]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.cpp
Handle paragraph direction switch in captions (with polyglossia/bidi)
[lyx.git] / src / LaTeXFeatures.cpp
index 5f83283460ddd320ffaa095e5db42d52660c3957..cd04b4c0f2bc4429ca1248acf1a19aacfa7ff0dc 100644 (file)
@@ -63,16 +63,7 @@ namespace lyx {
 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
 
 static docstring const lyx_def = from_ascii(
-       "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
-
-static docstring const lyx_rtl_def = from_ascii(
-       "\\let\\@@LyX\\LyX\n"
-       "\\def\\LyX{\\@ensure@LTR{\\@@LyX}}");
-
-static docstring const lyx_hyperref_def = from_ascii(
-       "\\providecommand{\\LyX}{\\texorpdfstring%\n"
-       "  {L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}\n"
-       "  {LyX}}");
+       "{%\n  L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
 
 static docstring const noun_def = from_ascii(
        "\\newcommand{\\noun}[1]{\\textsc{#1}}");
@@ -204,6 +195,39 @@ static docstring const lyxgreyedout_def = from_ascii(
        "  {\\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");
+
 // We want to omit the file extension for includegraphics, but this does not
 // work when the filename contains other dots.
 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
@@ -324,67 +348,75 @@ static docstring const ogonek_def = from_ascii(
 
 static docstring const lyxaccent_def = from_ascii(
        "%% custom text accent \\LyxTextAccent[<rise value (length)>]{<accent>}{<base>}\n"
-        "\\newcommand*{\\LyxTextAccent}[3][0ex]{%\n"
-        "  \\hmode@bgroup\\ooalign{\\null#3\\crcr\\hidewidth\n"
-        "  \\raise#1\\hbox{#2}\\hidewidth}\\egroup}\n"
-        "%% select a font size smaller than the current font size:\n"
-        "\\newcommand{\\LyxAccentSize}[1][\\sf@size]{%\n"
-        "  \\check@mathfonts\\fontsize#1\\z@\\math@fontsfalse\\selectfont\n"
-        "}\n");
+       "\\newcommand*{\\LyxTextAccent}[3][0ex]{%\n"
+       "  \\hmode@bgroup\\ooalign{\\null#3\\crcr\\hidewidth\n"
+       "  \\raise#1\\hbox{#2}\\hidewidth}\\egroup}\n"
+       "%% select a font size smaller than the current font size:\n"
+       "\\newcommand{\\LyxAccentSize}[1][\\sf@size]{%\n"
+       "  \\check@mathfonts\\fontsize#1\\z@\\math@fontsfalse\\selectfont\n"
+       "}\n");
 
 static docstring const textcommabelow_def = from_ascii(
-        "\\ProvideTextCommandDefault{\\textcommabelow}[1]{%%\n"
-        "  \\LyxTextAccent[-.31ex]{\\LyxAccentSize,}{#1}}\n");
+       "\\ProvideTextCommandDefault{\\textcommabelow}[1]{%%\n"
+       "  \\LyxTextAccent[-.31ex]{\\LyxAccentSize,}{#1}}\n");
 
 static docstring const textcommaabove_def = from_ascii(
-        "\\ProvideTextCommandDefault{\\textcommaabove}[1]{%%\n"
-        "  \\LyxTextAccent[.5ex]{\\LyxAccentSize`}{#1}}\n");
+       "\\ProvideTextCommandDefault{\\textcommaabove}[1]{%%\n"
+       "  \\LyxTextAccent[.5ex]{\\LyxAccentSize`}{#1}}\n");
 
 static docstring const textcommaaboveright_def = from_ascii(
-        "\\ProvideTextCommandDefault{\\textcommaaboveright}[1]{%%\n"
-        "  \\LyxTextAccent[.5ex]{\\LyxAccentSize\\ '}{#1}}\n");
+       "\\ProvideTextCommandDefault{\\textcommaaboveright}[1]{%%\n"
+       "  \\LyxTextAccent[.5ex]{\\LyxAccentSize\\ '}{#1}}\n");
 
 // Baltic languages use a comma-accent instead of a cedilla
 static docstring const textbaltic_def = from_ascii(
-        "%% use comma accent instead of cedilla for these characters:\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{g}{\\textcommaabove{g}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{G}{\\textcommabelow{G}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{k}{\\textcommabelow{k}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{K}{\\textcommabelow{K}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{l}{\\textcommabelow{l}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{L}{\\textcommabelow{L}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{n}{\\textcommabelow{n}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{N}{\\textcommabelow{N}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{r}{\\textcommabelow{r}}\n"
-        "\\DeclareTextCompositeCommand{\\c}{T1}{R}{\\textcommabelow{R}}\n");
+       "%% use comma accent instead of cedilla for these characters:\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{g}{\\textcommaabove{g}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{G}{\\textcommabelow{G}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{k}{\\textcommabelow{k}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{K}{\\textcommabelow{K}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{l}{\\textcommabelow{l}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{L}{\\textcommabelow{L}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{n}{\\textcommabelow{n}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{N}{\\textcommabelow{N}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{r}{\\textcommabelow{r}}\n"
+       "\\DeclareTextCompositeCommand{\\c}{T1}{R}{\\textcommabelow{R}}\n");
+
+// Use cyrillic fonts to provide letter schwa in text (see #11062)
+static docstring const textschwa_def = from_ascii(
+       "%% letter schwa missing in Latin fonts, use Cyrillic schwa\n"
+       "\\DeclareTextSymbolDefault{\\CYRSCHWA}{T2A}\n"
+       "\\DeclareTextSymbolDefault{\\cyrschwa}{T2A}\n"
+       "\\ProvideTextCommandDefault{\\textSchwa}{\\CYRSCHWA}\n"
+       "\\ProvideTextCommandDefault{\\textschwa}{\\cyrschwa}\n");
 
 // 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"
