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