]> git.lyx.org Git - features.git/blobdiff - src/bufferparams.C
change "support/std_sstream.h" to <sstream>
[features.git] / src / bufferparams.C
index 02b6b677edc319ff20ced88d3e661e2c09770215..448edc75dc9ea4ae960fb3a706d767532134e414 100644 (file)
-/* This file is part of
- * ======================================================
+/**
+ * \file bufferparams.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Alfredo Braunstein
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ * \author André Pönitz
+ * \author Martin Vermeer
  *
- *          Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The LyX Team.
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
 
 #include <config.h>
 
 #include "bufferparams.h"
-#include "tex-strings.h"
-#include "encoding.h"
-#include "layout.h"
-#include "vspace.h"
+
+#include "author.h"
+#include "BranchList.h"
+#include "Bullet.h"
 #include "debug.h"
-#include "lyxrc.h"
+#include "encoding.h"
+#include "gettext.h"
 #include "language.h"
-#include "lyxtextclasslist.h"
+#include "LaTeXFeatures.h"
+#include "LColor.h"
 #include "lyxlex.h"
-#include "Lsstream.h"
-#include "author.h"
-#include "gettext.h"
+#include "lyxrc.h"
+#include "lyxtextclasslist.h"
+#include "outputparams.h"
+#include "tex-strings.h"
+#include "Spacing.h"
+#include "texrow.h"
+#include "vspace.h"
+
+#include "frontends/Alert.h"
 
 #include "support/lyxalgo.h" // for lyx::count
-#include "support/lyxlib.h"
-#include "support/lstrings.h"
-#include "support/types.h"
 
-#include "frontends/Alert.h"
+#include <boost/array.hpp>
 
-#include <cstdlib>
-#include <algorithm>
+#include <sstream>
 
-using namespace lyx::support;
+namespace support = lyx::support;
+using lyx::support::bformat;
+using lyx::support::rtrim;
+using lyx::support::tokenPos;
 
-using std::ostream;
 using std::endl;
+using std::string;
+using std::istringstream;
+using std::ostream;
+using std::ostringstream;
 using std::pair;
 
+namespace biblio = lyx::biblio;
+
+
+struct BufferParams::Impl
+{
+       Impl();
+
+       AuthorList authorlist;
+       BranchList branchlist;
+       boost::array<Bullet, 4> temp_bullets;
+       boost::array<Bullet, 4> user_defined_bullets;
+       Spacing spacing;
+       /** This is the amount of space used for paragraph_separation "skip",
+        * and for detached paragraphs in "indented" documents.
+        */
+       VSpace defskip;
+};
+
+
+BufferParams::Impl::Impl()
+       : defskip(VSpace::MEDSKIP)
+{
+       // set initial author
+       authorlist.record(Author(lyxrc.user_name, lyxrc.user_email));
+}
+
+
+BufferParams::Impl *
+BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
+{
+       return new BufferParams::Impl(*ptr);
+}
+
+
+void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
+{
+       delete ptr;
+}
+
 
 BufferParams::BufferParams()
-       // Initialize textclass to point to article. if `first' is
-       // true in the returned pair, then `second' is the textclass
-       // number; if it is false, second is 0. In both cases, second
-       // is what we want.
-       : textclass(textclasslist.NumberOfClass("article").second)
+       : // Initialize textclass to point to article. if `first' is
+         // true in the returned pair, then `second' is the textclass
+         // number; if it is false, second is 0. In both cases, second
+         // is what we want.
+       textclass(textclasslist.NumberOfClass("article").second),
+       pimpl_(new Impl)
 {
        paragraph_separation = PARSEP_INDENT;
-       defskip = VSpace(VSpace::MEDSKIP);
        quotes_language = InsetQuotes::EnglishQ;
        quotes_times = InsetQuotes::DoubleQ;
        fontsize = "default";
@@ -61,8 +115,8 @@ BufferParams::BufferParams()
        orientation = ORIENTATION_PORTRAIT;
        use_geometry = false;
        use_amsmath = AMS_AUTO;
-       use_natbib = false;
-       use_numerical_citations = false;
+       cite_engine = biblio::ENGINE_BASIC;
+       use_bibtopic = false;
        tracking_changes = false;
        secnumdepth = 3;
        tocdepth = 3;
@@ -75,12 +129,92 @@ BufferParams::BufferParams()
        pagestyle = "default";
        compressed = false;
        for (int iter = 0; iter < 4; ++iter) {
-               user_defined_bullets[iter] = ITEMIZE_DEFAULTS[iter];
-               temp_bullets[iter] = ITEMIZE_DEFAULTS[iter];
+               user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
+               temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
        }
 }
 
 
