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   }
  39   Type& operator*() const
  40   {
  41     return *m_contained;
  42   }
  43   Type* operator->() const
  44   {
  45     return m_contained;
  46   }
  47   operator Type&() const
  48   {
  49     return *m_contained;
  50   }
  51   Type& get() const
  52   {
  53     return *m_contained;
  54   }
  55   Type* get_pointer() const
  56   {
  57     return m_contained;
  58   }
  59 };
  60
  61 template<typename Type>
  62 bool operator<(const Reference<Type>& self, const Reference<Type>& other)
  63 {
  64   return self.get() < other.get();
  65 }
  66 template<typename Type>
  67 bool operator==(const Reference<Type>& self, const Reference<Type>& other)
  68 {
  69   return self.get() == other.get();
  70 }
  71
  72 /// \brief construct a reference to a mutable object.
  73 template<typename Type>
  74 inline Reference<Type> makeReference(Type& value)
  75 {
  76   return Reference<Type>(value);
  77 }
  78
  79 /// \brief A reference to a non-mutable object.
  80 /// Has 'reference' semantics, except for \c 'operator==' and \c 'operator.'.
  81 /// \param Type The type of the referenced object.
  82 template<typename Type>
  83 class ConstReference
  84 {
  85   const Type* m_contained;
  86 public:
  87   explicit ConstReference(const Type& contained) : m_contained(&contained)
  88   {
  89   }
  90   const Type& operator*() const
  91   {
  92     return *m_contained;
  93   }
  94   const Type* operator->() const
  95   {
  96     return m_contained;
  97   }
  98   operator const Type&() const
  99   {
 100     return *m_contained;
 101   }
 102   const Type& get() const
 103   {
 104     return *m_contained;
 105   }
 106   const Type* get_pointer() const
 107   {
 108     return m_contained;
 109   }
 110 };
 111
 112 template<typename Type>
 113 bool operator<(const ConstReference<Type>& self, const ConstReference<Type>& other)
 114 {
 115   return self.get() < other.get();
 116 }
 117 template<typename Type>
 118 bool operator==(const ConstReference<Type>& self, const ConstReference<Type>& other)
 119 {
 120   return self.get() == other.get();
 121 }
 122
 123 /// \brief construct a reference to a non-mutable object.
 124 template<typename Type>
 125 inline ConstReference<Type> makeReference(const Type& value)
 126 {
 127   return ConstReference<Type>(value);
 128 }
 129
 130
 131 #endif