src/Encoding.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Encoding.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  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef ENCODING_H
  14 #define ENCODING_H
  15
  16 #include "support/docstring.h"
  17 #include "support/types.h"
  18
  19 #include <map>
  20 #include <set>
  21 #include <vector>
  22
  23 namespace lyx {
  24
  25 namespace support { class FileName; }
  26
  27 class Buffer;
  28 class LaTeXFeatures;
  29
  30 class EncodingException : public std::exception {
  31 public:
  32         EncodingException(char_type c);
  33         virtual ~EncodingException() throw() {}
  34         virtual const char * what() const throw();
  35
  36         char_type failed_char;
  37         int par_id;
  38         pos_type pos;
  39 };
  40
  41
  42 ///
  43 class Encoding {
  44 public:
  45         /// Which LaTeX package handles this encoding?
  46         enum Package {
  47                 none,
  48                 inputenc,
  49                 CJK,
  50                 japanese
  51         };
  52         ///
  53         Encoding() {}
  54         ///
  55         Encoding(std::string const & n, std::string const & l,
  56                  std::string const & g, std::string const & i,
  57                  bool f, Package p);
  58         ///
  59         void init() const;
  60         ///
  61         std::string const & name() const { return name_; }
  62         ///
  63         std::string const & latexName() const { return latexName_; }
  64         ///
  65         std::string const & guiName() const { return guiName_; }
  66         ///
  67         std::string const & iconvName() const { return iconvName_; }
  68         ///
  69         bool const & hasFixedWidth() const { return fixedwidth_; }
  70         /// \p c is representable in this encoding without a LaTeX macro
  71         bool encodable(char_type c) const;
  72         /**
  73          * Convert \p c to something that LaTeX can understand.
  74          * This is either the character itself (if it is representable
  75          * in this encoding), or a LaTeX macro.
  76          * If the character is not representable in this encoding, but no
  77          * LaTeX macro is known, a warning is given of lyxerr, and the
  78          * character is returned.
  79          * \return the converted character and a flag indicating whether
  80          * the command needs to be terminated by {} or a space.
  81          */
  82         std::pair<docstring, bool> latexChar(char_type c) const;
  83         /**
  84          * Convert \p input to something that LaTeX can understand.
  85          * This is either the string itself (if it is representable
  86          * in this encoding), or a LaTeX macro.
  87          * If a character is not representable in this encoding, but no
  88          * LaTeX macro is known, a warning is given of lyxerr, and the
  89          * character is returned in the second string of the pair and
  90          * omitted in the first.
  91          * \p dryrun specifies whether the string is used within source
  92          * preview (which yields a special warning).
  93          */
  94         std::pair<docstring, docstring> latexString(docstring const input,
  95                                                     bool dryrun = false) const;
  96         /// Which LaTeX package handles this encoding?
  97         Package package() const { return package_; }
  98         /// A list of all characters usable in this encoding
  99         std::vector<char_type> symbolsList() const;
 100 private:
 101         ///
 102         std::string name_;
 103         ///
 104         std::string latexName_;
 105         ///
 106         std::string guiName_;
 107         ///
 108         std::string iconvName_;
 109         /// Is this a fixed width encoding?
 110         bool fixedwidth_;
 111         ///
 112         typedef std::set<char_type> CharSet;
 113         /// Set of UCS4 characters that we can encode (for singlebyte
 114         /// encodings only)
 115         mutable CharSet encodable_;
 116         /// All code points below this are encodable. This helps us to avoid
 117         /// lokup of ASCII characters in encodable_ and gives about 1 sec
 118         /// speedup on export of the Userguide.
 119         mutable char_type start_encodable_;
 120         /// Which LaTeX package handles this encoding?
 121         Package package_;
 122         /**
 123          * If this is true the stored information about the encoding covers
 124          * all encodable characters. We set this to false initially so that
 125          * we only need to query iconv for the actually used encodings.
 126          * This is needed especially for the multibyte encodings, if we
 127          * complete all encoding info on startup it takes 2-3 minutes.
 128          */
 129         mutable bool complete_;
 130 };
 131
 132 class Encodings {
 133 public:
 134         ///
 135         typedef std::set<char_type> MathCommandSet;
 136         ///
 137         typedef std::set<char_type> TextCommandSet;
 138         ///
 139         typedef std::set<char_type> MathSymbolSet;
 140         ///
 141         typedef std::map<std::string, Encoding> EncodingList;
 142         /// iterator to iterate over all encodings.
 143         /// We hide the fact that our encoding list is implemented as a map.
 144         class const_iterator : public EncodingList::const_iterator {
 145                 typedef EncodingList::const_iterator base;
 146         public:
 147                 const_iterator() : base() {}
 148                 const_iterator(base const & b) : base(b) {}
 149                 Encoding const & operator*() const { return base::operator*().second; }
 150                 Encoding const * operator->() const { return &(base::operator*().second); }
 151         };
 152         ///
 153         Encodings();
 154         /// Read the encodings.
 155         /// \param encfile encodings definition file
 156         /// \param symbolsfile unicode->LaTeX mapping file
 157         void read(support::FileName const & encfile,
 158                   support::FileName const & symbolsfile);
 159         /// Get encoding from LyX name \p name
 160         Encoding const * fromLyXName(std::string const & name) const;
 161         /// Get encoding from LaTeX name \p name
 162         Encoding const * fromLaTeXName(std::string const & name) const;
 163
 164         ///
 165         const_iterator begin() const { return encodinglist.begin(); }
 166         ///
 167         const_iterator end() const { return encodinglist.end(); }
 168
 169         ///
 170         enum LetterForm {
 171                 ///
 172                 FORM_ISOLATED,
 173                 ///
 174                 FORM_FINAL,
 175                 ///
 176                 FORM_INITIAL,
 177                 ///
 178                 FORM_MEDIAL
 179         };
 180         ///
 181         static bool isHebrewComposeChar(char_type c);
 182         ///
 183         static bool isArabicComposeChar(char_type c);
 184         ///
 185         static bool isArabicSpecialChar(char_type c);
 186         ///
 187         static bool isArabicChar(char_type c);
 188         ///
 189         static char_type transformChar(char_type c, LetterForm form);
 190         /// Is this a combining char?
 191         static bool isCombiningChar(char_type c);
 192         /// Return the TIPA shortcut
 193         static std::string const TIPAShortcut(char_type c);
 194         /**
 195          * Is this a known char from some language?
 196          * If \p preamble is empty and code point \p c is known to belong
 197          * to a supported script, true is returned and \p preamble is set
 198          * to the corresponding entry in the unicodesymbols file.
 199          * If \p preamble is not empty, a check is made whether code point
 200          * \p c is a known character matching the preamble entry.
 201          */
 202         static bool isKnownScriptChar(char_type const c, std::string & preamble);
 203         /**
 204          * Do we have to output this character as LaTeX command in any case?
 205          * This is true if the "force" flag is set.
 206          * We need this if the inputencoding does not support a certain glyph.
 207          */
 208         static bool isForced(char_type c);
 209         /**
 210          * Do we have to display in italics this character when in mathmode?
 211          * This is true if the "mathalpha" flag is set. We use this for
 212          * letters and accented characters that are output as math commands.
 213          */
 214         static bool isMathAlpha(char_type c);
 215         /**
 216          * Register \p c as a mathmode command.
 217          */
 218         static void addMathCmd(char_type c) { mathcmd.insert(c); }
 219         /**
 220          * Register \p c as a textmode command.
 221          */
 222         static void addTextCmd(char_type c) { textcmd.insert(c); }
 223         /**
 224          * Register \p c as a mathmode symbol.
 225          */
 226         static void addMathSym(char_type c) { mathsym.insert(c); }
 227         /**
 228          * Tell whether \p c is registered as a mathmode command.
 229          */
 230         static bool isMathCmd(char_type c) { return mathcmd.count(c); }
 231         /**
 232          * Tell whether \p c is registered as a textmode command.
 233          */
 234         static bool isTextCmd(char_type c) { return textcmd.count(c); }
 235         /**
 236          * Tell whether \p c is registered as a mathmode symbol.
 237          */
 238         static bool isMathSym(char_type c) { return mathsym.count(c); }
 239         /**
 240          * Initialize mathcmd, textcmd, and mathsym sets.
 241          */
 242         static void initUnicodeMath(Buffer const & buffer, bool for_master = true);
 243         /**
 244          * If \p c cannot be encoded in the given \p encoding, convert
 245          * it to something that LaTeX can understand in mathmode.
 246          * \p needsTermination indicates whether the command needs to be
 247          * terminated by {} or a space.
 248          * \return whether \p command is a mathmode command
 249          */
 250         static bool latexMathChar(char_type c, bool mathmode,
 251                         Encoding const * encoding, docstring & command,
 252                         bool & needsTermination);
 253         /**
 254          * Convert the LaTeX command in \p cmd to the corresponding unicode
 255          * point and set \p combining to true if it is a combining symbol.
 256          * \p needsTermination indicates whether the command needs to be
 257          * terminated by {} or a space.
 258          */
 259         static char_type fromLaTeXCommand(docstring const & cmd, int cmdtype,
 260                         bool & combining, bool & needsTermination,
 261                         std::set<std::string> * req = 0);
 262         ///
 263         enum LatexCmd {
 264                 ///
 265                 MATH_CMD = 1,
 266                 ///
 267                 TEXT_CMD = 2
 268         };
 269         /**
 270          * Convert the LaTeX commands in \p cmd and \return a docstring
 271          * of corresponding unicode points. The conversion stops at the
 272          * first command which could not be converted, and the remaining
 273          * unconverted commands are returned in \p rem.
 274          * The \p cmdtype parameter can be used to limit recognized
 275          * commands to math or text mode commands only.
 276          * \p needsTermination indicates whether the command needs to be
 277          * terminated by {} or a space.
 278          */
 279         static docstring fromLaTeXCommand(docstring const & cmd, int cmdtype,
 280                         bool & needsTermination, docstring & rem,
 281                         std::set<std::string> * req = 0);
 282         /**
 283          * Add the preamble snippet needed for the output of \p c to
 284          * \p features.
 285          * This does not depend on the used encoding, since the inputenc
 286          * package only maps the code point \p c to a command, it does not
 287          * make this command available.
 288          */
 289         static void validate(char_type c, LaTeXFeatures & features, bool for_mathed = false);
 290
 291 private:
 292         ///
 293         EncodingList encodinglist;
 294         ///
 295         static MathCommandSet mathcmd;
 296         ///
 297         static TextCommandSet textcmd;
 298         ///
 299         static MathSymbolSet mathsym;
 300 };
 301
 302 extern Encodings encodings;
 303
 304
 305 } // namespace lyx
 306
 307 #endif