]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.cpp
some more uses of Requires.
[lyx.git] / src / LaTeXFeatures.cpp
index b3442087d43a24cac6b5d78449c7050fc183a76b..2a3eec1efb4c67f1445d24049011dbca3804f15e 100644 (file)
 
 #include "LaTeXFeatures.h"
 
-#include "BufferParams.h"
 #include "Color.h"
-#include "debug.h"
+#include "BufferParams.h"
+#include "support/debug.h"
 #include "Encoding.h"
 #include "Floating.h"
 #include "FloatList.h"
 #include "Language.h"
+#include "Layout.h"
 #include "Lexer.h"
 #include "LyXRC.h"
+#include "TextClass.h"
 
 #include "support/docstream.h"
+#include "support/FileName.h"
 #include "support/filetools.h"
 
-#include "frontends/controllers/frontend_helpers.h"
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::isSGMLFilename;
-using support::libFileSearch;
-using support::makeRelPath;
-using support::onlyPath;
-
-using std::endl;
-using std::find;
-using std::string;
-using std::list;
-using std::ostream;
-using std::ostringstream;
-using std::set;
-
 /////////////////////////////////////////////////////////////////////
 //
 // Strings
@@ -159,7 +150,7 @@ static string const mathcircumflex_def =
 static string const tabularnewline_def =
        "%% Because html converters don't know tabularnewline\n"
        "\\providecommand{\\tabularnewline}{\\\\}\n";
-
+       
 static string const lyxgreyedout_def =
        "%% The greyedout annotation environment\n"
        "\\newenvironment{lyxgreyedout}{\\textcolor[gray]{0.8}\\bgroup}{\\egroup}\n";
@@ -186,7 +177,115 @@ static string const changetracking_none_def =
        "\\newcommand{\\lyxadded}[3]{#3}\n"
        "\\newcommand{\\lyxdeleted}[3]{}\n";
 
