]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.C
add GuiView parent to QToc for proper memory management.
[lyx.git] / src / LaTeXFeatures.C
index 4ddaee94e1b1a6e68c07b5fb20acb5c5325c262a..185ac193a44d0a70522283f61b45096ef48fc26d 100644 (file)
 #include "LaTeXFeatures.h"
 
 #include "bufferparams.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 "lyxrc.h"
 
+#include "support/docstream.h"
 #include "support/filetools.h"
 
-#include "support/std_sstream.h"
+#include "frontends/controllers/biblio.h"
 
-using lyx::support::IsSGMLFilename;
-using lyx::support::MakeRelPath;
-using lyx::support::OnlyPath;
+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;
 
+LaTeXFeatures::PackagesList LaTeXFeatures::packages_;
+
 
-LaTeXFeatures::LaTeXFeatures(BufferParams const & p)
-       : params(p)
+LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
+                            OutputParams const & r)
+       : buffer_(&b), params_(p), runparams_(r)
 {}
 
 
@@ -60,7 +70,41 @@ void LaTeXFeatures::require(string const & name)
        if (isRequired(name))
                return;
 
-       features.push_back(name);
+       features_.push_back(name);
+}
+
+
+void LaTeXFeatures::getAvailable()
+{
+       LyXLex lex(0, 0);
+       support::FileName const real_file = libFileSearch("", "packages.lst");
+
+       if (real_file.empty())
+               return;
+
+       lex.setFile(real_file);
+
+       if (!lex.isOK())
+               return;
+
+       // Make sure that we are clean
+       packages_.clear();
+
+       bool finished = false;
+       // Parse config-file
+       while (lex.isOK() && !finished) {
+               switch (lex.lex()) {
+               case LyXLex::LEX_FEOF:
+                       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);
+               }
+       }
 }
 
 
@@ -76,11 +120,11 @@ void LaTeXFeatures::useLayout(string const & layoutname)
                return;
        }
 
-       LyXTextClass const & tclass = params.getLyXTextClass();
+       LyXTextClass const & tclass = params_.getLyXTextClass();
        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<string>::const_iterator cit = usedLayouts_.begin();
+               list<string>::const_iterator end = usedLayouts_.end();
                for (; cit != end; ++cit) {
                        if (layoutname == *cit)
                                return;
@@ -92,7 +136,7 @@ void LaTeXFeatures::useLayout(string const & layoutname)
                        useLayout(lyt->depends_on());
                        --level;
                }
