]> git.lyx.org Git - lyx.git/blobdiff - src/Encoding.cpp
Update my email and status.
[lyx.git] / src / Encoding.cpp
index 899d8e178600ee7d39dd273c74a717fa697bc3c8..48e9271395fc43dcdf5bafca902b8067e14dbdec 100644 (file)
@@ -22,6 +22,7 @@
 #include "LyXRC.h"
 
 #include "support/debug.h"
+#include "support/gettext.h"
 #include "support/FileName.h"
 #include "support/lstrings.h"
 #include "support/textutils.h"
@@ -228,6 +229,21 @@ char_type const arabic_start = 0x0621;
 char_type const arabic_end = 0x06cc;
 
 
+enum CharInfoFlags {
+       ///
+       CharInfoCombining = 1,
+       ///
+       CharInfoTextFeature = 2,
+       ///
+       CharInfoMathFeature = 4,
+       ///
+       CharInfoForce = 8,
+       ///
+       CharInfoTextNoTermination = 16,
+       ///
+       CharInfoMathNoTermination = 32,
+};
+
 /// Information about a single UCS4 character
 struct CharInfo {
        /// LaTeX command (text mode) for this character
@@ -239,16 +255,24 @@ struct CharInfo {
        /// Needed LaTeX preamble (or feature) for math mode
        string mathpreamble;
        /// Is this a combining character?
-       bool combining;
+       bool combining() const { return flags & CharInfoCombining ? true : false; }
        /// Is \c textpreamble a feature known by LaTeXFeatures, or a raw LaTeX
        /// command?
-       bool textfeature;
+       bool textfeature() const { return flags & CharInfoTextFeature ? true : false; }
        /// Is \c mathpreamble a feature known by LaTeXFeatures, or a raw LaTeX
        /// command?
-       bool mathfeature;
+       bool mathfeature() const { return flags & CharInfoMathFeature ? true : false; }
        /// Always force the LaTeX command, even if the encoding contains
        /// this character?
-       bool force;
+       bool force() const { return flags & CharInfoForce ? true : false; }
+       /// TIPA shortcut
+       string tipashortcut;
+       /// \c textcommand needs no termination (such as {} or space).
+       bool textnotermination() const { return flags & CharInfoTextNoTermination ? true : false; }
+       /// \c mathcommand needs no termination (such as {} or space).
+       bool mathnotermination() const { return flags & CharInfoMathNoTermination ? true : false; }
+       ///
+       unsigned int flags;
 };
 
 
@@ -281,8 +305,9 @@ const char * EncodingException::what() const throw()
 
 
 Encoding::Encoding(string const & n, string const & l, string const & g,
-                  string const & i, bool f, Encoding::Package p)
-       : name_(n), latexName_(l), guiName_(g), iconvName_(i), fixedwidth_(f), package_(p)
+                  string const & i, bool f, bool u, Encoding::Package p)
+       : name_(n), latexName_(l), guiName_(g), iconvName_(i), fixedwidth_(f),
+         unsafe_(u), package_(p)
 {
        if (n == "ascii") {
                // ASCII can encode 128 code points and nothing else
@@ -316,7 +341,7 @@ void Encoding::init() const
                                continue;
                        char_type const uc = ucs4[0];
                        CharInfoMap::const_iterator const it = unicodesymbols.find(uc);
-                       if (it == unicodesymbols.end() || !it->second.force)
+                       if (it == unicodesymbols.end() || !it->second.force())
                                encodable_.insert(uc);
                }
        } else {
@@ -328,7 +353,7 @@ void Encoding::init() const
                        vector<char> const eightbit = ucs4_to_eightbit(&c, 1, iconvName_);
                        if (!eightbit.empty()) {
                                CharInfoMap::const_iterator const it = unicodesymbols.find(c);
-                               if (it == unicodesymbols.end() || !it->second.force)
+                               if (it == unicodesymbols.end() || !it->second.force())
                                        encodable_.insert(c);
                        }
                }
@@ -344,19 +369,25 @@ void Encoding::init() const
 }
 
 
