]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.cpp
do what the FIXME suggested
[lyx.git] / src / BufferParams.cpp
index 757ec2a35c8a2b93588af17493bb045303bae641..7c84bfa21f4d4afb52f41286c7501f85c299cc5c 100644 (file)
@@ -18,6 +18,7 @@
 #include "BufferParams.h"
 
 #include "Author.h"
+#include "BaseClassList.h"
 #include "BranchList.h"
 #include "buffer_funcs.h"
 #include "Bullet.h"
@@ -29,7 +30,6 @@
 #include "Font.h"
 #include "Lexer.h"
 #include "LyXRC.h"
-#include "TextClassList.h"
 #include "OutputParams.h"
 #include "Spacing.h"
 #include "TexRow.h"
@@ -283,11 +283,12 @@ public:
         */
        VSpace defskip;
        PDFOptions pdfoptions;
+       LayoutFileIndex baseClass_;
 };
 
 
 BufferParams::Impl::Impl()
-       : defskip(VSpace::MEDSKIP)
+       : defskip(VSpace::MEDSKIP), baseClass_(string(""))
 {
        // set initial author
        // FIXME UNICODE
@@ -313,8 +314,8 @@ void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
 BufferParams::BufferParams()
        : pimpl_(new Impl)
 {
-       setBaseClass(defaultTextclass());
-       makeTextClass();
+       setBaseClass(defaultBaseclass());
+       makeDocumentClass();
        paragraph_separation = PARSEP_INDENT;
        quotes_language = InsetQuotes::EnglishQ;
        fontsize = "default";
@@ -462,27 +463,23 @@ 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));
+               string tcp;
+               BaseClassList & bcl = BaseClassList::get();
                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;
-                       }
+                       tcp = bcl.addLayoutFile(classname, filepath.absFilename());
+               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"
@@ -529,7 +526,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 +616,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 +674,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 " << baseClass()->name() << '\n';
 
        // then the preamble
        if (!preamble.empty()) {
@@ -764,6 +767,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,13 +816,7 @@ void BufferParams::writeFile(ostream & os) const
 
 void BufferParams::validate(LaTeXFeatures & features) const
 {
-       if (!getTextClass().requires().empty()) {
-               vector<string> req = getTextClass().requires();
-               for (vector<string>::const_iterator it = req.begin();
-                    it != req.end(); ++it) {
-                       features.require(*it);
-               }
-       }
+       features.require(documentClass().requires());
 
        if (outputChanges) {
                bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
@@ -858,7 +858,7 @@ void BufferParams::validate(LaTeXFeatures & features) const
 
        // 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");
@@ -899,7 +899,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
 {
        os << "\\documentclass";
 
-       TextClass const & tclass = getTextClass();
+       DocumentClass const & tclass = documentClass();
 
        ostringstream clsoptions; // the document class options.
 
@@ -1141,6 +1141,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();
        }
@@ -1238,7 +1240,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")) {
+               !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";
@@ -1254,15 +1256,9 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        // * Has to be loaded before the "LyX specific LaTeX commands" to
        //   avoid errors with algorithm floats.
        // use hyperref explicitely when it is required
-       /** FIXME: If the textclass provides hyperref, the GUI is
-           non-functional. To fix this, we would need requires("hyperref")
-           below, pass getTextClass().provides("hyperref") to
-           pdfoptions().writeLaTeX(oss) and load the options via
-           \hypersetup instead of tha package's optional argument.
-       **/
-       if (features.mustProvide("hyperref")) {
+       if (features.isRequired("hyperref")) {
                odocstringstream oss;
-               pdfoptions().writeLaTeX(oss);
+               pdfoptions().writeLaTeX(oss, documentClass().provides("hyperref"));
                lyxpreamble += oss.str();
        }
 
@@ -1344,7 +1340,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
 
 void BufferParams::useClassDefaults()
 {
-       TextClass const & tclass = textclasslist[baseClass_];
+       DocumentClass const & tclass = documentClass();
 
        sides = tclass.sides();
        columns = tclass.columns();
@@ -1360,57 +1356,80 @@ void BufferParams::useClassDefaults()
 
 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)
 {
-       if (textclasslist[tc].load()) {
-               baseClass_ = tc;
+       LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
+       BaseClassList const & bcl = BaseClassList::get();
+       if (!bcl.haveClass(classname)) {
+               docstring s = 
+                       bformat(_("The document class %1$s could not be found."),
+                       from_utf8(classname));
+               frontend::Alert::error(_("Class not found"), s);
+               return false;
+       }
+
+       if (bcl[classname].load()) {
+               pimpl_->baseClass_ = classname;
                return true;
        }
        
        docstring s = 
                bformat(_("The document class %1$s could not be loaded."),
-               from_utf8(textclasslist[tc].name()));
+               from_utf8(classname));
        frontend::Alert::error(_("Could not load class"), s);
        return false;
 }
 
 
-textclass_type BufferParams::getBaseClass() const
+LayoutFile const * BufferParams::baseClass() const
 {
-       return baseClass_;
+       if (BaseClassList::get().haveClass(pimpl_->baseClass_))
+               return &(BaseClassList::get()[pimpl_->baseClass_]);
+       else 
+               return 0;
 }
 
 
-void BufferParams::makeTextClass()
+LayoutFileIndex const & BufferParams::baseClassID() const
 {
-       textClass_.reset(new TextClass(textclasslist[getBaseClass()]));
+       return pimpl_->baseClass_;
+}
+
+
+void BufferParams::makeDocumentClass()
+{
+       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 
@@ -1427,7 +1446,7 @@ void BufferParams::makeTextClass()
                                        "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;
@@ -1440,18 +1459,24 @@ void BufferParams::makeTextClass()
                        frontend::Alert::warning(_("Package not available"), msg);
                }
                FileName layout_file = libFileSearch("layouts", lm->getFilename());
-               textClass_->read(layout_file, TextClass::MODULE);
+               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);
+               }
        }
 }
 
 
-vector<string> const & BufferParams::getModules() const {
+vector<string> const & BufferParams::getModules() const 
+{
        return layoutModules_;
 }
 
 
 
-bool BufferParams::addLayoutModule(string const & modName) {
+bool BufferParams::addLayoutModule(string const & modName) 
+{
        LayoutModuleList::const_iterator it = layoutModules_.begin();
        LayoutModuleList::const_iterator end = layoutModules_.end();
        for (; it != end; it++) {
@@ -1465,14 +1490,15 @@ bool BufferParams::addLayoutModule(string const & modName) {
 }
 
 
-void BufferParams::clearLayoutModules() {
+void BufferParams::clearLayoutModules() 
+{
        layoutModules_.clear();
 }
 
 
 Font const BufferParams::getFont() const
 {
-       FontInfo f = getTextClass().defaultfont();
+       FontInfo f = documentClass().defaultfont();
        if (fontsDefaultFamily == "rmdefault")
                f.setFamily(ROMAN_FAMILY);
        else if (fontsDefaultFamily == "sfdefault")
@@ -1513,7 +1539,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
@@ -1537,7 +1564,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();
@@ -1556,7 +1584,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();
@@ -1583,27 +1612,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";
        }
 }
@@ -1623,9 +1687,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.
@@ -1884,7 +1948,7 @@ biblio::CiteEngine BufferParams::getEngine() 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_;