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 "Color.h"
  20 #include "BufferParams.h"
  21 #include "Encoding.h"
  22 #include "Floating.h"
  23 #include "FloatList.h"
  24 #include "Language.h"
  25 #include "Layout.h"
  26 #include "Lexer.h"
  27 #include "LyXRC.h"
  28 #include "TextClass.h"
  29
  30 #include "support/debug.h"
  31 #include "support/docstream.h"
  32 #include "support/FileName.h"
  33 #include "support/filetools.h"
  34 #include "support/lstrings.h"
  35
  36 using namespace std;
  37 using namespace lyx::support;
  38
  39
  40 namespace lyx {
  41
  42 /////////////////////////////////////////////////////////////////////
  43 //
  44 // Strings
  45 //
  46 /////////////////////////////////////////////////////////////////////
  47
  48 //\NeedsTeXFormat{LaTeX2e}
  49 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
  50 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
  51
  52 static string const lyx_def =
  53         "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}";
  54
  55 static string const lyxline_def =
  56         "\\newcommand{\\lyxline}[1][1pt]{%\n"
  57         "  \\par\\noindent%\n"
  58         "  \\rule[.5ex]{\\linewidth}{#1}\\par}";
  59
  60 static string const noun_def = "\\newcommand{\\noun}[1]{\\textsc{#1}}";
  61
  62 static string const lyxarrow_def =
  63         "\\newcommand{\\lyxarrow}{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}";
  64
  65 // for quotes without babel. This does not give perfect results, but
  66 // anybody serious about non-english quotes should use babel (JMarc).
  67
  68 static string const quotedblbase_def =
  69         "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
  70         "  \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
  71         "  \\penalty10000\\hskip0em\\relax%\n"
  72         "}";
  73
  74 static string const quotesinglbase_def =
  75         "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
  76         "  \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
  77         "  \\penalty10000\\hskip0em\\relax%\n"
  78         "}";
  79
  80 static string const guillemotleft_def =
  81         "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
  82         "  {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
  83         "\\penalty10000\\hskip0pt\\relax%\n"
  84         "}";
  85
  86 static string const guillemotright_def =
  87         "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
  88         "  \\penalty10000\\hskip0pt%\n"
  89         "  {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
  90         "}";
  91
  92 static string const guilsinglleft_def =
  93         "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
  94         "  {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
  95         "  \\penalty10000\\hskip0pt\\relax%\n"
  96         "}";
  97
  98 static string const guilsinglright_def =
  99         "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
 100         "  \\penalty10000\\hskip0pt%\n"
 101         "  {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
 102         "}";
 103
 104 static string const paragraphleftindent_def =
 105         "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
 106         "{\n"
 107         "  \\begin{list}{}{%\n"
 108         "    \\setlength{\\topsep}{0pt}%\n"
 109         "    \\addtolength{\\leftmargin}{#1}\n"
 110 // ho hum, yet more things commented out with no hint as to why they
 111 // weren't just removed
 112 //      "%%    \\addtolength{\\leftmargin}{#1\\textwidth}\n"
 113 //      "%%    \\setlength{\\textwidth}{#2\\textwidth}\n"
 114 //      "%%    \\setlength\\listparindent\\parindent%\n"
 115 //      "%%    \\setlength\\itemindent\\parindent%\n"
 116         "    \\setlength{\\parsep}{0pt plus 1pt}%\n"
 117         "  }\n"
 118         "  \\item[]\n"
 119         "}\n"
 120         "{\\end{list}}\n";
 121
 122 static string const floatingfootnote_def =
 123         "%% Special footnote code from the package 'stblftnt.sty'\n"
 124         "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
 125         "\\let\\SF@@footnote\\footnote\n"
 126         "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
 127         "    \\expandafter\\SF@@footnote\n"
 128         "  \\else\n"
 129         "    \\expandafter\\SF@gobble@opt\n"
 130         "  \\fi\n"
 131         "}\n"
 132         "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
 133         "  \\SF@gobble@twobracket\n"
 134         "  \\@gobble\n"
 135         "}\n"
 136         "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
 137         "  \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
 138         "\\def\\SF@gobble@twobracket[#1]#2{}\n";
 139
 140 static string const binom_def =
 141         "%% Binom macro for standard LaTeX users\n"
 142         "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n";
 143
 144 static string const mathcircumflex_def =
 145         "%% For printing a cirumflex inside a formula\n"
 146         "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n";
 147
 148 static string const tabularnewline_def =
 149         "%% Because html converters don't know tabularnewline\n"
 150         "\\providecommand{\\tabularnewline}{\\\\}\n";
 151
 152 static string const lyxgreyedout_def =
 153         "%% The greyedout annotation environment\n"
 154         "\\newenvironment{lyxgreyedout}{\\textcolor[gray]{0.8}\\bgroup}{\\egroup}\n";
 155
 156 // We want to omit the file extension for includegraphics, but this does not
 157 // work when the filename contains other dots.
 158 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
 159 static string const lyxdot_def =
 160         "%% A simple dot to overcome graphicx limitations\n"
 161         "\\newcommand{\\lyxdot}{.}\n";
 162
 163 static string const changetracking_dvipost_def =
 164         "%% Change tracking with dvipost\n"
 165         "\\dvipostlayout\n"
 166         "\\dvipost{osstart color push Red}\n"
 167         "\\dvipost{osend color pop}\n"
 168         "\\dvipost{cbstart color push Blue}\n"
 169         "\\dvipost{cbend color pop}\n"
 170         "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
 171         "\\newcommand{\\lyxdeleted}[3]{%\n"
 172         "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n";
 173
 174 static string const changetracking_xcolor_soul_def =
 175         "%% Change tracking with soul\n"
 176         "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
 177         "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\st{#3}}}\n";
 178
 179 static string const changetracking_xcolor_soul_hyperref_def =
 180         "%% Change tracking with soul\n"
 181         "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}}{}#3}}\n"
 182         "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\st{#3}}{}}}\n";
 183
 184 static string const changetracking_none_def =
 185         "\\newcommand{\\lyxadded}[3]{#3}\n"
 186         "\\newcommand{\\lyxdeleted}[3]{}\n";
 187
 188 static string const textgreek_def =
 189         "\\DeclareRobustCommand{\\greektext}{%\n"
 190         "  \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
 191         "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
 192         "\\DeclareFontEncoding{LGR}{}{}\n";
 193
 194 static string const textcyr_def =
 195         "\\DeclareRobustCommand{\\cyrtext}{%\n"
 196         "  \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
 197         "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
 198         "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n";
 199
 200 static string const lyxmathsym_def =
 201         "\\DeclareRobustCommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
 202         "  \\def\\rmorbf##1{\\ifx\\math@version\\b@ld\\textbf{##1}\\else\\textrm{##1}\\fi}\n"
 203         "  \\mathchoice{\\hbox{\\rmorbf{#1}}}{\\hbox{\\rmorbf{#1}}}\n"
 204         "  {\\hbox{\\smaller[2]\\rmorbf{#1}}}{\\hbox{\\smaller[3]\\rmorbf{#1}}}\n"
 205         "  \\endgroup\\else#1\\fi}\n";
 206
 207 static string const papersizedvi_def =
 208         "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n";
 209
 210 static string const papersizepdf_def =
 211         "\\pdfpageheight\\paperheight\n"
 212         "\\pdfpagewidth\\paperwidth\n";
 213
 214 static string const cedilla_def =
 215         "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
 216         "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n";
 217
 218 static string const subring_def =
 219         "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
 220         "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n";
 221
 222 static string const subdot_def =
 223         "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
 224         "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n";
 225
 226 static string const subhat_def =
 227         "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
 228         "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n";
 229
 230 static string const subtilde_def =
 231         "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
 232         "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n";
 233
 234 static string const dacute_def =
 235         "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n";
 236
 237 static string const tipasymb_def =
 238         "\\DeclareFontEncoding{T3}{}{}\n"
 239         "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n";
 240
 241 static string const dgrave_def =
 242         "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n";
 243
 244 static string const rcap_def =
 245         "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n";
 246
 247 static string const ogonek_def =
 248         "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
 249         "  \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
 250         "  \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
 251         "  \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
 252         "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n";
 253
 254 /////////////////////////////////////////////////////////////////////
 255 //
 256 // LaTeXFeatures
 257 //
 258 /////////////////////////////////////////////////////////////////////
 259
 260 LaTeXFeatures::Packages LaTeXFeatures::packages_;
 261
 262
 263 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
 264                              OutputParams const & r)
 265         : buffer_(&b), params_(p), runparams_(r)
 266 {}
 267
 268
 269 bool LaTeXFeatures::useBabel() const
 270 {
 271         return lyxrc.language_use_babel ||
 272                 (bufferParams().language->lang() != lyxrc.default_language &&
 273                  !bufferParams().language->babel().empty()) ||
 274                 this->hasLanguages();
 275 }
 276
 277
 278 void LaTeXFeatures::require(string const & name)
 279 {
 280         features_.insert(name);
 281 }
 282
 283
 284 void LaTeXFeatures::require(set<string> const & names)
 285 {
 286         features_.insert(names.begin(), names.end());
 287 }
 288
 289
 290 void LaTeXFeatures::getAvailable()
 291 {
 292         Lexer lex;
 293         support::FileName const real_file = libFileSearch("", "packages.lst");
 294
 295         if (real_file.empty())
 296                 return;
 297
 298         lex.setFile(real_file);
 299
 300         if (!lex.isOK())
 301                 return;
 302
 303         // Make sure that we are clean
 304         packages_.clear();
 305
 306         bool finished = false;
 307         // Parse config-file
 308         while (lex.isOK() && !finished) {
 309                 switch (lex.lex()) {
 310                 case Lexer::LEX_FEOF:
 311                         finished = true;
 312                         break;
 313                 default:
 314                         packages_.insert(lex.getString());
 315                 }
 316         }
 317 }
 318
 319
 320 void LaTeXFeatures::useLayout(docstring const & layoutname)
 321 {
 322         // Some code to avoid loops in dependency definition
 323         static int level = 0;
 324         const int maxlevel = 30;
 325         if (level > maxlevel) {
 326                 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
 327                        << "recursion attained by layout "
 328                        << to_utf8(layoutname) << endl;
 329                 return;
 330         }
 331
 332         DocumentClass const & tclass = params_.documentClass();
 333         if (tclass.hasLayout(layoutname)) {
 334                 // Is this layout already in usedLayouts?
 335                 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
 336                     != usedLayouts_.end())
 337                         return;
 338
 339                 Layout const & layout = tclass[layoutname];
 340                 require(layout.requires());
 341
 342                 if (!layout.depends_on().empty()) {
 343                         ++level;
 344                         useLayout(layout.depends_on());
 345                         --level;
 346                 }
 347                 usedLayouts_.push_back(layoutname);
 348         } else {
 349                 lyxerr << "LaTeXFeatures::useLayout: layout `"
 350                        << to_utf8(layoutname) << "' does not exist in this class"
 351                        << endl;
 352         }
 353
 354         --level;
 355 }
 356
 357
 358 bool LaTeXFeatures::isRequired(string const & name) const
 359 {
 360         return features_.find(name) != features_.end();
 361 }
 362
 363
 364 bool LaTeXFeatures::mustProvide(string const & name) const
 365 {
 366         return isRequired(name) && !params_.documentClass().provides(name);
 367 }
 368
 369
 370 bool LaTeXFeatures::isAvailable(string const & name)
 371 {
 372         if (packages_.empty())
 373                 getAvailable();
 374         string n = name;
 375         if (suffixIs(n, ".sty"))
 376                 n.erase(name.length() - 4);
 377         return packages_.find(n) != packages_.end();
 378 }
 379
 380
 381 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
 382 {
 383         SnippetList::const_iterator begin = preamble_snippets_.begin();
 384         SnippetList::const_iterator end   = preamble_snippets_.end();
 385         if (find(begin, end, preamble) == end)
 386                 preamble_snippets_.push_back(preamble);
 387 }
 388
 389
 390 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
 391 {
 392         if (!usedFloats_[name])
 393                 usedFloats_[name] = subfloat;
 394         if (subfloat)
 395                 require("subfig");
 396         // We only need float.sty if we use non builtin floats, or if we
 397         // use the "H" modifier. This includes modified table and
 398         // figure floats. (Lgb)
 399         Floating const & fl = params_.documentClass().floats().getType(name);
 400         if (!fl.type().empty() && !fl.builtin()) {
 401                 require("float");
 402         }
 403 }
 404
 405
 406 void LaTeXFeatures::useLanguage(Language const * lang)
 407 {
 408         if (!lang->babel().empty())
 409                 UsedLanguages_.insert(lang);
 410         if (lang->lang() == "vietnamese")
 411                 require("vietnamese");
 412         // CJK languages do not have a babel name.
 413         // They use the CJK package
 414         if (lang->encoding()->package() == Encoding::CJK)
 415                 require("CJK");
 416         // japanese package is special
 417         if (lang->encoding()->package() == Encoding::japanese)
 418                 require("japanese");
 419 }
 420
 421
 422 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
 423 {
 424         IncludedFiles_[key] = name;
 425 }
 426
 427
 428 bool LaTeXFeatures::hasLanguages() const
 429 {
 430         return !UsedLanguages_.empty();
 431 }
 432
 433
 434 string LaTeXFeatures::getLanguages() const
 435 {
 436         ostringstream languages;
 437
 438         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 439         for (LanguageList::const_iterator cit = begin;
 440              cit != UsedLanguages_.end();
 441              ++cit) {
 442                 if (cit != begin)
 443                         languages << ',';
 444                 languages << (*cit)->babel();
 445         }
 446         return languages.str();
 447 }
 448
 449
 450 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 451 {
 452         // This does only find encodings of languages supported by babel, but
 453         // that does not matter since we don't have a language with an
 454         // encoding supported by inputenc but without babel support.
 455         set<string> encodings;
 456         LanguageList::const_iterator it  = UsedLanguages_.begin();
 457         LanguageList::const_iterator end = UsedLanguages_.end();
 458         for (; it != end; ++it)
 459                 if ((*it)->encoding()->latexName() != doc_encoding &&
 460                     ((*it)->encoding()->package() == Encoding::inputenc
 461                      || (*it)->encoding()->package() == Encoding::japanese))
 462                         encodings.insert((*it)->encoding()->latexName());
 463         return encodings;
 464 }
 465
 466 namespace {
 467
 468 char const * simplefeatures[] = {
 469 // note that the package order here will be the same in the LaTeX-output
 470         "array",
 471         "verbatim",
 472         "longtable",
 473         "rotating",
 474         "latexsym",
 475         "pifont",
 476         // subfig is handled in BufferParams.cpp
 477         "varioref",
 478         "prettyref",
 479         /*For a successful cooperation of the `wrapfig' package with the
 480           `float' package you should load the `wrapfig' package *after*
 481           the `float' package. See the caption package documentation
 482           for explanation.*/
 483         "float",
 484         "rotfloat",
 485         "wrapfig",
 486         "booktabs",
 487         "dvipost",
 488         "fancybox",
 489         "calc",
 490         "units",
 491         "tipa",
 492         "tipx",
 493         "framed",
 494         "soul",
 495         "textcomp",
 496         "pmboxdraw",
 497         "bbding",
 498         "ifsym",
 499         "marvosym",
 500         "txfonts",
 501         "mathrsfs",
 502         "ascii",
 503         "url",
 504         "covington",
 505         "csquotes",
 506         "enumitem",
 507         "endnotes",
 508         "ifthen",
 509         "amsthm",
 510         // listings is handled in BufferParams.cpp
 511         "bm",
 512         "pdfpages",
 513         "relsize",
 514         "amscd",
 515         "slashed"
 516 };
 517
 518 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 519
 520 }
 521
 522
 523 string const LaTeXFeatures::getPackages() const
 524 {
 525         ostringstream packages;
 526         DocumentClass const & tclass = params_.documentClass();
 527
 528         // FIXME: currently, we can only load packages and macros known
 529         // to LyX.
 530         // However, with the Require tag of layouts/custom insets,
 531         // also inknown packages can be requested. They are silently
 532         // swallowed now. We should change this eventually.
 533
 534         //
 535         //  These are all the 'simple' includes.  i.e
 536         //  packages which we just \usepackage{package}
 537         //
 538         for (int i = 0; i < nb_simplefeatures; ++i) {
 539                 if (mustProvide(simplefeatures[i]))
 540                         packages << "\\usepackage{"
 541                                  << simplefeatures[i] << "}\n";
 542         }
 543
 544         //
 545         // The rest of these packages are somewhat more complicated
 546         // than those above.
 547         //
 548
 549         // esint is preferred for esintoramsmath
 550         if ((mustProvide("amsmath") &&
 551              params_.use_amsmath != BufferParams::package_off) ||
 552             (mustProvide("esintoramsmath") &&
 553              params_.use_esint == BufferParams::package_off)) {
 554                 packages << "\\usepackage{amsmath}\n";
 555         } else if (mustProvide("amsbsy")) {
 556                 // amsbsy is already provided by amsmath
 557                 packages << "\\usepackage{amsbsy}\n";
 558         }
 559
 560         // wasysym is a simple feature, but it must be after amsmath if both
 561         // are used
 562         // wasysym redefines some integrals (e.g. iint) from amsmath. That
 563         // leads to inconsistent integrals. We only load this package if
 564         // the document does not contain integrals (then isRequired("esint")
 565         // is false) or if esint is used, since esint redefines all relevant
 566         // integral symbols from wasysym and amsmath.
 567         // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
 568         if (mustProvide("wasysym") &&
 569             (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
 570                 packages << "\\usepackage{wasysym}\n";
 571
 572         // accents must be loaded after amsmath
 573         if (mustProvide("accents"))
 574                 packages << "\\usepackage{accents}\n";
 575
 576         // [x]color.sty
 577         if (mustProvide("color") || mustProvide("xcolor")) {
 578                 string const package =
 579                         (mustProvide("xcolor") ? "xcolor" : "color");
 580                 if (params_.graphicsDriver == "default")
 581                         packages << "\\usepackage{" << package << "}\n";
 582                 else
 583                         packages << "\\usepackage["
 584                                  << params_.graphicsDriver
 585                                  << "]{" << package << "}\n";
 586         }
 587
 588         // pdfcolmk must be loaded after color
 589         if (mustProvide("pdfcolmk"))
 590                 packages << "\\usepackage{pdfcolmk}\n";
 591
 592         // makeidx.sty
 593         if (isRequired("makeidx")) {
 594                 if (!tclass.provides("makeidx"))
 595                         packages << "\\usepackage{makeidx}\n";
 596                 packages << "\\makeindex\n";
 597         }
 598
 599         // graphicx.sty
 600         if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
 601                 if (params_.graphicsDriver == "default")
 602                         packages << "\\usepackage{graphicx}\n";
 603                 else
 604                         packages << "\\usepackage["
 605                                  << params_.graphicsDriver
 606                                  << "]{graphicx}\n";
 607         }
 608         // shadecolor for shaded
 609         if (isRequired("framed") && mustProvide("color")) {
 610                 RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
 611                 //255.0 to force conversion to double
 612                 //NOTE As Jürgen Spitzmüller pointed out, an alternative would be
 613                 //to use the xcolor package instead, and then we can do
 614                 // \define{shadcolor}{RGB}...
 615                 //and not do any conversion. We'd then need to require xcolor
 616                 //in InsetNote::validate().
 617                 int const stmSize = packages.precision(2);
 618                 packages << "\\definecolor{shadecolor}{rgb}{"
 619                         << c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
 620                 packages.precision(stmSize);
 621         }
 622
 623         // lyxskak.sty --- newer chess support based on skak.sty
 624         if (mustProvide("chess"))
 625                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
 626
 627         // setspace.sty
 628         if (mustProvide("setspace") && !tclass.provides("SetSpace"))
 629                 packages << "\\usepackage{setspace}\n";
 630
 631         // amssymb.sty
 632         if (mustProvide("amssymb")
 633             || params_.use_amsmath == BufferParams::package_on)
 634                 packages << "\\usepackage{amssymb}\n";
 635
 636         // esint must be after amsmath and wasysym, since it will redeclare
 637         // inconsistent integral symbols
 638         if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
 639             params_.use_esint != BufferParams::package_off)
 640                 packages << "\\usepackage{esint}\n";
 641
 642         // natbib.sty
 643         // Some classes load natbib themselves, but still allow (or even require)
 644         // plain numeric citations (ReVTeX is such a case, see bug 5182).
 645         // This special case is indicated by the "natbib-internal" key.
 646         if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
 647                 packages << "\\usepackage[";
 648                 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
 649                         packages << "numbers";
 650                 else
 651                         packages << "authoryear";
 652                 packages << "]{natbib}\n";
 653         }
 654
 655         // jurabib -- we need version 0.6 at least.
 656         if (mustProvide("jurabib"))
 657                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
 658
 659         // xargs -- we need version 1.09 at least
 660         if (mustProvide("xargs"))
 661                 packages << "\\usepackage{xargs}[2008/03/08]\n";
 662
 663         // bibtopic -- the dot provides the aux file naming which
 664         // LyX can detect.
 665         if (mustProvide("bibtopic"))
 666                 packages << "\\usepackage[dot]{bibtopic}\n";
 667
 668         if (mustProvide("xy"))
 669                 packages << "\\usepackage[all]{xy}\n";
 670
 671         if (mustProvide("nomencl")) {
 672                 // Make it work with the new and old version of the package,
 673                 // but don't use the compatibility option since it is
 674                 // incompatible to other packages.
 675                 packages << "\\usepackage{nomencl}\n"
 676                             "% the following is useful when we have the old nomencl.sty package\n"
 677                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
 678                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
 679                             "\\makenomenclature\n";
 680         }
 681
 682         return packages.str();
 683 }
 684
 685
 686 string const LaTeXFeatures::getMacros() const
 687 {
 688         ostringstream macros;
 689
 690         if (!preamble_snippets_.empty())
 691                 macros << '\n';
 692         SnippetList::const_iterator pit  = preamble_snippets_.begin();
 693         SnippetList::const_iterator pend = preamble_snippets_.end();
 694         for (; pit != pend; ++pit)
 695                 macros << *pit << '\n';
 696
 697         if (mustProvide("papersize"))
 698                 if (runparams_.flavor == OutputParams::LATEX)
 699                         macros << papersizedvi_def << '\n';
 700                 else
 701                         macros << papersizepdf_def << '\n';
 702
 703         if (mustProvide("LyX"))
 704                 macros << lyx_def << '\n';
 705
 706         if (mustProvide("lyxline"))
 707                 macros << lyxline_def << '\n';
 708
 709         if (mustProvide("noun"))
 710                 macros << noun_def << '\n';
 711
 712         if (mustProvide("lyxarrow"))
 713                 macros << lyxarrow_def << '\n';
 714
 715         if (mustProvide("textgreek"))
 716                 macros << textgreek_def << '\n';
 717
 718         if (mustProvide("textcyr"))
 719                 macros << textcyr_def << '\n';
 720
 721         if (mustProvide("lyxmathsym"))
 722                 macros << lyxmathsym_def << '\n';
 723
 724         if (mustProvide("cedilla"))
 725                 macros << cedilla_def << '\n';
 726
 727         if (mustProvide("subring"))
 728                 macros << subring_def << '\n';
 729
 730         if (mustProvide("subdot"))
 731                 macros << subdot_def << '\n';
 732
 733         if (mustProvide("subhat"))
 734                 macros << subhat_def << '\n';
 735
 736         if (mustProvide("subtilde"))
 737                 macros << subtilde_def << '\n';
 738
 739         if (mustProvide("dacute"))
 740                 macros << dacute_def << '\n';
 741
 742         if (mustProvide("tipasymb"))
 743                 macros << tipasymb_def << '\n';
 744
 745         if (mustProvide("dgrave"))
 746                 macros << dgrave_def << '\n';
 747
 748         if (mustProvide("rcap"))
 749                 macros << rcap_def << '\n';
 750
 751         if (mustProvide("ogonek"))
 752                 macros << ogonek_def << '\n';
 753
 754         // quotes.
 755         if (mustProvide("quotesinglbase"))
 756                 macros << quotesinglbase_def << '\n';
 757         if (mustProvide("quotedblbase"))
 758                 macros << quotedblbase_def << '\n';
 759         if (mustProvide("guilsinglleft"))
 760                 macros << guilsinglleft_def << '\n';
 761         if (mustProvide("guilsinglright"))
 762                 macros << guilsinglright_def << '\n';
 763         if (mustProvide("guillemotleft"))
 764                 macros << guillemotleft_def << '\n';
 765         if (mustProvide("guillemotright"))
 766                 macros << guillemotright_def << '\n';
 767
 768         // Math mode
 769         if (mustProvide("binom") && !isRequired("amsmath"))
 770                 macros << binom_def << '\n';
 771         if (mustProvide("mathcircumflex"))
 772                 macros << mathcircumflex_def << '\n';
 773
 774         // other
 775         if (mustProvide("ParagraphLeftIndent"))
 776                 macros << paragraphleftindent_def;
 777         if (mustProvide("NeedLyXFootnoteCode"))
 778                 macros << floatingfootnote_def;
 779
 780         // some problems with tex->html converters
 781         if (mustProvide("NeedTabularnewline"))
 782                 macros << tabularnewline_def;
 783
 784         // greyedout environment (note inset)
 785         if (mustProvide("lyxgreyedout"))
 786                 macros << lyxgreyedout_def;
 787
 788         if (mustProvide("lyxdot"))
 789                 macros << lyxdot_def << '\n';
 790
 791         // floats
 792         getFloatDefinitions(macros);
 793
 794         // change tracking
 795         if (mustProvide("ct-dvipost"))
 796                 macros << changetracking_dvipost_def;
 797
 798         if (mustProvide("ct-xcolor-soul")) {
 799                 int const prec = macros.precision(2);
 800
 801                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
 802                 macros << "\\providecolor{lyxadded}{rgb}{"
 803                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
 804
 805                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
 806                 macros << "\\providecolor{lyxdeleted}{rgb}{"
 807                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
 808
 809                 macros.precision(prec);
 810
 811                 if (isRequired("hyperref"))
 812                         macros << changetracking_xcolor_soul_hyperref_def;
 813                 else
 814                         macros << changetracking_xcolor_soul_def;
 815         }
 816
 817         if (mustProvide("ct-none"))
 818                 macros << changetracking_none_def;
 819
 820         return macros.str();
 821 }
 822
 823
 824 string const LaTeXFeatures::getBabelOptions() const
 825 {
 826         ostringstream tmp;
 827
 828         LanguageList::const_iterator it  = UsedLanguages_.begin();
 829         LanguageList::const_iterator end =  UsedLanguages_.end();
 830         for (; it != end; ++it)
 831                 if (!(*it)->latex_options().empty())
 832                         tmp << (*it)->latex_options() << '\n';
 833         if (!params_.language->latex_options().empty())
 834                 tmp << params_.language->latex_options() << '\n';
 835
 836         return tmp.str();
 837 }
 838
 839
 840 docstring const LaTeXFeatures::getTClassPreamble() const
 841 {
 842         // the text class specific preamble
 843         DocumentClass const & tclass = params_.documentClass();
 844         odocstringstream tcpreamble;
 845
 846         tcpreamble << tclass.preamble();
 847
 848         list<docstring>::const_iterator cit = usedLayouts_.begin();
 849         list<docstring>::const_iterator end = usedLayouts_.end();
 850         for (; cit != end; ++cit) {
 851                 tcpreamble << tclass[*cit].preamble();
 852         }
 853
 854         return tcpreamble.str();
 855 }
 856
 857
 858 docstring const LaTeXFeatures::getLyXSGMLEntities() const
 859 {
 860         // Definition of entities used in the document that are LyX related.
 861         odocstringstream entities;
 862
 863         if (mustProvide("lyxarrow")) {
 864                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
 865         }
 866
 867         return entities.str();
 868 }
 869
 870
 871 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
 872 {
 873         odocstringstream sgmlpreamble;
 874         // FIXME UNICODE
 875         docstring const basename(from_utf8(onlyPath(fname)));
 876
 877         FileMap::const_iterator end = IncludedFiles_.end();
 878         for (FileMap::const_iterator fi = IncludedFiles_.begin();
 879              fi != end; ++fi)
 880                 // FIXME UNICODE
 881                 sgmlpreamble << "\n<!ENTITY " << fi->first
 882                              << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
 883                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
 884
 885         return sgmlpreamble.str();
 886 }
 887
 888
 889 void LaTeXFeatures::showStruct() const
 890 {
 891         lyxerr << "LyX needs the following commands when LaTeXing:"
 892                << "\n***** Packages:" << getPackages()
 893                << "\n***** Macros:" << getMacros()
 894                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
 895                << "\n***** done." << endl;
 896 }
 897
 898
 899 Buffer const & LaTeXFeatures::buffer() const
 900 {
 901         return *buffer_;
 902 }
 903
 904
 905 void LaTeXFeatures::setBuffer(Buffer const & buffer)
 906 {
 907         buffer_ = &buffer;
 908 }
 909
 910
 911 BufferParams const & LaTeXFeatures::bufferParams() const
 912 {
 913         return params_;
 914 }
 915
 916
 917 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
 918 {
 919         FloatList const & floats = params_.documentClass().floats();
 920
 921         // Here we will output the code to create the needed float styles.
 922         // We will try to do this as minimal as possible.
 923         // \floatstyle{ruled}
 924         // \newfloat{algorithm}{htbp}{loa}
 925         // \floatname{algorithm}{Algorithm}
 926         UsedFloats::const_iterator cit = usedFloats_.begin();
 927         UsedFloats::const_iterator end = usedFloats_.end();
 928         // ostringstream floats;
 929         for (; cit != end; ++cit) {
 930                 Floating const & fl = floats.getType((cit->first));
 931
 932                 // For builtin floats we do nothing.
 933                 if (fl.builtin()) continue;
 934
 935                 // We have to special case "table" and "figure"
 936                 if (fl.type() == "tabular" || fl.type() == "figure") {
 937                         // Output code to modify "table" or "figure"
 938                         // but only if builtin == false
 939                         // and that have to be true at this point in the
 940                         // function.
 941                         string const type = fl.type();
 942                         string const placement = fl.placement();
 943                         string const style = fl.style();
 944                         if (!style.empty()) {
 945                                 os << "\\floatstyle{" << style << "}\n"
 946                                    << "\\restylefloat{" << type << "}\n";
 947                         }
 948                         if (!placement.empty()) {
 949                                 os << "\\floatplacement{" << type << "}{"
 950                                    << placement << "}\n";
 951                         }
 952                 } else {
 953                         // The other non builtin floats.
 954
 955                         string const type = fl.type();
 956                         string const placement = fl.placement();
 957                         string const ext = fl.ext();
 958                         string const within = fl.within();
 959                         string const style = fl.style();
 960                         string const name = fl.name();
 961                         os << "\\floatstyle{" << style << "}\n"
 962                            << "\\newfloat{" << type << "}{" << placement
 963                            << "}{" << ext << '}';
 964                         if (!within.empty())
 965                                 os << '[' << within << ']';
 966                         os << '\n'
 967                            << "\\floatname{" << type << "}{"
 968                            << name << "}\n";
 969
 970                         // What missing here is to code to minimalize the code
 971                         // output so that the same floatstyle will not be
 972                         // used several times, when the same style is still in
 973                         // effect. (Lgb)
 974                 }
 975                 if (cit->second)
 976                         os << "\n\\newsubfloat{" << fl.type() << "}\n";
 977         }
 978 }
 979
 980
 981 } // namespace lyx