]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.cpp
GuiBox.cpp: make a logic setting more clear
[lyx.git] / src / BufferParams.cpp
index 0604a99b0e15fd494c04b7d0b00d6b35c0b3fc15..a12a2860dc037d4c7d87a068b998180c278e5ded 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;
 }
 
@@ -274,7 +275,8 @@ CiteEngineTypeTranslator const init_citeenginetypetranslator()
 
 CiteEngineTypeTranslator const & citeenginetypetranslator()
 {
-       static CiteEngineTypeTranslator translator = init_citeenginetypetranslator();
+       static CiteEngineTypeTranslator const translator =
+               init_citeenginetypetranslator();
        return translator;
 }
 
@@ -296,7 +298,7 @@ SpaceTranslator const init_spacetranslator()
 
 SpaceTranslator const & spacetranslator()
 {
-       static SpaceTranslator translator = init_spacetranslator();
+       static SpaceTranslator const translator = init_spacetranslator();
        return translator;
 }
 
@@ -365,8 +367,8 @@ BufferParams::BufferParams()
        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;
@@ -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");
@@ -623,7 +634,7 @@ string BufferParams::readToken(Lexer & lex, string const & token,
                                                 "See section 3.1.2.2 (Class Availability) of the\n"
                                                 "User's Guide for more information."), desc, prereqs);
                        frontend::Alert::warning(_("Document class not available"),
-                                      msg);
+                                      msg, true);
                }
        } else if (token == "\\begin_preamble") {
                readPreamble(lex);
@@ -744,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();
@@ -1170,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';
@@ -1194,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");
@@ -1280,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
@@ -1306,6 +1326,11 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
        // are doing!
        if (features.mustProvide("fix-cm"))
                os << "\\RequirePackage{fix-cm}\n";
+       // Likewise for fixltx2e. If other packages conflict with this policy,
+       // treat it as a package bug (and report it!)
+       // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
+       if (features.mustProvide("fixltx2e"))
+               os << "\\RequirePackage{fixltx2e}\n";
 
        os << "\\documentclass";
 
@@ -1471,32 +1496,16 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                   << from_ascii(fonts_default_family) << "}\n";
 
        // set font encoding
-       // for arabic_arabi and farsi we also need to load the LAE and
-       // LFE encoding
-       // XeTeX and LuaTeX (with OS fonts) work without fontenc
-       if (font_encoding() != "default" && language->lang() != "japanese"
-           && !useNonTeXFonts && !features.isProvided("fontenc")) {
-               docstring extra_encoding;
-               if (features.mustProvide("textgreek"))
-                       extra_encoding += from_ascii("LGR");
-               if (features.mustProvide("textcyr")) {
-                       if (!extra_encoding.empty())
-                               extra_encoding.push_back(',');
-                       extra_encoding += from_ascii("T2A");
-               }
-               if (!extra_encoding.empty() && !font_encoding().empty())
-                       extra_encoding.push_back(',');
-               size_t fars = language_options.str().find("farsi");
-               size_t arab = language_options.str().find("arabic");
-               if (language->lang() == "arabic_arabi"
-                       || language->lang() == "farsi" || fars != string::npos
-                       || arab != string::npos) {
-                       os << "\\usepackage[" << extra_encoding
-                          << from_ascii(font_encoding())
-                          << ",LFE,LAE]{fontenc}\n";
-               } else {
-                       os << "\\usepackage[" << extra_encoding
-                          << from_ascii(font_encoding())
+       // XeTeX and LuaTeX (with OS fonts) do not need fontenc
+       if (!useNonTeXFonts && !features.isProvided("fontenc")
+           && font_encoding() != "default") {
+               // get main font encodings
+               vector<string> fontencs = font_encodings();
+               // get font encodings of secondary languages
+               features.getFontEncodings(fontencs);
+               if (!fontencs.empty()) {
+                       os << "\\usepackage["
+                          << from_ascii(getStringFromVector(fontencs))
                           << "]{fontenc}\n";
                }
        }
@@ -1530,21 +1539,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;
@@ -1771,6 +1765,9 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                        lyxpreamble += "\\synctex=-1\n";
        }
 
+       // The package options (via \PassOptionsToPackage)
+       lyxpreamble += from_ascii(features.getPackageOptions());
+
        // 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
@@ -1887,6 +1884,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
@@ -1943,7 +1947,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, bicaption and listings (bug 8995) have to be
+       // called after babel, though.
        if (use_babel && !features.isRequired("jurabib")
            && !features.isRequired("hyperref")
                && !features.isRequired("varioref")
@@ -1955,6 +1960,19 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                                                   features.needBabelLangOptions())) + '\n';
                lyxpreamble += from_utf8(features.getBabelPostsettings());
        }
