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