2 Copyright (C) 2020-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
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.
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.
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/>.
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
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.
35 /** @file src/language_tag.cc
36 * @brief LanguageTag class
40 #ifndef LIBDCP_LANGUAGE_TAG_H
41 #define LIBDCP_LANGUAGE_TAG_H
44 #include <boost/filesystem.hpp>
45 #include <boost/optional.hpp>
56 std::string to_string () const;
57 std::string description () const;
63 SubtagData (std::string subtag_, std::string description_)
65 , description(description_)
69 std::string description;
71 bool operator== (SubtagData const& other) const {
72 return subtag == other.subtag && description == other.description;
75 bool operator!=(SubtagData const& other) const {
76 return subtag != other.subtag || description != other.description;
94 std::string subtag () const {
98 virtual SubtagType type () const = 0;
100 bool operator== (Subtag const& other) const {
101 return _subtag == other._subtag;
104 bool operator!=(Subtag const& other) const {
105 return _subtag != other._subtag;
108 bool operator<(Subtag const& other) const {
109 return _subtag < other._subtag;
113 Subtag (std::string subtag, SubtagType type);
119 class LanguageSubtag : public Subtag
122 LanguageSubtag (std::string subtag)
123 : Subtag(subtag, SubtagType::LANGUAGE) {}
124 LanguageSubtag (char const* subtag)
125 : Subtag(subtag, SubtagType::LANGUAGE) {}
127 SubtagType type () const override {
128 return SubtagType::LANGUAGE;
132 class ScriptSubtag : public Subtag
135 ScriptSubtag (std::string subtag)
136 : Subtag(subtag, SubtagType::SCRIPT) {}
137 ScriptSubtag (char const* subtag)
138 : Subtag(subtag, SubtagType::SCRIPT) {}
140 SubtagType type () const override {
141 return SubtagType::SCRIPT;
145 class RegionSubtag : public Subtag
148 RegionSubtag (std::string subtag)
149 : Subtag(subtag, SubtagType::REGION) {}
150 RegionSubtag (char const* subtag)
151 : Subtag(subtag, SubtagType::REGION) {}
153 SubtagType type () const override {
154 return SubtagType::REGION;
158 class VariantSubtag : public Subtag
161 VariantSubtag (std::string subtag)
162 : Subtag(subtag, SubtagType::VARIANT) {}
163 VariantSubtag (char const* subtag)
164 : Subtag(subtag, SubtagType::VARIANT) {}
166 SubtagType type () const override {
167 return SubtagType::VARIANT;
172 class ExtlangSubtag : public Subtag
175 ExtlangSubtag (std::string subtag)
176 : Subtag(subtag, SubtagType::EXTLANG) {}
177 ExtlangSubtag (char const* subtag)
178 : Subtag(subtag, SubtagType::EXTLANG) {}
180 SubtagType type () const override {
181 return SubtagType::EXTLANG;
186 explicit LanguageTag (std::string tag);
188 boost::optional<LanguageSubtag> language() const {
192 void set_language (LanguageSubtag language);
194 boost::optional<ScriptSubtag> script() const {
198 void set_script (ScriptSubtag script);
200 boost::optional<RegionSubtag> region() const {
204 void set_region (RegionSubtag region);
206 std::vector<VariantSubtag> variants() const {
210 void set_variants (std::vector<VariantSubtag> variants);
211 void add_variant (VariantSubtag variant);
213 std::vector<ExtlangSubtag> extlangs() const {
217 void set_extlangs (std::vector<ExtlangSubtag> extlangs);
218 void add_extlang (ExtlangSubtag extlang);
220 std::vector<std::pair<SubtagType, SubtagData>> subtags () const;
222 static std::vector<SubtagData> const& get_all (SubtagType type);
223 static std::string subtag_type_name (SubtagType type);
225 static boost::optional<std::string> get_subtag_description (SubtagType, std::string subtag);
226 static boost::optional<SubtagData> get_subtag_data (SubtagType, std::string subtag);
229 static boost::optional<std::string> get_subtag_description (T s) {
230 return get_subtag_description (s.type(), s.subtag());
234 static boost::optional<SubtagData> get_subtag_data (T s) {
235 return get_subtag_data (s.type(), s.subtag());
240 boost::optional<LanguageSubtag> _language;
241 boost::optional<ScriptSubtag> _script;
242 boost::optional<RegionSubtag> _region;
243 std::vector<VariantSubtag> _variants;
244 std::vector<ExtlangSubtag> _extlangs;
248 extern bool operator==(dcp::LanguageTag const& a, dcp::LanguageTag const& b);
249 extern bool operator!=(dcp::LanguageTag const& a, dcp::LanguageTag const& b);
250 extern bool operator<(dcp::LanguageTag const& a, dcp::LanguageTag const& b);
251 extern std::ostream& operator<<(std::ostream& os, dcp::LanguageTag const& tag);
254 extern void load_language_tag_lists (boost::filesystem::path tags_directory);
257 extern std::vector<std::pair<std::string, std::string>> dcnc_tags ();