src/LaTeXFeatures.cpp

   1 /**
   2  * \file LaTeXFeatures.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author José Matos
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author Jürgen Vigna
  10  * \author André Pönitz
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "LaTeXFeatures.h"
  18
  19 #include "Buffer.h"
  20 #include "BufferParams.h"
  21 #include "ColorSet.h"
  22 #include "Converter.h"
  23 #include "Encoding.h"
  24 #include "Floating.h"
  25 #include "FloatList.h"
  26 #include "Language.h"
  27 #include "LaTeXFonts.h"
  28 #include "LaTeXPackages.h"
  29 #include "Layout.h"
  30 #include "Lexer.h"
  31 #include "LyXRC.h"
  32 #include "TextClass.h"
  33
  34 #include "insets/InsetLayout.h"
  35
  36 #include "support/debug.h"
  37 #include "support/docstream.h"
  38 #include "support/FileName.h"
  39 #include "support/filetools.h"
  40 #include "support/gettext.h"
  41 #include "support/lstrings.h"
  42 #include "support/regex.h"
  43
  44 #include <algorithm>
  45
  46
  47 using namespace std;
  48 using namespace lyx::support;
  49
  50
  51 namespace lyx {
  52
  53 /////////////////////////////////////////////////////////////////////
  54 //
  55 // Strings
  56 //
  57 /////////////////////////////////////////////////////////////////////
  58
  59 //\NeedsTeXFormat{LaTeX2e}
  60 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
  61 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
  62
  63 static docstring const lyx_def = from_ascii(
  64         "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
  65
  66 static docstring const lyx_hyperref_def = from_ascii(
  67         "\\providecommand{\\LyX}{\\texorpdfstring%\n"
  68         "  {L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}\n"
  69         "  {LyX}}");
  70
  71 static docstring const noun_def = from_ascii(
  72         "\\newcommand{\\noun}[1]{\\textsc{#1}}");
  73
  74 static docstring const lyxarrow_def = from_ascii(
  75         "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
  76         "\\@ifstar\n"
  77         "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
  78         "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
  79
  80 // for quotes without babel. This does not give perfect results, but
  81 // anybody serious about non-english quotes should use babel (JMarc).
  82
  83 static docstring const quotedblbase_def = from_ascii(
  84         "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
  85         "  \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
  86         "  \\penalty10000\\hskip0em\\relax%\n"
  87         "}");
  88
  89 static docstring const quotesinglbase_def = from_ascii(
  90         "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
  91         "  \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
  92         "  \\penalty10000\\hskip0em\\relax%\n"
  93         "}");
  94
  95 static docstring const guillemotleft_def = from_ascii(
  96         "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
  97         "  {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
  98         "\\penalty10000\\hskip0pt\\relax%\n"
  99         "}");
 100
 101 static docstring const guillemotright_def = from_ascii(
 102         "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
 103         "  \\penalty10000\\hskip0pt%\n"
 104         "  {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
 105         "}");
 106
 107 static docstring const guilsinglleft_def = from_ascii(
 108         "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
 109         "  {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
 110         "  \\penalty10000\\hskip0pt\\relax%\n"
 111         "}");
 112
 113 static docstring const guilsinglright_def = from_ascii(
 114         "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
 115         "  \\penalty10000\\hskip0pt%\n"
 116         "  {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
 117         "}");
 118
 119 static docstring const paragraphleftindent_def = from_ascii(
 120         "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
 121         "{\n"
 122         "  \\begin{list}{}{%\n"
 123         "    \\setlength{\\topsep}{0pt}%\n"
 124         "    \\addtolength{\\leftmargin}{#1}\n"
 125 // ho hum, yet more things commented out with no hint as to why they
 126 // weren't just removed
 127 //      "%%    \\addtolength{\\leftmargin}{#1\\textwidth}\n"
 128 //      "%%    \\setlength{\\textwidth}{#2\\textwidth}\n"
 129 //      "%%    \\setlength\\listparindent\\parindent%\n"
 130 //      "%%    \\setlength\\itemindent\\parindent%\n"
 131         "    \\setlength{\\parsep}{0pt plus 1pt}%\n"
 132         "  }\n"
 133         "  \\item[]\n"
 134         "}\n"
 135         "{\\end{list}}\n");
 136
 137 static docstring const floatingfootnote_def = from_ascii(
 138         "%% Special footnote code from the package 'stblftnt.sty'\n"
 139         "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
 140         "\\let\\SF@@footnote\\footnote\n"
 141         "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
 142         "    \\expandafter\\SF@@footnote\n"
 143         "  \\else\n"
 144         "    \\expandafter\\SF@gobble@opt\n"
 145         "  \\fi\n"
 146         "}\n"
 147         "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
 148         "  \\SF@gobble@twobracket\n"
 149         "  \\@gobble\n"
 150         "}\n"
 151         "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
 152         "  \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
 153         "\\def\\SF@gobble@twobracket[#1]#2{}\n");
 154
 155 static docstring const binom_def = from_ascii(
 156         "%% Binom macro for standard LaTeX users\n"
 157         "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
 158
 159 static docstring const mathcircumflex_def = from_ascii(
 160         "%% For printing a cirumflex inside a formula\n"
 161         "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
 162
 163 static docstring const tabularnewline_def = from_ascii(
 164         "%% Because html converters don't know tabularnewline\n"
 165         "\\providecommand{\\tabularnewline}{\\\\}\n");
 166
 167 static docstring const lyxgreyedout_def = from_ascii(
 168         "%% The greyedout annotation environment\n"
 169         "\\newenvironment{lyxgreyedout}\n"
 170         "  {\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
 171         "  {\\ignorespacesafterend\\egroup}\n");
 172
 173 // We want to omit the file extension for includegraphics, but this does not
 174 // work when the filename contains other dots.
 175 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
 176 static docstring const lyxdot_def = from_ascii(
 177         "%% A simple dot to overcome graphicx limitations\n"
 178         "\\newcommand{\\lyxdot}{.}\n");
 179
 180 static docstring const changetracking_dvipost_def = from_ascii(
 181         "%% Change tracking with dvipost\n"
 182         "\\dvipostlayout\n"
 183         "\\dvipost{osstart color push Red}\n"
 184         "\\dvipost{osend color pop}\n"
 185         "\\dvipost{cbstart color push Blue}\n"
 186         "\\dvipost{cbend color pop}\n"
 187         "\\DeclareRobustCommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
 188         "\\DeclareRobustCommand{\\lyxdeleted}[3]{%\n"
 189         "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n");
 190
 191 static docstring const changetracking_xcolor_ulem_def = from_ascii(
 192         "%% Change tracking with ulem\n"
 193         "\\DeclareRobustCommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
 194         "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n");
 195
 196 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
 197         "%% Change tracking with ulem\n"
 198         "\\DeclareRobustCommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
 199         "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n");
 200
 201 static docstring const changetracking_none_def = from_ascii(
 202         "\\newcommand{\\lyxadded}[3]{#3}\n"
 203         "\\newcommand{\\lyxdeleted}[3]{}\n");
 204
 205 static docstring const textgreek_LGR_def = from_ascii(
 206         "\\DeclareFontEncoding{LGR}{}{}\n");
 207 static docstring const textgreek_def = from_ascii(
 208         "\\DeclareRobustCommand{\\greektext}{%\n"
 209         "  \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
 210         "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
 211         "\\ProvideTextCommand{\\~}{LGR}[1]{\\char126#1}\n");
 212
 213 static docstring const textcyr_T2A_def = from_ascii(
 214         "\\InputIfFileExists{t2aenc.def}{}{%\n"
 215         "  \\errmessage{File `t2aenc.def' not found: Cyrillic script not supported}}\n");
 216 static docstring const textcyr_def = from_ascii(
 217         "\\DeclareRobustCommand{\\cyrtext}{%\n"
 218         "  \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
 219         "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n");
 220
 221 static docstring const lyxmathsym_def = from_ascii(
 222         "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
 223         "  \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
 224
 225 static docstring const papersizedvi_def = from_ascii(
 226         "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
 227
 228 static docstring const papersizepdf_def = from_ascii(
 229         "\\pdfpageheight\\paperheight\n"
 230         "\\pdfpagewidth\\paperwidth\n");
 231
 232 static docstring const papersizepdflua_def = from_ascii(
 233         "% Backwards compatibility for LuaTeX < 0.90\n"
 234         "\\@ifundefined{pageheight}{\\let\\pageheight\\pdfpageheight}\n"
 235         "\\@ifundefined{pagewidth}{\\let\\pagewidth\\pdfpagewidth}\n"
 236         "\\pageheight\\paperheight\n"
 237         "\\pagewidth\\paperwidth\n");
 238
 239 static docstring const cedilla_def = from_ascii(
 240         "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
 241         "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
 242
 243 static docstring const subring_def = from_ascii(
 244         "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
 245         "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
 246
 247 static docstring const subdot_def = from_ascii(
 248         "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
 249         "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
 250
 251 static docstring const subhat_def = from_ascii(
 252         "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
 253         "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
 254
 255 static docstring const subtilde_def = from_ascii(
 256         "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
 257         "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
 258
 259 static docstring const dacute_def = from_ascii(
 260         "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
 261
 262 static docstring const tipasymb_def = from_ascii(
 263         "\\DeclareFontEncoding{T3}{}{}\n"
 264         "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
 265
 266 static docstring const dgrave_def = from_ascii(
 267         "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
 268
 269 static docstring const rcap_def = from_ascii(
 270         "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
 271
 272 static docstring const ogonek_def = from_ascii(
 273         "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
 274         "  \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
 275         "  \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
 276         "  \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
 277         "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
 278
 279 static docstring const lyxaccent_def = from_ascii(
 280         "%% custom text accent \\LyxTextAccent[<rise value (length)>]{<accent>}{<base>}\n"
 281         "\\newcommand*{\\LyxTextAccent}[3][0ex]{%\n"
 282         "  \\hmode@bgroup\\ooalign{\\null#3\\crcr\\hidewidth\n"
 283         "  \\raise#1\\hbox{#2}\\hidewidth}\\egroup}\n"
 284         "%% select a font size smaller than the current font size:\n"
 285         "\\newcommand{\\LyxAccentSize}[1][\\sf@size]{%\n"
 286         "  \\check@mathfonts\\fontsize#1\\z@\\math@fontsfalse\\selectfont\n"
 287         "}\n");
 288
 289 static docstring const textcommabelow_def = from_ascii(
 290         "\\ProvideTextCommandDefault{\\textcommabelow}[1]{%%\n"
 291         "  \\LyxTextAccent[-.31ex]{\\LyxAccentSize,}{#1}}\n");
 292
 293 static docstring const textcommaabove_def = from_ascii(
 294         "\\ProvideTextCommandDefault{\\textcommaabove}[1]{%%\n"
 295         "  \\LyxTextAccent[.5ex]{\\LyxAccentSize`}{#1}}\n");
 296
 297 static docstring const textcommaaboveright_def = from_ascii(
 298         "\\ProvideTextCommandDefault{\\textcommaaboveright}[1]{%%\n"
 299         "  \\LyxTextAccent[.5ex]{\\LyxAccentSize\\ `}{#1}}\n");
 300
 301 // Baltic languages use a comma-accent instead of a cedilla
 302 static docstring const textbaltic_def = from_ascii(
 303         "%% use comma accent instead of cedilla for these characters:\n"
 304         "\\DeclareTextCompositeCommand{\\c}{T1}{g}{\\textcommaabove{g}}\n"
 305         "\\DeclareTextCompositeCommand{\\c}{T1}{G}{\\textcommabelow{G}}\n"
 306         "\\DeclareTextCompositeCommand{\\c}{T1}{k}{\\textcommabelow{k}}\n"
 307         "\\DeclareTextCompositeCommand{\\c}{T1}{K}{\\textcommabelow{K}}\n"
 308         "\\DeclareTextCompositeCommand{\\c}{T1}{l}{\\textcommabelow{l}}\n"
 309         "\\DeclareTextCompositeCommand{\\c}{T1}{L}{\\textcommabelow{L}}\n"
 310         "\\DeclareTextCompositeCommand{\\c}{T1}{n}{\\textcommabelow{n}}\n"
 311         "\\DeclareTextCompositeCommand{\\c}{T1}{N}{\\textcommabelow{N}}\n"
 312         "\\DeclareTextCompositeCommand{\\c}{T1}{r}{\\textcommabelow{r}}\n"
 313         "\\DeclareTextCompositeCommand{\\c}{T1}{R}{\\textcommabelow{R}}\n");
 314
 315 static docstring const lyxref_def = from_ascii(
 316                 "\\RS@ifundefined{subsecref}\n"
 317                 "  {\\newref{subsec}{name = \\RSsectxt}}\n"
 318                 "  {}\n"
 319                 "\\RS@ifundefined{thmref}\n"
 320                 "  {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
 321                 "  {}\n"
 322                 "\\RS@ifundefined{lemref}\n"
 323                 "  {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
 324                 "  {}\n");
 325
 326 // Make sure the columns are also outputed as rtl
 327 static docstring const rtloutputdblcol_def = from_ascii(
 328         "\\def\\@outputdblcol{%\n"
 329         "  \\if@firstcolumn\n"
 330         "    \\global \\@firstcolumnfalse\n"
 331         "    \\global \\setbox\\@leftcolumn \\box\\@outputbox\n"
 332         "  \\else\n"
 333         "    \\global \\@firstcolumntrue\n"
 334         "    \\setbox\\@outputbox \\vbox {%\n"
 335         "      \\hb@xt@\\textwidth {%\n"
 336         "      \\kern\\textwidth \\kern-\\columnwidth %**\n"
 337         "      \\hb@xt@\\columnwidth {%\n"
 338         "         \\box\\@leftcolumn \\hss}%\n"
 339         "      \\kern-\\textwidth %**\n"
 340         "      \\hfil\n"
 341         "      {\\normalcolor\\vrule \\@width\\columnseprule}%\n"
 342         "      \\hfil\n"
 343         "      \\kern-\\textwidth  %**\n"
 344         "      \\hb@xt@\\columnwidth {%\n"
 345         "         \\box\\@outputbox \\hss}%\n"
 346         "      \\kern-\\columnwidth \\kern\\textwidth %**\n"
 347         "    }%\n"
 348         "  }%\n"
 349         "  \\@combinedblfloats\n"
 350         "  \\@outputpage\n"
 351         "  \\begingroup\n"
 352         "  \\@dblfloatplacement\n"
 353         "  \\@startdblcolumn\n"
 354         "  \\@whilesw\\if@fcolmade \\fi\n"
 355         "  {\\@outputpage\n"
 356         "    \\@startdblcolumn}%\n"
 357         "  \\endgroup\n"
 358         "  \\fi\n"
 359         "}\n"
 360         "\\@mparswitchtrue\n");
 361
 362
 363 /////////////////////////////////////////////////////////////////////
 364 //
 365 // LyXHTML strings
 366 //
 367 /////////////////////////////////////////////////////////////////////
 368
 369 static docstring const lyxnoun_style = from_ascii(
 370         "dfn.lyxnoun {\n"
 371         "  font-variant: small-caps;\n"
 372         "}\n");
 373
 374
 375 // this is how it normally renders, but it might not always do so.
 376 static docstring const lyxstrikeout_style = from_ascii(
 377         "del.strikeout {\n"
 378         "  text-decoration: line-through;\n"
 379         "}\n");
 380
 381
 382 /////////////////////////////////////////////////////////////////////
 383 //
 384 // LaTeXFeatures
 385 //
 386 /////////////////////////////////////////////////////////////////////
 387
 388
 389 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
 390                              OutputParams const & r)
 391         : buffer_(&b), params_(p), runparams_(r), in_float_(false)
 392 {}
 393
 394
 395 LaTeXFeatures::LangPackage LaTeXFeatures::langPackage() const
 396 {
 397         string const local_lp = bufferParams().lang_package;
 398
 399         // Locally, custom is just stored as a string
 400         // in bufferParams().lang_package.
 401         if (local_lp != "auto"
 402             && local_lp != "babel"
 403             && local_lp != "default"
 404             && local_lp != "none")
 405                  return LANG_PACK_CUSTOM;
 406
 407         if (local_lp == "none")
 408                 return LANG_PACK_NONE;
 409
 410         /* If "auto" is selected, we load polyglossia with non-TeX fonts,
 411          * else we select babel.
 412          * If babel is selected (either directly or via the "auto"
 413          * mechanism), we really do only require it if we have
 414          * a language that needs it.
 415          */
 416         bool const polyglossia_required =
 417                 params_.useNonTeXFonts
 418                 && isAvailable("polyglossia")
 419                 && !isProvided("babel")
 420                 && this->hasOnlyPolyglossiaLanguages();
 421         bool const babel_required =
 422                 !bufferParams().language->babel().empty()
 423                 || !this->getBabelLanguages().empty();
 424
 425         if (local_lp == "auto") {
 426                 // polyglossia requirement has priority over babel
 427                 if (polyglossia_required)
 428                         return LANG_PACK_POLYGLOSSIA;
 429                 else if (babel_required)
 430                         return LANG_PACK_BABEL;
 431         }
 432
 433         if (local_lp == "babel") {
 434                 if (babel_required)
 435                         return LANG_PACK_BABEL;
 436         }
 437
 438         if (local_lp == "default") {
 439                 switch (lyxrc.language_package_selection) {
 440                 case LyXRC::LP_AUTO:
 441                         // polyglossia requirement has priority over babel
 442                         if (polyglossia_required)
 443                                 return LANG_PACK_POLYGLOSSIA;
 444                         else if (babel_required)
 445                                 return LANG_PACK_BABEL;
 446                         break;
 447                 case LyXRC::LP_BABEL:
 448                         if (babel_required)
 449                                 return LANG_PACK_BABEL;
 450                         break;
 451                 case LyXRC::LP_CUSTOM:
 452                         return LANG_PACK_CUSTOM;
 453                 case LyXRC::LP_NONE:
 454                         return LANG_PACK_NONE;
 455                 }
 456         }
 457
 458         return LANG_PACK_NONE;
 459 }
 460
 461
 462 void LaTeXFeatures::require(string const & name)
 463 {
 464         features_.insert(name);
 465 }
 466
 467
 468 void LaTeXFeatures::require(set<string> const & names)
 469 {
 470         features_.insert(names.begin(), names.end());
 471 }
 472
 473
 474 void LaTeXFeatures::useLayout(docstring const & layoutname)
 475 {
 476         useLayout(layoutname, 0);
 477 }
 478
 479
 480 void LaTeXFeatures::useLayout(docstring const & layoutname, int level)
 481 {
 482         // Some code to avoid loops in dependency definition
 483         const int maxlevel = 30;
 484         if (level > maxlevel) {
 485                 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
 486                        << "recursion attained by layout "
 487                        << to_utf8(layoutname) << endl;
 488                 return;
 489         }
 490
 491         DocumentClass const & tclass = params_.documentClass();
 492         if (tclass.hasLayout(layoutname)) {
 493                 // Is this layout already in usedLayouts?
 494                 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
 495                     != usedLayouts_.end())
 496                         return;
 497
 498                 Layout const & layout = tclass[layoutname];
 499                 require(layout.requires());
 500
 501                 if (!layout.depends_on().empty()) {
 502                         useLayout(layout.depends_on(), level + 1);
 503                 }
 504                 usedLayouts_.push_back(layoutname);
 505         } else {
 506                 lyxerr << "LaTeXFeatures::useLayout: layout `"
 507                        << to_utf8(layoutname) << "' does not exist in this class"
 508                        << endl;
 509         }
 510 }
 511
 512
 513 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
 514 {
 515         docstring const & lname = lay.name();
 516         DocumentClass const & tclass = params_.documentClass();
 517
 518         // this is a default inset layout, nothing useful here
 519         if (!tclass.hasInsetLayout(lname))
 520                 return;
 521         // Is this layout already in usedInsetLayouts?
 522         if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
 523                         != usedInsetLayouts_.end())
 524                 return;
 525
 526         require(lay.requires());
 527         usedInsetLayouts_.push_back(lname);
 528 }
 529
 530
 531 bool LaTeXFeatures::isRequired(string const & name) const
 532 {
 533         return features_.find(name) != features_.end();
 534 }
 535
 536
 537 bool LaTeXFeatures::isProvided(string const & name) const
 538 {
 539         if (params_.useNonTeXFonts)
 540                 return params_.documentClass().provides(name);
 541
 542         bool const ot1 = (params_.font_encoding() == "default"
 543                 || params_.font_encoding() == "OT1");
 544         bool const complete = (params_.fontsSans() == "default"
 545                 && params_.fontsTypewriter() == "default");
 546         bool const nomath = (params_.fontsMath() == "default");
 547         return params_.documentClass().provides(name)
 548                 || theLaTeXFonts().getLaTeXFont(
 549                         from_ascii(params_.fontsRoman())).provides(name, ot1,
 550                                                                   complete,
 551                                                                   nomath)
 552                 || theLaTeXFonts().getLaTeXFont(
 553                         from_ascii(params_.fontsSans())).provides(name, ot1,
 554                                                                  complete,
 555                                                                  nomath)
 556                 || theLaTeXFonts().getLaTeXFont(
 557                         from_ascii(params_.fontsTypewriter())).provides(name, ot1,
 558                                                                        complete,
 559                                                                        nomath)
 560                 || theLaTeXFonts().getLaTeXFont(
 561                         from_ascii(params_.fontsMath())).provides(name, ot1,
 562                                                                        complete,
 563                                                                        nomath);
 564         // TODO: "textbaltic" provided, if the font-encoding is "L7x"
 565         //       "textgreek" provided, if a language with font-encoding LGR is used in the document
 566         //       "textcyr" provided, if a language with font-encoding T2A is used in the document
 567 }
 568
 569
 570 bool LaTeXFeatures::mustProvide(string const & name) const
 571 {
 572         return isRequired(name) && !isProvided(name);
 573 }
 574
 575
 576 bool LaTeXFeatures::isAvailable(string const & name)
 577 {
 578         string::size_type const i = name.find("->");
 579         if (i != string::npos) {
 580                 string const from = name.substr(0,i);
 581                 string const to = name.substr(i+2);
 582                 //LYXERR0("from=[" << from << "] to=[" << to << "]");
 583                 return theConverters().isReachable(from, to);
 584         }
 585         return LaTeXPackages::isAvailable(name);
 586 }
 587
 588
 589 void LaTeXFeatures::addPreambleSnippet(string const & preamble,
 590                 bool allowdupes)
 591 {
 592         SnippetList::const_iterator begin = preamble_snippets_.begin();
 593         SnippetList::const_iterator end   = preamble_snippets_.end();
 594         if (allowdupes || find(begin, end, preamble) == end)
 595                 preamble_snippets_.push_back(preamble);
 596 }
 597
 598
 599 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
 600 {
 601         SnippetList::const_iterator begin = css_snippets_.begin();
 602         SnippetList::const_iterator end   = css_snippets_.end();
 603         if (find(begin, end, snippet) == end)
 604                 css_snippets_.push_back(snippet);
 605 }
 606
 607
 608 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
 609 {
 610         if (!usedFloats_[name])
 611                 usedFloats_[name] = subfloat;
 612         if (subfloat)
 613                 require("subfig");
 614         // We only need float.sty if we use non builtin floats, or if we
 615         // use the "H" modifier. This includes modified table and
 616         // figure floats. (Lgb)
 617         Floating const & fl = params_.documentClass().floats().getType(name);
 618         if (!fl.floattype().empty() && fl.usesFloatPkg()) {
 619                 require("float");
 620         }
 621 }
 622
 623
 624 void LaTeXFeatures::useLanguage(Language const * lang)
 625 {
 626         if (!lang->babel().empty() || !lang->polyglossia().empty())
 627                 UsedLanguages_.insert(lang);
 628         if (!lang->requires().empty())
 629                 require(lang->requires());
 630         // CJK languages do not have a babel name.
 631         // They use the CJK package
 632         if (lang->encoding()->package() == Encoding::CJK)
 633                 require("CJK");
 634         // japanese package is special
 635         if (lang->encoding()->package() == Encoding::japanese)
 636                 require("japanese");
 637 }
 638
 639
 640 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
 641 {
 642         IncludedFiles_[key] = name;
 643 }
 644
 645
 646 bool LaTeXFeatures::hasLanguages() const
 647 {
 648         return !UsedLanguages_.empty();
 649 }
 650
 651
 652 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
 653 {
 654         // first the main language
 655         if (params_.language->polyglossia().empty())
 656                 return false;
 657         // now the secondary languages
 658         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 659         for (LanguageList::const_iterator cit = begin;
 660              cit != UsedLanguages_.end();
 661              ++cit) {
 662                 if ((*cit)->polyglossia().empty())
 663                         return false;
 664         }
 665         return true;
 666 }
 667
 668
 669 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
 670 {
 671         // first the main language
 672         if (params_.language->isPolyglossiaExclusive())
 673                 return true;
 674         // now the secondary languages
 675         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 676         for (LanguageList::const_iterator cit = begin;
 677              cit != UsedLanguages_.end();
 678              ++cit) {
 679                 if ((*cit)->isPolyglossiaExclusive())
 680                         return true;
 681         }
 682         return false;
 683 }
 684
 685
 686 string LaTeXFeatures::getBabelLanguages() const
 687 {
 688         ostringstream languages;
 689
 690         bool first = true;
 691         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 692         for (LanguageList::const_iterator cit = begin;
 693              cit != UsedLanguages_.end();
 694              ++cit) {
 695                 if ((*cit)->babel().empty())
 696                         continue;
 697                 if (!first)
 698                         languages << ',';
 699                 else
 700                         first = false;
 701                 languages << (*cit)->babel();
 702         }
 703         return languages.str();
 704 }
 705
 706
 707 std::map<std::string, std::string> LaTeXFeatures::getPolyglossiaLanguages() const
 708 {
 709         std::map<std::string, std::string> languages;
 710
 711         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 712         for (LanguageList::const_iterator cit = begin;
 713              cit != UsedLanguages_.end();
 714              ++cit) {
 715                 languages[(*cit)->polyglossia()] = (*cit)->polyglossiaOpts();
 716         }
 717         return languages;
 718 }
 719
 720
 721 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 722 {
 723         // This does only find encodings of languages supported by babel, but
 724         // that does not matter since we don't have a language with an
 725         // encoding supported by inputenc but without babel support.
 726         set<string> encodings;
 727         LanguageList::const_iterator it  = UsedLanguages_.begin();
 728         LanguageList::const_iterator end = UsedLanguages_.end();
 729         for (; it != end; ++it)
 730                 if ((*it)->encoding()->latexName() != doc_encoding &&
 731                     ((*it)->encoding()->package() == Encoding::inputenc
 732                      || (*it)->encoding()->package() == Encoding::japanese))
 733                         encodings.insert((*it)->encoding()->latexName());
 734         return encodings;
 735 }
 736
 737
 738 void LaTeXFeatures::getFontEncodings(vector<string> & encodings) const
 739 {
 740         // these must be loaded if glyphs of this script are used
 741         // unless a language providing them is used in the document
 742         // FIXME: currently the option is written twice in this case
 743         if (mustProvide("textgreek"))
 744                 encodings.insert(encodings.begin(), "LGR");
 745         if (mustProvide("textcyr"))
 746                 encodings.insert(encodings.begin(), "T2A");
 747
 748         LanguageList::const_iterator it  = UsedLanguages_.begin();
 749         LanguageList::const_iterator end = UsedLanguages_.end();
 750         for (; it != end; ++it)
 751                 if (!(*it)->fontenc().empty()
 752                     && ascii_lowercase((*it)->fontenc()) != "none") {
 753                         vector<string> extraencs = getVectorFromString((*it)->fontenc());
 754                         vector<string>::const_iterator fit = extraencs.begin();
 755                         for (; fit != extraencs.end(); ++fit) {
 756                                 if (find(encodings.begin(), encodings.end(), *fit) == encodings.end())
 757                                         encodings.insert(encodings.begin(), *fit);
 758                         }
 759                 }
 760 }
 761
 762 namespace {
 763
 764 char const * simplefeatures[] = {
 765 // note that the package order here will be the same in the LaTeX-output
 766         "array",
 767         "verbatim",
 768         "longtable",
 769         "rotating",
 770         "latexsym",
 771         "pifont",
 772         // subfig is handled in BufferParams.cpp
 773         "varioref",
 774         "prettyref",
 775         "refstyle",
 776         /*For a successful cooperation of the `wrapfig' package with the
 777           `float' package you should load the `wrapfig' package *after*
 778           the `float' package. See the caption package documentation
 779           for explanation.*/
 780         "float",
 781         "rotfloat",
 782         "wrapfig",
 783         "booktabs",
 784         "dvipost",
 785         "fancybox",
 786         "calc",
 787         "units",
 788         "framed",
 789         "soul",
 790         "textcomp",
 791         "pmboxdraw",
 792         "bbding",
 793         "ifsym",
 794         "txfonts",
 795         "pxfonts",
 796         "mathdesign",
 797         "mathrsfs",
 798         "mathabx",
 799         "mathtools",
 800         // "cancel",
 801         "ascii",
 802         "url",
 803         "covington",
 804         "csquotes",
 805         "enumitem",
 806         "endnotes",
 807         "hhline",
 808         "ifthen",
 809         // listings is handled in BufferParams.cpp
 810         "bm",
 811         "pdfpages",
 812         "amscd",
 813         "slashed",
 814         "multicol",
 815         "multirow",
 816         "tfrupee",
 817         "shapepar",
 818         "rsphrase",
 819         "hpstatement",
 820         "algorithm2e",
 821         "sectionbox",
 822         "tcolorbox",
 823         "pdfcomment",
 824         "fixme",
 825         "todonotes",
 826         "forest",
 827         "varwidth"
 828 };
 829
 830 char const * bibliofeatures[] = {
 831         // Known bibliography packages (will be loaded before natbib)
 832         "achicago",
 833         "apacite",
 834         "apalike",
 835         "astron",
 836         "authordate1-4",
 837         "babelbib",
 838         "bibgerm",
 839         "chicago",
 840         "chscite",
 841         "harvard",
 842         "mslapa",
 843         "named"
 844 };
 845
 846 int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
 847
 848 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 849
 850 }
 851
 852
 853 string const LaTeXFeatures::getColorOptions() const
 854 {
 855         ostringstream colors;
 856
 857         // Handling the color packages separately is needed to be able to load them
 858         // before babel when hyperref is loaded with the colorlinks option
 859         // for more info see Bufferparams.cpp
 860
 861         // [x]color.sty
 862         if (mustProvide("color") || mustProvide("xcolor")) {
 863                 string const package =
 864                         (mustProvide("xcolor") ? "xcolor" : "color");
 865                 if (params_.graphics_driver == "default"
 866                         || params_.graphics_driver == "none")
 867                         colors << "\\usepackage{" << package << "}\n";
 868                 else
 869                         colors << "\\usepackage["
 870                                  << params_.graphics_driver
 871                                  << "]{" << package << "}\n";
 872         }
 873
 874         // pdfcolmk must be loaded after color
 875         if (mustProvide("pdfcolmk"))
 876                 colors << "\\usepackage{pdfcolmk}\n";
 877
 878         // the following 3 color commands must be set after color
 879         // is loaded and before pdfpages, therefore add the command
 880         // here define the set color
 881         if (mustProvide("pagecolor")) {
 882                 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
 883                 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
 884                 // set the page color
 885                 colors << "\\pagecolor{page_backgroundcolor}\n";
 886         }
 887
 888         if (mustProvide("fontcolor")) {
 889                 colors << "\\definecolor{document_fontcolor}{rgb}{";
 890                 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
 891                 // set the color
 892                 colors << "\\color{document_fontcolor}\n";
 893         }
 894
 895         if (mustProvide("lyxgreyedout")) {
 896                 colors << "\\definecolor{note_fontcolor}{rgb}{";
 897                 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
 898                 // the color will be set together with the definition of
 899                 // the lyxgreyedout environment (see lyxgreyedout_def)
 900         }
 901
 902         // color for shaded boxes
 903         if (isRequired("framed") && mustProvide("color")) {
 904                 colors << "\\definecolor{shadecolor}{rgb}{";
 905                 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
 906                 // this color is automatically used by the LaTeX-package "framed"
 907         }
 908
 909         return colors.str();
 910 }
 911
 912
 913 string const LaTeXFeatures::getPackageOptions() const
 914 {
 915         ostringstream packageopts;
 916         // Output all the package option stuff we have been asked to do.
 917         map<string, string>::const_iterator it =
 918                 params_.documentClass().packageOptions().begin();
 919         map<string, string>::const_iterator en =
 920                 params_.documentClass().packageOptions().end();
 921         for (; it != en; ++it)
 922                 if (mustProvide(it->first))
 923                         packageopts << "\\PassOptionsToPackage{" << it->second << "}"
 924                                  << "{" << it->first << "}\n";
 925         return packageopts.str();
 926 }
 927
 928
 929 string const LaTeXFeatures::getPackages() const
 930 {
 931         ostringstream packages;
 932
 933         // FIXME: currently, we can only load packages and macros known
 934         // to LyX.
 935         // However, with the Require tag of layouts/custom insets,
 936         // also unknown packages can be requested. They are silently
 937         // swallowed now. We should change this eventually.
 938
 939         //  These are all the 'simple' includes.  i.e
 940         //  packages which we just \usepackage{package}
 941         for (int i = 0; i < nb_simplefeatures; ++i) {
 942                 if (mustProvide(simplefeatures[i]))
 943                         packages << "\\usepackage{" << simplefeatures[i] << "}\n";
 944         }
 945
 946         // The rest of these packages are somewhat more complicated
 947         // than those above.
 948
 949         // The tipa package and its extensions (tipx, tone) must not
 950         // be loaded with non-TeX fonts, since fontspec includes the
 951         // respective macros
 952         if (mustProvide("tipa") && !params_.useNonTeXFonts)
 953                 packages << "\\usepackage{tipa}\n";
 954         if (mustProvide("tipx") && !params_.useNonTeXFonts)
 955                 packages << "\\usepackage{tipx}\n";
 956         if (mustProvide("tone") && !params_.useNonTeXFonts)
 957                 packages << "\\usepackage{tone}\n";
 958
 959         // if fontspec or newtxmath is used, AMS packages have to be loaded
 960         // before fontspec (in BufferParams)
 961         string const amsPackages = loadAMSPackages();
 962         bool const ot1 = (params_.font_encoding() == "default" || params_.font_encoding() == "OT1");
 963         bool const use_newtxmath =
 964                 theLaTeXFonts().getLaTeXFont(from_ascii(params_.fontsMath())).getUsedPackage(
 965                         ot1, false, false) == "newtxmath";
 966
 967         if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
 968                 packages << amsPackages;
 969
 970         if (mustProvide("cancel") &&
 971             params_.use_package("cancel") != BufferParams::package_off)
 972                 packages << "\\usepackage{cancel}\n";
 973
 974         // marvosym and bbding both define the \Cross macro
 975         if (mustProvide("marvosym")) {
 976             if (mustProvide("bbding"))
 977                 packages << "\\let\\Cross\\relax\n";
 978             packages << "\\usepackage{marvosym}\n";
 979         }
 980
 981         // accents must be loaded after amsmath
 982         if (mustProvide("accents") &&
 983             params_.use_package("accents") != BufferParams::package_off)
 984                 packages << "\\usepackage{accents}\n";
 985
 986         // mathdots must be loaded after amsmath
 987         if (mustProvide("mathdots") &&
 988                 params_.use_package("mathdots") != BufferParams::package_off)
 989                 packages << "\\usepackage{mathdots}\n";
 990
 991         // yhmath must be loaded after amsmath
 992         if (mustProvide("yhmath") &&
 993             params_.use_package("yhmath") != BufferParams::package_off)
 994                 packages << "\\usepackage{yhmath}\n";
 995
 996         // stmaryrd must be loaded after amsmath
 997         if (mustProvide("stmaryrd") &&
 998             params_.use_package("stmaryrd") != BufferParams::package_off)
 999                 packages << "\\usepackage{stmaryrd}\n";
1000
1001         if (mustProvide("stackrel") &&
1002             params_.use_package("stackrel") != BufferParams::package_off)
1003                 packages << "\\usepackage{stackrel}\n";
1004
1005         if (mustProvide("undertilde") &&
1006                 params_.use_package("undertilde") != BufferParams::package_off)
1007                 packages << "\\usepackage{undertilde}\n";
1008
1009         // [x]color and pdfcolmk are handled in getColorOptions() above
1010
1011         // makeidx.sty
1012         if (isRequired("makeidx") || isRequired("splitidx")) {
1013                 if (!isProvided("makeidx") && !isRequired("splitidx"))
1014                         packages << "\\usepackage{makeidx}\n";
1015                 if (mustProvide("splitidx"))
1016                         packages << "\\usepackage{splitidx}\n";
1017                 packages << "\\makeindex\n";
1018         }
1019
1020         // graphicx.sty
1021         if (mustProvide("graphicx") && params_.graphics_driver != "none") {
1022                 if (params_.graphics_driver == "default")
1023                         packages << "\\usepackage{graphicx}\n";
1024                 else
1025                         packages << "\\usepackage["
1026                                  << params_.graphics_driver
1027                                  << "]{graphicx}\n";
1028         }
1029
1030         // lyxskak.sty --- newer chess support based on skak.sty
1031         if (mustProvide("chess"))
1032                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
1033
1034         // setspace.sty
1035         if (mustProvide("setspace") && !isProvided("SetSpace"))
1036                 packages << "\\usepackage{setspace}\n";
1037
1038         // we need to assure that mhchem is loaded before esint and every other
1039         // package that redefines command of amsmath because mhchem loads amlatex
1040         // (this info is from the author of mhchem from June 2013)
1041         if (mustProvide("mhchem") &&
1042             params_.use_package("mhchem") != BufferParams::package_off)
1043                 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
1044                             "\\usepackage{mhchem}\n";
1045
1046         // wasysym is a simple feature, but it must be after amsmath if both
1047         // are used
1048         // wasysym redefines some integrals (e.g. iint) from amsmath. That
1049         // leads to inconsistent integrals. We only load this package if
1050         // the document does not contain integrals (then isRequired("esint")
1051         // is false) or if esint is used, since esint redefines all relevant
1052         // integral symbols from wasysym and amsmath.
1053         // See http://www.lyx.org/trac/ticket/1942
1054         if (mustProvide("wasysym") &&
1055             params_.use_package("wasysym") != BufferParams::package_off &&
1056             (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
1057                 packages << "\\usepackage{wasysym}\n";
1058
1059         // esint must be after amsmath (and packages requiring amsmath, like mhchem)
1060         // and wasysym, since it will redeclare inconsistent integral symbols
1061         if (mustProvide("esint") &&
1062             params_.use_package("esint") != BufferParams::package_off)
1063                 packages << "\\usepackage{esint}\n";
1064
1065         // Known bibliography packages (simple \usepackage{package})
1066         for (int i = 0; i < nb_bibliofeatures; ++i) {
1067                 if (mustProvide(bibliofeatures[i]))
1068                         packages << "\\usepackage{"
1069                                  << bibliofeatures[i] << "}\n";
1070         }
1071
1072         // Compatibility between achicago and natbib
1073         if (mustProvide("achicago") && mustProvide("natbib"))
1074                 packages << "\\let\\achicagobib\\thebibliography\n";
1075
1076         // natbib.sty
1077         // Some classes load natbib themselves, but still allow (or even require)
1078         // plain numeric citations (ReVTeX is such a case, see bug 5182).
1079         // This special case is indicated by the "natbib-internal" key.
1080         if (mustProvide("natbib") && !isProvided("natbib-internal")) {
1081                 packages << "\\usepackage[";
1082                 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
1083                         packages << "numbers";
1084                 else
1085                         packages << "authoryear";
1086                 packages << "]{natbib}\n";
1087         }
1088
1089         // Compatibility between achicago and natbib
1090         if (mustProvide("achicago") && mustProvide("natbib")) {
1091                 packages << "\\let\\thebibliography\\achicagobib\n";
1092                 packages << "\\let\\SCcite\\astroncite\n";
1093                 packages << "\\let\\UnexpandableProtect\\protect\n";
1094         }
1095
1096         // jurabib -- we need version 0.6 at least.
1097         if (mustProvide("jurabib"))
1098                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
1099
1100         // opcit -- we pass custombst as we output \bibliographystyle ourselves
1101         if (mustProvide("opcit")) {
1102                 if (isRequired("hyperref"))
1103                         packages << "\\usepackage[custombst,hyperref]{opcit}\n";
1104                 else
1105                         packages << "\\usepackage[custombst]{opcit}\n";
1106         }
1107
1108         // xargs -- we need version 1.09 at least
1109         if (mustProvide("xargs"))
1110                 packages << "\\usepackage{xargs}[2008/03/08]\n";
1111
1112         if (mustProvide("xy"))
1113                 packages << "\\usepackage[all]{xy}\n";
1114
1115         if (mustProvide("feyn"))
1116                 packages << "\\usepackage{feyn}\n"; //Diagram
1117
1118         if (mustProvide("ulem"))
1119                 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
1120                             "\\usepackage{ulem}\n";
1121
1122         if (mustProvide("nomencl")) {
1123                 // Make it work with the new and old version of the package,
1124                 // but don't use the compatibility option since it is
1125                 // incompatible to other packages.
1126                 packages << "\\usepackage{nomencl}\n"
1127                             "% the following is useful when we have the old nomencl.sty package\n"
1128                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
1129                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
1130                             "\\makenomenclature\n";
1131         }
1132
1133         // fixltx2e provides subscript
1134         if (mustProvide("subscript") && !isRequired("fixltx2e"))
1135                 packages << "\\usepackage{subscript}\n";
1136
1137         // footmisc must be loaded after setspace
1138         // Set options here, load the package after the user preamble to
1139         // avoid problems with manual loaded footmisc.
1140         if (mustProvide("footmisc"))
1141                 packages << "\\PassOptionsToPackage{stable}{footmisc}\n";
1142
1143         if (mustProvide("microtype")){
1144                 packages << "\\usepackage{microtype}\n";
1145         }
1146
1147         return packages.str();
1148 }
1149
1150
1151 string LaTeXFeatures::getPreambleSnippets() const
1152 {
1153         ostringstream snip;
1154         SnippetList::const_iterator pit  = preamble_snippets_.begin();
1155         SnippetList::const_iterator pend = preamble_snippets_.end();
1156         for (; pit != pend; ++pit)
1157                 snip << *pit << '\n';
1158         return snip.str();
1159 }
1160
1161
1162 std::string LaTeXFeatures::getCSSSnippets() const
1163 {
1164         ostringstream snip;
1165         SnippetList::const_iterator pit  = css_snippets_.begin();
1166         SnippetList::const_iterator pend = css_snippets_.end();
1167         for (; pit != pend; ++pit)
1168                 snip << *pit << '\n';
1169         return snip.str();
1170 }
1171
1172
1173 docstring const LaTeXFeatures::getMacros() const
1174 {
1175         odocstringstream macros;
1176
1177         if (!preamble_snippets_.empty()) {
1178                 macros << '\n';
1179                 macros << from_utf8(getPreambleSnippets());
1180         }
1181
1182         if (mustProvide("papersize")) {
1183                 if (runparams_.flavor == OutputParams::LATEX
1184                     || runparams_.flavor == OutputParams::DVILUATEX)
1185                         macros << papersizedvi_def << '\n';
1186                 else if  (runparams_.flavor == OutputParams::LUATEX)
1187                         macros << papersizepdflua_def << '\n';
1188                 else
1189                         macros << papersizepdf_def << '\n';
1190         }
1191
1192         if (mustProvide("LyX")) {
1193                 if (isRequired("hyperref"))
1194                         macros << lyx_hyperref_def << '\n';
1195                 else
1196                         macros << lyx_def << '\n';
1197         }
1198
1199         if (mustProvide("noun"))
1200                 macros << noun_def << '\n';
1201
1202         if (mustProvide("lyxarrow"))
1203                 macros << lyxarrow_def << '\n';
1204
1205         if (!usePolyglossia() && mustProvide("textgreek")) {
1206                 // ensure LGR font encoding is defined also if fontenc is not loaded by LyX
1207                 if (params_.font_encoding() == "default")
1208                         macros << textgreek_LGR_def;
1209                 macros << textgreek_def << '\n';
1210         }
1211
1212         if (!usePolyglossia() && mustProvide("textcyr")) {
1213                 // ensure T2A font encoding is set up also if fontenc is not loaded by LyX
1214                 if (params_.font_encoding() == "default")
1215                         macros << textcyr_T2A_def;
1216                 macros << textcyr_def << '\n';
1217         }
1218
1219         // non-standard text accents:
1220         if (mustProvide("textcommaabove") || mustProvide("textcommaaboveright") ||
1221             mustProvide("textcommabelow") || mustProvide("textbaltic"))
1222                 macros << lyxaccent_def;
1223
1224         if (mustProvide("textcommabelow") || mustProvide("textbaltic"))
1225                 macros << textcommabelow_def << '\n';
1226
1227         if (mustProvide("textcommaabove") || mustProvide("textbaltic"))
1228                 macros << textcommaabove_def << '\n';
1229
1230         if (mustProvide("textcommaaboveright"))
1231                 macros << textcommaaboveright_def << '\n';
1232
1233         if (mustProvide("textbaltic"))
1234                 macros << textbaltic_def << '\n';
1235
1236         if (mustProvide("lyxmathsym"))
1237                 macros << lyxmathsym_def << '\n';
1238
1239         if (mustProvide("cedilla"))
1240                 macros << cedilla_def << '\n';
1241
1242         if (mustProvide("subring"))
1243                 macros << subring_def << '\n';
1244
1245         if (mustProvide("subdot"))
1246                 macros << subdot_def << '\n';
1247
1248         if (mustProvide("subhat"))
1249                 macros << subhat_def << '\n';
1250
1251         if (mustProvide("subtilde"))
1252                 macros << subtilde_def << '\n';
1253
1254         if (mustProvide("dacute"))
1255                 macros << dacute_def << '\n';
1256
1257         if (mustProvide("tipasymb"))
1258                 macros << tipasymb_def << '\n';
1259
1260         if (mustProvide("dgrave"))
1261                 macros << dgrave_def << '\n';
1262
1263         if (mustProvide("rcap"))
1264                 macros << rcap_def << '\n';
1265
1266         if (mustProvide("ogonek"))
1267                 macros << ogonek_def << '\n';
1268
1269         // quotes.
1270         if (mustProvide("quotesinglbase"))
1271                 macros << quotesinglbase_def << '\n';
1272         if (mustProvide("quotedblbase"))
1273                 macros << quotedblbase_def << '\n';
1274         if (mustProvide("guilsinglleft"))
1275                 macros << guilsinglleft_def << '\n';
1276         if (mustProvide("guilsinglright"))
1277                 macros << guilsinglright_def << '\n';
1278         if (mustProvide("guillemotleft"))
1279                 macros << guillemotleft_def << '\n';
1280         if (mustProvide("guillemotright"))
1281                 macros << guillemotright_def << '\n';
1282
1283         // Math mode
1284         if (mustProvide("binom") && !isRequired("amsmath"))
1285                 macros << binom_def << '\n';
1286         if (mustProvide("mathcircumflex"))
1287                 macros << mathcircumflex_def << '\n';
1288
1289         // other
1290         if (mustProvide("ParagraphLeftIndent"))
1291                 macros << paragraphleftindent_def;
1292         if (mustProvide("NeedLyXFootnoteCode"))
1293                 macros << floatingfootnote_def;
1294
1295         // some problems with tex->html converters
1296         if (mustProvide("NeedTabularnewline"))
1297                 macros << tabularnewline_def;
1298
1299         // greyed-out environment (note inset)
1300         // the color is specified in the routine
1301         // getColorOptions() to avoid LaTeX-package clashes
1302         if (mustProvide("lyxgreyedout"))
1303                 macros << lyxgreyedout_def;
1304
1305         if (mustProvide("lyxdot"))
1306                 macros << lyxdot_def << '\n';
1307
1308         // floats
1309         getFloatDefinitions(macros);
1310
1311         if (mustProvide("refstyle"))
1312                 macros << lyxref_def << '\n';
1313
1314         // change tracking
1315         if (mustProvide("ct-dvipost"))
1316                 macros << changetracking_dvipost_def;
1317
1318         if (mustProvide("ct-xcolor-ulem")) {
1319                 streamsize const prec = macros.precision(2);
1320
1321                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1322                 macros << "\\providecolor{lyxadded}{rgb}{"
1323                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1324
1325                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1326                 macros << "\\providecolor{lyxdeleted}{rgb}{"
1327                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1328
1329                 macros.precision(prec);
1330
1331                 if (isRequired("hyperref"))
1332                         macros << changetracking_xcolor_ulem_hyperref_def;
1333                 else
1334                         macros << changetracking_xcolor_ulem_def;
1335         }
1336
1337         if (mustProvide("ct-none"))
1338                 macros << changetracking_none_def;
1339
1340         if (mustProvide("rtloutputdblcol"))
1341                 macros << rtloutputdblcol_def;
1342
1343         return macros.str();
1344 }
1345
1346
1347 string const LaTeXFeatures::getBabelPresettings() const
1348 {
1349         ostringstream tmp;
1350
1351         LanguageList::const_iterator it  = UsedLanguages_.begin();
1352         LanguageList::const_iterator end = UsedLanguages_.end();
1353         for (; it != end; ++it)
1354                 if (!(*it)->babel_presettings().empty())
1355                         tmp << (*it)->babel_presettings() << '\n';
1356         if (!params_.language->babel_presettings().empty())
1357                 tmp << params_.language->babel_presettings() << '\n';
1358
1359         if (!contains(tmp.str(), '@'))
1360                 return tmp.str();
1361
1362         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1363 }
1364
1365
1366 string const LaTeXFeatures::getBabelPostsettings() const
1367 {
1368         ostringstream tmp;
1369
1370         LanguageList::const_iterator it  = UsedLanguages_.begin();
1371         LanguageList::const_iterator end = UsedLanguages_.end();
1372         for (; it != end; ++it)
1373                 if (!(*it)->babel_postsettings().empty())
1374                         tmp << (*it)->babel_postsettings() << '\n';
1375         if (!params_.language->babel_postsettings().empty())
1376                 tmp << params_.language->babel_postsettings() << '\n';
1377
1378         if (!contains(tmp.str(), '@'))
1379                 return tmp.str();
1380
1381         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1382 }
1383
1384
1385 bool LaTeXFeatures::needBabelLangOptions() const
1386 {
1387         if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1388                 return true;
1389
1390         LanguageList::const_iterator it  = UsedLanguages_.begin();
1391         LanguageList::const_iterator end = UsedLanguages_.end();
1392         for (; it != end; ++it)
1393                 if ((*it)->asBabelOptions())
1394                         return true;
1395
1396         return false;
1397 }
1398
1399
1400 string const LaTeXFeatures::loadAMSPackages() const
1401 {
1402         ostringstream tmp;
1403
1404         if (mustProvide("amsmath")
1405             && params_.use_package("amsmath") != BufferParams::package_off) {
1406                 tmp << "\\usepackage{amsmath}\n";
1407         } else {
1408                 // amsbsy and amstext are already provided by amsmath
1409                 if (mustProvide("amsbsy"))
1410                         tmp << "\\usepackage{amsbsy}\n";
1411                 if (mustProvide("amstext"))
1412                         tmp << "\\usepackage{amstext}\n";
1413         }
1414
1415         if (mustProvide("amsthm"))
1416                 tmp << "\\usepackage{amsthm}\n";
1417
1418         if (mustProvide("amssymb")
1419             && params_.use_package("amssymb") != BufferParams::package_off)
1420                 tmp << "\\usepackage{amssymb}\n";
1421
1422         return tmp.str();
1423 }
1424
1425
1426 docstring const LaTeXFeatures::getTClassPreamble() const
1427 {
1428         // the text class specific preamble
1429         DocumentClass const & tclass = params_.documentClass();
1430         odocstringstream tcpreamble;
1431
1432         tcpreamble << tclass.preamble();
1433
1434         list<docstring>::const_iterator cit = usedLayouts_.begin();
1435         list<docstring>::const_iterator end = usedLayouts_.end();
1436         for (; cit != end; ++cit)
1437                 tcpreamble << tclass[*cit].preamble();
1438
1439         cit = usedInsetLayouts_.begin();
1440         end = usedInsetLayouts_.end();
1441         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1442         for (; cit != end; ++cit) {
1443                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1444                 if (it == ils.end())
1445                         continue;
1446                 tcpreamble << it->second.preamble();
1447         }
1448
1449         return tcpreamble.str();
1450 }
1451
1452
1453 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1454 {
1455         DocumentClass const & tclass = params_.documentClass();
1456         odocstringstream tcpreamble;
1457
1458         tcpreamble << tclass.htmlpreamble();
1459
1460         list<docstring>::const_iterator cit = usedLayouts_.begin();
1461         list<docstring>::const_iterator end = usedLayouts_.end();
1462         for (; cit != end; ++cit)
1463                 tcpreamble << tclass[*cit].htmlpreamble();
1464
1465         cit = usedInsetLayouts_.begin();
1466         end = usedInsetLayouts_.end();
1467         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1468         for (; cit != end; ++cit) {
1469                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1470                 if (it == ils.end())
1471                         continue;
1472                 tcpreamble << it->second.htmlpreamble();
1473         }
1474
1475         return tcpreamble.str();
1476 }
1477
1478
1479 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1480 {
1481         DocumentClass const & tclass = params_.documentClass();
1482         odocstringstream tcpreamble;
1483
1484         if (mustProvide("noun"))
1485                 tcpreamble << lyxnoun_style;
1486         // this isn't exact, but it won't hurt that much if it
1487         // wasn't for this.
1488         if (mustProvide("ulem"))
1489                 tcpreamble << lyxstrikeout_style;
1490
1491         tcpreamble << tclass.htmlstyles();
1492
1493         list<docstring>::const_iterator cit = usedLayouts_.begin();
1494         list<docstring>::const_iterator end = usedLayouts_.end();
1495         for (; cit != end; ++cit)
1496                 tcpreamble << tclass[*cit].htmlstyle();
1497
1498         cit = usedInsetLayouts_.begin();
1499         end = usedInsetLayouts_.end();
1500         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1501         for (; cit != end; ++cit) {
1502                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1503                 if (it == ils.end())
1504                         continue;
1505                 tcpreamble << it->second.htmlstyle();
1506         }
1507
1508         return tcpreamble.str();
1509 }
1510
1511
1512 namespace {
1513
1514 docstring const getFloatI18nPreamble(docstring const & type,
1515                         docstring const & name, Language const * lang,
1516                         Encoding const & enc, bool const polyglossia)
1517 {
1518         // Check whether name can be encoded in the buffer encoding
1519         bool encodable = true;
1520         for (size_t i = 0; i < name.size(); ++i) {
1521                 if (!enc.encodable(name[i])) {
1522                         encodable = false;
1523                         break;
1524                 }
1525         }
1526
1527         docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1528                                                : from_ascii(lang->babel());
1529         docstring const langenc = from_ascii(lang->encoding()->iconvName());
1530         docstring const texenc = from_ascii(lang->encoding()->latexName());
1531         docstring const bufenc = from_ascii(enc.iconvName());
1532         docstring const s1 = docstring(1, 0xF0000);
1533         docstring const s2 = docstring(1, 0xF0001);
1534         docstring const translated = encodable ? name
1535                 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1536                         + s1 + langenc + s2 + name + s1 + bufenc + s2;
1537
1538         odocstringstream os;
1539         os << "\\addto\\captions" << language
1540            << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1541         return os.str();
1542 }
1543
1544
1545 docstring const i18npreamble(docstring const & templ, Language const * lang,
1546                              Encoding const & enc, bool const polyglossia,
1547                              bool const need_fixedwidth)
1548 {
1549         if (templ.empty())
1550                 return templ;
1551
1552         string preamble = polyglossia ?
1553                 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1554                 subst(to_utf8(templ), "$$lang", lang->babel());
1555
1556         string const langenc = lang->encoding()->iconvName();
1557         string const texenc = lang->encoding()->latexName();
1558         string const bufenc = enc.iconvName();
1559         Encoding const * testenc(&enc);
1560         bool lang_fallback = false;
1561         bool ascii_fallback = false;
1562         if (need_fixedwidth && !enc.hasFixedWidth()) {
1563                 if (lang->encoding()->hasFixedWidth()) {
1564                         testenc = lang->encoding();
1565                         lang_fallback = true;
1566                 } else {
1567                         // We need a fixed width encoding, but both the buffer
1568                         // encoding and the language encoding are variable
1569                         // width. As a last fallback, try to convert to pure
1570                         // ASCII using the LaTeX commands defined in unicodesymbols.
1571                         testenc = encodings.fromLyXName("ascii");
1572                         if (!testenc)
1573                                 return docstring();
1574                         ascii_fallback = true;
1575                 }
1576         }
1577         // First and second character of plane 15 (Private Use Area)
1578         string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1579         string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1580         // FIXME UNICODE
1581         // lyx::regex is not unicode-safe.
1582         // Should use QRegExp or (boost::u32regex, but that requires ICU)
1583         static regex const reg("_\\(([^\\)]+)\\)");
1584         smatch sub;
1585         while (regex_search(preamble, sub, reg)) {
1586                 string const key = sub.str(1);
1587                 docstring const name = lang->translateLayout(key);
1588                 // Check whether name can be encoded in the buffer encoding
1589                 bool encodable = true;
1590                 for (size_t i = 0; i < name.size() && encodable; ++i)
1591                         if (!testenc->encodable(name[i]))
1592                                 encodable = false;
1593                 string translated;
1594                 if (encodable && !lang_fallback)
1595                         translated = to_utf8(name);
1596                 else if (ascii_fallback)
1597                         translated = to_ascii(testenc->latexString(name).first);
1598                 else
1599                         translated = "\\inputencoding{" + texenc + "}"
1600                                 + s1 + langenc + s2 + to_utf8(name)
1601                                 + s1 + bufenc + s2;
1602                 preamble = subst(preamble, sub.str(), translated);
1603         }
1604         return from_utf8(preamble);
1605 }
1606
1607 }
1608
1609
1610 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1611 {
1612         DocumentClass const & tclass = params_.documentClass();
1613         // collect preamble snippets in a set to prevent multiple identical
1614         // commands (would happen if e.g. both theorem and theorem* are used)
1615         set<docstring> snippets;
1616         typedef LanguageList::const_iterator lang_it;
1617         lang_it const lbeg = UsedLanguages_.begin();
1618         lang_it const lend =  UsedLanguages_.end();
1619         list<docstring>::const_iterator cit = usedLayouts_.begin();
1620         list<docstring>::const_iterator end = usedLayouts_.end();
1621         for (; cit != end; ++cit) {
1622                 // language dependent commands (once per document)
1623                 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1624                                                 buffer().language(),
1625                                                 buffer().params().encoding(),
1626                                                 use_polyglossia, false));
1627                 // commands for language changing (for multilanguage documents)
1628                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1629                         snippets.insert(i18npreamble(
1630                                                 tclass[*cit].babelpreamble(),
1631                                                 buffer().language(),
1632                                                 buffer().params().encoding(),
1633                                                 use_polyglossia, false));
1634                         for (lang_it lit = lbeg; lit != lend; ++lit)
1635                                 snippets.insert(i18npreamble(
1636                                                 tclass[*cit].babelpreamble(),
1637                                                 *lit,
1638                                                 buffer().params().encoding(),
1639                                                 use_polyglossia, false));
1640                 }
1641         }
1642         if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1643                 FloatList const & floats = params_.documentClass().floats();
1644                 UsedFloats::const_iterator fit = usedFloats_.begin();
1645                 UsedFloats::const_iterator fend = usedFloats_.end();
1646                 for (; fit != fend; ++fit) {
1647                         Floating const & fl = floats.getType(fit->first);
1648                         // we assume builtin floats are translated
1649                         if (fl.isPredefined())
1650                                 continue;
1651                         docstring const type = from_ascii(fl.floattype());
1652                         docstring const flname = from_utf8(fl.name());
1653                         docstring name = buffer().language()->translateLayout(fl.name());
1654                         // only request translation if we have a real translation
1655                         // (that differs from the source)
1656                         if (flname != name)
1657                                 snippets.insert(getFloatI18nPreamble(
1658                                                 type, name, buffer().language(),
1659                                                 buffer().params().encoding(),
1660                                                 use_polyglossia));
1661                         for (lang_it lit = lbeg; lit != lend; ++lit) {
1662                                 string const code = (*lit)->code();
1663                                 name = (*lit)->translateLayout(fl.name());
1664                                 // we assume we have a suitable translation if
1665                                 // either the language is English (we need to
1666                                 // translate into English if English is a secondary
1667                                 // language) or if translateIfPossible returns
1668                                 // something different to the English source.
1669                                 bool const have_translation =
1670                                         (flname != name || contains(code, "en"));
1671                                 if (have_translation)
1672                                         snippets.insert(getFloatI18nPreamble(
1673                                                 type, name, *lit,
1674                                                 buffer().params().encoding(),
1675                                                 use_polyglossia));
1676                         }
1677                 }
1678         }
1679
1680         cit = usedInsetLayouts_.begin();
1681         end = usedInsetLayouts_.end();
1682         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1683         for (; cit != end; ++cit) {
1684                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1685                 if (it == ils.end())
1686                         continue;
1687                 // The listings package does not work with variable width
1688                 // encodings, only with fixed width encodings. Therefore we
1689                 // need to force a fixed width encoding for
1690                 // \lstlistlistingname and \lstlistingname (bug 9382).
1691                 // This needs to be consistent with InsetListings::latex().
1692                 bool const need_fixedwidth = !runparams_.isFullUnicode() &&
1693                                 it->second.fixedwidthpreambleencoding();
1694                 // language dependent commands (once per document)
1695                 snippets.insert(i18npreamble(it->second.langpreamble(),
1696                                                 buffer().language(),
1697                                                 buffer().params().encoding(),
1698                                                 use_polyglossia, need_fixedwidth));
1699                 // commands for language changing (for multilanguage documents)
1700                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1701                         snippets.insert(i18npreamble(
1702                                                 it->second.babelpreamble(),
1703                                                 buffer().language(),
1704                                                 buffer().params().encoding(),
1705                                                 use_polyglossia, need_fixedwidth));
1706                         for (lang_it lit = lbeg; lit != lend; ++lit)
1707                                 snippets.insert(i18npreamble(
1708                                                 it->second.babelpreamble(),
1709                                                 *lit,
1710                                                 buffer().params().encoding(),
1711                                                 use_polyglossia, need_fixedwidth));
1712                 }
1713         }
1714
1715         odocstringstream tcpreamble;
1716         set<docstring>::const_iterator const send = snippets.end();
1717         set<docstring>::const_iterator it = snippets.begin();
1718         for (; it != send; ++it)
1719                 tcpreamble << *it;
1720         return tcpreamble.str();
1721 }
1722
1723
1724 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1725 {
1726         // Definition of entities used in the document that are LyX related.
1727         odocstringstream entities;
1728
1729         if (mustProvide("lyxarrow")) {
1730                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
1731         }
1732
1733         return entities.str();
1734 }
1735
1736
1737 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1738 {
1739         odocstringstream sgmlpreamble;
1740         // FIXME UNICODE
1741         docstring const basename(from_utf8(onlyPath(fname)));
1742
1743         FileMap::const_iterator end = IncludedFiles_.end();
1744         for (FileMap::const_iterator fi = IncludedFiles_.begin();
1745              fi != end; ++fi)
1746                 // FIXME UNICODE
1747                 sgmlpreamble << "\n<!ENTITY " << fi->first
1748                              << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1749                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
1750
1751         return sgmlpreamble.str();
1752 }
1753
1754
1755 void LaTeXFeatures::showStruct() const
1756 {
1757         lyxerr << "LyX needs the following commands when LaTeXing:"
1758                << "\n***** Packages:" << getPackages()
1759                << "\n***** Macros:" << to_utf8(getMacros())
1760                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1761                << "\n***** done." << endl;
1762 }
1763
1764
1765 Buffer const & LaTeXFeatures::buffer() const
1766 {
1767         return *buffer_;
1768 }
1769
1770
1771 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1772 {
1773         buffer_ = &buffer;
1774 }
1775
1776
1777 BufferParams const & LaTeXFeatures::bufferParams() const
1778 {
1779         return params_;
1780 }
1781
1782
1783 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1784 {
1785         FloatList const & floats = params_.documentClass().floats();
1786
1787         // Here we will output the code to create the needed float styles.
1788         // We will try to do this as minimal as possible.
1789         // \floatstyle{ruled}
1790         // \newfloat{algorithm}{htbp}{loa}
1791         // \providecommand{\algorithmname}{Algorithm}
1792         // \floatname{algorithm}{\protect\algorithmname}
1793         UsedFloats::const_iterator cit = usedFloats_.begin();
1794         UsedFloats::const_iterator end = usedFloats_.end();
1795         for (; cit != end; ++cit) {
1796                 Floating const & fl = floats.getType(cit->first);
1797
1798                 // For builtin floats we do nothing.
1799                 if (fl.isPredefined())
1800                         continue;
1801
1802                 // We have to special case "table" and "figure"
1803                 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1804                         // Output code to modify "table" or "figure"
1805                         // but only if builtin == false
1806                         // and that have to be true at this point in the
1807                         // function.
1808                         docstring const type = from_ascii(fl.floattype());
1809                         docstring const placement = from_ascii(fl.placement());
1810                         docstring const style = from_ascii(fl.style());
1811                         if (!style.empty()) {
1812                                 os << "\\floatstyle{" << style << "}\n"
1813                                    << "\\restylefloat{" << type << "}\n";
1814                         }
1815                         if (!placement.empty()) {
1816                                 os << "\\floatplacement{" << type << "}{"
1817                                    << placement << "}\n";
1818                         }
1819                 } else {
1820                         // The other non builtin floats.
1821
1822                         docstring const type = from_ascii(fl.floattype());
1823                         docstring const placement = from_ascii(fl.placement());
1824                         docstring const ext = from_ascii(fl.ext());
1825                         docstring const within = from_ascii(fl.within());
1826                         docstring const style = from_ascii(fl.style());
1827                         docstring const name =
1828                                 buffer().language()->translateLayout(fl.name());
1829                         os << "\\floatstyle{" << style << "}\n"
1830                            << "\\newfloat{" << type << "}{" << placement
1831                            << "}{" << ext << '}';
1832                         if (!within.empty())
1833                                 os << '[' << within << ']';
1834                         os << '\n'
1835                            << "\\providecommand{\\" << type << "name}{"
1836                            << name << "}\n"
1837                            << "\\floatname{" << type << "}{\\protect\\"
1838                            << type << "name}\n";
1839
1840                         // What missing here is to code to minimalize the code
1841                         // output so that the same floatstyle will not be
1842                         // used several times, when the same style is still in
1843                         // effect. (Lgb)
1844                 }
1845                 if (cit->second)
1846                         // The subfig package is loaded later
1847                         os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
1848         }
1849 }
1850
1851
1852 void LaTeXFeatures::resolveAlternatives()
1853 {
1854         for (Features::iterator it = features_.begin(); it != features_.end();) {
1855                 if (contains(*it, '|')) {
1856                         vector<string> const alternatives = getVectorFromString(*it, "|");
1857                         vector<string>::const_iterator const end = alternatives.end();
1858                         vector<string>::const_iterator ita = alternatives.begin();
1859                         // Is any alternative already required? => use that
1860                         for (; ita != end; ++ita) {
1861                                 if (isRequired(*ita))
1862                                         break;
1863                         }
1864                         // Is any alternative available? => use the first one
1865                         // (bug 9498)
1866                         if (ita == end) {
1867                                 for (ita = alternatives.begin(); ita != end; ++ita) {
1868                                         if (isAvailable(*ita)) {
1869                                                 require(*ita);
1870                                                 break;
1871                                         }
1872                                 }
1873                         }
1874                         // This will not work, but not requiring something
1875                         // would be more confusing
1876                         if (ita == end)
1877                                 require(alternatives.front());
1878                         features_.erase(it);
1879                         it = features_.begin();
1880                 } else
1881                         ++it;
1882         }
1883 }
1884
1885
1886 } // namespace lyx