]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.cpp
InsetIndex: enable escaping for terms in the index
[lyx.git] / src / LaTeXFeatures.cpp
index 8a515a14052615c0db26761c4b4d6d7311977615..bcf9ddc82d7c1cf4cf5391bb70260bce7548d1db 100644 (file)
@@ -73,6 +73,11 @@ static docstring const lyxarrow_def = from_ascii(
        "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
        "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
 
+static docstring const aastex_case_def = from_ascii(
+               "\\providecommand\\case[2]{\\mbox{$\\frac{#1}{#2}$}}%");
+// Copied from https://github.com/AASJournals/AASTeX60/blob/master/cls/aastex63.cls#L1645
+// Adapted to providecommand for compatibility reasons.
+
 // ZERO WIDTH SPACE (ZWSP) is actually not a space character
 // but marks a line break opportunity. Several commands provide a
 // line break opportunity. They differ in side-effects:
@@ -188,44 +193,11 @@ static docstring const tabularnewline_def = from_ascii(
        "%% Because html converters don't know tabularnewline\n"
        "\\providecommand{\\tabularnewline}{\\\\}\n");
 
-static docstring const lyxgreyedout_def = from_ascii(
-       "%% The greyedout annotation environment\n"
-       "\\newenvironment{lyxgreyedout}\n"
-       "  {\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
-       "  {\\ignorespacesafterend\\egroup}\n");
-
-static docstring const lyxgreyedout_rtl_def = from_ascii(
-       "%% The greyedout annotation environment (with RTL support)\n"
-       "\\NewEnviron{lyxgreyedout}{%\n"
-       "\\if@rl%\n"
-       "\\everypar{\\textcolor{note_fontcolor}\\beginL\\ignorespaces}%\n"
-       "\\BODY\\everypar{\\ignorespacesafterend\\endL}\n"
-       "\\else%\n"
-       "\\textcolor{note_fontcolor}\\bgroup\\ignorespaces%\n"
-       "\\BODY\\ignorespacesafterend\\egroup\n"
-       "\\fi}\n");
-
-static docstring const lyxgreyedout_luartl_def = from_ascii(
-       "%% The greyedout annotation environment (with RTL support)\n"
-       "\\NewEnviron{lyxgreyedout}{%\n"
-       "\\if@RTL%\n"
-       "\\everypar{\\color{note_fontcolor}\\pardir TRT \\textdir TRT\\ignorespaces}%\n"
-       "\\BODY\\everypar{\\ignorespacesafterend}\n"
-       "\\else%\n"
-       "\\textcolor{note_fontcolor}\\bgroup\\ignorespaces%\n"
-       "\\BODY\\ignorespacesafterend\\egroup\n"
-       "\\fi}\n");
-
-static docstring const lyxgreyedout_luartl_babel_def = from_ascii(
-       "%% The greyedout annotation environment (with RTL support)\n"
-       "\\NewEnviron{lyxgreyedout}{%\n"
-       "\\if@rl%\n"
-       "\\everypar{\\color{note_fontcolor}\\pardir TRT \\textdir TRT\\ignorespaces}%\n"
-       "\\BODY\\everypar{\\ignorespacesafterend}\n"
-       "\\else%\n"
-       "\\textcolor{note_fontcolor}\\bgroup\\ignorespaces%\n"
-       "\\BODY\\ignorespacesafterend\\egroup\n"
-       "\\fi}\n");
+static docstring const cellvarwidth_def = from_ascii(
+       "%% Variable width box for table cells\n"
+       "\\newenvironment{cellvarwidth}[1][t]\n"
+       "    {\\begin{varwidth}[#1]{\\linewidth}}\n"
+       "    {\\@finalstrut\\@arstrutbox\\end{varwidth}}\n");
 
 // We want to omit the file extension for includegraphics, but this does not
 // work when the filename contains other dots.
@@ -498,6 +470,7 @@ static docstring const textschwa_def = from_ascii(
 // split-level fractions
 static docstring const xfrac_def = from_ascii(
           "\\usepackage{xfrac}\n");
+
 static docstring const smallLetterFrac_def = from_ascii(
        "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{default}{text}\n"
        "  {phantom=c, scale-factor=1.0, slash-left-kern=-.05em}\n"
@@ -573,6 +546,52 @@ static docstring const lyxmintcaption_def = from_ascii(
        "}\n");
 
 
+docstring const lyxgreyedoutDef(bool const rtl, bool const ct, bool const lua, bool const babel)
+{
+       odocstringstream ods;
+
+       if (rtl) {
+               ods << "%% The greyedout annotation environment (with RTL support)\n"
+                   << "\\NewEnviron{lyxgreyedout}{%\n";
+               if (lua && !babel)
+                       // luabidi uses this switch
+                       ods << "  \\if@RTL%\n";
+               else
+                       ods << "  \\if@rl%\n";
+               ods << "    \\everypar{%\n";
+               if (lua)
+                       ods << "      \\pardir TRT \\textdir TRT\\normalfont\\normalsize\\textcolor{note_fontcolor}\\ignorespaces%\n";
+               else
+                       ods << "      \\normalfont\\normalsize\\textcolor{note_fontcolor}\\beginL\\ignorespaces%\n";
+               ods << "    }%\n";
+               if (ct)
+                       ods << "    \\colorlet{lyxadded}{lyxadded!30}\\colorlet{lyxdeleted}{lyxdeleted!30}%\n";
+               if (lua)
+                       ods << "    \\BODY\\everypar{\\ignorespacesafterend}%\n";
+               else
+                       ods << "    \\BODY\\everypar{\\ignorespacesafterend\\endL}%\n";
+               ods << "  \\else%\n";
+               if (ct)
+                       ods << "    \\colorlet{lyxadded}{lyxadded!30}\\colorlet{lyxdeleted}{lyxdeleted!30}%\n";
+               ods << "    \\normalfont\\normalsize\\textcolor{note_fontcolor}\\bgroup\\ignorespaces%\n"
+                   << "    \\BODY\\ignorespacesafterend\\egroup%\n"
+                   << "  \\fi%\n"
+                   << "}\n";
+       } else {
+               ods << "%% The greyedout annotation environment\n"
+                   << "\\newenvironment{lyxgreyedout}\n"
+                   << "{";
+               if (ct)
+                       ods << "\\colorlet{lyxadded}{lyxadded!30}\\colorlet{lyxdeleted}{lyxdeleted!30}%\n ";
+               ods << "\\normalfont\\normalsize\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
+                   << "{\\ignorespacesafterend\\egroup}\n";
+       }
+
+       return ods.str();
+}
+
+
+
 /////////////////////////////////////////////////////////////////////
 //
 // LyXHTML strings
@@ -764,8 +783,8 @@ bool LaTeXFeatures::isProvided(string const & name) const
        if (params_.useNonTeXFonts)
                return params_.documentClass().provides(name);
 
-       bool const ot1 = (params_.main_font_encoding() == "default"
-               || params_.main_font_encoding() == "OT1");
+       bool const ot1 = (runparams().main_fontenc == "default"
+               || runparams().main_fontenc == "OT1");
        bool const complete = (params_.fontsSans() == "default"
                && params_.fontsTypewriter() == "default");
        bool const nomath = (params_.fontsMath() == "default");
@@ -818,7 +837,7 @@ void addSnippet(std::list<TexString> & list, TexString ts, bool allow_dupes)
                            return ts.str == ts2.str;
                    })
            )
