]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.cpp
Properly handle the bicaption package (bug #9449)
[lyx.git] / src / BufferParams.cpp
index b1a61b9b406b33065000f26dd54ed2ce594ee586..5cf529c430df28eff78d1029bca3d79ec3c1eee1 100644 (file)
@@ -30,6 +30,7 @@
 #include "IndicesList.h"
 #include "Language.h"
 #include "LaTeXFeatures.h"
+#include "LaTeXFonts.h"
 #include "ModuleList.h"
 #include "Font.h"
 #include "Lexer.h"
@@ -51,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"
 
@@ -86,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",
@@ -121,7 +118,8 @@ ParSepTranslator const init_parseptranslator()
 
 ParSepTranslator const & parseptranslator()
 {
-       static ParSepTranslator translator = init_parseptranslator();
+       static ParSepTranslator const translator =
+               init_parseptranslator();
        return translator;
 }
 
@@ -145,7 +143,8 @@ QuotesLangTranslator const init_quoteslangtranslator()
 
 QuotesLangTranslator const & quoteslangtranslator()
 {
-       static QuotesLangTranslator translator = init_quoteslangtranslator();
+       static QuotesLangTranslator const translator =
+               init_quoteslangtranslator();
        return translator;
 }
 
@@ -195,7 +194,8 @@ static PaperSizeTranslator initPaperSizeTranslator()
 
 PaperSizeTranslator const & papersizetranslator()
 {
-       static PaperSizeTranslator translator = initPaperSizeTranslator();
+       static PaperSizeTranslator const translator =
+               initPaperSizeTranslator();
        return translator;
 }
 
@@ -214,7 +214,8 @@ PaperOrientationTranslator const init_paperorientationtranslator()
 
 PaperOrientationTranslator const & paperorientationtranslator()
 {
-       static PaperOrientationTranslator translator = init_paperorientationtranslator();
+       static PaperOrientationTranslator const translator =
+           init_paperorientationtranslator();
        return translator;
 }
 
@@ -233,7 +234,7 @@ SidesTranslator const init_sidestranslator()
 
 SidesTranslator const & sidestranslator()
 {
-       static SidesTranslator translator = init_sidestranslator();
+       static SidesTranslator const translator = init_sidestranslator();
        return translator;
 }
 
@@ -253,7 +254,8 @@ PackageTranslator const init_packagetranslator()
 
 PackageTranslator const & packagetranslator()
 {
-       static PackageTranslator translator = init_packagetranslator();
+       static PackageTranslator const translator =
+               init_packagetranslator();
        return translator;
 }
 
@@ -266,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;
 }
 
@@ -294,7 +298,7 @@ SpaceTranslator const init_spacetranslator()
 
 SpaceTranslator const & spacetranslator()
 {
-       static SpaceTranslator translator = init_spacetranslator();
+       static SpaceTranslator const translator = init_spacetranslator();
        return translator;
 }
 
@@ -334,8 +338,7 @@ BufferParams::Impl::Impl()
 BufferParams::Impl *
 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
 {
-       LASSERT(ptr, /**/);
-
+       LBUFERR(ptr);
        return new BufferParams::Impl(*ptr);
 }
 
@@ -360,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;
@@ -375,6 +378,7 @@ BufferParams::BufferParams()
        fonts_roman = "default";
        fonts_sans = "default";
        fonts_typewriter = "default";
+       fonts_math = "auto";
        fonts_default_family = "default";
        useNonTeXFonts = false;
        fonts_expert_sc = false;
@@ -413,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;
@@ -421,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);
 }
 
@@ -441,18 +446,39 @@ void BufferParams::use_package(std::string const & p, BufferParams::Package u)
 }
 
 
-vector<string> const & BufferParams::auto_packages()
+map<string, string> const & BufferParams::auto_packages()
 {
-       static vector<string> 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.push_back("amsmath");
-               packages.push_back("amssymb");
-               packages.push_back("esint");
-               packages.push_back("mathdots");
-               packages.push_back("mathtools");
-               packages.push_back("mhchem");
-               packages.push_back("undertilde");
+               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");
+               packages["amssymb"] =
+                       N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
+               packages["cancel"] =
+                       N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
+               packages["esint"] =
+                       N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
+               packages["mathdots"] =
+                       N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
+               packages["mathtools"] =
+                       N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
+               packages["mhchem"] =
+                       N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
+               packages["stackrel"] =
+                       N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
+               packages["stmaryrd"] =
+                       N_("The LaTeX package stmaryrd is only used if symbols from the St Mary's Road symbol font for theoretical computer science are inserted into formulas");
+               packages["undertilde"] =
+                       N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
        }
        return packages;
 }
