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\n"
 191         " \\def\\encodingdefault{LGR}}\n"
 192         "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
 193         "\\DeclareFontEncoding{LGR}{}{}\n";
 194
 195 static string const textcyr_def =
 196         "\\DeclareRobustCommand{\\cyrtext}{%\n"
 197         " \\fontencoding{T2A}\\selectfont\n"
 198         " \\def\\encodingdefault{T2A}}\n"
 199         "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
 200         "\\DeclareFontEncoding{T2A}{}{}\n";
 201
 202 static string const lyxmathsym_def =
 203         "\\DeclareRobustCommand{\\lyxmathsym}[1]{%\n"
 204         " \\ifmmode\\begingroup\n"
 205         " \\edef\\b@ld{bold}%\n"
 206         " \\def\\rmorbf##1{\\ifx\\math@version\\b@ld\\textbf{##1}\\else\\textrm{##1}\\fi}%\n"
 207         " \\mathchoice{\\hbox{\\rmorbf{#1}}}{\\hbox{\\rmorbf{#1}}}%\n"
 208         "  {\\hbox{\\smaller[2]\\rmorbf{#1}}}{\\hbox{\\smaller[3]\\rmorbf{#1}}}%\n"
 209         " \\endgroup\\else#1\\fi}\n";
 210
 211 static string const papersizedvi_def =
 212         "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n";
 213
 214 static string const papersizepdf_def =
 215         "\\pdfpageheight\\paperheight\n"
 216         "\\pdfpagewidth\\paperwidth\n";
 217
 218 /////////////////////////////////////////////////////////////////////
 219 //
 220 // LaTeXFeatures
 221 //
 222 /////////////////////////////////////////////////////////////////////
 223
 224 LaTeXFeatures::Packages LaTeXFeatures::packages_;
 225
 226
 227 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
 228                              OutputParams const & r)
 229         : buffer_(&b), params_(p), runparams_(r)
 230 {}
 231
 232
 233 bool LaTeXFeatures::useBabel() const
 234 {
 235         return lyxrc.language_use_babel ||
 236                 (bufferParams().language->lang() != lyxrc.default_language &&
 237                  !bufferParams().language->babel().empty()) ||
 238                 this->hasLanguages();
 239 }
 240
 241
 242 void LaTeXFeatures::require(string const & name)
 243 {
 244         features_.insert(name);
 245 }
 246
 247
 248 void LaTeXFeatures::require(set<string> const & names)
 249 {
 250         features_.insert(names.begin(), names.end());
 251 }
 252
 253
 254 void LaTeXFeatures::getAvailable()
 255 {
 256         Lexer lex;
 257         support::FileName const real_file = libFileSearch("", "packages.lst");
 258
 259         if (real_file.empty())
 260                 return;
 261
 262         lex.setFile(real_file);
 263
 264         if (!lex.isOK())
 265                 return;
 266
 267         // Make sure that we are clean
 268         packages_.clear();
 269
 270         bool finished = false;
 271         // Parse config-file
 272         while (lex.isOK() && !finished) {
 273                 switch (lex.lex()) {
 274                 case Lexer::LEX_FEOF:
 275                         finished = true;
 276                         break;
 277                 default:
 278                         packages_.insert(lex.getString());
 279                 }
 280         }
 281 }
 282
 283
 284 void LaTeXFeatures::useLayout(docstring const & layoutname)
 285 {
 286         // Some code to avoid loops in dependency definition
 287         static int level = 0;
 288         const int maxlevel = 30;
 289         if (level > maxlevel) {
 290                 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
 291                        << "recursion attained by layout "
 292                        << to_utf8(layoutname) << endl;
 293                 return;
 294         }
 295
 296         DocumentClass const & tclass = params_.documentClass();
 297         if (tclass.hasLayout(layoutname)) {
 298                 // Is this layout already in usedLayouts?
 299                 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
 300                     != usedLayouts_.end())
 301                         return;
 302
 303                 Layout const & layout = tclass[layoutname];
 304                 require(layout.requires());
 305
 306                 if (!layout.depends_on().empty()) {
 307                         ++level;
 308                         useLayout(layout.depends_on());
 309                         --level;
 310                 }
 311                 usedLayouts_.push_back(layoutname);
 312         } else {
 313                 lyxerr << "LaTeXFeatures::useLayout: layout `"
 314                        << to_utf8(layoutname) << "' does not exist in this class"
 315                        << endl;
 316         }
 317
 318         --level;
 319 }
 320
 321
 322 bool LaTeXFeatures::isRequired(string const & name) const
 323 {
 324         return features_.find(name) != features_.end();
 325 }
 326
 327
 328 bool LaTeXFeatures::mustProvide(string const & name) const
 329 {
 330         return isRequired(name) && !params_.documentClass().provides(name);
 331 }
 332
 333
 334 bool LaTeXFeatures::isAvailable(string const & name)
 335 {
 336         if (packages_.empty())
 337                 getAvailable();
 338         string n = name;
 339         if (suffixIs(n, ".sty"))
 340                 n.erase(name.length() - 4);
 341         return packages_.find(n) != packages_.end();
 342 }
 343
 344
 345 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
 346 {
 347         SnippetList::const_iterator begin = preamble_snippets_.begin();
 348         SnippetList::const_iterator end   = preamble_snippets_.end();
 349         if (find(begin, end, preamble) == end)
 350                 preamble_snippets_.push_back(preamble);
 351 }
 352
 353
 354 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
 355 {
 356         if (!usedFloats_[name])
 357                 usedFloats_[name] = subfloat;
 358         if (subfloat)
 359                 require("subfig");
 360         // We only need float.sty if we use non builtin floats, or if we
 361         // use the "H" modifier. This includes modified table and
 362         // figure floats. (Lgb)
 363         Floating const & fl = params_.documentClass().floats().getType(name);
 364         if (!fl.type().empty() && !fl.builtin()) {
 365                 require("float");
 366         }
 367 }
 368
 369
 370 void LaTeXFeatures::useLanguage(Language const * lang)
 371 {
 372         if (!lang->babel().empty())
 373                 UsedLanguages_.insert(lang);
 374         if (lang->lang() == "vietnamese")
 375                 require("vietnamese");
 376         // CJK languages do not have a babel name.
 377         // They use the CJK package
 378         if (lang->encoding()->package() == Encoding::CJK)
 379                 require("CJK");
 380         // japanese package is special
 381         if (lang->encoding()->package() == Encoding::japanese)
 382                 require("japanese");
 383 }
 384
 385
 386 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
 387 {
 388         IncludedFiles_[key] = name;
 389 }
 390
 391
 392 bool LaTeXFeatures::hasLanguages() const
 393 {
 394         return !UsedLanguages_.empty();
 395 }
 396
 397
 398 string LaTeXFeatures::getLanguages() const
 399 {
 400         ostringstream languages;
 401
 402         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 403         for (LanguageList::const_iterator cit = begin;
 404              cit != UsedLanguages_.end();
 405              ++cit) {
 406                 if (cit != begin)
 407                         languages << ',';
 408                 languages << (*cit)->babel();
 409         }
 410         return languages.str();
 411 }
 412
 413
 414 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 415 {
 416         // This does only find encodings of languages supported by babel, but
 417         // that does not matter since we don't have a language with an
 418         // encoding supported by inputenc but without babel support.
 419         set<string> encodings;
 420         LanguageList::const_iterator it  = UsedLanguages_.begin();
 421         LanguageList::const_iterator end = UsedLanguages_.end();
 422         for (; it != end; ++it)
 423                 if ((*it)->encoding()->latexName() != doc_encoding &&
 424                     ((*it)->encoding()->package() == Encoding::inputenc
 425                      || (*it)->encoding()->package() == Encoding::japanese))
 426                         encodings.insert((*it)->encoding()->latexName());
 427         return encodings;
 428 }
 429
 430 namespace {
 431
 432 char const * simplefeatures[] = {
 433 // note that the package order here will be the same in the LaTeX-output
 434         "array",
 435         "verbatim",
 436         "longtable",
 437         "rotating",
 438         "latexsym",
 439         "pifont",
 440         // subfig is handled in BufferParams.cpp
 441         "varioref",
 442         "prettyref",
 443         /*For a successful cooperation of the `wrapfig' package with the
 444           `float' package you should load the `wrapfig' package *after*
 445           the `float' package. See the caption package documentation
 446           for explanation.*/
 447         "float",
 448         "rotfloat",
 449         "wrapfig",
 450         "booktabs",
 451         "dvipost",
 452         "fancybox",
 453         "calc",
 454         "units",
 455         "tipa",
 456         "tipx",
 457         "framed",
 458         "soul",
 459         "textcomp",
 460         "pmboxdraw",
 461         "bbding",
 462         "ifsym",
 463         "marvosym",
 464         "txfonts",
 465         "mathrsfs",
 466         "ascii",
 467         "url",
 468         "covington",
 469         "csquotes",
 470         "enumitem",
 471         "endnotes",
 472         "ifthen",
 473         "amsthm",
 474         "listings",
 475         "bm",
 476         "pdfpages",
 477         "relsize",
 478         "amscd"
 479 };
 480
 481 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 482
 483 }
 484
 485
 486 string const LaTeXFeatures::getPackages() const
 487 {
 488         ostringstream packages;
 489         DocumentClass const & tclass = params_.documentClass();
 490
 491         // FIXME: currently, we can only load packages and macros known
 492         // to LyX.
 493         // However, with the Require tag of layouts/custom insets,
 494         // also inknown packages can be requested. They are silently
 495         // swallowed now. We should change this eventually.
 496
 497         //
 498         //  These are all the 'simple' includes.  i.e
 499         //  packages which we just \usepackage{package}
 500         //
 501         for (int i = 0; i < nb_simplefeatures; ++i) {
 502                 if (mustProvide(simplefeatures[i]))
 503                         packages << "\\usepackage{"
 504                                  << simplefeatures[i] << "}\n";
 505         }
 506
 507         //
 508         // The rest of these packages are somewhat more complicated
 509         // than those above.
 510         //
 511
 512         // esint is preferred for esintoramsmath
 513         if ((mustProvide("amsmath") &&
 514              params_.use_amsmath != BufferParams::package_off) ||
 515             (mustProvide("esintoramsmath") &&
 516              params_.use_esint == BufferParams::package_off)) {
 517                 packages << "\\usepackage{amsmath}\n";
 518         } else if (mustProvide("amsbsy")) {
 519                 // amsbsy is already provided by amsmath
 520                 packages << "\\usepackage{amsbsy}\n";
 521         }
 522
 523         // wasysym is a simple feature, but it must be after amsmath if both
 524         // are used
 525         // wasysym redefines some integrals (e.g. iint) from amsmath. That
 526         // leads to inconsistent integrals. We only load this package if
 527         // the document does not contain integrals (then isRequired("esint")
 528         // is false) or if esint is used, since esint redefines all relevant
 529         // integral symbols from wasysym and amsmath.
 530         // See http://bugzilla.lyx.org/show_bug.cgi?id=1942
 531         if (mustProvide("wasysym") &&
 532             (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
 533                 packages << "\\usepackage{wasysym}\n";
 534
 535         // [x]color.sty
 536         if (mustProvide("color") || mustProvide("xcolor")) {
 537                 string const package =
 538                         (mustProvide("xcolor") ? "xcolor" : "color");
 539                 if (params_.graphicsDriver == "default")
 540                         packages << "\\usepackage{" << package << "}\n";
 541                 else
 542                         packages << "\\usepackage["
 543                                  << params_.graphicsDriver
 544                                  << "]{" << package << "}\n";
 545         }
 546
 547         // pdfcolmk must be loaded after color
 548         if (mustProvide("pdfcolmk"))
 549                 packages << "\\usepackage{pdfcolmk}\n";
 550
 551         // makeidx.sty
 552         if (isRequired("makeidx")) {
 553                 if (!tclass.provides("makeidx"))
 554                         packages << "\\usepackage{makeidx}\n";
 555                 packages << "\\makeindex\n";
 556         }
 557
 558         // graphicx.sty
 559         if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
 560                 if (params_.graphicsDriver == "default")
 561                         packages << "\\usepackage{graphicx}\n";
 562                 else
 563                         packages << "\\usepackage["
 564                                  << params_.graphicsDriver
 565                                  << "]{graphicx}\n";
 566         }
 567         // shadecolor for shaded
 568         if (isRequired("framed") && mustProvide("color")) {
 569                 RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
 570                 //255.0 to force conversion to double
 571                 //NOTE As Jürgen Spitzmüller pointed out, an alternative would be
 572                 //to use the xcolor package instead, and then we can do
 573                 // \define{shadcolor}{RGB}...
 574                 //and not do any conversion. We'd then need to require xcolor
 575                 //in InsetNote::validate().
 576                 int const stmSize = packages.precision(2);
 577                 packages << "\\definecolor{shadecolor}{rgb}{"
 578                         << c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
 579                 packages.precision(stmSize);
 580         }
 581
 582         // lyxskak.sty --- newer chess support based on skak.sty
 583         if (mustProvide("chess"))
 584                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
 585
 586         // setspace.sty
 587         if (mustProvide("setspace") && !tclass.provides("SetSpace"))
 588                 packages << "\\usepackage{setspace}\n";
 589
 590         // amssymb.sty
 591         if (mustProvide("amssymb")
 592             || params_.use_amsmath == BufferParams::package_on)
 593                 packages << "\\usepackage{amssymb}\n";
 594
 595         // esint must be after amsmath and wasysym, since it will redeclare
 596         // inconsistent integral symbols
 597         if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
 598             params_.use_esint != BufferParams::package_off)
 599                 packages << "\\usepackage{esint}\n";
 600
 601         // natbib.sty
 602         if (mustProvide("natbib")) {
 603                 packages << "\\usepackage[";
 604                 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
 605                         packages << "numbers";
 606                 else
 607                         packages << "authoryear";
 608                 packages << "]{natbib}\n";
 609         }
 610
 611         // jurabib -- we need version 0.6 at least.
 612         if (mustProvide("jurabib"))
 613                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
 614
 615         // xargs -- we need version 1.09 at least
 616         if (mustProvide("xargs"))
 617                 packages << "\\usepackage{xargs}[2008/03/08]\n";
 618
 619         // bibtopic -- the dot provides the aux file naming which
 620         // LyX can detect.
 621         if (mustProvide("bibtopic"))
 622                 packages << "\\usepackage[dot]{bibtopic}\n";
 623
 624         if (mustProvide("xy"))
 625                 packages << "\\usepackage[all]{xy}\n";
 626
 627         if (mustProvide("nomencl")) {
 628                 // Make it work with the new and old version of the package,
 629                 // but don't use the compatibility option since it is
 630                 // incompatible to other packages.
 631                 packages << "\\usepackage{nomencl}\n"
 632                             "% the following is useful when we have the old nomencl.sty package\n"
 633                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
 634                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
 635                             "\\makenomenclature\n";
 636         }
 637
 638         return packages.str();
 639 }
 640
 641
 642 string const LaTeXFeatures::getMacros() const
 643 {
 644         ostringstream macros;
 645
 646         if (!preamble_snippets_.empty())
 647                 macros << '\n';
 648         SnippetList::const_iterator pit  = preamble_snippets_.begin();
 649         SnippetList::const_iterator pend = preamble_snippets_.end();
 650         for (; pit != pend; ++pit)
 651                 macros << *pit << '\n';
 652
 653         if (mustProvide("papersize"))
 654                 if (runparams_.flavor == OutputParams::LATEX)
 655                         macros << papersizedvi_def << '\n';
 656                 else
 657                         macros << papersizepdf_def << '\n';
 658
 659         if (mustProvide("LyX"))
 660                 macros << lyx_def << '\n';
 661
 662         if (mustProvide("lyxline"))
 663                 macros << lyxline_def << '\n';
 664
 665         if (mustProvide("noun"))
 666                 macros << noun_def << '\n';
 667
 668         if (mustProvide("lyxarrow"))
 669                 macros << lyxarrow_def << '\n';
 670
 671         if (mustProvide("textgreek"))
 672                 macros << textgreek_def << '\n';
 673
 674         if (mustProvide("textcyr"))
 675                 macros << textcyr_def << '\n';
 676
 677         if (mustProvide("lyxmathsym"))
 678                 macros << lyxmathsym_def << '\n';
 679
 680         // quotes.
 681         if (mustProvide("quotesinglbase"))
 682                 macros << quotesinglbase_def << '\n';
 683         if (mustProvide("quotedblbase"))
 684                 macros << quotedblbase_def << '\n';
 685         if (mustProvide("guilsinglleft"))
 686                 macros << guilsinglleft_def << '\n';
 687         if (mustProvide("guilsinglright"))
 688                 macros << guilsinglright_def << '\n';
 689         if (mustProvide("guillemotleft"))
 690                 macros << guillemotleft_def << '\n';
 691         if (mustProvide("guillemotright"))
 692                 macros << guillemotright_def << '\n';
 693
 694         // Math mode
 695         if (mustProvide("binom") && !isRequired("amsmath"))
 696                 macros << binom_def << '\n';
 697         if (mustProvide("mathcircumflex"))
 698                 macros << mathcircumflex_def << '\n';
 699
 700         // other
 701         if (mustProvide("ParagraphLeftIndent"))
 702                 macros << paragraphleftindent_def;
 703         if (mustProvide("NeedLyXFootnoteCode"))
 704                 macros << floatingfootnote_def;
 705
 706         // some problems with tex->html converters
 707         if (mustProvide("NeedTabularnewline"))
 708                 macros << tabularnewline_def;
 709
 710         // greyedout environment (note inset)
 711         if (mustProvide("lyxgreyedout"))
 712                 macros << lyxgreyedout_def;
 713
 714         if (mustProvide("lyxdot"))
 715                 macros << lyxdot_def << '\n';
 716
 717         // floats
 718         getFloatDefinitions(macros);
 719
 720         // change tracking
 721         if (mustProvide("ct-dvipost"))
 722                 macros << changetracking_dvipost_def;
 723
 724         if (mustProvide("ct-xcolor-soul")) {
 725                 int const prec = macros.precision(2);
 726
 727                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
 728                 macros << "\\providecolor{lyxadded}{rgb}{"
 729                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
 730
 731                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
 732                 macros << "\\providecolor{lyxdeleted}{rgb}{"
 733                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
 734
 735                 macros.precision(prec);
 736
 737                 if (isRequired("hyperref"))
 738                         macros << changetracking_xcolor_soul_hyperref_def;
 739                 else
 740                         macros << changetracking_xcolor_soul_def;
 741         }
 742
 743         if (mustProvide("ct-none"))
 744                 macros << changetracking_none_def;
 745
 746         return macros.str();
 747 }
 748
 749
 750 string const LaTeXFeatures::getBabelOptions() const
 751 {
 752         ostringstream tmp;
 753
 754         LanguageList::const_iterator it  = UsedLanguages_.begin();
 755         LanguageList::const_iterator end =  UsedLanguages_.end();
 756         for (; it != end; ++it)
 757                 if (!(*it)->latex_options().empty())
 758                         tmp << (*it)->latex_options() << '\n';
 759         if (!params_.language->latex_options().empty())
 760                 tmp << params_.language->latex_options() << '\n';
 761
 762         return tmp.str();
 763 }
 764
 765
 766 docstring const LaTeXFeatures::getTClassPreamble() const
 767 {
 768         // the text class specific preamble
 769         DocumentClass const & tclass = params_.documentClass();
 770         odocstringstream tcpreamble;
 771
 772         tcpreamble << tclass.preamble();
 773
 774         list<docstring>::const_iterator cit = usedLayouts_.begin();
 775         list<docstring>::const_iterator end = usedLayouts_.end();
 776         for (; cit != end; ++cit) {
 777                 tcpreamble << tclass[*cit].preamble();
 778         }
 779
 780         return tcpreamble.str();
 781 }
 782
 783
 784 docstring const LaTeXFeatures::getLyXSGMLEntities() const
 785 {
 786         // Definition of entities used in the document that are LyX related.
 787         odocstringstream entities;
 788
 789         if (mustProvide("lyxarrow")) {
 790                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
 791         }
 792
 793         return entities.str();
 794 }
 795
 796
 797 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
 798 {
 799         odocstringstream sgmlpreamble;
 800         // FIXME UNICODE
 801         docstring const basename(from_utf8(onlyPath(fname)));
 802
 803         FileMap::const_iterator end = IncludedFiles_.end();
 804         for (FileMap::const_iterator fi = IncludedFiles_.begin();
 805              fi != end; ++fi)
 806                 // FIXME UNICODE
 807                 sgmlpreamble << "\n<!ENTITY " << fi->first
 808                              << (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
 809                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
 810
 811         return sgmlpreamble.str();
 812 }
 813
 814
 815 void LaTeXFeatures::showStruct() const
 816 {
 817         lyxerr << "LyX needs the following commands when LaTeXing:"
 818                << "\n***** Packages:" << getPackages()
 819                << "\n***** Macros:" << getMacros()
 820                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
 821                << "\n***** done." << endl;
 822 }
 823
 824
 825 Buffer const & LaTeXFeatures::buffer() const
 826 {
 827         return *buffer_;
 828 }
 829
 830
 831 void LaTeXFeatures::setBuffer(Buffer const & buffer)
 832 {
 833         buffer_ = &buffer;
 834 }
 835
 836
 837 BufferParams const & LaTeXFeatures::bufferParams() const
 838 {
 839         return params_;
 840 }
 841
 842
 843 void LaTeXFeatures::getFloatDefinitions(ostream & os) const
 844 {
 845         FloatList const & floats = params_.documentClass().floats();
 846
 847         // Here we will output the code to create the needed float styles.
 848         // We will try to do this as minimal as possible.
 849         // \floatstyle{ruled}
 850         // \newfloat{algorithm}{htbp}{loa}
 851         // \floatname{algorithm}{Algorithm}
 852         UsedFloats::const_iterator cit = usedFloats_.begin();
 853         UsedFloats::const_iterator end = usedFloats_.end();
 854         // ostringstream floats;
 855         for (; cit != end; ++cit) {
 856                 Floating const & fl = floats.getType((cit->first));
 857
 858                 // For builtin floats we do nothing.
 859                 if (fl.builtin()) continue;
 860
 861                 // We have to special case "table" and "figure"
 862                 if (fl.type() == "tabular" || fl.type() == "figure") {
 863                         // Output code to modify "table" or "figure"
 864                         // but only if builtin == false
 865                         // and that have to be true at this point in the
 866                         // function.
 867                         string const type = fl.type();
 868                         string const placement = fl.placement();
 869                         string const style = fl.style();
 870                         if (!style.empty()) {
 871                                 os << "\\floatstyle{" << style << "}\n"
 872                                    << "\\restylefloat{" << type << "}\n";
 873                         }
 874                         if (!placement.empty()) {
 875                                 os << "\\floatplacement{" << type << "}{"
 876                                    << placement << "}\n";
 877                         }
 878                 } else {
 879                         // The other non builtin floats.
 880
 881                         string const type = fl.type();
 882                         string const placement = fl.placement();
 883                         string const ext = fl.ext();
 884                         string const within = fl.within();
 885                         string const style = fl.style();
 886                         string const name = fl.name();
 887                         os << "\\floatstyle{" << style << "}\n"
 888                            << "\\newfloat{" << type << "}{" << placement
 889                            << "}{" << ext << '}';
 890                         if (!within.empty())
 891                                 os << '[' << within << ']';
 892                         os << '\n'
 893                            << "\\floatname{" << type << "}{"
 894                            << name << "}\n";
 895
 896                         // What missing here is to code to minimalize the code
 897                         // output so that the same floatstyle will not be
 898                         // used several times, when the same style is still in
 899                         // effect. (Lgb)
 900                 }
 901                 if (cit->second)
 902                         os << "\n\\newsubfloat{" << fl.type() << "}\n";
 903         }
 904 }
 905
 906
 907 } // namespace lyx