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