#include "BufferParams.h"
#include "Author.h"
+#include "LayoutFile.h"
#include "BranchList.h"
#include "buffer_funcs.h"
#include "Bullet.h"
#include "Font.h"
#include "Lexer.h"
#include "LyXRC.h"
-#include "TextClassList.h"
#include "OutputParams.h"
#include "Spacing.h"
#include "TexRow.h"
namespace {
// Paragraph separation
-typedef Translator<string, BufferParams::PARSEP> ParSepTranslator;
+typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
ParSepTranslator const init_parseptranslator()
{
- ParSepTranslator translator(string_paragraph_separation[0], BufferParams::PARSEP_INDENT);
- translator.addPair(string_paragraph_separation[1], BufferParams::PARSEP_SKIP);
+ ParSepTranslator translator
+ (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
+ translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
return translator;
}
// Quotes language
-typedef Translator<string, InsetQuotes::quote_language> QuotesLangTranslator;
+typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
QuotesLangTranslator const init_quoteslangtranslator()
{
- QuotesLangTranslator translator(string_quotes_language[0], InsetQuotes::EnglishQ);
- translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQ);
- translator.addPair(string_quotes_language[2], InsetQuotes::GermanQ);
- translator.addPair(string_quotes_language[3], InsetQuotes::PolishQ);
- translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQ);
- translator.addPair(string_quotes_language[5], InsetQuotes::DanishQ);
+ QuotesLangTranslator translator
+ (string_quotes_language[0], InsetQuotes::EnglishQuotes);
+ translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
+ translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
+ translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
+ translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
+ translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
return translator;
}
typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
-PaperSizeTranslator const init_papersizetranslator()
+static PaperSizeTranslator initPaperSizeTranslator()
{
PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
translator.addPair(string_papersize[1], PAPER_CUSTOM);
PaperSizeTranslator const & papersizetranslator()
{
- static PaperSizeTranslator translator = init_papersizetranslator();
+ static PaperSizeTranslator translator = initPaperSizeTranslator();
return translator;
}
AuthorList authorlist;
BranchList branchlist;
+ vector<string> extraEmbeddedFiles;
Bullet temp_bullets[4];
Bullet user_defined_bullets[4];
Spacing spacing;
*/
VSpace defskip;
PDFOptions pdfoptions;
+ LayoutFileIndex baseClass_;
};
BufferParams::Impl::Impl()
- : defskip(VSpace::MEDSKIP)
+ : defskip(VSpace::MEDSKIP), baseClass_(string(""))
{
// set initial author
// FIXME UNICODE
BufferParams::BufferParams()
: pimpl_(new Impl)
{
- setBaseClass(defaultTextclass());
- paragraph_separation = PARSEP_INDENT;
- quotes_language = InsetQuotes::EnglishQ;
+ setBaseClass(defaultBaseclass());
+ makeDocumentClass();
+ paragraph_separation = ParagraphIndentSeparation;
+ quotes_language = InsetQuotes::EnglishQuotes;
fontsize = "default";
/* PaperLayout */
listings_params = string();
pagestyle = "default";
compressed = false;
- embedded = false;
+ embedded = lyxrc.use_bundled_format;
for (int iter = 0; iter < 4; ++iter) {
user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
}
-BufferParams::~BufferParams()
-{}
-
-
-docstring const BufferParams::B_(string const & l10n) const
+docstring BufferParams::B_(string const & l10n) const
{
BOOST_ASSERT(language);
return getMessages(language->code()).get(l10n);
}
+vector<string> & BufferParams::extraEmbeddedFiles()
+{
+ return pimpl_->extraEmbeddedFiles;
+}
+
+
+vector<string> const & BufferParams::extraEmbeddedFiles() const
+{
+ return pimpl_->extraEmbeddedFiles;
+}
+
+
BranchList & BufferParams::branchlist()
{
return pimpl_->branchlist;
}
-string const BufferParams::readToken(Lexer & lex, string const & token,
- FileName const & filepath)
+string BufferParams::readToken(Lexer & lex, string const & token,
+ FileName const & filepath, FileName const & temppath)
{
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 =
- make_pair(false, textclass_type(0));
- if (!filepath.empty())
- pp = textclasslist.addTextClass(
- classname, filepath.absFilename());
- if (pp.first)
- setBaseClass(pp.second);
- else {
- pp = textclasslist.numberOfClass(classname);
- if (pp.first)
- setBaseClass(pp.second);
- else {
- // a warning will be given for unknown class
- setBaseClass(defaultTextclass());
- return classname;
- }
+ string tcp;
+ LayoutFileList & bcl = LayoutFileList::get();
+ if (!temppath.empty())
+ tcp = bcl.addLayoutFile(classname, temppath.absFilename(), LayoutFileList::Embedded);
+ if (tcp.empty() && !filepath.empty())
+ tcp = bcl.addLayoutFile(classname, filepath.absFilename(), LayoutFileList::Local);
+ if (!tcp.empty())
+ setBaseClass(tcp);
+ else if (bcl.haveClass(classname)) {
+ setBaseClass(classname);
+ } else {
+ // a warning will be given for unknown class
+ setBaseClass(defaultBaseclass());
+ 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()) {
+ if (!baseClass()->isTeXClassAvailable()) {
docstring const msg =
bformat(_("The layout file requested by this document,\n"
"%1$s.layout,\n"
} else if (token == "\\begin_preamble") {
readPreamble(lex);
+ } else if (token == "\\begin_local_layout") {
+ readLocalLayout(lex);
} else if (token == "\\begin_modules") {
readModules(lex);
- makeTextClass();
} else if (token == "\\options") {
lex.eatLine();
options = lex.getString();
paragraph_separation = parseptranslator().find(parsep);
} else if (token == "\\defskip") {
lex.next();
- pimpl_->defskip = VSpace(lex.getString());
+ string defskip = lex.getString();
+ if (defskip == "defskip")
+ // this is invalid
+ defskip = "medskip";
+ pimpl_->defskip = VSpace(defskip);
} else if (token == "\\quotes_language") {
string quotes_lang;
lex >> quotes_lang;
lex >> headsep;
} else if (token == "\\footskip") {
lex >> footskip;
+ } else if (token == "\\columnsep") {
+ lex >> columnsep;
} else if (token == "\\paperfontsize") {
lex >> fontsize;
} else if (token == "\\papercolumns") {
toktmp << endl;
return toktmp;
}
+ } else if (token == "\\extra_embedded_files") {
+ extraEmbeddedFiles().clear();
+ string par;
+ lex >> par;
+ string tmp;
+ par = split(par, tmp, ',');
+ while (!tmp.empty()) {
+ extraEmbeddedFiles().push_back(tmp);
+ par = split(par, tmp, ',');
+ }
} else {
lyxerr << "BufferParams::readToken(): Unknown token: " <<
token << endl;
// Prints out the buffer info into the .lyx file given by file
// the textclass
- os << "\\textclass " << textclasslist[baseClass_].name() << '\n';
+ os << "\\textclass " << baseClass()->name() << '\n';
// then the preamble
if (!preamble.empty()) {
os << "\\end_modules" << '\n';
}
+ // local layout information
+ if (!local_layout.empty()) {
+ // remove '\n' from the end
+ string const tmplocal = rtrim(local_layout, "\n");
+ os << "\\begin_local_layout\n"
+ << tmplocal
+ << "\n\\end_local_layout\n";
+ }
+
// then the text parameters
if (language != ignore_language)
os << "\\language " << language->lang() << '\n';
if (!footskip.empty())
os << "\\footskip "
<< VSpace(footskip).asLyXCommand() << '\n';
+ if (!columnsep.empty())
+ os << "\\columnsep "
+ << VSpace(columnsep).asLyXCommand() << '\n';
os << "\\secnumdepth " << secnumdepth
<< "\n\\tocdepth " << tocdepth
<< "\n\\paragraph_separation "
else
os << "\\author " << Author() << "\n";
}
+
+ vector<string>::const_iterator e_it = extraEmbeddedFiles().begin();
+ vector<string>::const_iterator e_end = extraEmbeddedFiles().end();
+ os << "\\extra_embedded_files \"";
+ bool first = true;
+ for (; e_it != e_end; ++e_it) {
+ if (!first)
+ os << ",";
+ else
+ first = false;
+ os << *e_it;
+ }
+ os << "\"\n";
}
void BufferParams::validate(LaTeXFeatures & features) const
{
+ features.require(documentClass().requires());
+
if (outputChanges) {
bool dvipost = LaTeXFeatures::isAvailable("dvipost");
bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
// AMS Style is at document level
if (use_amsmath == package_on
- || getTextClass().provides("amsmath"))
+ || documentClass().provides("amsmath"))
features.require("amsmath");
if (use_esint == package_on)
features.require("esint");
+ // Document-level line spacing
+ if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
+ features.require("setspace");
+
// the bullet shapes are buffer level not paragraph level
// so they are tested here
for (int i = 0; i < 4; ++i) {
features.require("pifont");
}
}
+
+ if (pdfoptions().use_hyperref)
+ features.require("hyperref");
}
{
os << "\\documentclass";
- TextClass const & tclass = getTextClass();
+ DocumentClass const & tclass = documentClass();
ostringstream clsoptions; // the document class options.
os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
if (!footskip.empty())
os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
+ if (!columnsep.empty())
+ os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
os << "}\n";
texrow.newline();
}
// The optional packages;
docstring lyxpreamble(from_ascii(features.getPackages()));
+ // Line spacing
+ lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
+
// 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.
// hyperref, see
// http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
if (language->lang() == "japanese-plain" &&
- !getTextClass().provides("japanese")) {
+ !documentClass().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";
// 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();
+ if (features.isRequired("hyperref")) {
+ odocstringstream oss;
+ pdfoptions().writeLaTeX(oss, documentClass().provides("hyperref"));
+ lyxpreamble += oss.str();
+ }
// this might be useful...
lyxpreamble += "\n\\makeatletter\n";
void BufferParams::useClassDefaults()
{
- TextClass const & tclass = textclasslist[baseClass_];
+ DocumentClass const & tclass = documentClass();
sides = tclass.sides();
columns = tclass.columns();
bool BufferParams::hasClassDefaults() const
{
- TextClass const & tclass = textclasslist[baseClass_];
+ DocumentClass const & tclass = documentClass();
- return (sides == tclass.sides()
+ return sides == tclass.sides()
&& columns == tclass.columns()
&& pagestyle == tclass.pagestyle()
&& options == tclass.options()
&& secnumdepth == tclass.secnumdepth()
- && tocdepth == tclass.tocdepth());
+ && tocdepth == tclass.tocdepth();
}
-TextClass const & BufferParams::getTextClass() const
+DocumentClass const & BufferParams::documentClass() const
{
- return *textClass_;
+ return *doc_class_;
}
-TextClassPtr BufferParams::getTextClassPtr() const {
- return textClass_;
+DocumentClass * BufferParams::documentClassPtr() const {
+ return doc_class_;
}
-void BufferParams::setTextClass(TextClassPtr tc) {
- textClass_ = tc;
+void BufferParams::setDocumentClass(DocumentClass const * const tc) {
+ // evil, but this function is evil
+ doc_class_ = const_cast<DocumentClass *>(tc);
}
-bool BufferParams::setBaseClass(textclass_type tc)
+bool BufferParams::setBaseClass(string const & classname)
{
- bool retVal = true;
- if (textclasslist[tc].load())
- baseClass_ = tc;
- else {
+ LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
+ LayoutFileList const & bcl = LayoutFileList::get();
+ if (!bcl.haveClass(classname)) {
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;
+ bformat(_("The document class %1$s could not be found."),
+ from_utf8(classname));
+ frontend::Alert::error(_("Class not found"), s);
+ return false;
}
- makeTextClass();
- return retVal;
+
+ if (bcl[classname].load()) {
+ pimpl_->baseClass_ = classname;
+ return true;
+ }
+
+ 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;
}
-void BufferParams::setJustBaseClass(textclass_type tc)
-{
- baseClass_ = tc;
+LayoutFile const * BufferParams::baseClass() const
+{
+ if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
+ return &(LayoutFileList::get()[pimpl_->baseClass_]);
+ else
+ return 0;
}
-textclass_type BufferParams::getBaseClass() const
+LayoutFileIndex const & BufferParams::baseClassID() const
{
- return baseClass_;
+ return pimpl_->baseClass_;
}
-void BufferParams::makeTextClass()
+void BufferParams::makeDocumentClass()
{
- textClass_.reset(new TextClass(textclasslist[getBaseClass()]));
+ 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.
"probably 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 " <<
+ lyxerr << "BufferParams::makeDocumentClass(): Module " <<
modName << " requested but not found in module list." <<
endl;
continue;
}
- FileName layout_file = libFileSearch("layouts", lm->filename);
- textClass_->read(layout_file, TextClass::MODULE);
+ 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");
+ frontend::Alert::warning(_("Read Error"), msg);
+ }
}
}
-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(vector<string>modNames)
+void BufferParams::clearLayoutModules()
{
- bool retval = true;
- vector<string>::const_iterator it = modNames.begin();
- 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
{
- FontInfo f = getTextClass().defaultfont();
+ FontInfo f = documentClass().defaultfont();
if (fontsDefaultFamily == "rmdefault")
f.setFamily(ROMAN_FAMILY);
else if (fontsDefaultFamily == "sfdefault")
}
+void BufferParams::readLocalLayout(Lexer & lex)
+{
+ if (lex.getString() != "\\begin_local_layout")
+ lyxerr << "Error (BufferParams::readLocalLayout):"
+ "consistency check failed." << endl;
+
+ local_layout = lex.getLongString("\\end_local_layout");
+}
+
+
void BufferParams::readLanguage(Lexer & lex)
{
if (!lex.next()) return;
void BufferParams::readGraphicsDriver(Lexer & lex)
{
- if (!lex.next()) return;
+ if (!lex.next())
+ return;
string const tmptok = lex.getString();
// check if tmptok is part of tex_graphics in tex_defs.h
void BufferParams::readBullets(Lexer & lex)
{
- if (!lex.next()) return;
+ if (!lex.next())
+ return;
int const index = lex.getInteger();
lex.next();
void BufferParams::readBulletsLaTeX(Lexer & lex)
{
// The bullet class should be able to read this.
- if (!lex.next()) return;
+ if (!lex.next())
+ return;
int const index = lex.getInteger();
lex.next(true);
docstring const temp_str = lex.getDocString();
}
-string const BufferParams::paperSizeName() const
+string BufferParams::paperSizeName(PapersizePurpose purpose) const
{
char real_papersize = papersize;
if (real_papersize == PAPER_DEFAULT)
real_papersize = lyxrc.default_papersize;
switch (real_papersize) {
+ case PAPER_DEFAULT:
+ // could be anything, so don't guess
+ return string();
+ case PAPER_CUSTOM: {
+ if (purpose == XDVI && !paperwidth.empty() &&
+ !paperheight.empty()) {
+ // heightxwidth<unit>
+ string first = paperwidth;
+ string second = paperheight;
+ if (orientation == ORIENTATION_LANDSCAPE)
+ first.swap(second);
+ // cut off unit.
+ return first.erase(first.length() - 2)
+ + "x" + second;
+ }
+ return string();
+ }
case PAPER_A3:
return "a3";
case PAPER_A4:
return "a4";
case PAPER_A5:
return "a5";
+ case PAPER_B3:
+ // dvips and dvipdfm do not know this
+ if (purpose == DVIPS || purpose == DVIPDFM)
+ return string();
+ return "b3";
+ case PAPER_B4:
+ // dvipdfm does not know this
+ if (purpose == DVIPDFM)
+ return string();
+ return "b4";
case PAPER_B5:
+ // dvipdfm does not know this
+ if (purpose == DVIPDFM)
+ return string();
return "b5";
case PAPER_USEXECUTIVE:
+ // dvipdfm does not know this
+ if (purpose == DVIPDFM)
+ return string();
return "foolscap";
case PAPER_USLEGAL:
return "legal";
case PAPER_USLETTER:
default:
+ if (purpose == XDVI)
+ return "us";
return "letter";
}
}
result += ' ' + paperwidth;
result += ',' + paperheight;
} else {
- string const paper_option = paperSizeName();
- if (paper_option != "letter" ||
- orientation != ORIENTATION_LANDSCAPE) {
+ string const paper_option = paperSizeName(DVIPS);
+ if (!paper_option.empty() && (paper_option != "letter" ||
+ orientation != ORIENTATION_LANDSCAPE)) {
// dvips won't accept -t letter -t landscape.
// In all other cases, include the paper size
// explicitly.
}
-string const BufferParams::babelCall(string const & lang_opts) const
+string BufferParams::babelCall(string const & lang_opts) const
{
string lang_pack = lyxrc.language_package;
if (lang_pack != "\\usepackage{babel}")
else if (tt == "courier" )
os << "\\usepackage{" << tt << "}\n";
// Computer Modern, Latin Modern, CM Bright
- else if (tt != "default")
+ else if (tt != "default")
os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
return os.str();
Encoding const & BufferParams::encoding() const
{
if (inputenc == "auto" || inputenc == "default")
- return *(language->encoding());
- Encoding const * const enc =
- encodings.getFromLaTeXName(inputenc);
+ return *language->encoding();
+ Encoding const * const enc = encodings.fromLaTeXName(inputenc);
if (enc)
return *enc;
- lyxerr << "Unknown inputenc value `" << inputenc
- << "'. Using `auto' instead." << endl;
- return *(language->encoding());
+ LYXERR0("Unknown inputenc value `" << inputenc
+ << "'. Using `auto' instead.");
+ return *language->encoding();
}
-biblio::CiteEngine BufferParams::getEngine() const
+biblio::CiteEngine BufferParams::citeEngine() const
{
// FIXME the class should provide the numerical/
// authoryear choice
- if (getTextClass().provides("natbib")
+ if (documentClass().provides("natbib")
&& cite_engine_ != biblio::ENGINE_NATBIB_NUMERICAL)
return biblio::ENGINE_NATBIB_AUTHORYEAR;
return cite_engine_;
}
-void BufferParams::setCiteEngine(biblio::CiteEngine const cite_engine)
+void BufferParams::setCiteEngine(biblio::CiteEngine cite_engine)
{
cite_engine_ = cite_engine;
}
projects / lyx.git / blobdiff