-               usedLayouts.push_back(layoutname);
+               usedLayouts_.push_back(layoutname);
        } else {
                lyxerr << "LaTeXFeatures::useLayout: layout `"
                       << layoutname << "' does not exist in this class"
@@ -105,26 +149,40 @@ void LaTeXFeatures::useLayout(string const & layoutname)
 
 bool LaTeXFeatures::isRequired(string const & name) const
 {
-       return find(features.begin(), features.end(), name) != features.end();
+       return find(features_.begin(), features_.end(), name) != features_.end();
+}
+
+
+bool LaTeXFeatures::mustProvide(string const & name) const
+{
+       return isRequired(name) && !params_.getLyXTextClass().provides(name);
+}
+
+
+bool LaTeXFeatures::isAvailable(string const & name)
+{
+       if (packages_.empty())
+               getAvailable();
+       return find(packages_.begin(), packages_.end(), name) != packages_.end();
 }
 
 
-void LaTeXFeatures::addExternalPreamble(string const & preamble)
+void LaTeXFeatures::addPreambleSnippet(string const & preamble)
 {
-       FeaturesList::const_iterator begin = preamble_snippets.begin();
-       FeaturesList::const_iterator end   = preamble_snippets.end();
+       FeaturesList::const_iterator begin = preamble_snippets_.begin();
+       FeaturesList::const_iterator end   = preamble_snippets_.end();
        if (find(begin, end, preamble) == end)
-               preamble_snippets.push_back(preamble);
+               preamble_snippets_.push_back(preamble);
 }
 
 
 void LaTeXFeatures::useFloat(string const & name)
 {
-       usedFloats.insert(name);
+       usedFloats_.insert(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_.getLyXTextClass().floats().getType(name);
        if (!fl.type().empty() && !fl.builtin()) {
                require("float");
        }
@@ -133,19 +191,19 @@ void LaTeXFeatures::useFloat(string const & name)
 
 void LaTeXFeatures::useLanguage(Language const * lang)
 {
-       UsedLanguages.insert(lang);
+       UsedLanguages_.insert(lang);
 }
 
 
-void LaTeXFeatures::includeFile(string const & key, string const & name)
+void LaTeXFeatures::includeFile(docstring const & key, string const & name)
 {
-       IncludedFiles[key] = name;
+       IncludedFiles_[key] = name;
 }
 
 
 bool LaTeXFeatures::hasLanguages() const
 {
-       return !UsedLanguages.empty();
+       return !UsedLanguages_.empty();
 }
 
 
@@ -154,23 +212,26 @@ string LaTeXFeatures::getLanguages() const
        ostringstream languages;
 
        for (LanguageList::const_iterator cit =
-                   UsedLanguages.begin();
-            cit != UsedLanguages.end();
+                   UsedLanguages_.begin();
+            cit != UsedLanguages_.end();
             ++cit)
                languages << (*cit)->babel() << ',';
-
-       return STRCONV(languages.str());
+       return languages.str();
 }
 
 
 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 {
        set<string> encodings;
-       for (LanguageList::const_iterator it =
-                    UsedLanguages.begin();
-            it != UsedLanguages.end(); ++it)
-               if ((*it)->encoding()->LatexName() != doc_encoding)
-                       encodings.insert((*it)->encoding()->LatexName());
+       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")
+                       encodings.insert((*it)->encoding()->latexName());
        return encodings;
 }
 
@@ -188,8 +249,14 @@ char const * simplefeatures[] = {
        "varioref",
        "prettyref",
        "float",
-       "wasy",
-       "dvipost"
+       "booktabs",
+       "dvipost",
+       "fancybox",
+       "calc",
+       "nicefrac",
+       "tipa",
+       "framed",
+       "textcomp",
 };
 
 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
@@ -200,14 +267,14 @@ int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 string const LaTeXFeatures::getPackages() const
 {
        ostringstream packages;
-       LyXTextClass const & tclass = params.getLyXTextClass();
+       LyXTextClass const & tclass = params_.getLyXTextClass();
 
        //
        //  These are all the 'simple' includes.  i.e
        //  packages which we just \usepackage{package}
        //
        for (int i = 0; i < nb_simplefeatures; ++i) {
-               if (isRequired(simplefeatures[i]))
+               if (mustProvide(simplefeatures[i]))
                        packages << "\\usepackage{"
                                 << simplefeatures[i] << "}\n";
        }
@@ -217,56 +284,67 @@ string const LaTeXFeatures::getPackages() const
        // than those above.
        //
 
-       if (isRequired("amsmath")
-           && !tclass.provides(LyXTextClass::amsmath)
-           && params.use_amsmath != BufferParams::AMS_OFF) {
+       if (mustProvide("amsmath")
+           && params_.use_amsmath != BufferParams::package_off) {
                packages << "\\usepackage{amsmath}\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
+       // leads to inconsistent integrals. We only load this package 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)
+               packages << "\\usepackage{wasysym}\n";
+
        // color.sty
-       if (isRequired("color")) {
-               if (params.graphicsDriver == "default")
-                       packages << "\\usepackage[usenames]{color}\n";
+       if (mustProvide("color")) {
+               if (params_.graphicsDriver == "default")
+                       packages << "\\usepackage{color}\n";
                else
                        packages << "\\usepackage["
-                                << params.graphicsDriver
-                                << ",usenames"
+                                << params_.graphicsDriver
                                 << "]{color}\n";
        }
 
        // makeidx.sty
        if (isRequired("makeidx")) {
-               if (! tclass.provides(LyXTextClass::makeidx))
+               if (!tclass.provides("makeidx"))
                        packages << "\\usepackage{makeidx}\n";
                packages << "\\makeindex\n";
        }
 
        // graphicx.sty
-       if (isRequired("graphicx") && params.graphicsDriver != "none") {
-               if (params.graphicsDriver == "default")
+       if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
+               if (params_.graphicsDriver == "default")
                        packages << "\\usepackage{graphicx}\n";
                else
                        packages << "\\usepackage["
-                                << params.graphicsDriver
+                                << params_.graphicsDriver
                                 << "]{graphicx}\n";
        }
-
-       //if (algorithm) {
-       //      packages << "\\usepackage{algorithm}\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";
+       }
 
        // lyxskak.sty --- newer chess support based on skak.sty
-       if (isRequired("chess")) {
+       if (mustProvide("chess")) {
                packages << "\\usepackage[ps,mover]{lyxskak}\n";
        }
 
        // setspace.sty
-       if ((params.spacing().getSpace() != Spacing::Single
-            && !params.spacing().isDefault())
+       if ((params_.spacing().getSpace() != Spacing::Single
+            && !params_.spacing().isDefault())
            || isRequired("setspace")) {
                packages << "\\usepackage{setspace}\n";
        }
-       switch (params.spacing().getSpace()) {
+       switch (params_.spacing().getSpace()) {
        case Spacing::Default:
        case Spacing::Single:
                // we dont use setspace.sty so dont print anything
@@ -280,23 +358,30 @@ string const LaTeXFeatures::getPackages() const
                break;
        case Spacing::Other:
                packages << "\\setstretch{"
-                        << params.spacing().getValue() << "}\n";
+                        << params_.spacing().getValue() << "}\n";
                break;
        }
 
        // amssymb.sty
-       if (isRequired("amssymb") || params.use_amsmath == BufferParams::AMS_ON)
+       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)
+               packages << "\\usepackage{esint}\n";
+
        // url.sty
-       if (isRequired("url") && ! tclass.provides(LyXTextClass::url))
+       if (mustProvide("url"))
                packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
                            "                      {\\newcommand{\\url}{\\texttt}}\n";
 
-       // float.sty
        // natbib.sty
-       if (isRequired("natbib") && ! tclass.provides(LyXTextClass::natbib)) {
+       if (mustProvide("natbib")) {
                packages << "\\usepackage[";
-               if (params.use_numerical_citations) {
+               if (params_.getEngine() == biblio::ENGINE_NATBIB_NUMERICAL) {
                        packages << "numbers";
                } else {
                        packages << "authoryear";
@@ -304,7 +389,26 @@ string const LaTeXFeatures::getPackages() const
                packages << "]{natbib}\n";
        }
 
-       return STRCONV(packages.str());
+       // jurabib -- we need version 0.6 at least.
+       if (mustProvide("jurabib")) {
+               packages << "\\usepackage{jurabib}[2004/01/25]\n";
+       }
+
+       // bibtopic -- the dot provides the aux file naming which
+       // LyX can detect.
+       if (mustProvide("bibtopic")) {
+               packages << "\\usepackage[dot]{bibtopic}\n";
+       }
+
+       if (mustProvide("xy"))
+               packages << "\\usepackage[all]{xy}\n";
+
+       if (mustProvide("nomencl")) {
+               packages << "\\usepackage{nomencl}[2005/09/22]\n"
+                        << "\\makenomenclature\n";
+       }
+       return packages.str();
 }
 
 
@@ -312,68 +416,69 @@ string const LaTeXFeatures::getMacros() const
 {
        ostringstream macros;
 
-       if (!preamble_snippets.empty())
+       if (!preamble_snippets_.empty())
                macros << '\n';
-       FeaturesList::const_iterator pit  = preamble_snippets.begin();
-       FeaturesList::const_iterator pend = preamble_snippets.end();
+       FeaturesList::const_iterator pit  = preamble_snippets_.begin();
+       FeaturesList::const_iterator pend = preamble_snippets_.end();
        for (; pit != pend; ++pit) {
                macros << *pit << '\n';
        }
 
-       if (isRequired("LyX"))
+       if (mustProvide("LyX"))
                macros << lyx_def << '\n';
 
-       if (isRequired("lyxline"))
+       if (mustProvide("lyxline"))
                macros << lyxline_def << '\n';
 
-       if (isRequired("noun"))
+       if (mustProvide("noun"))
                macros << noun_def << '\n';
 
-       if (isRequired("lyxarrow"))
+       if (mustProvide("lyxarrow"))
                macros << lyxarrow_def << '\n';
 
        // quotes.
-       if (isRequired("quotesinglbase"))
+       if (mustProvide("quotesinglbase"))
                macros << quotesinglbase_def << '\n';
-       if (isRequired("quotedblbase"))
+       if (mustProvide("quotedblbase"))
                macros << quotedblbase_def << '\n';
-       if (isRequired("guilsinglleft"))
+       if (mustProvide("guilsinglleft"))
                macros << guilsinglleft_def << '\n';
-       if (isRequired("guilsinglright"))
+       if (mustProvide("guilsinglright"))
                macros << guilsinglright_def << '\n';
-       if (isRequired("guillemotleft"))
+       if (mustProvide("guillemotleft"))
                macros << guillemotleft_def << '\n';
-       if (isRequired("guillemotright"))
+       if (mustProvide("guillemotright"))
                macros << guillemotright_def << '\n';
 
        // Math mode
-       if (isRequired("boldsymbol") && !isRequired("amsmath"))
+       if (mustProvide("boldsymbol") && !isRequired("amsmath"))
                macros << boldsymbol_def << '\n';
-       if (isRequired("binom") && !isRequired("amsmath"))
+       if (mustProvide("binom") && !isRequired("amsmath"))
                macros << binom_def << '\n';
-       if (isRequired("mathcircumflex"))
+       if (mustProvide("mathcircumflex"))
                macros << mathcircumflex_def << '\n';
 
        // other
-       if (isRequired("NeedLyXMinipageIndent"))
-               macros << minipageindent_def;
-       if (isRequired("ParagraphLeftIndent"))
+       if (mustProvide("ParagraphLeftIndent"))
                macros << paragraphleftindent_def;
-       if (isRequired("NeedLyXFootnoteCode"))
+       if (mustProvide("NeedLyXFootnoteCode"))
                macros << floatingfootnote_def;
 
        // some problems with tex->html converters
-       if (isRequired("NeedTabularnewline"))
+       if (mustProvide("NeedTabularnewline"))
                macros << tabularnewline_def;
 
        // greyedout environment (note inset)
-       if (isRequired("lyxgreyedout"))
+       if (mustProvide("lyxgreyedout"))
                macros << lyxgreyedout_def;
 
+       if (mustProvide("lyxdot"))
+               macros << lyxdot_def << '\n';
+
        // floats
        getFloatDefinitions(macros);
 
-       return STRCONV(macros.str());
+       return macros.str();
 }
 
 
@@ -381,61 +486,71 @@ string const LaTeXFeatures::getBabelOptions() const
 {
        ostringstream tmp;
 
-       for (LanguageList::const_iterator cit = UsedLanguages.begin();
-            cit != UsedLanguages.end(); ++cit)
-               if (!(*cit)->latex_options().empty())
-                       tmp << (*cit)->latex_options() << '\n';
-       if (!params.language->latex_options().empty())
-               tmp << params.language->latex_options() << '\n';
+       LanguageList::const_iterator it  = UsedLanguages_.begin();
+       LanguageList::const_iterator end =  UsedLanguages_.end();
+       for (; it != end; ++it)
+               if (!(*it)->latex_options().empty())
+                       tmp << (*it)->latex_options() << '\n';
+       if (!params_.language->latex_options().empty())
+               tmp << params_.language->latex_options() << '\n';
 
-       return STRCONV(tmp.str());
+       return tmp.str();
 }
 
 
-string const LaTeXFeatures::getTClassPreamble() const
+docstring const LaTeXFeatures::getTClassPreamble() const
 {
        // the text class specific preamble
-       LyXTextClass const & tclass = params.getLyXTextClass();
-       ostringstream tcpreamble;
+       LyXTextClass const & tclass = params_.getLyXTextClass();
+       odocstringstream tcpreamble;
 
        tcpreamble << tclass.preamble();
 
-       list<string>::const_iterator cit = usedLayouts.begin();
-       list<string>::const_iterator end = usedLayouts.end();
+       list<string>::const_iterator cit = usedLayouts_.begin();
+       list<string>::const_iterator end = usedLayouts_.end();
        for (; cit != end; ++cit) {
                tcpreamble << tclass[*cit]->preamble();
        }
 
-       return STRCONV(tcpreamble.str());
+       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();
 }
 
 
-string const LaTeXFeatures::getLyXSGMLEntities() const
+docstring const LaTeXFeatures::getLyXSGMLEntities() const
 {
        // Definition of entities used in the document that are LyX related.
-       ostringstream entities;
+       odocstringstream entities;
 
-       if (isRequired("lyxarrow")) {
+       if (mustProvide("lyxarrow")) {
                entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
        }
 
-       return STRCONV(entities.str());
+       return entities.str();
 }
 
 
-string const LaTeXFeatures::getIncludedFiles(string const & fname) const
+docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
 {
-       ostringstream sgmlpreamble;
-       string const basename = OnlyPath(fname);
+       odocstringstream sgmlpreamble;
+       // FIXME UNICODE
+       docstring const basename(from_utf8(onlyPath(fname)));
 
-       FileMap::const_iterator end = IncludedFiles.end();
-       for (FileMap::const_iterator fi = IncludedFiles.begin();
+       FileMap::const_iterator end = IncludedFiles_.end();
+       for (FileMap::const_iterator fi = IncludedFiles_.begin();
             fi != end; ++fi)
+               // FIXME UNICODE
                sgmlpreamble << "\n<!ENTITY " << fi->first
-                            << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
-                            << MakeRelPath(fi->second, basename) << "\">";
+                            << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
+                            << makeRelPath(from_utf8(fi->second), basename) << "\">";
 
-       return STRCONV(sgmlpreamble.str());
+       return sgmlpreamble.str();
 }
 
 
@@ -443,28 +558,40 @@ void LaTeXFeatures::showStruct() const {
        lyxerr << "LyX needs the following commands when LaTeXing:"
               << "\n***** Packages:" << getPackages()
               << "\n***** Macros:" << getMacros()
-              << "\n***** Textclass stuff:" << getTClassPreamble()
+              << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
               << "\n***** done." << endl;
 }
 
 
+Buffer const & LaTeXFeatures::buffer() const
+{
+       return *buffer_;
+}
+
+
+void LaTeXFeatures::setBuffer(Buffer const & buffer)
+{
+       buffer_ = &buffer;
+}
+
+
 BufferParams const & LaTeXFeatures::bufferParams() const
 {
-       return params;
+       return params_;
 }
 
 
 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
 {
-       FloatList const & floats = params.getLyXTextClass().floats();
+       FloatList const & floats = params_.getLyXTextClass().floats();
 
        // Here we will output the code to create the needed float styles.
        // We will try to do this as minimal as possible.
        // \floatstyle{ruled}
        // \newfloat{algorithm}{htbp}{loa}
        // \floatname{algorithm}{Algorithm}
-       UsedFloats::const_iterator cit = usedFloats.begin();
-       UsedFloats::const_iterator end = usedFloats.end();
+       UsedFloats::const_iterator cit = usedFloats_.begin();
+       UsedFloats::const_iterator end = usedFloats_.end();
        // ostringstream floats;
        for (; cit != end; ++cit) {
                Floating const & fl = floats.getType((*cit));
@@ -514,3 +641,6 @@ void LaTeXFeatures::getFloatDefinitions(ostream & os) const
                }
        }
 }
+
+
+} // namespace lyx