src/Language.cpp

   1 /**
   2  * \file Language.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jean-Marc Lasgouttes
   8  * \author Jürgen Spitzmüller
   9  * \author Dekel Tsur
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "Language.h"
  17
  18 #include "Encoding.h"
  19 #include "LaTeXFonts.h"
  20 #include "Lexer.h"
  21 #include "LyXRC.h"
  22
  23 #include "support/debug.h"
  24 #include "support/FileName.h"
  25 #include "support/filetools.h"
  26 #include "support/lassert.h"
  27 #include "support/lstrings.h"
  28 #include "support/Messages.h"
  29
  30 using namespace std;
  31 using namespace lyx::support;
  32
  33 namespace lyx {
  34
  35 Languages languages;
  36 Language const * ignore_language = 0;
  37 Language const * default_language = 0;
  38 Language const * latex_language = 0;
  39 Language const * reset_language = 0;
  40
  41
  42 bool Language::isPolyglossiaExclusive() const
  43 {
  44         return babel().empty() && !polyglossia().empty() && requires().empty();
  45 }
  46
  47
  48 bool Language::isBabelExclusive() const
  49 {
  50         return !babel().empty() && polyglossia().empty() && requires().empty();
  51 }
  52
  53
  54 docstring const Language::translateLayout(string const & m) const
  55 {
  56         if (m.empty())
  57                 return docstring();
  58
  59         if (!isAscii(m)) {
  60                 lyxerr << "Warning: not translating `" << m
  61                        << "' because it is not pure ASCII.\n";
  62                 return from_utf8(m);
  63         }
  64
  65         TranslationMap::const_iterator it = layoutTranslations_.find(m);
  66         if (it != layoutTranslations_.end())
  67                 return it->second;
  68
  69         docstring t = from_ascii(m);
  70         cleanTranslation(t);
  71         return t;
  72 }
  73
  74
  75 string Language::fontenc(BufferParams const & params) const
  76 {
  77         // Don't use LaTeX fonts, so just return the language's preferred
  78         // (although this is not used with nonTeXFonts anyway).
  79         if (params.useNonTeXFonts)
  80                 return fontenc_.front() == "ASCII" ? "T1" : fontenc_.front();
  81
  82         // Determine optimal font encoding
  83         // We check whether the used rm font supports an encoding our language supports
  84         LaTeXFont const & lf =
  85                 theLaTeXFonts().getLaTeXFont(from_ascii(params.fontsRoman()));
  86         vector<string> const lfe = lf.fontencs();
  87         for (auto & fe : fontenc_) {
  88                 // ASCII means: support all T* encodings plus OT1
  89                 if (fe == "ASCII") {
  90                         for (auto & afe : lfe) {
  91                                 if (afe == "OT1" || prefixIs(afe, "T"))
  92                                         // we found a suitable one; return that.
  93                                         return afe;
  94                         }
  95                 }
  96                 // For other encodings, just check whether the font supports it
  97                 if (lf.hasFontenc(fe))
  98                         return fe;
  99         }
 100         // We did not find a suitable one; just take the first in the list,
 101         // the priorized one (which is "T1" for ASCII).
 102         return fontenc_.front() == "ASCII" ? "T1" : fontenc_.front();
 103 }
 104
 105
 106 string Language::dateFormat(size_t i) const
 107 {
 108         if (i > dateformats_.size())
 109                 return string();
 110         return dateformats_.at(i);
 111 }
 112
 113
 114 bool Language::readLanguage(Lexer & lex)
 115 {
 116         enum LanguageTags {
 117                 LA_AS_BABELOPTS = 1,
 118                 LA_BABELNAME,
 119                 LA_DATEFORMATS,
 120                 LA_ENCODING,
 121                 LA_END,
 122                 LA_FONTENC,
 123                 LA_GUINAME,
 124                 LA_HAS_GUI_SUPPORT,
 125                 LA_INTERNAL_ENC,
 126                 LA_LANG_CODE,
 127                 LA_LANG_VARIETY,
 128                 LA_POLYGLOSSIANAME,
 129                 LA_POLYGLOSSIAOPTS,
 130                 LA_POSTBABELPREAMBLE,
 131                 LA_PREBABELPREAMBLE,
 132                 LA_PROVIDES,
 133                 LA_REQUIRES,
 134                 LA_QUOTESTYLE,
 135                 LA_RTL
 136         };
 137
 138         // Keep these sorted alphabetically!
 139         LexerKeyword languageTags[] = {
 140                 { "asbabeloptions",       LA_AS_BABELOPTS },
 141                 { "babelname",            LA_BABELNAME },
 142                 { "dateformats",          LA_DATEFORMATS },
 143                 { "encoding",             LA_ENCODING },
 144                 { "end",                  LA_END },
 145                 { "fontencoding",         LA_FONTENC },
 146                 { "guiname",              LA_GUINAME },
 147                 { "hasguisupport",        LA_HAS_GUI_SUPPORT },
 148                 { "internalencoding",     LA_INTERNAL_ENC },
 149                 { "langcode",             LA_LANG_CODE },
 150                 { "langvariety",          LA_LANG_VARIETY },
 151                 { "polyglossianame",      LA_POLYGLOSSIANAME },
 152                 { "polyglossiaopts",      LA_POLYGLOSSIAOPTS },
 153                 { "postbabelpreamble",    LA_POSTBABELPREAMBLE },
 154                 { "prebabelpreamble",     LA_PREBABELPREAMBLE },
 155                 { "provides",             LA_PROVIDES },
 156                 { "quotestyle",           LA_QUOTESTYLE },
 157                 { "requires",             LA_REQUIRES },
 158                 { "rtl",                  LA_RTL }
 159         };
 160
 161         bool error = false;
 162         bool finished = false;
 163         lex.pushTable(languageTags);
 164         // parse style section
 165         while (!finished && lex.isOK() && !error) {
 166                 int le = lex.lex();
 167                 // See comment in LyXRC.cpp.
 168                 switch (le) {
 169                 case Lexer::LEX_FEOF:
 170                         continue;
 171
 172                 case Lexer::LEX_UNDEF: // parse error
 173                         lex.printError("Unknown language tag `$$Token'");
 174                         error = true;
 175                         continue;
 176
 177                 default:
 178                         break;
 179                 }
 180                 switch (static_cast<LanguageTags>(le)) {
 181                 case LA_END: // end of structure
 182                         finished = true;
 183                         break;
 184                 case LA_AS_BABELOPTS:
 185                         lex >> as_babel_options_;
 186                         break;
 187                 case LA_BABELNAME:
 188                         lex >> babel_;
 189                         break;
 190                 case LA_POLYGLOSSIANAME:
 191                         lex >> polyglossia_name_;
 192                         break;
 193                 case LA_POLYGLOSSIAOPTS:
 194                         lex >> polyglossia_opts_;
 195                         break;
 196                 case LA_QUOTESTYLE:
 197                         lex >> quote_style_;
 198                         break;
 199                 case LA_ENCODING:
 200                         lex >> encodingStr_;
 201                         break;
 202                 case LA_FONTENC: {
 203                         lex.eatLine();
 204                         vector<string> const fe =
 205                                 getVectorFromString(lex.getString(true), "|");
 206                         fontenc_.insert(fontenc_.end(), fe.begin(), fe.end());
 207                         break;
 208                 }
 209                 case LA_DATEFORMATS: {
 210                         lex.eatLine();
 211                         vector<string> const df =
 212                                 getVectorFromString(trim(lex.getString(true), "\""), "|");
 213                         dateformats_.insert(dateformats_.end(), df.begin(), df.end());
 214                         break;
 215                 }
 216                 case LA_GUINAME:
 217                         lex >> display_;
 218                         break;
 219                 case LA_HAS_GUI_SUPPORT:
 220                         lex >> has_gui_support_;
 221                         break;
 222                 case LA_INTERNAL_ENC:
 223                         lex >> internal_enc_;
 224                         break;
 225                 case LA_LANG_CODE:
 226                         lex >> code_;
 227                         break;
 228                 case LA_LANG_VARIETY:
 229                         lex >> variety_;
 230                         break;
 231                 case LA_POSTBABELPREAMBLE:
 232                         babel_postsettings_ =
 233                                 lex.getLongString(from_ascii("EndPostBabelPreamble"));
 234                         break;
 235                 case LA_PREBABELPREAMBLE:
 236                         babel_presettings_ =
 237                                 lex.getLongString(from_ascii("EndPreBabelPreamble"));
 238                         break;
 239                 case LA_REQUIRES:
 240                         lex >> requires_;
 241                         break;
 242                 case LA_PROVIDES:
 243                         lex >> provides_;
 244                         break;
 245                 case LA_RTL:
 246                         lex >> rightToLeft_;
 247                         break;
 248                 }
 249         }
 250         lex.popTable();
 251         return finished && !error;
 252 }
 253
 254
 255 bool Language::read(Lexer & lex)
 256 {
 257         as_babel_options_ = 0;
 258         encoding_ = 0;
 259         internal_enc_ = 0;
 260         rightToLeft_ = 0;
 261
 262         if (!lex.next()) {
 263                 lex.printError("No name given for language: `$$Token'.");
 264                 return false;
 265         }
 266
 267         lang_ = lex.getString();
 268         LYXERR(Debug::INFO, "Reading language " << lang_);
 269         if (!readLanguage(lex)) {
 270                 LYXERR0("Error parsing language `" << lang_ << '\'');
 271                 return false;
 272         }
 273
 274         encoding_ = encodings.fromLyXName(encodingStr_);
 275         if (!encoding_ && !encodingStr_.empty()) {
 276                 encoding_ = encodings.fromLyXName("iso8859-1");
 277                 LYXERR0("Unknown encoding " << encodingStr_);
 278         }
 279         if (fontenc_.empty())
 280                 fontenc_.push_back("ASCII");
 281         if (dateformats_.empty()) {
 282                 dateformats_.push_back("MMMM dd, yyyy");
 283                 dateformats_.push_back("MMM dd, yyyy");
 284                 dateformats_.push_back("M/d/yyyy");
 285         }
 286         return true;
 287 }
 288
 289
 290 void Language::readLayoutTranslations(Language::TranslationMap const & trans, bool replace)
 291 {
 292         TranslationMap::const_iterator const end = trans.end();
 293         for (TranslationMap::const_iterator it = trans.begin(); it != end; ++it) {
 294                 if (replace
 295                         || layoutTranslations_.find(it->first) == layoutTranslations_.end())
 296                         layoutTranslations_[it->first] = it->second;
 297         }
 298 }
 299
 300
 301 void Languages::read(FileName const & filename)
 302 {
 303         Lexer lex;
 304         lex.setFile(filename);
 305         lex.setContext("Languages::read");
 306         while (lex.isOK()) {
 307                 int le = lex.lex();
 308                 switch (le) {
 309                 case Lexer::LEX_FEOF:
 310                         continue;
 311
 312                 default:
 313                         break;
 314                 }
 315                 if (lex.getString() != "Language") {
 316                         lex.printError("Unknown Language tag `$$Token'");
 317                         continue;
 318                 }
 319                 Language l;
 320                 l.read(lex);
 321                 if (!lex)
 322                         break;
 323                 if (l.lang() == "latex") {
 324                         // Check if latex language was not already defined.
 325                         LASSERT(latex_language == 0, continue);
 326                         static const Language latex_lang = l;
 327                         latex_language = &latex_lang;
 328                 } else if (l.lang() == "ignore") {
 329                         // Check if ignore language was not already defined.
 330                         LASSERT(ignore_language == 0, continue);
 331                         static const Language ignore_lang = l;
 332                         ignore_language = &ignore_lang;
 333                 } else
 334                         languagelist[l.lang()] = l;
 335         }
 336
 337         default_language = getLanguage("english");
 338         if (!default_language) {
 339                 LYXERR0("Default language \"english\" not found!");
 340                 default_language = &(*languagelist.begin()).second;
 341                 LYXERR0("Using \"" << default_language->lang() << "\" instead!");
 342         }
 343
 344         // Read layout translations
 345         FileName const path = libFileSearch(string(), "layouttranslations");
 346         readLayoutTranslations(path);
 347 }
 348
 349
 350 namespace {
 351
 352 bool readTranslations(Lexer & lex, Language::TranslationMap & trans)
 353 {
 354         while (lex.isOK()) {
 355                 if (lex.checkFor("End"))
 356                         break;
 357                 if (!lex.next(true))
 358                         return false;
 359                 string const key = lex.getString();
 360                 if (!lex.next(true))
 361                         return false;
 362                 docstring const val = lex.getDocString();
 363                 trans[key] = val;
 364         }
 365         return true;
 366 }
 367
 368
 369 enum Match {
 370         NoMatch,
 371         ApproximateMatch,
 372         ExactMatch
 373 };
 374
 375
 376 Match match(string const & code, Language const & lang)
 377 {
 378         // we need to mimic gettext: code can be a two-letter code, which
 379         // should match all variants, e.g. "de" should match "de_DE",
 380         // "de_AT" etc.
 381         // special case for chinese:
 382         // simplified  => code == "zh_CN", langcode == "zh_CN"
 383         // traditional => code == "zh_TW", langcode == "zh_CN"
 384         string const variety = lang.variety();
 385         string const langcode = variety.empty() ?
 386                                 lang.code() : lang.code() + '_' + variety;
 387         string const name = lang.lang();
 388         if ((code == langcode && name != "chinese-traditional")
 389                 || (code == "zh_TW"  && name == "chinese-traditional"))
 390                 return ExactMatch;
 391         if ((code.size() == 2) && (langcode.size() > 2)
 392                 && (code + '_' == langcode.substr(0, 3)))
 393                 return ApproximateMatch;
 394         return NoMatch;
 395 }
 396
 397 } // namespace
 398
 399
 400
 401 Language const * Languages::getFromCode(string const & code) const
 402 {
 403         LanguageList::const_iterator const lbeg = languagelist.begin();
 404         LanguageList::const_iterator const lend = languagelist.end();
 405         // Try for exact match first
 406         for (LanguageList::const_iterator lit = lbeg; lit != lend; ++lit) {
 407                 if (match(code, lit->second) == ExactMatch)
 408                         return &lit->second;
 409         }
 410         // If not found, look for lang prefix (without country) instead
 411         for (LanguageList::const_iterator lit = lbeg; lit != lend; ++lit) {
 412                 if (match(code, lit->second) == ApproximateMatch)
 413                         return &lit->second;
 414         }
 415         LYXERR0("Unknown language `" + code + "'");
 416         return 0;
 417 }
 418
 419
 420 void Languages::readLayoutTranslations(support::FileName const & filename)
 421 {
 422         Lexer lex;
 423         lex.setFile(filename);
 424         lex.setContext("Languages::read");
 425
 426         // 1) read all translations (exact and approximate matches) into trans
 427         typedef std::map<string, Language::TranslationMap> TransMap;
 428         TransMap trans;
 429         LanguageList::iterator const lbeg = languagelist.begin();
 430         LanguageList::iterator const lend = languagelist.end();
 431         while (lex.isOK()) {
 432                 if (!lex.checkFor("Translation")) {
 433                         if (lex.isOK())
 434                                 lex.printError("Unknown layout translation tag `$$Token'");
 435                         break;
 436                 }
 437                 if (!lex.next(true))
 438                         break;
 439                 string const code = lex.getString();
 440                 bool found = getFromCode(code);
 441                 if (!found) {
 442                         lex.printError("Unknown language `" + code + "'");
 443                         break;
 444                 }
 445                 if (!readTranslations(lex, trans[code])) {
 446                         lex.printError("Could not read layout translations for language `"
 447                                 + code + "'");
 448                         break;
 449                 }
 450         }
 451
 452         // 2) merge all translations into the languages
 453         // exact translations overwrite approximate ones
 454         TransMap::const_iterator const tbeg = trans.begin();
 455         TransMap::const_iterator const tend = trans.end();
 456         for (TransMap::const_iterator tit = tbeg; tit != tend; ++tit) {
 457                 for (LanguageList::iterator lit = lbeg; lit != lend; ++lit) {
 458                         Match const m = match(tit->first, lit->second);
 459                         if (m == NoMatch)
 460                                 continue;
 461                         lit->second.readLayoutTranslations(tit->second,
 462                                                            m == ExactMatch);
 463                 }
 464         }
 465
 466 }
 467
 468
 469 Language const * Languages::getLanguage(string const & language) const
 470 {
 471         if (language == "reset")
 472                 return reset_language;
 473         if (language == "ignore")
 474                 return ignore_language;
 475         const_iterator it = languagelist.find(language);
 476         return it == languagelist.end() ? reset_language : &it->second;
 477 }
 478
 479
 480 } // namespace lyx