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