-
+static string const textgreek_def =
+       "\\DeclareRobustCommand{\\greektext}{%\n"
+       " \\fontencoding{LGR}\\selectfont\n"
+       " \\def\\encodingdefault{LGR}}\n"
+       "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
+       "\\DeclareFontEncoding{LGR}{}{}\n";
+
+static string const textcyr_def =
+       "\\DeclareRobustCommand{\\cyrtext}{%\n"
+       " \\fontencoding{T2A}\\selectfont\n"
+       " \\def\\encodingdefault{T2A}}\n"
+       "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
+       "\\DeclareFontEncoding{T2A}{}{}\n";
+
+static string const newlyxcommand_def =
+       "%% Math macros with multiple optional parameters\n"
+       "% #1<-\\foo\n"
+       "\\def\\newlyxcommand#1{\n"
+       "  \\@ifnextchar[%]\n"
+       "  {\\newlyxcommand@arity{#1}}\n"
+       "  {\\newlyxcommand@arity{#1}[0]}\n"
+       "}\n"
+       "\n"
+       "% #1<-\\foo #2<-arity\n"
+       "\\def\\newlyxcommand@arity#1[#2]{\n"
+       "  \\@ifnextchar[%]\n"
+       "  {\\newlyxcommand@firstopt{#1}{}{#2}}\n"
+       "  {\\newlyxcommand@def#1{#2}}\n"
+       "}\n"
+       "\n"
+       "% #1<-\\foo #2<-iii #3<-arity #4<-default value for (#2+1)th argument\n"
+       "\\def\\newlyxcommand@firstopt#1#2#3[#4]{\n"
+       "  % ##1<-\\foo@\n"
+       "  \\def\\@defclause##1{\n"
+       "    \\def#1{\n"
+       "      \\@ifnextchar[%]\n"
+       "      {##1{}{#4}}\n"
+       "      {##1{}{#4}[#4]}}\n"
+       "  }\n"
+       "  \\expandafter\\@defclause\\csname\\expandafter\\@gobble\\string#1@\\endcsname\n"
+       "  \\@ifnextchar[%]\n"
+       "  {\\newlyxcommand@opt{#1}{#2}{#3}}\n"
+       "  {\\newlyxcommand@last{#1}{#2}{#3}[#4]}\n"
+       "}\n"
+       "\n"
+       "\\begingroup\n"
+       "\\catcode`\\Q=3\n"
+       "\\gdef\\@myempty{Q}\n"
+       "\\endgroup\n"
+       "\n"
+       "% #1<-\\foo #2<-iii #3<-arity #4<-default value for (#2+1)th argument\n"
+       "\\def\\newlyxcommand@opt#1#2#3[#4]{\n"
+       "  % ##1<-\\foo@iii ##2<-\\foo@iiii \n"
+       "  % ####1<-{a}{b}{c} ####2<-default value ####3<- default arg\n"
+       "  \\def\\@defclause##1##2{\n"
+       "    \\def##1####1####2[####3]{\n"
+       "      \\ifx\\@myempty####3\\@myempty%\n"
+       "        \\def\\@callnext{\n"
+       "          \\@ifnextchar[%]\n"
+       "          {##2{####1{####2}}{#4}}\n"
+       "          {##2{####1{####2}}{#4}[#4]}\n"
+       "      }\n"
+       "      \\else\n"
+       "        \\def\\@callnext{\n"
+       "          \\@ifnextchar[%]\n"
+       "          {##2{####1{####3}}{#4}}\n"
+       "          {##2{####1{####3}}{#4}[#4]}\n"
+       "      }\n"
+       "      \\fi\n"
+       "      \\@callnext\n"
+       "    }\n"
+       "  }\n"
+       "  \\expandafter\\def\\expandafter\\@clausename\\expandafter{\\csname\\expandafter\\@gobble\\string#1@#2\\endcsname}\n"
+       "  \\expandafter\\def\\expandafter\\@nextclausename\\expandafter{\\csname\\expandafter\\@gobble\\string#1@#2i\\endcsname}\n"
+       "  \\expandafter\\expandafter\\expandafter  \n"
+       "  \\@defclause\\expandafter\\@clausename\\@nextclausename\n"
+       "  \\@ifnextchar[%]\n"
+       "  {\\newlyxcommand@opt{#1}{#2i}{#3}}\n"
+       "  {\\newlyxcommand@last{#1}{#2i}{#3}[#4]}\n"
+       "}\n"
+       "\n"
+       "% #1<-\\foo #2<-iii #3<-arity #4<-default value for (#2+1)th argument\n"
+       "\\def\\newlyxcommand@last#1#2#3[#4]{\n"
+       "  \\def\\@defclause##1##2{\n"
+       "    \\def##1####1####2[####3]{\n"
+       "      \\ifx\\@myempty####3\\@myempty%\n"
+       "        \\def\\@callnext{##2####1{####2}}\n"
+       "      \\else\n"
+       "        \\def\\@callnext{##2####1{####3}}\n"
+       "      \\fi\n"
+       "      \\@callnext\n"
+       "    }\n"
+       "  }\n"
+       "  \\expandafter\\def\\expandafter\\@clausename\\expandafter{\\csname\\expandafter\\@gobble\\string#1@#2\\endcsname}\n"
+       "  \\expandafter\\def\\expandafter\\@nextclausename\\expandafter{\\csname\\expandafter\\@gobble\\string#1@#2i\\endcsname}\n"
+       "  \\expandafter\\expandafter\\expandafter\n"
+       "  \\@defclause\\expandafter\\@clausename\\@nextclausename\n"
+       "  \\expandafter\\newlyxcommand@def\\csname\\expandafter\\@gobble\\string#1@#2i\\endcsname{#3}\n"
+       "}\n"
+       "\n"
+       "% #1<-\\foo #2<-arity #3<-definition\n"
+       "\\def\\newlyxcommand@def#1#2#3{\n"
+       "  \\ifx#20\n"
+       "  \\def#1{#3}\n"
+       "  \\else\n"
+       "  \\def\\@splitargs##1#2##2.{\\def#1##1#2}\\@splitargs##1##2##3##4##5##6##7##8##9.{#3}\n"
+       "  \\fi\n"
+       "}\n";
+       
 /////////////////////////////////////////////////////////////////////
 //
 // LaTeXFeatures
@@ -254,7 +353,7 @@ void LaTeXFeatures::getAvailable()
 }
 
 
