* Licence details can be found in the file COPYING.
*
* \author Alfredo Braunstein
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
* \author John Levon
- * \author André Pönitz
+ * \author André Pönitz
* \author Martin Vermeer
*
* Full author contact details are available in file CREDITS.
#include "buffer_funcs.h"
#include "Bullet.h"
#include "Color.h"
+#include "ColorSet.h"
#include "Encoding.h"
#include "Language.h"
#include "LaTeXFeatures.h"
static char const * const tex_graphics[] = {
- "default", "dvips", "dvitops", "emtex",
- "ln", "oztex", "textures", "none", ""
+ "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
+ "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
+ "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
+ "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
+ "xetex", "none", ""
};
use_bibtopic = false;
trackChanges = false;
outputChanges = false;
+ use_default_options = true;
secnumdepth = 3;
tocdepth = 3;
language = default_language;
readLocalLayout(lex);
} else if (token == "\\begin_modules") {
readModules(lex);
+ } else if (token == "\\begin_removed_modules") {
+ readRemovedModules(lex);
} else if (token == "\\options") {
lex.eatLine();
options = lex.getString();
+ } else if (token == "\\use_default_options") {
+ lex >> use_default_options;
} else if (token == "\\master") {
lex.eatLine();
master = lex.getString();
} else if (token == "\\output_changes") {
lex >> outputChanges;
} else if (token == "\\branch") {
- lex.next();
+ lex.eatLine();
docstring branch = lex.getDocString();
branchlist().add(branch);
while (true) {
os << "\\options " << options << '\n';
}
+ // use the class options defined in the layout?
+ os << "\\use_default_options "
+ << convert<string>(use_default_options) << "\n";
+
// the master document
if (!master.empty()) {
os << "\\master " << master << '\n';
}
- //the modules
+ // removed modules
+ if (!removedModules_.empty()) {
+ os << "\\begin_removed_modules" << '\n';
+ list<string>::const_iterator it = removedModules_.begin();
+ list<string>::const_iterator en = removedModules_.end();
+ for (; it != en; it++)
+ os << *it << '\n';
+ os << "\\end_removed_modules" << '\n';
+ }
+
+ // the modules
if (!layoutModules_.empty()) {
os << "\\begin_modules" << '\n';
LayoutModuleList::const_iterator it = layoutModules_.begin();
- for (; it != layoutModules_.end(); it++)
+ LayoutModuleList::const_iterator en = layoutModules_.end();
+ for (; it != en; it++)
os << *it << '\n';
os << "\\end_modules" << '\n';
}
-
+
// local layout information
if (!local_layout.empty()) {
// remove '\n' from the end
BranchList::const_iterator it = branchlist().begin();
BranchList::const_iterator end = branchlist().end();
for (; it != end; ++it) {
- os << "\\branch " << to_utf8(it->getBranch())
- << "\n\\selected " << it->getSelected()
- << "\n\\color " << lyx::X11hexname(it->getColor())
+ os << "\\branch " << to_utf8(it->branch())
+ << "\n\\selected " << it->isSelected()
+ << "\n\\color " << lyx::X11hexname(it->color())
<< "\n\\end_branch"
<< "\n";
}
if (outputChanges) {
bool dvipost = LaTeXFeatures::isAvailable("dvipost");
- bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
+ bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
LaTeXFeatures::isAvailable("xcolor");
switch (features.runparams().flavor) {
if (dvipost) {
features.require("ct-dvipost");
features.require("dvipost");
- } else if (xcolorsoul) {
- features.require("ct-xcolor-soul");
- features.require("soul");
+ } else if (xcolorulem) {
+ features.require("ct-xcolor-ulem");
+ features.require("ulem");
features.require("xcolor");
} else {
features.require("ct-none");
}
break;
case OutputParams::PDFLATEX:
- if (xcolorsoul) {
- features.require("ct-xcolor-soul");
- features.require("soul");
+ if (xcolorulem) {
+ features.require("ct-xcolor-ulem");
+ features.require("ulem");
features.require("xcolor");
// improves color handling in PDF output
features.require("pdfcolmk");
}
}
- if (pdfoptions().use_hyperref)
+ if (pdfoptions().use_hyperref) {
features.require("hyperref");
+ // due to interferences with babel and hyperref, the color package has to
+ // be loaded after hyperref when hyperref is used with the colorlinks
+ // option, see http://bugzilla.lyx.org/show_bug.cgi?id=5291
+ if (pdfoptions().colorlinks)
+ features.require("color");
+ }
if (language->lang() == "vietnamese")
features.require("vietnamese");
language_options << ',';
language_options << language->babel();
}
- // if Vietnamese is used, babel must directly be loaded with the
- // language options, not in the class options, see
+ // if Vietnamese is used, babel must directly be loaded
+ // with 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 Japanese is used, babel must directly be loaded with the
- // language options, not in the class options, see
+ // the same is for all other languages that are not directly supported by
+ // babel, but where LaTeX-packages add babel support.
+ // this is currently the case for Latvian, Lithuanian, and Mongolian
+ size_t latvian = language_options.str().find("latvian");
+ size_t lithu = language_options.str().find("lithuanian");
+ size_t mongo = language_options.str().find("mongolian");
+ // if Japanese is used, babel must directly be loaded
+ // with language options, not in the class options, see
// http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
size_t japan = language_options.str().find("japanese");
- // japan = string::npos when not found
if (lyxrc.language_global_options && !language_options.str().empty()
- && viet == string::npos && japan == string::npos)
+ && viet == string::npos && japan == string::npos
+ && latvian == string::npos && lithu == string::npos
+ && mongo == string::npos)
clsoptions << language_options.str() << ',';
}
+ // the predefined options from the layout
+ if (use_default_options && !tclass.options().empty())
+ clsoptions << tclass.options() << ',';
+
// the user-defined options
if (!options.empty()) {
clsoptions << options << ',';
// 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") {
- if (language->lang() == "arabic_arabi" || language->lang() == "farsi") {
+ // for arabic_arabi and farsi we also need to load the LAE and
+ // LFE encoding
+ if (lyxrc.fontenc != "default" && language->lang() != "japanese") {
+ if (language->lang() == "arabic_arabi"
+ || language->lang() == "farsi") {
os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
<< ",LFE,LAE]{fontenc}\n";
texrow.newline();
// handle inputenc etc.
writeEncodingPreamble(os, features, texrow);
- if (!listings_params.empty()) {
+ if (!listings_params.empty() || features.isRequired("listings")) {
os << "\\usepackage{listings}\n";
texrow.newline();
+ }
+ if (!listings_params.empty()) {
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);
+ // do not test validity because listings_params is
+ // supposed to be valid
+ string par =
+ InsetListingsParams(listings_params).separatedParams(true);
+ // we can't support all packages, but we should load the color package
+ if (par.find("\\color", 0) != string::npos)
+ features.require("color");
+ os << from_utf8(par);
// count the number of newlines
for (size_t i = 0; i < par.size(); ++i)
if (par[i] == '\n')
os << "}\n";
texrow.newline();
}
- if (use_geometry || nonstandard_papersize) {
- os << "\\usepackage{geometry}\n";
- texrow.newline();
- os << "\\geometry{verbose";
+ if (!tclass.provides("geometry")
+ && (use_geometry || nonstandard_papersize)) {
+ odocstringstream ods;
+ if (!getGraphicsDriver("geometry").empty())
+ ods << getGraphicsDriver("geometry");
if (orientation == ORIENTATION_LANDSCAPE)
- os << ",landscape";
+ ods << ",landscape";
switch (papersize) {
case PAPER_CUSTOM:
if (!paperwidth.empty())
- os << ",paperwidth="
+ ods << ",paperwidth="
<< from_ascii(paperwidth);
if (!paperheight.empty())
- os << ",paperheight="
+ ods << ",paperheight="
<< from_ascii(paperheight);
break;
case PAPER_USLETTER:
- os << ",letterpaper";
+ ods << ",letterpaper";
break;
case PAPER_USLEGAL:
- os << ",legalpaper";
+ ods << ",legalpaper";
break;
case PAPER_USEXECUTIVE:
- os << ",executivepaper";
+ ods << ",executivepaper";
break;
case PAPER_A3:
- os << ",a3paper";
+ ods << ",a3paper";
break;
case PAPER_A4:
- os << ",a4paper";
+ ods << ",a4paper";
break;
case PAPER_A5:
- os << ",a5paper";
+ ods << ",a5paper";
break;
case PAPER_B3:
- os << ",b3paper";
+ ods << ",b3paper";
break;
case PAPER_B4:
- os << ",b4paper";
+ ods << ",b4paper";
break;
case PAPER_B5:
- os << ",b5paper";
+ ods << ",b5paper";
break;
default:
// default papersize ie PAPER_DEFAULT
switch (lyxrc.default_papersize) {
case PAPER_DEFAULT: // keep compiler happy
case PAPER_USLETTER:
- os << ",letterpaper";
+ ods << ",letterpaper";
break;
case PAPER_USLEGAL:
- os << ",legalpaper";
+ ods << ",legalpaper";
break;
case PAPER_USEXECUTIVE:
- os << ",executivepaper";
+ ods << ",executivepaper";
break;
case PAPER_A3:
- os << ",a3paper";
+ ods << ",a3paper";
break;
case PAPER_A4:
- os << ",a4paper";
+ ods << ",a4paper";
break;
case PAPER_A5:
- os << ",a5paper";
+ ods << ",a5paper";
break;
case PAPER_B5:
- os << ",b5paper";
+ ods << ",b5paper";
break;
case PAPER_B3:
case PAPER_B4:
break;
}
}
+ docstring const g_options = trim(ods.str(), ",");
+ os << "\\usepackage";
+ if (!g_options.empty())
+ os << '[' << g_options << ']';
+ os << "{geometry}\n";
+ texrow.newline();
+ os << "\\geometry{verbose";
if (!topmargin.empty())
os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
if (!bottommargin.empty())
texrow.newline();
}
- // If we use jurabib, we have to call babel here.
- if (use_babel && features.isRequired("jurabib")) {
- os << from_ascii(babelCall(language_options.str()))
- << '\n'
- << from_ascii(features.getBabelOptions());
- texrow.newline();
- }
-
// Now insert the LyX specific LaTeX commands...
+ docstring lyxpreamble;
+
+ // due to interferences with babel and hyperref, the color package has to
+ // be loaded (when it is not already loaded) before babel when hyperref
+ // is used with the colorlinks option, see
+ // http://bugzilla.lyx.org/show_bug.cgi?id=5291
+ // we decided therefore to load color always before babel, see
+ // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
+ lyxpreamble += from_ascii(features.getColorOptions());
+
+ // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
+ if (use_babel
+ && (features.isRequired("jurabib")
+ || features.isRequired("hyperref")
+ || features.isRequired("vietnamese")
+ || features.isRequired("japanese") ) ) {
+ // FIXME UNICODE
+ lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
+ lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
+ }
// The optional packages;
- docstring lyxpreamble(from_ascii(features.getPackages()));
+ lyxpreamble += from_ascii(features.getPackages());
// Line spacing
lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
- // If we use hyperref or japanese or vietnamese, we have to call babel here.
- if (use_babel && !features.isRequired("jurabib")
- && (features.isRequired("hyperref") || features.isRequired("vietnamese")
- || features.isRequired("japanese"))) {
- // 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."
+ // 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
pdfoptions().writeLaTeX(oss, documentClass().provides("hyperref"));
lyxpreamble += oss.str();
}
-
+
// Will be surrounded by \makeatletter and \makeatother when needed
docstring atlyxpreamble;
else
lyxpreamble += '\n' + atlyxpreamble;
- // We try to load babel late, in case it interferes
- // with other packages.
+ // We try to load babel late, in case it interferes with other packages.
// Jurabib and Hyperref have to be called after babel, though.
if (use_babel && !features.isRequired("jurabib")
&& !features.isRequired("hyperref")
lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
}
+ docstring const i18npreamble = features.getTClassI18nPreamble(use_babel);
+ if (!i18npreamble.empty())
+ lyxpreamble += i18npreamble + '\n';
+
int const nlines =
int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
for (int j = 0; j != nlines; ++j) {
sides = tclass.sides();
columns = tclass.columns();
pagestyle = tclass.pagestyle();
- options = tclass.options();
+ use_default_options = true;
// Only if class has a ToC hierarchy
if (tclass.hasTocLevels()) {
secnumdepth = tclass.secnumdepth();
return sides == tclass.sides()
&& columns == tclass.columns()
&& pagestyle == tclass.pagestyle()
- && options == tclass.options()
+ && use_default_options
&& secnumdepth == tclass.secnumdepth()
&& tocdepth == tclass.tocdepth();
}
bcl.addEmptyClass(classname);
}
- if (bcl[classname].load()) {
- pimpl_->baseClass_ = classname;
- return true;
+ bool const success = bcl[classname].load();
+ if (!success) {
+ docstring s =
+ bformat(_("The document class %1$s could not be loaded."),
+ from_utf8(classname));
+ frontend::Alert::error(_("Could not load class"), s);
+ return false;
}
-
- docstring s =
- bformat(_("The document class %1$s could not be loaded."),
- from_utf8(classname));
- frontend::Alert::error(_("Could not load class"), s);
- return false;
+
+ pimpl_->baseClass_ = classname;
+ layoutModules_.adaptToBaseClass(baseClass(), removedModules_);
+ return true;
}
if (!baseClass())
return;
- doc_class_ = &(DocumentClassBundle::get().newClass(*baseClass()));
-
- //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"
- "probably need to reconfigure LyX.\n"), from_utf8(modName));
- frontend::Alert::warning(_("Module not available"),
- msg + _("Some layouts may not be available."));
- LYXERR0("BufferParams::makeDocumentClass(): Module " <<
- modName << " requested but not found in module list.");
- continue;
- }
- 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());
- if (!doc_class_->read(layout_file, TextClass::MODULE)) {
- docstring const msg =
- bformat(_("Error reading module %1$s\n"), from_utf8(modName));
- frontend::Alert::warning(_("Read Error"), msg);
- }
- }
+ doc_class_ = &(DocumentClassBundle::get().makeDocumentClass(*baseClass(), layoutModules_));
+
if (!local_layout.empty()) {
if (!doc_class_->read(local_layout, TextClass::MODULE)) {
docstring const msg = _("Error reading internal layout information");
}
}
-
-vector<string> const & BufferParams::getModules() const
+bool BufferParams::moduleCanBeAdded(string const & modName) const
{
- return layoutModules_;
+ return layoutModules_.moduleCanBeAdded(modName, baseClass());
}
-
-bool BufferParams::addLayoutModule(string const & modName)
+bool BufferParams::addLayoutModule(string const & modName)
{
LayoutModuleList::const_iterator it = layoutModules_.begin();
LayoutModuleList::const_iterator end = layoutModules_.end();
}
-void BufferParams::clearLayoutModules()
-{
- layoutModules_.clear();
-}
-
-
Font const BufferParams::getFont() const
{
FontInfo f = documentClass().defaultfont();
}
+void BufferParams::readRemovedModules(Lexer & lex)
+{
+ if (!lex.eatLine()) {
+ lyxerr << "Error (BufferParams::readRemovedModules):"
+ "Unexpected end of input." << endl;
+ return;
+ }
+ while (true) {
+ string mod = lex.getString();
+ if (mod == "\\end_removed_modules")
+ break;
+ removedModules_.push_back(mod);
+ lex.eatLine();
+ }
+ // now we want to remove any removed modules that were previously
+ // added. normally, that will be because default modules were added in
+ // setBaseClass(), which gets called when \textclass is read at the
+ // start of the read.
+ list<string>::const_iterator rit = removedModules_.begin();
+ list<string>::const_iterator const ren = removedModules_.end();
+ for (; rit != ren; rit++) {
+ LayoutModuleList::iterator const mit = layoutModules_.begin();
+ LayoutModuleList::iterator const men = layoutModules_.end();
+ LayoutModuleList::iterator found = find(mit, men, *rit);
+ if (found == men)
+ continue;
+ layoutModules_.erase(found);
+ }
+}
+
+
string BufferParams::paperSizeName(PapersizePurpose purpose) const
{
char real_papersize = papersize;
// 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
+ // the same is for all other languages that are not directly supported by
+ // babel, but where LaTeX-packages add babel support.
+ // this is currently the case for Latvian, Lithuanian, and Mongolian
+ size_t latvian = lang_opts.find("latvian");
+ size_t lithu = lang_opts.find("lithuanian");
+ size_t mongo = lang_opts.find("mongolian");
// If Japanese is used, babel must directly be loaded with the
// language options, see
// http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
size_t japan = lang_opts.find("japanese");
- // japan = string::npos when not found
- if (!lyxrc.language_global_options || viet != string::npos || japan != string::npos)
+ if (!lyxrc.language_global_options || viet != string::npos
+ || japan != string::npos || latvian != string::npos
+ || lithu != string::npos || mongo != string::npos)
return "\\usepackage[" + lang_opts + "]{babel}";
return lang_pack;
}
+docstring BufferParams::getGraphicsDriver(string const & package) const
+{
+ docstring result;
+
+ if (package == "geometry") {
+ if (graphicsDriver == "dvips"
+ || graphicsDriver == "dvipdfm"
+ || graphicsDriver == "pdftex"
+ || graphicsDriver == "vtex")
+ result = from_ascii(graphicsDriver);
+ else if (graphicsDriver == "dvipdfmx")
+ result = from_ascii("dvipdfm");
+ }
+
+ return result;
+}
+
+
void BufferParams::writeEncodingPreamble(odocstream & os,
LaTeXFeatures & features, TexRow & texrow) const
{
set<string> encodings =
features.getEncodingSet(doc_encoding);
- // If the encodings EUC-JP-plain, JIS-plain, or SJIS-plain are used, the
- // package inputenc must be omitted. Therefore set the encoding to empty.
+ // If the "japanese" package (i.e. pLaTeX) is used,
+ // inputenc must be omitted.
// 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 (package == Encoding::japanese)
+ features.require("japanese");
- if (!encodings.empty() || package == Encoding::inputenc) {
+ if ((!encodings.empty() || package == Encoding::inputenc)
+ && !features.isRequired("japanese")) {
os << "\\usepackage[";
set<string>::const_iterator it = encodings.begin();
set<string>::const_iterator const end = encodings.end();
texrow.newline();
}
if (package == Encoding::CJK || features.mustProvide("CJK")) {
- os << "\\usepackage{CJK}\n";
+ if (language->encoding()->name() == "utf8-cjk"
+ && LaTeXFeatures::isAvailable("CJKutf8"))
+ os << "\\usepackage{CJKutf8}\n";
+ else
+ os << "\\usepackage{CJK}\n";
texrow.newline();
}
} else if (inputenc != "default") {
switch (encoding().package()) {
case Encoding::none:
+ case Encoding::japanese:
break;
case Encoding::inputenc:
+ // do not load inputenc if japanese is used
+ if (features.isRequired("japanese"))
+ break;
os << "\\usepackage[" << from_ascii(inputenc)
<< "]{inputenc}\n";
texrow.newline();
break;
case Encoding::CJK:
- os << "\\usepackage{CJK}\n";
+ if (encoding().name() == "utf8-cjk"
+ && LaTeXFeatures::isAvailable("CJKutf8"))
+ os << "\\usepackage{CJKutf8}\n";
+ else
+ 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") {
+ // The encoding "armscii8" (for Armenian) is only available when
+ // the package "armtex" is loaded.
+ if (language->encoding()->latexName() == "armscii8"
+ || inputenc == "armscii8") {
os << "\\usepackage{armtex}\n";
texrow.newline();
}