-               list.push_back(move(ts));
+               list.push_back(std::move(ts));
 }
 
 
@@ -835,7 +854,7 @@ TexString getSnippets(std::list<TexString> const & list)
 
 void LaTeXFeatures::addPreambleSnippet(TexString snippet, bool allow_dupes)
 {
-       addSnippet(preamble_snippets_, move(snippet), allow_dupes);
+       addSnippet(preamble_snippets_, std::move(snippet), allow_dupes);
 }
 
 
@@ -1229,14 +1248,10 @@ string const LaTeXFeatures::getPackageOptions() const
 {
        ostringstream packageopts;
        // Output all the package option stuff we have been asked to do.
-       map<string, string>::const_iterator it =
-               params_.documentClass().packageOptions().begin();
-       map<string, string>::const_iterator en =
-               params_.documentClass().packageOptions().end();
-       for (; it != en; ++it)
-               if (mustProvide(it->first))
-                       packageopts << "\\PassOptionsToPackage{" << it->second << "}"
-                                << "{" << it->first << "}\n";
+       for (auto const & p : params_.documentClass().packageOptions())
+               if (mustProvide(p.first))
+                       packageopts << "\\PassOptionsToPackage{" << p.second << "}"
+                                << "{" << p.first << "}\n";
        return packageopts.str();
 }
 
@@ -1263,8 +1278,8 @@ string const LaTeXFeatures::getPackages() const
 
        if (mustProvide("changebar")) {
                packages << "\\usepackage";
-               if (runparams_.flavor == FLAVOR::LATEX
-                   || runparams_.flavor == FLAVOR::DVILUATEX)
+               if (runparams_.flavor == Flavor::LaTeX
+                   || runparams_.flavor == Flavor::DviLuaTeX)
                        packages << "[dvips]";
                packages << "{changebar}\n";
        }
