Add AssetList to extract some boilerplate from AssetMap and PKL.

4 files changed, 102 insertions, 68 deletions

diff --git a/src/asset_list.h b/src/asset_list.h
new file mode 100644
index 00000000..5c50495d
--- /dev/null
+++ b/src/asset_list.h
@@ -0,0 +1,94 @@
+/*
+    Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
+
+    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.
+
+    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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    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.
+*/
+
+
+#ifndef DCP_ASSET_LIST_H
+#define DCP_ASSET_LIST_H
+
+
+#include "types.h"
+
+
+namespace dcp {
+
+
+/** Class to extract some boilerplate from AssetMap and PKL */
+class AssetList
+{
+public:
+	AssetList() {}
+	AssetList(Standard standard, boost::optional<std::string> annotation_text, std::string issue_date, std::string issuer, std::string creator)
+		: _standard(standard)
+		, _annotation_text(annotation_text)
+		, _issue_date(issue_date)
+		, _issuer(issuer)
+		, _creator(creator)
+	{}
+
+	dcp::Standard standard() const {
+		return _standard;
+	}
+
+	void set_annotation_text(std::string annotation_text) {
+		_annotation_text = annotation_text;
+	}
+
+	void set_issue_date(std::string issue_date) {
+		_issue_date = issue_date;
+	}
+
+	void set_issuer(std::string issuer) {
+		_issuer = issuer;
+	}
+
+	void set_creator(std::string creator) {
+		_creator = creator;
+	}
+
+	boost::optional<std::string> annotation_text() const {
+		return _annotation_text;
+	}
+
+protected:
+	dcp::Standard _standard = dcp::Standard::SMPTE;
+	boost::optional<std::string> _annotation_text;
+        std::string _issue_date;
+        std::string _issuer;
+        std::string _creator;
+};
+
+
+}
+
+
+#endif
diff --git a/src/asset_map.h b/src/asset_map.h
index cf91a95b..733dadab 100644
--- a/src/asset_map.h
+++ b/src/asset_map.h
@@ -32,6 +32,7 @@
 */
 
 
+#include "asset_list.h"
 #include "object.h"
 #include "types.h"
 #include <libcxml/cxml.h>
@@ -44,16 +45,12 @@
 namespace dcp {
 
 
-class AssetMap : public Object
+class AssetMap : public Object, public AssetList
 {
 public:
 	AssetMap(Standard standard, boost::optional<std::string> annotation_text, std::string issue_date, std::string issuer, std::string creator)
-		: _standard(standard)
-		, _annotation_text(annotation_text)
-		, _issue_date(issue_date)
-		, _issuer(issuer)
-		, _creator(creator)
-        {}
+		: AssetList(standard, annotation_text, issue_date, issuer, creator)
+	{}
 
 	explicit AssetMap(boost::filesystem::path path);
 
@@ -65,26 +62,6 @@ public:
 
 	std::vector<boost::filesystem::path> pkl_paths() const;
 
-	dcp::Standard standard() const {
-		return _standard;
-	}
-
-	void set_annotation_text(std::string annotation_text) {
-		_annotation_text = annotation_text;
-	}
-
-	void set_issue_date(std::string issue_date) {
-		_issue_date = issue_date;
-	}
-
-	void set_issuer(std::string issuer) {
-		_issuer = issuer;
-	}
-
-	void set_creator(std::string creator) {
-		_creator = creator;
-	}
-
 	void clear_assets();
 	void add_asset(std::string id, boost::filesystem::path path, bool pkl);
 
@@ -117,11 +94,6 @@ public:
 	};
 
 private:
-	dcp::Standard _standard;
-	boost::optional<std::string> _annotation_text;
-        std::string _issue_date;
-        std::string _issuer;
-        std::string _creator;
 	std::vector<Asset> _assets;
 	mutable boost::optional<boost::filesystem::path> _path;
 };
diff --git a/src/pkl.h b/src/pkl.h
index 315c1554..baa8a3e2 100644
--- a/src/pkl.h
+++ b/src/pkl.h
@@ -41,6 +41,7 @@
 #define LIBDCP_PKL_H
 
 
+#include "asset_list.h"
 #include "object.h"
 #include "types.h"
 #include "util.h"
@@ -52,43 +53,15 @@
 namespace dcp {
 
 
-class PKL : public Object
+class PKL : public Object, public AssetList
 {
 public:
 	PKL (Standard standard, boost::optional<std::string> annotation_text, std::string issue_date, std::string issuer, std::string creator)
-		: _standard (standard)
-		, _annotation_text (annotation_text)
-		, _issue_date (issue_date)
-		, _issuer (issuer)
-		, _creator (creator)
+		: AssetList(standard, annotation_text, issue_date, issuer, creator)
 	{}
 
 	explicit PKL (boost::filesystem::path file);
 
-	Standard standard () const {
-		return _standard;
-	}
-
-	boost::optional<std::string> annotation_text () const {
-		return _annotation_text;
-	}
-
-	void set_annotation_text(std::string annotation_text) {
-		_annotation_text = annotation_text;
-	}
-
-	void set_issue_date(std::string issue_date) {
-		_issue_date = issue_date;
-	}
-
-	void set_issuer(std::string issuer) {
-		_issuer = issuer;
-	}
-
-	void set_creator(std::string creator) {
-		_creator = creator;
-	}
-
 	boost::optional<std::string> hash (std::string id) const;
 	boost::optional<std::string> type (std::string id) const;
 
@@ -148,12 +121,6 @@ public:
 	}
 
 private:
-
-	Standard _standard = dcp::Standard::SMPTE;
-	boost::optional<std::string> _annotation_text;
-	std::string _issue_date;
-	std::string _issuer;
-	std::string _creator;
 	std::vector<std::shared_ptr<Asset>> _asset_list;
 	/** The most recent disk file used to read or write this PKL */
 	mutable boost::optional<boost::filesystem::path> _file;
diff --git a/src/wscript b/src/wscript
index 2788183b..2e8cd670 100644
--- a/src/wscript
+++ b/src/wscript
@@ -124,6 +124,7 @@ def build(bld):
     headers = """
               array_data.h
               asset.h
+              asset_list.h
               asset_map.h
               asset_reader.h
               asset_writer.h