listerrors.lyx : Update a link.

[lyx.git] / src / Encoding.h

diff --git a/src/Encoding.h b/src/Encoding.h
index f5b02826bf688164428e625f34ef3c1158ed43f8..effde73ffc7e7cc645b7472e6abed57f586756f2 100644 (file)
--- a/src/Encoding.h
+++ b/src/Encoding.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author Jean-Marc Lasgouttes
  *
  * Full author contact details are available in file CREDITS.
@@ -24,6 +24,7 @@ namespace lyx {
 
 namespace support { class FileName; }
 
+class Buffer;
 class LaTeXFeatures;
 
 class EncodingException : public std::exception {
@@ -45,13 +46,15 @@ public:
        enum Package {
                none,
                inputenc,
-               CJK
+               CJK,
+               japanese
        };
        ///
        Encoding() {}
        ///
        Encoding(std::string const & n, std::string const & l,
-                std::string const & i, bool f, Package p);
+                std::string const & g, std::string const & i,
+                bool f, Package p);
        ///
        void init() const;
        ///
@@ -59,7 +62,11 @@ public:
        ///
        std::string const & latexName() const { return latexName_; }
        ///
+       std::string const & guiName() const { return guiName_; }
+       ///
        std::string const & iconvName() const { return iconvName_; }
+       ///
+       bool const & hasFixedWidth() const { return fixedwidth_; }
        /**
         * Convert \p c to something that LaTeX can understand.
         * This is either the character itself (if it is representable
@@ -68,7 +75,7 @@ public:
         * LaTeX macro is known, a warning is given of lyxerr, and the
         * character is returned.
         */
-       docstring latexChar(char_type c) const;
+       docstring latexChar(char_type c, bool no_commands = false) const;
        /// Which LaTeX package handles this encoding?
        Package package() const { return package_; }
        /// A list of all characters usable in this encoding
@@ -79,6 +86,8 @@ private:
        ///
        std::string latexName_;
        ///
+       std::string guiName_;
+       ///
        std::string iconvName_;
        /// Is this a fixed width encoding?
        bool fixedwidth_;
@@ -105,6 +114,12 @@ private:
 
 class Encodings {
 public:
+       ///
+       typedef std::set<char_type> MathCommandSet;
+       ///
+       typedef std::set<char_type> TextCommandSet;
+       ///
+       typedef std::set<char_type> MathSymbolSet;
        ///
        typedef std::map<std::string, Encoding> EncodingList;
        /// iterator to iterate over all encodings.
@@ -167,10 +182,75 @@ public:
         */
        static bool isKnownScriptChar(char_type const c, std::string & preamble);
        /**
-        * Convert \p c to something that LaTeX can understand in math mode.
-        * \return whether \p command is a math mode command
+        * Do we have to output this character as LaTeX command in any case?
+        * This is true if the "force" flag is set.
+        * We need this if the inputencoding does not support a certain glyph.
+        */
+       static bool isForced(char_type c);
+       /**
+        * Do we have to display in italics this character when in mathmode?
+        * This is true if the "mathalpha" flag is set. We use this for
+        * letters and accented characters that are output as math commands.
+        */
+       static bool isMathAlpha(char_type c);
+       /**
+        * Register \p c as a mathmode command.
+        */
+       static void addMathCmd(char_type c) { mathcmd.insert(c); }
+       /**
+        * Register \p c as a textmode command.
+        */
+       static void addTextCmd(char_type c) { textcmd.insert(c); }
+       /**
+        * Register \p c as a mathmode symbol.
+        */
+       static void addMathSym(char_type c) { mathsym.insert(c); }
+       /**
+        * Tell whether \p c is registered as a mathmode command.
+        */
+       static bool isMathCmd(char_type c) { return mathcmd.count(c); }
+       /**
+        * Tell whether \p c is registered as a textmode command.
         */
-       static bool latexMathChar(char_type c, docstring & command);
+       static bool isTextCmd(char_type c) { return textcmd.count(c); }
+       /**
+        * Tell whether \p c is registered as a mathmode symbol.
+        */
+       static bool isMathSym(char_type c) { return mathsym.count(c); }
+       /**
+        * Initialize mathcmd, textcmd, and mathsym sets.
+        */
+       static void initUnicodeMath(Buffer const & buffer, bool for_master = true);
+       /**
+        * If \p c cannot be encoded in the given \p encoding, convert
+        * it to something that LaTeX can understand in mathmode.
+        * \return whether \p command is a mathmode command
+        */
+       static bool latexMathChar(char_type c, bool mathmode,
+                       Encoding const * encoding, docstring & command);
+       /**
+        * Convert the LaTeX command in \p cmd to the corresponding unicode
+        * point and set \p combining to true if it is a combining symbol
+        */
+       static char_type fromLaTeXCommand(docstring const & cmd, int cmdtype,
+                       bool & combining, std::set<std::string> * req = 0);
+       ///
+       enum LatexCmd {
+               ///
+               MATH_CMD = 1,
+               ///
+               TEXT_CMD = 2
+       };
+       /**
+        * Convert the LaTeX commands in \p cmd and \return a docstring
+        * of corresponding unicode points. The conversion stops at the
+        * first command which could not be converted, and the remaining
+        * unconverted commands are returned in \p rem.
+        * The \p cmdtype parameter can be used to limit recognized
+        * commands to math or text mode commands only.
+        */
+       static docstring fromLaTeXCommand(docstring const & cmd, int cmdtype,
+                       docstring & rem, std::set<std::string> * req = 0);
        /**
         * Add the preamble snippet needed for the output of \p c to
         * \p features.
@@ -183,6 +263,12 @@ public:
 private:
        ///
        EncodingList encodinglist;
+       ///
+       static MathCommandSet mathcmd;
+       ///
+       static TextCommandSet textcmd;
+       ///
+       static MathSymbolSet mathsym;
 };
 
 extern Encodings encodings;