Add some explicit declarations to constructors.

[libdcp.git] / src / asset.h

diff --git a/src/asset.h b/src/asset.h
index bad982f1878b2584741ef0955a65253c022ff19f..c0f4700f9c950676b5c6abe228ad9ffd9a0ed527 100644 (file)
--- a/src/asset.h
+++ b/src/asset.h
@@ -1,25 +1,25 @@
 /*
     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
 
-    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 <http://www.gnu.org/licenses/>.
 */
 
 /** @file  src/asset.h
  *  @brief Asset class.
- */ 
+ */
 
 #ifndef LIBDCP_ASSET_H
 #define LIBDCP_ASSET_H
@@ -29,15 +29,18 @@
 #include <boost/filesystem.hpp>
 #include <boost/function.hpp>
 #include <boost/bind.hpp>
+#include <boost/optional.hpp>
 
 namespace xmlpp {
        class Node;
 }
 
+struct asset_test;
+
 namespace dcp {
 
 /** @class Asset
- *  @brief Parent class for DCP assets, i.e. picture/sound/subtitles and CPLs.
+ *  @brief Parent class for DCP assets, i.e. picture, sound, subtitles, CPLs, fonts.
  *
  *  Note that this class is not used for ReelAssets; those are just for the metadata
  *  that gets put into &lt;Reel&gt;s.
@@ -46,13 +49,13 @@ class Asset : public Object
 {
 public:
        Asset ();
-       Asset (boost::filesystem::path file);
-       Asset (std::string id);
+       explicit Asset (boost::filesystem::path file);
+       Asset (std::string id, boost::filesystem::path file);
 
        virtual bool equals (
                boost::shared_ptr<const Asset> other,
                EqualityOptions opt,
-               boost::function<void (NoteType, std::string)> note
+               NoteHandler note
                ) const;
 
        /** Write details of the asset to a ASSETMAP.
@@ -64,8 +67,9 @@ public:
         *  @param node Parent node.
         *  @param standard Standard to use.
         */
-       void write_to_pkl (xmlpp::Node* node, Standard standard) const;
+       void write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const;
 
+       /** @return the most recent disk file used to read or write this asset; may be empty */
        boost::filesystem::path file () const {
                return _file;
        }
@@ -75,13 +79,20 @@ public:
        /** @return the hash of this asset's file */
        std::string hash (boost::function<void (float)> progress = 0) const;
 
+       void set_hash (std::string hash);
+
 protected:
-       virtual std::string pkl_type (Standard standard) const = 0;
 
-       /** The disk file that represents this asset, if one exists */
+       /** The most recent disk file used to read or write this asset; may be empty */
        mutable boost::filesystem::path _file;
-       /** Hash of _file, or empty if the hash has not yet been computed */
-       mutable std::string _hash;
+
+private:
+       friend struct ::asset_test;
+
+       virtual std::string pkl_type (Standard standard) const = 0;
+
+       /** Hash of _file if it has been computed */
+       mutable boost::optional<std::string> _hash;
 };
 
 }