X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fref.h;h=d306f963429d25274dc661fa1cbcad7a37517bbf;hb=11b1c2f72e99590d8c3d1fc1cd2c2a1a3d52932d;hp=8194e5855f7ee3833e76b645036d4d19a0c9d333;hpb=2ae92dcc97765deb2845dd07a338858aeb375cb3;p=libdcp.git diff --git a/src/ref.h b/src/ref.h index 8194e585..d306f963 100644 --- a/src/ref.h +++ b/src/ref.h @@ -1,61 +1,79 @@ /* - Copyright (C) 2014 Carl Hetherington + Copyright (C) 2014-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp 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 General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ + /** @file src/ref.h - * @brief Ref class. + * @brief Ref class */ + #ifndef LIBDCP_REF_H #define LIBDCP_REF_H + #include "exceptions.h" -#include "object.h" +#include "asset.h" #include "util.h" -#include +#include #include + namespace dcp { + /** @class Ref - * @brief A reference to an object which is identified by a universally-unique identifier (UUID). + * @brief A reference to an asset which is identified by a universally-unique identifier (UUID) * * This class is a `pointer' to a thing. It will always know the * UUID of the thing, and it may have a shared_ptr to the C++ object * which represents the thing. * * If the Ref does not have a shared_ptr it may be given one by - * calling resolve() with a list of objects. The shared_ptr will be - * set up using any object on the list which has a matching ID. + * calling resolve() with a vector of assets. The shared_ptr will be + * set up using any object on the vector which has a matching ID. */ -template class Ref { public: /** Initialise a Ref with an ID but no shared_ptr */ - Ref (std::string id) + explicit Ref (std::string id) : _id (id) {} - /** Initialise a Ref with a shared_ptr to an object */ - Ref (boost::shared_ptr object) - : _id (object->id ()) - , _object (object) + /** Initialise a Ref with a shared_ptr to an asset */ + explicit Ref (std::shared_ptr asset) + : _id (asset->id ()) + , _asset (asset) {} /** Set the ID of this Ref */ @@ -64,20 +82,10 @@ public: _id = id; } - /** Look through a list of objects and copy a shared_ptr to any object - * which matches the ID of this one. + /** Look through a list of assets and copy a shared_ptr to any asset + * which matches the ID of this one */ - void resolve (std::list > objects) - { - typename std::list >::iterator i = objects.begin(); - while (i != objects.end() && !ids_equal ((*i)->id(), _id)) { - ++i; - } - - if (i != objects.end ()) { - _object = boost::dynamic_pointer_cast (*i); - } - } + void resolve (std::vector> assets); /** @return the ID of the thing that we are pointing to */ std::string id () const { @@ -85,37 +93,39 @@ public: } /** @return a shared_ptr to the thing; an UnresolvedRefError is thrown - * if the shared_ptr is not known. + * if the shared_ptr is not known */ - boost::shared_ptr object () const { - if (!_object) { + std::shared_ptr asset () const { + if (!_asset) { throw UnresolvedRefError (_id); } - return _object; + return _asset; } /** operator-> to access the shared_ptr; an UnresolvedRefError is thrown - * if the shared_ptr is not known. + * if the shared_ptr is not known */ - T * operator->() const { - if (!_object) { + Asset * operator->() const { + if (!_asset) { throw UnresolvedRefError (_id); } - return _object.get (); + return _asset.get (); } /** @return true if a shared_ptr is known for this Ref */ bool resolved () const { - return _object; + return static_cast(_asset); } private: - std::string _id; ///< ID; will always be known - boost::shared_ptr _object; ///< shared_ptr to the thing, may be null. + std::string _id; ///< ID; will always be known + std::shared_ptr _asset; ///< shared_ptr to the thing, may be null. }; + } + #endif