]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.cpp
Typo.
[lyx.git] / src / BufferParams.cpp
index 9ed248fcea65afc975517333262afe396413ae80..73bd2258a481e1e880c244ea0e71ee72c81e338e 100644 (file)
@@ -68,7 +68,7 @@ static char const * const string_quotes_language[] = {
 
 
 static char const * const string_papersize[] = {
-       "default", "custom", "letterpaper", "executivepaper", "legalpaper",
+       "default", "custom", "letterpaper", "legalpaper", "executivepaper",
        "a3paper", "a4paper", "a5paper", "b3paper", "b4paper", "b5paper", ""
 };
 
@@ -95,13 +95,14 @@ namespace lyx {
 namespace {
 
 // Paragraph separation
-typedef Translator<string, BufferParams::PARSEP> ParSepTranslator;
+typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
 
 
 ParSepTranslator const init_parseptranslator()
 {
-       ParSepTranslator translator(string_paragraph_separation[0], BufferParams::PARSEP_INDENT);
-       translator.addPair(string_paragraph_separation[1], BufferParams::PARSEP_SKIP);
+       ParSepTranslator translator
+               (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
+       translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
        return translator;
 }
 
@@ -114,17 +115,18 @@ ParSepTranslator const & parseptranslator()
 
 
 // Quotes language
-typedef Translator<string, InsetQuotes::quote_language> QuotesLangTranslator;
+typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
 
 
 QuotesLangTranslator const init_quoteslangtranslator()
 {
-       QuotesLangTranslator translator(string_quotes_language[0], InsetQuotes::EnglishQ);
-       translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQ);
-       translator.addPair(string_quotes_language[2], InsetQuotes::GermanQ);
-       translator.addPair(string_quotes_language[3], InsetQuotes::PolishQ);
-       translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQ);
-       translator.addPair(string_quotes_language[5], InsetQuotes::DanishQ);
+       QuotesLangTranslator translator
+               (string_quotes_language[0], InsetQuotes::EnglishQuotes);
+       translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
+       translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
+       translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
+       translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
+       translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
        return translator;
 }
 
@@ -140,7 +142,7 @@ QuotesLangTranslator const & quoteslangtranslator()
 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
 
 
-PaperSizeTranslator const init_papersizetranslator()
+static PaperSizeTranslator initPaperSizeTranslator()
 {
        PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
        translator.addPair(string_papersize[1], PAPER_CUSTOM);
@@ -159,7 +161,7 @@ PaperSizeTranslator const init_papersizetranslator()
 
 PaperSizeTranslator const & papersizetranslator()
 {
-       static PaperSizeTranslator translator = init_papersizetranslator();
+       static PaperSizeTranslator translator = initPaperSizeTranslator();
        return translator;
 }
 
@@ -223,15 +225,15 @@ PackageTranslator const & packagetranslator()
 
 
 // Cite engine
-typedef Translator<string, biblio::CiteEngine> CiteEngineTranslator;
+typedef Translator<string, CiteEngine> CiteEngineTranslator;
 
 
 CiteEngineTranslator const init_citeenginetranslator()
 {
-       CiteEngineTranslator translator("basic", biblio::ENGINE_BASIC);
-       translator.addPair("natbib_numerical", biblio::ENGINE_NATBIB_NUMERICAL);
-       translator.addPair("natbib_authoryear", biblio::ENGINE_NATBIB_AUTHORYEAR);
-       translator.addPair("jurabib", biblio::ENGINE_JURABIB);
+       CiteEngineTranslator translator("basic", ENGINE_BASIC);
+       translator.addPair("natbib_numerical", ENGINE_NATBIB_NUMERICAL);
+       translator.addPair("natbib_authoryear", ENGINE_NATBIB_AUTHORYEAR);
+       translator.addPair("jurabib", ENGINE_JURABIB);
        return translator;
 }
 
@@ -299,7 +301,7 @@ BufferParams::Impl::Impl()
 BufferParams::Impl *
 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
 {
-       BOOST_ASSERT(ptr);
+       LASSERT(ptr, /**/);
 
        return new BufferParams::Impl(*ptr);
 }
@@ -316,8 +318,8 @@ BufferParams::BufferParams()
 {
        setBaseClass(defaultBaseclass());
        makeDocumentClass();
-       paragraph_separation = PARSEP_INDENT;
-       quotes_language = InsetQuotes::EnglishQ;
+       paragraph_separation = ParagraphIndentSeparation;
+       quotes_language = InsetQuotes::EnglishQuotes;
        fontsize = "default";
 
        /*  PaperLayout */
@@ -326,7 +328,7 @@ BufferParams::BufferParams()
        use_geometry = false;
        use_amsmath = package_auto;
        use_esint = package_auto;
-       cite_engine_ = biblio::ENGINE_BASIC;
+       cite_engine_ = ENGINE_BASIC;
        use_bibtopic = false;
        trackChanges = false;
        outputChanges = false;
@@ -348,7 +350,6 @@ 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];
@@ -356,13 +357,9 @@ BufferParams::BufferParams()
 }
 
 
-BufferParams::~BufferParams()
-{}
-
-
-docstring const BufferParams::B_(string const & l10n) const
+docstring BufferParams::B_(string const & l10n) const
 {
-       BOOST_ASSERT(language);
+       LASSERT(language, /**/);
        return getMessages(language->code()).get(l10n);
 }
 
@@ -393,28 +390,28 @@ BranchList const & BufferParams::branchlist() const
 
 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
 {
-       BOOST_ASSERT(index < 4);
+       LASSERT(index < 4, /**/);
        return pimpl_->temp_bullets[index];
 }
 
 
 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
 {
-       BOOST_ASSERT(index < 4);
+       LASSERT(index < 4, /**/);
        return pimpl_->temp_bullets[index];
 }
 
 
 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
 {
-       BOOST_ASSERT(index < 4);
+       LASSERT(index < 4, /**/);
        return pimpl_->user_defined_bullets[index];
 }
 
 
 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
 {
-       BOOST_ASSERT(index < 4);
+       LASSERT(index < 4, /**/);
        return pimpl_->user_defined_bullets[index];
 }
 
@@ -455,7 +452,7 @@ void BufferParams::setDefSkip(VSpace const & vs)
 }
 
 
-string const BufferParams::readToken(Lexer & lex, string const & token,
+string BufferParams::readToken(Lexer & lex, string const & token,
        FileName const & filepath)
 {
        if (token == "\\textclass") {
@@ -465,8 +462,8 @@ string const BufferParams::readToken(Lexer & lex, string const & token,
                // NOTE: in this case, the textclass (.cls file) is assumed to be available.
                string tcp;
                LayoutFileList & bcl = LayoutFileList::get();
-               if (!filepath.empty())
-                       tcp = bcl.addLayoutFile(classname, filepath.absFilename());
+               if (tcp.empty() && !filepath.empty())
+                       tcp = bcl.addLayoutFile(classname, filepath.absFilename(), LayoutFileList::Local);
                if (!tcp.empty())
                        setBaseClass(tcp);
                else if (bcl.haveClass(classname)) {
@@ -493,11 +490,16 @@ string const BufferParams::readToken(Lexer & lex, string const & token,
                
        } else if (token == "\\begin_preamble") {
                readPreamble(lex);
+       } else if (token == "\\begin_local_layout") {
+               readLocalLayout(lex);
        } else if (token == "\\begin_modules") {
                readModules(lex);
        } else if (token == "\\options") {
                lex.eatLine();
                options = lex.getString();
+       } else if (token == "\\master") {
+               lex.eatLine();
+               master = lex.getString();
        } else if (token == "\\language") {
                readLanguage(lex);
        } else if (token == "\\inputencoding") {
@@ -520,6 +522,8 @@ string const BufferParams::readToken(Lexer & lex, string const & token,
                lex >> fontsSansScale;
        } else if (token == "\\font_tt_scale") {
                lex >> fontsTypewriterScale;
+       } else if (token == "\\font_cjk") {
+               lex >> fontsCJK;
        } else if (token == "\\paragraph_separation") {
                string parsep;
                lex >> parsep;
@@ -689,6 +693,11 @@ void BufferParams::writeFile(ostream & os) const
        if (!options.empty()) {
                os << "\\options " << options << '\n';
        }
+
+       // the master document
+       if (!master.empty()) {
+               os << "\\master " << master << '\n';
+       }
        
        //the modules
        if (!layoutModules_.empty()) {
@@ -699,6 +708,15 @@ void BufferParams::writeFile(ostream & os) const
                os << "\\end_modules" << '\n';
        }
 
+       // local layout information
+       if (!local_layout.empty()) {
+               // remove '\n' from the end 
+               string const tmplocal = rtrim(local_layout, "\n");
+               os << "\\begin_local_layout\n"
+                  << tmplocal
+                  << "\n\\end_local_layout\n";
+       }
+
        // then the text parameters
        if (language != ignore_language)
                os << "\\language " << language->lang() << '\n';
@@ -711,7 +729,11 @@ void BufferParams::writeFile(ostream & os) const
           << "\n\\font_osf " << convert<string>(fontsOSF)
           << "\n\\font_sf_scale " << fontsSansScale
           << "\n\\font_tt_scale " << fontsTypewriterScale
-          << "\n\\graphics " << graphicsDriver << '\n';
+          << '\n';
+       if (!fontsCJK.empty()) {
+               os << "\\font_cjk " << fontsCJK << '\n';
+       }
+       os << "\n\\graphics " << graphicsDriver << '\n';
 
        if (!float_placement.empty()) {
                os << "\\float_placement " << float_placement << '\n';
@@ -988,8 +1010,13 @@ 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
+               // when Japanese is used, babel must directly be loaded with the
+               // 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)
+                       && viet == string::npos && japan == string::npos)
                        clsoptions << language_options.str() << ',';
        }
 
@@ -1145,6 +1172,8 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
                        os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
                os << "}\n";
                texrow.newline();
+       } else if (orientation == ORIENTATION_LANDSCAPE) {
+               features.require("papersize");
        }
 
        if (tokenPos(tclass.opt_pagestyle(),
@@ -1215,17 +1244,19 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        // 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
+       // 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:
+       // 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
@@ -1235,18 +1266,6 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
                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" &&
-               !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";
-               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,
@@ -1262,32 +1281,45 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
                lyxpreamble += oss.str();
        }
 
-       // this might be useful...
-       lyxpreamble += "\n\\makeatletter\n";
+       // Will be surrounded by \makeatletter and \makeatother when needed
+       docstring atlyxpreamble;
 
        // Some macros LyX will need
        docstring tmppreamble(from_ascii(features.getMacros()));
 
-       if (!tmppreamble.empty()) {
-               lyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
+       if (!tmppreamble.empty())
+               atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
                        "LyX specific LaTeX commands.\n"
                        + tmppreamble + '\n';
-       }
 
        // the text class specific preamble
        tmppreamble = features.getTClassPreamble();
-       if (!tmppreamble.empty()) {
-               lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
+       if (!tmppreamble.empty())
+               atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
                        "Textclass specific LaTeX commands.\n"
                        + tmppreamble + '\n';
-       }
 
        /* the user-defined preamble */
-       if (!preamble.empty()) {
+       if (!preamble.empty())
                // FIXME UNICODE
-               lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
+               atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
                        "User specified LaTeX commands.\n"
                        + from_utf8(preamble) + '\n';
+
+       // subfig loads internally the LaTeX package "caption". As
+       // caption is a very popular package, users will load it in
+       // the preamble. Therefore we must load subfig behind the
+       // user-defined preamble and check if the caption package was
+       // loaded or not. For the case that caption is loaded before
+       // subfig, there is the subfig option "caption=false". This
+       // option also works when a koma-script class is used and
+       // koma's own caption commands are used instead of caption. We
+       // use \PassOptionsToPackage here because the user could have
+       // already loaded subfig in the preamble.
+       if (features.isRequired("subfig")) {
+               atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
+                       " \\PassOptionsToPackage{caption=false}{subfig}}\n"
+                       "\\usepackage{subfig}\n";
        }
 
        // Itemize bullet settings need to be last in case the user
@@ -1323,9 +1355,13 @@ bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
        }
 
        if (!bullets_def.empty())
-               lyxpreamble += bullets_def + "}\n\n";
+               atlyxpreamble += bullets_def + "}\n\n";
 
-       lyxpreamble += "\\makeatother\n\n";
+       if (atlyxpreamble.find(from_ascii("@")) != docstring::npos)
+               lyxpreamble += "\n\\makeatletter\n"
+                       + atlyxpreamble + "\\makeatother\n\n";
+       else
+               lyxpreamble += '\n' + atlyxpreamble;
 
        int const nlines =
                int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
@@ -1373,7 +1409,7 @@ DocumentClass const & BufferParams::documentClass() const
 }
 
 
-DocumentClass * BufferParams::documentClassPtr() const {
+DocumentClass const * BufferParams::documentClassPtr() const {
        return doc_class_;
 }
 
@@ -1446,9 +1482,8 @@ void BufferParams::makeDocumentClass()
                                        "probably need to reconfigure LyX.\n"), from_utf8(modName));
                        frontend::Alert::warning(_("Module not available"),
                                        msg + _("Some layouts may not be available."));
-                       lyxerr << "BufferParams::makeDocumentClass(): Module " <<
-                                       modName << " requested but not found in module list." <<
-                                       endl;
+                       LYXERR0("BufferParams::makeDocumentClass(): Module " <<
+                                       modName << " requested but not found in module list.");
                        continue;
                }
                if (!lm->isAvailable()) {
@@ -1465,6 +1500,12 @@ void BufferParams::makeDocumentClass()
                        frontend::Alert::warning(_("Read Error"), msg);
                }
        }
+       if (!local_layout.empty()) {
+               if (!doc_class_->read(local_layout, TextClass::MODULE)) {
+                       docstring const msg = _("Error reading internal layout information");
+                       frontend::Alert::warning(_("Read Error"), msg);
+               }
+       }
 }
 
 
@@ -1479,12 +1520,9 @@ bool BufferParams::addLayoutModule(string const & modName)
 {
        LayoutModuleList::const_iterator it = layoutModules_.begin();
        LayoutModuleList::const_iterator end = layoutModules_.end();
-       for (; it != end; it++) {
+       for (; it != end; it++)
                if (*it == modName) 
-                       break;
-       }
-       if (it != layoutModules_.end())
-               return false;
+                       return false;
        layoutModules_.push_back(modName);
        return true;
 }
@@ -1519,6 +1557,16 @@ void BufferParams::readPreamble(Lexer & lex)
 }
 
 
+void BufferParams::readLocalLayout(Lexer & lex)
+{
+       if (lex.getString() != "\\begin_local_layout")
+               lyxerr << "Error (BufferParams::readLocalLayout):"
+                       "consistency check failed." << endl;
+
+       local_layout = lex.getLongString("\\end_local_layout");
+}
+
+
 void BufferParams::readLanguage(Lexer & lex)
 {
        if (!lex.next()) return;
@@ -1551,7 +1599,8 @@ void BufferParams::readGraphicsDriver(Lexer & lex)
                if (test == tmptok) {
                        graphicsDriver = tmptok;
                        break;
-               } else if (test == "") {
+               }
+               if (test.empty()) {
                        lex.printError(
                                "Warning: graphics driver `$$Token' not recognized!\n"
                                "         Setting graphics driver to `default'.\n");
@@ -1612,7 +1661,7 @@ void BufferParams::readModules(Lexer & lex)
 }
 
 
-string const BufferParams::paperSizeName(Papersize_Purpose const & purpose) const
+string BufferParams::paperSizeName(PapersizePurpose purpose) const
 {
        char real_papersize = papersize;
        if (real_papersize == PAPER_DEFAULT)
@@ -1704,7 +1753,7 @@ string const BufferParams::dvips_options() const
 }
 
 
-string const BufferParams::babelCall(string const & lang_opts) const
+string BufferParams::babelCall(string const & lang_opts) const
 {
        string lang_pack = lyxrc.language_package;
        if (lang_pack != "\\usepackage{babel}")
@@ -1719,7 +1768,12 @@ string const 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
-       if (!lyxrc.language_global_options || viet != string::npos)
+       // when 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)
                return "\\usepackage[" + lang_opts + "]{babel}";
        return lang_pack;
 }
@@ -1923,7 +1977,7 @@ string const BufferParams::loadFonts(string const & rm,
        else if (tt == "courier" )
                os << "\\usepackage{" << tt << "}\n";
        // Computer Modern, Latin Modern, CM Bright
-       else if  (tt != "default")
+       else if (tt != "default")
                os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
 
        return os.str();
@@ -1933,29 +1987,28 @@ string const BufferParams::loadFonts(string const & rm,
 Encoding const & BufferParams::encoding() const
 {
        if (inputenc == "auto" || inputenc == "default")
-               return *(language->encoding());
-       Encoding const * const enc =
-               encodings.getFromLaTeXName(inputenc);
+               return *language->encoding();
+       Encoding const * const enc = encodings.fromLaTeXName(inputenc);
        if (enc)
                return *enc;
-       lyxerr << "Unknown inputenc value `" << inputenc
-              << "'. Using `auto' instead." << endl;
-       return *(language->encoding());
+       LYXERR0("Unknown inputenc value `" << inputenc
+              << "'. Using `auto' instead.");
+       return *language->encoding();
 }
 
 
-biblio::CiteEngine BufferParams::getEngine() const
+CiteEngine BufferParams::citeEngine() const
 {
        // FIXME the class should provide the numerical/
        // authoryear choice
        if (documentClass().provides("natbib")
-           && cite_engine_ != biblio::ENGINE_NATBIB_NUMERICAL)
-               return biblio::ENGINE_NATBIB_AUTHORYEAR;
+           && cite_engine_ != ENGINE_NATBIB_NUMERICAL)
+               return ENGINE_NATBIB_AUTHORYEAR;
        return cite_engine_;
 }
 
 
-void BufferParams::setCiteEngine(biblio::CiteEngine const cite_engine)
+void BufferParams::setCiteEngine(CiteEngine cite_engine)
 {
        cite_engine_ = cite_engine;
 }