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