-docstring Encoding::latexChar(char_type c, bool for_mathed) const
+bool Encoding::encodable(char_type c) const
 {
        // assure the used encoding is properly initialized
        init();
 
        if (iconvName_ == "UTF-8" && package_ == none)
-               return docstring(1, c);
+               return true;
        if (c < start_encodable_ && !encodings.isForced(c))
-               return docstring(1, c);
+               return true;
        if (encodable_.find(c) != encodable_.end())
-               return docstring(1, c);
-       if (for_mathed)
-               return docstring();
+               return true;
+       return false;
+}
+
+
+pair<docstring, bool> Encoding::latexChar(char_type c) const
+{
+       if (encodable(c))
+               return make_pair(docstring(1, c), false);
 
        // c cannot (or should not) be encoded in this encoding
        CharInfoMap::const_iterator const it = unicodesymbols.find(c);
@@ -364,8 +395,47 @@ docstring Encoding::latexChar(char_type c, bool for_mathed) const
                throw EncodingException(c);
        // at least one of mathcommand and textcommand is nonempty
        if (it->second.textcommand.empty())
-               return "\\ensuremath{" + it->second.mathcommand + '}';
-       return it->second.textcommand;
+               return make_pair(
+                       "\\ensuremath{" + it->second.mathcommand + '}', false);
+       return make_pair(it->second.textcommand, !it->second.textnotermination());
+}
+
+
+pair<docstring, docstring> Encoding::latexString(docstring const input, bool dryrun) const
+{
+       docstring result;
+       docstring uncodable;
+       bool terminate = false;
+       for (size_t n = 0; n < input.size(); ++n) {
+               try {
+                       char_type const c = input[n];
+                       pair<docstring, bool> latex_char = latexChar(c);
+                       docstring const latex = latex_char.first;
+                       if (terminate && !prefixIs(latex, '\\')
+                           && !prefixIs(latex, '{')
+                           && !prefixIs(latex, '}')) {
+                                       // Prevent eating of a following
+                                       // space or command corruption by
+                                       // following characters
+                                       if (latex == " ")
+                                               result += "{}";
+                                       else
+                                               result += " ";
+                               }
+                       result += latex;
+                       terminate = latex_char.second;
+               } catch (EncodingException & /* e */) {
+                       LYXERR0("Uncodable character in latexString!");
+                       if (dryrun) {
+                               result += "<" + _("LyX Warning: ")
+                                          + _("uncodable character") + " '";
+                               result += docstring(1, input[n]);
+                               result += "'>";
+                       } else
+                               uncodable += input[n];
+               }
+       }
+       return make_pair(result, uncodable);
 }
 
 