@@ -496,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];
 }
 
@@ -583,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
@@ -612,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") {
@@ -662,6 +691,9 @@ string BufferParams::readToken(Lexer & lex, string const & token,
        } else if (token == "\\font_typewriter") {
                lex.eatLine();
                fonts_typewriter = lex.getString();
+       } else if (token == "\\font_math") {
+               lex.eatLine();
+               fonts_math = lex.getString();
        } else if (token == "\\font_default_family") {
                lex >> fonts_default_family;
        } else if (token == "\\use_non_tex_fonts") {
@@ -723,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();
@@ -810,10 +842,12 @@ string BufferParams::readToken(Lexer & lex, string const & token,
                lex.eatLine();
                string color = lex.getString();
                notefontcolor = lyx::rgbFromHexName(color);
+               lcolor.setColor("notefontcolor", color);
        } else if (token == "\\boxbgcolor") {
                lex.eatLine();
                string color = lex.getString();
                boxbgcolor = lyx::rgbFromHexName(color);
+               lcolor.setColor("boxbgcolor", color);
        } else if (token == "\\paperwidth") {
                lex >> paperwidth;
        } else if (token == "\\paperheight") {
@@ -970,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");
@@ -977,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)
@@ -987,6 +1030,7 @@ void BufferParams::writeFile(ostream & os) const
           << "\n\\font_roman " << fonts_roman
           << "\n\\font_sans " << fonts_sans
           << "\n\\font_typewriter " << fonts_typewriter
+          << "\n\\font_math " << fonts_math
           << "\n\\font_default_family " << fonts_default_family
           << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
           << "\n\\font_sc " << convert<string>(fonts_expert_sc)
@@ -997,7 +1041,7 @@ void BufferParams::writeFile(ostream & os) const
        if (!fonts_cjk.empty()) {
                os << "\\font_cjk " << fonts_cjk << '\n';
        }
-       os << "\n\\graphics " << graphics_driver << '\n';
+       os << "\\graphics " << graphics_driver << '\n';
        os << "\\default_output_format " << default_output_format << '\n';
        os << "\\output_sync " << output_sync << '\n';
        if (!output_sync_macro.empty())
@@ -1015,10 +1059,11 @@ void BufferParams::writeFile(ostream & os) const
 
        os << "\\papersize " << string_papersize[papersize]
           << "\n\\use_geometry " << convert<string>(use_geometry);
-       vector<string> const & packages = auto_packages();
-       for (size_t i = 0; i < packages.size(); ++i)
-               os << "\n\\use_package " << packages[i] << ' '
-                  << use_package(packages[i]);
+       map<string, string> const & packages = auto_packages();
+       for (map<string, string>::const_iterator it = packages.begin();
+            it != packages.end(); ++it)
+               os << "\n\\use_package " << it->first << ' '
+                  << use_package(it->first);
 
        os << "\n\\cite_engine ";
 
@@ -1136,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';
@@ -1157,7 +1202,10 @@ void BufferParams::validate(LaTeXFeatures & features) const
 {
        features.require(documentClass().requires());
 
-       if (outputChanges) {
+       if (columns > 1 && language->rightToLeft())
+               features.require("rtloutputdblcol");
+
+       if (output_changes) {
                bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
                bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
                                  LaTeXFeatures::isAvailable("xcolor");
@@ -1203,7 +1251,7 @@ void BufferParams::validate(LaTeXFeatures & features) const
                if (it->first == "amsmath") {
                        // AMS Style is at document level
                        if (it->second == package_on ||
-                           documentClass().provides("amsmath"))
+                           features.isProvided("amsmath"))
                                features.require(it->first);
                } else if (it->second == package_on)
                        features.require(it->first);
@@ -1243,29 +1291,27 @@ 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
-                 || language->lang() == "ancientgreek"
-                 || language->lang() == "coptic"
-                 || language->lang() == "divehi"
-                 || language->lang() == "hindi"
-                 || language->lang() == "kurmanji"
-                 || language->lang() == "lao"
-                 || language->lang() == "marathi"
-                 || language->lang() == "occitan"
-                 || language->lang() == "sanskrit"
-                 || language->lang() == "syriac"
-                 || language->lang() == "tamil"
-                 || language->lang() == "telugu"
-                 || language->lang() == "urdu"
-                ) && useNonTeXFonts)
+       if (features.runparams().flavor == OutputParams::XETEX
+           && (features.hasPolyglossiaExclusiveLanguages()
+               || useNonTeXFonts))
                features.require("polyglossia");
 
-       if (language->lang() == "vietnamese")
-               features.require("vietnamese");
-       else if (language->lang() == "japanese")
-               features.require("japanese");
+       if (useNonTeXFonts && fonts_math != "auto")
+               features.require("unicode-math");
+
+       if (!language->requires().empty())
+               features.require(language->requires());
 }
 
 