-               "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmr}{text}\n"
-               "  {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
-               "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmss}{text}\n"
-               "  {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
-               "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmr}{text}\n"
-               "  {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
-               "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmss}{text}\n"
-               "  {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
-               "\\newcommand{\\smallLetterFrac}[2]{%\n"
-               "  {\\UseCollection{xfrac}{smallLetterFrac}\\sfrac{#1}{#2}}}\n");
+       "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{default}{text}\n"
+       "  {phantom=c, scale-factor=1.0, slash-left-kern=-.05em}\n"
+       "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmr}{text}\n"
+       "  {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
+       "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmss}{text}\n"
+       "  {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
+       "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmr}{text}\n"
+       "  {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
+       "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmss}{text}\n"
+       "  {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
+       "\\newcommand{\\smallLetterFrac}[2]{%\n"
+       "  {\\UseCollection{xfrac}{smallLetterFrac}\\sfrac{#1}{#2}}}\n");
 
 static docstring const lyxref_def = from_ascii(
-               "\\RS@ifundefined{subsecref}\n"
-               "  {\\newref{subsec}{name = \\RSsectxt}}\n"
-               "  {}\n"
-               "\\RS@ifundefined{thmref}\n"
-               "  {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
-               "  {}\n"
-               "\\RS@ifundefined{lemref}\n"
-               "  {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
-               "  {}\n");
+       "\\RS@ifundefined{subsecref}\n"
+       "  {\\newref{subsec}{name = \\RSsectxt}}\n"
+       "  {}\n"
+       "\\RS@ifundefined{thmref}\n"
+       "  {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
+       "  {}\n"
+       "\\RS@ifundefined{lemref}\n"
+       "  {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
+       "  {}\n");
 
 // Make sure the columns are also outputed as rtl
 static docstring const rtloutputdblcol_def = from_ascii(
@@ -463,7 +495,7 @@ static docstring const lyxstrikeout_style = from_ascii(
 
 
 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
-                            OutputParams const & r)
+                                                        OutputParams const & r)
        : buffer_(&b), params_(p), runparams_(r), in_float_(false),
          in_deleted_inset_(false)
 {}
@@ -737,8 +769,14 @@ void LaTeXFeatures::useFloat(string const & name, bool subfloat)
        // use the "H" modifier. This includes modified table and
        // figure floats. (Lgb)
        Floating const & fl = params_.documentClass().floats().getType(name);
-       if (!fl.floattype().empty() && fl.usesFloatPkg()) {
-               require("float");
+       if (!fl.floattype().empty()) {
+               if (fl.usesFloatPkg())
+                       require("float");
+               if (!fl.requires().empty()) {
+                       vector<string> reqs = getVectorFromString(fl.requires());
+                       for (auto const req : reqs)
+                               require(req);
+               }
        }
 }
 
