Line data    Source code

       1             : 
       2             : /* Copyright (c) 2009-2014, Stefan Eilemann <eile@equalizergraphics.com>
       3             :  *
       4             :  * This library is free software; you can redistribute it and/or modify it under
       5             :  * the terms of the GNU Lesser General Public License version 2.1 as published
       6             :  * by the Free Software Foundation.
       7             :  *
       8             :  * This library is distributed in the hope that it will be useful, but WITHOUT
       9             :  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
      10             :  * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
      11             :  * details.
      12             :  *
      13             :  * You should have received a copy of the GNU Lesser General Public License
      14             :  * along with this library; if not, write to the Free Software Foundation, Inc.,
      15             :  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
      16             :  */
      17             : 
      18             : #ifndef LUNCHBOX_LOCKABLE_H
      19             : #define LUNCHBOX_LOCKABLE_H
      20             : 
      21             : #include <lunchbox/log.h> // used inline
      22             : #include <boost/noncopyable.hpp>
      23             : #include <iostream>
      24             : 
      25             : namespace lunchbox
      26             : {
      27             : /**
      28             :  * A convenience structure to hold data together with a lock for access.
      29             :  *
      30             :  * Locking the data still has to be done manually, e.g, using a ScopedMutex.
      31             :  */
      32          24 : template< class D, class L = Lock > class Lockable : public boost::noncopyable
      33             : {
      34             : public:
      35             :     /** Construct a new lockable data structure. @version 1.0 */
      36          24 :     Lockable() {}
      37             : 
      38             :     /** Construct and initialize a new data structure. @version 1.0 */
      39             :     explicit Lockable( const D& value ) : data( value ) {}
      40             : 
      41             :     /** Construct and initialize a new data structure. @version 1.3.2 */
      42             :     template< class P1 > Lockable( const P1& p1 ) : data( p1 ) {}
      43             : 
      44             :     /** Access the held data. @version 1.0 */
      45        3050 :     D* operator->() { return &data; }
      46             : 
      47             :     /** Access the held data. @version 1.0 */
      48             :     const D* operator->() const { return &data; }
      49             : 
      50             :     /** Access the held data. @version 1.1.5 */
      51             :     D& operator *() { return data; }
      52             : 
      53             :     /** Access the held data. @version 1.1.5 */
      54             :     const D& operator*() const { return data; }
      55             : 
      56             :     /** @return true if the data is equal to the rhs object. @version 1.0*/
      57             :     bool operator == ( const D& rhs ) const { return ( data == rhs ); }
      58             : 
      59             :     /** Assign another value to the data. @version 1.0 */
      60             :     Lockable& operator = ( const D& rhs ) { data = rhs; return *this; }
      61             : 
      62             :     D data;
      63             :     mutable L lock;
      64             : };
      65             : 
      66             : /** Print the data to the given output stream. */
      67             : template< class D, class L >
      68             : inline std::ostream& operator << ( std::ostream& os, const Lockable<D, L>& l )
      69             : {
      70             :     return os << disableFlush << "<" << l.lock.isSet() << " " << l.data << ">"
      71             :               << enableFlush;
      72             : }
      73             : }
      74             : #endif // LUNCHBOX_LOCKABLE_H