#include "BranchList.h"
#include "buffer_funcs.h"
#include "Bullet.h"
-#include "debug.h"
+#include "Color.h"
#include "Encoding.h"
-#include "gettext.h"
#include "Language.h"
#include "LaTeXFeatures.h"
-#include "Messages.h"
#include "ModuleList.h"
-#include "Color.h"
#include "Font.h"
#include "Lexer.h"
#include "LyXRC.h"
#include "Spacing.h"
#include "TexRow.h"
#include "VSpace.h"
+#include "PDFOptions.h"
#include "frontends/alert.h"
+
#include "insets/InsetListingsParams.h"
#include "support/convert.h"
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/FileName.h"
#include "support/filetools.h"
+#include "support/gettext.h"
+#include "support/Messages.h"
#include "support/Translator.h"
-
-#include <boost/array.hpp>
+#include "support/lstrings.h"
#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 namespace std;
+using namespace lyx::support;
static char const * const string_paragraph_separation[] = {
// Paper size
-typedef Translator<std::string, PAPER_SIZE> PaperSizeTranslator;
+typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
PaperSizeTranslator const init_papersizetranslator()
// Page sides
-typedef Translator<int, TextClass::PageSides> SidesTranslator;
+typedef Translator<int, PageSides> SidesTranslator;
SidesTranslator const init_sidestranslator()
{
- SidesTranslator translator(1, TextClass::OneSide);
- translator.addPair(2, TextClass::TwoSides);
+ SidesTranslator translator(1, OneSide);
+ translator.addPair(2, TwoSides);
return translator;
}
AuthorList authorlist;
BranchList branchlist;
- boost::array<Bullet, 4> temp_bullets;
- boost::array<Bullet, 4> user_defined_bullets;
+ Bullet temp_bullets[4];
+ Bullet user_defined_bullets[4];
Spacing spacing;
/** This is the amount of space used for paragraph_separation "skip",
* and for detached paragraphs in "indented" documents.
*/
VSpace defskip;
+ PDFOptions pdfoptions;
};
: pimpl_(new Impl)
{
setBaseClass(defaultTextclass());
+ makeTextClass();
paragraph_separation = PARSEP_INDENT;
quotes_language = InsetQuotes::EnglishQ;
fontsize = "default";
fontsTypewriterScale = 100;
inputenc = "auto";
graphicsDriver = "default";
- sides = TextClass::OneSide;
+ sides = OneSide;
columns = 1;
listings_params = string();
pagestyle = "default";
}
+PDFOptions & BufferParams::pdfoptions()
+{
+ return pimpl_->pdfoptions;
+}
+
+
+PDFOptions const & BufferParams::pdfoptions() const
+{
+ return pimpl_->pdfoptions;
+}
+
+
VSpace const & BufferParams::getDefSkip() const
{
return pimpl_->defskip;
}
-string const BufferParams::readToken(Lexer & lex, string const & token)
+string const BufferParams::readToken(Lexer & lex, string const & token,
+ FileName const & filepath)
{
if (token == "\\textclass") {
lex.next();
string const classname = lex.getString();
+ // if there exists a local layout file, ignore the system one
+ // NOTE: in this case, the textclass (.cls file) is assumed to be available.
pair<bool, lyx::textclass_type> pp =
- textclasslist.numberOfClass(classname);
- if (pp.first) {
+ make_pair(false, textclass_type(0));
+ if (!filepath.empty())
+ pp = textclasslist.addTextClass(
+ classname, filepath.absFilename());
+ if (pp.first)
setBaseClass(pp.second);
- } else {
- // if text class does not exist, try to load it from filepath
- pp = textclasslist.addTextClass(classname, filepath);
- if (pp.first) {
+ else {
+ pp = textclasslist.numberOfClass(classname);
+ if (pp.first)
setBaseClass(pp.second);
- } else {
+ else {
+ // a warning will be given for unknown class
setBaseClass(defaultTextclass());
return classname;
}
}
+ // FIXME: this warning will be given even if there exists a local .cls
+ // file. Even worse, the .lyx file can not be compiled or exported
+ // because the textclass is marked as unavilable.
if (!getTextClass().isTeXClassAvailable()) {
docstring const msg =
bformat(_("The layout file requested by this document,\n"
readPreamble(lex);
} else if (token == "\\begin_modules") {
readModules(lex);
- makeTextClass();
} else if (token == "\\options") {
lex.eatLine();
options = lex.getString();
branch_ptr->setColor(color);
// Update also the Color table:
if (color == "none")
- color = lcolor.getX11Name(Color::background);
+ color = lcolor.getX11Name(Color_background);
// FIXME UNICODE
lcolor.setColor(to_utf8(branch), color);
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;
os << "\\paperfontsize " << fontsize << '\n';
spacing().writeFile(os);
+ pdfoptions().writeFile(os);
os << "\\papersize " << string_papersize[papersize]
<< "\n\\use_geometry " << convert<string>(use_geometry)
}
+void BufferParams::validate(LaTeXFeatures & features) const
+{
+ if (!getTextClass().requires().empty()) {
+ vector<string> req = getTextClass().requires();
+ for (vector<string>::const_iterator it = req.begin();
+ it != req.end(); ++it) {
+ features.require(*it);
+ }
+ }
+
+ if (outputChanges) {
+ bool dvipost = LaTeXFeatures::isAvailable("dvipost");
+ bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
+ LaTeXFeatures::isAvailable("xcolor");
+
+ switch (features.runparams().flavor) {
+ case OutputParams::LATEX:
+ if (dvipost) {
+ features.require("ct-dvipost");
+ features.require("dvipost");
+ } else if (xcolorsoul) {
+ features.require("ct-xcolor-soul");
+ features.require("soul");
+ features.require("xcolor");
+ } else {
+ features.require("ct-none");
+ }
+ break;
+ case OutputParams::PDFLATEX:
+ if (xcolorsoul) {
+ features.require("ct-xcolor-soul");
+ features.require("soul");
+ features.require("xcolor");
+ // improves color handling in PDF output
+ features.require("pdfcolmk");
+ } else {
+ features.require("ct-none");
+ }
+ break;
+ default:
+ break;
+ }
+ }
+
+ // Floats with 'Here definitely' as default setting.
+ if (float_placement.find('H') != string::npos)
+ features.require("float");
+
+ // AMS Style is at document level
+ if (use_amsmath == package_on
+ || getTextClass().provides("amsmath"))
+ features.require("amsmath");
+ if (use_esint == package_on)
+ features.require("esint");
+
+ // the bullet shapes are buffer level not paragraph level
+ // so they are tested here
+ for (int i = 0; i < 4; ++i) {
+ if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
+ continue;
+ int const font = user_defined_bullet(i).getFont();
+ if (font == 0) {
+ int const c = user_defined_bullet(i).getCharacter();
+ if (c == 16
+ || c == 17
+ || c == 25
+ || c == 26
+ || c == 31) {
+ features.require("latexsym");
+ }
+ } else if (font == 1) {
+ features.require("amssymb");
+ } else if (font >= 2 && font <= 5) {
+ features.require("pifont");
+ }
+ }
+}
+
+
bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
TexRow & texrow) const
{
// if needed
if (sides != tclass.sides()) {
switch (sides) {
- case TextClass::OneSide:
+ case OneSide:
clsoptions << "oneside,";
break;
- case TextClass::TwoSides:
+ case TwoSides:
clsoptions << "twoside,";
break;
}
language_options << ',';
language_options << language->babel();
}
- if (lyxrc.language_global_options && !language_options.str().empty())
+ // when Vietnamese is used, babel must directly be loaded with the
+ // language options, not in the class options, see
+ // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
+ size_t viet = language_options.str().find("vietnam");
+ // viet = string::npos when not found
+ if (lyxrc.language_global_options && !language_options.str().empty()
+ && viet == string::npos)
clsoptions << language_options.str() << ',';
}
// 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 problems, you can shift babel to its old place behind
+ // the user-defined preamble. But in this case you must change the Vietnamese
+ // support from currently "\usepackage[vietnamese]{babel}" to:
+ // \usepackage{vietnamese}
+ // \usepackage{babel}
+ // because vietnamese must be loaded before hyperref
+ if (use_babel && !features.isRequired("jurabib")) {
+ // FIXME UNICODE
+ lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
+ lyxpreamble += from_utf8(features.getBabelOptions());
+ }
+
+ // When the language "japanese-plain" is used, the package "japanese" must
+ // be loaded behind babel (it provides babel support for Japanese) but before
+ // hyperref, see
+ // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
+ if (language->lang() == "japanese-plain" &&
+ !getTextClass().provides("japanese")) {
+ //load babel in case it was not loaded due to an empty language list
+ if (language_options.str().empty())
+ lyxpreamble += "\\usepackage{babel}\n";
+ lyxpreamble += "\\usepackage{japanese}\n";
+ }
+
+ // 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;
+ // use hyperref explicitely when it is required
+ pdfoptions().writeLaTeX(oss, features.isRequired("hyperref"));
+ 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\n";
int const nlines =
}
-TextClass_ptr BufferParams::getTextClass_ptr() const {
+TextClassPtr BufferParams::getTextClassPtr() const {
return textClass_;
}
-void BufferParams::setTextClass(TextClass_ptr tc) {
+void BufferParams::setTextClass(TextClassPtr tc) {
textClass_ = tc;
}
bool BufferParams::setBaseClass(textclass_type tc)
{
- bool retVal = true;
- if (textclasslist[tc].load())
+ 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;
+ return true;
}
- makeTextClass();
- return retVal;
-}
-
-
-void BufferParams::setJustBaseClass(textclass_type tc)
-{
- baseClass_ = tc;
+
+ 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);
+ return false;
}
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.
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));
+ 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"
+ "probably need to reconfigure LyX.\n"), from_utf8(modName));
frontend::Alert::warning(_("Module not available"),
- msg + _("Some layouts may not be 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);
+ if (!lm->isAvailable()) {
+ docstring const msg =
+ bformat(_("The module %1$s requires a package that is\n"
+ "not available in your LaTeX installation. LaTeX output\n"
+ "may not be possible.\n"), from_utf8(modName));
+ frontend::Alert::warning(_("Package not available"), msg);
+ }
+ FileName layout_file = libFileSearch("layouts", lm->getFilename());
textClass_->read(layout_file, TextClass::MODULE);
}
}
-std::vector<string> const & BufferParams::getModules() const {
+vector<string> const & BufferParams::getModules() const {
return layoutModules_;
}
-bool BufferParams::addLayoutModule(string modName, bool makeClass) {
+bool BufferParams::addLayoutModule(string const & modName) {
LayoutModuleList::const_iterator it = layoutModules_.begin();
LayoutModuleList::const_iterator end = layoutModules_.end();
for (; it != end; it++) {
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();
}
Font const BufferParams::getFont() const
{
- Font f = getTextClass().defaultfont();
- f.setLanguage(language);
+ FontInfo f = getTextClass().defaultfont();
if (fontsDefaultFamily == "rmdefault")
- f.setFamily(Font::ROMAN_FAMILY);
+ f.setFamily(ROMAN_FAMILY);
else if (fontsDefaultFamily == "sfdefault")
- f.setFamily(Font::SANS_FAMILY);
+ f.setFamily(SANS_FAMILY);
else if (fontsDefaultFamily == "ttdefault")
- f.setFamily(Font::TYPEWRITER_FAMILY);
- return f;
+ f.setFamily(TYPEWRITER_FAMILY);
+ return Font(f, language);
}
// other languages are used (lang_opts is then empty)
if (lang_opts.empty())
return string();
- if (!lyxrc.language_global_options)
+ // when Vietnamese is used, babel must directly be loaded with the
+ // language options, see
+ // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
+ size_t viet = lang_opts.find("vietnam");
+ // viet = string::npos when not found
+ if (!lyxrc.language_global_options || viet != string::npos)
return "\\usepackage[" + lang_opts + "]{babel}";
return lang_pack;
}
// Create a list with all the input encodings used
// in the document
- std::set<string> encodings =
+ set<string> encodings =
features.getEncodingSet(doc_encoding);
+ // When the encodings EUC-JP-plain, JIS-plain, or SJIS-plainare used, the
+ // package inputenc must be omitted. Therefore set the encoding to empty.
+ // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
+ if (doc_encoding == "EUC-JP-plain" || doc_encoding == "JIS-plain" ||
+ doc_encoding == "SJIS-plain")
+ encodings.clear();
+
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();
+ set<string>::const_iterator it = encodings.begin();
+ set<string>::const_iterator const end = encodings.end();
if (it != end) {
os << from_ascii(*it);
++it;
os << "]{inputenc}\n";
texrow.newline();
}
- if (package == Encoding::CJK) {
+ if (package == Encoding::CJK || features.mustProvide("CJK")) {
os << "\\usepackage{CJK}\n";
texrow.newline();
}