]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.cpp
fix warning on possibly(?) unused precompiled headers due to different -fPic settings...
[lyx.git] / src / LaTeXFeatures.cpp
index fbc1e7c423340341f4810ee809f67ac622a4787e..d5163a09d4328c7ec2a5bc3cdf41d464baaac6eb 100644 (file)
 #include "LaTeXFeatures.h"
 
 #include "BufferParams.h"
-#include "color.h"
+#include "Color.h"
 #include "debug.h"
 #include "Encoding.h"
 #include "Floating.h"
 #include "FloatList.h"
-#include "LColor.h"
 #include "Language.h"
-#include "LyXLex.h"
-#include "lyx_sty.h"
+#include "Lexer.h"
 #include "LyXRC.h"
 
 #include "support/docstream.h"
 
 #include "frontends/controllers/frontend_helpers.h"
 
-namespace lyx {
-
-using support::isSGMLFilename;
-using support::libFileSearch;
-using support::makeRelPath;
-using support::onlyPath;
-
 using std::endl;
 using std::find;
 using std::string;
@@ -48,6 +39,161 @@ using std::ostream;
 using std::ostringstream;
 using std::set;
 
+
+namespace lyx {
+
+using support::isSGMLFilename;
+using support::libFileSearch;
+using support::makeRelPath;
+using support::onlyPath;
+
+/////////////////////////////////////////////////////////////////////
+//
+// Strings
+//
+/////////////////////////////////////////////////////////////////////
+
+//\NeedsTeXFormat{LaTeX2e}
+//\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
+//\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
+
+static string const lyx_def =
+       "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}";
+
+static string const lyxline_def =
+       "\\newcommand{\\lyxline}[1][1pt]{%\n"
+       "  \\par\\noindent%\n"
+       "  \\rule[.5ex]{\\linewidth}{#1}\\par}";
+
+static string const noun_def = "\\newcommand{\\noun}[1]{\\textsc{#1}}";
+
+static string const lyxarrow_def =
+       "\\newcommand{\\lyxarrow}{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}";
+
+// for quotes without babel. This does not give perfect results, but
+// anybody serious about non-english quotes should use babel (JMarc).
+
+static string const quotedblbase_def =
+       "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
+       "  \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
+       "  \\penalty10000\\hskip0em\\relax%\n"
+       "}";
+
+static string const quotesinglbase_def =
+       "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
+       "  \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
+       "  \\penalty10000\\hskip0em\\relax%\n"
+       "}";
+
+static string const guillemotleft_def =
+       "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
+       "  {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
+       "\\penalty10000\\hskip0pt\\relax%\n"
+       "}";
+
+static string const guillemotright_def =
+       "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
+       "  \\penalty10000\\hskip0pt%\n"
+       "  {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
+       "}";
+
+static string const guilsinglleft_def =
+       "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
+       "  {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
+       "  \\penalty10000\\hskip0pt\\relax%\n"
+       "}";
+
+static string const guilsinglright_def =
+       "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
+       "  \\penalty10000\\hskip0pt%\n"
+       "  {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
+       "}";
+
+static string const paragraphleftindent_def =
+       "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
+       "{\n"
+       "  \\begin{list}{}{%\n"
+       "    \\setlength{\\topsep}{0pt}%\n"
+       "    \\addtolength{\\leftmargin}{#1}\n"
+// ho hum, yet more things commented out with no hint as to why they
+// weren't just removed
+//     "%%    \\addtolength{\\leftmargin}{#1\\textwidth}\n"
+//     "%%    \\setlength{\\textwidth}{#2\\textwidth}\n"
+//     "%%    \\setlength\\listparindent\\parindent%\n"
+//     "%%    \\setlength\\itemindent\\parindent%\n"
+       "    \\setlength{\\parsep}{0pt plus 1pt}%\n"
+       "  }\n"
+       "  \\item[]\n"
+       "}\n"
+       "{\\end{list}}\n";
+
+static string const floatingfootnote_def =
+       "%% Special footnote code from the package 'stblftnt.sty'\n"
+       "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
+       "\\let\\SF@@footnote\\footnote\n"
+       "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
+       "    \\expandafter\\SF@@footnote\n"
+       "  \\else\n"
+       "    \\expandafter\\SF@gobble@opt\n"
+       "  \\fi\n"
+       "}\n"
+       "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
+       "  \\SF@gobble@twobracket\n"
+       "  \\@gobble\n"
+       "}\n"
+       "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
+       "  \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
+       "\\def\\SF@gobble@twobracket[#1]#2{}\n";
+
+static string const boldsymbol_def =
+       "%% Bold symbol macro for standard LaTeX users\n"
+       "\\providecommand{\\boldsymbol}[1]{\\mbox{\\boldmath $#1$}}\n";
+
+static string const binom_def =
+       "%% Binom macro for standard LaTeX users\n"
+       "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n";
+
+static string const mathcircumflex_def =
+       "%% For printing a cirumflex inside a formula\n"
+       "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n";
+
+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";
+
+// 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
+static string const lyxdot_def =
+       "%% A simple dot to overcome graphicx limitations\n"
+       "\\newcommand{\\lyxdot}{.}\n";
+
+static string const changetracking_dvipost_def =
+       "%% Change tracking with dvipost\n"
+       "\\dvipostlayout\n"
+       "\\dvipost{osstart color push Red}\n"
+       "\\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"
+       "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n";
+
+static string const changetracking_none_def =
+       "\\newcommand{\\lyxadded}[3]{#3}\n"
+       "\\newcommand{\\lyxdeleted}[3]{}\n";
+
+
+/////////////////////////////////////////////////////////////////////
+//
+// LaTeXFeatures
+//
+/////////////////////////////////////////////////////////////////////
+
 LaTeXFeatures::PackagesList LaTeXFeatures::packages_;
 
 
@@ -60,7 +206,8 @@ LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
 bool LaTeXFeatures::useBabel() const
 {
        return lyxrc.language_use_babel ||
-               bufferParams().language->lang() != lyxrc.default_language ||
+               (bufferParams().language->lang() != lyxrc.default_language &&
+                !bufferParams().language->babel().empty()) ||
                this->hasLanguages();
 }
 
@@ -76,7 +223,7 @@ void LaTeXFeatures::require(string const & name)
 
 void LaTeXFeatures::getAvailable()
 {
-       LyXLex lex(0, 0);
+       Lexer lex(0, 0);
        support::FileName const real_file = libFileSearch("", "packages.lst");
 
        if (real_file.empty())
@@ -94,7 +241,7 @@ void LaTeXFeatures::getAvailable()
        // Parse config-file
        while (lex.isOK() && !finished) {
                switch (lex.lex()) {
-               case LyXLex::LEX_FEOF:
+               case Lexer::LEX_FEOF:
                        finished = true;
                        break;
                default:
@@ -108,7 +255,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;
@@ -116,21 +263,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;
        }
 
-       LyXTextClass const & tclass = params_.getLyXTextClass();
+       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;
                }
 
-               LyXLayout_ptr const & lyt = tclass[layoutname];
+               Layout_ptr const & lyt = tclass[layoutname];
                if (!lyt->depends_on().empty()) {
                        ++level;
                        useLayout(lyt->depends_on());
@@ -139,7 +286,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;
        }
 
@@ -155,7 +302,7 @@ bool LaTeXFeatures::isRequired(string const & name) const
 
 bool LaTeXFeatures::mustProvide(string const & name) const
 {
-       return isRequired(name) && !params_.getLyXTextClass().provides(name);
+       return isRequired(name) && !params_.getTextClass().provides(name);
 }
 
 
@@ -182,7 +329,7 @@ void LaTeXFeatures::useFloat(string const & name)
        // We only need float.sty if we use non builtin floats, or if we
        // use the "H" modifier. This includes modified table and
        // figure floats. (Lgb)
-       Floating const & fl = params_.getLyXTextClass().floats().getType(name);
+       Floating const & fl = params_.getTextClass().floats().getType(name);
        if (!fl.type().empty() && !fl.builtin()) {
                require("float");
        }
@@ -191,7 +338,8 @@ void LaTeXFeatures::useFloat(string const & name)
 
 void LaTeXFeatures::useLanguage(Language const * lang)
 {
-       UsedLanguages_.insert(lang);
+       if (!lang->babel().empty())
+               UsedLanguages_.insert(lang);
 }
 
 
@@ -211,26 +359,29 @@ string LaTeXFeatures::getLanguages() const
 {
        ostringstream languages;
 
-       for (LanguageList::const_iterator cit =
-                   UsedLanguages_.begin();
+       LanguageList::const_iterator const begin = UsedLanguages_.begin();
+       for (LanguageList::const_iterator cit = begin;
             cit != UsedLanguages_.end();
-            ++cit)
-               languages << (*cit)->babel() << ',';
+            ++cit) {
+               if (cit != begin)
+                       languages << ',';
+               languages << (*cit)->babel();
+       }
        return languages.str();
 }
 
 
 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 {
+       // This does only find encodings of languages supported by babel, but
+       // that does not matter since we don't have a language with an
+       // encoding supported by inputenc but without babel support.
        set<string> encodings;
        LanguageList::const_iterator it  = UsedLanguages_.begin();
        LanguageList::const_iterator end = UsedLanguages_.end();
        for (; it != end; ++it)
-               // thailatex does not use the inputenc package, but sets up
-               // babel directly for tis620-0 encoding, therefore we must
-               // not add tis620-0 to the encoding set.
                if ((*it)->encoding()->latexName() != doc_encoding &&
-                   (*it)->encoding()->name() != "tis620-0")
+                   (*it)->encoding()->package() == Encoding::inputenc)
                        encodings.insert((*it)->encoding()->latexName());
        return encodings;
 }
@@ -238,6 +389,7 @@ set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 namespace {
 
 char const * simplefeatures[] = {
+// note that the package order here will be the same in the LaTeX-output
        "array",
        "verbatim",
        "longtable",
@@ -256,7 +408,17 @@ char const * simplefeatures[] = {
        "nicefrac",
        "tipa",
        "framed",
+       "pdfcolmk",
+       "soul",
        "textcomp",
+       "xcolor",
+       "pmboxdraw",
+       "bbding",
+       "ifsym",
+       "marvosym",
+       "txfonts",
+       "mathrsfs",
+       "ascii",
 };
 
 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
@@ -267,7 +429,7 @@ int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 string const LaTeXFeatures::getPackages() const
 {
        ostringstream packages;
-       LyXTextClass const & tclass = params_.getLyXTextClass();
+       TextClass const & tclass = params_.getTextClass();
 
        //
        //  These are all the 'simple' includes.  i.e
@@ -284,8 +446,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";
        }
 
@@ -293,11 +458,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
@@ -327,10 +493,18 @@ string const LaTeXFeatures::getPackages() const
                                 << "]{graphicx}\n";
        }
        // shadecolor for shaded
-       if (mustProvide("framed")) {
-               RGBColor c = RGBColor(lcolor.getX11Name(LColor::shadedbg));
-               packages << "\\definecolor{shadecolor}{rgb}{" 
-                       << c.r/255 << ',' << c.g/255 << ',' << c.b/255 << "}\n";
+       if (mustProvide("framed") && mustProvide("color")) {
+               RGBColor c = RGBColor(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.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
+               packages.precision(stmSize);
        }
 
        // lyxskak.sty --- newer chess support based on skak.sty
@@ -363,14 +537,14 @@ string const LaTeXFeatures::getPackages() const
        }
 
        // amssymb.sty
-       if (mustProvide("amssymb") 
+       if (mustProvide("amssymb")
            || params_.use_amsmath == BufferParams::package_on)
                packages << "\\usepackage{amssymb}\n";
 
        // 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
@@ -408,12 +582,15 @@ string const LaTeXFeatures::getPackages() const
                // but don't use the compatibility option since it is
                // incompatible to other packages.
                packages << "\\usepackage{nomencl}\n"
-                           "% the following is useful when we have the old nomencl.sty package\n"
-                           "\\providecommand{\\printnomenclature}{\\printglossary}\n"
-                           "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
-                           "\\makenomenclature\n";
+                           "% the following is useful when we have the old nomencl.sty package\n"
+                           "\\providecommand{\\printnomenclature}{\\printglossary}\n"
+                           "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
+                           "\\makenomenclature\n";
        }
+
+       if (mustProvide("listings"))
+               packages << "\\usepackage{listings}\n";
+
        return packages.str();
 }
 
@@ -484,6 +661,30 @@ string const LaTeXFeatures::getMacros() const
        // floats
        getFloatDefinitions(macros);
 
+       // change tracking
+       if (mustProvide("ct-dvipost")) {
+               macros << changetracking_dvipost_def;
+       }
+       if (mustProvide("ct-xcolor-soul")) {
+               int const prec = macros.precision(2);
+       
+               RGBColor cadd = RGBColor(lcolor.getX11Name(Color::addedtext));
+               macros << "\\providecolor{lyxadded}{rgb}{"
+                      << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
+
+               RGBColor cdel = RGBColor(lcolor.getX11Name(Color::deletedtext));
+               macros << "\\providecolor{lyxdeleted}{rgb}{"
+                      << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
+
+               macros.precision(prec);
+
+               macros << "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
+                      << "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\st{#3}}}\n";
+       }
+       if (mustProvide("ct-none")) {
+               macros << changetracking_none_def;
+       }
+
        return macros.str();
 }
 
@@ -507,13 +708,13 @@ string const LaTeXFeatures::getBabelOptions() const
 docstring const LaTeXFeatures::getTClassPreamble() const
 {
        // the text class specific preamble
-       LyXTextClass const & tclass = params_.getLyXTextClass();
+       TextClass const & tclass = params_.getTextClass();
        odocstringstream tcpreamble;
 
        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();
        }
@@ -589,7 +790,7 @@ BufferParams const & LaTeXFeatures::bufferParams() const
 
 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
 {
-       FloatList const & floats = params_.getLyXTextClass().floats();
+       FloatList const & floats = params_.getTextClass().floats();
 
        // Here we will output the code to create the needed float styles.
        // We will try to do this as minimal as possible.