src/LaTeXFeatures.cpp

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