src/ref.h

   1 /*
   2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/ref.h
  21  *  @brief Ref class.
  22  */
  23
  24 #ifndef LIBDCP_REF_H
  25 #define LIBDCP_REF_H
  26
  27 #include "exceptions.h"
  28 #include "object.h"
  29 #include <boost/shared_ptr.hpp>
  30 #include <string>
  31
  32 namespace dcp {
  33
  34 /** @class Ref
  35  *  @brief A reference to an object which is identified by a universally-unique identifier (UUID).
  36  *
  37  *  This class is a `pointer' to a thing.  It will always know the
  38  *  UUID of the thing, and it may have a shared_ptr to the C++ object
  39  *  which represents the thing.
  40  *
  41  *  If the Ref does not have a shared_ptr it may be given one by
  42  *  calling resolve() with a list of objects.  The shared_ptr will be
  43  *  set up using any object on the list which has a matching ID.
  44  */
  45 template<class T>
  46 class Ref
  47 {
  48 public:
  49         /** Initialise a Ref with an ID but no shared_ptr */
  50         Ref (std::string id)
  51                 : _id (id)
  52         {}
  53
  54         /** Initialise a Ref with a shared_ptr to an object */
  55         Ref (boost::shared_ptr<T> object)
  56                 : _id (object->id ())
  57                 , _object (object)
  58         {}
  59
  60         /** Set the ID of this Ref */
  61         void set_id (std::string id)
  62         {
  63                 _id = id;
  64         }
  65
  66         /** Look through a list of objects and copy a shared_ptr to any object
  67          *  which matches the ID of this one.
  68          */
  69         void resolve (std::list<boost::shared_ptr<Object> > objects)
  70         {
  71                 typename std::list<boost::shared_ptr<Object> >::iterator i = objects.begin();
  72                 while (i != objects.end() && (*i)->id() != _id) {
  73                         ++i;
  74                 }
  75
  76                 if (i != objects.end ()) {
  77                         _object = boost::dynamic_pointer_cast<T> (*i);
  78                 }
  79         }
  80
  81         /** @return the ID of the thing that we are pointing to */
  82         std::string id () const {
  83                 return _id;
  84         }
  85
  86         /** @return a shared_ptr to the thing; an UnresolvedRefError is thrown
  87          *  if the shared_ptr is not known.
  88          */
  89         boost::shared_ptr<T> object () const {
  90                 if (!_object) {
  91                         throw UnresolvedRefError (_id);
  92                 }
  93
  94                 return _object;
  95         }
  96
  97         /** operator-> to access the shared_ptr; an UnresolvedRefError is thrown
  98          *  if the shared_ptr is not known.
  99          */
 100         T * operator->() const {
 101                 if (!_object) {
 102                         throw UnresolvedRefError (_id);
 103                 }
 104
 105                 return _object.get ();
 106         }
 107
 108         /** @return true if a shared_ptr is known for this Ref */
 109         bool resolved () const {
 110                 return _object;
 111         }
 112
 113 private:
 114         std::string _id;              ///< ID; will always be known
 115         boost::shared_ptr<T> _object; ///< shared_ptr to the thing, may be null.
 116 };
 117
 118 }
 119
 120 #endif