src/Language.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Language.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author Dekel Tsur
  10  * \author Jürgen Vigna
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef LANGUAGE_H
  16 #define LANGUAGE_H
  17
  18 #include "support/docstring.h"
  19
  20 #include <map>
  21
  22
  23 namespace lyx {
  24
  25 namespace support { class FileName; }
  26
  27 class Encoding;
  28 class Lexer;
  29
  30 ///
  31 class Language {
  32 public:
  33         ///
  34         Language() : rightToLeft_(false), translated_(false) {}
  35         /// LyX language name
  36         std::string const & lang() const { return lang_; }
  37         /// Babel language name
  38         std::string const & babel() const { return babel_; }
  39         /// polyglossia language name
  40         std::string const & polyglossia() const { return polyglossia_name_; }
  41         /// polyglossia language options
  42         std::string const & polyglossiaOpts() const { return polyglossia_opts_; }
  43         /// quotation marks style
  44         std::string const & quoteStyle() const { return quote_style_; }
  45         /// requirement (package, function)
  46         std::string const & requires() const { return requires_; }
  47         /// translatable GUI name
  48         std::string const & display() const { return display_; }
  49         /// is this a RTL language?
  50         bool rightToLeft() const { return rightToLeft_; }
  51         /// Is an (at least partial) translation of this language available?
  52         bool translated() const { return translated_; }
  53         /// Is an (at least partial) translation of this language available?
  54         void translated(bool trans) { translated_ = trans; }
  55         /**
  56          * Translate a string from the layout files that appears in the output.
  57          * It takes the translations from lib/layouttranslations instead of
  58          * the .mo files. This should be used for every translation that
  59          * appears in the exported document, since the output must not depend
  60          * on installed locales. Non-ASCII keys are not translated. */
  61         docstring const translateLayout(std::string const & msg) const;
  62         /// default encoding
  63         Encoding const * encoding() const { return encoding_; }
  64         ///
  65         std::string const & encodingStr() const { return encodingStr_; }
  66         /// language code
  67         std::string const & code() const { return code_; }
  68         /// set code (needed for rc.spellchecker_alt_lang)
  69         void setCode(std::string const c) { code_ = c; }
  70         /// language variety (needed by aspell checker)
  71         std::string const & variety() const { return variety_; }
  72         /// set variety (needed for rc.spellchecker_alt_lang)
  73         void setVariety(std::string const v) { variety_ = v; }
  74         /// preamble settings after babel was called
  75         std::string const & babel_postsettings() const { return babel_postsettings_; }
  76         /// preamble settings before babel is called
  77         std::string const & babel_presettings() const { return babel_presettings_; }
  78         /// This language internally sets a font encoding
  79         bool internalFontEncoding() const { return internal_enc_; }
  80         /// This language needs to be passed to babel itself (not the class)
  81         bool asBabelOptions() const { return as_babel_options_; }
  82         ///
  83         bool read(Lexer & lex);
  84         ///
  85         bool readLanguage(Lexer & lex);
  86         ///
  87         typedef std::map<std::string, docstring> TranslationMap;
  88         ///
  89         void readLayoutTranslations(TranslationMap const & trans, bool replace);
  90         // for the use in std::map
  91         friend bool operator<(Language const & p, Language const & q);
  92 private:
  93         ///
  94         std::string lang_;
  95         ///
  96         std::string babel_;
  97         ///
  98         std::string polyglossia_name_;
  99         ///
 100         std::string polyglossia_opts_;
 101         ///
 102         std::string quote_style_;
 103         ///
 104         std::string requires_;
 105         ///
 106         std::string display_;
 107         ///
 108         bool rightToLeft_;
 109         ///
 110         std::string encodingStr_;
 111         ///
 112         Encoding const * encoding_;
 113         ///
 114         std::string code_;
 115         ///
 116         std::string variety_;
 117         ///
 118         std::string babel_postsettings_;
 119         ///
 120         std::string babel_presettings_;
 121         ///
 122         bool internal_enc_;
 123         ///
 124         bool as_babel_options_;
 125         ///
 126         bool translated_;
 127         ///
 128         TranslationMap layoutTranslations_;
 129 };
 130
 131
 132 inline bool operator<(Language const & p, Language const & q)
 133 {
 134         return q.lang() > p.lang();
 135 }
 136
 137
 138 class Languages
 139 {
 140 public:
 141         ///
 142         typedef std::map<std::string, Language> LanguageList;
 143         ///
 144         typedef LanguageList::const_iterator const_iterator;
 145         ///
 146         typedef LanguageList::size_type size_type;
 147         ///
 148         void read(support::FileName const & filename);
 149         ///
 150         void readLayoutTranslations(support::FileName const & filename);
 151         ///
 152         void readInstalledTranslations(support::FileName const & filename);
 153         ///
 154         Language const * getLanguage(std::string const & language) const;
 155         ///
 156         size_type size() const { return languagelist.size(); }
 157         ///
 158         const_iterator begin() const { return languagelist.begin(); }
 159         ///
 160         const_iterator end() const { return languagelist.end(); }
 161         ///
 162
 163 private:
 164         ///
 165         LanguageList languagelist;
 166 };
 167
 168 /// Global singleton instance.
 169 extern Languages languages;
 170 /// Default language defined in LyXRC
 171 extern Language const * default_language;
 172 /// Used to indicate that the language should be left unchanged when
 173 /// applying a font change.
 174 extern Language const * ignore_language;
 175 /// Default language defined in LyXRC
 176 extern Language const * latex_language;
 177 /// Used to indicate that the language should be reset to the Buffer
 178 // language when applying a font change.
 179 extern Language const * reset_language;
 180
 181
 182 } // namespace lyx
 183
 184 #endif