#include "Author.h"
#include "BranchList.h"
+#include "buffer_funcs.h"
#include "Bullet.h"
#include "debug.h"
#include "Encoding.h"
#include "Language.h"
#include "LaTeXFeatures.h"
#include "Messages.h"
+#include "ModuleList.h"
#include "Color.h"
#include "Font.h"
#include "Lexer.h"
#include "Spacing.h"
#include "TexRow.h"
#include "VSpace.h"
+#include "PDFOptions.h"
#include "frontends/alert.h"
+#include "insets/InsetListingsParams.h"
-#include "support/lyxalgo.h" // for lyx::count
#include "support/convert.h"
+#include "support/filetools.h"
#include "support/Translator.h"
+#include "support/lstrings.h"
#include <boost/array.hpp>
+#include <algorithm>
#include <sstream>
+using std::count;
using std::endl;
using std::string;
using std::istringstream;
using std::ostream;
using std::ostringstream;
using std::pair;
-
+using std::string;
+using lyx::support::FileName;
+using lyx::support::libFileSearch;
using lyx::support::bformat;
using lyx::support::rtrim;
using lyx::support::tokenPos;
+using lyx::support::prefixIs;
static char const * const string_paragraph_separation[] = {
}
-textclass_type defaultTextclass()
-{
- // 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.
- return textclasslist.numberOfClass("article").second;
-}
-
} // anon namespace
* and for detached paragraphs in "indented" documents.
*/
VSpace defskip;
+ PDFOptions pdfoptions;
};
BufferParams::BufferParams()
- : textclass(defaultTextclass()), pimpl_(new Impl)
+ : pimpl_(new Impl)
{
+ setBaseClass(defaultTextclass());
paragraph_separation = PARSEP_INDENT;
quotes_language = InsetQuotes::EnglishQ;
fontsize = "default";
graphicsDriver = "default";
sides = TextClass::OneSide;
columns = 1;
+ listings_params = string();
pagestyle = "default";
compressed = false;
+ embedded = false;
for (int iter = 0; iter < 4; ++iter) {
user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
}
+PDFOptions & BufferParams::pdfoptions()
+{
+ return pimpl_->pdfoptions;
+}
+
+
+PDFOptions const & BufferParams::pdfoptions() const
+{
+ return pimpl_->pdfoptions;
+}
+
+
VSpace const & BufferParams::getDefSkip() const
{
return pimpl_->defskip;
pair<bool, lyx::textclass_type> pp =
textclasslist.numberOfClass(classname);
if (pp.first) {
- textclass = pp.second;
+ setBaseClass(pp.second);
} else {
// if text class does not exist, try to load it from filepath
pp = textclasslist.addTextClass(classname, filepath);
if (pp.first) {
- textclass = pp.second;
+ setBaseClass(pp.second);
} else {
- textclass = defaultTextclass();
+ setBaseClass(defaultTextclass());
return classname;
}
}
- // FIXME: isTeXClassAvailable will try to load the layout file, but will
- // fail because of the lack of path info. Warnings will be given although
- // the layout file will be correctly loaded later.
if (!getTextClass().isTeXClassAvailable()) {
docstring const msg =
bformat(_("The layout file requested by this document,\n"
- "%1$s.layout,\n"
- "is not usable. This is probably because a LaTeX\n"
- "class or style file required by it is not\n"
- "available. See the Customization documentation\n"
- "for more information.\n"), from_utf8(classname));
+ "%1$s.layout,\n"
+ "is not usable. This is probably because a LaTeX\n"
+ "class or style file required by it is not\n"
+ "available. See the Customization documentation\n"
+ "for more information.\n"), from_utf8(classname));
frontend::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 == "\\begin_modules") {
+ readModules(lex);
+ makeTextClass();
} else if (token == "\\options") {
lex.eatLine();
options = lex.getString();
lex >> fontsize;
} else if (token == "\\papercolumns") {
lex >> columns;
+ } else if (token == "\\listings_params") {
+ string par;
+ lex >> par;
+ listings_params = InsetListingsParams(par).params();
} else if (token == "\\papersides") {
int psides;
lex >> psides;
spacing().set(spacetranslator().find(nspacing), tmp_val);
} else if (token == "\\float_placement") {
lex >> float_placement;
+
+ } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
+ string toktmp = pdfoptions().readToken(lex, token);
+ if (!toktmp.empty()) {
+ lyxerr << "PDFOptions::readToken(): Unknown token: " <<
+ toktmp << endl;
+ return toktmp;
+ }
} else {
+ lyxerr << "BufferParams::readToken(): Unknown token: " <<
+ token << endl;
return token;
}
// Prints out the buffer info into the .lyx file given by file
// the textclass
- os << "\\textclass " << textclasslist[textclass].name() << '\n';
+ os << "\\textclass " << textclasslist[baseClass_].name() << '\n';
// then the preamble
if (!preamble.empty()) {
if (!options.empty()) {
os << "\\options " << options << '\n';
}
+
+ //the modules
+ if (!layoutModules_.empty()) {
+ os << "\\begin_modules" << '\n';
+ LayoutModuleList::const_iterator it = layoutModules_.begin();
+ for (; it != layoutModules_.end(); it++)
+ os << *it << '\n';
+ os << "\\end_modules" << '\n';
+ }
// then the text parameters
if (language != ignore_language)
os << "\\paperfontsize " << fontsize << '\n';
spacing().writeFile(os);
+ pdfoptions().writeFile(os);
os << "\\papersize " << string_papersize[papersize]
<< "\n\\use_geometry " << convert<string>(use_geometry)
<< "\n\\papercolumns " << columns
<< "\n\\papersides " << sides
<< "\n\\paperpagestyle " << pagestyle << '\n';
+ if (!listings_params.empty())
+ os << "\\listings_params \"" <<
+ InsetListingsParams(listings_params).encodedString() << "\"\n";
for (int i = 0; i < 4; ++i) {
if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
if (user_defined_bullet(i).getFont() != -1) {
AuthorList::Authors::const_iterator a_it = pimpl_->authorlist.begin();
AuthorList::Authors::const_iterator a_end = pimpl_->authorlist.end();
for (; a_it != a_end; ++a_it) {
- os << "\\author " << a_it->second << "\n";
+ if (a_it->second.used())
+ os << "\\author " << a_it->second << "\n";
+ else
+ os << "\\author " << Author() << "\n";
}
}
}
// custom, A3, B3 and B4 paper sizes need geometry
- bool nonstandard_papersize = papersize == PAPER_B3
+ bool nonstandard_papersize = papersize == PAPER_B3
|| papersize == PAPER_B4
|| papersize == PAPER_A3
|| papersize == PAPER_CUSTOM;
bool const use_babel = features.useBabel();
if (use_babel) {
language_options << features.getLanguages();
- language_options << language->babel();
- if (lyxrc.language_global_options)
+ if (!language->babel().empty()) {
+ if (!language_options.str().empty())
+ language_options << ',';
+ language_options << language->babel();
+ }
+ if (lyxrc.language_global_options && !language_options.str().empty())
clsoptions << language_options.str() << ',';
}
if (fontsDefaultFamily != "default")
os << "\\renewcommand{\\familydefault}{\\"
<< from_ascii(fontsDefaultFamily) << "}\n";
+
+ // set font encoding
// this one is not per buffer
+ // for arabic_arabi and farsi we also need to load the LAE and LFE encoding
if (lyxrc.fontenc != "default") {
- os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
- << "]{fontenc}\n";
- texrow.newline();
- }
-
- if (inputenc == "auto") {
- string const doc_encoding =
- language->encoding()->latexName();
-
- // Create a list with all the input encodings used
- // in the document
- std::set<string> encodings =
- features.getEncodingSet(doc_encoding);
-
- // thailatex does not use the inputenc package, but sets up
- // babel directly for tis620-0 encoding, therefore we must
- // not request inputenc for tis620-0 encoding
- if (!encodings.empty() || doc_encoding != "tis620-0") {
- os << "\\usepackage[";
- std::set<string>::const_iterator it = encodings.begin();
- std::set<string>::const_iterator const end = encodings.end();
- if (it != end) {
- os << from_ascii(*it);
- ++it;
- }
- for (; it != end; ++it)
- os << ',' << from_ascii(*it);
- if (doc_encoding != "tis620-0") {
- if (!encodings.empty())
- os << ',';
- os << from_ascii(doc_encoding);
- }
- os << "]{inputenc}\n";
+ if (language->lang() == "arabic_arabi" || language->lang() == "farsi") {
+ os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
+ << ",LFE,LAE]{fontenc}\n";
+ texrow.newline();
+ } else {
+ os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
+ << "]{fontenc}\n";
texrow.newline();
}
- } else if (inputenc != "default" && inputenc != "tis620-0" &&
- inputenc != "ascii") {
- os << "\\usepackage[" << from_ascii(inputenc)
- << "]{inputenc}\n";
- texrow.newline();
}
- // The encoding "armscii8" is only available when the package "armtex" is loaded.
- // armscii8 is used for Armenian.
- if (language->encoding()->latexName() == "armscii8" || inputenc == "armscii8") {
- os << "\\usepackage{armtex}\n";
+ // handle inputenc etc.
+ writeEncodingPreamble(os, features, texrow);
+
+ if (!listings_params.empty()) {
+ os << "\\usepackage{listings}\n";
+ texrow.newline();
+ os << "\\lstset{";
+ // do not test validity because listings_params is supposed to be valid
+ string par = InsetListingsParams(listings_params).separatedParams(true);
+ os << from_ascii(par);
+ // count the number of newlines
+ for (size_t i = 0; i < par.size(); ++i)
+ if (par[i] == '\n')
+ texrow.newline();
+ os << "}\n";
texrow.newline();
}
-
if (use_geometry || nonstandard_papersize) {
os << "\\usepackage{geometry}\n";
texrow.newline();
// The optional packages;
docstring lyxpreamble(from_ascii(features.getPackages()));
+ // We try to load babel late, in case it interferes
+ // with other packages. But some packages also need babel to be loaded
+ // before, e.g. jurabib has to be called after babel.
+ // So load babel after the optional packages but before the user-defined
+ // preamble. This allows the users to redefine babel commands, e.g. to
+ // translate the word "Index" to the German "Stichwortverzeichnis".
+ // For more infos why this place was chosen, see
+ // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg128425.html
+ // if you encounter problem, you can shift babel to its old place behind
+ // the user-defined preamble
+ if (use_babel && !features.isRequired("jurabib")) {
+ // FIXME UNICODE
+ lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
+ lyxpreamble += from_utf8(features.getBabelOptions());
+ }
+
+ // PDF support.
+ // * Hyperref manual: "Make sure it comes last of your loaded
+ // packages, to give it a fighting chance of not being over-written,
+ // since its job is to redefine many LATEX commands."
+ // * Email from Heiko Oberdiek: "It is usually better to load babel
+ // before hyperref. Then hyperref has a chance to detect babel.
+ // * Has to be loaded before the "LyX specific LaTeX commands" to
+ // avoid errors with algorithm floats.
+ odocstringstream oss;
+ pdfoptions().writeLaTeX(oss);
+ lyxpreamble += oss.str();
+
// this might be useful...
lyxpreamble += "\n\\makeatletter\n";
if (!bullets_def.empty())
lyxpreamble += bullets_def + "}\n\n";
- // We try to load babel late, in case it interferes
- // with other packages.
- // Jurabib has to be called after babel, though.
- if (use_babel && !features.isRequired("jurabib")) {
- // FIXME UNICODE
- lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
- lyxpreamble += from_utf8(features.getBabelOptions());
- }
-
- lyxpreamble += "\\makeatother\n";
-
- // dvipost settings come after everything else
- if (features.isAvailable("dvipost") && outputChanges) {
- lyxpreamble +=
- "\\dvipostlayout\n"
- "\\dvipost{osstart color push Red}\n"
- "\\dvipost{osend color pop}\n"
- "\\dvipost{cbstart color push Blue}\n"
- "\\dvipost{cbend color pop}\n";
- }
+ lyxpreamble += "\\makeatother\n\n";
int const nlines =
- int(lyx::count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
+ int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
for (int j = 0; j != nlines; ++j) {
texrow.newline();
}
void BufferParams::useClassDefaults()
{
- TextClass const & tclass = textclasslist[textclass];
+ TextClass const & tclass = textclasslist[baseClass_];
sides = tclass.sides();
columns = tclass.columns();
bool BufferParams::hasClassDefaults() const
{
- TextClass const & tclass = textclasslist[textclass];
+ TextClass const & tclass = textclasslist[baseClass_];
return (sides == tclass.sides()
&& columns == tclass.columns()
TextClass const & BufferParams::getTextClass() const
{
- return textclasslist[textclass];
+ return *textClass_;
+}
+
+
+TextClassPtr BufferParams::getTextClassPtr() const {
+ return textClass_;
+}
+
+
+void BufferParams::setTextClass(TextClassPtr tc) {
+ textClass_ = tc;
+}
+
+
+bool BufferParams::setBaseClass(textclass_type tc)
+{
+ bool retVal = true;
+ if (textclasslist[tc].load())
+ baseClass_ = tc;
+ else {
+ docstring s =
+ bformat(_("The document class %1$s could not be loaded."),
+ from_utf8(textclasslist[tc].name()));
+ frontend::Alert::error(_("Could not load class"), s);
+ retVal = false;
+ }
+ makeTextClass();
+ return retVal;
+}
+
+
+void BufferParams::setJustBaseClass(textclass_type tc)
+{
+ baseClass_ = tc;
+}
+
+
+textclass_type BufferParams::getBaseClass() const
+{
+ return baseClass_;
+}
+
+
+void BufferParams::makeTextClass()
+{
+ textClass_.reset(new TextClass(textclasslist[getBaseClass()]));
+ //FIXME It might be worth loading the children's modules here,
+ //just as we load their bibliographies and such, instead of just
+ //doing a check in InsetInclude.
+ LayoutModuleList::const_iterator it = layoutModules_.begin();
+ for (; it != layoutModules_.end(); it++) {
+ string const modName = *it;
+ LyXModule * lm = moduleList[modName];
+ if (!lm) {
+ docstring const msg =
+ bformat(_("The module %1$s has been requested by\n"
+ "this document but has not been found in the list of\n"
+ "available modules. If you recently installed it, you\n"
+ "probalby need to reconfigure LyX.\n"), from_utf8(modName));
+ frontend::Alert::warning(_("Module not available"),
+ msg + _("Some layouts may not be available."));
+ lyxerr << "BufferParams::makeTextClass(): Module " <<
+ modName << " requested but not found in module list." <<
+ endl;
+ continue;
+ }
+ FileName layout_file = libFileSearch("layouts", lm->filename);
+ textClass_->read(layout_file, TextClass::MODULE);
+ }
+}
+
+
+std::vector<string> const & BufferParams::getModules() const {
+ return layoutModules_;
+}
+
+
+
+bool BufferParams::addLayoutModule(string modName, bool makeClass) {
+ LayoutModuleList::const_iterator it = layoutModules_.begin();
+ LayoutModuleList::const_iterator end = layoutModules_.end();
+ for (; it != end; it++) {
+ if (*it == modName)
+ break;
+ }
+ if (it != layoutModules_.end())
+ return false;
+ layoutModules_.push_back(modName);
+ if (makeClass)
+ makeTextClass();
+ return true;
+}
+
+
+bool BufferParams::addLayoutModules(std::vector<string>modNames)
+{
+ bool retval = true;
+ std::vector<string>::const_iterator it = modNames.begin();
+ std::vector<string>::const_iterator end = modNames.end();
+ for (; it != end; ++it)
+ retval &= addLayoutModule(*it, false);
+ makeTextClass();
+ return retval;
+}
+
+
+void BufferParams::clearLayoutModules() {
+ layoutModules_.clear();
+ makeTextClass();
}
}
+void BufferParams::readModules(Lexer & lex)
+{
+ if (!lex.eatLine()) {
+ lyxerr << "Error (BufferParams::readModules):"
+ "Unexpected end of input." << endl;
+ return;
+ }
+ while (true) {
+ string mod = lex.getString();
+ if (mod == "\\end_modules")
+ break;
+ addLayoutModule(mod);
+ lex.eatLine();
+ }
+}
+
+
string const BufferParams::paperSizeName() const
{
char real_papersize = papersize;
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;
+ string lang_pack = lyxrc.language_package;
+ if (lang_pack != "\\usepackage{babel}")
+ return lang_pack;
+ // suppress the babel call when there is no babel language defined
+ // for the document language in the lib/languages file and if no
+ // other languages are used (lang_opts is then empty)
+ if (lang_opts.empty())
+ return string();
+ if (!lyxrc.language_global_options)
+ return "\\usepackage[" + lang_opts + "]{babel}";
+ return lang_pack;
+}
+
+
+void BufferParams::writeEncodingPreamble(odocstream & os,
+ LaTeXFeatures & features, TexRow & texrow) const
+{
+ if (inputenc == "auto") {
+ string const doc_encoding =
+ language->encoding()->latexName();
+ Encoding::Package const package =
+ language->encoding()->package();
+
+ // Create a list with all the input encodings used
+ // in the document
+ std::set<string> encodings =
+ features.getEncodingSet(doc_encoding);
+
+ if (!encodings.empty() || package == Encoding::inputenc) {
+ os << "\\usepackage[";
+ std::set<string>::const_iterator it = encodings.begin();
+ std::set<string>::const_iterator const end = encodings.end();
+ if (it != end) {
+ os << from_ascii(*it);
+ ++it;
+ }
+ for (; it != end; ++it)
+ os << ',' << from_ascii(*it);
+ if (package == Encoding::inputenc) {
+ if (!encodings.empty())
+ os << ',';
+ os << from_ascii(doc_encoding);
+ }
+ os << "]{inputenc}\n";
+ texrow.newline();
+ }
+ if (package == Encoding::CJK) {
+ os << "\\usepackage{CJK}\n";
+ texrow.newline();
+ }
+ } else if (inputenc != "default") {
+ switch (encoding().package()) {
+ case Encoding::none:
+ break;
+ case Encoding::inputenc:
+ os << "\\usepackage[" << from_ascii(inputenc)
+ << "]{inputenc}\n";
+ texrow.newline();
+ break;
+ case Encoding::CJK:
+ os << "\\usepackage{CJK}\n";
+ texrow.newline();
+ break;
+ }
+ }
+
+ // The encoding "armscii8" is only available when the package "armtex" is loaded.
+ // armscii8 is used for Armenian.
+ if (language->encoding()->latexName() == "armscii8" || inputenc == "armscii8") {
+ os << "\\usepackage{armtex}\n";
+ texrow.newline();
+ }
}