libs/generic/reference.h

   1 /*
   2    Copyright (C) 2001-2006, William Joseph.
   3    All Rights Reserved.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    GtkRadiant is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #if !defined( INCLUDED_GENERIC_REFERENCE_H )
  23 #define INCLUDED_GENERIC_REFERENCE_H
  24
  25 /// \file
  26 /// \brief Wrappers to allow storing objects in templated containers using 'reference' semantics.
  27
  28 /// \brief A reference to a mutable object.
  29 /// Has 'reference' semantics, except for \c 'operator==' and \c 'operator.'.
  30 /// \param Type The type of the referenced object.
  31 template<typename Type>
  32 class Reference
  33 {
  34 Type* m_contained;
  35 public:
  36 explicit Reference( Type& contained ) : m_contained( &contained ){
  37 }
  38 operator Type&() const
  39 {
  40         return *m_contained;
  41 }
  42 Type& get() const {
  43         return *m_contained;
  44 }
  45 Type* get_pointer() const {
  46         return m_contained;
  47 }
  48 };
  49
  50 template<typename Type>
  51 bool operator<( const Reference<Type>& self, const Reference<Type>& other ){
  52         return self.get() < other.get();
  53 }
  54 template<typename Type>
  55 bool operator==( const Reference<Type>& self, const Reference<Type>& other ){
  56         return self.get() == other.get();
  57 }
  58
  59 /// \brief construct a reference to a mutable object.
  60 template<typename Type>
  61 inline Reference<Type> makeReference( Type& value ){
  62         return Reference<Type>( value );
  63 }
  64
  65 /// \brief A reference to a non-mutable object.
  66 /// Has 'reference' semantics, except for \c 'operator==' and \c 'operator.'.
  67 /// \param Type The type of the referenced object.
  68 template<typename Type>
  69 class ConstReference
  70 {
  71 const Type* m_contained;
  72 public:
  73 explicit ConstReference( const Type& contained ) : m_contained( &contained ){
  74 }
  75 operator const Type&() const
  76 {
  77         return *m_contained;
  78 }
  79 const Type& get() const {
  80         return *m_contained;
  81 }
  82 const Type* get_pointer() const {
  83         return m_contained;
  84 }
  85 };
  86
  87 template<typename Type>
  88 bool operator<( const ConstReference<Type>& self, const ConstReference<Type>& other ){
  89         return self.get() < other.get();
  90 }
  91 template<typename Type>
  92 bool operator==( const ConstReference<Type>& self, const ConstReference<Type>& other ){
  93         return self.get() == other.get();
  94 }
  95
  96 /// \brief construct a reference to a non-mutable object.
  97 template<typename Type>
  98 inline ConstReference<Type> makeReference( const Type& value ){
  99         return ConstReference<Type>( value );
 100 }
 101
 102
 103 #endif