+BufferParams::~BufferParams()
+{}
+
+
+AuthorList & BufferParams::authors()
+{
+       return pimpl_->authorlist;
+}
+
+
+AuthorList const & BufferParams::authors() const
+{
+       return pimpl_->authorlist;
+}
+
+
+BranchList & BufferParams::branchlist()
+{
+       return pimpl_->branchlist;
+}
+
+
+BranchList const & BufferParams::branchlist() const
+{
+       return pimpl_->branchlist;
+}
+
+
+Bullet & BufferParams::temp_bullet(lyx::size_type index)
+{
+       BOOST_ASSERT(index < 4);
+       return pimpl_->temp_bullets[index];
+}
+
+
+Bullet const & BufferParams::temp_bullet(lyx::size_type index) const
+{
+       BOOST_ASSERT(index < 4);
+       return pimpl_->temp_bullets[index];
+}
+
+
+Bullet & BufferParams::user_defined_bullet(lyx::size_type index)
+{
+       BOOST_ASSERT(index < 4);
+       return pimpl_->user_defined_bullets[index];
+}
+
+
+Bullet const & BufferParams::user_defined_bullet(lyx::size_type index) const
+{
+       BOOST_ASSERT(index < 4);
+       return pimpl_->user_defined_bullets[index];
+}
+
+
+Spacing & BufferParams::spacing()
+{
+       return pimpl_->spacing;
+}
+
+
+Spacing const & BufferParams::spacing() const
+{
+       return pimpl_->spacing;
+}
+
+
+VSpace const & BufferParams::getDefSkip() const
+{
+       return pimpl_->defskip;
+}
+
+
+void BufferParams::setDefSkip(VSpace const & vs)
+{
+       pimpl_->defskip = vs;
+}
+
+
 string const BufferParams::readToken(LyXLex & lex, string const & token)
 {
        if (token == "\\textclass") {
@@ -123,7 +257,7 @@ string const BufferParams::readToken(LyXLex & lex, string const & token)
                        static_cast<PARSEP>(tmpret);
        } else if (token == "\\defskip") {
                lex.nextToken();
-               defskip = VSpace(lex.getString());
+               pimpl_->defskip = VSpace(lex.getString());
        } else if (token == "\\quotes_language") {
                // FIXME: should be params.readQuotes()
                int tmpret = lex.findToken(string_quotes_language);
@@ -183,21 +317,58 @@ string const BufferParams::readToken(LyXLex & lex, string const & token)
                lex.nextToken();
                use_amsmath = static_cast<AMS>(
                        lex.getInteger());
-       } else if (token == "\\use_natbib") {
+       } else if (token == "\\cite_engine") {
                lex.nextToken();
-               use_natbib = lex.getInteger();
-       } else if (token == "\\use_numerical_citations") {
+               string const engine = lex.getString();
+
+               cite_engine = biblio::ENGINE_BASIC;
+               if (engine == "natbib_numerical")
+                       cite_engine = biblio::ENGINE_NATBIB_NUMERICAL;
+               else if (engine == "natbib_authoryear")
+                       cite_engine = biblio::ENGINE_NATBIB_AUTHORYEAR;
+               else if (engine == "jurabib")
+                       cite_engine = biblio::ENGINE_JURABIB;
+
+       } else if (token == "\\use_bibtopic") {
                lex.nextToken();
-               use_numerical_citations = lex.getInteger();
+               use_bibtopic = lex.getInteger();
        } else if (token == "\\tracking_changes") {
                lex.nextToken();
                tracking_changes = lex.getInteger();
+       } else if (token == "\\branch") {
+               lex.nextToken();
+               string branch = lex.getString();
+               branchlist().add(branch);
+               while (true) {
+                       lex.nextToken();
+                       string const tok = lex.getString();
+                       if (tok == "\\end_branch")
+                               break;
+                       Branch * branch_ptr = branchlist().find(branch);
+                       if (tok == "\\selected") {
+                               lex.nextToken();
+                               if (branch_ptr)
+                                       branch_ptr->setSelected(lex.getInteger());
+                       }
+                       // not yet operational
+                       if (tok == "\\color") {
+                               lex.nextToken();
+                               string color = lex.getString();
+                               if (branch_ptr)
+                                       branch_ptr->setColor(color);
+                               // Update also the LColor table:
+                               if (color == "none")
+                                       color = lcolor.getX11Name(LColor::background);
+                               lcolor.setColor(branch, color);
+
+                       }
+               }
        } else if (token == "\\author") {
                lex.nextToken();
-               istringstream ss(STRCONV(lex.getString()));
+               istringstream ss(lex.getString());
                Author a;
                ss >> a;
-               author_map.push_back(authorlist.record(a));
+               author_map.push_back(pimpl_->authorlist.record(a));
        } else if (token == "\\paperorientation") {
                int tmpret = lex.findToken(string_orientation);
                if (tmpret == -1)
@@ -253,16 +424,16 @@ string const BufferParams::readToken(LyXLex & lex, string const & token)
                int const index = lex.getInteger();
                lex.nextToken();
                int temp_int = lex.getInteger();
-               user_defined_bullets[index].setFont(temp_int);
-               temp_bullets[index].setFont(temp_int);
+               user_defined_bullet(index).setFont(temp_int);
+               temp_bullet(index).setFont(temp_int);
                lex.nextToken();
                temp_int = lex.getInteger();
-               user_defined_bullets[index].setCharacter(temp_int);
-               temp_bullets[index].setCharacter(temp_int);
+               user_defined_bullet(index).setCharacter(temp_int);
+               temp_bullet(index).setCharacter(temp_int);
                lex.nextToken();
                temp_int = lex.getInteger();
-               user_defined_bullets[index].setSize(temp_int);
-               temp_bullets[index].setSize(temp_int);
+               user_defined_bullet(index).setSize(temp_int);
+               temp_bullet(index).setSize(temp_int);
                lex.nextToken();
                string const temp_str = lex.getString();
                if (temp_str != "\\end_bullet") {
@@ -292,8 +463,8 @@ string const BufferParams::readToken(LyXLex & lex, string const & token)
                        temp_str = lex.getString();
                }
 
-               user_defined_bullets[index].setText(sum_str);
-               temp_bullets[index].setText(sum_str);
+               user_defined_bullet(index).setText(sum_str);
+               temp_bullet(index).setText(sum_str);
        } else if (token == "\\secnumdepth") {
                lex.nextToken();
                secnumdepth = lex.getInteger();
@@ -324,7 +495,7 @@ string const BufferParams::readToken(LyXLex & lex, string const & token)
                if (first_par)
                        par->params().spacing(Spacing(tmp_space, tmp_val));
 #endif
-               spacing.set(tmp_space, tmp_val);
+               spacing().set(tmp_space, tmp_val);
        } else if (token == "\\float_placement") {
                lex.nextToken();
                float_placement = lex.getString();
@@ -370,16 +541,42 @@ void BufferParams::writeFile(ostream & os) const
        }
        os << "\\paperfontsize " << fontsize << '\n';
 
-       spacing.writeFile(os);
+       spacing().writeFile(os);
+
+       string cite_engine_str = "basic";
+       switch (cite_engine) {
+       case biblio::ENGINE_BASIC:
+               break;
+       case biblio::ENGINE_NATBIB_NUMERICAL:
+               cite_engine_str = "natbib_numerical";
+               break;
+       case biblio::ENGINE_NATBIB_AUTHORYEAR:
+               cite_engine_str = "natbib_authoryear";
+               break;
+       case biblio::ENGINE_JURABIB:
+               cite_engine_str = "jurabib";
+               break;
+       }
 
        os << "\\papersize " << string_papersize[papersize2]
           << "\n\\paperpackage " << string_paperpackages[paperpackage]
           << "\n\\use_geometry " << use_geometry
           << "\n\\use_amsmath " << use_amsmath
-          << "\n\\use_natbib " << use_natbib
-          << "\n\\use_numerical_citations " << use_numerical_citations
+          << "\n\\cite_engine " << cite_engine_str
+          << "\n\\use_bibtopic " << use_bibtopic
           << "\n\\paperorientation " << string_orientation[orientation]
           << '\n';
+
+       std::list<Branch>::const_iterator it = branchlist().begin();
+       std::list<Branch>::const_iterator end = branchlist().end();
+       for (; it != end; ++it) {
+               os << "\\branch " << it->getBranch()
+                  << "\n\\selected " << it->getSelected()
+                  << "\n\\color " << it->getColor()
+                  << "\n\\end_branch"
+                  << "\n";
+       }
+
        if (!paperwidth.empty())
                os << "\\paperwidth "
                   << VSpace(paperwidth).asLyXCommand() << '\n';
@@ -411,7 +608,7 @@ void BufferParams::writeFile(ostream & os) const
           << "\n\\tocdepth " << tocdepth
           << "\n\\paragraph_separation "
           << string_paragraph_separation[paragraph_separation]
-          << "\n\\defskip " << defskip.asLyXCommand()
+          << "\n\\defskip " << getDefSkip().asLyXCommand()
           << "\n\\quotes_language "
           << string_quotes_language[quotes_language] << '\n';
        switch (quotes_times) {
@@ -425,21 +622,21 @@ void BufferParams::writeFile(ostream & os) const
           << "\n\\papersides " << sides
           << "\n\\paperpagestyle " << pagestyle << '\n';
        for (int i = 0; i < 4; ++i) {
-               if (user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
-                       if (user_defined_bullets[i].getFont() != -1) {
+               if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
+                       if (user_defined_bullet(i).getFont() != -1) {
                                os << "\\bullet " << i
                                   << "\n\t"
-                                  << user_defined_bullets[i].getFont()
+                                  << user_defined_bullet(i).getFont()
                                   << "\n\t"
-                                  << user_defined_bullets[i].getCharacter()
+                                  << user_defined_bullet(i).getCharacter()
                                   << "\n\t"
-                                  << user_defined_bullets[i].getSize()
+                                  << user_defined_bullet(i).getSize()
                                   << "\n\\end_bullet\n";
                        }
                        else {
                                os << "\\bulletLaTeX " << i
                                   << "\n\t\""
-                                  << user_defined_bullets[i].getText()
+                                  << user_defined_bullet(i).getText()
                                   << "\"\n\\end_bullet\n";
                        }
                }
@@ -448,8 +645,8 @@ void BufferParams::writeFile(ostream & os) const
        os << "\\tracking_changes " << tracking_changes << "\n";
 
        if (tracking_changes) {
-               AuthorList::Authors::const_iterator it = authorlist.begin();
-               AuthorList::Authors::const_iterator end = authorlist.end();
+               AuthorList::Authors::const_iterator it = pimpl_->authorlist.begin();
+               AuthorList::Authors::const_iterator end = pimpl_->authorlist.end();
                for (; it != end; ++it) {
                        os << "\\author " << it->second << "\n";
                }
@@ -546,7 +743,7 @@ bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
                clsoptions << options << ',';
        }
 
-       string strOptions(STRCONV(clsoptions.str()));
+       string strOptions(clsoptions.str());
        if (!strOptions.empty()) {
                strOptions = rtrim(strOptions, ",");
                os << '[' << strOptions << ']';
@@ -724,7 +921,7 @@ bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
        }
 
        if (paragraph_separation) {
-               switch (defskip.kind()) {
+               switch (getDefSkip().kind()) {
                case VSpace::SMALLSKIP:
                        os << "\\setlength\\parskip{\\smallskipamount}\n";
                        break;
@@ -736,7 +933,7 @@ bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
                        break;
                case VSpace::LENGTH:
                        os << "\\setlength\\parskip{"
-                          << defskip.length().asLatexString()
+                          << getDefSkip().length().asLatexString()
                           << "}\n";
                        break;
                default: // should never happen // Then delete it.
@@ -749,6 +946,14 @@ bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
                texrow.newline();
        }
 
+       // If we use jurabib, we have to call babel here.
+       if (use_babel && features.isRequired("jurabib")) {
+               os << babelCall(language_options.str())
+                  << '\n'
+                  << features.getBabelOptions();
+               texrow.newline();
+       }
+
        // Now insert the LyX specific LaTeX commands...
 
        // The optional packages;
@@ -789,7 +994,7 @@ bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
        // at \begin{document} time -- JMarc
        string bullets_def;
        for (int i = 0; i < 4; ++i) {
-               if (user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
+               if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
                        if (bullets_def.empty())
                                bullets_def="\\AtBeginDocument{\n";
                        bullets_def += "  \\renewcommand{\\labelitemi";
@@ -808,7 +1013,7 @@ bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
                                break;
                        }
                        bullets_def += "}{" +
-                               user_defined_bullets[i].getText()
+                               user_defined_bullet(i).getText()
                                + "}\n";
                }
        }
@@ -818,14 +1023,9 @@ bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
 
        // We try to load babel late, in case it interferes
        // with other packages.
-       if (use_babel) {
-               string tmp = lyxrc.language_package;
-               if (!lyxrc.language_global_options
-                   && tmp == "\\usepackage{babel}")
-                       tmp = string("\\usepackage[") +
-                               STRCONV(language_options.str()) +
-                               "]{babel}";
-               lyxpreamble += tmp + "\n";
+       // Jurabib has to be called after babel, though.
+       if (use_babel && !features.isRequired("jurabib")) {
+               lyxpreamble += babelCall(language_options.str()) + '\n';
                lyxpreamble += features.getBabelOptions();
        }
 
@@ -1017,3 +1217,12 @@ string const BufferParams::dvips_options() const
                result += ' ' + lyxrc.print_landscape_flag;
        return result;
 }
+
+
+string const BufferParams::babelCall(string const & lang_opts) const
+{
+       string tmp = lyxrc.language_package;
+       if (!lyxrc.language_global_options && tmp == "\\usepackage{babel}")
+               tmp = string("\\usepackage[") + lang_opts + "]{babel}";
+       return tmp;
+}