-void LaTeXFeatures::useLayout(string const & layoutname)
+void LaTeXFeatures::useLayout(docstring const & layoutname)
 {
        // Some code to avoid loops in dependency definition
        static int level = 0;
@@ -262,21 +361,21 @@ void LaTeXFeatures::useLayout(string const & layoutname)
        if (level > maxlevel) {
                lyxerr << "LaTeXFeatures::useLayout: maximum level of "
                       << "recursion attained by layout "
-                      << layoutname << endl;
+                      << to_utf8(layoutname) << endl;
                return;
        }
 
        TextClass const & tclass = params_.getTextClass();
        if (tclass.hasLayout(layoutname)) {
                // Is this layout already in usedLayouts?
-               list<string>::const_iterator cit = usedLayouts_.begin();
-               list<string>::const_iterator end = usedLayouts_.end();
+               list<docstring>::const_iterator cit = usedLayouts_.begin();
+               list<docstring>::const_iterator end = usedLayouts_.end();
                for (; cit != end; ++cit) {
                        if (layoutname == *cit)
                                return;
                }
 
-               Layout_ptr const & lyt = tclass[layoutname];
+               LayoutPtr const & lyt = tclass[layoutname];
                if (!lyt->depends_on().empty()) {
                        ++level;
                        useLayout(lyt->depends_on());
@@ -285,7 +384,7 @@ void LaTeXFeatures::useLayout(string const & layoutname)
                usedLayouts_.push_back(layoutname);
        } else {
                lyxerr << "LaTeXFeatures::useLayout: layout `"
-                      << layoutname << "' does not exist in this class"
+                      << to_utf8(layoutname) << "' does not exist in this class"
                       << endl;
        }
 
@@ -307,9 +406,13 @@ bool LaTeXFeatures::mustProvide(string const & name) const
 
 bool LaTeXFeatures::isAvailable(string const & name)
 {
+       string n = name;
        if (packages_.empty())
                getAvailable();
-       return find(packages_.begin(), packages_.end(), name) != packages_.end();
+       size_t loc = n.rfind(".sty");
+       if (loc == n.length() - 4) 
+               n = n.erase(name.length() - 4);
+       return find(packages_.begin(), packages_.end(), n) != packages_.end();
 }
 
 
@@ -339,6 +442,10 @@ void LaTeXFeatures::useLanguage(Language const * lang)
 {
        if (!lang->babel().empty())
                UsedLanguages_.insert(lang);
+       // CJK languages do not have a babel name.
+       // They use the CJK package
+       if (lang->encoding()->package() == Encoding::CJK)
+               require("CJK");
 }
 
 
@@ -396,27 +503,38 @@ char const * simplefeatures[] = {
        "latexsym",
        "pifont",
        "subfigure",
-       "floatflt",
        "varioref",
        "prettyref",
+       /*For a successful cooperation of the `wrapfig' package with the
+         `float' package you should load the `wrapfig' package *after*
+         the `float' package. See the caption package documentation
+         for explanation.*/
        "float",
+       "wrapfig",
        "booktabs",
        "dvipost",
        "fancybox",
        "calc",
-       "nicefrac",
+       "units",
        "tipa",
        "framed",
        "pdfcolmk",
        "soul",
        "textcomp",
        "xcolor",
-       "wasysym",
        "pmboxdraw",
        "bbding",
        "ifsym",
        "marvosym",
        "txfonts",
+       "mathrsfs",
+       "ascii",
+       "url",
+       "covington",
+       "csquotes",
+       "enumitem",
+       "endnotes",
+       "ifthen"
 };
 
 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
@@ -429,6 +547,12 @@ string const LaTeXFeatures::getPackages() const
        ostringstream packages;
        TextClass const & tclass = params_.getTextClass();
 
+       // FIXME: currently, we can only load packages and macros known
+       // to LyX.
+       // However, with the Require tag of layouts/custom insets,
+       // also inknown packages can be requested. They are silently
+       // swallowed now. We should change this eventually.
+
        //
        //  These are all the 'simple' includes.  i.e
        //  packages which we just \usepackage{package}
@@ -444,8 +568,11 @@ string const LaTeXFeatures::getPackages() const
        // than those above.
        //
 
-       if (mustProvide("amsmath")
-           && params_.use_amsmath != BufferParams::package_off) {
+       // esint is preferred for esintoramsmath
+       if ((mustProvide("amsmath") &&
+            params_.use_amsmath != BufferParams::package_off) ||
+           (mustProvide("esintoramsmath") &&
+            params_.use_esint == BufferParams::package_off)) {
                packages << "\\usepackage{amsmath}\n";
        }
 
@@ -453,11 +580,12 @@ string const LaTeXFeatures::getPackages() const
        // are used
        // wasysym redefines some integrals (e.g. iint) from amsmath. That
        // leads to inconsistent integrals. We only load this package if
-       // esint is used, since esint redefines all relevant integral
-       // symbols from wasysym and amsmath.
+       // the document does not contain integrals (then isRequired("esint")
+       // is false) or if esint is used, since esint redefines all relevant
+       // integral symbols from wasysym and amsmath.
        // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
-       if (mustProvide("wasysym") && isRequired("esint") &&
-           params_.use_esint != BufferParams::package_off)
+       if (mustProvide("wasysym") &&
+           (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
                packages << "\\usepackage{wasysym}\n";
 
        // color.sty
@@ -487,10 +615,18 @@ string const LaTeXFeatures::getPackages() const
                                 << "]{graphicx}\n";
        }
        // shadecolor for shaded
-       if (mustProvide("framed") && mustProvide("color")) {
-               RGBColor c = RGBColor(lcolor.getX11Name(Color::shadedbg));
+       if (isRequired("framed") && mustProvide("color")) {
+               RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
+               //255.0 to force conversion to double
+               //NOTE As Jürgen Spitzmüller pointed out, an alternative would be
+               //to use the xcolor package instead, and then we can do
+               // \define{shadcolor}{RGB}...
+               //and not do any conversion. We'd then need to require xcolor
+               //in InsetNote::validate().
+               int const stmSize = packages.precision(2);
                packages << "\\definecolor{shadecolor}{rgb}{"
-                       << c.r/255 << ',' << c.g/255 << ',' << c.b/255 << "}\n";
+                       << c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
+               packages.precision(stmSize);
        }
 
        // lyxskak.sty --- newer chess support based on skak.sty
@@ -529,15 +665,10 @@ string const LaTeXFeatures::getPackages() const
 
        // esint must be after amsmath and wasysym, since it will redeclare
        // inconsistent integral symbols
-       if (mustProvide("esint")
-           && params_.use_esint != BufferParams::package_off)
+       if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
+           params_.use_esint != BufferParams::package_off)
                packages << "\\usepackage{esint}\n";
 
-       // url.sty
-       if (mustProvide("url"))
-               packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
-                           "                      {\\newcommand{\\url}{\\texttt}}\n";
-
        // natbib.sty
        if (mustProvide("natbib")) {
                packages << "\\usepackage[";
@@ -589,9 +720,8 @@ string const LaTeXFeatures::getMacros() const
                macros << '\n';
        FeaturesList::const_iterator pit  = preamble_snippets_.begin();
        FeaturesList::const_iterator pend = preamble_snippets_.end();
-       for (; pit != pend; ++pit) {
+       for (; pit != pend; ++pit)
                macros << *pit << '\n';
-       }
 
        if (mustProvide("LyX"))
                macros << lyx_def << '\n';
@@ -605,6 +735,12 @@ string const LaTeXFeatures::getMacros() const
        if (mustProvide("lyxarrow"))
                macros << lyxarrow_def << '\n';
 
+       if (mustProvide("textgreek"))
+               macros << textgreek_def << '\n';
+
+       if (mustProvide("textcyr"))
+               macros << textcyr_def << '\n';
+
        // quotes.
        if (mustProvide("quotesinglbase"))
                macros << quotesinglbase_def << '\n';
@@ -626,6 +762,8 @@ string const LaTeXFeatures::getMacros() const
                macros << binom_def << '\n';
        if (mustProvide("mathcircumflex"))
                macros << mathcircumflex_def << '\n';
+       if (mustProvide("newlyxcommand"))
+               macros << newlyxcommand_def << '\n';
 
        // other
        if (mustProvide("ParagraphLeftIndent"))
@@ -648,24 +786,28 @@ string const LaTeXFeatures::getMacros() const
        getFloatDefinitions(macros);
 
        // change tracking
-       if (mustProvide("ct-dvipost")) {
+       if (mustProvide("ct-dvipost"))
                macros << changetracking_dvipost_def;
-       }
+
        if (mustProvide("ct-xcolor-soul")) {
-               RGBColor cadd = RGBColor(lcolor.getX11Name(Color::addedtext));
+               int const prec = macros.precision(2);
+       
+               RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
                macros << "\\providecolor{lyxadded}{rgb}{"
-                      << cadd.r/255 << ',' << cadd.g/255 << ',' << cadd.b/255 << "}\n";
+                      << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
 
-               RGBColor cdel = RGBColor(lcolor.getX11Name(Color::deletedtext));
+               RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
                macros << "\\providecolor{lyxdeleted}{rgb}{"
-                      << cdel.r/255 << ',' << cdel.g/255 << ',' << cdel.b/255 << "}\n";
+                      << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
 
-               macros << "\\newcommand{\\lyxadded}[3]{\\color{lyxadded}{#3}}\n"
-                      << "\\newcommand{\\lyxdeleted}[3]{\\color{lyxdeleted}{\\st{#3}}}\n";
+               macros.precision(prec);
+
+               macros << "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
+                      << "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\st{#3}}}\n";
        }
-       if (mustProvide("ct-none")) {
+
+       if (mustProvide("ct-none"))
                macros << changetracking_none_def;
-       }
 
        return macros.str();
 }
@@ -695,19 +837,12 @@ docstring const LaTeXFeatures::getTClassPreamble() const
 
        tcpreamble << tclass.preamble();
 
-       list<string>::const_iterator cit = usedLayouts_.begin();
-       list<string>::const_iterator end = usedLayouts_.end();
+       list<docstring>::const_iterator cit = usedLayouts_.begin();
+       list<docstring>::const_iterator end = usedLayouts_.end();
        for (; cit != end; ++cit) {
                tcpreamble << tclass[*cit]->preamble();
        }
 
-       CharStyles::iterator cs = tclass.charstyles().begin();
-       CharStyles::iterator csend = tclass.charstyles().end();
-       for (; cs != csend; ++cs) {
-               if (isRequired(cs->name))
-                       tcpreamble << cs->preamble;
-       }
-
        return tcpreamble.str();
 }