]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.cpp
adjust
[lyx.git] / src / BufferParams.cpp
index 01e17f967a3187072f8e3186351aedbc587fec11..303fe2fcb229f7e7b595d00df85464dc0979cd24 100644 (file)
@@ -19,6 +19,7 @@
 
 #include "Author.h"
 #include "BranchList.h"
+#include "buffer_funcs.h"
 #include "Bullet.h"
 #include "debug.h"
 #include "Encoding.h"
@@ -26,6 +27,7 @@
 #include "Language.h"
 #include "LaTeXFeatures.h"
 #include "Messages.h"
+#include "ModuleList.h"
 #include "Color.h"
 #include "Font.h"
 #include "Lexer.h"
 #include "Spacing.h"
 #include "TexRow.h"
 #include "VSpace.h"
+#include "PDFOptions.h"
 
 #include "frontends/alert.h"
 #include "insets/InsetListingsParams.h"
 
-#include "support/lyxalgo.h" // for lyx::count
 #include "support/convert.h"
+#include "support/filetools.h"
 #include "support/Translator.h"
+#include "support/lstrings.h"
 
 #include <boost/array.hpp>
 
+#include <algorithm>
 #include <sstream>
 
+using std::count;
 using std::endl;
+using std::find;
 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 lyx::support::prefixIs;
 
 
 static char const * const string_paragraph_separation[] = {
@@ -267,15 +277,6 @@ SpaceTranslator const & spacetranslator()
 }
 
 
-textclass_type defaultTextclass()
-{
-       // Initialize textclass to point to article. if `first' is
-       // true in the returned pair, then `second' is the textclass
-       // number; if it is false, second is 0. In both cases, second
-       // is what we want.
-       return textclasslist.numberOfClass("article").second;
-}
-
 } // anon namespace
 
 
@@ -293,6 +294,7 @@ public:
         * and for detached paragraphs in "indented" documents.
         */
        VSpace defskip;
+       PDFOptions pdfoptions;
 };
 
 
@@ -321,8 +323,9 @@ void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
 
 
 BufferParams::BufferParams()
-       : textclass(defaultTextclass()), pimpl_(new Impl)
+       : pimpl_(new Impl)
 {
+       setBaseClass(defaultTextclass());
        paragraph_separation = PARSEP_INDENT;
        quotes_language = InsetQuotes::EnglishQ;
        fontsize = "default";
@@ -355,6 +358,7 @@ BufferParams::BufferParams()
        listings_params = string();
        pagestyle = "default";
        compressed = false;
+       embedded = false;
        for (int iter = 0; iter < 4; ++iter) {
                user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
                temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
@@ -437,6 +441,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;
@@ -457,20 +473,17 @@ string const BufferParams::readToken(Lexer & lex, string const & token)
                pair<bool, lyx::textclass_type> pp =
                        textclasslist.numberOfClass(classname);
                if (pp.first) {
-                       textclass = pp.second;
+                       setBaseClass(pp.second);
                } else {
                        // if text class does not exist, try to load it from filepath
                        pp = textclasslist.addTextClass(classname, filepath);
                        if (pp.first) {
-                               textclass = pp.second;
+                               setBaseClass(pp.second);
                        } else {
-                               textclass = defaultTextclass();
+                               setBaseClass(defaultTextclass());
                                return classname;
                        }
                }
-               // FIXME: isTeXClassAvailable will try to load the layout file, but will
-               // fail because of the lack of path info. Warnings will be given although
-               // the layout file will be correctly loaded later.
                if (!getTextClass().isTeXClassAvailable()) {
                        docstring const msg =
                                bformat(_("The layout file requested by this document,\n"
@@ -481,9 +494,13 @@ string const BufferParams::readToken(Lexer & lex, string const & token)
                                                 "for more information.\n"), from_utf8(classname));
                        frontend::Alert::warning(_("Document class not available"),
                                       msg + _("LyX will not be able to produce output."));
-               }
+               } 
+               
        } else if (token == "\\begin_preamble") {
                readPreamble(lex);
+       } else if (token == "\\begin_modules") {
+               readModules(lex);
+               makeTextClass();
        } else if (token == "\\options") {
                lex.eatLine();
                options = lex.getString();
@@ -633,7 +650,17 @@ 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;
                return token;
        }
 
@@ -647,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[textclass].name() << '\n';
+       os << "\\textclass " << textclasslist[baseClass_].name() << '\n';
 
        // then the preamble
        if (!preamble.empty()) {
@@ -662,6 +689,15 @@ void BufferParams::writeFile(ostream & os) const
        if (!options.empty()) {
                os << "\\options " << options << '\n';
        }
+       
+       //the modules
+       if (!layoutModules_.empty()) {
+               os << "\\begin_modules" << '\n';
+               LayoutModuleList::const_iterator it = layoutModules_.begin();
+               for (; it != layoutModules_.end(); it++)
+                       os << *it << '\n';
+               os << "\\end_modules" << '\n';
+       }
 
        // then the text parameters
        if (language != ignore_language)
@@ -683,6 +719,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<string>(use_geometry)
@@ -766,7 +803,10 @@ void BufferParams::writeFile(ostream & os) const
        AuthorList::Authors::const_iterator a_it = pimpl_->authorlist.begin();
        AuthorList::Authors::const_iterator a_end = pimpl_->authorlist.end();
        for (; a_it != a_end; ++a_it) {
-               os << "\\author " << a_it->second << "\n";
+               if (a_it->second.used())
+                       os << "\\author " << a_it->second << "\n";
+               else
+                       os << "\\author " << Author() << "\n";
        }
 }
 
