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 languages;
 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                         languages << ',';
 845                 else
 846                         first = false;
 847                 languages << (*cit)->babel();
 848         }
 849         return languages.str();
 850 }
 851
 852
 853 set<string> LaTeXFeatures::getPolyglossiaLanguages() const
 854 {
 855         set<string> languages;
 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                 languages.insert((*cit)->polyglossia());
 863         }
 864         return languages;
 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> encodings;
 874         LanguageList::const_iterator it  = UsedLanguages_.begin();
 875         LanguageList::const_iterator end = UsedLanguages_.end();
 876         for (; it != end; ++it)
 877                 if ((*it)->encoding()->latexName() != doc_encoding &&
 878                     ((*it)->encoding()->package() == Encoding::inputenc
 879                      || (*it)->encoding()->package() == Encoding::japanese))
 880                         encodings.insert((*it)->encoding()->latexName());
 881         return encodings;
 882 }
 883
 884
 885 void LaTeXFeatures::getFontEncodings(vector<string> & encodings) const
 886 {
 887         // these must be loaded if glyphs of this script are used
 888         // unless a language providing them is used in the document
 889         if (mustProvide("textgreek")
 890             && find(encodings.begin(), encodings.end(), "LGR") == encodings.end())
 891                 encodings.insert(encodings.begin(), "LGR");
 892         if (mustProvide("textcyr")
 893             && find(encodings.begin(), encodings.end(), "T2A") == encodings.end())
 894                 encodings.insert(encodings.begin(), "T2A");
 895
 896         LanguageList::const_iterator it  = UsedLanguages_.begin();
 897         LanguageList::const_iterator end = UsedLanguages_.end();
 898         for (; it != end; ++it)
 899                 if (!(*it)->fontenc().empty()
 900                     && ascii_lowercase((*it)->fontenc()) != "none") {
 901                         vector<string> extraencs = getVectorFromString((*it)->fontenc());
 902                         vector<string>::const_iterator fit = extraencs.begin();
 903                         for (; fit != extraencs.end(); ++fit) {
 904                                 if (find(encodings.begin(), encodings.end(), *fit) == encodings.end())
 905                                         encodings.insert(encodings.begin(), *fit);
 906                         }
 907                 }
 908 }
 909
 910 namespace {
 911
 912 char const * simplefeatures[] = {
 913 // note that the package order here will be the same in the LaTeX-output
 914         "array",
 915         "verbatim",
 916         "longtable",
 917         "rotating",
 918         "latexsym",
 919         "pifont",
 920         // subfig is handled in BufferParams.cpp
 921         "varioref",
 922         "prettyref",
 923         "refstyle",
 924         /*For a successful cooperation of the `wrapfig' package with the
 925           `float' package you should load the `wrapfig' package *after*
 926           the `float' package. See the caption package documentation
 927           for explanation.*/
 928         "float",
 929         "rotfloat",
 930         "wrapfig",
 931         "booktabs",
 932         "dvipost",
 933         "fancybox",
 934         "calc",
 935         "units",
 936         "framed",
 937         "soul",
 938         "textcomp",
 939         "pmboxdraw",
 940         "bbding",
 941         "ifsym",
 942         "txfonts",
 943         "pxfonts",
 944         "mathdesign",
 945         "mathrsfs",
 946         "mathabx",
 947         "mathtools",
 948         // "cancel",
 949         "ascii",
 950         "url",
 951         "covington",
 952         "csquotes",
 953         "enumitem",
 954         "endnotes",
 955         "hhline",
 956         "ifthen",
 957         // listings is handled in BufferParams.cpp
 958         "bm",
 959         "pdfpages",
 960         "amscd",
 961         "slashed",
 962         "multicol",
 963         "multirow",
 964         "tfrupee",
 965         "shapepar",
 966         "rsphrase",
 967         "hpstatement",
 968         "algorithm2e",
 969         "sectionbox",
 970         "tcolorbox",
 971         "pdfcomment",
 972         "fixme",
 973         "todonotes",
 974         "forest",
 975         "varwidth",
 976         "footnote",
 977         "tablefootnote",
 978 };
 979
 980 char const * bibliofeatures[] = {
 981         // Known bibliography packages (will be loaded before natbib)
 982         "achicago",
 983         "apacite",
 984         "apalike",
 985         "astron",
 986         "authordate1-4",
 987         "babelbib",
 988         "bibgerm",
 989         "chapterbib",
 990         "chicago",
 991         "chscite",
 992         "harvard",
 993         "mslapa",
 994         "named"
 995 };
 996
 997 int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
 998
 999 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
1000
1001 } // namespace
1002
1003
1004 string const LaTeXFeatures::getColorOptions() const
1005 {
1006         ostringstream colors;
1007
1008         // Handling the color packages separately is needed to be able to load them
1009         // before babel when hyperref is loaded with the colorlinks option
1010         // for more info see Bufferparams.cpp
1011
1012         // [x]color.sty
1013         if (mustProvide("color") || mustProvide("xcolor")) {
1014                 string const package =
1015                         (mustProvide("xcolor") ? "xcolor" : "color");
1016                 if (params_.graphics_driver == "default"
1017                         || params_.graphics_driver == "none")
1018                         colors << "\\usepackage{" << package << "}\n";
1019                 else
1020                         colors << "\\usepackage["
1021                                  << params_.graphics_driver
1022                                  << "]{" << package << "}\n";
1023         }
1024
1025         // pdfcolmk must be loaded after color
1026         if (mustProvide("pdfcolmk"))
1027                 colors << "\\usepackage{pdfcolmk}\n";
1028
1029         // the following 3 color commands must be set after color
1030         // is loaded and before pdfpages, therefore add the command
1031         // here define the set color
1032         if (mustProvide("pagecolor")) {
1033                 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
1034                 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
1035                 // set the page color
1036                 colors << "\\pagecolor{page_backgroundcolor}\n";
1037         }
1038
1039         if (mustProvide("fontcolor")) {
1040                 colors << "\\definecolor{document_fontcolor}{rgb}{";
1041                 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
1042                 // set the color
1043                 colors << "\\color{document_fontcolor}\n";
1044         }
1045
1046         if (mustProvide("lyxgreyedout")) {
1047                 colors << "\\definecolor{note_fontcolor}{rgb}{";
1048                 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
1049                 // the color will be set together with the definition of
1050                 // the lyxgreyedout environment (see lyxgreyedout_def)
1051         }
1052
1053         // color for shaded boxes
1054         if (isRequired("framed") && mustProvide("color")) {
1055                 colors << "\\definecolor{shadecolor}{rgb}{";
1056                 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
1057                 // this color is automatically used by the LaTeX-package "framed"
1058         }
1059
1060         return colors.str();
1061 }
1062
1063
1064 string const LaTeXFeatures::getPackageOptions() const
1065 {
1066         ostringstream packageopts;
1067         // Output all the package option stuff we have been asked to do.
1068         map<string, string>::const_iterator it =
1069                 params_.documentClass().packageOptions().begin();
1070         map<string, string>::const_iterator en =
1071                 params_.documentClass().packageOptions().end();
1072         for (; it != en; ++it)
1073                 if (mustProvide(it->first))
1074                         packageopts << "\\PassOptionsToPackage{" << it->second << "}"
1075                                  << "{" << it->first << "}\n";
1076         return packageopts.str();
1077 }
1078
1079
1080 string const LaTeXFeatures::getPackages() const
1081 {
1082         ostringstream packages;
1083
1084         // FIXME: currently, we can only load packages and macros known
1085         // to LyX.
1086         // However, with the Require tag of layouts/custom insets,
1087         // also unknown packages can be requested. They are silently
1088         // swallowed now. We should change this eventually.
1089
1090         //  These are all the 'simple' includes.  i.e
1091         //  packages which we just \usepackage{package}
1092         for (int i = 0; i < nb_simplefeatures; ++i) {
1093                 if (mustProvide(simplefeatures[i]))
1094                         packages << "\\usepackage{" << simplefeatures[i] << "}\n";
1095         }
1096
1097         // The rest of these packages are somewhat more complicated
1098         // than those above.
1099
1100         // The tipa package and its extensions (tipx, tone) must not
1101         // be loaded with non-TeX fonts, since fontspec includes the
1102         // respective macros
1103         if (mustProvide("tipa") && !params_.useNonTeXFonts)
1104                 packages << "\\usepackage{tipa}\n";
1105         if (mustProvide("tipx") && !params_.useNonTeXFonts)
1106                 packages << "\\usepackage{tipx}\n";
1107         if (mustProvide("extraipa") && !params_.useNonTeXFonts)
1108                 packages << "\\usepackage{extraipa}\n";
1109         if (mustProvide("tone") && !params_.useNonTeXFonts)
1110                 packages << "\\usepackage{tone}\n";
1111
1112         // if fontspec or newtxmath is used, AMS packages have to be loaded
1113         // before fontspec (in BufferParams)
1114         string const amsPackages = loadAMSPackages();
1115         bool const ot1 = (params_.main_font_encoding() == "default"
1116                           || params_.main_font_encoding() == "OT1");
1117         bool const use_newtxmath =
1118                 theLaTeXFonts().getLaTeXFont(from_ascii(params_.fontsMath())).getUsedPackage(
1119                         ot1, false, false) == "newtxmath";
1120
1121         if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
1122                 packages << amsPackages;
1123
1124         if (mustProvide("cancel") &&
1125             params_.use_package("cancel") != BufferParams::package_off)
1126                 packages << "\\usepackage{cancel}\n";
1127
1128         // marvosym and bbding both define the \Cross macro
1129         if (mustProvide("marvosym")) {
1130             if (mustProvide("bbding"))
1131                 packages << "\\let\\Cross\\relax\n";
1132             packages << "\\usepackage{marvosym}\n";
1133         }
1134
1135         // accents must be loaded after amsmath
1136         if (mustProvide("accents") &&
1137             params_.use_package("accents") != BufferParams::package_off)
1138                 packages << "\\usepackage{accents}\n";
1139
1140         // mathdots must be loaded after amsmath
1141         if (mustProvide("mathdots") &&
1142                 params_.use_package("mathdots") != BufferParams::package_off)
1143                 packages << "\\usepackage{mathdots}\n";
1144
1145         // yhmath must be loaded after amsmath
1146         if (mustProvide("yhmath") &&
1147             params_.use_package("yhmath") != BufferParams::package_off)
1148                 packages << "\\usepackage{yhmath}\n";
1149
1150         // stmaryrd must be loaded after amsmath
1151         if (mustProvide("stmaryrd") &&
1152             params_.use_package("stmaryrd") != BufferParams::package_off)
1153                 packages << "\\usepackage{stmaryrd}\n";
1154
1155         if (mustProvide("stackrel") &&
1156             params_.use_package("stackrel") != BufferParams::package_off)
1157                 packages << "\\usepackage{stackrel}\n";
1158
1159         if (mustProvide("undertilde") &&
1160                 params_.use_package("undertilde") != BufferParams::package_off)
1161                 packages << "\\usepackage{undertilde}\n";
1162
1163         // [x]color and pdfcolmk are handled in getColorOptions() above
1164
1165         // makeidx.sty
1166         if (isRequired("makeidx") || isRequired("splitidx")) {
1167                 if (!isProvided("makeidx") && !isRequired("splitidx"))
1168                         packages << "\\usepackage{makeidx}\n";
1169                 if (mustProvide("splitidx"))
1170                         packages << "\\usepackage{splitidx}\n";
1171                 packages << "\\makeindex\n";
1172         }
1173
1174         // graphicx.sty
1175         if (mustProvide("graphicx") && params_.graphics_driver != "none") {
1176                 if (params_.graphics_driver == "default")
1177                         packages << "\\usepackage{graphicx}\n";
1178                 else
1179                         packages << "\\usepackage["
1180                                  << params_.graphics_driver
1181                                  << "]{graphicx}\n";
1182         }
1183
1184         // lyxskak.sty --- newer chess support based on skak.sty
1185         if (mustProvide("chess"))
1186                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
1187
1188         // setspace.sty
1189         if (mustProvide("setspace") && !isProvided("SetSpace"))
1190                 packages << "\\usepackage{setspace}\n";
1191
1192         // we need to assure that mhchem is loaded before esint and every other
1193         // package that redefines command of amsmath because mhchem loads amlatex
1194         // (this info is from the author of mhchem from June 2013)
1195         if (mustProvide("mhchem") &&
1196             params_.use_package("mhchem") != BufferParams::package_off)
1197                 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
1198                             "\\usepackage{mhchem}\n";
1199
1200         // wasysym is a simple feature, but it must be after amsmath if both
1201         // are used
1202         // wasysym redefines some integrals (e.g. iint) from amsmath. That
1203         // leads to inconsistent integrals. We only load this package if
1204         // the document does not contain integrals (then isRequired("esint")
1205         // is false) or if esint is used, since esint redefines all relevant
1206         // integral symbols from wasysym and amsmath.
1207         // See http://www.lyx.org/trac/ticket/1942
1208         if (mustProvide("wasysym") &&
1209             params_.use_package("wasysym") != BufferParams::package_off &&
1210             (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
1211                 packages << "\\usepackage{wasysym}\n";
1212
1213         // esint must be after amsmath (and packages requiring amsmath, like mhchem)
1214         // and wasysym, since it will redeclare inconsistent integral symbols
1215         if (mustProvide("esint") &&
1216             params_.use_package("esint") != BufferParams::package_off)
1217                 packages << "\\usepackage{esint}\n";
1218
1219         // Known bibliography packages (simple \usepackage{package})
1220         for (int i = 0; i < nb_bibliofeatures; ++i) {
1221                 if (mustProvide(bibliofeatures[i]))
1222                         packages << "\\usepackage{"
1223                                  << bibliofeatures[i] << "}\n";
1224         }
1225
1226         // Compatibility between achicago and natbib
1227         if (mustProvide("achicago") && mustProvide("natbib"))
1228                 packages << "\\let\\achicagobib\\thebibliography\n";
1229
1230         // natbib.sty
1231         // Some classes load natbib themselves, but still allow (or even require)
1232         // plain numeric citations (ReVTeX is such a case, see bug 5182).
1233         // This special case is indicated by the "natbib-internal" key.
1234         if (mustProvide("natbib")
1235             && !isProvided("natbib-internal")
1236             && !isProvided("biblatex")
1237             && !isProvided("biblatex-natbib")
1238             && !isProvided("jurabib")) {
1239                 packages << "\\usepackage[";
1240                 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
1241                         packages << "numbers";
1242                 else
1243                         packages << "authoryear";
1244                 if (!params_.biblio_opts.empty())
1245                         packages << ',' << params_.biblio_opts;
1246                 packages << "]{natbib}\n";
1247         }
1248
1249         // Compatibility between achicago and natbib
1250         if (mustProvide("achicago") && mustProvide("natbib")) {
1251                 packages << "\\let\\thebibliography\\achicagobib\n";
1252                 packages << "\\let\\SCcite\\astroncite\n";
1253                 packages << "\\let\\UnexpandableProtect\\protect\n";
1254         }
1255
1256         // jurabib -- we need version 0.6 at least.
1257         if (mustProvide("jurabib")
1258             && !isProvided("natbib-internal")
1259             && !isProvided("natbib")
1260             && !isProvided("biblatex")
1261             && !isProvided("biblatex-natbib")) {
1262                 packages << "\\usepackage";
1263                 if (!params_.biblio_opts.empty())
1264                         packages << '[' << params_.biblio_opts << ']';
1265                 packages << "{jurabib}[2004/01/25]\n";
1266         }
1267
1268         // opcit -- we pass custombst as we output \bibliographystyle ourselves
1269         if (mustProvide("opcit")) {
1270                 if (isRequired("hyperref"))
1271                         packages << "\\usepackage[custombst,hyperref]{opcit}\n";
1272                 else
1273                         packages << "\\usepackage[custombst]{opcit}\n";
1274         }
1275
1276         // xargs -- we need version 1.09 at least
1277         if (mustProvide("xargs"))
1278                 packages << "\\usepackage{xargs}[2008/03/08]\n";
1279
1280         if (mustProvide("xy"))
1281                 packages << "\\usepackage[all]{xy}\n";
1282
1283         if (mustProvide("feyn"))
1284                 packages << "\\usepackage{feyn}\n"; //Diagram
1285
1286         if (mustProvide("ulem"))
1287                 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
1288                             "\\usepackage{ulem}\n";
1289
1290         if (mustProvide("nomencl")) {
1291                 // Make it work with the new and old version of the package,
1292                 // but don't use the compatibility option since it is
1293                 // incompatible to other packages.
1294                 packages << "\\usepackage{nomencl}\n"
1295                             "% the following is useful when we have the old nomencl.sty package\n"
1296                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
1297                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
1298                             "\\makenomenclature\n";
1299         }
1300
1301         // fixltx2e provides subscript
1302         if (mustProvide("subscript") && !isRequired("fixltx2e"))
1303                 packages << "\\usepackage{subscript}\n";
1304
1305         // footmisc must be loaded after setspace
1306         // Set options here, load the package after the user preamble to
1307         // avoid problems with manual loaded footmisc.
1308         if (mustProvide("footmisc"))
1309                 packages << "\\PassOptionsToPackage{stable}{footmisc}\n";
1310
1311         if (mustProvide("microtype")){
1312                 packages << "\\usepackage{microtype}\n";
1313         }
1314
1315         return packages.str();
1316 }
1317
1318
1319 TexString LaTeXFeatures::getMacros() const
1320 {
1321         otexstringstream macros;
1322
1323         if (!preamble_snippets_.empty()) {
1324                 macros << '\n';
1325                 macros << getPreambleSnippets();
1326         }
1327
1328         if (mustProvide("xetexdashbreakstate"))
1329                 macros << "\\XeTeXdashbreakstate 0" << '\n';
1330
1331         if (mustProvide("papersize")) {
1332                 if (runparams_.flavor == OutputParams::LATEX
1333                     || runparams_.flavor == OutputParams::DVILUATEX)
1334                         macros << papersizedvi_def << '\n';
1335                 else if  (runparams_.flavor == OutputParams::LUATEX)
1336                         macros << papersizepdflua_def << '\n';
1337                 else
1338                         macros << papersizepdf_def << '\n';
1339         }
1340
1341         if (mustProvide("LyX")) {
1342                 if (isRequired("hyperref"))
1343                         macros << lyx_hyperref_def << '\n';
1344                 else
1345                         macros << lyx_def << '\n';
1346         }
1347
1348         if (mustProvide("noun"))
1349                 macros << noun_def << '\n';
1350
1351         if (mustProvide("lyxarrow"))
1352                 macros << lyxarrow_def << '\n';
1353
1354         if (mustProvide("lyxzerowidthspace"))
1355                 macros << lyxZWSP_def << '\n';
1356
1357         if (!usePolyglossia() && mustProvide("textgreek")) {
1358             // ensure LGR font encoding is defined also if fontenc is not loaded by LyX
1359                 if (params_.main_font_encoding() == "default")
1360                         macros << textgreek_LGR_def;
1361                 macros << textgreek_def << '\n';
1362         }
1363
1364         if (!usePolyglossia() && mustProvide("textcyr")) {
1365                 // ensure T2A font encoding is set up also if fontenc is not loaded by LyX
1366                 if (params_.main_font_encoding() == "default")
1367                         macros << textcyr_T2A_def;
1368                 macros << textcyr_def << '\n';
1369         }
1370
1371         // non-standard text accents:
1372         if (mustProvide("textcommaabove") || mustProvide("textcommaaboveright") ||
1373             mustProvide("textcommabelow") || mustProvide("textbaltic"))
1374                 macros << lyxaccent_def;
1375
1376         if (mustProvide("textcommabelow") || mustProvide("textbaltic"))
1377                 macros << textcommabelow_def << '\n';
1378
1379         if (mustProvide("textcommaabove") || mustProvide("textbaltic"))
1380                 macros << textcommaabove_def << '\n';
1381
1382         if (mustProvide("textcommaaboveright"))
1383                 macros << textcommaaboveright_def << '\n';
1384
1385         if (mustProvide("textbaltic"))
1386                 macros << textbaltic_def << '\n';
1387
1388         // split-level fractions
1389         if (mustProvide("xfrac") || mustProvide("smallLetterFrac"))
1390                 macros << xfrac_def << '\n';
1391
1392         if (mustProvide("smallLetterFrac"))
1393                 macros << smallLetterFrac_def << '\n';
1394
1395         if (mustProvide("lyxmathsym"))
1396                 macros << lyxmathsym_def << '\n';
1397
1398         if (mustProvide("cedilla"))
1399                 macros << cedilla_def << '\n';
1400
1401         if (mustProvide("subring"))
1402                 macros << subring_def << '\n';
1403
1404         if (mustProvide("subdot"))
1405                 macros << subdot_def << '\n';
1406
1407         if (mustProvide("subhat"))
1408                 macros << subhat_def << '\n';
1409
1410         if (mustProvide("subtilde"))
1411                 macros << subtilde_def << '\n';
1412
1413         if (mustProvide("dacute"))
1414                 macros << dacute_def << '\n';
1415
1416         if (mustProvide("tipasymb"))
1417                 macros << tipasymb_def << '\n';
1418
1419         if (mustProvide("dgrave"))
1420                 macros << dgrave_def << '\n';
1421
1422         if (mustProvide("rcap"))
1423                 macros << rcap_def << '\n';
1424
1425         if (mustProvide("ogonek"))
1426                 macros << ogonek_def << '\n';
1427
1428         // quotes.
1429         if (mustProvide("quotesinglbase"))
1430                 macros << quotesinglbase_def << '\n';
1431         if (mustProvide("quotedblbase"))
1432                 macros << quotedblbase_def << '\n';
1433         if (mustProvide("guilsinglleft"))
1434                 macros << guilsinglleft_def << '\n';
1435         if (mustProvide("guilsinglright"))
1436                 macros << guilsinglright_def << '\n';
1437         if (mustProvide("guillemotleft"))
1438                 macros << guillemotleft_def << '\n';
1439         if (mustProvide("guillemotright"))
1440                 macros << guillemotright_def << '\n';
1441         if (mustProvide("textquotedbl"))
1442                 macros << textquotedbl_def << '\n';
1443         if (mustProvide("textquotesinglep")) {
1444                 if (runparams_.flavor == OutputParams::XETEX)
1445                         macros << textquotesinglep_xetex_def << '\n';
1446                 else
1447                         macros << textquotesinglep_luatex_def << '\n';
1448         }
1449         if (mustProvide("textquotedblp")) {
1450                 if (runparams_.flavor == OutputParams::XETEX)
1451                         macros << textquotedblp_xetex_def << '\n';
1452                 else
1453                         macros << textquotedblp_luatex_def << '\n';
1454         }
1455
1456         // Math mode
1457         if (mustProvide("binom") && !isRequired("amsmath"))
1458                 macros << binom_def << '\n';
1459         if (mustProvide("mathcircumflex"))
1460                 macros << mathcircumflex_def << '\n';
1461
1462         // other
1463         if (mustProvide("ParagraphLeftIndent"))
1464                 macros << paragraphleftindent_def;
1465         if (mustProvide("NeedLyXFootnoteCode"))
1466                 macros << floatingfootnote_def;
1467
1468         // some problems with tex->html converters
1469         if (mustProvide("NeedTabularnewline"))
1470                 macros << tabularnewline_def;
1471
1472         // greyed-out environment (note inset)
1473         // the color is specified in the routine
1474         // getColorOptions() to avoid LaTeX-package clashes
1475         if (mustProvide("lyxgreyedout"))
1476                 macros << lyxgreyedout_def;
1477
1478         if (mustProvide("lyxdot"))
1479                 macros << lyxdot_def << '\n';
1480
1481         // floats
1482         getFloatDefinitions(macros);
1483
1484         if (mustProvide("refstyle"))
1485                 macros << lyxref_def << '\n';
1486
1487         // change tracking
1488         if (mustProvide("ct-dvipost"))
1489                 macros << changetracking_dvipost_def;
1490
1491         if (mustProvide("ct-xcolor-ulem")) {
1492                 streamsize const prec = macros.os().precision(2);
1493
1494                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1495                 macros << "\\providecolor{lyxadded}{rgb}{"
1496                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1497
1498                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1499                 macros << "\\providecolor{lyxdeleted}{rgb}{"
1500                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1501
1502                 macros.os().precision(prec);
1503
1504                 if (isRequired("hyperref"))
1505                         macros << changetracking_xcolor_ulem_hyperref_def;
1506                 else
1507                         macros << changetracking_xcolor_ulem_def;
1508         }
1509
1510         if (mustProvide("ct-tikz-math-sout"))
1511                         macros << changetracking_tikz_math_sout_def;
1512
1513         if (mustProvide("ct-none"))
1514                 macros << changetracking_none_def;
1515
1516         if (mustProvide("rtloutputdblcol"))
1517                 macros << rtloutputdblcol_def;
1518
1519         if (mustProvide("lyxmintcaption"))
1520                 macros << lyxmintcaption_def;
1521
1522         return macros.release();
1523 }
1524
1525
1526 docstring const LaTeXFeatures::getBabelPresettings() const
1527 {
1528         odocstringstream tmp;
1529
1530         for (Language const * lang : UsedLanguages_)
1531                 if (!lang->babel_presettings().empty())
1532                         tmp << lang->babel_presettings() << '\n';
1533         if (!params_.language->babel_presettings().empty())
1534                 tmp << params_.language->babel_presettings() << '\n';
1535
1536         if (!contains(tmp.str(), '@'))
1537                 return tmp.str();
1538
1539         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1540 }
1541
1542
1543 docstring const LaTeXFeatures::getBabelPostsettings() const
1544 {
1545         odocstringstream tmp;
1546
1547         for (Language const * lang : UsedLanguages_)
1548                 if (!lang->babel_postsettings().empty())
1549                         tmp << lang->babel_postsettings() << '\n';
1550         if (!params_.language->babel_postsettings().empty())
1551                 tmp << params_.language->babel_postsettings() << '\n';
1552
1553         if (!contains(tmp.str(), '@'))
1554                 return tmp.str();
1555
1556         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1557 }
1558
1559
1560 bool LaTeXFeatures::needBabelLangOptions() const
1561 {
1562         if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1563                 return true;
1564
1565         LanguageList::const_iterator it  = UsedLanguages_.begin();
1566         LanguageList::const_iterator end = UsedLanguages_.end();
1567         for (; it != end; ++it)
1568                 if ((*it)->asBabelOptions())
1569                         return true;
1570
1571         return false;
1572 }
1573
1574
1575 string const LaTeXFeatures::loadAMSPackages() const
1576 {
1577         ostringstream tmp;
1578
1579         if (mustProvide("amsmath")
1580             && params_.use_package("amsmath") != BufferParams::package_off) {
1581                 tmp << "\\usepackage{amsmath}\n";
1582         } else {
1583                 // amsbsy and amstext are already provided by amsmath
1584                 if (mustProvide("amsbsy"))
1585                         tmp << "\\usepackage{amsbsy}\n";
1586                 if (mustProvide("amstext"))
1587                         tmp << "\\usepackage{amstext}\n";
1588         }
1589
1590         if (mustProvide("amsthm"))
1591                 tmp << "\\usepackage{amsthm}\n";
1592
1593         if (mustProvide("amssymb")
1594             && params_.use_package("amssymb") != BufferParams::package_off)
1595                 tmp << "\\usepackage{amssymb}\n";
1596
1597         return tmp.str();
1598 }
1599
1600
1601 docstring const LaTeXFeatures::getTClassPreamble() const
1602 {
1603         // the text class specific preamble
1604         DocumentClass const & tclass = params_.documentClass();
1605         odocstringstream tcpreamble;
1606
1607         tcpreamble << tclass.preamble();
1608
1609         list<docstring>::const_iterator cit = usedLayouts_.begin();
1610         list<docstring>::const_iterator end = usedLayouts_.end();
1611         for (; cit != end; ++cit)
1612                 // For InPreamble layouts, we output the preamble stuff earlier
1613                 // (before the layouts). See Paragraph::Private::validate.
1614                 if (!tclass[*cit].inpreamble)
1615                         tcpreamble << tclass[*cit].preamble();
1616
1617         cit = usedInsetLayouts_.begin();
1618         end = usedInsetLayouts_.end();
1619         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1620         for (; cit != end; ++cit) {
1621                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1622                 if (it == ils.end())
1623                         continue;
1624                 tcpreamble << it->second.preamble();
1625         }
1626
1627         return tcpreamble.str();
1628 }
1629
1630
1631 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1632 {
1633         DocumentClass const & tclass = params_.documentClass();
1634         odocstringstream tcpreamble;
1635
1636         tcpreamble << tclass.htmlpreamble();
1637
1638         list<docstring>::const_iterator cit = usedLayouts_.begin();
1639         list<docstring>::const_iterator end = usedLayouts_.end();
1640         for (; cit != end; ++cit)
1641                 tcpreamble << tclass[*cit].htmlpreamble();
1642
1643         cit = usedInsetLayouts_.begin();
1644         end = usedInsetLayouts_.end();
1645         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1646         for (; cit != end; ++cit) {
1647                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1648                 if (it == ils.end())
1649                         continue;
1650                 tcpreamble << it->second.htmlpreamble();
1651         }
1652
1653         return tcpreamble.str();
1654 }
1655
1656
1657 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1658 {
1659         DocumentClass const & tclass = params_.documentClass();
1660         odocstringstream tcpreamble;
1661
1662         if (mustProvide("noun"))
1663                 tcpreamble << lyxnoun_style;
1664         // this isn't exact, but it won't hurt that much if it
1665         // wasn't for this.
1666         if (mustProvide("ulem"))
1667                 tcpreamble << lyxstrikeout_style;
1668
1669         tcpreamble << tclass.htmlstyles();
1670
1671         list<docstring>::const_iterator cit = usedLayouts_.begin();
1672         list<docstring>::const_iterator end = usedLayouts_.end();
1673         for (; cit != end; ++cit)
1674                 tcpreamble << tclass[*cit].htmlstyle();
1675
1676         cit = usedInsetLayouts_.begin();
1677         end = usedInsetLayouts_.end();
1678         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1679         for (; cit != end; ++cit) {
1680                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1681                 if (it == ils.end())
1682                         continue;
1683                 tcpreamble << it->second.htmlstyle();
1684         }
1685
1686         return tcpreamble.str();
1687 }
1688
1689
1690 namespace {
1691
1692 docstring const getFloatI18nPreamble(docstring const & type,
1693                         docstring const & name, Language const * lang,
1694                         Encoding const & enc, bool const polyglossia)
1695 {
1696         // Check whether name can be encoded in the buffer encoding
1697         bool encodable = true;
1698         for (size_t i = 0; i < name.size(); ++i) {
1699                 if (!enc.encodable(name[i])) {
1700                         encodable = false;
1701                         break;
1702                 }
1703         }
1704
1705         docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1706                                                : from_ascii(lang->babel());
1707         docstring const langenc = from_ascii(lang->encoding()->iconvName());
1708         docstring const texenc = from_ascii(lang->encoding()->latexName());
1709         docstring const bufenc = from_ascii(enc.iconvName());
1710         docstring const s1 = docstring(1, 0xF0000);
1711         docstring const s2 = docstring(1, 0xF0001);
1712         docstring const translated = encodable ? name
1713                 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1714                         + s1 + langenc + s2 + name + s1 + bufenc + s2;
1715
1716         odocstringstream os;
1717         os << "\\addto\\captions" << language
1718            << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1719         return os.str();
1720 }
1721
1722
1723 docstring const i18npreamble(docstring const & templ, Language const * lang,
1724                              Encoding const & enc, bool const polyglossia,
1725                              bool const need_fixedwidth)
1726 {
1727         if (templ.empty())
1728                 return templ;
1729
1730         string preamble = polyglossia ?
1731                 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1732                 subst(to_utf8(templ), "$$lang", lang->babel());
1733
1734         string const langenc = lang->encoding()->iconvName();
1735         string const texenc = lang->encoding()->latexName();
1736         string const bufenc = enc.iconvName();
1737         Encoding const * testenc(&enc);
1738         bool lang_fallback = false;
1739         bool ascii_fallback = false;
1740         if (need_fixedwidth && !enc.hasFixedWidth()) {
1741                 if (lang->encoding()->hasFixedWidth()) {
1742                         testenc = lang->encoding();
1743                         lang_fallback = true;
1744                 } else {
1745                         // We need a fixed width encoding, but both the buffer
1746                         // encoding and the language encoding are variable
1747                         // width. As a last fallback, try to convert to pure
1748                         // ASCII using the LaTeX commands defined in unicodesymbols.
1749                         testenc = encodings.fromLyXName("ascii");
1750                         if (!testenc)
1751                                 return docstring();
1752                         ascii_fallback = true;
1753                 }
1754         }
1755         // First and second character of plane 15 (Private Use Area)
1756         string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1757         string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1758         // FIXME UNICODE
1759         // lyx::regex is not unicode-safe.
1760         // Should use QRegExp or (boost::u32regex, but that requires ICU)
1761         static regex const reg("_\\(([^\\)]+)\\)");
1762         smatch sub;
1763         while (regex_search(preamble, sub, reg)) {
1764                 string const key = sub.str(1);
1765                 docstring const name = lang->translateLayout(key);
1766                 // Check whether name can be encoded in the buffer encoding
1767                 bool encodable = true;
1768                 for (size_t i = 0; i < name.size() && encodable; ++i)
1769                         if (!testenc->encodable(name[i]))
1770                                 encodable = false;
1771                 string translated;
1772                 if (encodable && !lang_fallback)
1773                         translated = to_utf8(name);
1774                 else if (ascii_fallback)
1775                         translated = to_ascii(testenc->latexString(name).first);
1776                 else
1777                         translated = "\\inputencoding{" + texenc + "}"
1778                                 + s1 + langenc + s2 + to_utf8(name)
1779                                 + s1 + bufenc + s2;
1780                 preamble = subst(preamble, sub.str(), translated);
1781         }
1782         return from_utf8(preamble);
1783 }
1784
1785 } // namespace
1786
1787
1788 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel,
1789                                 bool use_polyglossia, bool use_minted) const
1790 {
1791         DocumentClass const & tclass = params_.documentClass();
1792         // collect preamble snippets in a set to prevent multiple identical
1793         // commands (would happen if e.g. both theorem and theorem* are used)
1794         set<docstring> snippets;
1795         typedef LanguageList::const_iterator lang_it;
1796         lang_it const lbeg = UsedLanguages_.begin();
1797         lang_it const lend =  UsedLanguages_.end();
1798         list<docstring>::const_iterator cit = usedLayouts_.begin();
1799         list<docstring>::const_iterator end = usedLayouts_.end();
1800         for (; cit != end; ++cit) {
1801                 // language dependent commands (once per document)
1802                 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1803                                                 buffer().language(),
1804                                                 buffer().params().encoding(),
1805                                                 use_polyglossia, false));
1806                 // commands for language changing (for multilanguage documents)
1807                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1808                         snippets.insert(i18npreamble(
1809                                                 tclass[*cit].babelpreamble(),
1810                                                 buffer().language(),
1811                                                 buffer().params().encoding(),
1812                                                 use_polyglossia, false));
1813                         for (lang_it lit = lbeg; lit != lend; ++lit)
1814                                 snippets.insert(i18npreamble(
1815                                                 tclass[*cit].babelpreamble(),
1816                                                 *lit,
1817                                                 buffer().params().encoding(),
1818                                                 use_polyglossia, false));
1819                 }
1820         }
1821         if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1822                 FloatList const & floats = params_.documentClass().floats();
1823                 UsedFloats::const_iterator fit = usedFloats_.begin();
1824                 UsedFloats::const_iterator fend = usedFloats_.end();
1825                 for (; fit != fend; ++fit) {
1826                         Floating const & fl = floats.getType(fit->first);
1827                         // we assume builtin floats are translated
1828                         if (fl.isPredefined())
1829                                 continue;
1830                         docstring const type = from_ascii(fl.floattype());
1831                         docstring const flname = from_utf8(fl.name());
1832                         docstring name = buffer().language()->translateLayout(fl.name());
1833                         // only request translation if we have a real translation
1834                         // (that differs from the source)
1835                         if (flname != name)
1836                                 snippets.insert(getFloatI18nPreamble(
1837                                                 type, name, buffer().language(),
1838                                                 buffer().params().encoding(),
1839                                                 use_polyglossia));
1840                         for (lang_it lit = lbeg; lit != lend; ++lit) {
1841                                 string const code = (*lit)->code();
1842                                 name = (*lit)->translateLayout(fl.name());
1843                                 // we assume we have a suitable translation if
1844                                 // either the language is English (we need to
1845                                 // translate into English if English is a secondary
1846                                 // language) or if translateIfPossible returns
1847                                 // something different to the English source.
1848                                 bool const have_translation =
1849                                         (flname != name || contains(code, "en"));
1850                                 if (have_translation)
1851                                         snippets.insert(getFloatI18nPreamble(
1852                                                 type, name, *lit,
1853                                                 buffer().params().encoding(),
1854                                                 use_polyglossia));
1855                         }
1856                 }
1857         }
1858
1859         cit = usedInsetLayouts_.begin();
1860         end = usedInsetLayouts_.end();
1861         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1862         for (; cit != end; ++cit) {
1863                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1864                 if (it == ils.end())
1865                         continue;
1866                 // The listings package does not work with variable width
1867                 // encodings, only with fixed width encodings. Therefore we
1868                 // need to force a fixed width encoding for
1869                 // \lstlistlistingname and \lstlistingname (bug 9382).
1870                 // This needs to be consistent with InsetListings::latex().
1871                 bool const need_fixedwidth = !use_minted &&
1872                                         !runparams_.isFullUnicode() &&
1873                                         it->second.fixedwidthpreambleencoding();
1874                 // language dependent commands (once per document)
1875                 snippets.insert(i18npreamble(it->second.langpreamble(),
1876                                                 buffer().language(),
1877                                                 buffer().params().encoding(),
1878                                                 use_polyglossia, need_fixedwidth));
1879                 // commands for language changing (for multilanguage documents)
1880                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1881                         snippets.insert(i18npreamble(
1882                                                 it->second.babelpreamble(),
1883                                                 buffer().language(),
1884                                                 buffer().params().encoding(),
1885                                                 use_polyglossia, need_fixedwidth));
1886                         for (lang_it lit = lbeg; lit != lend; ++lit)
1887                                 snippets.insert(i18npreamble(
1888                                                 it->second.babelpreamble(),
1889                                                 *lit,
1890                                                 buffer().params().encoding(),
1891                                                 use_polyglossia, need_fixedwidth));
1892                 }
1893         }
1894
1895         odocstringstream tcpreamble;
1896         set<docstring>::const_iterator const send = snippets.end();
1897         set<docstring>::const_iterator it = snippets.begin();
1898         for (; it != send; ++it)
1899                 tcpreamble << *it;
1900         return tcpreamble.str();
1901 }
1902
1903
1904 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1905 {
1906         // Definition of entities used in the document that are LyX related.
1907         odocstringstream entities;
1908
1909         if (mustProvide("lyxarrow")) {
1910                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
1911         }
1912
1913         return entities.str();
1914 }
1915
1916
1917 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1918 {
1919         odocstringstream sgmlpreamble;
1920         // FIXME UNICODE
1921         docstring const basename(from_utf8(onlyPath(fname)));
1922
1923         FileMap::const_iterator end = IncludedFiles_.end();
1924         for (FileMap::const_iterator fi = IncludedFiles_.begin();
1925              fi != end; ++fi)
1926                 // FIXME UNICODE
1927                 sgmlpreamble << "\n<!ENTITY " << fi->first
1928                              << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1929                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
1930
1931         return sgmlpreamble.str();
1932 }
1933
1934
1935 void LaTeXFeatures::showStruct() const
1936 {
1937         lyxerr << "LyX needs the following commands when LaTeXing:"
1938                << "\n***** Packages:" << getPackages()
1939                << "\n***** Macros:" << to_utf8(getMacros().str)
1940                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1941                << "\n***** done." << endl;
1942 }
1943
1944
1945 Buffer const & LaTeXFeatures::buffer() const
1946 {
1947         return *buffer_;
1948 }
1949
1950
1951 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1952 {
1953         buffer_ = &buffer;
1954 }
1955
1956
1957 BufferParams const & LaTeXFeatures::bufferParams() const
1958 {
1959         return params_;
1960 }
1961
1962
1963 void LaTeXFeatures::getFloatDefinitions(otexstream & os) const
1964 {
1965         FloatList const & floats = params_.documentClass().floats();
1966
1967         // Here we will output the code to create the needed float styles.
1968         // We will try to do this as minimal as possible.
1969         // \floatstyle{ruled}
1970         // \newfloat{algorithm}{htbp}{loa}
1971         // \providecommand{\algorithmname}{Algorithm}
1972         // \floatname{algorithm}{\protect\algorithmname}
1973         UsedFloats::const_iterator cit = usedFloats_.begin();
1974         UsedFloats::const_iterator end = usedFloats_.end();
1975         for (; cit != end; ++cit) {
1976                 Floating const & fl = floats.getType(cit->first);
1977
1978                 // For builtin floats we do nothing.
1979                 if (fl.isPredefined())
1980                         continue;
1981
1982                 // We have to special case "table" and "figure"
1983                 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1984                         // Output code to modify "table" or "figure"
1985                         // but only if builtin == false
1986                         // and that have to be true at this point in the
1987                         // function.
1988                         docstring const type = from_ascii(fl.floattype());
1989                         docstring const placement = from_ascii(fl.placement());
1990                         docstring const style = from_ascii(fl.style());
1991                         if (!style.empty()) {
1992                                 os << "\\floatstyle{" << style << "}\n"
1993                                    << "\\restylefloat{" << type << "}\n";
1994                         }
1995                         if (!placement.empty()) {
1996                                 os << "\\floatplacement{" << type << "}{"
1997                                    << placement << "}\n";
1998                         }
1999                 } else {
2000                         // The other non builtin floats.
2001
2002                         docstring const type = from_ascii(fl.floattype());
2003                         docstring const placement = from_ascii(fl.placement());
2004                         docstring const ext = from_ascii(fl.ext());
2005                         docstring const within = from_ascii(fl.within());
2006                         docstring const style = from_ascii(fl.style());
2007                         docstring const name =
2008                                 buffer().language()->translateLayout(fl.name());
2009                         os << "\\floatstyle{" << style << "}\n"
2010                            << "\\newfloat{" << type << "}{" << placement
2011                            << "}{" << ext << '}';
2012                         if (!within.empty())
2013                                 os << '[' << within << ']';
2014                         os << '\n'
2015                            << "\\providecommand{\\" << type << "name}{"
2016                            << name << "}\n"
2017                            << "\\floatname{" << type << "}{\\protect\\"
2018                            << type << "name}\n";
2019
2020                         // What missing here is to code to minimalize the code
2021                         // output so that the same floatstyle will not be
2022                         // used several times, when the same style is still in
2023                         // effect. (Lgb)
2024                 }
2025                 if (cit->second)
2026                         // The subfig package is loaded later
2027                         os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
2028         }
2029 }
2030
2031
2032 void LaTeXFeatures::resolveAlternatives()
2033 {
2034         for (Features::iterator it = features_.begin(); it != features_.end();) {
2035                 if (contains(*it, '|')) {
2036                         vector<string> const alternatives = getVectorFromString(*it, "|");
2037                         vector<string>::const_iterator const end = alternatives.end();
2038                         vector<string>::const_iterator ita = alternatives.begin();
2039                         // Is any alternative already required? => use that
2040                         for (; ita != end; ++ita) {
2041                                 if (isRequired(*ita))
2042                                         break;
2043                         }
2044                         // Is any alternative available? => use the first one
2045                         // (bug 9498)
2046                         if (ita == end) {
2047                                 for (ita = alternatives.begin(); ita != end; ++ita) {
2048                                         if (isAvailable(*ita)) {
2049                                                 require(*ita);
2050                                                 break;
2051                                         }
2052                                 }
2053                         }
2054                         // This will not work, but not requiring something
2055                         // would be more confusing
2056                         if (ita == end)
2057                                 require(alternatives.front());
2058                         features_.erase(it);
2059                         it = features_.begin();
2060                 } else
2061                         ++it;
2062         }
2063 }
2064
2065
2066 void LaTeXFeatures::expandMultiples()
2067 {
2068         for (Features::iterator it = features_.begin(); it != features_.end();) {
2069                 if (contains(*it, ',')) {
2070                         vector<string> const multiples = getVectorFromString(*it, ",");
2071                         vector<string>::const_iterator const end = multiples.end();
2072                         vector<string>::const_iterator itm = multiples.begin();
2073                         // Do nothing if any multiple is already required
2074                         for (; itm != end; ++itm) {
2075                                 if (!isRequired(*itm))
2076                                         require(*itm);
2077                         }
2078                         features_.erase(it);
2079                         it = features_.begin();
2080                 } else
2081                         ++it;
2082         }
2083 }
2084
2085
2086 } // namespace lyx