]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.cpp
endl is defined in ostream, iomanip is not enough (it matters for gcc 4.3)
[lyx.git] / src / LaTeXFeatures.cpp
index f192813d73bfa41f8c6b34b11799038668cec89d..1e809380179ac19c81036f8074bf4a7296e62f2a 100644 (file)
@@ -18,7 +18,6 @@
 
 #include "Color.h"
 #include "BufferParams.h"
-#include "support/debug.h"
 #include "Encoding.h"
 #include "Floating.h"
 #include "FloatList.h"
 #include "LyXRC.h"
 #include "TextClass.h"
 
+#include "support/debug.h"
 #include "support/docstream.h"
 #include "support/FileName.h"
 #include "support/filetools.h"
+#include "support/lstrings.h"
 
 using namespace std;
 using namespace lyx::support;
 
+
 namespace lyx {
 
 /////////////////////////////////////////////////////////////////////
@@ -135,10 +137,6 @@ static string const floatingfootnote_def =
        "  \\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";
@@ -200,101 +198,6 @@ static string const textcyr_def =
        " \\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";
        
 /////////////////////////////////////////////////////////////////////
 //
@@ -302,7 +205,7 @@ static string const newlyxcommand_def =
 //
 /////////////////////////////////////////////////////////////////////
 
-LaTeXFeatures::PackagesList LaTeXFeatures::packages_;
+LaTeXFeatures::Packages LaTeXFeatures::packages_;
 
 
 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
@@ -322,16 +225,19 @@ bool LaTeXFeatures::useBabel() const
 
 void LaTeXFeatures::require(string const & name)
 {
-       if (isRequired(name))
-               return;
+       features_.insert(name);
+}
+
 
-       features_.push_back(name);
+void LaTeXFeatures::require(set<string> const & names)
+{
+       features_.insert(names.begin(), names.end());
 }
 
 
 void LaTeXFeatures::getAvailable()
 {
-       Lexer lex(0, 0);
+       Lexer lex;
        support::FileName const real_file = libFileSearch("", "packages.lst");
 
        if (real_file.empty())
@@ -353,11 +259,7 @@ void LaTeXFeatures::getAvailable()
                        finished = true;
                        break;
                default:
-                       string const name = lex.getString();
-                       PackagesList::const_iterator begin = packages_.begin();
-                       PackagesList::const_iterator end   = packages_.end();
-                       if (find(begin, end, name) == end)
-                               packages_.push_back(name);
+                       packages_.insert(lex.getString());
                }
        }
 }
@@ -375,20 +277,19 @@ void LaTeXFeatures::useLayout(docstring const & layoutname)
                return;
        }
 
-       TextClass const & tclass = params_.getTextClass();
+       DocumentClass const & tclass = params_.documentClass();
        if (tclass.hasLayout(layoutname)) {
                // Is this layout already in usedLayouts?
-               list<docstring>::const_iterator cit = usedLayouts_.begin();
-               list<docstring>::const_iterator end = usedLayouts_.end();
-               for (; cit != end; ++cit) {
-                       if (layoutname == *cit)
-                               return;
-               }
+               if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname) 
+                   != usedLayouts_.end())
+                       return;
 