@@ -1278,8 +1293,8 @@ string const LaTeXFeatures::getPackages() const
 
        // [pdf]lscape is used to rotate longtables
        if (mustProvide("lscape")) {
-               if (runparams_.flavor == FLAVOR::LATEX
-                   || runparams_.flavor == FLAVOR::DVILUATEX)
+               if (runparams_.flavor == Flavor::LaTeX
+                   || runparams_.flavor == Flavor::DviLuaTeX)
                        packages << "\\usepackage{lscape}\n";
                else
                        packages << "\\usepackage{pdflscape}\n";
@@ -1300,8 +1315,8 @@ string const LaTeXFeatures::getPackages() const
        // if fontspec or newtxmath is used, AMS packages have to be loaded
        // before fontspec (in BufferParams)
        string const amsPackages = loadAMSPackages();
-       bool const ot1 = (params_.main_font_encoding() == "default"
-                         || params_.main_font_encoding() == "OT1");
+       bool const ot1 = (runparams().main_fontenc == "default"
+                         || runparams().main_fontenc == "OT1");
        bool const use_newtxmath =
                theLaTeXFonts().getLaTeXFont(from_ascii(params_.fontsMath())).getUsedPackage(
                        ot1, false, false) == "newtxmath";
@@ -1496,7 +1511,8 @@ string const LaTeXFeatures::getPackages() const
        }
 
        // fixltx2e provides subscript
-       if (mustProvide("subscript") && !isRequired("fixltx2e"))
+       if (mustProvide("subscript") && !isRequired("fixltx2e")
+           && !isAvailable("LaTeX-2005/12/01"))
                packages << "\\usepackage{subscript}\n";
 
        // footmisc must be loaded after setspace
