]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.C
avoid to update when navigating
[lyx.git] / src / LaTeXFeatures.C
index 6bc5141f2ab36c8ada838c78a946bd30da5afec6..9cbbc3288c564c9e76c60aa34443f15740d92782 100644 (file)
@@ -1,52 +1,66 @@
-/* This file is part of
- * ======================================================
+/**
+ * \file LaTeXFeatures.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author José Matos
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author Jürgen Vigna
+ * \author André Pönitz
  *
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 the LyX Team.
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "LaTeXFeatures.h"
-#include "debug.h"
-#include "lyx_sty.h"
-#include "lyxrc.h"
+
 #include "bufferparams.h"
+#include "debug.h"
+#include "encoding.h"
+#include "Floating.h"
 #include "FloatList.h"
 #include "language.h"
-#include "encoding.h"
-#include "LString.h"
+#include "lyx_sty.h"
+#include "lyxrc.h"
 
 #include "support/filetools.h"
-#include "support/lstrings.h"
 
-using lyx::textclass_type;
+#include "support/std_sstream.h"
+
+using lyx::support::IsSGMLFilename;
+using lyx::support::MakeRelPath;
+using lyx::support::OnlyPath;
 
 using std::endl;
-using std::list;
-using std::set;
 using std::find;
+using std::string;
+using std::list;
 using std::ostream;
+using std::ostringstream;
+using std::set;
 
 
-LaTeXFeatures::LaTeXFeatures(BufferParams const & p)
-       : params(p)
+LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p, bool n)
+       : buffer_(&b), params_(p), nice_(n)
 {}
 
 
+bool LaTeXFeatures::useBabel() const
+{
+       return lyxrc.language_use_babel ||
+               bufferParams().language->lang() != lyxrc.default_language ||
+               this->hasLanguages();
+}
+
+
 void LaTeXFeatures::require(string const & name)
 {
        if (isRequired(name))
                return;
 
-       features.push_back(name);
+       features_.push_back(name);
 }
 
 
@@ -61,56 +75,56 @@ void LaTeXFeatures::useLayout(string const & layoutname)
                       << layoutname << endl;
                return;
        }
-       
-       LyXTextClass 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;
                }
-               
-               LyXLayout_ptr lyt = tclass[layoutname];
+
+               LyXLayout_ptr const & lyt = tclass[layoutname];
                if (!lyt->depends_on().empty()) {
                        ++level;
                        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"
-                      << endl; 
+                      << endl;
        }
-       
+
        --level;
 }
 
 
 bool LaTeXFeatures::isRequired(string const & name) const
 {
-       FeaturesList::const_iterator i = find(features.begin(),
-                                             features.end(),
-                                             name);
-       return i != features.end();
+       return find(features_.begin(), features_.end(), name) != features_.end();
 }
 
 
-void LaTeXFeatures::addExternalPreamble(string const & pream)
+void LaTeXFeatures::addExternalPreamble(string const & preamble)
 {
-       externalPreambles += pream;
+       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);
 }
 
 
 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");
        }
@@ -119,19 +133,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)
 {
-       IncludedFiles[key] = name;
+       IncludedFiles_[key] = name;
 }
 
 
-bool LaTeXFeatures::hasLanguages()
+bool LaTeXFeatures::hasLanguages() const
 {
-       return !UsedLanguages.empty();
+       return !UsedLanguages_.empty();
 }
 
 
@@ -140,21 +154,21 @@ 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 languages.str().c_str();
+       return languages.str();
 }
 
 
-set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding)
+set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 {
        set<string> encodings;
-       for (LanguageList::const_iterator it =
-                    UsedLanguages.begin();
-            it != UsedLanguages.end(); ++it)
+       LanguageList::const_iterator it  = UsedLanguages_.begin();
+       LanguageList::const_iterator end = UsedLanguages_.end();
+       for (; it != end; ++it)
                if ((*it)->encoding()->LatexName() != doc_encoding)
                        encodings.insert((*it)->encoding()->LatexName());
        return encodings;
@@ -174,18 +188,22 @@ char const * simplefeatures[] = {
        "varioref",
        "prettyref",
        "float",
-       "wasy"
+       "wasy",
+       "dvipost",
+       "fancybox",
+       "calc",
+       "jurabib"
 };
 
-const int nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
+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
@@ -194,7 +212,7 @@ string const LaTeXFeatures::getPackages() const
        for (int i = 0; i < nb_simplefeatures; ++i) {
                if (isRequired(simplefeatures[i]))
                        packages << "\\usepackage{"
-                                << simplefeatures[i] << "}\n";
+                                << simplefeatures[i] << "}\n";
        }
 
        //
@@ -203,17 +221,19 @@ string const LaTeXFeatures::getPackages() const
        //
 
        if (isRequired("amsmath")
-           && ! tclass.provides(LyXTextClass::amsmath)) {
+           && !tclass.provides(LyXTextClass::amsmath)
+           && params_.use_amsmath != BufferParams::AMS_OFF) {
                packages << "\\usepackage{amsmath}\n";
        }
 
        // color.sty
        if (isRequired("color")) {
-               if (params.graphicsDriver == "default")
-                       packages << "\\usepackage{color}\n";
+               if (params_.graphicsDriver == "default")
+                       packages << "\\usepackage[usenames]{color}\n";
                else
                        packages << "\\usepackage["
-                                << params.graphicsDriver
+                                << params_.graphicsDriver
+                                << ",usenames"
                                 << "]{color}\n";
        }
 
@@ -225,12 +245,12 @@ string const LaTeXFeatures::getPackages() const
        }
 
        // graphicx.sty
-       if (isRequired("graphicx") && params.graphicsDriver != "none") {
-               if (params.graphicsDriver == "default")
+       if (isRequired("graphicx") && params_.graphicsDriver != "none") {
+               if (params_.graphicsDriver == "default")
                        packages << "\\usepackage{graphicx}\n";
                else
                        packages << "\\usepackage["
-                                << params.graphicsDriver
+                                << params_.graphicsDriver
                                 << "]{graphicx}\n";
        }
 
@@ -244,12 +264,12 @@ string const LaTeXFeatures::getPackages() const
        }
 
        // 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
@@ -263,12 +283,12 @@ 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)
+       if (isRequired("amssymb") || params_.use_amsmath == BufferParams::AMS_ON)
                packages << "\\usepackage{amssymb}\n";
        // url.sty
        if (isRequired("url") && ! tclass.provides(LyXTextClass::url))
@@ -279,7 +299,7 @@ string const LaTeXFeatures::getPackages() const
        // natbib.sty
        if (isRequired("natbib") && ! tclass.provides(LyXTextClass::natbib)) {
                packages << "\\usepackage[";
-               if (params.use_numerical_citations) {
+               if (params_.cite_engine == biblio::ENGINE_NATBIB_NUMERICAL) {
                        packages << "numbers";
                } else {
                        packages << "authoryear";
@@ -287,9 +307,13 @@ string const LaTeXFeatures::getPackages() const
                packages << "]{natbib}\n";
        }
 
-       packages << externalPreambles;
+       // bibtopic -- the dot provides the aux file naming which
+       // LyX can detect.
+       if (isRequired("bibtopic")) {
+               packages << "\\usepackage[dot]{bibtopic}\n";
+       }
 
-       return packages.str().c_str();
+       return packages.str();
 }
 
 
@@ -297,6 +321,14 @@ string const LaTeXFeatures::getMacros() const
 {
        ostringstream macros;
 
+       if (!preamble_snippets_.empty())
+               macros << '\n';
+       FeaturesList::const_iterator pit  = preamble_snippets_.begin();
+       FeaturesList::const_iterator pend = preamble_snippets_.end();
+       for (; pit != pend; ++pit) {
+               macros << *pit << '\n';
+       }
+
        if (isRequired("LyX"))
                macros << lyx_def << '\n';
 
@@ -332,8 +364,6 @@ string const LaTeXFeatures::getMacros() const
                macros << mathcircumflex_def << '\n';
 
        // other
-       if (isRequired("NeedLyXMinipageIndent"))
-               macros << minipageindent_def;
        if (isRequired("ParagraphLeftIndent"))
                macros << paragraphleftindent_def;
        if (isRequired("NeedLyXFootnoteCode"))
@@ -343,10 +373,17 @@ string const LaTeXFeatures::getMacros() const
        if (isRequired("NeedTabularnewline"))
                macros << tabularnewline_def;
 
+       // greyedout environment (note inset)
+       if (isRequired("lyxgreyedout"))
+               macros << lyxgreyedout_def;
+
+       if (isRequired("lyxdot"))
+               macros << lyxdot_def << '\n';
+
        // floats
        getFloatDefinitions(macros);
 
-       return macros.str().c_str();
+       return macros.str();
 }
 
 
@@ -354,32 +391,40 @@ 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 tmp.str().c_str();
+       return tmp.str();
 }
 
 
 string const LaTeXFeatures::getTClassPreamble() const
 {
        // the text class specific preamble
-       LyXTextClass const & tclass = params.getLyXTextClass();
+       LyXTextClass const & tclass = params_.getLyXTextClass();
        ostringstream 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 tcpreamble.str().c_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();
 }
 
 
@@ -392,7 +437,7 @@ string const LaTeXFeatures::getLyXSGMLEntities() const
                entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
        }
 
-       return entities.str().c_str();
+       return entities.str();
 }
 
 
@@ -401,14 +446,14 @@ string const LaTeXFeatures::getIncludedFiles(string const & fname) const
        ostringstream sgmlpreamble;
        string const basename = 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)
                sgmlpreamble << "\n<!ENTITY " << fi->first
                             << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
                             << MakeRelPath(fi->second, basename) << "\">";
 
-       return sgmlpreamble.str().c_str();
+       return sgmlpreamble.str();
 }
 
 
@@ -421,23 +466,35 @@ void LaTeXFeatures::showStruct() const {
 }
 
 
+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));
@@ -473,10 +530,10 @@ void LaTeXFeatures::getFloatDefinitions(ostream & os) const
                        string const name = fl.name();
                        os << "\\floatstyle{" << style << "}\n"
                           << "\\newfloat{" << type << "}{" << placement
-                          << "}{" << ext << "}";
+                          << "}{" << ext << '}';
                        if (!within.empty())
-                               os << "[" << within << "]";
-                       os << "\n"
+                               os << '[' << within << ']';
+                       os << '\n'
                           << "\\floatname{" << type << "}{"
                           << name << "}\n";