-               LayoutPtr const & lyt = tclass[layoutname];
-               if (!lyt->depends_on().empty()) {
+               Layout const & layout = tclass[layoutname];
+               require(layout.requires());
+
+               if (!layout.depends_on().empty()) {
                        ++level;
-                       useLayout(lyt->depends_on());
+                       useLayout(layout.depends_on());
                        --level;
                }
                usedLayouts_.push_back(layoutname);
@@ -404,44 +305,46 @@ void LaTeXFeatures::useLayout(docstring const & layoutname)
 
 bool LaTeXFeatures::isRequired(string const & name) const
 {
-       return find(features_.begin(), features_.end(), name) != features_.end();
+       return features_.find(name) != features_.end();
 }
 
 
 bool LaTeXFeatures::mustProvide(string const & name) const
 {
-       return isRequired(name) && !params_.getTextClass().provides(name);
+       return isRequired(name) && !params_.documentClass().provides(name);
 }
 
 
 bool LaTeXFeatures::isAvailable(string const & name)
 {
-       string n = name;
        if (packages_.empty())
                getAvailable();
-       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();
+       string n = name;
+       if (suffixIs(n, ".sty"))
+               n.erase(name.length() - 4);
+       return packages_.find(n) != packages_.end();
 }
 
 
 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
 {
-       FeaturesList::const_iterator begin = preamble_snippets_.begin();
-       FeaturesList::const_iterator end   = preamble_snippets_.end();
+       SnippetList::const_iterator begin = preamble_snippets_.begin();
+       SnippetList::const_iterator end   = preamble_snippets_.end();
        if (find(begin, end, preamble) == end)
                preamble_snippets_.push_back(preamble);
 }
 
 
-void LaTeXFeatures::useFloat(string const & name)
+void LaTeXFeatures::useFloat(string const & name, bool subfloat)
 {
-       usedFloats_.insert(name);
+       if (!usedFloats_[name])
+               usedFloats_[name] = subfloat;
+       if (subfloat)
+               require("subfig");
        // 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_.getTextClass().floats().getType(name);
+       Floating const & fl = params_.documentClass().floats().getType(name);
        if (!fl.type().empty() && !fl.builtin()) {
                require("float");
        }
@@ -512,7 +415,7 @@ char const * simplefeatures[] = {
        "rotating",
        "latexsym",
        "pifont",
-       "subfigure",
+       "subfig",
        "varioref",
        "prettyref",
        /*For a successful cooperation of the `wrapfig' package with the
@@ -528,6 +431,7 @@ char const * simplefeatures[] = {
        "calc",
        "units",
        "tipa",
+       "tipx",
        "framed",
        "soul",
        "textcomp",
@@ -545,7 +449,9 @@ char const * simplefeatures[] = {
        "endnotes",
        "ifthen",
        "amsthm",
-       "listings"
+       "listings",
+       "bm",
+       "pdfpages"
 };
 
 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
@@ -556,7 +462,7 @@ int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 string const LaTeXFeatures::getPackages() const
 {
        ostringstream packages;
-       TextClass const & tclass = params_.getTextClass();
+       DocumentClass const & tclass = params_.documentClass();
 
        // FIXME: currently, we can only load packages and macros known
        // to LyX.
@@ -585,6 +491,9 @@ string const LaTeXFeatures::getPackages() const
            (mustProvide("esintoramsmath") &&
             params_.use_esint == BufferParams::package_off)) {
                packages << "\\usepackage{amsmath}\n";
+       } else if (mustProvide("amsbsy")) {
+               // amsbsy is already provided by amsmath
+               packages << "\\usepackage{amsbsy}\n";
        }
        
        // wasysym is a simple feature, but it must be after amsmath if both
@@ -612,9 +521,8 @@ string const LaTeXFeatures::getPackages() const
        }
 
        // pdfcolmk must be loaded after color
-       if (mustProvide("pdfcolmk")) {
+       if (mustProvide("pdfcolmk"))
                packages << "\\usepackage{pdfcolmk}\n";
-       }
 
        // makeidx.sty
        if (isRequired("makeidx")) {
@@ -648,13 +556,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")
@@ -670,24 +577,25 @@ string const LaTeXFeatures::getPackages() const
        // natbib.sty
        if (mustProvide("natbib")) {
                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"))
+               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";
@@ -713,8 +621,8 @@ string const LaTeXFeatures::getMacros() const
 
        if (!preamble_snippets_.empty())
                macros << '\n';
-       FeaturesList::const_iterator pit  = preamble_snippets_.begin();
-       FeaturesList::const_iterator pend = preamble_snippets_.end();
+       SnippetList::const_iterator pit  = preamble_snippets_.begin();
+       SnippetList::const_iterator pend = preamble_snippets_.end();
        for (; pit != pend; ++pit)
                macros << *pit << '\n';
 
@@ -751,14 +659,10 @@ string const LaTeXFeatures::getMacros() const
                macros << guillemotright_def << '\n';
 
        // Math mode
-       if (mustProvide("boldsymbol") && !isRequired("amsmath"))
-               macros << boldsymbol_def << '\n';
        if (mustProvide("binom") && !isRequired("amsmath"))
                macros << binom_def << '\n';
        if (mustProvide("mathcircumflex"))
                macros << mathcircumflex_def << '\n';
-       if (mustProvide("newlyxcommand"))
-               macros << newlyxcommand_def << '\n';
 
        // other
        if (mustProvide("ParagraphLeftIndent"))
@@ -829,7 +733,7 @@ string const LaTeXFeatures::getBabelOptions() const
 docstring const LaTeXFeatures::getTClassPreamble() const
 {
        // the text class specific preamble
-       TextClass const & tclass = params_.getTextClass();
+       DocumentClass const & tclass = params_.documentClass();
        odocstringstream tcpreamble;
 
        tcpreamble << tclass.preamble();
@@ -837,7 +741,7 @@ docstring const LaTeXFeatures::getTClassPreamble() const
        list<docstring>::const_iterator cit = usedLayouts_.begin();
        list<docstring>::const_iterator end = usedLayouts_.end();
        for (; cit != end; ++cit) {
-               tcpreamble << tclass[*cit]->preamble();
+               tcpreamble << tclass[*cit].preamble();
        }
 
        return tcpreamble.str();
@@ -875,7 +779,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()
@@ -904,7 +809,7 @@ BufferParams const & LaTeXFeatures::bufferParams() const
 
 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
 {
-       FloatList const & floats = params_.getTextClass().floats();
+       FloatList const & floats = params_.documentClass().floats();
 
        // Here we will output the code to create the needed float styles.
        // We will try to do this as minimal as possible.
@@ -915,7 +820,7 @@ void LaTeXFeatures::getFloatDefinitions(ostream & os) const
        UsedFloats::const_iterator end = usedFloats_.end();
        // ostringstream floats;
        for (; cit != end; ++cit) {
-               Floating const & fl = floats.getType((*cit));
+               Floating const & fl = floats.getType((cit->first));
 
                // For builtin floats we do nothing.
                if (fl.builtin()) continue;
@@ -960,6 +865,8 @@ void LaTeXFeatures::getFloatDefinitions(ostream & os) const
                        // used several times, when the same style is still in
                        // effect. (Lgb)
                }
+               if (cit->second)
+                       os << "\n\\newsubfloat{" << fl.type() << "}\n";
        }
 }