]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.cpp
Fix bug 4441. GuiRef: Ok button must be default.
[lyx.git] / src / LaTeXFeatures.cpp
index 4b47083660359ab38ce85ebee0c489465a26ed3f..99a7d811ef8baec3a7a436aca45e643f4a2ccfa0 100644 (file)
@@ -3,11 +3,11 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author José Matos
- * \author Lars Gullik Bjønnes
+ * \author José Matos
+ * \author Lars Gullik Bjønnes
  * \author Jean-Marc Lasgouttes
- * \author Jürgen Vigna
- * \author André Pönitz
+ * \author Jürgen Vigna
+ * \author André Pönitz
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -16,8 +16,9 @@
 
 #include "LaTeXFeatures.h"
 
-#include "Color.h"
+#include "Buffer.h"
 #include "BufferParams.h"
+#include "ColorSet.h"
 #include "Encoding.h"
 #include "Floating.h"
 #include "FloatList.h"
@@ -36,6 +37,7 @@
 using namespace std;
 using namespace lyx::support;
 
+
 namespace lyx {
 
 /////////////////////////////////////////////////////////////////////
@@ -59,7 +61,10 @@ static string const lyxline_def =
 static string const noun_def = "\\newcommand{\\noun}[1]{\\textsc{#1}}";
 
 static string const lyxarrow_def =
-       "\\newcommand{\\lyxarrow}{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}";
+       "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
+       "\\@ifstar\n"
+       "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
+       "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}";
 
 // for quotes without babel. This does not give perfect results, but
 // anybody serious about non-english quotes should use babel (JMarc).
@@ -170,15 +175,15 @@ static string const changetracking_dvipost_def =
        "\\newcommand{\\lyxdeleted}[3]{%\n"
        "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n";
 
-static string const changetracking_xcolor_soul_def =
-       "%% Change tracking with soul\n"
+static string const changetracking_xcolor_ulem_def =
+       "%% Change tracking with ulem\n"
        "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
-       "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\st{#3}}}\n";
+       "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n";
 
-static string const changetracking_xcolor_soul_hyperref_def =
-       "%% Change tracking with soul\n"
+static string const changetracking_xcolor_ulem_hyperref_def =
+       "%% Change tracking with ulem\n"
        "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}}{}#3}}\n"
-       "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\st{#3}}{}}}\n";
+       "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n";
 
 static string const changetracking_none_def =
        "\\newcommand{\\lyxadded}[3]{#3}\n"
@@ -186,18 +191,68 @@ static string const changetracking_none_def =
 
 static string const textgreek_def =
        "\\DeclareRobustCommand{\\greektext}{%\n"
-       " \\fontencoding{LGR}\\selectfont\n"
-       " \\def\\encodingdefault{LGR}}\n"
+       "  \\fontencoding{LGR}\\selectfont\\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"
+       "  \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
        "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
-       "\\DeclareFontEncoding{T2A}{}{}\n";
-       
+       "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n";
+
+static string const lyxmathsym_def =
+       "\\newcommand{\\lyxmathsym}{\\@ifstar{\\lyxm@thsym\\textit}{\\lyxm@thsym\\textrm}}\n"
+       "\\newcommand{\\lyxm@thsym}[2]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
+       "  #1{\\ifx\\math@version\\b@ld\\bfseries\\fi#2}\\endgroup\\else#2\\fi}\n";
+
+static string const papersizedvi_def =
+       "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n";
+
+static string const papersizepdf_def =
+       "\\pdfpageheight\\paperheight\n"
+       "\\pdfpagewidth\\paperwidth\n";
+
+static string const cedilla_def =
+       "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
+       "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n";
+
+static string const subring_def =
+       "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
+       "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n";
+
+static string const subdot_def =
+       "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
+       "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n";
+
+static string const subhat_def =
+       "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
+       "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n";
+
+static string const subtilde_def =
+       "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
+       "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n";
+
+static string const dacute_def =
+       "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n";
+
+static string const tipasymb_def =
+       "\\DeclareFontEncoding{T3}{}{}\n"
+       "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n";
+
+static string const dgrave_def =
+       "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n";
+
+static string const rcap_def =
+       "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n";
+
+static string const ogonek_def =
+       "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
+       "  \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
+       "  \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
+       "  \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
+       "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n";
+
 /////////////////////////////////////////////////////////////////////
 //
 // LaTeXFeatures
@@ -209,7 +264,7 @@ LaTeXFeatures::Packages LaTeXFeatures::packages_;
 
 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
                             OutputParams const & r)
