language_tag.cc

Go to the documentation of this file.

/*
    Copyright (C) 2020-2021 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.
*/
 
 
#include "compose.hpp"
#include "dcp_assert.h"
#include "exceptions.h"
#include "file.h"
#include "language_tag.h"
#include <boost/algorithm/string.hpp>
#include <string>
 
 
using std::make_pair;
using std::ostream;
using std::pair;
using std::string;
using std::vector;
using boost::algorithm::trim;
using boost::optional;
using namespace dcp;
 
 
static vector<LanguageTag::SubtagData> language_list;
static vector<LanguageTag::SubtagData> variant_list;
static vector<LanguageTag::SubtagData> region_list;
static vector<LanguageTag::SubtagData> script_list;
static vector<LanguageTag::SubtagData> extlang_list;
 
static vector<pair<string, string>> dcnc_list;
 
 
static
optional<LanguageTag::SubtagData>
find_in_list (vector<LanguageTag::SubtagData> const& list, string subtag)
{
        for (auto const& i: list) {
                if (boost::iequals(i.subtag, subtag)) {
                        return i;
                }
        }
 
        return {};
}
 
 
LanguageTag::Subtag::Subtag (string subtag, SubtagType type)
        : _subtag (subtag)
{
        if (!get_subtag_data(type, subtag)) {
                throw LanguageTagError(String::compose("Unknown %1 string %2", subtag_type_name(type), subtag));
        }
}
 
 
LanguageTag::LanguageTag (string tag)
{
        vector<string> parts;
        boost::split (parts, tag, boost::is_any_of("-"));
        if (parts.empty()) {
                throw LanguageTagError (String::compose("Could not parse language tag %1", tag));
        }
 
        vector<string>::size_type p = 0;
        _language = LanguageSubtag (parts[p]);
        ++p;
 
        if (p == parts.size()) {
                return;
        }
 
        try {
                _script = ScriptSubtag (parts[p]);
                ++p;
        } catch (...) {}
 
        if (p == parts.size()) {
                return;
        }
 
        try {
                _region = RegionSubtag (parts[p]);
                ++p;
        } catch (...) {}
 
        if (p == parts.size()) {
                return;
        }
 
        try {
                while (true) {
                        _variants.push_back (VariantSubtag(parts[p]));
                        ++p;
                        if (p == parts.size()) {
                                return;
                        }
                }
        } catch (...) {}
 
        try {
                while (true) {
                        _extlangs.push_back (ExtlangSubtag(parts[p]));
                        ++p;
                        if (p == parts.size()) {
                                return;
                        }
                }
        } catch (...) {}
 
        if (p < parts.size()) {
                throw LanguageTagError (String::compose("Unrecognised subtag %1", parts[p]));
        }
}
 
 
string
LanguageTag::to_string () const
{
        if (!_language) {
                throw LanguageTagError("No language set up");
        }
 
        auto s = _language->subtag();
 
        if (_script) {
                s += "-" + _script->subtag();
        }
 
        if (_region) {
                s += "-" + _region->subtag();
        }
 
        for (auto i: _variants) {
                s += "-" + i.subtag();
        }
 
        for (auto i: _extlangs) {
                s += "-" + i.subtag();
        }
 
        return s;
}
 
 
void
LanguageTag::set_language (LanguageSubtag language)
{
        _language = language;
}
 
 
void
LanguageTag::set_script (ScriptSubtag script)
{
        _script = script;
}
 
 
void
LanguageTag::set_region (RegionSubtag region)
{
        _region = region;
}
 
 
void
LanguageTag::add_variant (VariantSubtag variant)
{
        if (find(_variants.begin(), _variants.end(), variant) != _variants.end()) {
                throw LanguageTagError (String::compose("Duplicate Variant subtag %1", variant.subtag()));
        }
 
        _variants.push_back (variant);
}
 
 
template <class T>
void
check_for_duplicates (vector<T> const& subtags, dcp::LanguageTag::SubtagType type)
{
        vector<T> sorted = subtags;
        sort (sorted.begin(), sorted.end());
        optional<T> last;
        for (auto const& i: sorted) {
                if (last && i == *last) {
                        throw LanguageTagError (String::compose("Duplicate %1 subtag %2", dcp::LanguageTag::subtag_type_name(type), i.subtag()));
                }
                last = i;
        }
}
 
 
void
LanguageTag::set_variants (vector<VariantSubtag> variants)
{
        check_for_duplicates (variants, SubtagType::VARIANT);
        _variants = variants;
}
 
 
void
LanguageTag::add_extlang (ExtlangSubtag extlang)
{
        if (find(_extlangs.begin(), _extlangs.end(), extlang) != _extlangs.end()) {
                throw LanguageTagError (String::compose("Duplicate Extlang subtag %1", extlang.subtag()));
        }
 
        _extlangs.push_back (extlang);
}
 
 
void
LanguageTag::set_extlangs (vector<ExtlangSubtag> extlangs)
{
        check_for_duplicates (extlangs, SubtagType::EXTLANG);
        _extlangs = extlangs;
}
 
 
string
LanguageTag::description () const
{
        if (!_language) {
                throw LanguageTagError("No language set up");
        }
 
        string d;
 
        for (auto const& i: _variants) {
                optional<SubtagData> variant = get_subtag_data (SubtagType::VARIANT, i.subtag());
                DCP_ASSERT (variant);
                d += variant->description + " dialect of ";
        }
 
        auto language = get_subtag_data (SubtagType::LANGUAGE, _language->subtag());
        DCP_ASSERT (language);
        d += language->description;
 
        if (_script) {
                auto script = get_subtag_data (SubtagType::SCRIPT, _script->subtag());
                DCP_ASSERT (script);
                d += " written using the " + script->description + " script";
        }
 
        if (_region) {
                auto region = get_subtag_data (SubtagType::REGION, _region->subtag());
                DCP_ASSERT (region);
                d += " for " + region->description;
        }
 
        for (auto const& i: _extlangs) {
                auto extlang = get_subtag_data (SubtagType::EXTLANG, i.subtag());
                DCP_ASSERT (extlang);
                d += ", " + extlang->description;
        }
 
        return d;
}
 
 
vector<LanguageTag::SubtagData> const &
LanguageTag::get_all (SubtagType type)
{
        switch (type) {
        case SubtagType::LANGUAGE:
                return language_list;
        case SubtagType::SCRIPT:
                return script_list;
        case SubtagType::REGION:
                return region_list;
        case SubtagType::VARIANT:
                return variant_list;
        case SubtagType::EXTLANG:
                return extlang_list;
        }
 
        return language_list;
}
 
 
string
LanguageTag::subtag_type_name (SubtagType type)
{
        switch (type) {
                case SubtagType::LANGUAGE:
                        return "Language";
                case SubtagType::SCRIPT:
                        return "Script";
                case SubtagType::REGION:
                        return "Region";
                case SubtagType::VARIANT:
                        return "Variant";
                case SubtagType::EXTLANG:
                        return "Extended";
        }
 
        return {};
}
 
 
bool
dcp::operator== (dcp::LanguageTag const& a, dcp::LanguageTag const& b)
{
        return a.to_string() == b.to_string();
}
 
 
bool
dcp::operator!= (dcp::LanguageTag const& a, dcp::LanguageTag const& b)
{
        return a.to_string() != b.to_string();
}
 
 
bool
dcp::operator< (dcp::LanguageTag const& a, dcp::LanguageTag const& b)
{
        return a.to_string() < b.to_string();
}
 
 
ostream&
dcp::operator<< (ostream& os, dcp::LanguageTag const& tag)
{
        os << tag.to_string();
        return os;
}
 
 
vector<pair<LanguageTag::SubtagType, LanguageTag::SubtagData>>
LanguageTag::subtags () const
{
        vector<pair<SubtagType, SubtagData>> s;
 
        if (_language) {
                s.push_back (make_pair(SubtagType::LANGUAGE, *get_subtag_data(SubtagType::LANGUAGE, _language->subtag())));
        }
 
        if (_script) {
                s.push_back (make_pair(SubtagType::SCRIPT, *get_subtag_data(SubtagType::SCRIPT, _script->subtag())));
        }
 
        if (_region) {
                s.push_back (make_pair(SubtagType::REGION, *get_subtag_data(SubtagType::REGION, _region->subtag())));
        }
 
        for (auto const& i: _variants) {
                s.push_back (make_pair(SubtagType::VARIANT, *get_subtag_data(SubtagType::VARIANT, i.subtag())));
        }
 
        for (auto const& i: _extlangs) {
                s.push_back (make_pair(SubtagType::EXTLANG, *get_subtag_data(SubtagType::EXTLANG, i.subtag())));
        }
 
        return s;
}
 
 
optional<LanguageTag::SubtagData>
LanguageTag::get_subtag_data (LanguageTag::SubtagType type, string subtag)
{
        switch (type) {
        case SubtagType::LANGUAGE:
                return find_in_list(language_list, subtag);
        case SubtagType::SCRIPT:
                return find_in_list(script_list, subtag);
        case SubtagType::REGION:
                return find_in_list(region_list, subtag);
        case SubtagType::VARIANT:
                return find_in_list(variant_list, subtag);
        case SubtagType::EXTLANG:
                return find_in_list(extlang_list, subtag);
        }
 
        return {};
}
 
 
optional<string>
LanguageTag::get_subtag_description (LanguageTag::SubtagType type, string subtag)
{
        auto data = get_subtag_data (type, subtag);
        if (!data) {
                return {};
        }
 
        return data->description;
}
 
 
void
load_language_tag_list (boost::filesystem::path tags_directory, string name, std::function<void (std::string, std::string)> add)
{
        File f(tags_directory / name, "r");
        if (!f) {
                throw FileError ("Could not open tags file", tags_directory / name, errno);
        }
        char buffer[512];
 
        while (!f.eof()) {
                char* r = f.gets(buffer, sizeof(buffer));
                if (r == 0) {
                        break;
                }
                string a = buffer;
                trim (a);
                r = f.gets(buffer, sizeof(buffer));
                if (r == 0) {
                        throw FileError ("Bad tags file", tags_directory / name, -1);
                }
                string b = buffer;
                trim (b);
                add (a, b);
        }
}
 
 
void
dcp::load_language_tag_lists (boost::filesystem::path tags_directory)
{
        auto add_subtag = [](vector<LanguageTag::SubtagData>& list, string a, string b) {
                list.push_back (LanguageTag::SubtagData(a, b));
        };
 
        load_language_tag_list (tags_directory, "language", [&add_subtag](string a, string b) { add_subtag(language_list, a, b); });
        load_language_tag_list (tags_directory, "variant",  [&add_subtag](string a, string b) { add_subtag(variant_list, a, b); });
        load_language_tag_list (tags_directory, "region",   [&add_subtag](string a, string b) { add_subtag(region_list, a, b); });
        load_language_tag_list (tags_directory, "script",   [&add_subtag](string a, string b) { add_subtag(script_list, a, b); });
        load_language_tag_list (tags_directory, "extlang",  [&add_subtag](string a, string b) { add_subtag(extlang_list, a, b); });
 
        load_language_tag_list (tags_directory, "dcnc", [](string a, string b) { dcnc_list.push_back(make_pair(a, b)); });
}
 
 
vector<pair<string, string>> dcp::dcnc_tags ()
{
        return dcnc_list;
}