* 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 "IndicesList.h"
#include "Language.h"
#include "LaTeXFeatures.h"
#include "ModuleList.h"
};
+
namespace lyx {
// Local translators
return translator;
}
-
} // anon namespace
BranchList branchlist;
Bullet temp_bullets[4];
Bullet user_defined_bullets[4];
+ IndicesList indiceslist;
Spacing spacing;
/** This is the amount of space used for paragraph_separation "skip",
* and for detached paragraphs in "indented" documents.
use_esint = package_auto;
cite_engine_ = ENGINE_BASIC;
use_bibtopic = false;
+ use_indices = false;
trackChanges = false;
outputChanges = false;
use_default_options = true;
fontsSans = "default";
fontsTypewriter = "default";
fontsDefaultFamily = "default";
+ useXetex = false;
fontsSC = false;
fontsOSF = false;
fontsSansScale = 100;
fontsTypewriterScale = 100;
inputenc = "auto";
graphicsDriver = "default";
+ defaultOutputFormat = "default";
sides = OneSide;
columns = 1;
listings_params = string();
pagestyle = "default";
+ // white is equal to no background color
+ backgroundcolor = lyx::rgbFromHexName("#ffffff");
compressed = false;
for (int iter = 0; iter < 4; ++iter) {
user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
}
+ // default index
+ indiceslist().addDefault(B_("Index"));
}
}
+IndicesList & BufferParams::indiceslist()
+{
+ return pimpl_->indiceslist;
+}
+
+
+IndicesList const & BufferParams::indiceslist() const
+{
+ return pimpl_->indiceslist;
+}
+
+
Bullet & BufferParams::temp_bullet(lyx::size_type const index)
{
LASSERT(index < 4, /**/);
lex >> inputenc;
} else if (token == "\\graphics") {
readGraphicsDriver(lex);
+ } else if (token == "\\default_output_format") {
+ lex >> defaultOutputFormat;
} else if (token == "\\font_roman") {
- lex >> fontsRoman;
+ lex.eatLine();
+ fontsRoman = lex.getString();
} else if (token == "\\font_sans") {
- lex >> fontsSans;
+ lex.eatLine();
+ fontsSans = lex.getString();
} else if (token == "\\font_typewriter") {
- lex >> fontsTypewriter;
+ lex.eatLine();
+ fontsTypewriter = lex.getString();
} else if (token == "\\font_default_family") {
lex >> fontsDefaultFamily;
+ } else if (token == "\\use_xetex") {
+ lex >> useXetex;
} else if (token == "\\font_sc") {
lex >> fontsSC;
} else if (token == "\\font_osf") {
cite_engine_ = citeenginetranslator().find(engine);
} else if (token == "\\use_bibtopic") {
lex >> use_bibtopic;
+ } else if (token == "\\use_indices") {
+ lex >> use_indices;
} else if (token == "\\tracking_changes") {
lex >> trackChanges;
} else if (token == "\\output_changes") {
lex >> outputChanges;
} else if (token == "\\branch") {
- lex.next();
+ lex.eatLine();
docstring branch = lex.getDocString();
branchlist().add(branch);
while (true) {
color = lcolor.getX11Name(Color_background);
// FIXME UNICODE
lcolor.setColor(to_utf8(branch), color);
-
+ }
+ }
+ } else if (token == "\\index") {
+ lex.eatLine();
+ docstring index = lex.getDocString();
+ indiceslist().add(index);
+ while (true) {
+ lex.next();
+ string const tok = lex.getString();
+ if (tok == "\\end_index")
+ break;
+ Index * index_ptr = indiceslist().find(index);
+ if (tok == "\\shortcut") {
+ lex.next();
+ if (index_ptr)
+ index_ptr->setShortcut(lex.getDocString());
+ }
+ // not yet operational
+ if (tok == "\\color") {
+ lex.eatLine();
+ string color = lex.getString();
+ if (index_ptr)
+ index_ptr->setColor(color);
+ // Update also the Color table:
+ if (color == "none")
+ color = lcolor.getX11Name(Color_background);
+ // FIXME UNICODE
+ lcolor.setColor(to_utf8(index), color);
}
}
} else if (token == "\\author") {
string orient;
lex >> orient;
orientation = paperorientationtranslator().find(orient);
+ } else if (token == "\\backgroundcolor") {
+ lex.eatLine();
+ backgroundcolor = lyx::rgbFromHexName(lex.getString());
} else if (token == "\\paperwidth") {
lex >> paperwidth;
} else if (token == "\\paperheight") {
// removed modules
if (!removedModules_.empty()) {
os << "\\begin_removed_modules" << '\n';
- set<string>::const_iterator it = removedModules_.begin();
- set<string>::const_iterator en = removedModules_.end();
+ 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';
<< "\n\\font_sans " << fontsSans
<< "\n\\font_typewriter " << fontsTypewriter
<< "\n\\font_default_family " << fontsDefaultFamily
+ << "\n\\use_xetex " << convert<string>(useXetex)
<< "\n\\font_sc " << convert<string>(fontsSC)
<< "\n\\font_osf " << convert<string>(fontsOSF)
<< "\n\\font_sf_scale " << fontsSansScale
os << "\\font_cjk " << fontsCJK << '\n';
}
os << "\n\\graphics " << graphicsDriver << '\n';
+ os << "\\default_output_format " << defaultOutputFormat << '\n';
if (!float_placement.empty()) {
os << "\\float_placement " << float_placement << '\n';
<< "\n\\use_esint " << use_esint
<< "\n\\cite_engine " << citeenginetranslator().find(cite_engine_)
<< "\n\\use_bibtopic " << convert<string>(use_bibtopic)
+ << "\n\\use_indices " << convert<string>(use_indices)
<< "\n\\paperorientation " << string_orientation[orientation]
+ << "\n\\backgroundcolor " << lyx::X11hexname(backgroundcolor)
<< '\n';
BranchList::const_iterator it = branchlist().begin();
<< "\n";
}
+ IndicesList::const_iterator iit = indiceslist().begin();
+ IndicesList::const_iterator iend = indiceslist().end();
+ for (; iit != iend; ++iit) {
+ os << "\\index " << to_utf8(iit->index())
+ << "\n\\shortcut " << to_utf8(iit->shortcut())
+ << "\n\\color " << lyx::X11hexname(iit->color())
+ << "\n\\end_index"
+ << "\n";
+ }
+
if (!paperwidth.empty())
os << "\\paperwidth "
<< VSpace(paperwidth).asLyXCommand() << '\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");
+ case OutputParams::XETEX:
+ if (xcolorulem) {
+ features.require("ct-xcolor-ulem");
+ features.require("ulem");
features.require("xcolor");
// improves color handling in PDF output
features.require("pdfcolmk");
features.require("color");
}
+ if (useXetex)
+ features.require("xetex");
+
if (language->lang() == "vietnamese")
features.require("vietnamese");
else if (language->lang() == "japanese")
texrow.newline();
// end of \documentclass defs
+ if (useXetex) {
+ os << "\\usepackage{fontspec}\n";
+ texrow.newline();
+ }
+
// font selection must be done before loading fontenc.sty
string const fonts =
loadFonts(fontsRoman, fontsSans,
fontsTypewriter, fontsSC, fontsOSF,
- fontsSansScale, fontsTypewriterScale);
+ fontsSansScale, fontsTypewriterScale, useXetex);
if (!fonts.empty()) {
os << from_ascii(fonts);
texrow.newline();
// 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" && language->lang() != "japanese") {
+ // XeteX works without fontenc
+ if (lyxrc.fontenc != "default" && language->lang() != "japanese"
+ && !useXetex) {
if (language->lang() == "arabic_arabi"
|| language->lang() == "farsi") {
os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
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();
}
+ // only output when the background color is not white
+ if (backgroundcolor != lyx::rgbFromHexName("#ffffff")) {
+ // only require color here, the background color will be defined
+ // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
+ // package pdfpages
+ features.require("color");
+ features.require("pagecolor");
+ }
+
// Only if class has a ToC hierarchy
if (tclass.hasTocLevels()) {
if (secnumdepth != tclass.secnumdepth()) {
// The optional packages;
lyxpreamble += from_ascii(features.getPackages());
+ // Additional Indices
+ if (features.isRequired("splitidx")) {
+ IndicesList::const_iterator iit = indiceslist().begin();
+ IndicesList::const_iterator iend = indiceslist().end();
+ for (; iit != iend; ++iit) {
+ lyxpreamble += "\\newindex[";
+ lyxpreamble += iit->index();
+ lyxpreamble += "]{";
+ lyxpreamble += iit->shortcut();
+ lyxpreamble += "}\n";
+ }
+ }
+
// Line spacing
lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
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) {
}
os << lyxpreamble;
+
+ // these packages (xunicode, for that matter) need to be loaded at least
+ // after amsmath, amssymb, esint and the other packages that provide
+ // special glyphs
+ if (useXetex) {
+ os << "\\usepackage{xunicode}\n";
+ texrow.newline();
+ os << "\\usepackage{xltxtra}\n";
+ texrow.newline();
+ }
return use_babel;
}
}
-void BufferParams::addDefaultModules()
-{
- // add any default modules not already in use
- list<string> const & mods = baseClass()->defaultModules();
- list<string>::const_iterator mit = mods.begin();
- list<string>::const_iterator men = mods.end();
-
- // we want to add these to the front, but in the right order,
- // so we collect them here first.
- list<string> modulesToAdd;
-
- for (; mit != men; mit++) {
- string const & modName = *mit;
- // make sure the user hasn't removed it
- if (find(removedModules_.begin(), removedModules_.end(), modName) !=
- removedModules_.end()) {
- LYXERR(Debug::TCLASS, "Default module `" << modName <<
- "' not added because removed by user.");
- continue;
- }
-
- if (moduleCanBeAdded(modName)) {
- LYXERR(Debug::TCLASS, "Default module `" << modName << "' added.");
- modulesToAdd.push_back(modName);
- } else
- LYXERR(Debug::TCLASS,
- "Default module `" << modName << "' could not be added.");
- }
-
- // OK, now we can add the default modules.
- layoutModules_.insert(
- layoutModules_.begin(), modulesToAdd.begin(), modulesToAdd.end());
-}
-
-
bool BufferParams::setBaseClass(string const & classname)
{
LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
}
pimpl_->baseClass_ = classname;
- addDefaultModules();
-
+ layoutModules_.adaptToBaseClass(baseClass(), removedModules_);
return true;
}
if (!baseClass())
return;
- doc_class_ = &(DocumentClassBundle::get().newClass(*baseClass()));
+ doc_class_ = &(DocumentClassBundle::get().makeDocumentClass(*baseClass(), layoutModules_));
- // 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);
- }
- }
if (!local_layout.empty()) {
if (!doc_class_->read(local_layout, TextClass::MODULE)) {
docstring const msg = _("Error reading internal layout information");
}
}
-
bool BufferParams::moduleCanBeAdded(string const & modName) const
{
- // Is the module already present?
- LayoutModuleList::const_iterator it = layoutModules_.begin();
- LayoutModuleList::const_iterator end = layoutModules_.end();
- for (; it != end; it++)
- if (*it == modName)
- return false;
-
- LyXModule const * const lm = moduleList[modName];
- if (!lm)
- return true;
-
- LayoutModuleList::const_iterator mit = getModules().begin();
- LayoutModuleList::const_iterator const men = getModules().end();
- // Check for conflicts with used modules
- for (; mit != men; ++mit)
- if (!LyXModule::areCompatible(modName, *mit))
- return false;
-
- // Check whether some required module is available
- vector<string> const reqs = lm->getRequiredModules();
- if (reqs.empty())
- return true;
-
- mit = getModules().begin(); // reset
- vector<string>::const_iterator rit = reqs.begin();
- vector<string>::const_iterator ren = reqs.end();
- bool foundone = false;
- for (; rit != ren; ++rit) {
- if (find(mit, men, *rit) != men) {
- foundone = true;
- break;
- }
- }
-
- return foundone;
+ return layoutModules_.moduleCanBeAdded(modName, baseClass());
}
string mod = lex.getString();
if (mod == "\\end_removed_modules")
break;
- removedModules_.insert(mod);
+ 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.
- set<string>::const_iterator rit = removedModules_.begin();
- set<string>::const_iterator const ren = removedModules_.end();
+ 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();
}
+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
{
+ if (useXetex)
+ return;
if (inputenc == "auto") {
string const doc_encoding =
language->encoding()->latexName();
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") {
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;
}
}
+string const BufferParams::parseFontName(string const & name) const
+{
+ string mangled = name;
+ size_t const idx = mangled.find('[');
+ if (idx == string::npos || idx == 0)
+ return mangled;
+ else
+ return mangled.substr(0, idx - 1);
+}
+
+
string const BufferParams::loadFonts(string const & rm,
string const & sf, string const & tt,
bool const & sc, bool const & osf,
- int const & sfscale, int const & ttscale) const
+ int const & sfscale, int const & ttscale,
+ bool const & xetex) const
{
/* The LaTeX font world is in a flux. In the PSNFSS font interface,
several packages have been replaced by others, that might not
ostringstream os;
+ if (xetex) {
+ if (rm != "default")
+ os << "\\setmainfont[Mapping=tex-text]{"
+ << parseFontName(rm) << "}\n";
+ if (sf != "default") {
+ string const sans = parseFontName(sf);
+ if (sfscale != 100)
+ os << "\\setsansfont[Scale="
+ << float(sfscale) / 100
+ << ",Mapping=tex-text]{"
+ << sans << "}\n";
+ else
+ os << "\\setsansfont[Mapping=tex-text]{"
+ << sans << "}\n";
+ }
+ if (tt != "default") {
+ string const mono = parseFontName(tt);
+ if (ttscale != 100)
+ os << "\\setmonofont[Scale="
+ << float(sfscale) / 100
+ << "]{"
+ << mono << "}\n";
+ else
+ os << "\\setmonofont[Mapping=tex-text]{"
+ << mono << "}\n";
+ }
+ if (osf)
+ os << "\\defaultfontfeatures{Numbers=OldStyle}\n";
+ return os.str();
+ }
+
// ROMAN FONTS
// Computer Modern (must be explicitely selectable -- there might be classes
// that define a different default font!
Encoding const & BufferParams::encoding() const
{
+ if (useXetex)
+ return *(encodings.fromLaTeXName("utf8-plain"));
if (inputenc == "auto" || inputenc == "default")
return *language->encoding();
Encoding const * const enc = encodings.fromLaTeXName(inputenc);