-       : buffer_(&b), params_(p), runparams_(r)
+       : buffer_(&b), params_(p), runparams_(r), in_float_(false)
 {}
 
 
@@ -236,7 +291,7 @@ void LaTeXFeatures::require(set<string> const & names)
 
 void LaTeXFeatures::getAvailable()
 {
-       Lexer lex(0, 0);
+       Lexer lex;
        support::FileName const real_file = libFileSearch("", "packages.lst");
 
        if (real_file.empty())
@@ -354,10 +409,15 @@ void LaTeXFeatures::useLanguage(Language const * lang)
 {
        if (!lang->babel().empty())
                UsedLanguages_.insert(lang);
+       if (lang->lang() == "vietnamese")
+               require("vietnamese");
        // CJK languages do not have a babel name.
        // They use the CJK package
        if (lang->encoding()->package() == Encoding::CJK)
                require("CJK");
+       // japanese package is special
+       if (lang->encoding()->package() == Encoding::japanese)
+               require("japanese");
 }
 
 
@@ -399,7 +459,8 @@ set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
        LanguageList::const_iterator end = UsedLanguages_.end();
        for (; it != end; ++it)
                if ((*it)->encoding()->latexName() != doc_encoding &&
-                   (*it)->encoding()->package() == Encoding::inputenc)
+                   ((*it)->encoding()->package() == Encoding::inputenc
+                    || (*it)->encoding()->package() == Encoding::japanese))
                        encodings.insert((*it)->encoding()->latexName());
        return encodings;
 }
