]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.cpp
After a hiatus, I'm returning to the rewrite of InsetCommandParams, the purpose of...
[lyx.git] / src / BufferParams.cpp
index 11145b8189424076579b679df22ec667744476da..0ab1d830881a425cd7d71ede999f70a914d9b90a 100644 (file)
@@ -283,11 +283,16 @@ public:
         */
        VSpace defskip;
        PDFOptions pdfoptions;
+
+       /// the base TextClass associated with the document
+       TextClassIndex baseClass_;
+       /// the possibly modular TextClass actually in use
+       TextClassIndex textClass_;
 };
 
 
 BufferParams::Impl::Impl()
-       : defskip(VSpace::MEDSKIP)
+       : defskip(VSpace::MEDSKIP), baseClass_(0), textClass_(0)
 {
        // set initial author
        // FIXME UNICODE
@@ -314,6 +319,7 @@ BufferParams::BufferParams()
        : pimpl_(new Impl)
 {
        setBaseClass(defaultTextclass());
+       makeTextClass();
        paragraph_separation = PARSEP_INDENT;
        quotes_language = InsetQuotes::EnglishQ;
        fontsize = "default";
@@ -461,8 +467,8 @@ string const BufferParams::readToken(Lexer & lex, string const & token,
                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));
+               pair<bool, TextClassIndex> pp =
+                       make_pair(false, TextClassIndex(0));
                if (!filepath.empty())
                        pp = textclasslist.addTextClass(
                                classname, filepath.absFilename());
@@ -481,7 +487,7 @@ string const BufferParams::readToken(Lexer & lex, string const & token,
                // 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 (!textClass().isTeXClassAvailable()) {
                        docstring const msg =
                                bformat(_("The layout file requested by this document,\n"
                                                 "%1$s.layout,\n"
@@ -497,7 +503,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();
@@ -529,7 +534,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;
@@ -615,6 +624,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") {
@@ -671,7 +682,7 @@ void BufferParams::writeFile(ostream & os) const
        // Prints out the buffer info into the .lyx file given by file
 
        // the textclass
-       os << "\\textclass " << textclasslist[baseClass_].name() << '\n';
+       os << "\\textclass " << textClass().name() << '\n';
 
        // then the preamble
        if (!preamble.empty()) {
@@ -764,6 +775,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 "
@@ -810,6 +824,8 @@ 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") &&
@@ -849,12 +865,15 @@ void BufferParams::validate(LaTeXFeatures & features) const
                features.require("float");
 
        // AMS Style is at document level
-       if (use_amsmath == package_on
-           || getTextClass().provides("amsmath"))
+       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) {
@@ -876,6 +895,9 @@ void BufferParams::validate(LaTeXFeatures & features) const
                        features.require("pifont");
                }
        }
+
+       if (pdfoptions().use_hyperref)
+               features.require("hyperref");
 }
 
 
@@ -884,8 +906,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
 {
        os << "\\documentclass";
 
-       TextClass const & tclass = getTextClass();
-
+       TextClass const & tclass = textClass(); 
        ostringstream clsoptions; // the document class options.
 
        if (tokenPos(tclass.opt_fontsize(),
@@ -1126,6 +1147,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();
        }
@@ -1195,6 +1218,9 @@ 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.
@@ -1220,7 +1246,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        // hyperref, see
        // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
        if (language->lang() == "japanese-plain" &&
-               !getTextClass().provides("japanese")) {
+               !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";
@@ -1235,10 +1261,12 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        //   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, textClass().provides("hyperref"));
+               lyxpreamble += oss.str();
+       }
 
        // this might be useful...
        lyxpreamble += "\n\\makeatletter\n";
@@ -1318,7 +1346,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
 
 void BufferParams::useClassDefaults()
 {
-       TextClass const & tclass = textclasslist[baseClass_];
+       TextClass const & tclass = textclasslist[pimpl_->baseClass_];
 
        sides = tclass.sides();
        columns = tclass.columns();
@@ -1334,65 +1362,60 @@ void BufferParams::useClassDefaults()
 
 bool BufferParams::hasClassDefaults() const
 {
-       TextClass const & tclass = textclasslist[baseClass_];
+       TextClass const & tclass = textclasslist[pimpl_->baseClass_];
 
-       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
+TextClass const & BufferParams::textClass() const
 {
-       return *textClass_;
+       return textclasslist[pimpl_->textClass_];
 }
 
 
-TextClassPtr BufferParams::getTextClassPtr() const {
-       return textClass_;
+TextClassIndex BufferParams::textClassIndex() const
+{
+       return pimpl_->textClass_;
 }
 
 
-void BufferParams::setTextClass(TextClassPtr tc) {
-       textClass_ = tc;
+void BufferParams::setTextClass(TextClassIndex const & tc)
+{
+       pimpl_->textClass_ = tc;
 }
 
 
-bool BufferParams::setBaseClass(textclass_type tc)
+bool BufferParams::setBaseClass(TextClassIndex const & tc)
 {
-       bool retVal = true;
-       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;
+       if (textclasslist[tc].load()) {
+               pimpl_->baseClass_ = tc;
+               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;
 }
 
 
-textclass_type BufferParams::getBaseClass() const
+TextClassIndex BufferParams::baseClass() const
 {
-       return baseClass_;
+       return pimpl_->baseClass_;
 }
 
 
 void BufferParams::makeTextClass()
 {
-       textClass_.reset(new TextClass(textclasslist[getBaseClass()]));
+       pimpl_->textClass_ = 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.
@@ -1413,19 +1436,32 @@ void BufferParams::makeTextClass()
                                        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 (!textclasslist.at(pimpl_->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);
+               }
        }
 }
 
 
-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++) {
@@ -1435,33 +1471,19 @@ 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(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 = textClass().defaultfont();
        if (fontsDefaultFamily == "rmdefault")
                f.setFamily(ROMAN_FAMILY);
        else if (fontsDefaultFamily == "sfdefault")
@@ -1502,7 +1524,8 @@ void BufferParams::readLanguage(Lexer & lex)
 
 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
@@ -1526,7 +1549,8 @@ void BufferParams::readGraphicsDriver(Lexer & lex)
 
 void BufferParams::readBullets(Lexer & lex)
 {
-       if (!lex.next()) return;
+       if (!lex.next())
+               return;
 
        int const index = lex.getInteger();
        lex.next();
@@ -1545,7 +1569,8 @@ void BufferParams::readBullets(Lexer & lex)
 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();
@@ -1572,27 +1597,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<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";
        }
 }
@@ -1612,9 +1672,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.
@@ -1873,7 +1933,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_;