]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.cpp
* Call metrics of the parameters with the correct font in MathMacros, for example
[lyx.git] / src / BufferParams.cpp
index e470adf1faefaf69cfadf5b30c95de05cf8c1ce6..65fd6ab3a4048d6fb8810e6df4502860a37d1d4f 100644 (file)
@@ -84,8 +84,11 @@ static char const * const string_footnotekinds[] = {
 
 
 static char const * const tex_graphics[] = {
-       "default", "dvips", "dvitops", "emtex",
-       "ln", "oztex", "textures", "none", ""
+       "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
+       "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
+       "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
+       "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
+       "xetex", "none", ""
 };
 
 
@@ -332,6 +335,7 @@ BufferParams::BufferParams()
        use_bibtopic = false;
        trackChanges = false;
        outputChanges = false;
+       use_default_options = true;
        secnumdepth = 3;
        tocdepth = 3;
        language = default_language;
@@ -492,6 +496,8 @@ string BufferParams::readToken(Lexer & lex, string const & token,
        } else if (token == "\\options") {
                lex.eatLine();
                options = lex.getString();
+       } else if (token == "\\use_default_options") {
+               lex >> use_default_options;
        } else if (token == "\\master") {
                lex.eatLine();
                master = lex.getString();
@@ -689,6 +695,10 @@ void BufferParams::writeFile(ostream & os) const
                os << "\\options " << options << '\n';
        }
 
+       // use the class options defined in the layout?
+       os << "\\use_default_options " 
+          << convert<string>(use_default_options) << "\n";
+
        // the master document
        if (!master.empty()) {
                os << "\\master " << master << '\n';
@@ -761,9 +771,9 @@ void BufferParams::writeFile(ostream & os) const
        BranchList::const_iterator it = branchlist().begin();
        BranchList::const_iterator end = branchlist().end();
        for (; it != end; ++it) {
-               os << "\\branch " << to_utf8(it->getBranch())
-                  << "\n\\selected " << it->getSelected()
-                  << "\n\\color " << lyx::X11hexname(it->getColor())
+               os << "\\branch " << to_utf8(it->branch())
+                  << "\n\\selected " << it->isSelected()
+                  << "\n\\color " << lyx::X11hexname(it->color())
                   << "\n\\end_branch"
                   << "\n";
        }
@@ -917,8 +927,14 @@ void BufferParams::validate(LaTeXFeatures & features) const
                }
        }
 
-       if (pdfoptions().use_hyperref)
+       if (pdfoptions().use_hyperref) {
                features.require("hyperref");
+               // due to interferences with babel and hyperref, the color package has to
+               // be loaded after hyperref when hyperref is used with the colorlinks
+               // option, see http://bugzilla.lyx.org/show_bug.cgi?id=5291
+               if (pdfoptions().colorlinks)
+                       features.require("color");
+       }
 
        if (language->lang() == "vietnamese")
                features.require("vietnamese");
@@ -1021,17 +1037,27 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
                // 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
+               // the same is for all other languages that are not directly supported by
+               // babel, but where LaTeX-packages add babel support.
+               // this is currently the case for Latvian, Lithuanian, and Mongolian
+               size_t latvian = language_options.str().find("latvian");
+               size_t lithu = language_options.str().find("lithuanian");
+               size_t mongo = language_options.str().find("mongolian");
                // if Japanese is used, babel must directly be loaded
                // with language options, not in the class options, see
                // http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
                size_t japan = language_options.str().find("japanese");
-               // japan = string::npos when not found
-               if (lyxrc.language_global_options
-                       && !language_options.str().empty()
-                       && viet == string::npos && japan == string::npos)
+               if (lyxrc.language_global_options && !language_options.str().empty()
+                       && viet == string::npos && japan == string::npos
+                       && latvian == string::npos && lithu == string::npos
+                       && mongo == string::npos)
                        clsoptions << language_options.str() << ',';
        }
 
