rippled/beast/Uncopyable.h

//------------------------------------------------------------------------------
/*
    This file is part of Beast: https://github.com/vinniefalco/Beast
    Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>

    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.

    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================

#ifndef BEAST_UNCOPYABLE_H_INCLUDED
#define BEAST_UNCOPYABLE_H_INCLUDED

namespace beast
{

// Ideas from boost

/** Prevent copy construction and assignment.

    This is used to suppress warnings and prevent unsafe operations on
    objects which cannot be passed by value. Ideas based on Boost.

    For example, instead of

    @code

    class MyClass
    {
    public:
        //...

    private:
        MyClass (const MyClass&);
        MyClass& operator= (const MyClass&);
    };
    
    @endcode

    ..you can just write:

    @code

    class MyClass : public Uncopyable
    {
    public:
        //...
    };
    
    @endcode

    @note The derivation should be public or else child classes which
          also derive from Uncopyable may not compile.
*/
class Uncopyable
{
protected:
    Uncopyable () { }
    ~Uncopyable () { }

private:
    Uncopyable (Uncopyable const&);
    Uncopyable const& operator= (Uncopyable const&);
};

}

#endif