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