src/language_tag.h

   1 /*
   2     Copyright (C) 2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 #ifndef LIBDCP_LANGUAGE_TAG_H
  35 #define LIBDCP_LANGUAGE_TAG_H
  36
  37
  38 #include <boost/optional.hpp>
  39 #include <string>
  40 #include <vector>
  41
  42
  43 namespace dcp {
  44
  45
  46 class LanguageTag
  47 {
  48 public:
  49         std::string to_string () const;
  50         std::string description () const;
  51
  52         struct SubtagData
  53         {
  54                 SubtagData () {}
  55
  56                 SubtagData (std::string subtag_, std::string description_)
  57                         : subtag(subtag_)
  58                         , description(description_)
  59                 {}
  60
  61                 std::string subtag;
  62                 std::string description;
  63
  64                 bool operator== (SubtagData const& other) {
  65                         return subtag == other.subtag && description == other.description;
  66                 }
  67         };
  68
  69         enum SubtagType
  70         {
  71                 LANGUAGE,
  72                 SCRIPT,
  73                 REGION,
  74                 VARIANT,
  75                 EXTLANG,
  76         };
  77
  78         class Subtag
  79         {
  80         public:
  81                 std::string subtag () const {
  82                         return _subtag;
  83                 }
  84
  85                 virtual SubtagType type () const = 0;
  86
  87                 bool operator== (Subtag const& other) {
  88                         return _subtag == other._subtag;
  89                 }
  90
  91         protected:
  92                 Subtag (std::string subtag, SubtagType type);
  93
  94         private:
  95                 std::string _subtag;
  96         };
  97
  98         class LanguageSubtag : public Subtag
  99         {
 100         public:
 101                 LanguageSubtag (std::string subtag)
 102                         : Subtag(subtag, LANGUAGE) {}
 103                 LanguageSubtag (char const* subtag)
 104                         : Subtag(subtag, LANGUAGE) {}
 105
 106                 SubtagType type () const {
 107                         return LANGUAGE;
 108                 }
 109         };
 110
 111         class ScriptSubtag : public Subtag
 112         {
 113         public:
 114                 ScriptSubtag (std::string subtag)
 115                         : Subtag(subtag, SCRIPT) {}
 116                 ScriptSubtag (char const* subtag)
 117                         : Subtag(subtag, SCRIPT) {}
 118
 119                 SubtagType type () const {
 120                         return SCRIPT;
 121                 }
 122         };
 123
 124         class RegionSubtag : public Subtag
 125         {
 126         public:
 127                 RegionSubtag (std::string subtag)
 128                         : Subtag(subtag, REGION) {}
 129                 RegionSubtag (char const* subtag)
 130                         : Subtag(subtag, REGION) {}
 131
 132                 SubtagType type () const {
 133                         return REGION;
 134                 }
 135         };
 136
 137         class VariantSubtag : public Subtag
 138         {
 139         public:
 140                 VariantSubtag (std::string subtag)
 141                         : Subtag(subtag, VARIANT) {}
 142                 VariantSubtag (char const* subtag)
 143                         : Subtag(subtag, VARIANT) {}
 144
 145                 SubtagType type () const {
 146                         return VARIANT;
 147                 }
 148
 149                 bool operator== (VariantSubtag const& other) const;
 150                 bool operator< (VariantSubtag const& other) const;
 151         };
 152
 153
 154         class ExtlangSubtag : public Subtag
 155         {
 156         public:
 157                 ExtlangSubtag (std::string subtag)
 158                         : Subtag(subtag, EXTLANG) {}
 159                 ExtlangSubtag (char const* subtag)
 160                         : Subtag(subtag, EXTLANG) {}
 161
 162                 SubtagType type () const {
 163                         return EXTLANG;
 164                 }
 165
 166                 bool operator== (ExtlangSubtag const& other) const;
 167                 bool operator< (ExtlangSubtag const& other) const;
 168         };
 169
 170         LanguageTag () {}
 171         LanguageTag (std::string tag);
 172
 173         boost::optional<LanguageSubtag> language() {
 174                 return _language;
 175         }
 176
 177         void set_language (LanguageSubtag language);
 178
 179         boost::optional<ScriptSubtag> script() const {
 180                 return _script;
 181         }
 182
 183         void set_script (ScriptSubtag script);
 184
 185         boost::optional<RegionSubtag> region() const {
 186                 return _region;
 187         }
 188
 189         void set_region (RegionSubtag region);
 190
 191         std::vector<VariantSubtag> variants() const {
 192                 return _variants;
 193         }
 194
 195         void set_variants (std::vector<VariantSubtag> variants);
 196         void add_variant (VariantSubtag variant);
 197
 198         std::vector<ExtlangSubtag> extlangs() const {
 199                 return _extlangs;
 200         }
 201
 202         void set_extlangs (std::vector<ExtlangSubtag> extlangs);
 203         void add_extlang (ExtlangSubtag extlang);
 204
 205         std::vector<std::pair<SubtagType, SubtagData> > subtags () const;
 206
 207         static std::vector<SubtagData> get_all (SubtagType type);
 208         static std::string subtag_type_name (SubtagType type);
 209
 210         static boost::optional<std::string> get_subtag_description (SubtagType, std::string subtag);
 211         static boost::optional<SubtagData > get_subtag_data (SubtagType, std::string subtag);
 212
 213         template <class T>
 214         static boost::optional<std::string> get_subtag_description (T s) {
 215                 return get_subtag_description (s.type(), s.subtag());
 216         }
 217
 218         template <class T>
 219         static boost::optional<SubtagData> get_subtag_data (T s) {
 220                 return get_subtag_data (s.type(), s.subtag());
 221         }
 222
 223 private:
 224
 225         boost::optional<LanguageSubtag> _language;
 226         boost::optional<ScriptSubtag> _script;
 227         boost::optional<RegionSubtag> _region;
 228         std::vector<VariantSubtag> _variants;
 229         std::vector<ExtlangSubtag> _extlangs;
 230 };
 231
 232 extern bool operator==(dcp::LanguageTag const& a, dcp::LanguageTag const& b);
 233 extern std::ostream& operator<<(std::ostream& os, dcp::LanguageTag const& tag);
 234
 235 }
 236
 237 #endif