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