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