+       // the predefined options from the layout
+       if (use_default_options && !tclass.options().empty())
+               clsoptions << tclass.options() << ',';
+
        // the user-defined options
        if (!options.empty()) {
                clsoptions << options << ',';
@@ -1081,15 +1107,20 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        // handle inputenc etc.
        writeEncodingPreamble(os, features, texrow);
 
-       if (!listings_params.empty()) {
+       if (!listings_params.empty() || features.isRequired("listings")) {
                os << "\\usepackage{listings}\n";
                texrow.newline();
+       }
+       if (!listings_params.empty()) {
                os << "\\lstset{";
                // do not test validity because listings_params is 
                // supposed to be valid
                string par =
                        InsetListingsParams(listings_params).separatedParams(true);
-               os << from_ascii(par);
+               // we can't support all packages, but we should load the color package
+               if (par.find("\\color", 0) != string::npos)
+                       features.require("color");
+               os << from_utf8(par);
                // count the number of newlines
                for (size_t i = 0; i < par.size(); ++i)
                        if (par[i] == '\n')
@@ -1244,23 +1275,30 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
                texrow.newline();
        }
 
-       // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel here.
+       // Now insert the LyX specific LaTeX commands...
+       docstring lyxpreamble;
+
+       // due to interferences with babel and hyperref, the color package has to
+       // be loaded (when it is not already loaded) before babel when hyperref
+       // is used with the colorlinks option, see
+       // http://bugzilla.lyx.org/show_bug.cgi?id=5291
+       // we decided therefore to load color always before babel, see
+       // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
+       lyxpreamble += from_ascii(features.getColorOptions());
+       
+       // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
        if (use_babel
                && (features.isRequired("jurabib")
                        || features.isRequired("hyperref")
                        || features.isRequired("vietnamese")
                        || features.isRequired("japanese") ) ) {
-               // FIXME UNICODE
-               os << from_utf8(babelCall(language_options.str()))
-                  << '\n'
-                  << from_utf8(features.getBabelOptions());
-               texrow.newline();
+                               // FIXME UNICODE
+                               lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
+                               lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
        }
 
-       // Now insert the LyX specific LaTeX commands...
-
        // The optional packages;
-       docstring lyxpreamble(from_ascii(features.getPackages()));
+       lyxpreamble += from_ascii(features.getPackages());
 
        // Line spacing
        lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
@@ -1268,7 +1306,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        // 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."
+       //   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
@@ -1279,7 +1317,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
                pdfoptions().writeLaTeX(oss, documentClass().provides("hyperref"));
                lyxpreamble += oss.str();
        }
-
+       
        // Will be surrounded by \makeatletter and \makeatother when needed
        docstring atlyxpreamble;
 
@@ -1362,8 +1400,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        else
                lyxpreamble += '\n' + atlyxpreamble;
 
-       // We try to load babel late, in case it interferes
-       // with other packages.
+       // We try to load babel late, in case it interferes with other packages.
        // Jurabib and Hyperref have to be called after babel, though.
        if (use_babel && !features.isRequired("jurabib")
            && !features.isRequired("hyperref")
@@ -1392,7 +1429,7 @@ void BufferParams::useClassDefaults()
        sides = tclass.sides();
        columns = tclass.columns();
        pagestyle = tclass.pagestyle();
-       options = tclass.options();
+       use_default_options = true;
        // Only if class has a ToC hierarchy
        if (tclass.hasTocLevels()) {
                secnumdepth = tclass.secnumdepth();
@@ -1408,7 +1445,7 @@ bool BufferParams::hasClassDefaults() const
        return sides == tclass.sides()
                && columns == tclass.columns()
                && pagestyle == tclass.pagestyle()
-               && options == tclass.options()
+               && use_default_options
                && secnumdepth == tclass.secnumdepth()
                && tocdepth == tclass.tocdepth();
 }
@@ -1431,58 +1468,52 @@ void BufferParams::setDocumentClass(DocumentClass const * const tc) {
 }
 
 
-bool BufferParams::setBaseClass(string const & classname)
+void BufferParams::addDefaultModules()
 {
-       LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
-       LayoutFileList & bcl = LayoutFileList::get();
-       if (!bcl.haveClass(classname)) {
-               docstring s = 
-                       bformat(_("The document class %1$s could not be found. "
-                               "A default textclass with default layouts will be used. "
-                               "LyX might not be able to produce output unless a correct "
-                               "textclass is selected from the document settings dialog."),
-                       from_utf8(classname));
-               frontend::Alert::error(_("Document class not found"), s);
-               bcl.addEmptyClass(classname);
-       }
+       // 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();
 
-       bool const success = bcl[classname].load();
-       if (!success) { 
-               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;
-       }
+       // we want to add these to the front, but in the right order,
+       // so we collect them here first.
+       list<string> modulesToAdd;
 
-       pimpl_->baseClass_ = classname;
-
-       // add any required modules not already in use
-       set<string> const & mods = baseClass()->defaultModules();
-       set<string>::const_iterator mit = mods.begin();
-       set<string>::const_iterator men = mods.end();
        for (; mit != men; mit++) {
                string const & modName = *mit;
                // see if we're already in use
-               if (find(layoutModules_.begin(), layoutModules_.end(), modName) != 
+               if (find(layoutModules_.begin(), layoutModules_.end(), modName) !=
                    layoutModules_.end()) {
                        LYXERR(Debug::TCLASS, "Default module `" << modName << 
                                        "' not added because already used.");
                        continue;
                }
                // make sure the user hasn't removed it
-               if (find(removedModules_.begin(), removedModules_.end(), modName) != 
+               if (find(removedModules_.begin(), removedModules_.end(), modName) !=
                    removedModules_.end()) {
                        LYXERR(Debug::TCLASS, "Default module `" << modName << 
                                        "' not added because removed by user.");
                        continue;
                }
+
                // Now we want to check the list of selected modules to see if any of them
-               // exclude this one.
+               // excludes this one, or if we exclude one of them.
+               LyXModule * thismod = moduleList[modName];
+               if (!thismod) {
+                       LYXERR0("Adding default module " << modName << 
+                                       " even though it is unavailable.");
+                       modulesToAdd.push_back(modName);
+                       continue;
+               }
+
                bool foundit = false;
+               vector<string> const ourExcMods = thismod->getExcludedModules();
+               vector<string>::const_iterator const eit = ourExcMods.begin();
+               vector<string>::const_iterator const een = ourExcMods.end();
+
                // so iterate over the selected modules...
                LayoutModuleList::const_iterator lit = layoutModules_.begin();
-               LayoutModuleList::const_iterator len = layoutModules_.end();
+               LayoutModuleList::const_iterator const len = layoutModules_.end();
                for (; lit != len; lit++) {
                        LyXModule * lm = moduleList[*lit];
                        if (!lm)
@@ -1496,12 +1527,54 @@ bool BufferParams::setBaseClass(string const & classname)
                                                *lit << "'.");
                                break;
                        }
+                       if (find(eit, een, *lit) != een) {
+                               foundit = true;
+                               LYXERR(Debug::TCLASS, "Default module `" << modName << 
+                                               "' not added because it excludes loaded module `" << 
+                                               *lit << "'.");
+                               break;
+                       }
                }
+
                if (!foundit) {
                        LYXERR(Debug::TCLASS, "Default module `" << modName << "' added.");
-                       layoutModules_.push_back(modName);
+                       modulesToAdd.push_back(modName);
                }
        }
+
+       // 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);
+       LayoutFileList & bcl = LayoutFileList::get();
+       if (!bcl.haveClass(classname)) {
+               docstring s = 
+                       bformat(_("The document class %1$s could not be found. "
+                               "A default textclass with default layouts will be used. "
+                               "LyX might not be able to produce output unless a correct "
+                               "textclass is selected from the document settings dialog."),
+                       from_utf8(classname));
+               frontend::Alert::error(_("Document class not found"), s);
+               bcl.addEmptyClass(classname);
+       }
+
+       bool const success = bcl[classname].load();
+       if (!success) {
+               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;
+       }
+
+       pimpl_->baseClass_ = classname;
+       addDefaultModules();
+
        return true;
 }
 
@@ -1847,12 +1920,19 @@ string BufferParams::babelCall(string const & lang_opts) const
        // 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
+       // the same is for all other languages that are not directly supported by
+       // babel, but where LaTeX-packages add babel support.
+       // this is currently the case for Latvian, Lithuanian, and Mongolian
+       size_t latvian = lang_opts.find("latvian");
+       size_t lithu = lang_opts.find("lithuanian");
+       size_t mongo = lang_opts.find("mongolian");
        // If Japanese is used, babel must directly be loaded with the
        // language options, see
        // http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
        size_t japan = lang_opts.find("japanese");
-       // japan = string::npos when not found
-       if (!lyxrc.language_global_options || viet != string::npos || japan != string::npos)
+       if (!lyxrc.language_global_options || viet != string::npos
+               || japan != string::npos || latvian != string::npos
+               || lithu != string::npos || mongo != string::npos)
                return "\\usepackage[" + lang_opts + "]{babel}";
        return lang_pack;
 }