@@ -756,7 +794,7 @@ void LaTeXFeatures::useLanguage(Language const * lang)
        // They use the CJK package
        if (lang->encoding()->package() == Encoding::CJK)
                require("CJK");
-       // japanese package is special
+       // japanese babel language is special (tied to the pLaTeX engine).
        if (lang->encoding()->package() == Encoding::japanese)
                require("japanese");
 }
@@ -880,6 +918,20 @@ set<string> LaTeXFeatures::getPolyglossiaLanguages() const
 }
 
 
+string LaTeXFeatures::getActiveChars() const
+{
+       string res;
+       // first the main language
+       res += params_.language->activeChars();
+       // now the secondary languages
+       LanguageList::const_iterator const begin = UsedLanguages_.begin();
+       for (LanguageList::const_iterator cit = begin;
+            cit != UsedLanguages_.end(); ++cit)
+               res += ((*cit)->activeChars());
+       return res;
+}
+
+
 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 {
        // This does only find encodings of languages supported by babel, but
@@ -888,8 +940,7 @@ set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
        set<string> encs;
        for (auto const & lang : UsedLanguages_)
                if (lang->encoding()->latexName() != doc_encoding &&
-                   (lang->encoding()->package() == Encoding::inputenc
-                    || lang->encoding()->package() == Encoding::japanese))
+                   lang->encoding()->package() == Encoding::inputenc)
                        encs.insert(lang->encoding()->latexName());
        return encs;
 }
@@ -903,7 +954,7 @@ void LaTeXFeatures::getFontEncodings(vector<string> & encs, bool const onlylangs
                if (mustProvide("textgreek")
                    && find(encs.begin(), encs.end(), "LGR") == encs.end())
                        encs.insert(encs.begin(), "LGR");
-               if (mustProvide("textcyrillic")
+               if ((mustProvide("textcyrillic") || mustProvide("textschwa"))
                    && find(encs.begin(), encs.end(), "T2A") == encs.end())
                        encs.insert(encs.begin(), "T2A");
        }
@@ -929,6 +980,7 @@ bool LaTeXFeatures::hasRTLLanguage() const
        return false;
 }
 
