src/LaTeXFeatures.cpp

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