@@ -1385,17 +1431,18 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                features.useLanguage(default_language);
 
        ostringstream language_options;
-       bool const use_babel = features.useBabel() && !tclass.provides("babel");
+       bool const use_babel = features.useBabel() && !features.isProvided("babel");
        bool const use_polyglossia = features.usePolyglossia();
        bool const global = lyxrc.language_global_options;
        if (use_babel || (use_polyglossia && global)) {
-               language_options << features.getLanguages();
+               language_options << features.getBabelLanguages();
                if (!language->babel().empty()) {
                        if (!language_options.str().empty())
                                language_options << ',';
                        language_options << language->babel();
                }
-               if (global && !features.needBabelLangOptions())
+               if (global && !features.needBabelLangOptions()
+                   && !language_options.str().empty())
                        clsoptions << language_options.str() << ',';
        }
 
@@ -1418,20 +1465,24 @@ 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)
+       if (useNonTeXFonts) {
                os << "\\usepackage{fontspec}\n";
+               if (features.mustProvide("unicode-math")
+                   && features.isAvailable("unicode-math"))
+                       os << "\\usepackage{unicode-math}\n";
+       }
 
        // font selection must be done before loading fontenc.sty
-       string const fonts =
-               loadFonts(fonts_roman, fonts_sans, fonts_typewriter,
-                         fonts_expert_sc, fonts_old_figures,
-                         fonts_sans_scale, fonts_typewriter_scale,
-                         useNonTeXFonts, features);
+       string const fonts = loadFonts(features);
        if (!fonts.empty())
                os << from_utf8(fonts);
 
@@ -1440,20 +1491,26 @@ 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 && !tclass.provides("fontenc")) {
-               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[" << from_ascii(font_encoding())
-                          << ",LFE,LAE]{fontenc}\n";
-               } else {
-                       os << "\\usepackage[" << from_ascii(font_encoding())
+       // XeTeX and LuaTeX (with OS fonts) do not need fontenc
+       if (!useNonTeXFonts && !features.isProvided("fontenc")
+           && font_encoding() != "default") {
+               vector<string> fontencs;
+               // primary language font encoding and default encoding
+               if (ascii_lowercase(language->fontenc()) != "none") {
+                       vector<string> fencs = getVectorFromString(font_encoding());
+                       fontencs.insert(fontencs.end(), fencs.begin(), fencs.end());
+                       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);
+                       }
+               }
+               // get font encodings of secondary languages
+               features.getFontEncodings(fontencs);
+               if (!fontencs.empty()) {
+                       os << "\\usepackage["
+                          << from_ascii(getStringFromVector(fontencs))
                           << "]{fontenc}\n";
                }
        }
