X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.cpp;h=6355dbcc6729d3f5a439c50f33936d5c6a260963;hb=0362c6aae73c293d1c20277c12d362acfe0b2ef6;hp=c18e9b9e7db0a7694898e5a92f3e20e8dddbe362;hpb=d7a33bc841e75fb746778f937336bc347fb32d8a;p=lyx.git diff --git a/src/BufferParams.cpp b/src/BufferParams.cpp index c18e9b9e7d..6355dbcc67 100644 --- a/src/BufferParams.cpp +++ b/src/BufferParams.cpp @@ -21,14 +21,11 @@ #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" @@ -37,32 +34,27 @@ #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 +#include "support/lstrings.h" #include #include -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[] = { @@ -145,7 +137,7 @@ QuotesLangTranslator const & quoteslangtranslator() // Paper size -typedef Translator PaperSizeTranslator; +typedef Translator PaperSizeTranslator; PaperSizeTranslator const init_papersizetranslator() @@ -192,13 +184,13 @@ PaperOrientationTranslator const & paperorientationtranslator() // Page sides -typedef Translator SidesTranslator; +typedef Translator 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; } @@ -283,13 +275,14 @@ public: AuthorList authorlist; BranchList branchlist; - boost::array temp_bullets; - boost::array 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; }; @@ -321,6 +314,7 @@ BufferParams::BufferParams() : pimpl_(new Impl) { setBaseClass(defaultTextclass()); + makeTextClass(); paragraph_separation = PARSEP_INDENT; quotes_language = InsetQuotes::EnglishQ; fontsize = "default"; @@ -348,7 +342,7 @@ BufferParams::BufferParams() fontsTypewriterScale = 100; inputenc = "auto"; graphicsDriver = "default"; - sides = TextClass::OneSide; + sides = OneSide; columns = 1; listings_params = string(); pagestyle = "default"; @@ -436,6 +430,18 @@ Spacing const & BufferParams::spacing() const } +PDFOptions & BufferParams::pdfoptions() +{ + return pimpl_->pdfoptions; +} + + +PDFOptions const & BufferParams::pdfoptions() const +{ + return pimpl_->pdfoptions; +} + + VSpace const & BufferParams::getDefSkip() const { return pimpl_->defskip; @@ -448,26 +454,35 @@ void BufferParams::setDefSkip(VSpace const & vs) } -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 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; } } - if (!getTextClass().isTeXClassAvailable()) { + // 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 (!textClass().isTeXClassAvailable()) { docstring const msg = bformat(_("The layout file requested by this document,\n" "%1$s.layout,\n" @@ -483,7 +498,6 @@ string const BufferParams::readToken(Lexer & lex, string const & token) readPreamble(lex); } else if (token == "\\begin_modules") { readModules(lex); - makeTextClass(); } else if (token == "\\options") { lex.eatLine(); options = lex.getString(); @@ -515,7 +529,11 @@ string const BufferParams::readToken(Lexer & lex, string const & token) 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; @@ -567,7 +585,7 @@ string const BufferParams::readToken(Lexer & lex, string const & token) 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); @@ -601,6 +619,8 @@ string const BufferParams::readToken(Lexer & lex, string const & token) lex >> headsep; } else if (token == "\\footskip") { lex >> footskip; + } else if (token == "\\columnsep") { + lex >> columnsep; } else if (token == "\\paperfontsize") { lex >> fontsize; } else if (token == "\\papercolumns") { @@ -633,6 +653,14 @@ string const BufferParams::readToken(Lexer & lex, string const & token) 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; @@ -694,6 +722,7 @@ void BufferParams::writeFile(ostream & os) const os << "\\paperfontsize " << fontsize << '\n'; spacing().writeFile(os); + pdfoptions().writeFile(os); os << "\\papersize " << string_papersize[papersize] << "\n\\use_geometry " << convert(use_geometry) @@ -741,6 +770,9 @@ void BufferParams::writeFile(ostream & os) const 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 " @@ -785,12 +817,92 @@ void BufferParams::writeFile(ostream & os) const } +void BufferParams::validate(LaTeXFeatures & features) const +{ + features.require(textClass().requires()); + + 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 + || textClass().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) { + 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"); + } + } + + if (pdfoptions().use_hyperref) + features.require("hyperref"); +} + + bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features, TexRow & texrow) const { os << "\\documentclass"; - TextClass const & tclass = getTextClass(); + TextClass const & tclass = textClass(); ostringstream clsoptions; // the document class options. @@ -838,10 +950,10 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features, // if needed if (sides != tclass.sides()) { switch (sides) { - case TextClass::OneSide: + case OneSide: clsoptions << "oneside,"; break; - case TextClass::TwoSides: + case TwoSides: clsoptions << "twoside,"; break; } @@ -874,7 +986,13 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features, 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() << ','; } @@ -1026,6 +1144,8 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features, 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(); } @@ -1095,6 +1215,56 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features, // 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. + // 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" && + !textClass().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. + // use hyperref explicitely when it is required + if (features.isRequired("hyperref")) { + odocstringstream oss; + pdfoptions().writeLaTeX(oss, textClass().provides("hyperref")); + lyxpreamble += oss.str(); + } + // this might be useful... lyxpreamble += "\n\\makeatletter\n"; @@ -1158,15 +1328,6 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features, 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 = @@ -1209,41 +1370,34 @@ bool BufferParams::hasClassDefaults() const } -TextClass const & BufferParams::getTextClass() const +TextClass const & BufferParams::textClass() const { return *textClass_; } -TextClass_ptr BufferParams::getTextClass_ptr() const { +TextClassPtr BufferParams::textClassPtr() const { return textClass_; } -void BufferParams::setTextClass(TextClass_ptr tc) { +void BufferParams::setTextClass(TextClassPtr tc) { textClass_ = tc; } bool BufferParams::setBaseClass(textclass_type tc) { - if (!textclasslist[tc].load()) { - 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; + if (textclasslist[tc].load()) { + baseClass_ = tc; + return true; } - baseClass_ = tc; - makeTextClass(); - return true; -} - - -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; } @@ -1256,38 +1410,51 @@ textclass_type BufferParams::getBaseClass() const void BufferParams::makeTextClass() { textClass_.reset(new TextClass(textclasslist[getBaseClass()])); + //FIXME It might be worth loading the children's modules here, - //instead of just doing a check in InsetInclude. + //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)); + 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); - 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 (!textClass_->read(layout_file, TextClass::MODULE)) { + docstring const msg = + bformat(_("Error reading module %1$s\n"), from_utf8(modName)); + frontend::Alert::warning(_("Read Error"), msg); + } } } -std::vector const & BufferParams::getModules() const { +vector 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++) { @@ -1297,41 +1464,25 @@ bool BufferParams::addLayoutModule(string modName, bool makeClass) { if (it != layoutModules_.end()) return false; layoutModules_.push_back(modName); - if (makeClass) - makeTextClass(); return true; } -bool BufferParams::addLayoutModules(std::vectormodNames) -{ - bool retval = true; - std::vector::const_iterator it = modNames.begin(); - std::vector::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 = textClass().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); } @@ -1435,27 +1586,62 @@ void BufferParams::readModules(Lexer & lex) } -string const BufferParams::paperSizeName() const +string const BufferParams::paperSizeName(Papersize_Purpose const & 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 + 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"; } } @@ -1475,9 +1661,9 @@ string const BufferParams::dvips_options() const 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. @@ -1502,7 +1688,12 @@ string const BufferParams::babelCall(string const & lang_opts) const // 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; } @@ -1519,13 +1710,20 @@ void BufferParams::writeEncodingPreamble(odocstream & os, // Create a list with all the input encodings used // in the document - std::set encodings = + set 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::const_iterator it = encodings.begin(); - std::set::const_iterator const end = encodings.end(); + set::const_iterator it = encodings.begin(); + set::const_iterator const end = encodings.end(); if (it != end) { os << from_ascii(*it); ++it; @@ -1540,7 +1738,7 @@ void BufferParams::writeEncodingPreamble(odocstream & os, os << "]{inputenc}\n"; texrow.newline(); } - if (package == Encoding::CJK) { + if (package == Encoding::CJK || features.mustProvide("CJK")) { os << "\\usepackage{CJK}\n"; texrow.newline(); } @@ -1724,7 +1922,7 @@ biblio::CiteEngine BufferParams::getEngine() const { // FIXME the class should provide the numerical/ // authoryear choice - if (getTextClass().provides("natbib") + if (textClass().provides("natbib") && cite_engine_ != biblio::ENGINE_NATBIB_NUMERICAL) return biblio::ENGINE_NATBIB_AUTHORYEAR; return cite_engine_;