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 };
 751
 752 char const * bibliofeatures[] = {
 753         // Known bibliography packages (will be loaded before natbib)
 754         "achicago",
 755         "apacite",
 756         "apalike",
 757         "astron",
 758         "authordate1-4",
 759         "babelbib",
 760         "bibgerm",
 761         "chicago",
 762         "chscite",
 763         "harvard",
 764         "mslapa",
 765         "named"
 766 };
 767
 768 int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
 769
 770 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 771
 772 }
 773
 774
 775 string const LaTeXFeatures::getColorOptions() const
 776 {
 777         ostringstream colors;
 778
 779         // Handling the color packages separately is needed to be able to load them
 780         // before babel when hyperref is loaded with the colorlinks option
 781         // for more info see Bufferparams.cpp
 782
 783         // [x]color.sty
 784         if (mustProvide("color") || mustProvide("xcolor")) {
 785                 string const package =
 786                         (mustProvide("xcolor") ? "xcolor" : "color");
 787                 if (params_.graphics_driver == "default"
 788                         || params_.graphics_driver == "none")
 789                         colors << "\\usepackage{" << package << "}\n";
 790                 else
 791                         colors << "\\usepackage["
 792                                  << params_.graphics_driver
 793                                  << "]{" << package << "}\n";
 794         }
 795
 796         // pdfcolmk must be loaded after color
 797         if (mustProvide("pdfcolmk"))
 798                 colors << "\\usepackage{pdfcolmk}\n";
 799
 800         // the following 3 color commands must be set after color
 801         // is loaded and before pdfpages, therefore add the command
 802         // here define the set color
 803         if (mustProvide("pagecolor")) {
 804                 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
 805                 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
 806                 // set the page color
 807                 colors << "\\pagecolor{page_backgroundcolor}\n";
 808         }
 809
 810         if (mustProvide("fontcolor")) {
 811                 colors << "\\definecolor{document_fontcolor}{rgb}{";
 812                 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
 813                 // set the color
 814                 colors << "\\color{document_fontcolor}\n";
 815         }
 816
 817         if (mustProvide("lyxgreyedout")) {
 818                 colors << "\\definecolor{note_fontcolor}{rgb}{";
 819                 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
 820                 // the color will be set together with the definition of
 821                 // the lyxgreyedout environment (see lyxgreyedout_def)
 822         }
 823
 824         // color for shaded boxes
 825         if (isRequired("framed") && mustProvide("color")) {
 826                 colors << "\\definecolor{shadecolor}{rgb}{";
 827                 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
 828                 // this color is automatically used by the LaTeX-package "framed"
 829         }
 830
 831         return colors.str();
 832 }
 833
 834
 835 string const LaTeXFeatures::getPackages() const
 836 {
 837         ostringstream packages;
 838
 839         // FIXME: currently, we can only load packages and macros known
 840         // to LyX.
 841         // However, with the Require tag of layouts/custom insets,
 842         // also unknown packages can be requested. They are silently
 843         // swallowed now. We should change this eventually.
 844
 845         // Output all the package option stuff we have been asked to do.
 846         map<string, string>::const_iterator it =
 847             params_.documentClass().packageOptions().begin();
 848         map<string, string>::const_iterator en =
 849             params_.documentClass().packageOptions().end();
 850         for (; it != en; ++it)
 851                 if (mustProvide(it->first))
 852                         packages << "\\PassOptionsToPackage{" << it->second << "}"
 853                                  << "{" << it->first << "}\n";
 854
 855         //  These are all the 'simple' includes.  i.e
 856         //  packages which we just \usepackage{package}
 857         for (int i = 0; i < nb_simplefeatures; ++i) {
 858                 if (mustProvide(simplefeatures[i]))
 859                         packages << "\\usepackage{" << simplefeatures[i] << "}\n";
 860         }
 861
 862         // The rest of these packages are somewhat more complicated
 863         // than those above.
 864
 865         // The tipa package and its extensions (tipx, tone) must not
 866         // be loaded with non-TeX fonts, since fontspec includes the
 867         // respective macros
 868         if (mustProvide("tipa") && !params_.useNonTeXFonts)
 869                 packages << "\\usepackage{tipa}\n";
 870         if (mustProvide("tipx") && !params_.useNonTeXFonts)
 871                 packages << "\\usepackage{tipx}\n";
 872         if (mustProvide("tone") && !params_.useNonTeXFonts)
 873                 packages << "\\usepackage{tone}\n";
 874
 875         // if fontspec or newtxmath is used, AMS packages have to be loaded
 876         // before fontspec (in BufferParams)
 877         string const amsPackages = loadAMSPackages();
 878         bool const ot1 = (params_.font_encoding() == "default" || params_.font_encoding() == "OT1");
 879         bool const use_newtxmath =
 880                 theLaTeXFonts().getLaTeXFont(from_ascii(params_.fonts_math)).getUsedPackage(
 881                         ot1, false, false) == "newtxmath";
 882
 883         if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
 884                 packages << amsPackages;
 885
 886         // fixltx2e must be loaded after amsthm, since amsthm produces an error with
 887         // the redefined \[ command (bug 7233). Load it as early as possible, since
 888         // other packages might profit from it.
 889         if (mustProvide("fixltx2e"))
 890                 packages << "\\usepackage{fixltx2e}\n";
 891
 892         if (mustProvide("cancel") &&
 893             params_.use_package("cancel") != BufferParams::package_off)
 894                 packages << "\\usepackage{cancel}\n";
 895         // wasysym is a simple feature, but it must be after amsmath if both
 896         // are used
 897         // wasysym redefines some integrals (e.g. iint) from amsmath. That
 898         // leads to inconsistent integrals. We only load this package if
 899         // the document does not contain integrals (then isRequired("esint")
 900         // is false) or if esint is used, since esint redefines all relevant
 901         // integral symbols from wasysym and amsmath.
 902         // See http://www.lyx.org/trac/ticket/1942
 903         if (mustProvide("wasysym") &&
 904             params_.use_package("wasysym") != BufferParams::package_off &&
 905             (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
 906                 packages << "\\usepackage{wasysym}\n";
 907
 908         // accents must be loaded after amsmath
 909         if (mustProvide("accents") &&
 910             params_.use_package("accents") != BufferParams::package_off)
 911                 packages << "\\usepackage{accents}\n";
 912
 913         // mathdots must be loaded after amsmath
 914         if (mustProvide("mathdots") &&
 915                 params_.use_package("mathdots") != BufferParams::package_off)
 916                 packages << "\\usepackage{mathdots}\n";
 917
 918         // yhmath must be loaded after amsmath
 919         if (mustProvide("yhmath") &&
 920             params_.use_package("yhmath") != BufferParams::package_off)
 921                 packages << "\\usepackage{yhmath}\n";
 922
 923         // stmaryrd must be loaded after amsmath
 924         if (mustProvide("stmaryrd") &&
 925             params_.use_package("stmaryrd") != BufferParams::package_off)
 926                 packages << "\\usepackage{stmaryrd}\n";
 927
 928         if (mustProvide("stackrel") &&
 929             params_.use_package("stackrel") != BufferParams::package_off)
 930                 packages << "\\usepackage{stackrel}\n";
 931
 932         if (mustProvide("undertilde") &&
 933                 params_.use_package("undertilde") != BufferParams::package_off)
 934                 packages << "\\usepackage{undertilde}\n";
 935
 936         // [x]color and pdfcolmk are handled in getColorOptions() above
 937
 938         // makeidx.sty
 939         if (isRequired("makeidx") || isRequired("splitidx")) {
 940                 if (!isProvided("makeidx") && !isRequired("splitidx"))
 941                         packages << "\\usepackage{makeidx}\n";
 942                 if (mustProvide("splitidx"))
 943                         packages << "\\usepackage{splitidx}\n";
 944                 packages << "\\makeindex\n";
 945         }
 946
 947         // graphicx.sty
 948         if (mustProvide("graphicx") && params_.graphics_driver != "none") {
 949                 if (params_.graphics_driver == "default")
 950                         packages << "\\usepackage{graphicx}\n";
 951                 else
 952                         packages << "\\usepackage["
 953                                  << params_.graphics_driver
 954                                  << "]{graphicx}\n";
 955         }
 956
 957         // lyxskak.sty --- newer chess support based on skak.sty
 958         if (mustProvide("chess"))
 959                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
 960
 961         // setspace.sty
 962         if (mustProvide("setspace") && !isProvided("SetSpace"))
 963                 packages << "\\usepackage{setspace}\n";
 964
 965         // we need to assure that mhchem is loaded before esint
 966         // because esint must be loaded AFTER amslatex and mhchem loads amlatex
 967         // (this info is from the author of mhchem from June 2013)
 968         if (mustProvide("mhchem") &&
 969             params_.use_package("mhchem") != BufferParams::package_off)
 970                 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
 971                             "\\usepackage{mhchem}\n";
 972
 973         // esint must be after amsmath (and packages requiring amsmath, like mhchem)
 974         // and wasysym, since it will redeclare inconsistent integral symbols
 975         if (mustProvide("esint") &&
 976             params_.use_package("esint") != BufferParams::package_off)
 977                 packages << "\\usepackage{esint}\n";
 978
 979         // Known bibliography packages (simple \usepackage{package})
 980         for (int i = 0; i < nb_bibliofeatures; ++i) {
 981                 if (mustProvide(bibliofeatures[i]))
 982                         packages << "\\usepackage{"
 983                                  << bibliofeatures[i] << "}\n";
 984         }
 985
 986         // Compatibility between achicago and natbib
 987         if (mustProvide("achicago") && mustProvide("natbib"))
 988                 packages << "\\let\\achicagobib\\thebibliography\n";
 989
 990         // natbib.sty
 991         // Some classes load natbib themselves, but still allow (or even require)
 992         // plain numeric citations (ReVTeX is such a case, see bug 5182).
 993         // This special case is indicated by the "natbib-internal" key.
 994         if (mustProvide("natbib") && !isProvided("natbib-internal")) {
 995                 packages << "\\usepackage[";
 996                 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
 997                         packages << "numbers";
 998                 else
 999                         packages << "authoryear";
1000                 packages << "]{natbib}\n";
1001         }
1002
1003         // Compatibility between achicago and natbib
1004         if (mustProvide("achicago") && mustProvide("natbib")) {
1005                 packages << "\\let\\thebibliography\\achicagobib\n";
1006                 packages << "\\let\\SCcite\\astroncite\n";
1007                 packages << "\\let\\UnexpandableProtect\\protect\n";
1008         }
1009
1010         // jurabib -- we need version 0.6 at least.
1011         if (mustProvide("jurabib"))
1012                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
1013
1014         // opcit -- we pass custombst as we output \bibliographystyle ourselves
1015         if (mustProvide("opcit")) {
1016                 if (isRequired("hyperref"))
1017                         packages << "\\usepackage[custombst,hyperref]{opcit}\n";
1018                 else
1019                         packages << "\\usepackage[custombst]{opcit}\n";
1020         }
1021
1022         // xargs -- we need version 1.09 at least
1023         if (mustProvide("xargs"))
1024                 packages << "\\usepackage{xargs}[2008/03/08]\n";
1025
1026         if (mustProvide("xy"))
1027                 packages << "\\usepackage[all]{xy}\n";
1028
1029         if (mustProvide("feyn"))
1030                 packages << "\\usepackage{feyn}\n"; //Diagram
1031
1032         if (mustProvide("ulem"))
1033                 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
1034                             "\\usepackage{ulem}\n";
1035
1036         if (mustProvide("nomencl")) {
1037                 // Make it work with the new and old version of the package,
1038                 // but don't use the compatibility option since it is
1039                 // incompatible to other packages.
1040                 packages << "\\usepackage{nomencl}\n"
1041                             "% the following is useful when we have the old nomencl.sty package\n"
1042                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
1043                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
1044                             "\\makenomenclature\n";
1045         }
1046
1047         // fixltx2e provides subscript
1048         if (mustProvide("subscript") && !isRequired("fixltx2e"))
1049                 packages << "\\usepackage{subscript}\n";
1050
1051         return packages.str();
1052 }
1053
1054
1055 string LaTeXFeatures::getPreambleSnippets() const
1056 {
1057         ostringstream snip;
1058         SnippetList::const_iterator pit  = preamble_snippets_.begin();
1059         SnippetList::const_iterator pend = preamble_snippets_.end();
1060         for (; pit != pend; ++pit)
1061                 snip << *pit << '\n';
1062         return snip.str();
1063 }
1064
1065
1066 std::string LaTeXFeatures::getCSSSnippets() const
1067 {
1068         ostringstream snip;
1069         SnippetList::const_iterator pit  = css_snippets_.begin();
1070         SnippetList::const_iterator pend = css_snippets_.end();
1071         for (; pit != pend; ++pit)
1072                 snip << *pit << '\n';
1073         return snip.str();
1074 }
1075
1076
1077 docstring const LaTeXFeatures::getMacros() const
1078 {
1079         odocstringstream macros;
1080
1081         if (!preamble_snippets_.empty()) {
1082                 macros << '\n';
1083                 macros << from_utf8(getPreambleSnippets());
1084         }
1085
1086         if (mustProvide("papersize")) {
1087                 if (runparams_.flavor == OutputParams::LATEX)
1088                         macros << papersizedvi_def << '\n';
1089                 else
1090                         macros << papersizepdf_def << '\n';
1091         }
1092
1093         if (mustProvide("LyX")) {
1094                 if (isRequired("hyperref"))
1095                         macros << lyx_hyperref_def << '\n';
1096                 else
1097                         macros << lyx_def << '\n';
1098         }
1099
1100         if (mustProvide("noun"))
1101                 macros << noun_def << '\n';
1102
1103         if (mustProvide("lyxarrow"))
1104                 macros << lyxarrow_def << '\n';
1105
1106         if (!usePolyglossia() && mustProvide("textgreek")) {
1107                 // Avoid a LaTeX error if times fonts are used and the grtimes
1108                 // package is installed but actual fonts are not (bug 6469).
1109                 if (params_.fonts_roman == "times")
1110                         macros << subst(textgreek_def,
1111                                         from_ascii("\\greektext #1"),
1112                                         from_ascii("%\n  \\IfFileExists"
1113                                                    "{grtm10.tfm}{}{\\fontfamily"
1114                                                    "{cmr}}\\greektext #1"))
1115                                << '\n';
1116                 else
1117                         macros << textgreek_def << '\n';
1118         }
1119
1120         if (!usePolyglossia() && mustProvide("textcyr"))
1121                 macros << textcyr_def << '\n';
1122
1123         if (mustProvide("lyxmathsym"))
1124                 macros << lyxmathsym_def << '\n';
1125
1126         if (mustProvide("cedilla"))
1127                 macros << cedilla_def << '\n';
1128
1129         if (mustProvide("subring"))
1130                 macros << subring_def << '\n';
1131
1132         if (mustProvide("subdot"))
1133                 macros << subdot_def << '\n';
1134
1135         if (mustProvide("subhat"))
1136                 macros << subhat_def << '\n';
1137
1138         if (mustProvide("subtilde"))
1139                 macros << subtilde_def << '\n';
1140
1141         if (mustProvide("dacute"))
1142                 macros << dacute_def << '\n';
1143
1144         if (mustProvide("tipasymb"))
1145                 macros << tipasymb_def << '\n';
1146
1147         if (mustProvide("dgrave"))
1148                 macros << dgrave_def << '\n';
1149
1150         if (mustProvide("rcap"))
1151                 macros << rcap_def << '\n';
1152
1153         if (mustProvide("ogonek"))
1154                 macros << ogonek_def << '\n';
1155
1156         // quotes.
1157         if (mustProvide("quotesinglbase"))
1158                 macros << quotesinglbase_def << '\n';
1159         if (mustProvide("quotedblbase"))
1160                 macros << quotedblbase_def << '\n';
1161         if (mustProvide("guilsinglleft"))
1162                 macros << guilsinglleft_def << '\n';
1163         if (mustProvide("guilsinglright"))
1164                 macros << guilsinglright_def << '\n';
1165         if (mustProvide("guillemotleft"))
1166                 macros << guillemotleft_def << '\n';
1167         if (mustProvide("guillemotright"))
1168                 macros << guillemotright_def << '\n';
1169
1170         // Math mode
1171         if (mustProvide("binom") && !isRequired("amsmath"))
1172                 macros << binom_def << '\n';
1173         if (mustProvide("mathcircumflex"))
1174                 macros << mathcircumflex_def << '\n';
1175
1176         // other
1177         if (mustProvide("ParagraphLeftIndent"))
1178                 macros << paragraphleftindent_def;
1179         if (mustProvide("NeedLyXFootnoteCode"))
1180                 macros << floatingfootnote_def;
1181
1182         // some problems with tex->html converters
1183         if (mustProvide("NeedTabularnewline"))
1184                 macros << tabularnewline_def;
1185
1186         // greyed-out environment (note inset)
1187         // the color is specified in the routine
1188         // getColorOptions() to avoid LaTeX-package clashes
1189         if (mustProvide("lyxgreyedout"))
1190                 macros << lyxgreyedout_def;
1191
1192         if (mustProvide("lyxdot"))
1193                 macros << lyxdot_def << '\n';
1194
1195         // floats
1196         getFloatDefinitions(macros);
1197
1198         if (mustProvide("refstyle"))
1199                 macros << lyxref_def << '\n';
1200
1201         // change tracking
1202         if (mustProvide("ct-dvipost"))
1203                 macros << changetracking_dvipost_def;
1204
1205         if (mustProvide("ct-xcolor-ulem")) {
1206                 streamsize const prec = macros.precision(2);
1207
1208                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1209                 macros << "\\providecolor{lyxadded}{rgb}{"
1210                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1211
1212                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1213                 macros << "\\providecolor{lyxdeleted}{rgb}{"
1214                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1215
1216                 macros.precision(prec);
1217
1218                 if (isRequired("hyperref"))
1219                         macros << changetracking_xcolor_ulem_hyperref_def;
1220                 else
1221                         macros << changetracking_xcolor_ulem_def;
1222         }
1223
1224         if (mustProvide("ct-none"))
1225                 macros << changetracking_none_def;
1226
1227         if (mustProvide("rtloutputdblcol"))
1228                 macros << rtloutputdblcol_def;
1229
1230         return macros.str();
1231 }
1232
1233
1234 string const LaTeXFeatures::getBabelPresettings() const
1235 {
1236         ostringstream tmp;
1237
1238         LanguageList::const_iterator it  = UsedLanguages_.begin();
1239         LanguageList::const_iterator end = UsedLanguages_.end();
1240         for (; it != end; ++it)
1241                 if (!(*it)->babel_presettings().empty())
1242                         tmp << (*it)->babel_presettings() << '\n';
1243         if (!params_.language->babel_presettings().empty())
1244                 tmp << params_.language->babel_presettings() << '\n';
1245
1246         if (!contains(tmp.str(), '@'))
1247                 return tmp.str();
1248
1249         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1250 }
1251
1252
1253 string const LaTeXFeatures::getBabelPostsettings() const
1254 {
1255         ostringstream tmp;
1256
1257         LanguageList::const_iterator it  = UsedLanguages_.begin();
1258         LanguageList::const_iterator end = UsedLanguages_.end();
1259         for (; it != end; ++it)
1260                 if (!(*it)->babel_postsettings().empty())
1261                         tmp << (*it)->babel_postsettings() << '\n';
1262         if (!params_.language->babel_postsettings().empty())
1263                 tmp << params_.language->babel_postsettings() << '\n';
1264
1265         if (!contains(tmp.str(), '@'))
1266                 return tmp.str();
1267
1268         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1269 }
1270
1271
1272 bool LaTeXFeatures::needBabelLangOptions() const
1273 {
1274         if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1275                 return true;
1276
1277         LanguageList::const_iterator it  = UsedLanguages_.begin();
1278         LanguageList::const_iterator end = UsedLanguages_.end();
1279         for (; it != end; ++it)
1280                 if ((*it)->asBabelOptions())
1281                         return true;
1282
1283         return false;
1284 }
1285
1286
1287 string const LaTeXFeatures::loadAMSPackages() const
1288 {
1289         ostringstream tmp;
1290         if (mustProvide("amsthm"))
1291                 tmp << "\\usepackage{amsthm}\n";
1292
1293         if (mustProvide("amsmath")
1294             && params_.use_package("amsmath") != BufferParams::package_off) {
1295                 tmp << "\\usepackage{amsmath}\n";
1296         } else {
1297                 // amsbsy and amstext are already provided by amsmath
1298                 if (mustProvide("amsbsy"))
1299                         tmp << "\\usepackage{amsbsy}\n";
1300                 if (mustProvide("amstext"))
1301                         tmp << "\\usepackage{amstext}\n";
1302         }
1303
1304         if (mustProvide("amssymb")
1305             && params_.use_package("amssymb") != BufferParams::package_off)
1306                 tmp << "\\usepackage{amssymb}\n";
1307
1308         return tmp.str();
1309 }
1310
1311
1312 docstring const LaTeXFeatures::getTClassPreamble() const
1313 {
1314         // the text class specific preamble
1315         DocumentClass const & tclass = params_.documentClass();
1316         odocstringstream tcpreamble;
1317
1318         tcpreamble << tclass.preamble();
1319
1320         list<docstring>::const_iterator cit = usedLayouts_.begin();
1321         list<docstring>::const_iterator end = usedLayouts_.end();
1322         for (; cit != end; ++cit)
1323                 tcpreamble << tclass[*cit].preamble();
1324
1325         cit = usedInsetLayouts_.begin();
1326         end = usedInsetLayouts_.end();
1327         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1328         for (; cit != end; ++cit) {
1329                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1330                 if (it == ils.end())
1331                         continue;
1332                 tcpreamble << it->second.preamble();
1333         }
1334
1335         return tcpreamble.str();
1336 }
1337
1338
1339 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1340 {
1341         DocumentClass const & tclass = params_.documentClass();
1342         odocstringstream tcpreamble;
1343
1344         tcpreamble << tclass.htmlpreamble();
1345
1346         list<docstring>::const_iterator cit = usedLayouts_.begin();
1347         list<docstring>::const_iterator end = usedLayouts_.end();
1348         for (; cit != end; ++cit)
1349                 tcpreamble << tclass[*cit].htmlpreamble();
1350
1351         cit = usedInsetLayouts_.begin();
1352         end = usedInsetLayouts_.end();
1353         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1354         for (; cit != end; ++cit) {
1355                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1356                 if (it == ils.end())
1357                         continue;
1358                 tcpreamble << it->second.htmlpreamble();
1359         }
1360
1361         return tcpreamble.str();
1362 }
1363
1364
1365 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1366 {
1367         DocumentClass const & tclass = params_.documentClass();
1368         odocstringstream tcpreamble;
1369
1370         if (mustProvide("noun"))
1371                 tcpreamble << lyxnoun_style;
1372         // this isn't exact, but it won't hurt that much if it
1373         // wasn't for this.
1374         if (mustProvide("ulem"))
1375                 tcpreamble << lyxstrikeout_style;
1376
1377         tcpreamble << tclass.htmlstyles();
1378
1379         list<docstring>::const_iterator cit = usedLayouts_.begin();
1380         list<docstring>::const_iterator end = usedLayouts_.end();
1381         for (; cit != end; ++cit)
1382                 tcpreamble << tclass[*cit].htmlstyle();
1383
1384         cit = usedInsetLayouts_.begin();
1385         end = usedInsetLayouts_.end();
1386         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1387         for (; cit != end; ++cit) {
1388                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1389                 if (it == ils.end())
1390                         continue;
1391                 tcpreamble << it->second.htmlstyle();
1392         }
1393
1394         return tcpreamble.str();
1395 }
1396
1397
1398 namespace {
1399
1400 docstring const getFloatI18nPreamble(docstring const & type,
1401                         docstring const & name, Language const * lang,
1402                         Encoding const & enc, bool const polyglossia)
1403 {
1404         // Check whether name can be encoded in the buffer encoding
1405         bool encodable = true;
1406         for (size_t i = 0; i < name.size(); ++i) {
1407                 if (!enc.encodable(name[i])) {
1408                         encodable = false;
1409                         break;
1410                 }
1411         }
1412
1413         docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1414                                                : from_ascii(lang->babel());
1415         docstring const langenc = from_ascii(lang->encoding()->iconvName());
1416         docstring const texenc = from_ascii(lang->encoding()->latexName());
1417         docstring const bufenc = from_ascii(enc.iconvName());
1418         docstring const s1 = docstring(1, 0xF0000);
1419         docstring const s2 = docstring(1, 0xF0001);
1420         docstring const translated = encodable ? name
1421                 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1422                         + s1 + langenc + s2 + name + s1 + bufenc + s2;
1423
1424         odocstringstream os;
1425         os << "\\addto\\captions" << language
1426            << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1427         return os.str();
1428 }
1429
1430
1431 docstring const i18npreamble(docstring const & templ, Language const * lang,
1432                 Encoding const & enc, bool const polyglossia)
1433 {
1434         if (templ.empty())
1435                 return templ;
1436
1437         string preamble = polyglossia ?
1438                 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1439                 subst(to_utf8(templ), "$$lang", lang->babel());
1440
1441         string const langenc = lang->encoding()->iconvName();
1442         string const texenc = lang->encoding()->latexName();
1443         string const bufenc = enc.iconvName();
1444         // First and second character of plane 15 (Private Use Area)
1445         string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1446         string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1447         // FIXME UNICODE
1448         // lyx::regex is not unicode-safe.
1449         // Should use QRegExp or (boost::u32regex, but that requires ICU)
1450         static regex const reg("_\\(([^\\)]+)\\)");
1451         smatch sub;
1452         while (regex_search(preamble, sub, reg)) {
1453                 string const key = sub.str(1);
1454                 docstring const name = lang->translateLayout(key);
1455                 // Check whether name can be encoded in the buffer encoding
1456                 bool encodable = true;
1457                 for (size_t i = 0; i < name.size(); ++i) {
1458                         if (!enc.encodable(name[i])) {
1459                                 encodable = false;
1460                                 break;
1461                         }
1462                 }
1463                 string const translated = encodable ? to_utf8(name)
1464                         : "\\inputencoding{" + texenc + "}"
1465                         + s1 + langenc + s2 + to_utf8(name)
1466                         + s1 + bufenc + s2;
1467                 preamble = subst(preamble, sub.str(), translated);
1468         }
1469         return from_utf8(preamble);
1470 }
1471
1472 }
1473
1474
1475 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1476 {
1477         DocumentClass const & tclass = params_.documentClass();
1478         // collect preamble snippets in a set to prevent multiple identical
1479         // commands (would happen if e.g. both theorem and theorem* are used)
1480         set<docstring> snippets;
1481         typedef LanguageList::const_iterator lang_it;
1482         lang_it const lbeg = UsedLanguages_.begin();
1483         lang_it const lend =  UsedLanguages_.end();
1484         list<docstring>::const_iterator cit = usedLayouts_.begin();
1485         list<docstring>::const_iterator end = usedLayouts_.end();
1486         for (; cit != end; ++cit) {
1487                 // language dependent commands (once per document)
1488                 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1489                                                 buffer().language(),
1490                                                 buffer().params().encoding(),
1491                                                 use_polyglossia));
1492                 // commands for language changing (for multilanguage documents)
1493                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1494                         snippets.insert(i18npreamble(
1495                                                 tclass[*cit].babelpreamble(),
1496                                                 buffer().language(),
1497                                                 buffer().params().encoding(),
1498                                                 use_polyglossia));
1499                         for (lang_it lit = lbeg; lit != lend; ++lit)
1500                                 snippets.insert(i18npreamble(
1501                                                 tclass[*cit].babelpreamble(),
1502                                                 *lit,
1503                                                 buffer().params().encoding(),
1504                                                 use_polyglossia));
1505                 }
1506         }
1507         if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1508                 FloatList const & floats = params_.documentClass().floats();
1509                 UsedFloats::const_iterator fit = usedFloats_.begin();
1510                 UsedFloats::const_iterator fend = usedFloats_.end();
1511                 for (; fit != fend; ++fit) {
1512                         Floating const & fl = floats.getType(fit->first);
1513                         // we assume builtin floats are translated
1514                         if (fl.isPredefined())
1515                                 continue;
1516                         docstring const type = from_ascii(fl.floattype());
1517                         docstring const flname = from_utf8(fl.name());
1518                         docstring name = buffer().language()->translateLayout(fl.name());
1519                         // only request translation if we have a real translation
1520                         // (that differs from the source)
1521                         if (flname != name)
1522                                 snippets.insert(getFloatI18nPreamble(
1523                                                 type, name, buffer().language(),
1524                                                 buffer().params().encoding(),
1525                                                 use_polyglossia));
1526                         for (lang_it lit = lbeg; lit != lend; ++lit) {
1527                                 string const code = (*lit)->code();
1528                                 name = (*lit)->translateLayout(fl.name());
1529                                 // we assume we have a suitable translation if
1530                                 // either the language is English (we need to
1531                                 // translate into English if English is a secondary
1532                                 // language) or if translateIfPossible returns
1533                                 // something different to the English source.
1534                                 bool const have_translation =
1535                                         (flname != name || contains(code, "en"));
1536                                 if (have_translation)
1537                                         snippets.insert(getFloatI18nPreamble(
1538                                                 type, name, *lit,
1539                                                 buffer().params().encoding(),
1540                                                 use_polyglossia));
1541                         }
1542                 }
1543         }
1544
1545         cit = usedInsetLayouts_.begin();
1546         end = usedInsetLayouts_.end();
1547         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1548         for (; cit != end; ++cit) {
1549                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1550                 if (it == ils.end())
1551                         continue;
1552                 // language dependent commands (once per document)
1553                 snippets.insert(i18npreamble(it->second.langpreamble(),
1554                                                 buffer().language(),
1555                                                 buffer().params().encoding(),
1556                                                 use_polyglossia));
1557                 // commands for language changing (for multilanguage documents)
1558                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1559                         snippets.insert(i18npreamble(
1560                                                 it->second.babelpreamble(),
1561                                                 buffer().language(),
1562                                                 buffer().params().encoding(),
1563                                                 use_polyglossia));
1564                         for (lang_it lit = lbeg; lit != lend; ++lit)
1565                                 snippets.insert(i18npreamble(
1566                                                 it->second.babelpreamble(),
1567                                                 *lit,
1568                                                 buffer().params().encoding(),
1569                                                 use_polyglossia));
1570                 }
1571         }
1572
1573         odocstringstream tcpreamble;
1574         set<docstring>::const_iterator const send = snippets.end();
1575         set<docstring>::const_iterator it = snippets.begin();
1576         for (; it != send; ++it)
1577                 tcpreamble << *it;
1578         return tcpreamble.str();
1579 }
1580
1581
1582 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1583 {
1584         // Definition of entities used in the document that are LyX related.
1585         odocstringstream entities;
1586
1587         if (mustProvide("lyxarrow")) {
1588                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
1589         }
1590
1591         return entities.str();
1592 }
1593
1594
1595 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1596 {
1597         odocstringstream sgmlpreamble;
1598         // FIXME UNICODE
1599         docstring const basename(from_utf8(onlyPath(fname)));
1600
1601         FileMap::const_iterator end = IncludedFiles_.end();
1602         for (FileMap::const_iterator fi = IncludedFiles_.begin();
1603              fi != end; ++fi)
1604                 // FIXME UNICODE
1605                 sgmlpreamble << "\n<!ENTITY " << fi->first
1606                              << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1607                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
1608
1609         return sgmlpreamble.str();
1610 }
1611
1612
1613 void LaTeXFeatures::showStruct() const
1614 {
1615         lyxerr << "LyX needs the following commands when LaTeXing:"
1616                << "\n***** Packages:" << getPackages()
1617                << "\n***** Macros:" << to_utf8(getMacros())
1618                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1619                << "\n***** done." << endl;
1620 }
1621
1622
1623 Buffer const & LaTeXFeatures::buffer() const
1624 {
1625         return *buffer_;
1626 }
1627
1628
1629 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1630 {
1631         buffer_ = &buffer;
1632 }
1633
1634
1635 BufferParams const & LaTeXFeatures::bufferParams() const
1636 {
1637         return params_;
1638 }
1639
1640
1641 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1642 {
1643         FloatList const & floats = params_.documentClass().floats();
1644
1645         // Here we will output the code to create the needed float styles.
1646         // We will try to do this as minimal as possible.
1647         // \floatstyle{ruled}
1648         // \newfloat{algorithm}{htbp}{loa}
1649         // \providecommand{\algorithmname}{Algorithm}
1650         // \floatname{algorithm}{\protect\algorithmname}
1651         UsedFloats::const_iterator cit = usedFloats_.begin();
1652         UsedFloats::const_iterator end = usedFloats_.end();
1653         for (; cit != end; ++cit) {
1654                 Floating const & fl = floats.getType(cit->first);
1655
1656                 // For builtin floats we do nothing.
1657                 if (fl.isPredefined())
1658                         continue;
1659
1660                 // We have to special case "table" and "figure"
1661                 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1662                         // Output code to modify "table" or "figure"
1663                         // but only if builtin == false
1664                         // and that have to be true at this point in the
1665                         // function.
1666                         docstring const type = from_ascii(fl.floattype());
1667                         docstring const placement = from_ascii(fl.placement());
1668                         docstring const style = from_ascii(fl.style());
1669                         if (!style.empty()) {
1670                                 os << "\\floatstyle{" << style << "}\n"
1671                                    << "\\restylefloat{" << type << "}\n";
1672                         }
1673                         if (!placement.empty()) {
1674                                 os << "\\floatplacement{" << type << "}{"
1675                                    << placement << "}\n";
1676                         }
1677                 } else {
1678                         // The other non builtin floats.
1679
1680                         docstring const type = from_ascii(fl.floattype());
1681                         docstring const placement = from_ascii(fl.placement());
1682                         docstring const ext = from_ascii(fl.ext());
1683                         docstring const within = from_ascii(fl.within());
1684                         docstring const style = from_ascii(fl.style());
1685                         docstring const name =
1686                                 buffer().language()->translateLayout(fl.name());
1687                         os << "\\floatstyle{" << style << "}\n"
1688                            << "\\newfloat{" << type << "}{" << placement
1689                            << "}{" << ext << '}';
1690                         if (!within.empty())
1691                                 os << '[' << within << ']';
1692                         os << '\n'
1693                            << "\\providecommand{\\" << type << "name}{"
1694                            << name << "}\n"
1695                            << "\\floatname{" << type << "}{\\protect\\"
1696                            << type << "name}\n";
1697
1698                         // What missing here is to code to minimalize the code
1699                         // output so that the same floatstyle will not be
1700                         // used several times, when the same style is still in
1701                         // effect. (Lgb)
1702                 }
1703                 if (cit->second)
1704                         // The subfig package is loaded later
1705                         os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
1706         }
1707 }
1708
1709
1710 void LaTeXFeatures::resolveAlternatives()
1711 {
1712         for (Features::iterator it = features_.begin(); it != features_.end();) {
1713                 if (contains(*it, '|')) {
1714                         vector<string> const alternatives = getVectorFromString(*it, "|");
1715                         vector<string>::const_iterator const end = alternatives.end();
1716                         vector<string>::const_iterator ita = alternatives.begin();
1717                         for (; ita != end; ++ita) {
1718                                 if (isRequired(*ita))
1719                                         break;
1720                         }
1721                         if (ita == end)
1722                                 require(alternatives.front());
1723                         features_.erase(it);
1724                         it = features_.begin();
1725                 } else
1726                         ++it;
1727         }
1728 }
1729
1730
1731 } // namespace lyx