@@ -860,7 +900,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
+               int 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() << ',';
        }
 
@@ -1081,6 +1127,51 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        // The optional packages;
        docstring lyxpreamble(from_ascii(features.getPackages()));
 
+       // 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" &&
+               !getTextClass().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.
+       odocstringstream oss;
+       // use hyperref explicitely when it is required
+       pdfoptions().writeLaTeX(oss, features.isRequired("hyperref"));
+       lyxpreamble += oss.str();
+
        // this might be useful...
        lyxpreamble += "\n\\makeatletter\n";
 
@@ -1144,19 +1235,10 @@ 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 =
-               int(lyx::count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
+               int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
        for (int j = 0; j != nlines; ++j) {
                texrow.newline();
        }
@@ -1168,7 +1250,7 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
 
 void BufferParams::useClassDefaults()
 {
-       TextClass const & tclass = textclasslist[textclass];
+       TextClass const & tclass = textclasslist[baseClass_];
 
        sides = tclass.sides();
        columns = tclass.columns();
@@ -1184,7 +1266,7 @@ void BufferParams::useClassDefaults()
 
 bool BufferParams::hasClassDefaults() const
 {
-       TextClass const & tclass = textclasslist[textclass];
+       TextClass const & tclass = textclasslist[baseClass_];
 
        return (sides == tclass.sides()
                && columns == tclass.columns()
@@ -1197,7 +1279,115 @@ bool BufferParams::hasClassDefaults() const
 
 TextClass const & BufferParams::getTextClass() const
 {
-       return textclasslist[textclass];
+       return *textClass_;
+}
+
+
+TextClassPtr BufferParams::getTextClassPtr() const {
+       return textClass_;
+}
+
+
+void BufferParams::setTextClass(TextClassPtr tc) {
+       textClass_ = tc;
+}
+
+
+bool BufferParams::setBaseClass(textclass_type 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;
+       }
+       makeTextClass();
+       return retVal;
+}
+
+
+void BufferParams::setJustBaseClass(textclass_type tc)
+{ 
+       baseClass_ = tc; 
+}
+
+
+textclass_type BufferParams::getBaseClass() const
+{
+       return baseClass_;
+}
+
+
+void BufferParams::makeTextClass()
+{
+       textClass_.reset(new TextClass(textclasslist[getBaseClass()]));
+       //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.
+       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));
+                       frontend::Alert::warning(_("Module not 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);
+       }
+}
+
+
+std::vector<string> const & BufferParams::getModules() const {
+       return layoutModules_;
+}
+
+
+
+bool BufferParams::addLayoutModule(string modName, bool makeClass) {
+       LayoutModuleList::const_iterator it = layoutModules_.begin();
+       LayoutModuleList::const_iterator end = layoutModules_.end();
+       for (; it != end; it++) {
+               if (*it == modName) 
+                       break;
+       }
+       if (it != layoutModules_.end())
+               return false;
+       layoutModules_.push_back(modName);
+       if (makeClass)
+               makeTextClass();
+       return true;
+}
+
+
+bool BufferParams::addLayoutModules(std::vector<string>modNames)
+{
+       bool retval = true;
+       std::vector<string>::const_iterator it = modNames.begin();
+       std::vector<string>::const_iterator end = modNames.end();
+       for (; it != end; ++it)
+               retval &= addLayoutModule(*it, false);
+       makeTextClass();
+       return retval;
+}
+
+
+void BufferParams::clearLayoutModules() {
+       layoutModules_.clear();
+       makeTextClass();
 }
 
 
@@ -1298,6 +1488,23 @@ void BufferParams::readBulletsLaTeX(Lexer & lex)
 }
 
 
+void BufferParams::readModules(Lexer & lex)
+{
+       if (!lex.eatLine()) {
+               lyxerr << "Error (BufferParams::readModules):"
+                               "Unexpected end of input." << endl;
+               return;
+       }
+       while (true) {
+               string mod = lex.getString();
+               if (mod == "\\end_modules")
+                       break;
+               addLayoutModule(mod);
+               lex.eatLine();
+       }
+}
+
+
 string const BufferParams::paperSizeName() const
 {
        char real_papersize = papersize;
@@ -1365,7 +1572,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
+       int 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;
 }
@@ -1385,6 +1597,13 @@ void BufferParams::writeEncodingPreamble(odocstream & os,
                std::set<string> 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<string>::const_iterator it = encodings.begin();
@@ -1408,7 +1627,7 @@ void BufferParams::writeEncodingPreamble(odocstream & os,
                        texrow.newline();
                }
        } else if (inputenc != "default") {
-               switch (language->encoding()->package()) {
+               switch (encoding().package()) {
                case Encoding::none:
                        break;
                case Encoding::inputenc: