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