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