@@ -389,10 +459,14 @@ vector<char_type> Encoding::symbolsList() const
 
 
 bool Encodings::latexMathChar(char_type c, bool mathmode,
-                       Encoding const * encoding, docstring & command)
+                       Encoding const * encoding, docstring & command,
+                       bool & needsTermination)
 {
+       command = empty_docstring();
        if (encoding)
-               command = encoding->latexChar(c, true);
+               if (encoding->encodable(c))
+                       command = docstring(1, c);
+       needsTermination = false;
 
        CharInfoMap::const_iterator const it = unicodesymbols.find(c);
        if (it == unicodesymbols.end()) {
@@ -407,10 +481,12 @@ bool Encodings::latexMathChar(char_type c, bool mathmode,
                        (!mathmode && it->second.textcommand.empty());
        if (use_math) {
                command = it->second.mathcommand;
+               needsTermination = !it->second.mathnotermination();
                addMathCmd(c);
        } else {
                if (!encoding || command.empty()) {
                        command = it->second.textcommand;
+                       needsTermination = !it->second.textnotermination();
                        addTextCmd(c);
                }
                if (mathmode)
@@ -420,24 +496,43 @@ bool Encodings::latexMathChar(char_type c, bool mathmode,
 }
 
 
-char_type Encodings::fromLaTeXCommand(docstring const & cmd, bool & combining)
+char_type Encodings::fromLaTeXCommand(docstring const & cmd, int cmdtype,
+               bool & combining, bool & needsTermination, set<string> * req)
 {
        CharInfoMap::const_iterator const end = unicodesymbols.end();
        CharInfoMap::const_iterator it = unicodesymbols.begin();
        for (combining = false; it != end; ++it) {
                docstring const math = it->second.mathcommand;
                docstring const text = it->second.textcommand;
-               if (math == cmd || text == cmd) {
-                       combining = it->second.combining;
+               if ((cmdtype & MATH_CMD) && math == cmd) {
+                       combining = it->second.combining();
+                       needsTermination = !it->second.mathnotermination();
+                       if (req && it->second.mathfeature() &&
+                           !it->second.mathpreamble.empty())
+                               req->insert(it->second.mathpreamble);
+                       return it->first;
+               }
+               if ((cmdtype & TEXT_CMD) && text == cmd) {
+                       combining = it->second.combining();
+                       needsTermination = !it->second.textnotermination();
+                       if (req && it->second.textfeature() &&
+                           !it->second.textpreamble.empty())
+                               req->insert(it->second.textpreamble);
                        return it->first;
                }
        }
+       needsTermination = false;
        return 0;
 }
 
 
-docstring Encodings::fromLaTeXCommand(docstring const & cmd, docstring & rem)
+docstring Encodings::fromLaTeXCommand(docstring const & cmd, int cmdtype,
+               bool & needsTermination, docstring & rem, set<string> * req)
 {
+       needsTermination = false;
+       rem = empty_docstring();
+       bool const mathmode = cmdtype & MATH_CMD;
+       bool const textmode = cmdtype & TEXT_CMD;
        docstring symbols;
        size_t i = 0;
        size_t const cmdend = cmd.size();
@@ -468,8 +563,10 @@ docstring Encodings::fromLaTeXCommand(docstring const & cmd, docstring & rem)
                size_t unicmd_size = 0;
                char_type c = 0;
                for (; it != uniend; ++it) {
-                       docstring const math = it->second.mathcommand;
-                       docstring const text = it->second.textcommand;
+                       docstring const math = mathmode ? it->second.mathcommand
+                                                       : docstring();
+                       docstring const text = textmode ? it->second.textcommand
+                                                       : docstring();
                        size_t cur_size = max(math.size(), text.size());
                        // The current math or text unicode command cannot
                        // match, or we already matched a longer one
@@ -516,44 +613,70 @@ docstring Encodings::fromLaTeXCommand(docstring const & cmd, docstring & rem)
                                j = k - 1;
                                i = j + 1;
                                unicmd_size = cur_size;
+                               if (math == tmp)
+                                       needsTermination = !it->second.mathnotermination();
+                               else
+                                       needsTermination = !it->second.textnotermination();
+                               if (req) {
+                                       if (math == tmp && it->second.mathfeature() &&
+                                           !it->second.mathpreamble.empty())
+                                               req->insert(it->second.mathpreamble);
+                                       if (text == tmp && it->second.textfeature() &&
+                                           !it->second.textpreamble.empty())
+                                               req->insert(it->second.textpreamble);
+                               }
                        }
                }
                if (unicmd_size)
                        symbols += c;
-               else if (j + 1 == cmdend)
+               else if (j + 1 == cmdend) {
                        // No luck. Return what remains
                        rem = cmd.substr(i);
+                       if (needsTermination && !rem.empty()) {
+                               if (rem.substr(0, 2) == "{}") {
+                                       rem = rem.substr(2);
+                                       needsTermination = false;
+                               } else if (rem[0] == ' ') {
+                                       needsTermination = false;
+                                       // LaTeX would swallow all spaces
+                                       rem = ltrim(rem);
+                               }
+                       }
+               }
        }
        return symbols;
 }
 
 
-void Encodings::initUnicodeMath(Buffer const & buffer, bool clear_sets)
+void Encodings::initUnicodeMath(Buffer const & buffer, bool for_master)
 {
 #ifdef TEX2LYX
        // The code below is not needed in tex2lyx and requires additional stuff
        (void)buffer;
-       (void)clear_sets;
+       (void)for_master;
 #else
-       if (clear_sets) {
+       if (for_master) {
                mathcmd.clear();
                textcmd.clear();
                mathsym.clear();
        }
 
-       // Check master
+       // Check this buffer
        Inset & inset = buffer.inset();
        InsetIterator it = inset_iterator_begin(inset);
        InsetIterator const end = inset_iterator_end(inset);
        for (; it != end; ++it)
                it->initUnicodeMath();
 
+       if (!for_master)
+               return;
+
        // Check children
-       BufferList::iterator bit = theBufferList().begin();
-       BufferList::iterator const bend = theBufferList().end();
+       ListOfBuffers blist = buffer.getDescendents();
+       ListOfBuffers::const_iterator bit = blist.begin();
+       ListOfBuffers::const_iterator const bend = blist.end();
        for (; bit != bend; ++bit)
-               if (buffer.isChild(*bit))
-                       initUnicodeMath(**bit, false);
+               initUnicodeMath(**bit, false);
 #endif
 }
 
@@ -569,13 +692,20 @@ void Encodings::validate(char_type c, LaTeXFeatures & features, bool for_mathed)
        CharInfoMap::const_iterator const it = unicodesymbols.find(c);
        if (it != unicodesymbols.end()) {
                // In mathed, c could be used both in textmode and mathmode
-               bool const use_math = (for_mathed && isMathCmd(c)) ||
+               bool const math_mode = for_mathed && isMathCmd(c);
+               bool const use_math = math_mode ||
                                      (!for_mathed && it->second.textcommand.empty());
                bool const use_text = (for_mathed && isTextCmd(c)) ||
                                      (!for_mathed && !it->second.textcommand.empty());
-               if (use_math) {
+               bool const plain_utf8 = (features.runparams().encoding->name() == "utf8-plain");
+               bool const unicode_math = (features.isRequired("unicode-math")
+                       && features.isAvailable("unicode-math"));
+               // with utf8-plain, we only load packages when in mathed (see #7766)
+               // and if we do not use unicode-math
+               if ((math_mode && !unicode_math)
+                    || (use_math && !plain_utf8)) {
                        if (!it->second.mathpreamble.empty()) {
-                               if (it->second.mathfeature) {
+                               if (it->second.mathfeature()) {
                                        string feats = it->second.mathpreamble;
                                        while (!feats.empty()) {
                                                string feat;
@@ -586,9 +716,10 @@ void Encodings::validate(char_type c, LaTeXFeatures & features, bool for_mathed)
                                        features.addPreambleSnippet(it->second.mathpreamble);
                        }
                }
-               if (use_text) {
+               // with utf8-plain, we do not load packages (see #7766)
+               if (use_text && !plain_utf8) {
                        if (!it->second.textpreamble.empty()) {
-                               if (it->second.textfeature) {
+                               if (it->second.textfeature()) {
                                        string feats = it->second.textpreamble;
                                        while (!feats.empty()) {
                                                string feat;
@@ -601,7 +732,7 @@ void Encodings::validate(char_type c, LaTeXFeatures & features, bool for_mathed)
                }
        }
        if (for_mathed && isMathSym(c)) {
-               features.require("relsize");
+               features.require("amstext");
                features.require("lyxmathsym");
        }
 #endif
@@ -649,11 +780,20 @@ bool Encodings::isCombiningChar(char_type c)
 {
        CharInfoMap::const_iterator const it = unicodesymbols.find(c);
        if (it != unicodesymbols.end())
-               return it->second.combining;
+               return it->second.combining();
        return false;
 }
 
 
+string const Encodings::TIPAShortcut(char_type c)
+{
+       CharInfoMap::const_iterator const it = unicodesymbols.find(c);
+       if (it != unicodesymbols.end())
+               return it->second.tipashortcut;
+       return string();
+}
+
+
 bool Encodings::isKnownScriptChar(char_type const c, string & preamble)
 {
        CharInfoMap::const_iterator const it = unicodesymbols.find(c);
@@ -684,15 +824,25 @@ bool Encodings::isMathAlpha(char_type c)
 }
 
 
-Encoding const * Encodings::fromLyXName(string const & name) const
+Encoding const *
+Encodings::fromLyXName(string const & name, bool allowUnsafe) const
 {
        EncodingList::const_iterator const it = encodinglist.find(name);
+       if (!allowUnsafe && it->second.unsafe())
+               return 0;
        return it != encodinglist.end() ? &it->second : 0;
 }
 
 
-Encoding const * Encodings::fromLaTeXName(string const & name) const
+Encoding const *
+Encodings::fromLaTeXName(string const & n, bool allowUnsafe) const
 {
+       string name = n;
+       // FIXME: if we have to test for too many of these synonyms,
+       // we should instead extend the format of lib/encodings
+       if (n == "ansinew")
+               name = "cp1252";
+
        // We don't use find_if because it makes copies of the pairs in
        // the map.
        // This linear search is OK since we don't have many encodings.
@@ -700,15 +850,17 @@ Encoding const * Encodings::fromLaTeXName(string const & name) const
        // most at the top of lib/encodings.
        EncodingList::const_iterator const end = encodinglist.end();
        for (EncodingList::const_iterator it = encodinglist.begin(); it != end; ++it)
-               if (it->second.latexName() == name)
+               if (it->second.latexName() == name) {
+                       if (!allowUnsafe && it->second.unsafe())
+                               return 0;
                        return &it->second;
+               }
        return 0;
 }
 
 
 Encodings::Encodings()
-{
-}
+{}
 
 
 void Encodings::read(FileName const & encfile, FileName const & symbolsfile)
@@ -747,19 +899,33 @@ void Encodings::read(FileName const & encfile, FileName const & symbolsfile)
                        break;
                flags = symbolslex.getString();
 
-               info.combining = false;
-               info.textfeature = false;
-               info.force = false;
+               info.flags = 0;
+               if (suffixIs(info.textcommand, '}'))
+                       info.flags |= CharInfoTextNoTermination;
+               if (suffixIs(info.mathcommand, '}'))
+                       info.flags |= CharInfoMathNoTermination;
                while (!flags.empty()) {
                        string flag;
                        flags = split(flags, flag, ',');
                        if (flag == "combining") {
-                               info.combining = true;
+                               info.flags |= CharInfoCombining;
                        } else if (flag == "force") {
-                               info.force = true;
+                               info.flags |= CharInfoForce;
                                forced.insert(symbol);
                        } else if (flag == "mathalpha") {
                                mathalpha.insert(symbol);
+                       } else if (flag == "notermination=text") {
+                               info.flags |= CharInfoTextNoTermination;
+                       } else if (flag == "notermination=math") {
+                               info.flags |= CharInfoMathNoTermination;
+                       } else if (flag == "notermination=both") {
+                               info.flags |= CharInfoTextNoTermination;
+                               info.flags |= CharInfoMathNoTermination;
+                       } else if (flag == "notermination=none") {
+                               info.flags &= ~CharInfoTextNoTermination;
+                               info.flags &= ~CharInfoMathNoTermination;
+                       } else if (contains(flag, "tipashortcut=")) {
+                               info.tipashortcut = split(flag, '=');
                        } else {
                                lyxerr << "Ignoring unknown flag `" << flag
                                       << "' for symbol `0x"
@@ -792,16 +958,23 @@ void Encodings::read(FileName const & encfile, FileName const & symbolsfile)
                        breakout = true;
                }
 
+               // backward compatibility
+               if (info.mathpreamble == "esintoramsmath")
+                       info.mathpreamble = "esint|amsmath";
+
                if (!info.textpreamble.empty())
-                       info.textfeature = info.textpreamble[0] != '\\';
+                       if (info.textpreamble[0] != '\\')
+                               info.flags |= CharInfoTextFeature;
                if (!info.mathpreamble.empty())
-                       info.mathfeature = info.mathpreamble[0] != '\\';
+                       if (info.mathpreamble[0] != '\\')
+                               info.flags |= CharInfoMathFeature;
 
                LYXERR(Debug::INFO, "Read unicode symbol " << symbol << " '"
                        << to_utf8(info.textcommand) << "' '" << info.textpreamble
-                       << "' " << info.combining << ' ' << info.textfeature
-                       << " '" << to_utf8(info.mathcommand) << "' '"
-                       << info.mathpreamble << "' " << info.mathfeature);
+                       << " '" << info.textfeature() << ' ' << info.textnotermination()
+                       << ' ' << to_utf8(info.mathcommand) << "' '" << info.mathpreamble
+                       << "' " << info.mathfeature() << ' ' << info.mathnotermination()
+                       << ' ' << info.combining() << ' ' << info.force());
 
                // we assume that at least one command is nonempty when using unicodesymbols
                if (!info.textcommand.empty() || !info.mathcommand.empty())
@@ -814,7 +987,7 @@ void Encodings::read(FileName const & encfile, FileName const & symbolsfile)
        // Now read the encodings
        enum {
                et_encoding = 1,
-               et_end,
+               et_end
        };
 
        LexerKeyword encodingtags[] = {
@@ -840,10 +1013,15 @@ void Encodings::read(FileName const & encfile, FileName const & symbolsfile)
                        lex.next();
                        string const width = lex.getString();
                        bool fixedwidth = false;
+                       bool unsafe = false;
                        if (width == "fixed")
                                fixedwidth = true;
                        else if (width == "variable")
                                fixedwidth = false;
+                       else if (width == "variableunsafe") {
+                               fixedwidth = false;
+                               unsafe = true;
+                       }
                        else
                                lex.printError("Unknown width");
 
@@ -863,7 +1041,8 @@ void Encodings::read(FileName const & encfile, FileName const & symbolsfile)
 
                        LYXERR(Debug::INFO, "Reading encoding " << name);
                        encodinglist[name] = Encoding(name, latexname,
-                               guiname, iconvname, fixedwidth, package);
+                               guiname, iconvname, fixedwidth, unsafe,
+                               package);
 
                        if (lex.lex() != et_end)
                                lex.printError("Missing end");