src/LaTeXFeatures.cpp

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