Comments / tweaks.
[libdcp.git] / src / util.h
index 5d7a9c4f96cc4513da15a76a208211621d8c63b7..2bfeb60ab9f3a5845a5a75d17802933fefd5ea1d 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
  *  @brief Utility methods.
  */
 
-#include <string>
-#include <stdint.h>
+#include "types.h"
 #include <boost/shared_ptr.hpp>
 #include <boost/function.hpp>
 #include <boost/date_time/posix_time/posix_time.hpp>
 #include <boost/filesystem.hpp>
+#include <boost/optional.hpp>
 #include <openjpeg.h>
-#include "types.h"
+#include <string>
+#include <stdint.h>
 
 namespace xmlpp {
        class Element;
@@ -44,7 +45,11 @@ class CertificateChain;
 class GammaLUT;
 class XYZFrame;
 
-struct Size {
+/** @struct Size
+ *  @brief The integer, two-dimensional size of something.
+ */
+struct Size
+{
        Size ()
                : width (0)
                , height (0)
@@ -80,11 +85,26 @@ extern void add_signature_value (xmlpp::Element* parent, CertificateChain const
 extern void add_signer (xmlpp::Element* parent, CertificateChain const & certificates, std::string const & ns);
 
 extern int base64_decode (std::string const & in, unsigned char* out, int out_length);
-
+extern boost::optional<boost::filesystem::path> relative_to_root (boost::filesystem::path root, boost::filesystem::path file);
 extern std::string tm_to_string (struct tm *);
 extern std::string utc_offset_to_string (int);
 extern std::string ptime_to_string (boost::posix_time::ptime);
 extern FILE * fopen_boost (boost::filesystem::path, std::string);
+
+template <class F, class T>
+std::list<boost::shared_ptr<T> >
+list_of_type (std::list<boost::shared_ptr<F> > const & from)
+{
+       std::list<boost::shared_ptr<T> > out;
+       for (typename std::list<boost::shared_ptr<F> >::const_iterator i = from.begin(); i != from.end(); ++i) {
+               boost::shared_ptr<T> check = boost::dynamic_pointer_cast<T> (*i);
+               if (check) {
+                       out.push_back (check);
+               }
+       }
+
+       return out;
+}
        
 }