lockable.h

/* Copyright (c) 2009-2012, Stefan Eilemann <eile@equalizergraphics.com> 
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *  
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef LUNCHBOX_LOCKABLE_H
#define LUNCHBOX_LOCKABLE_H

#include <lunchbox/log.h> // used inline
#include <lunchbox/nonCopyable.h> // base class
#include <iostream>

namespace lunchbox
{
    template< class D, class L = Lock > class Lockable : public NonCopyable
    {
    public:
        explicit Lockable() {}

        explicit Lockable( const D& value ) : data( value ) {}

        D* operator->() { return &data; }

        const D* operator->() const { return &data; }

        D& operator *() { return data; }

        const D& operator*() const { return data; }

        bool operator == ( const D& rhs ) const { return ( data == rhs ); }

        Lockable& operator = ( const D& rhs ) { data = rhs; return *this; }

        D data;
        mutable L lock;
    };

    template< class D, class L >
    inline std::ostream& operator << ( std::ostream& os,
                                       const Lockable<D, L>& l )
    {
        os << disableFlush << "<" << l.lock.isSet() << " " << l.data << ">"
           << enableFlush;
        return os;
    }
}
#endif // LUNCHBOX_LOCKABLE_H