]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.cpp
Add some missing files to autoconf's dist
[lyx.git] / src / LaTeXFeatures.cpp
index bbc76d18523eb714573fdc7dc874e90baf90e8e5..a7974b62c5ac062ef2bb95ee0599e71de04710bc 100644 (file)
@@ -184,19 +184,19 @@ static docstring const changetracking_dvipost_def = from_ascii(
        "\\dvipost{osend color pop}\n"
        "\\dvipost{cbstart color push Blue}\n"
        "\\dvipost{cbend color pop}\n"
-       "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
-       "\\newcommand{\\lyxdeleted}[3]{%\n"
+       "\\DeclareRobustCommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
+       "\\DeclareRobustCommand{\\lyxdeleted}[3]{%\n"
        "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n");
 
 static docstring const changetracking_xcolor_ulem_def = from_ascii(
        "%% Change tracking with ulem\n"
-       "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
-       "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n");
+       "\\DeclareRobustCommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
+       "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n");
 
 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
        "%% Change tracking with ulem\n"
-       "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
-       "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n");
+       "\\DeclareRobustCommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
+       "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n");
 
 static docstring const changetracking_none_def = from_ascii(
        "\\newcommand{\\lyxadded}[3]{#3}\n"
@@ -314,6 +314,25 @@ static docstring const rtloutputdblcol_def = from_ascii(
        "\\@mparswitchtrue\n");
 
 
+/////////////////////////////////////////////////////////////////////
+//
+// LyXHTML strings
+//
+/////////////////////////////////////////////////////////////////////
+
+static docstring const lyxnoun_style = from_ascii(
+       "dfn.lyxnoun {\n"
+  "  font-variant: small-caps;\n"
+  "}\n");
+
+
+// this is how it normally renders, but it might not always do so.
+static docstring const lyxstrikeout_style = from_ascii(
+       "del.strikeout {\n"
+  "  text-decoration: line-through;\n"
+  "}\n");
+
+
 /////////////////////////////////////////////////////////////////////
 //
 // LaTeXFeatures
@@ -327,7 +346,7 @@ LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
 {}
 
 
-LaTeXFeatures::LangPackage LaTeXFeatures::langPackage(bool englishbabel) const
+LaTeXFeatures::LangPackage LaTeXFeatures::langPackage() const
 {
        string const local_lp = bufferParams().lang_package;
 
@@ -347,9 +366,6 @@ LaTeXFeatures::LangPackage LaTeXFeatures::langPackage(bool englishbabel) const
         * If babel is selected (either directly or via the "auto"
         * mechanism), we really do only require it if we have
         * a language that needs it.
-        * English alone normally does not require babel (since it is
-        * the default language of LaTeX). However, in some cases we
-        * need to surpass this exception (see Font::validate).
         */
        bool const polyglossia_required =
                isRequired("polyglossia")
@@ -357,8 +373,7 @@ LaTeXFeatures::LangPackage LaTeXFeatures::langPackage(bool englishbabel) const
                && !isProvided("babel")
                && this->hasOnlyPolyglossiaLanguages();
        bool const babel_required = 
-               ((englishbabel || bufferParams().language->lang() != "english")
-                && !bufferParams().language->babel().empty())
+               !bufferParams().language->babel().empty()
                || !this->getBabelLanguages().empty();
 
        if (local_lp == "auto") {
@@ -411,9 +426,14 @@ void LaTeXFeatures::require(set<string> const & names)
 
 
 void LaTeXFeatures::useLayout(docstring const & layoutname)
+{
+       useLayout(layoutname, 0);
+}
+
+
+void LaTeXFeatures::useLayout(docstring const & layoutname, int level)
 {
        // Some code to avoid loops in dependency definition
-       static int level = 0;
        const int maxlevel = 30;
        if (level > maxlevel) {
                lyxerr << "LaTeXFeatures::useLayout: maximum level of "
@@ -433,9 +453,7 @@ void LaTeXFeatures::useLayout(docstring const & layoutname)
                require(layout.requires());
 
                if (!layout.depends_on().empty()) {
-                       ++level;
-                       useLayout(layout.depends_on());
-                       --level;
+                       useLayout(layout.depends_on(), level + 1);
                }
                usedLayouts_.push_back(layoutname);
        } else {
@@ -443,8 +461,6 @@ void LaTeXFeatures::useLayout(docstring const & layoutname)
                       << to_utf8(layoutname) << "' does not exist in this class"
                       << endl;
        }
-
-       --level;
 }
 
 
@@ -585,6 +601,10 @@ bool LaTeXFeatures::hasLanguages() const
 
 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
 {
+       // first the main language
+       if (params_.language->polyglossia().empty())
+               return false;
+       // now the secondary languages
        LanguageList::const_iterator const begin = UsedLanguages_.begin();
        for (LanguageList::const_iterator cit = begin;
             cit != UsedLanguages_.end();
@@ -598,11 +618,15 @@ bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
 
 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
 {
+       // first the main language
+       if (params_.language->isPolyglossiaExclusive())
+               return true;
+       // now the secondary languages
        LanguageList::const_iterator const begin = UsedLanguages_.begin();
        for (LanguageList::const_iterator cit = begin;
             cit != UsedLanguages_.end();
             ++cit) {
-               if ((*cit)->babel().empty() && !(*cit)->polyglossia().empty() && (*cit)->requires().empty())
+               if ((*cit)->isPolyglossiaExclusive())
                        return true;
        }
        return false;
@@ -686,9 +710,6 @@ char const * simplefeatures[] = {
        "fancybox",
        "calc",
        "units",
-       "tipa",
-       "tipx",
-       "tone",
        "framed",
        "soul",
        "textcomp",
@@ -702,7 +723,7 @@ char const * simplefeatures[] = {
        "mathrsfs",
        "mathabx",
        "mathtools",
-       "cancel",
+       // "cancel",
        "ascii",
        "url",
        "covington",
@@ -716,10 +737,37 @@ char const * simplefeatures[] = {
        "pdfpages",
        "amscd",
        "slashed",
+       "multicol",
        "multirow",
-       "tfrupee"
+       "tfrupee",
+       "shapepar",
+       "rsphrase",
+       "algorithm2e",
+       "sectionbox",
+       "tcolorbox",
+       "pdfcomment",
+       "fixme",
+       "todonotes"
 };
 
+char const * bibliofeatures[] = {
+       // Known bibliography packages (will be loaded before natbib)
+       "achicago",
+       "apacite",
+       "apalike",
+       "astron",
+       "authordate1-4",
+       "babelbib",
+       "bibgerm",
+       "chicago",
+       "chscite",
+       "harvard",
+       "mslapa",
+       "named"
+};
+
+int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
+
 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 
 }
@@ -795,25 +843,45 @@ string const LaTeXFeatures::getPackages() const
        // also unknown packages can be requested. They are silently
        // swallowed now. We should change this eventually.
 
-       //
+       // 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))
+                       packages << "\\PassOptionsToPackage{" << it->second << "}"
+                                << "{" << it->first << "}\n";
+
        //  These are all the 'simple' includes.  i.e
        //  packages which we just \usepackage{package}
-       //
        for (int i = 0; i < nb_simplefeatures; ++i) {
                if (mustProvide(simplefeatures[i]))
-                       packages << "\\usepackage{"
-                                << simplefeatures[i] << "}\n";
+                       packages << "\\usepackage{" << simplefeatures[i] << "}\n";
        }
 
-       //
        // The rest of these packages are somewhat more complicated
        // than those above.
-       //
 
-       // if fontspec is used, AMS packages have to be loaded before
-       // fontspec (in BufferParams)
+       // The tipa package and its extensions (tipx, tone) must not
+       // be loaded with non-TeX fonts, since fontspec includes the
+       // respective macros
+       if (mustProvide("tipa") && !params_.useNonTeXFonts)
+               packages << "\\usepackage{tipa}\n";
+       if (mustProvide("tipx") && !params_.useNonTeXFonts)
+               packages << "\\usepackage{tipx}\n";
+       if (mustProvide("tone") && !params_.useNonTeXFonts)
+               packages << "\\usepackage{tone}\n";
+
+       // if fontspec or newtxmath is used, AMS packages have to be loaded
+       // before fontspec (in BufferParams)
        string const amsPackages = loadAMSPackages();
-       if (!params_.useNonTeXFonts && !amsPackages.empty())
+       bool const ot1 = (params_.font_encoding() == "default" || params_.font_encoding() == "OT1");
+       bool const use_newtxmath =
+               theLaTeXFonts().getLaTeXFont(from_ascii(params_.fonts_math)).getUsedPackage(
+                       ot1, false, false) == "newtxmath";
+       
+       if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
                packages << amsPackages;
 
        // fixltx2e must be loaded after amsthm, since amsthm produces an error with
@@ -822,6 +890,9 @@ string const LaTeXFeatures::getPackages() const
        if (mustProvide("fixltx2e"))
                packages << "\\usepackage{fixltx2e}\n";
 
+       if (mustProvide("cancel") &&
+           params_.use_package("cancel") != BufferParams::package_off)
+               packages << "\\usepackage{cancel}\n";
        // wasysym is a simple feature, but it must be after amsmath if both
        // are used
        // wasysym redefines some integrals (e.g. iint) from amsmath. That
@@ -850,6 +921,15 @@ string const LaTeXFeatures::getPackages() const
            params_.use_package("yhmath") != BufferParams::package_off)
                packages << "\\usepackage{yhmath}\n";
 
+       // stmaryrd must be loaded after amsmath
+       if (mustProvide("stmaryrd") &&
+           params_.use_package("stmaryrd") != BufferParams::package_off)
+               packages << "\\usepackage{stmaryrd}\n";
+
+       if (mustProvide("stackrel") &&
+           params_.use_package("stackrel") != BufferParams::package_off)
+               packages << "\\usepackage{stackrel}\n";
+
        if (mustProvide("undertilde") &&
                params_.use_package("undertilde") != BufferParams::package_off)
                packages << "\\usepackage{undertilde}\n";
@@ -883,12 +963,31 @@ string const LaTeXFeatures::getPackages() const
        if (mustProvide("setspace") && !isProvided("SetSpace"))
                packages << "\\usepackage{setspace}\n";
 
-       // esint must be after amsmath and wasysym, since it will redeclare
-       // inconsistent integral symbols
+       // we need to assure that mhchem is loaded before esint
+       // because esint must be loaded AFTER amslatex and mhchem loads amlatex
+       // (this info is from the author of mhchem from June 2013)
+       if (mustProvide("mhchem") &&
+           params_.use_package("mhchem") != BufferParams::package_off)
+               packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
+                           "\\usepackage{mhchem}\n";
+
+       // esint must be after amsmath (and packages requiring amsmath, like mhchem)
+       // and wasysym, since it will redeclare inconsistent integral symbols
        if (mustProvide("esint") &&
            params_.use_package("esint") != BufferParams::package_off)
                packages << "\\usepackage{esint}\n";
 
+       // Known bibliography packages (simple \usepackage{package})
+       for (int i = 0; i < nb_bibliofeatures; ++i) {
+               if (mustProvide(bibliofeatures[i]))
+                       packages << "\\usepackage{"
+                                << bibliofeatures[i] << "}\n";
+       }
+
+       // Compatibility between achicago and natbib
+       if (mustProvide("achicago") && mustProvide("natbib"))
+               packages << "\\let\\achicagobib\\thebibliography\n";
+
        // natbib.sty
        // Some classes load natbib themselves, but still allow (or even require)
        // plain numeric citations (ReVTeX is such a case, see bug 5182).
@@ -902,10 +1001,25 @@ string const LaTeXFeatures::getPackages() const
                packages << "]{natbib}\n";
        }
 
+       // Compatibility between achicago and natbib
+       if (mustProvide("achicago") && mustProvide("natbib")) {
+               packages << "\\let\\thebibliography\\achicagobib\n";
+               packages << "\\let\\SCcite\\astroncite\n";
+               packages << "\\let\\UnexpandableProtect\\protect\n";
+       }
+
        // jurabib -- we need version 0.6 at least.
        if (mustProvide("jurabib"))
                packages << "\\usepackage{jurabib}[2004/01/25]\n";
 
+       // opcit -- we pass custombst as we output \bibliographystyle ourselves
+       if (mustProvide("opcit")) {
+               if (isRequired("hyperref"))
+                       packages << "\\usepackage[custombst,hyperref]{opcit}\n";
+               else
+                       packages << "\\usepackage[custombst]{opcit}\n";
+       }
+
        // xargs -- we need version 1.09 at least
        if (mustProvide("xargs"))
                packages << "\\usepackage{xargs}[2008/03/08]\n";
@@ -920,11 +1034,6 @@ string const LaTeXFeatures::getPackages() const
                packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
                            "\\usepackage{ulem}\n";
 
-       if (mustProvide("mhchem") &&
-           params_.use_package("mhchem") != BufferParams::package_off)
-               packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
-                           "\\usepackage{mhchem}\n";
-
        if (mustProvide("nomencl")) {
                // Make it work with the new and old version of the package,
                // but don't use the compatibility option since it is
@@ -1259,6 +1368,13 @@ docstring const LaTeXFeatures::getTClassHTMLStyles() const
        DocumentClass const & tclass = params_.documentClass();
        odocstringstream tcpreamble;
 
+       if (mustProvide("noun"))
+               tcpreamble << lyxnoun_style;
+       // this isn't exact, but it won't hurt that much if it
+       // wasn't for this.
+       if (mustProvide("ulem"))
+               tcpreamble << lyxstrikeout_style;
+
        tcpreamble << tclass.htmlstyles();
 
        list<docstring>::const_iterator cit = usedLayouts_.begin();
@@ -1586,7 +1702,8 @@ void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
                        // effect. (Lgb)
                }
                if (cit->second)
-                       os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";
+                       // The subfig package is loaded later
+                       os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
        }
 }