+       if (features.isRequired("bicaption"))
+               lyxpreamble += "\\usepackage{bicaption}\n";
+       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
@@ -2101,7 +2119,7 @@ LayoutFileIndex const & BufferParams::baseClassID() const
 }
 
 
-void BufferParams::makeDocumentClass()
+void BufferParams::makeDocumentClass(bool const clone)
 {
        if (!baseClass())
                return;
@@ -2117,7 +2135,7 @@ void BufferParams::makeDocumentClass()
        for (; it != en; ++it)
                mods.push_back(*it);
 
-       doc_class_ = getDocumentClass(*baseClass(), mods);
+       doc_class_ = getDocumentClass(*baseClass(), mods, clone);
 
        TextClass::ReturnValues success = TextClass::OK;
        if (!forced_local_layout_.empty())
@@ -2264,7 +2282,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;
@@ -2346,7 +2364,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);
 }
@@ -2734,7 +2752,31 @@ string const BufferParams::dvips_options() const
 
 string const BufferParams::font_encoding() const
 {
-       return (fontenc == "global") ? lyxrc.fontenc : fontenc;
+       return font_encodings().empty() ? "default" : font_encodings().back();
+}
+
+
+vector<string> const BufferParams::font_encodings() const
+{
+       string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
+
+       vector<string> fontencs;
+
+       // "default" means "no explicit font encoding"
+       if (doc_fontenc != "default") {
+               fontencs = getVectorFromString(doc_fontenc);
+               if (!language->fontenc().empty()
+                   && ascii_lowercase(language->fontenc()) != "none") {
+                       vector<string> fencs = getVectorFromString(language->fontenc());
+                       vector<string>::const_iterator fit = fencs.begin();
+                       for (; fit != fencs.end(); ++fit) {
+                               if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
+                                       fontencs.push_back(*fit);
+                       }
+               }
+       }
+
+       return fontencs;
 }
 
 
@@ -2804,7 +2846,8 @@ void BufferParams::writeEncodingPreamble(otexstream & os,
                // inputenc must be omitted.
                // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
                if ((!encodings.empty() || package == Encoding::inputenc)
-                   && !features.isRequired("japanese")) {
+                   && !features.isRequired("japanese")
+                   && !features.isProvided("inputenc")) {
                        os << "\\usepackage[";
                        set<string>::const_iterator it = encodings.begin();
                        set<string>::const_iterator const end = encodings.end();
@@ -2835,7 +2878,9 @@ void BufferParams::writeEncodingPreamble(otexstream & os,
                        break;
                case Encoding::inputenc:
                        // do not load inputenc if japanese is used
-                       if (features.isRequired("japanese"))
+                       // or if the class provides inputenc
+                       if (features.isRequired("japanese")
+                           || features.isProvided("inputenc"))
                                break;
                        os << "\\usepackage[" << from_ascii(encoding().latexName())
                           << "]{inputenc}\n";
@@ -2971,7 +3016,8 @@ Encoding const & BufferParams::encoding() const
        // FIXME: actually, we should check for the flavor
        // or runparams.isFullyUnicode() here:
        // This check will not work with XeTeX/LuaTeX and tex fonts.
-       // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
+       // Thus we have to reset the encoding in Buffer::makeLaTeXFile
+       // (for export) and Buffer::writeLaTeXSource (for preview).
        if (useNonTeXFonts)
                return *(encodings.fromLyXName("utf8-plain"));
        if (inputenc == "auto" || inputenc == "default")