@@ -1487,22 +1544,7 @@ 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 (!tclass.provides("geometry")
+       if (!features.isProvided("geometry")
            && (use_geometry || nonstandard_papersize)) {
                odocstringstream ods;
                if (!getGraphicsDriver("geometry").empty())
@@ -1728,6 +1770,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
@@ -1736,10 +1781,12 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
        // 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 we use hyperref, jurabib, japanese, varioref or vietnamese,
+       // we have to call babel before
        if (use_babel
            && (features.isRequired("jurabib")
                || features.isRequired("hyperref")
+               || features.isRequired("varioref")
                || features.isRequired("vietnamese")
                || features.isRequired("japanese"))) {
                        // FIXME UNICODE
@@ -1757,16 +1804,27 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                IndicesList::const_iterator iit = indiceslist().begin();
                IndicesList::const_iterator iend = indiceslist().end();
                for (; iit != iend; ++iit) {
+                       pair<docstring, docstring> indexname_latex =
+                               features.runparams().encoding->latexString(iit->index(),
+                                                                          features.runparams().dryrun);
+                       if (!indexname_latex.second.empty()) {
+                               // issue a warning about omitted characters
+                               // FIXME: should be passed to the error dialog
+                               frontend::Alert::warning(_("Uncodable characters"),
+                                       bformat(_("The following characters that are used in an index name are not\n"
+                                                 "representable in the current encoding and therefore have been omitted:\n%1$s."),
+                                               indexname_latex.second));
+                       }
                        lyxpreamble += "\\newindex[";
-                       lyxpreamble += iit->index();
+                       lyxpreamble += indexname_latex.first;
                        lyxpreamble += "]{";
-                       lyxpreamble += iit->shortcut();
+                       lyxpreamble += escape(iit->shortcut());
                        lyxpreamble += "}\n";
                }
        }
 
        // Line spacing
-       lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
+       lyxpreamble += from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
 
        // PDF support.
        // * Hyperref manual: "Make sure it comes last of your loaded
@@ -1784,7 +1842,7 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
 
                OutputParams tmp_params = features.runparams();
                pdfoptions().writeLaTeX(tmp_params, os,
-                                       documentClass().provides("hyperref"));
+                                       features.isProvided("hyperref"));
                // set back for the rest
                lyxpreamble.clear();
                // correctly break URLs with hyperref and dvi output
@@ -1831,6 +1889,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
@@ -1887,9 +1952,11 @@ 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 and Hyperref 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")
            && !features.isRequired("vietnamese")
            && !features.isRequired("japanese")) {
                // FIXME UNICODE
@@ -1898,10 +1965,24 @@ 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
-       if (features.runparams().flavor == OutputParams::XETEX)
+       if (features.runparams().flavor == OutputParams::XETEX
+           && useNonTeXFonts)
                lyxpreamble += "\\usepackage{xunicode}\n";
 
        // Polyglossia must be loaded last
@@ -1925,6 +2006,15 @@ bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
                }
        }
 
+       // Load custom language package here
+       if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
+               if (lang_package == "default")
+                       lyxpreamble += from_utf8(lyxrc.language_custom_package);
+               else
+                       lyxpreamble += from_utf8(lang_package);
+               lyxpreamble += '\n';
+       }
+
        docstring const i18npreamble =
                features.getTClassI18nPreamble(use_babel, use_polyglossia);
        if (!i18npreamble.empty())
@@ -2034,40 +2124,64 @@ LayoutFileIndex const & BufferParams::baseClassID() const
 }
 
 
-void BufferParams::makeDocumentClass()
+void BufferParams::makeDocumentClass(bool const clone)
 {
        if (!baseClass())
                return;
 
        LayoutModuleList mods;
-       LayoutModuleList::iterator it;
-       LayoutModuleList::iterator en;
-
-       it = layout_modules_.begin();
-       en = layout_modules_.end();
+       LayoutModuleList::iterator it = layout_modules_.begin();
+       LayoutModuleList::iterator en = layout_modules_.end();
        for (; it != en; ++it)
                mods.push_back(*it);
+
        it = cite_engine_.begin();
        en = cite_engine_.end();
        for (; it != en; ++it)
                mods.push_back(*it);
-       doc_class_ = getDocumentClass(*baseClass(), mods);
 
-       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);
-               }
+       doc_class_ = getDocumentClass(*baseClass(), mods, clone);
+
+       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);
        }
 }
 
 
-bool BufferParams::moduleCanBeAdded(string const & modName) const
+bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
 {
-       return cite_engine_.moduleCanBeAdded(modName, baseClass()) &&
-               layout_modules_.moduleCanBeAdded(modName, baseClass());
+       return layout_modules_.moduleCanBeAdded(modName, baseClass());
+}
+
+
+bool BufferParams::citationModuleCanBeAdded(string const & modName) const
+{
+       return cite_engine_.moduleCanBeAdded(modName, baseClass());
+}
+
+
+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;
 }
 
 
