Cleanup: pass EqualityOptions as const&

[libdcp.git] / src / asset.h

diff --git a/src/asset.h b/src/asset.h
index 100303a1b76e3f9e2ad9ba0fa3036e5897144ed3..b88b1167d3c110f1087424805d972d2225667164 100644 (file)
--- a/src/asset.h
+++ b/src/asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -31,13 +31,16 @@
     files in the program, then also delete it here.
 */
 
+
 /** @file  src/asset.h
- *  @brief Asset class.
+ *  @brief Asset class
  */
 
+
 #ifndef LIBDCP_ASSET_H
 #define LIBDCP_ASSET_H
 
+
 #include "object.h"
 #include "types.h"
 #include "pkl.h"
@@ -45,16 +48,23 @@
 #include <boost/function.hpp>
 #include <boost/optional.hpp>
 
+
 namespace xmlpp {
        class Node;
 }
 
+
 struct asset_test;
 
+
 namespace dcp {
 
+
+class AssetMap;
+
+
 /** @class Asset
- *  @brief Parent class for DCP assets, i.e. picture, sound, subtitles, CPLs, fonts.
+ *  @brief Parent class for DCP assets, i.e. picture, sound, subtitles, closed captions, 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.
@@ -62,20 +72,27 @@ namespace dcp {
 class Asset : public Object
 {
 public:
+       /** Create an Asset with a randomly-generated ID */
        Asset ();
+
+       /** Create an Asset from a given file with a randomly-generated ID
+        *  @param file File name
+        */
        explicit Asset (boost::filesystem::path file);
+
+       /** Create an Asset from a given file with a given ID
+        *  @param id ID
+        *  @param file File name
+        */
        Asset (std::string id, boost::filesystem::path file);
 
        virtual bool equals (
                std::shared_ptr<const Asset> other,
-               EqualityOptions opt,
+               EqualityOptions const& opt,
                NoteHandler note
                ) const;
 
-       /** Write details of the asset to a ASSETMAP.
-        *  @param node Parent node.
-        */
-       virtual void write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const;
+       virtual void add_to_assetmap (AssetMap& asset_map, boost::filesystem::path root) const;
 
        virtual void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const;
 
@@ -84,19 +101,48 @@ public:
                return _file;
        }
 
+       /** Set the file that holds this asset on disk.  Calling this function
+        *  clears this object's store of its hash, so you should call ::hash
+        *  after this.
+        *
+        *  @param file New file's path.
+        */
        void set_file (boost::filesystem::path file) const;
 
-       /** @return the hash of this asset's file */
-       std::string hash (boost::function<void (float)> progress = 0) const;
+       /** Set the file that holds this asset on disk.  Calling this function
+        *  preserves the object's store of its hash, so if the object already
+        *  has a hash it is up to the caller to ensure that the new file has
+        *  the same hash.
+        *
+        *  @param file New file's path.
+        */
+       void set_file_preserving_hash(boost::filesystem::path file) const;
+
+       /** Set the file that holds this asset on disk.  The new file must
+        *  be exactly the same as the old one, as this function assumes
+        *  that the object's hash does not change.
+        *
+        *  @param file New file's path.
+        */
+       void rename_file(boost::filesystem::path file);
+
+       /** Calculate the hash of this asset's file, if it has not already been calculated,
+        *  then return it
+        *  @param progress Function that will be called with a parameter between 0 and 1 to indicate
+        *  progress in the calculation
+        *  @return the hash
+        */
+       std::string hash (boost::function<void (float)> progress = {}) const;
 
        void set_hash (std::string hash);
+       void unset_hash();
 
 protected:
 
        /** The most recent disk file used to read or write this asset */
        mutable boost::optional<boost::filesystem::path> _file;
 
-       static void write_file_to_assetmap (xmlpp::Node* node, boost::filesystem::path root, boost::filesystem::path file, std::string id);
+       static void add_file_to_assetmap (AssetMap& asset_map, boost::filesystem::path root, boost::filesystem::path file, std::string id);
 
 private:
        friend struct ::asset_test;
@@ -108,6 +154,8 @@ private:
        mutable boost::optional<std::string> _hash;
 };
 
+
 }
 
+
 #endif