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