]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.cpp
Remove unneeded mutable keywords
[lyx.git] / src / BufferParams.cpp
index 08c7e0de400f8fdfafb8939be0925d4b8664eed1..d94600fb0f303b8511f4a05b3f6eb681e37322ef 100644 (file)
@@ -52,6 +52,7 @@
 #include "support/filetools.h"
 #include "support/gettext.h"
 #include "support/Messages.h"
+#include "support/mutex.h"
 #include "support/Translator.h"
 #include "support/lstrings.h"
 
@@ -87,11 +88,6 @@ static char const * const string_orientation[] = {
 };
 
 
-static char const * const string_footnotekinds[] = {
-       "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
-};
-
-
 static char const * const tex_graphics[] = {
        "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
        "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
@@ -122,7 +118,8 @@ ParSepTranslator const init_parseptranslator()
 
 ParSepTranslator const & parseptranslator()
 {
-       static ParSepTranslator translator = init_parseptranslator();
+       static ParSepTranslator const translator =
+               init_parseptranslator();
        return translator;
 }
 
@@ -146,7 +143,8 @@ QuotesLangTranslator const init_quoteslangtranslator()
 
 QuotesLangTranslator const & quoteslangtranslator()
 {
-       static QuotesLangTranslator translator = init_quoteslangtranslator();
+       static QuotesLangTranslator const translator =
+               init_quoteslangtranslator();
        return translator;
 }
 
@@ -196,7 +194,8 @@ static PaperSizeTranslator initPaperSizeTranslator()
 
 PaperSizeTranslator const & papersizetranslator()
 {
-       static PaperSizeTranslator translator = initPaperSizeTranslator();
+       static PaperSizeTranslator const translator =
+               initPaperSizeTranslator();
        return translator;
 }
 
@@ -215,7 +214,8 @@ PaperOrientationTranslator const init_paperorientationtranslator()
 
 PaperOrientationTranslator const & paperorientationtranslator()
 {
-       static PaperOrientationTranslator translator = init_paperorientationtranslator();
+       static PaperOrientationTranslator const translator =
+           init_paperorientationtranslator();
        return translator;
 }
 
@@ -234,7 +234,7 @@ SidesTranslator const init_sidestranslator()
 
 SidesTranslator const & sidestranslator()
 {
-       static SidesTranslator translator = init_sidestranslator();
+       static SidesTranslator const translator = init_sidestranslator();
        return translator;
 }
 
@@ -254,7 +254,8 @@ PackageTranslator const init_packagetranslator()
 
 PackageTranslator const & packagetranslator()
 {
-       static PackageTranslator translator = init_packagetranslator();
+       static PackageTranslator const translator =
+               init_packagetranslator();
        return translator;
 }
 
@@ -267,13 +268,15 @@ CiteEngineTypeTranslator const init_citeenginetypetranslator()
 {
        CiteEngineTypeTranslator translator("authoryear", ENGINE_TYPE_AUTHORYEAR);
        translator.addPair("numerical", ENGINE_TYPE_NUMERICAL);
+       translator.addPair("default", ENGINE_TYPE_DEFAULT);
        return translator;
 }
 
 
 CiteEngineTypeTranslator const & citeenginetypetranslator()
 {
-       static CiteEngineTypeTranslator translator = init_citeenginetypetranslator();
+       static CiteEngineTypeTranslator const translator =
+               init_citeenginetypetranslator();
        return translator;
 }
 
@@ -295,7 +298,7 @@ SpaceTranslator const init_spacetranslator()
 
 SpaceTranslator const & spacetranslator()
 {
-       static SpaceTranslator translator = init_spacetranslator();
+       static SpaceTranslator const translator = init_spacetranslator();
        return translator;
 }
 
@@ -335,8 +338,7 @@ BufferParams::Impl::Impl()
 BufferParams::Impl *
 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
 {
-       LASSERT(ptr, /**/);
-
+       LBUFERR(ptr);
        return new BufferParams::Impl(*ptr);
 }
 
@@ -361,12 +363,12 @@ BufferParams::BufferParams()
        orientation = ORIENTATION_PORTRAIT;
        use_geometry = false;
        cite_engine_.push_back("basic");
-       cite_engine_type_ = ENGINE_TYPE_NUMERICAL;
+       cite_engine_type_ = ENGINE_TYPE_DEFAULT;
        biblio_style = "plain";
        use_bibtopic = false;
        use_indices = false;
-       trackChanges = false;
-       outputChanges = false;
+       track_changes = false;
+       output_changes = false;
        use_default_options = true;
        maintain_unincluded_children = false;
        secnumdepth = 3;
@@ -415,6 +417,7 @@ BufferParams::BufferParams()
        html_math_output = MathML;
        html_math_img_scale = 1.0;
        html_css_as_file = false;
+       display_pixel_ratio = 1.0;
 
        output_sync = false;
        use_refstyle = true;
@@ -423,7 +426,7 @@ BufferParams::BufferParams()
 
 docstring BufferParams::B_(string const & l10n) const
 {
-       LASSERT(language, /**/);
+       LASSERT(language, return from_utf8(l10n));
        return getMessages(language->code()).get(l10n);
 }
 
@@ -447,6 +450,14 @@ map<string, string> const & BufferParams::auto_packages()
 {
        static map<string, string> packages;
        if (packages.empty()) {
+               // We could have a race condition here that two threads
+               // discover an empty map at the same time and want to fill
+               // it, but that is no problem, since the same contents is
+               // filled in twice then. Having the locker inside the
+               // packages.empty() condition has the advantage that we
+               // don't need the mutex overhead for simple reading.
+               static Mutex mutex;
+               Mutex::Locker locker(&mutex);
                // adding a package here implies a file format change!
                packages["amsmath"] =
                        N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
@@ -511,28 +522,28 @@ IndicesList const & BufferParams::indiceslist() const
 
 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
 {
-       LASSERT(index < 4, /**/);
+       LASSERT(index < 4, return pimpl_->temp_bullets[0]);
        return pimpl_->temp_bullets[index];
 }
 
 
 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
 {
-       LASSERT(index < 4, /**/);
+       LASSERT(index < 4, return pimpl_->temp_bullets[0]);
        return pimpl_->temp_bullets[index];
 }
 
 
 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
 {
-       LASSERT(index < 4, /**/);
+       LASSERT(index < 4, return pimpl_->temp_bullets[0]);
        return pimpl_->user_defined_bullets[index];
 }
 
 
 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
 {
-       LASSERT(index < 4, /**/);
+       LASSERT(index < 4, return pimpl_->temp_bullets[0]);
        return pimpl_->user_defined_bullets[index];
 }
 
@@ -598,8 +609,9 @@ string BufferParams::readToken(Lexer & lex, string const & token,
                // be available.
                string tcp;
                LayoutFileList & bcl = LayoutFileList::get();
-               if (tcp.empty() && !filepath.empty())
+               if (!filepath.empty())
                        tcp = bcl.addLocalLayout(classname, filepath.absFileName());
+               // that returns non-empty if a "local" layout file is found.
                if (!tcp.empty())
                        setBaseClass(tcp);
                else
@@ -627,7 +639,9 @@ string BufferParams::readToken(Lexer & lex, string const & token,
        } else if (token == "\\begin_preamble") {
                readPreamble(lex);
        } else if (token == "\\begin_local_layout") {
-               readLocalLayout(lex);
+               readLocalLayout(lex, false);
+       } else if (token == "\\begin_forced_local_layout") {
+               readLocalLayout(lex, true);
        } else if (token == "\\begin_modules") {
                readModules(lex);
        } else if (token == "\\begin_removed_modules") {
@@ -741,9 +755,9 @@ string BufferParams::readToken(Lexer & lex, string const & token,
        } else if (token == "\\use_indices") {
                lex >> use_indices;
        } else if (token == "\\tracking_changes") {
-               lex >> trackChanges;
+               lex >> track_changes;
        } else if (token == "\\output_changes") {
-               lex >> outputChanges;
+               lex >> output_changes;
        } else if (token == "\\branch") {
                lex.eatLine();
                docstring branch = lex.getDocString();
@@ -990,6 +1004,7 @@ void BufferParams::writeFile(ostream & os) const
           << convert<string>(maintain_unincluded_children) << '\n';
 
        // local layout information
+       string const local_layout = getLocalLayout(false);
        if (!local_layout.empty()) {
                // remove '\n' from the end
                string const tmplocal = rtrim(local_layout, "\n");
@@ -997,6 +1012,14 @@ void BufferParams::writeFile(ostream & os) const
                   << tmplocal
                   << "\n\\end_local_layout\n";
        }
+       string const forced_local_layout = getLocalLayout(true);
+       if (!forced_local_layout.empty()) {
+               // remove '\n' from the end
+               string const tmplocal = rtrim(forced_local_layout, "\n");
+               os << "\\begin_forced_local_layout\n"
+                  << tmplocal
+                  << "\n\\end_forced_local_layout\n";
+       }
 
        // then the text parameters
        if (language != ignore_language)
@@ -1158,8 +1181,8 @@ void BufferParams::writeFile(ostream & os) const
                }
        }
 
-       os << "\\tracking_changes " << convert<string>(trackChanges) << '\n'
-          << "\\output_changes " << convert<string>(outputChanges) << '\n'
+       os << "\\tracking_changes " << convert<string>(track_changes) << '\n'
+          << "\\output_changes " << convert<string>(output_changes) << '\n'
           << "\\html_math_output " << html_math_output << '\n'
           << "\\html_css_as_file " << html_css_as_file << '\n'
           << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
@@ -1182,7 +1205,7 @@ void BufferParams::validate(LaTeXFeatures & features) const
        if (columns > 1 && language->rightToLeft())
                features.require("rtloutputdblcol");
 
-       if (outputChanges) {
+       if (output_changes) {
                bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
                bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
                                  LaTeXFeatures::isAvailable("xcolor");
@@ -1268,6 +1291,15 @@ void BufferParams::validate(LaTeXFeatures & features) const
                if (pdfoptions().colorlinks)
                        features.require("color");
        }
+       if (!listings_params.empty()) {
+               // do not test validity because listings_params is
+               // supposed to be valid
+               string par =
+                       InsetListingsParams(listings_params).separatedParams(true);
+               // we can't support all packages, but we should load the color package
+               if (par.find("\\color", 0) != string::npos)
+                       features.require("color");
+       }
 
        // some languages are only available via polyglossia
        if (features.runparams().flavor == OutputParams::XETEX
@@ -1433,9 +1465,13 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
        os << '{' << from_ascii(tclass.latexname()) << "}\n";
        // end of \documentclass defs
 
-       // if we use fontspec, we have to load the AMS packages here
+       // if we use fontspec or newtxmath, we have to load the AMS packages here
        string const ams = features.loadAMSPackages();
-       if (useNonTeXFonts && !ams.empty())
+       bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
+       bool const use_newtxmath =
+               theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getUsedPackage(
+                       ot1, false, false) == "newtxmath";
+       if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
                os << from_ascii(ams);
 
        if (useNonTeXFonts) {
@@ -1514,21 +1550,6 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                os << "}\n";
        }
 
-       if (!listings_params.empty() || features.isRequired("listings"))
-               os << "\\usepackage{listings}\n";
-
-       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);
-               // 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)
-                  << "}\n";
-       }
        if (!features.isProvided("geometry")
            && (use_geometry || nonstandard_papersize)) {
                odocstringstream ods;
@@ -1871,6 +1892,13 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                        "User specified LaTeX commands.\n"
                        + from_utf8(preamble) + '\n';
 
+       // footmisc must be loaded after setspace
+       // Load it here to avoid clashes with footmisc loaded in the user
+       // preamble. For that reason we also pass the options via
+       // \PassOptionsToPackage in getPreamble() and not here.
+       if (features.mustProvide("footmisc"))
+               atlyxpreamble += "\\usepackage{footmisc}\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
@@ -1927,7 +1955,8 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                        + atlyxpreamble + "\\makeatother\n\n";
 
        // We try to load babel late, in case it interferes with other packages.
-       // Jurabib, hyperref and varioref have to be called after babel, though.
+       // Jurabib, hyperref, varioref and listings (bug 8995) have to be
+       // called after babel, though.
        if (use_babel && !features.isRequired("jurabib")
            && !features.isRequired("hyperref")
                && !features.isRequired("varioref")
@@ -1939,10 +1968,22 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                                                   features.needBabelLangOptions())) + '\n';
                lyxpreamble += from_utf8(features.getBabelPostsettings());
        }
+       if (!listings_params.empty() || features.isRequired("listings"))
+               lyxpreamble += "\\usepackage{listings}\n";
+       if (!listings_params.empty()) {
+               lyxpreamble += "\\lstset{";
+               // do not test validity because listings_params is
+               // supposed to be valid
+               string par =
+                       InsetListingsParams(listings_params).separatedParams(true);
+               lyxpreamble += from_utf8(par);
+               lyxpreamble += "}\n";
+       }
 
        // xunicode needs to be loaded at least after amsmath, amssymb,
        // esint and the other packages that provide special glyphs
-       if (features.runparams().flavor == OutputParams::XETEX)
+       if (features.runparams().flavor == OutputParams::XETEX
+           && useNonTeXFonts)
                lyxpreamble += "\\usepackage{xunicode}\n";
 
        // Polyglossia must be loaded last
@@ -2084,7 +2125,7 @@ LayoutFileIndex const & BufferParams::baseClassID() const
 }
 
 
-void BufferParams::makeDocumentClass()
+void BufferParams::makeDocumentClass(bool const clone)
 {
        if (!baseClass())
                return;
@@ -2100,15 +2141,17 @@ void BufferParams::makeDocumentClass()
        for (; it != en; ++it)
                mods.push_back(*it);
 
-       doc_class_ = getDocumentClass(*baseClass(), mods);
+       doc_class_ = getDocumentClass(*baseClass(), mods, clone);
 
-       if (!local_layout.empty()) {
-               TextClass::ReturnValues success =
-                       doc_class_->read(local_layout, TextClass::MODULE);
-               if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
-                       docstring const msg = _("Error reading internal layout information");
-                       frontend::Alert::warning(_("Read Error"), msg);
-               }
+       TextClass::ReturnValues success = TextClass::OK;
+       if (!forced_local_layout_.empty())
+               success = doc_class_->read(forced_local_layout_, TextClass::MODULE);
+       if (!local_layout_.empty() &&
+           (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
+               success = doc_class_->read(local_layout_, TextClass::MODULE);
+       if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
+               docstring const msg = _("Error reading internal layout information");
+               frontend::Alert::warning(_("Read Error"), msg);
        }
 }
 
@@ -2125,6 +2168,24 @@ bool BufferParams::citationModuleCanBeAdded(string const & modName) const
 }
 
 
+std::string BufferParams::getLocalLayout(bool forced) const
+{
+       if (forced)
+               return doc_class_->forcedLayouts();
+       else
+               return local_layout_;
+}
+
+
+void BufferParams::setLocalLayout(string const & layout, bool forced)
+{
+       if (forced)
+               forced_local_layout_ = layout;
+       else
+               local_layout_ = layout;
+}
+
+
 bool BufferParams::addLayoutModule(string const & modName)
 {
        LayoutModuleList::const_iterator it = layout_modules_.begin();
@@ -2227,7 +2288,7 @@ vector<string> BufferParams::backends() const
 }
 
 
-OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
+OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
 {
        string const dformat = (format.empty() || format == "default") ?
                getDefaultOutputFormat() : format;
@@ -2284,7 +2345,6 @@ string BufferParams::getDefaultOutputFormat() const
            && default_output_format != "default")
                return default_output_format;
        if (isDocBook()
-           || useNonTeXFonts
            || encoding().package() == Encoding::japanese) {
                vector<Format const *> const formats = exportableFormats(true);
                if (formats.empty())
@@ -2292,6 +2352,8 @@ string BufferParams::getDefaultOutputFormat() const
                // return the first we find
                return formats.front()->name();
        }
+       if (useNonTeXFonts)
+               return lyxrc.default_otf_view_format;
        return lyxrc.default_view_format;
 }
 
@@ -2308,7 +2370,7 @@ Font const BufferParams::getFont() const
 }
 
 
-InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const qs) const
+InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const qs) const
 {
        return quoteslangtranslator().find(qs);
 }
@@ -2342,13 +2404,19 @@ void BufferParams::readPreamble(Lexer & lex)
 }
 
 
-void BufferParams::readLocalLayout(Lexer & lex)
+void BufferParams::readLocalLayout(Lexer & lex, bool forced)
 {
-       if (lex.getString() != "\\begin_local_layout")
+       string const expected = forced ? "\\begin_forced_local_layout" :
+                                        "\\begin_local_layout";
+       if (lex.getString() != expected)
                lyxerr << "Error (BufferParams::readLocalLayout):"
                        "consistency check failed." << endl;
 
-       local_layout = lex.getLongString("\\end_local_layout");
+       if (forced)
+               forced_local_layout_ =
+                       lex.getLongString("\\end_forced_local_layout");
+       else
+               local_layout_ = lex.getLongString("\\end_local_layout");
 }
 
 
@@ -2804,6 +2872,15 @@ void BufferParams::writeEncodingPreamble(otexstream & os,
                                os << "\\usepackage{CJK}\n";
                        break;
                }
+               // Load the CJK package if needed by a secondary language.
+               // If the main encoding is some variant of UTF8, use CJKutf8.
+               if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
+                       if (encoding().iconvName() == "UTF-8"
+                           && LaTeXFeatures::isAvailable("CJKutf8"))
+                               os << "\\usepackage{CJKutf8}\n";
+                       else
+                               os << "\\usepackage{CJK}\n";
+               }
        }
 }