+
 namespace {
 
 char const * simplefeatures[] = {
@@ -937,7 +989,6 @@ char const * simplefeatures[] = {
        "verbatim",
        "cprotect",
        "longtable",
-       "rotating",
        "latexsym",
        "pifont",
        // subfig is handled in BufferParams.cpp
@@ -949,7 +1000,6 @@ char const * simplefeatures[] = {
          the `float' package. See the caption package documentation
          for explanation.*/
        "float",
-       "rotfloat",
        "wrapfig",
        "booktabs",
        "dvipost",
@@ -958,8 +1008,7 @@ char const * simplefeatures[] = {
        "units",
        "framed",
        "soul",
-       "textcomp",
-       "pmboxdraw",
+       "dingbat",
        "bbding",
        "ifsym",
        "txfonts",
@@ -971,10 +1020,10 @@ char const * simplefeatures[] = {
        // "cancel",
        "ascii",
        "url",
-       "covington",
        "csquotes",
        "enumitem",
        "endnotes",
+       "enotez",
        "hhline",
        "ifthen",
        // listings is handled in BufferParams.cpp
@@ -996,11 +1045,15 @@ char const * simplefeatures[] = {
        "todonotes",
        "forest",
        "varwidth",
-       "footnote",
        "tablefootnote",
        "afterpage",
        "tabularx",
-       "xltabular"
+       "xltabular",
+       "chessboard",
+       "xskak",
+       "pict2e",
+       "drs",
+       "environ"
 };
 
 char const * bibliofeatures[] = {
@@ -1123,6 +1176,13 @@ string const LaTeXFeatures::getPackages() const
        // The rest of these packages are somewhat more complicated
        // than those above.
 
+       if (mustProvide("footnote")) {
+               if (isRequired("hyperref"))
+                       packages << "\\usepackage{footnotehyper}\n";
+               else
+                       packages << "\\usepackage{footnote}\n";
+       }
+
        // [pdf]lscape is used to rotate longtables
        if (mustProvide("lscape")) {
                if (runparams_.flavor == OutputParams::LATEX
@@ -1216,6 +1276,13 @@ string const LaTeXFeatures::getPackages() const
                                 << "]{graphicx}\n";
        }
 
+       // These must be loaded after graphicx, since they try
+       // to load graphicx without options
+       if (mustProvide("rotating"))
+               packages << "\\usepackage{rotating}\n";
+       if (mustProvide("rotfloat"))
+               packages << "\\usepackage{rotfloat}\n";
+
        // lyxskak.sty --- newer chess support based on skak.sty
        if (mustProvide("chess"))
                packages << "\\usepackage[ps,mover]{lyxskak}\n";
@@ -1374,12 +1441,24 @@ TexString LaTeXFeatures::getMacros() const
        }
 
        if (mustProvide("LyX")) {
+               macros << "\\providecommand{\\LyX}";
+               // open conditional wrappers
+               if (runparams_.use_polyglossia && hasRTLLanguage())
+                       macros << "{\\@ensure@LTR";
                if (isRequired("hyperref"))
-                       macros << lyx_hyperref_def << '\n';
-               else
-                       macros << lyx_def << '\n';
+                       macros << "{\\texorpdfstring";
+               if (useBabel())
+                       macros << "{\\ensureascii";
+               // main definition
+               macros << lyx_def;
+               // close conditional wrappers
+               if (useBabel())
+                       macros << '}';
+               if (isRequired("hyperref"))
+                       macros << "{LyX}}";
                if (runparams_.use_polyglossia && hasRTLLanguage())
-                       macros << lyx_rtl_def << '\n';
+                       macros << '}';
+               macros << '\n';
        }
 
        if (mustProvide("noun"))
@@ -1422,6 +1501,9 @@ TexString LaTeXFeatures::getMacros() const
        if (mustProvide("textbaltic"))
                macros << textbaltic_def << '\n';
 
+       if (mustProvide("textschwa"))
+               macros << textschwa_def << '\n';
+
        // split-level fractions
        if (mustProvide("xfrac") || mustProvide("smallLetterFrac"))
                macros << xfrac_def << '\n';
@@ -1509,8 +1591,19 @@ TexString LaTeXFeatures::getMacros() const
        // greyed-out environment (note inset)
        // the color is specified in the routine
        // getColorOptions() to avoid LaTeX-package clashes
-       if (mustProvide("lyxgreyedout"))
-               macros << lyxgreyedout_def;
+       if (mustProvide("lyxgreyedout")) {
+               // We need different version for RTL (#8647)
+               if (hasRTLLanguage()) {
+                       if (runparams_.flavor == OutputParams::LUATEX)
+                               if (useBabel())
+                                       macros << lyxgreyedout_luartl_babel_def;
+                               else
+                                       macros << lyxgreyedout_luartl_def;
+                       else
+                               macros << lyxgreyedout_rtl_def;
+               } else
+                       macros << lyxgreyedout_def;
+       }
 
        if (mustProvide("lyxdot"))
                macros << lyxdot_def << '\n';
@@ -1594,21 +1687,6 @@ docstring const LaTeXFeatures::getBabelPostsettings() const
 }
 
 
-bool LaTeXFeatures::needBabelLangOptions() const
-{
-       if (!lyxrc.language_global_options || params_.language->asBabelOptions())
-               return true;
-
-       LanguageList::const_iterator it  = UsedLanguages_.begin();
-       LanguageList::const_iterator end = UsedLanguages_.end();
-       for (; it != end; ++it)
-               if ((*it)->asBabelOptions())
-                       return true;
-
-       return false;
-}
-
-
 string const LaTeXFeatures::loadAMSPackages() const
 {
        ostringstream tmp;
@@ -1904,9 +1982,11 @@ docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel,
                // encodings, only with fixed width encodings. Therefore we
                // need to force a fixed width encoding for
                // \lstlistlistingname and \lstlistingname (bug 9382).
-               // This needs to be consistent with InsetListings::latex().
+               // This needs to be consistent with InsetListings::latex()
+               // rsp. InsetListings::forcedEncoding().
                bool const need_fixedwidth = !use_minted &&
                                        !runparams_.isFullUnicode() &&
+                                       buffer().params().encoding().package() != Encoding::japanese &&
                                        it->second.fixedwidthpreambleencoding();
                // language dependent commands (once per document)
                snippets.insert(i18npreamble(it->second.langpreamble(),