@@ -2107,13 +2221,6 @@ bool BufferParams::isExportable(string const & format) const
 }
 
 
-namespace {
-bool formatSorter(Format const * lhs, Format const * rhs) {
-       return _(lhs->prettyname()) < _(rhs->prettyname());
-}
-}
-
-
 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
 {
        vector<string> const backs = backends();
@@ -2130,7 +2237,6 @@ vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
                        theConverters().getReachable(*it, only_viewable, false, excludes);
                result.insert(result.end(), r.begin(), r.end());
        }
-       sort(result.begin(), result.end(), formatSorter);
        return result;
 }
 
@@ -2166,8 +2272,11 @@ vector<string> BufferParams::backends() const
                v.push_back("xetex");
        } else if (buffmt == "xetex") {
                v.push_back("xetex");
-               v.push_back("luatex");
-               v.push_back("dviluatex");
+               // FIXME: need to test all languages (bug 8205)
+               if (!language || !language->isPolyglossiaExclusive()) {
+                       v.push_back("luatex");
+                       v.push_back("dviluatex");
+               }
        } else
                v.push_back(buffmt);
 
@@ -2178,7 +2287,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;
@@ -2190,12 +2299,22 @@ OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
 
        OutputParams::FLAVOR result = OutputParams::LATEX;
 
+       // FIXME It'd be better not to hardcode this, but to do
+       //       something with formats.
        if (dformat == "xhtml")
                result = OutputParams::HTML;
        else if (dformat == "text")
                result = OutputParams::TEXT;
        else if (dformat == "lyx")
                result = OutputParams::LYX;
+       else if (dformat == "pdflatex")
+               result = OutputParams::PDFLATEX;
+       else if (dformat == "xetex")
+               result = OutputParams::XETEX;
+       else if (dformat == "luatex")
+               result = OutputParams::LUATEX;
+       else if (dformat == "dviluatex")
+               result = OutputParams::DVILUATEX;
        else {
                // Try to determine flavor of default output format
                vector<string> backs = backends();
@@ -2225,7 +2344,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())
@@ -2233,6 +2351,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;
 }
 
@@ -2249,6 +2369,12 @@ Font const BufferParams::getFont() const
 }
 
 
+InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const & qs) const
+{
+       return quoteslangtranslator().find(qs);
+}
+
+
 bool BufferParams::isLatex() const
 {
        return documentClass().outputType() == LATEX;
@@ -2277,13 +2403,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");
 }
 
 
@@ -2631,11 +2763,6 @@ string const BufferParams::font_encoding() const
 
 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
 {
-       if (lang_package != "auto" && lang_package != "babel"
-           && lang_package != "default" && lang_package != "none")
-               return lang_package;
-       if (lyxrc.language_package_selection == LyXRC::LP_CUSTOM)
-               return lyxrc.language_custom_package;
        // suppress the babel call if there is no BabelName defined
        // for the document language in the lib/languages file and if no
        // other languages are used (lang_opts is then empty)
@@ -2699,11 +2826,9 @@ void BufferParams::writeEncodingPreamble(otexstream & os,
                // If the "japanese" package (i.e. pLaTeX) is used,
                // inputenc must be omitted.
                // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
-               if (package == Encoding::japanese)
-                    features.require("japanese");
-
                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();
@@ -2734,9 +2859,11 @@ 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(inputenc)
+                       os << "\\usepackage[" << from_ascii(encoding().latexName())
                           << "]{inputenc}\n";
                        break;
                case Encoding::CJK:
@@ -2747,13 +2874,16 @@ 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";
+               }
        }
-
-       // The encoding "armscii8" (for Armenian) is only available when
-       // the package "armtex" is loaded.
-       if (language->encoding()->latexName() == "armscii8"
-           || inputenc == "armscii8")
-               os << "\\usepackage{armtex}\n";
 }
 
 
@@ -2768,26 +2898,11 @@ string const BufferParams::parseFontName(string const & name) const
 }
 
 