@@ -1526,10 +1542,10 @@ TexString LaTeXFeatures::getMacros() const
                macros << "\\XeTeXdashbreakstate 0" << '\n';
 
        if (mustProvide("papersize")) {
-               if (runparams_.flavor == FLAVOR::LATEX
-                   || runparams_.flavor == FLAVOR::DVILUATEX)
+               if (runparams_.flavor == Flavor::LaTeX
+                   || runparams_.flavor == Flavor::DviLuaTeX)
                        macros << papersizedvi_def << '\n';
-               else if  (runparams_.flavor == FLAVOR::LUATEX)
+               else if  (runparams_.flavor == Flavor::LuaTeX)
                        macros << papersizepdflua_def << '\n';
                else
                        macros << papersizepdf_def << '\n';
@@ -1562,19 +1578,22 @@ TexString LaTeXFeatures::getMacros() const
        if (mustProvide("lyxarrow"))
                macros << lyxarrow_def << '\n';
 
+       if (mustProvide("aastex_case"))
+               macros << aastex_case_def << '\n';
+
        if (mustProvide("lyxzerowidthspace"))
                macros << lyxZWSP_def << '\n';
 
        if (!usePolyglossia() && mustProvide("textgreek")) {
-           // ensure LGR font encoding is defined also if fontenc is not loaded by LyX
-               if (params_.main_font_encoding() == "default")
+               // ensure LGR font encoding is defined also if fontenc is not loaded by LyX
+               if (runparams().main_fontenc == "default")
                        macros << textgreek_LGR_def;
                macros << textgreek_def << '\n';
        }
 
        if (!usePolyglossia() && mustProvide("textcyrillic")) {
                // ensure T2A font encoding is set up also if fontenc is not loaded by LyX
-               if (params_.main_font_encoding() == "default")
+               if (runparams().main_fontenc == "default")
                        macros << textcyr_T2A_def;
                macros << textcyr_def << '\n';
        }
@@ -1655,13 +1674,13 @@ TexString LaTeXFeatures::getMacros() const
        if (mustProvide("textquotedbl"))
                macros << textquotedbl_def << '\n';
        if (mustProvide("textquotesinglep")) {
-               if (runparams_.flavor == FLAVOR::XETEX)
+               if (runparams_.flavor == Flavor::XeTeX)
                        macros << textquotesinglep_xetex_def << '\n';
                else
                        macros << textquotesinglep_luatex_def << '\n';
        }
        if (mustProvide("textquotedblp")) {
-               if (runparams_.flavor == FLAVOR::XETEX)
+               if (runparams_.flavor == Flavor::XeTeX)
                        macros << textquotedblp_xetex_def << '\n';
                else
                        macros << textquotedblp_luatex_def << '\n';
@@ -1683,22 +1702,17 @@ TexString LaTeXFeatures::getMacros() const
        if (mustProvide("NeedTabularnewline"))
                macros << tabularnewline_def;
 
+       if (mustProvide("cellvarwidth"))
+               macros << cellvarwidth_def;
+
        // greyed-out environment (note inset)
        // the color is specified in the routine
        // getColorOptions() to avoid LaTeX-package clashes
-       if (mustProvide("lyxgreyedout")) {
-               // We need different version for RTL (#8647)
-               if (hasRTLLanguage()) {
-                       if (runparams_.flavor == FLAVOR::LUATEX)
-                               if (useBabel())
-                                       macros << lyxgreyedout_luartl_babel_def;
-                               else
-                                       macros << lyxgreyedout_luartl_def;
-                       else
-                               macros << lyxgreyedout_rtl_def;
-               } else
-                       macros << lyxgreyedout_def;
-       }
+       if (mustProvide("lyxgreyedout"))
+               // We need different version for RTL (#8647), with change tracking (#12025)
+               // and for some specific engine/language package combinations
+               macros << lyxgreyedoutDef(hasRTLLanguage(), mustProvide("ct-xcolor-ulem"),
+                                         (runparams_.flavor == Flavor::LuaTeX), useBabel());
 
        if (mustProvide("lyxdot"))
                macros << lyxdot_def << '\n';
@@ -1713,11 +1727,11 @@ TexString LaTeXFeatures::getMacros() const
        if (mustProvide("ct-xcolor-ulem")) {
                streamsize const prec = macros.os().precision(2);
 
-               RGBColor cadd = rgbFromHexName(lcolor.getX11HexName(Color_addedtext));
+               RGBColor cadd = rgbFromHexName(lcolor.getX11HexName(Color_addedtext_output));
                macros << "\\providecolor{lyxadded}{rgb}{"
                       << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
 
-               RGBColor cdel = rgbFromHexName(lcolor.getX11HexName(Color_deletedtext));
+               RGBColor cdel = rgbFromHexName(lcolor.getX11HexName(Color_deletedtext_output));
                macros << "\\providecolor{lyxdeleted}{rgb}{"
                       << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
 
@@ -1742,11 +1756,11 @@ TexString LaTeXFeatures::getMacros() const
                if (!mustProvide("ct-xcolor-ulem")) {
                        streamsize const prec = macros.os().precision(2);
 
-                       RGBColor cadd = rgbFromHexName(lcolor.getX11HexName(Color_addedtext));
+                       RGBColor cadd = rgbFromHexName(lcolor.getX11HexName(Color_addedtext_output));
                        macros << "\\providecolor{lyxadded}{rgb}{"
                               << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
        
-                       RGBColor cdel = rgbFromHexName(lcolor.getX11HexName(Color_deletedtext));
+                       RGBColor cdel = rgbFromHexName(lcolor.getX11HexName(Color_deletedtext_output));
                        macros << "\\providecolor{lyxdeleted}{rgb}{"
                               << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
        
@@ -2215,10 +2229,8 @@ void LaTeXFeatures::getFloatDefinitions(otexstream & os) const
        // \newfloat{algorithm}{htbp}{loa}
        // \providecommand{\algorithmname}{Algorithm}
        // \floatname{algorithm}{\protect\algorithmname}
-       UsedFloats::const_iterator cit = usedFloats_.begin();
-       UsedFloats::const_iterator end = usedFloats_.end();
-       for (; cit != end; ++cit) {
-               Floating const & fl = floats.getType(cit->first);
+       for (auto const & cit : usedFloats_) {
+               Floating const & fl = floats.getType(cit.first);
 
                // For builtin floats we do nothing.
                if (fl.isPredefined())
@@ -2267,7 +2279,7 @@ void LaTeXFeatures::getFloatDefinitions(otexstream & os) const
                        // used several times, when the same style is still in
                        // effect. (Lgb)
                }
-               if (cit->second)
+               if (cit.second)
                        // The subfig package is loaded later
                        os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
        }
@@ -2312,13 +2324,10 @@ void LaTeXFeatures::expandMultiples()
 {
        for (Features::iterator it = features_.begin(); it != features_.end();) {
                if (contains(*it, ',')) {
-                       vector<string> const multiples = getVectorFromString(*it, ",");
-                       vector<string>::const_iterator const end = multiples.end();
-                       vector<string>::const_iterator itm = multiples.begin();
                        // Do nothing if any multiple is already required
-                       for (; itm != end; ++itm) {
-                               if (!isRequired(*itm))
-                                       require(*itm);
+                       for (string const & pkg : getVectorFromString(*it, ",")) {
+                               if (!isRequired(pkg))
+                                       require(pkg);
                        }
                        features_.erase(it);
                        it = features_.begin();