src/lib/name_format.h

   1 /*
   2     Copyright (C) 2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_NAME_FORMAT
  22 #define DCPOMATIC_NAME_FORMAT
  23
  24 #include <boost/optional.hpp>
  25 #include <map>
  26 #include <list>
  27
  28 class NameFormat
  29 {
  30 public:
  31         struct Component
  32         {
  33                 Component (std::string name_, char placeholder_, std::string title_)
  34                         : name (name_)
  35                         , placeholder (placeholder_)
  36                         , title (title_)
  37                 {}
  38
  39                 std::string name;
  40                 char placeholder;
  41                 std::string title;
  42         };
  43
  44         std::list<Component> components () const {
  45                 return _components;
  46         }
  47
  48         std::string specification () const {
  49                 return _specification;
  50         }
  51
  52         void set_specification (std::string specification) {
  53                 _specification = specification;
  54         }
  55
  56         typedef std::map<std::string, std::string> Map;
  57
  58         std::string get (Map) const;
  59
  60 protected:
  61         NameFormat () {}
  62
  63         NameFormat (std::string specification)
  64                 : _specification (specification)
  65         {}
  66
  67         void add (std::string name, char placeholder, std::string title);
  68
  69 private:
  70         boost::optional<NameFormat::Component> component_by_placeholder (char p) const;
  71
  72         std::list<Component> _components;
  73         std::string _specification;
  74 };
  75
  76 extern bool operator== (NameFormat const & a, NameFormat const & b);
  77
  78 #endif