@@ -414,7 +475,7 @@ char const * simplefeatures[] = {
        "rotating",
        "latexsym",
        "pifont",
-       "subfig",
+       // subfig is handled in BufferParams.cpp
        "varioref",
        "prettyref",
        /*For a successful cooperation of the `wrapfig' package with the
@@ -448,8 +509,11 @@ char const * simplefeatures[] = {
        "endnotes",
        "ifthen",
        "amsthm",
-       "listings",
-       "bm"
+       // listings is handled in BufferParams.cpp
+       "bm",
+       "pdfpages",
+       "amscd",
+       "slashed"
 };
 
 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
@@ -457,6 +521,35 @@ int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 }
 
 
+string const LaTeXFeatures::getColorOptions() const
+{
+       ostringstream colors;
+
+       // Handling the color packages separately is needed to be able to load them
+       // before babel when hyperref is loaded with the colorlinks option
+       // for more info see Bufferparams.cpp
+
+       // [x]color.sty
+       if (mustProvide("color") || mustProvide("xcolor")) {
+               string const package =
+                       (mustProvide("xcolor") ? "xcolor" : "color");
+               if (params_.graphicsDriver == "default"
+                       || params_.graphicsDriver == "none")
+                       colors << "\\usepackage{" << package << "}\n";
+               else
+                       colors << "\\usepackage["
+                                << params_.graphicsDriver
+                                << "]{" << package << "}\n";
+       }
+
+       // pdfcolmk must be loaded after color
+       if (mustProvide("pdfcolmk"))
+               colors << "\\usepackage{pdfcolmk}\n";
+
+       return colors.str();
+}
+
+
 string const LaTeXFeatures::getPackages() const
 {
        ostringstream packages;
@@ -484,11 +577,18 @@ string const LaTeXFeatures::getPackages() const
        //
 
        // esint is preferred for esintoramsmath
-       if ((mustProvide("amsmath") &&
-            params_.use_amsmath != BufferParams::package_off) ||
-           (mustProvide("esintoramsmath") &&
-            params_.use_esint == BufferParams::package_off)) {
+       if ((mustProvide("amsmath")
+            && params_.use_amsmath != BufferParams::package_off)
+           || (mustProvide("esintoramsmath")
+               && params_.use_esint == BufferParams::package_off
+               && params_.use_amsmath != BufferParams::package_off)) {
                packages << "\\usepackage{amsmath}\n";
+       } else {
+               // amsbsy and amstext are already provided by amsmath
+               if (mustProvide("amsbsy"))
+                       packages << "\\usepackage{amsbsy}\n";
+               if (mustProvide("amstext"))
+                       packages << "\\usepackage{amstext}\n";
        }
        
        // wasysym is a simple feature, but it must be after amsmath if both
@@ -503,23 +603,12 @@ string const LaTeXFeatures::getPackages() const
            (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
                packages << "\\usepackage{wasysym}\n";
 
-       // [x]color.sty
-       if (mustProvide("color") || mustProvide("xcolor")) {
-               string const package =
-                       (mustProvide("xcolor") ? "xcolor" : "color");
-               if (params_.graphicsDriver == "default")
-                       packages << "\\usepackage{" << package << "}\n";
-               else
-                       packages << "\\usepackage["
-                                << params_.graphicsDriver
-                                << "]{" << package << "}\n";
-       }
-
-       // pdfcolmk must be loaded after color
-       if (mustProvide("pdfcolmk")) {
-               packages << "\\usepackage{pdfcolmk}\n";
-       }
+       // accents must be loaded after amsmath
+       if (mustProvide("accents"))
+               packages << "\\usepackage{accents}\n";
 
+       // [x]color and pdfcolmk are handled in getColorOptions() above
+       
        // makeidx.sty
        if (isRequired("makeidx")) {
                if (!tclass.provides("makeidx"))
@@ -540,7 +629,7 @@ string const LaTeXFeatures::getPackages() const
        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
+               //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
@@ -552,13 +641,12 @@ string const LaTeXFeatures::getPackages() const
        }
 
        // lyxskak.sty --- newer chess support based on skak.sty
-       if (mustProvide("chess")) {
+       if (mustProvide("chess"))
                packages << "\\usepackage[ps,mover]{lyxskak}\n";
-       }
 
        // setspace.sty
        if (mustProvide("setspace") && !tclass.provides("SetSpace"))
-                   packages << "\\usepackage{setspace}\n";
+               packages << "\\usepackage{setspace}\n";
 
        // amssymb.sty
        if (mustProvide("amssymb")
@@ -572,35 +660,38 @@ string const LaTeXFeatures::getPackages() const
                packages << "\\usepackage{esint}\n";
 
        // natbib.sty
-       if (mustProvide("natbib")) {
+       // Some classes load natbib themselves, but still allow (or even require)
+       // plain numeric citations (ReVTeX is such a case, see bug 5182).
+       // This special case is indicated by the "natbib-internal" key.
+       if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
                packages << "\\usepackage[";
-               if (params_.getEngine() == biblio::ENGINE_NATBIB_NUMERICAL) {
+               if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
                        packages << "numbers";
-               } else {
+               else
                        packages << "authoryear";
-               }
                packages << "]{natbib}\n";
        }
 
        // jurabib -- we need version 0.6 at least.
-       if (mustProvide("jurabib")) {
+       if (mustProvide("jurabib"))
                packages << "\\usepackage{jurabib}[2004/01/25]\n";
-       }
        
        // xargs -- we need version 1.09 at least
-       if (mustProvide("xargs")) {
+       if (mustProvide("xargs"))
                packages << "\\usepackage{xargs}[2008/03/08]\n";
-       }
 
        // bibtopic -- the dot provides the aux file naming which
        // LyX can detect.
-       if (mustProvide("bibtopic")) {
+       if (mustProvide("bibtopic"))
                packages << "\\usepackage[dot]{bibtopic}\n";
-       }
 
        if (mustProvide("xy"))
                packages << "\\usepackage[all]{xy}\n";
 
+       if (mustProvide("ulem"))
+               packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
+                           "\\usepackage{ulem}\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
@@ -627,6 +718,13 @@ string const LaTeXFeatures::getMacros() const
        for (; pit != pend; ++pit)
                macros << *pit << '\n';
 
+        if (mustProvide("papersize")) {
+               if (runparams_.flavor == OutputParams::LATEX)
+                       macros << papersizedvi_def << '\n';
+               else
+                       macros << papersizepdf_def << '\n';
+       }
+
        if (mustProvide("LyX"))
                macros << lyx_def << '\n';
 
@@ -645,6 +743,39 @@ string const LaTeXFeatures::getMacros() const
        if (mustProvide("textcyr"))
                macros << textcyr_def << '\n';
 
+       if (mustProvide("lyxmathsym"))
+               macros << lyxmathsym_def << '\n';
+
+       if (mustProvide("cedilla"))
+               macros << cedilla_def << '\n';
+
+       if (mustProvide("subring"))
+               macros << subring_def << '\n';
+
+       if (mustProvide("subdot"))
+               macros << subdot_def << '\n';
+
+       if (mustProvide("subhat"))
+               macros << subhat_def << '\n';
+
+       if (mustProvide("subtilde"))
+               macros << subtilde_def << '\n';
+
+       if (mustProvide("dacute"))
+               macros << dacute_def << '\n';
+
+       if (mustProvide("tipasymb"))
+               macros << tipasymb_def << '\n';
+
+       if (mustProvide("dgrave"))
+               macros << dgrave_def << '\n';
+
+       if (mustProvide("rcap"))
+               macros << rcap_def << '\n';
+
+       if (mustProvide("ogonek"))
+               macros << ogonek_def << '\n';
+
        // quotes.
        if (mustProvide("quotesinglbase"))
                macros << quotesinglbase_def << '\n';
@@ -689,7 +820,7 @@ string const LaTeXFeatures::getMacros() const
        if (mustProvide("ct-dvipost"))
                macros << changetracking_dvipost_def;
 
-       if (mustProvide("ct-xcolor-soul")) {
+       if (mustProvide("ct-xcolor-ulem")) {
                int const prec = macros.precision(2);
        
                RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
@@ -703,9 +834,9 @@ string const LaTeXFeatures::getMacros() const
                macros.precision(prec);
                
                if (isRequired("hyperref"))
-                       macros << changetracking_xcolor_soul_hyperref_def;
+                       macros << changetracking_xcolor_ulem_hyperref_def;
                else
-                       macros << changetracking_xcolor_soul_def;
+                       macros << changetracking_xcolor_ulem_def;
        }
 
        if (mustProvide("ct-none"))
@@ -741,10 +872,40 @@ docstring const LaTeXFeatures::getTClassPreamble() const
 
        list<docstring>::const_iterator cit = usedLayouts_.begin();
        list<docstring>::const_iterator end = usedLayouts_.end();
-       for (; cit != end; ++cit) {
+       for (; cit != end; ++cit)
                tcpreamble << tclass[*cit].preamble();
+
+       return tcpreamble.str();
+}
+
+
+docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel) const
+{
+       DocumentClass const & tclass = params_.documentClass();
+       // collect preamble snippets in a set to prevent multiple identical
+       // commands (would happen if e.g. both theorem and theorem* are used)
+       set<docstring> snippets;
+       typedef LanguageList::const_iterator lang_it;
+       lang_it const lbeg = UsedLanguages_.begin();
+       lang_it const lend =  UsedLanguages_.end();
+       list<docstring>::const_iterator cit = usedLayouts_.begin();
+       list<docstring>::const_iterator end = usedLayouts_.end();
+       for (; cit != end; ++cit) {
+               // language dependent commands (once per document)
+               snippets.insert(tclass[*cit].langpreamble(buffer().language()));
+               // commands for language changing (for multilanguage documents)
+               if (use_babel && !UsedLanguages_.empty()) {
+                       snippets.insert(tclass[*cit].babelpreamble(buffer().language()));
+                       for (lang_it lit = lbeg; lit != lend; ++lit)
+                               snippets.insert(tclass[*cit].babelpreamble(*lit));
+               }
        }
 
+       odocstringstream tcpreamble;
+       set<docstring>::const_iterator const send = snippets.end();
+       set<docstring>::const_iterator it = snippets.begin();
+       for (; it != send; ++it)
+               tcpreamble << *it;
        return tcpreamble.str();
 }
 
@@ -780,7 +941,8 @@ docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
 }
 
 
-void LaTeXFeatures::showStruct() const {
+void LaTeXFeatures::showStruct() const
+{
        lyxerr << "LyX needs the following commands when LaTeXing:"
               << "\n***** Packages:" << getPackages()
               << "\n***** Macros:" << getMacros()