-/* 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 "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 <cstdlib>
+#include <boost/array.hpp>
+
+#include "support/std_sstream.h"
+
+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;
+
+
+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;
+}
-#ifdef WITH_WARNINGS
-#warning Do we need this horrible thing? (JMarc)
-#endif
-bool use_babel;
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";
paperpackage = PACKAGE_NONE;
orientation = ORIENTATION_PORTRAIT;
use_geometry = false;
- use_amsmath = false;
+ use_amsmath = AMS_AUTO;
use_natbib = false;
use_numerical_citations = false;
tracking_changes = false;
sides = LyXTextClass::OneSide;
columns = 1;
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") {
+ lex.eatLine();
+ string const classname = lex.getString();
+ pair<bool, lyx::textclass_type> pp =
+ textclasslist.NumberOfClass(classname);
+ if (pp.first) {
+ textclass = pp.second;
+ } else {
+ textclass = 0;
+ return classname;
+ }
+ if (!getLyXTextClass().isTeXClassAvailable()) {
+ string msg = bformat(_("The document uses a missing "
+ "TeX class \"%1$s\".\n"), classname);
+ Alert::warning(_("Document class not available"),
+ msg + _("LyX will not be able to produce output."));
+ }
+ } else if (token == "\\begin_preamble") {
+ readPreamble(lex);
+ } else if (token == "\\options") {
+ lex.eatLine();
+ options = lex.getString();
+ } else if (token == "\\language") {
+ readLanguage(lex);
+ } else if (token == "\\inputencoding") {
+ lex.eatLine();
+ inputenc = lex.getString();
+ } else if (token == "\\graphics") {
+ readGraphicsDriver(lex);
+ } else if (token == "\\fontscheme") {
+ lex.eatLine();
+ fonts = lex.getString();
+ } else if (token == "\\paragraph_separation") {
+ int tmpret = lex.findToken(string_paragraph_separation);
+ if (tmpret == -1)
+ ++tmpret;
+ paragraph_separation =
+ static_cast<PARSEP>(tmpret);
+ } else if (token == "\\defskip") {
+ lex.nextToken();
+ pimpl_->defskip = VSpace(lex.getString());
+ } else if (token == "\\quotes_language") {
+ // FIXME: should be params.readQuotes()
+ int tmpret = lex.findToken(string_quotes_language);
+ if (tmpret == -1)
+ ++tmpret;
+ InsetQuotes::quote_language tmpl =
+ InsetQuotes::EnglishQ;
+ switch (tmpret) {
+ case 0:
+ tmpl = InsetQuotes::EnglishQ;
+ break;
+ case 1:
+ tmpl = InsetQuotes::SwedishQ;
+ break;
+ case 2:
+ tmpl = InsetQuotes::GermanQ;
+ break;
+ case 3:
+ tmpl = InsetQuotes::PolishQ;
+ break;
+ case 4:
+ tmpl = InsetQuotes::FrenchQ;
+ break;
+ case 5:
+ tmpl = InsetQuotes::DanishQ;
+ break;
+ }
+ quotes_language = tmpl;
+ } else if (token == "\\quotes_times") {
+ // FIXME: should be params.readQuotes()
+ lex.nextToken();
+ switch (lex.getInteger()) {
+ case 1:
+ quotes_times = InsetQuotes::SingleQ;
+ break;
+ case 2:
+ quotes_times = InsetQuotes::DoubleQ;
+ break;
+ }
+ } else if (token == "\\papersize") {
+ int tmpret = lex.findToken(string_papersize);
+ if (tmpret == -1)
+ ++tmpret;
+ else
+ papersize2 = VMARGIN_PAPER_TYPE(tmpret);
+ } else if (token == "\\paperpackage") {
+ int tmpret = lex.findToken(string_paperpackages);
+ if (tmpret == -1) {
+ ++tmpret;
+ paperpackage = PACKAGE_NONE;
+ } else
+ paperpackage = PAPER_PACKAGES(tmpret);
+ } else if (token == "\\use_geometry") {
+ lex.nextToken();
+ use_geometry = lex.getInteger();
+ } else if (token == "\\use_amsmath") {
+ lex.nextToken();
+ use_amsmath = static_cast<AMS>(
+ lex.getInteger());
+ } else if (token == "\\use_natbib") {
+ lex.nextToken();
+ use_natbib = lex.getInteger();
+ } else if (token == "\\use_numerical_citations") {
+ lex.nextToken();
+ use_numerical_citations = 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(lcolor.getFromLyXName(branch), color);
+ }
+ }
+ } else if (token == "\\author") {
+ lex.nextToken();
+ istringstream ss(lex.getString());
+ Author a;
+ ss >> a;
+ author_map.push_back(pimpl_->authorlist.record(a));
+ } else if (token == "\\paperorientation") {
+ int tmpret = lex.findToken(string_orientation);
+ if (tmpret == -1)
+ ++tmpret;
+ orientation =
+ static_cast<PAPER_ORIENTATION>(tmpret);
+ } else if (token == "\\paperwidth") {
+ lex.next();
+ paperwidth = lex.getString();
+ } else if (token == "\\paperheight") {
+ lex.next();
+ paperheight = lex.getString();
+ } else if (token == "\\leftmargin") {
+ lex.next();
+ leftmargin = lex.getString();
+ } else if (token == "\\topmargin") {
+ lex.next();
+ topmargin = lex.getString();
+ } else if (token == "\\rightmargin") {
+ lex.next();
+ rightmargin = lex.getString();
+ } else if (token == "\\bottommargin") {
+ lex.next();
+ bottommargin = lex.getString();
+ } else if (token == "\\headheight") {
+ lex.next();
+ headheight = lex.getString();
+ } else if (token == "\\headsep") {
+ lex.next();
+ headsep = lex.getString();
+ } else if (token == "\\footskip") {
+ lex.next();
+ footskip = lex.getString();
+ } else if (token == "\\paperfontsize") {
+ lex.nextToken();
+ fontsize = rtrim(lex.getString());
+ } else if (token == "\\papercolumns") {
+ lex.nextToken();
+ columns = lex.getInteger();
+ } else if (token == "\\papersides") {
+ lex.nextToken();
+ switch (lex.getInteger()) {
+ default:
+ case 1: sides = LyXTextClass::OneSide; break;
+ case 2: sides = LyXTextClass::TwoSides; break;
+ }
+ } else if (token == "\\paperpagestyle") {
+ lex.nextToken();
+ pagestyle = rtrim(lex.getString());
+ } else if (token == "\\bullet") {
+ // FIXME: should be params.readBullets()
+ lex.nextToken();
+ int const index = lex.getInteger();
+ lex.nextToken();
+ int temp_int = lex.getInteger();
+ user_defined_bullet(index).setFont(temp_int);
+ temp_bullet(index).setFont(temp_int);
+ lex.nextToken();
+ temp_int = lex.getInteger();
+ user_defined_bullet(index).setCharacter(temp_int);
+ temp_bullet(index).setCharacter(temp_int);
+ lex.nextToken();
+ temp_int = lex.getInteger();
+ 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") {
+ // this element isn't really necessary for
+ // parsing but is easier for humans
+ // to understand bullets. Put it back and
+ // set a debug message?
+ lex.printError("\\end_bullet expected, got" + temp_str);
+ //how can I put it back?
+ }
+ } else if (token == "\\bulletLaTeX") {
+ // The bullet class should be able to read this.
+ lex.nextToken();
+ int const index = lex.getInteger();
+ lex.next();
+ string temp_str = lex.getString();
+ string sum_str;
+ while (temp_str != "\\end_bullet") {
+ // this loop structure is needed when user
+ // enters an empty string since the first
+ // thing returned will be the \\end_bullet
+ // OR
+ // if the LaTeX entry has spaces. Each element
+ // therefore needs to be read in turn
+ sum_str += temp_str;
+ lex.next();
+ temp_str = lex.getString();
+ }
+
+ user_defined_bullet(index).setText(sum_str);
+ temp_bullet(index).setText(sum_str);
+ } else if (token == "\\secnumdepth") {
+ lex.nextToken();
+ secnumdepth = lex.getInteger();
+ } else if (token == "\\tocdepth") {
+ lex.nextToken();
+ tocdepth = lex.getInteger();
+ } else if (token == "\\spacing") {
+ lex.next();
+ string const tmp = rtrim(lex.getString());
+ Spacing::Space tmp_space = Spacing::Default;
+ float tmp_val = 0.0;
+ if (tmp == "single") {
+ tmp_space = Spacing::Single;
+ } else if (tmp == "onehalf") {
+ tmp_space = Spacing::Onehalf;
+ } else if (tmp == "double") {
+ tmp_space = Spacing::Double;
+ } else if (tmp == "other") {
+ lex.next();
+ tmp_space = Spacing::Other;
+ tmp_val = lex.getFloat();
+ } else {
+ lex.printError("Unknown spacing token: '$$Token'");
+ }
+#if 0 // FIXME: Handled in lyx2lyx ?
+ // Small hack so that files written with klyx will be
+ // parsed correctly.
+ if (first_par)
+ par->params().spacing(Spacing(tmp_space, tmp_val));
+#endif
+ spacing().set(tmp_space, tmp_val);
+ } else if (token == "\\float_placement") {
+ lex.nextToken();
+ float_placement = lex.getString();
+ } else {
+ return token;
+ }
+
+ return string();
+}
+
+
void BufferParams::writeFile(ostream & os) const
{
// The top of the file is written by the buffer.
}
os << "\\paperfontsize " << fontsize << '\n';
- spacing.writeFile(os);
+ spacing().writeFile(os);
os << "\\papersize " << string_papersize[papersize2]
<< "\n\\paperpackage " << string_paperpackages[paperpackage]
<< "\n\\use_numerical_citations " << use_numerical_citations
<< "\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';
<< "\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) {
<< "\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";
}
}
}
os << "\\tracking_changes " << tracking_changes << "\n";
+
+ if (tracking_changes) {
+ 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";
+ }
+ }
}
-void BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
+bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
TexRow & texrow) const
{
os << "\\documentclass";
if (!use_geometry &&
(paperpackage == PACKAGE_NONE)) {
switch (papersize) {
+ case PAPER_A3PAPER:
+ clsoptions << "a3paper,";
+ break;
case PAPER_A4PAPER:
clsoptions << "a4paper,";
break;
case PAPER_LEGALPAPER:
clsoptions << "legalpaper,";
break;
+ case PAPER_DEFAULT:
+ break;
}
}
clsoptions << "landscape,";
// language should be a parameter to \documentclass
- use_babel = false;
- ostringstream language_options;
if (language->babel() == "hebrew"
&& default_language->babel() != "hebrew")
// This seems necessary
features.useLanguage(default_language);
- if (lyxrc.language_use_babel ||
- language->lang() != lyxrc.default_language ||
- features.hasLanguages()) {
- use_babel = true;
+ ostringstream language_options;
+ bool const use_babel = features.useBabel();
+ if (use_babel) {
language_options << features.getLanguages();
language_options << language->babel();
if (lyxrc.language_global_options)
clsoptions << options << ',';
}
- string strOptions(STRCONV(clsoptions.str()));
+ string strOptions(clsoptions.str());
if (!strOptions.empty()) {
strOptions = rtrim(strOptions, ",");
os << '[' << strOptions << ']';
// At the very beginning the text parameters.
if (paperpackage != PACKAGE_NONE) {
switch (paperpackage) {
+ case PACKAGE_NONE:
+ break;
case PACKAGE_A4:
os << "\\usepackage{a4}\n";
texrow.newline();
}
if (paragraph_separation) {
- switch (defskip.kind()) {
+ switch (getDefSkip().kind()) {
case VSpace::SMALLSKIP:
os << "\\setlength\\parskip{\\smallskipamount}\n";
break;
break;
case VSpace::LENGTH:
os << "\\setlength\\parskip{"
- << defskip.length().asLatexString()
+ << getDefSkip().length().asLatexString()
<< "}\n";
break;
default: // should never happen // Then delete it.
// 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";
break;
}
bullets_def += "}{" +
- user_defined_bullets[i].getText()
+ user_defined_bullet(i).getText()
+ "}\n";
}
}
if (!lyxrc.language_global_options
&& tmp == "\\usepackage{babel}")
tmp = string("\\usepackage[") +
- STRCONV(language_options.str()) +
+ language_options.str() +
"]{babel}";
lyxpreamble += tmp + "\n";
lyxpreamble += features.getBabelOptions();
}
os << lyxpreamble;
+ return use_babel;
}
void BufferParams::setPaperStuff()
}
}
}
+
+
+string const BufferParams::paperSizeName() const
+{
+ char real_papersize = papersize;
+ if (real_papersize == PAPER_DEFAULT)
+ real_papersize = lyxrc.default_papersize;
+
+ switch (real_papersize) {
+ case PAPER_A3PAPER:
+ return "a3";
+ case PAPER_A4PAPER:
+ return "a4";
+ case PAPER_A5PAPER:
+ return "a5";
+ case PAPER_B5PAPER:
+ return "b5";
+ case PAPER_EXECUTIVEPAPER:
+ return "foolscap";
+ case PAPER_LEGALPAPER:
+ return "legal";
+ case PAPER_USLETTER:
+ default:
+ return "letter";
+ }
+}
+
+
+string const BufferParams::dvips_options() const
+{
+ string result;
+
+ if (use_geometry
+ && papersize2 == VM_PAPER_CUSTOM
+ && !lyxrc.print_paper_dimension_flag.empty()
+ && !paperwidth.empty()
+ && !paperheight.empty()) {
+ // using a custom papersize
+ result = lyxrc.print_paper_dimension_flag;
+ result += ' ' + paperwidth;
+ result += ',' + paperheight;
+ } else {
+ string const paper_option = paperSizeName();
+ if (paper_option != "letter" ||
+ orientation != ORIENTATION_LANDSCAPE) {
+ // dvips won't accept -t letter -t landscape.
+ // In all other cases, include the paper size
+ // explicitly.
+ result = lyxrc.print_paper_flag;
+ result += ' ' + paper_option;
+ }
+ }
+ if (orientation == ORIENTATION_LANDSCAPE &&
+ papersize2 != VM_PAPER_CUSTOM)
+ result += ' ' + lyxrc.print_landscape_flag;
+ return result;
+}
projects / lyx.git / blobdiff