-string const BufferParams::loadFonts(string const & rm,
-                                    string const & sf, string const & tt,
-                                    bool const & sc, bool const & osf,
-                                    int const & sfscale, int const & ttscale,
-                                    bool const & use_systemfonts,
-                                    LaTeXFeatures & features) const
-{
-       /* The LaTeX font world is in a flux. In the PSNFSS font interface,
-          several packages have been replaced by others, that might not
-          be installed on every system. We have to take care for that
-          (see psnfss.pdf). We try to support all psnfss fonts as well
-          as the fonts that have become de facto standard in the LaTeX
-          world (e.g. Latin Modern). We do not support obsolete fonts
-          (like PSLatex). In general, it should be possible to mix any
-          rm font with any sf or tt font, respectively. (JSpitzm)
-          TODO:
-               -- separate math fonts.
-       */
-
-       if (rm == "default" && sf == "default" && tt == "default")
+string const BufferParams::loadFonts(LaTeXFeatures & features) const
+{
+       if (fonts_roman == "default" && fonts_sans == "default"
+           && fonts_typewriter == "default"
+           && (fonts_math == "default" || fonts_math == "auto"))
                //nothing to do
                return string();
 
@@ -2803,7 +2918,7 @@ string const BufferParams::loadFonts(string const & rm,
         *    -- if there's a way to find out if a font really supports
         *       OldStyle, enable/disable the widget accordingly.
        */
-       if (use_systemfonts && features.isAvailable("fontspec")) {
+       if (useNonTeXFonts && features.isAvailable("fontspec")) {
                // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
                // However, until v.2 (2010/07/11) fontspec only knew
                // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
@@ -2816,28 +2931,28 @@ string const BufferParams::loadFonts(string const & rm,
                string const texmapping =
                        (features.runparams().flavor == OutputParams::XETEX) ?
                        "Mapping=tex-text" : "Ligatures=TeX";
-               if (rm != "default") {
+               if (fonts_roman != "default") {
                        os << "\\setmainfont[" << texmapping;
-                       if (osf)
+                       if (fonts_old_figures)
                                os << ",Numbers=OldStyle";
-                       os << "]{" << parseFontName(rm) << "}\n";
+                       os << "]{" << parseFontName(fonts_roman) << "}\n";
                }
-               if (sf != "default") {
-                       string const sans = parseFontName(sf);
-                       if (sfscale != 100)
+               if (fonts_sans != "default") {
+                       string const sans = parseFontName(fonts_sans);
+                       if (fonts_sans_scale != 100)
                                os << "\\setsansfont[Scale="
-                                  << float(sfscale) / 100
+                                  << float(fonts_sans_scale) / 100
                                   << "," << texmapping << "]{"
                                   << sans << "}\n";
                        else
                                os << "\\setsansfont[" << texmapping << "]{"
                                   << sans << "}\n";
                }
-               if (tt != "default") {
-                       string const mono = parseFontName(tt);
-                       if (ttscale != 100)
+               if (fonts_typewriter != "default") {
+                       string const mono = parseFontName(fonts_typewriter);
+                       if (fonts_typewriter_scale != 100)
                                os << "\\setmonofont[Scale="
-                                  << float(ttscale) / 100
+                                  << float(fonts_typewriter_scale) / 100
                                   << "]{"
                                   << mono << "}\n";
                        else
@@ -2847,115 +2962,31 @@ string const BufferParams::loadFonts(string const & rm,
                return os.str();
        }
 
+       // Tex Fonts
+       bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
+       bool const dryrun = features.runparams().dryrun;
+       bool const complete = (fonts_sans == "default" && fonts_typewriter == "default");
+       bool const nomath = (fonts_math == "default");
+
        // ROMAN FONTS
-       // Computer Modern (must be explicitly selectable -- there might be classes
-       // that define a different default font!
-       if (rm == "cmr") {
-               os << "\\renewcommand{\\rmdefault}{cmr}\n";
-               // osf for Computer Modern needs eco.sty
-               if (osf)
-                       os << "\\usepackage{eco}\n";
-       }
-       // Latin Modern Roman
-       else if (rm == "lmodern")
-               os << "\\usepackage{lmodern}\n";
-       // AE
-       else if (rm == "ae") {
-               // not needed when using OT1 font encoding.
-               if (font_encoding() != "default")
-                       os << "\\usepackage{ae,aecompl}\n";
-       }
-       // Times
-       else if (rm == "times") {
-               // try to load the best available package
-               if (LaTeXFeatures::isAvailable("mathptmx"))
-                       os << "\\usepackage{mathptmx}\n";
-               else if (LaTeXFeatures::isAvailable("mathptm"))
-                       os << "\\usepackage{mathptm}\n";
-               else
-                       os << "\\usepackage{times}\n";
-       }
-       // Palatino
-       else if (rm == "palatino") {
-               // try to load the best available package
-               if (LaTeXFeatures::isAvailable("mathpazo")) {
-                       os << "\\usepackage";
-                       if (osf || sc) {
-                               os << '[';
-                               if (!osf)
-                                       os << "sc";
-                               else
-                                       // "osf" includes "sc"!
-                                       os << "osf";
-                               os << ']';
-                       }
-                       os << "{mathpazo}\n";
-               }
-               else if (LaTeXFeatures::isAvailable("mathpple"))
-                       os << "\\usepackage{mathpple}\n";
-               else
-                       os << "\\usepackage{palatino}\n";
-       }
-       // Utopia
-       else if (rm == "utopia") {
-               // fourier supersedes utopia.sty, but does
-               // not work with OT1 encoding.
-               if (LaTeXFeatures::isAvailable("fourier")
-                   && font_encoding() != "default") {
-                       os << "\\usepackage";
-                       if (osf || sc) {
-                               os << '[';
-                               if (sc)
-                                       os << "expert";
-                               if (osf && sc)
-                                       os << ',';
-                               if (osf)
-                                       os << "oldstyle";
-                               os << ']';
-                       }
-                       os << "{fourier}\n";
-               }
-               else
-                       os << "\\usepackage{utopia}\n";
-       }
-       // Bera (complete fontset)
-       else if (rm == "bera" && sf == "default" && tt == "default")
-               os << "\\usepackage{bera}\n";
-       // everything else
-       else if (rm != "default")
-               os << "\\usepackage" << "{" << rm << "}\n";
+       os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_roman)).getLaTeXCode(
+               dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
+               nomath);
 
        // SANS SERIF
-       // Helvetica, Bera Sans
-       if (sf == "helvet" || sf == "berasans") {
-               if (sfscale != 100)
-                       os << "\\usepackage[scaled=" << float(sfscale) / 100
-                          << "]{" << sf << "}\n";
-               else
-                       os << "\\usepackage{" << sf << "}\n";
-       }
-       // Avant Garde
-       else if (sf == "avant")
-               os << "\\usepackage{" << sf << "}\n";
-       // Computer Modern, Latin Modern, CM Bright
-       else if (sf != "default")
-               os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
-
-       // monospaced/typewriter
-       // Courier, LuxiMono
-       if (tt == "luximono" || tt == "beramono") {
-               if (ttscale != 100)
-                       os << "\\usepackage[scaled=" << float(ttscale) / 100
-                          << "]{" << tt << "}\n";
-               else
-                       os << "\\usepackage{" << tt << "}\n";
-       }
-       // Courier
-       else if (tt == "courier" )
-               os << "\\usepackage{" << tt << "}\n";
-       // Computer Modern, Latin Modern, CM Bright
-       else if (tt != "default")
-               os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
+       os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_sans)).getLaTeXCode(
+               dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
+               nomath, fonts_sans_scale);
+
+       // MONOSPACED/TYPEWRITER
+       os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_typewriter)).getLaTeXCode(
+               dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
+               nomath, fonts_typewriter_scale);
+
+       // MATH
+       os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getLaTeXCode(
+               dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
+               nomath);
 
        return os.str();
 }
@@ -2966,12 +2997,13 @@ 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.fromLaTeXName("utf8-plain"));
+               return *(encodings.fromLyXName("utf8-plain"));
        if (inputenc == "auto" || inputenc == "default")
                return *language->encoding();
-       Encoding const * const enc = encodings.fromLaTeXName(inputenc);
+       Encoding const * const enc = encodings.fromLyXName(inputenc);
        if (enc)
                return *enc;
        LYXERR0("Unknown inputenc value `" << inputenc