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