src/LaTeXFeatures.cpp

   1 /**
   2  * \file LaTeXFeatures.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author José Matos
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author Jürgen Vigna
  10  * \author André Pönitz
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "LaTeXFeatures.h"
  18
  19 #include "Buffer.h"
  20 #include "BufferParams.h"
  21 #include "ColorSet.h"
  22 #include "Converter.h"
  23 #include "Encoding.h"
  24 #include "Floating.h"
  25 #include "FloatList.h"
  26 #include "Language.h"
  27 #include "Layout.h"
  28 #include "Lexer.h"
  29 #include "LyXRC.h"
  30 #include "TextClass.h"
  31
  32 #include "insets/InsetLayout.h"
  33
  34 #include "support/debug.h"
  35 #include "support/docstream.h"
  36 #include "support/FileName.h"
  37 #include "support/filetools.h"
  38 #include "support/gettext.h"
  39 #include "support/lstrings.h"
  40
  41 #include <algorithm>
  42
  43
  44 using namespace std;
  45 using namespace lyx::support;
  46
  47
  48 namespace lyx {
  49
  50 /////////////////////////////////////////////////////////////////////
  51 //
  52 // Strings
  53 //
  54 /////////////////////////////////////////////////////////////////////
  55
  56 //\NeedsTeXFormat{LaTeX2e}
  57 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
  58 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
  59
  60 static docstring const lyx_def = from_ascii(
  61         "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
  62
  63 static docstring const noun_def = from_ascii(
  64         "\\newcommand{\\noun}[1]{\\textsc{#1}}");
  65
  66 static docstring const lyxarrow_def = from_ascii(
  67         "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
  68         "\\@ifstar\n"
  69         "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
  70         "{\\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 docstring const quotedblbase_def = from_ascii(
  76         "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
  77         "  \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
  78         "  \\penalty10000\\hskip0em\\relax%\n"
  79         "}");
  80
  81 static docstring const quotesinglbase_def = from_ascii(
  82         "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
  83         "  \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
  84         "  \\penalty10000\\hskip0em\\relax%\n"
  85         "}");
  86
  87 static docstring const guillemotleft_def = from_ascii(
  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 docstring const guillemotright_def = from_ascii(
  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 docstring const guilsinglleft_def = from_ascii(
 100         "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
 101         "  {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
 102         "  \\penalty10000\\hskip0pt\\relax%\n"
 103         "}");
 104
 105 static docstring const guilsinglright_def = from_ascii(
 106         "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
 107         "  \\penalty10000\\hskip0pt%\n"
 108         "  {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
 109         "}");
 110
 111 static docstring const paragraphleftindent_def = from_ascii(
 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 docstring const floatingfootnote_def = from_ascii(
 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 docstring const binom_def = from_ascii(
 148         "%% Binom macro for standard LaTeX users\n"
 149         "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
 150
 151 static docstring const mathcircumflex_def = from_ascii(
 152         "%% For printing a cirumflex inside a formula\n"
 153         "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
 154
 155 static docstring const tabularnewline_def = from_ascii(
 156         "%% Because html converters don't know tabularnewline\n"
 157         "\\providecommand{\\tabularnewline}{\\\\}\n");
 158
 159 static docstring const lyxgreyedout_def = from_ascii(
 160         "%% The greyedout annotation environment\n"
 161         "\\newenvironment{lyxgreyedout}{\\textcolor{note_fontcolor}\\bgroup}{\\egroup}\n");
 162
 163 // We want to omit the file extension for includegraphics, but this does not
 164 // work when the filename contains other dots.
 165 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
 166 static docstring const lyxdot_def = from_ascii(
 167         "%% A simple dot to overcome graphicx limitations\n"
 168         "\\newcommand{\\lyxdot}{.}\n");
 169
 170 static docstring const changetracking_dvipost_def = from_ascii(
 171         "%% Change tracking with dvipost\n"
 172         "\\dvipostlayout\n"
 173         "\\dvipost{osstart color push Red}\n"
 174         "\\dvipost{osend color pop}\n"
 175         "\\dvipost{cbstart color push Blue}\n"
 176         "\\dvipost{cbend color pop}\n"
 177         "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
 178         "\\newcommand{\\lyxdeleted}[3]{%\n"
 179         "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n");
 180
 181 static docstring const changetracking_xcolor_ulem_def = from_ascii(
 182         "%% Change tracking with ulem\n"
 183         "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
 184         "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n");
 185
 186 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
 187         "%% Change tracking with ulem\n"
 188         "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
 189         "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#3}}{}}}\n");
 190
 191 static docstring const changetracking_none_def = from_ascii(
 192         "\\newcommand{\\lyxadded}[3]{#3}\n"
 193         "\\newcommand{\\lyxdeleted}[3]{}\n");
 194
 195 static docstring const textgreek_def = from_ascii(
 196         "\\DeclareRobustCommand{\\greektext}{%\n"
 197         "  \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
 198         "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
 199         "\\DeclareFontEncoding{LGR}{}{}\n"
 200         "\\DeclareTextSymbol{\\~}{LGR}{126}");
 201
 202 static docstring const textcyr_def = from_ascii(
 203         "\\DeclareRobustCommand{\\cyrtext}{%\n"
 204         "  \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
 205         "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
 206         "\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n");
 207
 208 static docstring const lyxmathsym_def = from_ascii(
 209         "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
 210         "  \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
 211
 212 static docstring const papersizedvi_def = from_ascii(
 213         "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
 214
 215 static docstring const papersizepdf_def = from_ascii(
 216         "\\pdfpageheight\\paperheight\n"
 217         "\\pdfpagewidth\\paperwidth\n");
 218
 219 static docstring const cedilla_def = from_ascii(
 220         "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
 221         "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
 222
 223 static docstring const subring_def = from_ascii(
 224         "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
 225         "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
 226
 227 static docstring const subdot_def = from_ascii(
 228         "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
 229         "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
 230
 231 static docstring const subhat_def = from_ascii(
 232         "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
 233         "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
 234
 235 static docstring const subtilde_def = from_ascii(
 236         "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
 237         "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
 238
 239 static docstring const dacute_def = from_ascii(
 240         "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
 241
 242 static docstring const tipasymb_def = from_ascii(
 243         "\\DeclareFontEncoding{T3}{}{}\n"
 244         "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
 245
 246 static docstring const dgrave_def = from_ascii(
 247         "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
 248
 249 static docstring const rcap_def = from_ascii(
 250         "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
 251
 252 static docstring const ogonek_def = from_ascii(
 253         "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
 254         "  \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
 255         "  \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
 256         "  \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
 257         "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
 258
 259 static docstring const lyxref_def = from_ascii(
 260                 "\\RS@ifundefined{subref}\n"
 261                 "  {\\def\\RSsubtxt{section~}\\newref{sub}{name = \\RSsubtxt}}\n"
 262                 "  {}\n"
 263                 "\\RS@ifundefined{thmref}\n"
 264                 "  {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
 265                 "  {}\n"
 266                 "\\RS@ifundefined{lemref}\n"
 267                 "  {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
 268                 "  {}\n");
 269
 270
 271 /////////////////////////////////////////////////////////////////////
 272 //
 273 // LaTeXFeatures
 274 //
 275 /////////////////////////////////////////////////////////////////////
 276
 277 LaTeXFeatures::Packages LaTeXFeatures::packages_;
 278
 279
 280 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
 281                              OutputParams const & r)
 282         : buffer_(&b), params_(p), runparams_(r), in_float_(false)
 283 {}
 284
 285
 286 bool LaTeXFeatures::useBabel() const
 287 {
 288         if (usePolyglossia())
 289                 return false;
 290         return (lyxrc.language_package_selection != LyXRC::LP_NONE)
 291                 || (bufferParams().language->lang() != lyxrc.default_language
 292                     && !bufferParams().language->babel().empty())
 293                 || this->hasLanguages();
 294 }
 295
 296
 297 bool LaTeXFeatures::usePolyglossia() const
 298 {
 299         return (lyxrc.language_package_selection == LyXRC::LP_AUTO)
 300                 && isRequired("polyglossia")
 301                 && isAvailable("polyglossia")
 302                 && this->hasPolyglossiaLanguages();
 303 }
 304
 305
 306 void LaTeXFeatures::require(string const & name)
 307 {
 308         features_.insert(name);
 309 }
 310
 311
 312 void LaTeXFeatures::require(set<string> const & names)
 313 {
 314         features_.insert(names.begin(), names.end());
 315 }
 316
 317
 318 void LaTeXFeatures::getAvailable()
 319 {
 320         Lexer lex;
 321         support::FileName const real_file = libFileSearch("", "packages.lst");
 322
 323         if (real_file.empty())
 324                 return;
 325
 326         lex.setFile(real_file);
 327
 328         if (!lex.isOK())
 329                 return;
 330
 331         // Make sure that we are clean
 332         packages_.clear();
 333
 334         bool finished = false;
 335         // Parse config-file
 336         while (lex.isOK() && !finished) {
 337                 switch (lex.lex()) {
 338                 case Lexer::LEX_FEOF:
 339                         finished = true;
 340                         break;
 341                 default:
 342                         packages_.insert(lex.getString());
 343                 }
 344         }
 345 }
 346
 347
 348 void LaTeXFeatures::useLayout(docstring const & layoutname)
 349 {
 350         // Some code to avoid loops in dependency definition
 351         static int level = 0;
 352         const int maxlevel = 30;
 353         if (level > maxlevel) {
 354                 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
 355                        << "recursion attained by layout "
 356                        << to_utf8(layoutname) << endl;
 357                 return;
 358         }
 359
 360         DocumentClass const & tclass = params_.documentClass();
 361         if (tclass.hasLayout(layoutname)) {
 362                 // Is this layout already in usedLayouts?
 363                 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
 364                     != usedLayouts_.end())
 365                         return;
 366
 367                 Layout const & layout = tclass[layoutname];
 368                 require(layout.requires());
 369
 370                 if (!layout.depends_on().empty()) {
 371                         ++level;
 372                         useLayout(layout.depends_on());
 373                         --level;
 374                 }
 375                 usedLayouts_.push_back(layoutname);
 376         } else {
 377                 lyxerr << "LaTeXFeatures::useLayout: layout `"
 378                        << to_utf8(layoutname) << "' does not exist in this class"
 379                        << endl;
 380         }
 381
 382         --level;
 383 }
 384
 385
 386 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
 387 {
 388         docstring const & lname = lay.name();
 389         DocumentClass const & tclass = params_.documentClass();
 390
 391         // this is a default inset layout, nothing useful here
 392         if (!tclass.hasInsetLayout(lname))
 393                 return;
 394         // Is this layout already in usedInsetLayouts?
 395         if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
 396                         != usedInsetLayouts_.end())
 397                 return;
 398
 399         require(lay.requires());
 400         usedInsetLayouts_.push_back(lname);
 401 }
 402
 403
 404 bool LaTeXFeatures::isRequired(string const & name) const
 405 {
 406         return features_.find(name) != features_.end();
 407 }
 408
 409
 410 bool LaTeXFeatures::mustProvide(string const & name) const
 411 {
 412         return isRequired(name) && !params_.documentClass().provides(name);
 413 }
 414
 415
 416 bool LaTeXFeatures::isAvailable(string const & name)
 417 {
 418         string::size_type const i = name.find("->");
 419         if (i != string::npos) {
 420                 string const from = name.substr(0,i);
 421                 string const to = name.substr(i+2);
 422                 //LYXERR0("from=[" << from << "] to=[" << to << "]");
 423                 return theConverters().isReachable(from, to);
 424         }
 425
 426         if (packages_.empty())
 427                 getAvailable();
 428         string n = name;
 429         if (suffixIs(n, ".sty"))
 430                 n.erase(name.length() - 4);
 431         return packages_.find(n) != packages_.end();
 432 }
 433
 434
 435 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
 436 {
 437         SnippetList::const_iterator begin = preamble_snippets_.begin();
 438         SnippetList::const_iterator end   = preamble_snippets_.end();
 439         if (find(begin, end, preamble) == end)
 440                 preamble_snippets_.push_back(preamble);
 441 }
 442
 443
 444 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
 445 {
 446         if (!usedFloats_[name])
 447                 usedFloats_[name] = subfloat;
 448         if (subfloat)
 449                 require("subfig");
 450         // We only need float.sty if we use non builtin floats, or if we
 451         // use the "H" modifier. This includes modified table and
 452         // figure floats. (Lgb)
 453         Floating const & fl = params_.documentClass().floats().getType(name);
 454         if (!fl.floattype().empty() && fl.needsFloatPkg()) {
 455                 require("float");
 456         }
 457 }
 458
 459
 460 void LaTeXFeatures::useLanguage(Language const * lang)
 461 {
 462         if (!lang->babel().empty())
 463                 UsedLanguages_.insert(lang);
 464         if (lang->lang() == "vietnamese")
 465                 require("vietnamese");
 466         // CJK languages do not have a babel name.
 467         // They use the CJK package
 468         if (lang->encoding()->package() == Encoding::CJK)
 469                 require("CJK");
 470         // japanese package is special
 471         if (lang->encoding()->package() == Encoding::japanese)
 472                 require("japanese");
 473 }
 474
 475
 476 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
 477 {
 478         IncludedFiles_[key] = name;
 479 }
 480
 481
 482 bool LaTeXFeatures::hasLanguages() const
 483 {
 484         return !UsedLanguages_.empty();
 485 }
 486
 487
 488 bool LaTeXFeatures::hasPolyglossiaLanguages() const
 489 {
 490         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 491         for (LanguageList::const_iterator cit = begin;
 492              cit != UsedLanguages_.end();
 493              ++cit) {
 494                 if ((*cit)->polyglossia().empty())
 495                         return false;
 496         }
 497         return true;
 498 }
 499
 500
 501 string LaTeXFeatures::getLanguages() const
 502 {
 503         ostringstream languages;
 504
 505         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 506         for (LanguageList::const_iterator cit = begin;
 507              cit != UsedLanguages_.end();
 508              ++cit) {
 509                 if (cit != begin)
 510                         languages << ',';
 511                 languages << (*cit)->babel();
 512         }
 513         return languages.str();
 514 }
 515
 516
 517 std::map<std::string, std::string> LaTeXFeatures::getPolyglossiaLanguages() const
 518 {
 519         std::map<std::string, std::string> languages;
 520
 521         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 522         for (LanguageList::const_iterator cit = begin;
 523              cit != UsedLanguages_.end();
 524              ++cit) {
 525                 languages[(*cit)->polyglossia()] = (*cit)->polyglossiaOpts();
 526         }
 527         return languages;
 528 }
 529
 530
 531 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 532 {
 533         // This does only find encodings of languages supported by babel, but
 534         // that does not matter since we don't have a language with an
 535         // encoding supported by inputenc but without babel support.
 536         set<string> encodings;
 537         LanguageList::const_iterator it  = UsedLanguages_.begin();
 538         LanguageList::const_iterator end = UsedLanguages_.end();
 539         for (; it != end; ++it)
 540                 if ((*it)->encoding()->latexName() != doc_encoding &&
 541                     ((*it)->encoding()->package() == Encoding::inputenc
 542                      || (*it)->encoding()->package() == Encoding::japanese))
 543                         encodings.insert((*it)->encoding()->latexName());
 544         return encodings;
 545 }
 546
 547 namespace {
 548
 549 char const * simplefeatures[] = {
 550 // note that the package order here will be the same in the LaTeX-output
 551         "array",
 552         "verbatim",
 553         "longtable",
 554         "rotating",
 555         "latexsym",
 556         "pifont",
 557         // subfig is handled in BufferParams.cpp
 558         "varioref",
 559         "prettyref",
 560         "refstyle",
 561         /*For a successful cooperation of the `wrapfig' package with the
 562           `float' package you should load the `wrapfig' package *after*
 563           the `float' package. See the caption package documentation
 564           for explanation.*/
 565         "float",
 566         "rotfloat",
 567         "wrapfig",
 568         "booktabs",
 569         "dvipost",
 570         "fancybox",
 571         "calc",
 572         "units",
 573         "tipa",
 574         "tipx",
 575         "framed",
 576         "soul",
 577         "textcomp",
 578         "fixltx2e",
 579         "pmboxdraw",
 580         "bbding",
 581         "ifsym",
 582         "marvosym",
 583         "txfonts",
 584         "mathrsfs",
 585         "ascii",
 586         "url",
 587         "covington",
 588         "csquotes",
 589         "enumitem",
 590         "endnotes",
 591         "ifthen",
 592         "amsthm",
 593         // listings is handled in BufferParams.cpp
 594         "bm",
 595         "pdfpages",
 596         "amscd",
 597         "slashed",
 598         "multirow",
 599         "tfrupee"
 600 };
 601
 602 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 603
 604 }
 605
 606
 607 string const LaTeXFeatures::getColorOptions() const
 608 {
 609         ostringstream colors;
 610
 611         // Handling the color packages separately is needed to be able to load them
 612         // before babel when hyperref is loaded with the colorlinks option
 613         // for more info see Bufferparams.cpp
 614
 615         // [x]color.sty
 616         if (mustProvide("color") || mustProvide("xcolor")) {
 617                 string const package =
 618                         (mustProvide("xcolor") ? "xcolor" : "color");
 619                 if (params_.graphics_driver == "default"
 620                         || params_.graphics_driver == "none")
 621                         colors << "\\usepackage{" << package << "}\n";
 622                 else
 623                         colors << "\\usepackage["
 624                                  << params_.graphics_driver
 625                                  << "]{" << package << "}\n";
 626         }
 627
 628         // pdfcolmk must be loaded after color
 629         if (mustProvide("pdfcolmk"))
 630                 colors << "\\usepackage{pdfcolmk}\n";
 631
 632         // the following 3 color commands must be set after color
 633         // is loaded and before pdfpages, therefore add the command
 634         // here define the set color
 635         if (mustProvide("pagecolor")) {
 636                 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
 637                 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
 638                 // set the page color
 639                 colors << "\\pagecolor{page_backgroundcolor}\n";
 640         }
 641
 642         if (mustProvide("fontcolor")) {
 643                 colors << "\\definecolor{document_fontcolor}{rgb}{";
 644                 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
 645                 // set the color
 646                 colors << "\\color{document_fontcolor}\n";
 647         }
 648
 649         if (mustProvide("lyxgreyedout")) {
 650                 colors << "\\definecolor{note_fontcolor}{rgb}{";
 651                 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
 652                 // the color will be set together with the definition of
 653                 // the lyxgreyedout environment (see lyxgreyedout_def)
 654         }
 655
 656         // color for shaded boxes
 657         if (isRequired("framed") && mustProvide("color")) {
 658                 colors << "\\definecolor{shadecolor}{rgb}{";
 659                 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
 660                 // this color is automatically used by the LaTeX-package "framed"
 661         }
 662
 663         return colors.str();
 664 }
 665
 666
 667 string const LaTeXFeatures::getPackages() const
 668 {
 669         ostringstream packages;
 670         DocumentClass const & tclass = params_.documentClass();
 671
 672         // FIXME: currently, we can only load packages and macros known
 673         // to LyX.
 674         // However, with the Require tag of layouts/custom insets,
 675         // also unknown packages can be requested. They are silently
 676         // swallowed now. We should change this eventually.
 677
 678         //
 679         //  These are all the 'simple' includes.  i.e
 680         //  packages which we just \usepackage{package}
 681         //
 682         for (int i = 0; i < nb_simplefeatures; ++i) {
 683                 if (mustProvide(simplefeatures[i]))
 684                         packages << "\\usepackage{"
 685                                  << simplefeatures[i] << "}\n";
 686         }
 687
 688         //
 689         // The rest of these packages are somewhat more complicated
 690         // than those above.
 691         //
 692
 693         // esint is preferred for esintoramsmath
 694         if ((mustProvide("amsmath")
 695              && params_.use_amsmath != BufferParams::package_off)
 696             || (mustProvide("esintoramsmath")
 697                 && params_.use_esint == BufferParams::package_off
 698                 && params_.use_amsmath != BufferParams::package_off)) {
 699                 packages << "\\usepackage{amsmath}\n";
 700         } else {
 701                 // amsbsy and amstext are already provided by amsmath
 702                 if (mustProvide("amsbsy"))
 703                         packages << "\\usepackage{amsbsy}\n";
 704                 if (mustProvide("amstext"))
 705                         packages << "\\usepackage{amstext}\n";
 706         }
 707
 708         // wasysym is a simple feature, but it must be after amsmath if both
 709         // are used
 710         // wasysym redefines some integrals (e.g. iint) from amsmath. That
 711         // leads to inconsistent integrals. We only load this package if
 712         // the document does not contain integrals (then isRequired("esint")
 713         // is false) or if esint is used, since esint redefines all relevant
 714         // integral symbols from wasysym and amsmath.
 715         // See http://www.lyx.org/trac/ticket/1942
 716         if (mustProvide("wasysym") &&
 717             (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
 718                 packages << "\\usepackage{wasysym}\n";
 719
 720         // accents must be loaded after amsmath
 721         if (mustProvide("accents"))
 722                 packages << "\\usepackage{accents}\n";
 723
 724         // mathdots must be loaded after amsmath
 725         if (mustProvide("mathdots") &&
 726                 params_.use_mathdots != BufferParams::package_off)
 727                 packages << "\\usepackage{mathdots}\n";
 728
 729         // yhmath must be loaded after amsmath
 730         if (mustProvide("yhmath"))
 731                 packages << "\\usepackage{yhmath}\n";
 732
 733         // [x]color and pdfcolmk are handled in getColorOptions() above
 734
 735         // makeidx.sty
 736         if (isRequired("makeidx") || isRequired("splitidx")) {
 737                 if (!tclass.provides("makeidx") && !isRequired("splitidx"))
 738                         packages << "\\usepackage{makeidx}\n";
 739                 if (!tclass.provides("splitidx") && isRequired("splitidx"))
 740                         packages << "\\usepackage{splitidx}\n";
 741                 packages << "\\makeindex\n";
 742         }
 743
 744         // graphicx.sty
 745         if (mustProvide("graphicx") && params_.graphics_driver != "none") {
 746                 if (params_.graphics_driver == "default")
 747                         packages << "\\usepackage{graphicx}\n";
 748                 else
 749                         packages << "\\usepackage["
 750                                  << params_.graphics_driver
 751                                  << "]{graphicx}\n";
 752         }
 753
 754         // lyxskak.sty --- newer chess support based on skak.sty
 755         if (mustProvide("chess"))
 756                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
 757
 758         // setspace.sty
 759         if (mustProvide("setspace") && !tclass.provides("SetSpace"))
 760                 packages << "\\usepackage{setspace}\n";
 761
 762         // amssymb.sty
 763         if (mustProvide("amssymb")
 764             || params_.use_amsmath == BufferParams::package_on)
 765                 packages << "\\usepackage{amssymb}\n";
 766
 767         // esint must be after amsmath and wasysym, since it will redeclare
 768         // inconsistent integral symbols
 769         if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
 770             params_.use_esint != BufferParams::package_off)
 771                 packages << "\\usepackage{esint}\n";
 772
 773         // natbib.sty
 774         // Some classes load natbib themselves, but still allow (or even require)
 775         // plain numeric citations (ReVTeX is such a case, see bug 5182).
 776         // This special case is indicated by the "natbib-internal" key.
 777         if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
 778                 packages << "\\usepackage[";
 779                 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
 780                         packages << "numbers";
 781                 else
 782                         packages << "authoryear";
 783                 packages << "]{natbib}\n";
 784         }
 785
 786         // jurabib -- we need version 0.6 at least.
 787         if (mustProvide("jurabib"))
 788                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
 789
 790         // xargs -- we need version 1.09 at least
 791         if (mustProvide("xargs"))
 792                 packages << "\\usepackage{xargs}[2008/03/08]\n";
 793
 794         // bibtopic -- the dot provides the aux file naming which
 795         // LyX can detect.
 796         if (mustProvide("bibtopic"))
 797                 packages << "\\usepackage[dot]{bibtopic}\n";
 798
 799         if (mustProvide("xy"))
 800                 packages << "\\usepackage[all]{xy}\n";
 801
 802         if (mustProvide("feyn"))
 803                 packages << "\\usepackage{feyn}\n"; //Diagram
 804
 805         if (mustProvide("ulem"))
 806                 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
 807                             "\\usepackage{ulem}\n";
 808
 809         if (params_.use_mhchem == BufferParams::package_on ||
 810             (mustProvide("mhchem") &&
 811              params_.use_mhchem != BufferParams::package_off))
 812                 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
 813                             "\\usepackage{mhchem}\n";
 814
 815         if (mustProvide("nomencl")) {
 816                 // Make it work with the new and old version of the package,
 817                 // but don't use the compatibility option since it is
 818                 // incompatible to other packages.
 819                 packages << "\\usepackage{nomencl}\n"
 820                             "% the following is useful when we have the old nomencl.sty package\n"
 821                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
 822                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
 823                             "\\makenomenclature\n";
 824         }
 825
 826         // fixltx2e provides subscript
 827         if (mustProvide("subscript") && !isRequired("fixltx2e"))
 828                 packages << "\\usepackage{subscript}\n";
 829
 830         return packages.str();
 831 }
 832
 833
 834 string LaTeXFeatures::getPreambleSnippets() const
 835 {
 836         ostringstream snip;
 837         SnippetList::const_iterator pit  = preamble_snippets_.begin();
 838         SnippetList::const_iterator pend = preamble_snippets_.end();
 839         for (; pit != pend; ++pit)
 840                 snip << *pit << '\n';
 841         return snip.str();
 842 }
 843
 844
 845 docstring const LaTeXFeatures::getMacros() const
 846 {
 847         odocstringstream macros;
 848
 849         if (!preamble_snippets_.empty()) {
 850                 macros << '\n';
 851                 macros << from_utf8(getPreambleSnippets());
 852         }
 853
 854         if (mustProvide("papersize")) {
 855                 if (runparams_.flavor == OutputParams::LATEX)
 856                         macros << papersizedvi_def << '\n';
 857                 else
 858                         macros << papersizepdf_def << '\n';
 859         }
 860
 861         if (mustProvide("LyX"))
 862                 macros << lyx_def << '\n';
 863
 864         if (mustProvide("noun"))
 865                 macros << noun_def << '\n';
 866
 867         if (mustProvide("lyxarrow"))
 868                 macros << lyxarrow_def << '\n';
 869
 870         if (!usePolyglossia() && mustProvide("textgreek")) {
 871                 // Avoid a LaTeX error if times fonts are used and the grtimes
 872                 // package is installed but actual fonts are not (bug 6469).
 873                 if (params_.fonts_roman == "times")
 874                         macros << subst(textgreek_def,
 875                                         from_ascii("\\greektext #1"),
 876                                         from_ascii("%\n  \\IfFileExists"
 877                                                    "{grtm10.tfm}{}{\\fontfamily"
 878                                                    "{cmr}}\\greektext #1"))
 879                                << '\n';
 880                 else
 881                         macros << textgreek_def << '\n';
 882         }
 883
 884         if (!usePolyglossia() && mustProvide("textcyr"))
 885                 macros << textcyr_def << '\n';
 886
 887         if (mustProvide("lyxmathsym"))
 888                 macros << lyxmathsym_def << '\n';
 889
 890         if (mustProvide("cedilla"))
 891                 macros << cedilla_def << '\n';
 892
 893         if (mustProvide("subring"))
 894                 macros << subring_def << '\n';
 895
 896         if (mustProvide("subdot"))
 897                 macros << subdot_def << '\n';
 898
 899         if (mustProvide("subhat"))
 900                 macros << subhat_def << '\n';
 901
 902         if (mustProvide("subtilde"))
 903                 macros << subtilde_def << '\n';
 904
 905         if (mustProvide("dacute"))
 906                 macros << dacute_def << '\n';
 907
 908         if (mustProvide("tipasymb"))
 909                 macros << tipasymb_def << '\n';
 910
 911         if (mustProvide("dgrave"))
 912                 macros << dgrave_def << '\n';
 913
 914         if (mustProvide("rcap"))
 915                 macros << rcap_def << '\n';
 916
 917         if (mustProvide("ogonek"))
 918                 macros << ogonek_def << '\n';
 919
 920         // quotes.
 921         if (mustProvide("quotesinglbase"))
 922                 macros << quotesinglbase_def << '\n';
 923         if (mustProvide("quotedblbase"))
 924                 macros << quotedblbase_def << '\n';
 925         if (mustProvide("guilsinglleft"))
 926                 macros << guilsinglleft_def << '\n';
 927         if (mustProvide("guilsinglright"))
 928                 macros << guilsinglright_def << '\n';
 929         if (mustProvide("guillemotleft"))
 930                 macros << guillemotleft_def << '\n';
 931         if (mustProvide("guillemotright"))
 932                 macros << guillemotright_def << '\n';
 933
 934         // Math mode
 935         if (mustProvide("binom") && !isRequired("amsmath"))
 936                 macros << binom_def << '\n';
 937         if (mustProvide("mathcircumflex"))
 938                 macros << mathcircumflex_def << '\n';
 939
 940         // other
 941         if (mustProvide("ParagraphLeftIndent"))
 942                 macros << paragraphleftindent_def;
 943         if (mustProvide("NeedLyXFootnoteCode"))
 944                 macros << floatingfootnote_def;
 945
 946         // some problems with tex->html converters
 947         if (mustProvide("NeedTabularnewline"))
 948                 macros << tabularnewline_def;
 949
 950         // greyed-out environment (note inset)
 951         // the color is specified in the routine
 952         // getColorOptions() to avoid LaTeX-package clashes
 953         if (mustProvide("lyxgreyedout"))
 954                 macros << lyxgreyedout_def;
 955
 956         if (mustProvide("lyxdot"))
 957                 macros << lyxdot_def << '\n';
 958
 959         // floats
 960         getFloatDefinitions(macros);
 961
 962         if (mustProvide("refstyle"))
 963                 macros << lyxref_def << '\n';
 964
 965         // change tracking
 966         if (mustProvide("ct-dvipost"))
 967                 macros << changetracking_dvipost_def;
 968
 969         if (mustProvide("ct-xcolor-ulem")) {
 970                 streamsize const prec = macros.precision(2);
 971
 972                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
 973                 macros << "\\providecolor{lyxadded}{rgb}{"
 974                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
 975
 976                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
 977                 macros << "\\providecolor{lyxdeleted}{rgb}{"
 978                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
 979
 980                 macros.precision(prec);
 981
 982                 if (isRequired("hyperref"))
 983                         macros << changetracking_xcolor_ulem_hyperref_def;
 984                 else
 985                         macros << changetracking_xcolor_ulem_def;
 986         }
 987
 988         if (mustProvide("ct-none"))
 989                 macros << changetracking_none_def;
 990
 991         return macros.str();
 992 }
 993
 994
 995 string const LaTeXFeatures::getBabelPresettings() const
 996 {
 997         ostringstream tmp;
 998
 999         LanguageList::const_iterator it  = UsedLanguages_.begin();
1000         LanguageList::const_iterator end = UsedLanguages_.end();
1001         for (; it != end; ++it)
1002                 if (!(*it)->babel_presettings().empty())
1003                         tmp << (*it)->babel_presettings() << '\n';
1004         if (!params_.language->babel_presettings().empty())
1005                 tmp << params_.language->babel_presettings() << '\n';
1006
1007         return tmp.str();
1008 }
1009
1010
1011 string const LaTeXFeatures::getBabelPostsettings() const
1012 {
1013         ostringstream tmp;
1014
1015         LanguageList::const_iterator it  = UsedLanguages_.begin();
1016         LanguageList::const_iterator end = UsedLanguages_.end();
1017         for (; it != end; ++it)
1018                 if (!(*it)->babel_postsettings().empty())
1019                         tmp << (*it)->babel_postsettings() << '\n';
1020         if (!params_.language->babel_postsettings().empty())
1021                 tmp << params_.language->babel_postsettings() << '\n';
1022
1023         return tmp.str();
1024 }
1025
1026
1027 bool LaTeXFeatures::needBabelLangOptions() const
1028 {
1029         if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1030                 return true;
1031
1032         LanguageList::const_iterator it  = UsedLanguages_.begin();
1033         LanguageList::const_iterator end = UsedLanguages_.end();
1034         for (; it != end; ++it)
1035                 if ((*it)->asBabelOptions())
1036                         return true;
1037
1038         return false;
1039 }
1040
1041
1042 docstring const LaTeXFeatures::getTClassPreamble() const
1043 {
1044         // the text class specific preamble
1045         DocumentClass const & tclass = params_.documentClass();
1046         odocstringstream tcpreamble;
1047
1048         tcpreamble << tclass.preamble();
1049
1050         list<docstring>::const_iterator cit = usedLayouts_.begin();
1051         list<docstring>::const_iterator end = usedLayouts_.end();
1052         for (; cit != end; ++cit)
1053                 tcpreamble << tclass[*cit].preamble();
1054
1055         cit = usedInsetLayouts_.begin();
1056         end = usedInsetLayouts_.end();
1057         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1058         for (; cit != end; ++cit) {
1059                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1060                 if (it == ils.end())
1061                         continue;
1062                 tcpreamble << it->second.preamble();
1063         }
1064
1065         return tcpreamble.str();
1066 }
1067
1068
1069 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1070 {
1071         DocumentClass const & tclass = params_.documentClass();
1072         odocstringstream tcpreamble;
1073
1074         tcpreamble << tclass.htmlpreamble();
1075
1076         list<docstring>::const_iterator cit = usedLayouts_.begin();
1077         list<docstring>::const_iterator end = usedLayouts_.end();
1078         for (; cit != end; ++cit)
1079                 tcpreamble << tclass[*cit].htmlpreamble();
1080
1081         cit = usedInsetLayouts_.begin();
1082         end = usedInsetLayouts_.end();
1083         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1084         for (; cit != end; ++cit) {
1085                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1086                 if (it == ils.end())
1087                         continue;
1088                 tcpreamble << it->second.htmlpreamble();
1089         }
1090
1091         return tcpreamble.str();
1092 }
1093
1094
1095 docstring const LaTeXFeatures::getTClassHTMLStyles() const {
1096         DocumentClass const & tclass = params_.documentClass();
1097         odocstringstream tcpreamble;
1098
1099         list<docstring>::const_iterator cit = usedLayouts_.begin();
1100         list<docstring>::const_iterator end = usedLayouts_.end();
1101         for (; cit != end; ++cit)
1102                 tcpreamble << tclass[*cit].htmlstyle();
1103
1104         cit = usedInsetLayouts_.begin();
1105         end = usedInsetLayouts_.end();
1106         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1107         for (; cit != end; ++cit) {
1108                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1109                 if (it == ils.end())
1110                         continue;
1111                 tcpreamble << it->second.htmlstyle();
1112         }
1113
1114         return tcpreamble.str();
1115 }
1116
1117
1118 namespace {
1119 docstring const getFloatI18nPreamble(docstring const & type, docstring const & name, docstring const & lang)
1120 {
1121         odocstringstream os;
1122         os << "\\addto\\captions" << lang
1123            << "{\\renewcommand{\\" << type << "name}{" << name << "}}\n";
1124         return os.str();
1125 }
1126 }
1127
1128
1129 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel) const
1130 {
1131         DocumentClass const & tclass = params_.documentClass();
1132         // collect preamble snippets in a set to prevent multiple identical
1133         // commands (would happen if e.g. both theorem and theorem* are used)
1134         set<docstring> snippets;
1135         typedef LanguageList::const_iterator lang_it;
1136         lang_it const lbeg = UsedLanguages_.begin();
1137         lang_it const lend =  UsedLanguages_.end();
1138         list<docstring>::const_iterator cit = usedLayouts_.begin();
1139         list<docstring>::const_iterator end = usedLayouts_.end();
1140         for (; cit != end; ++cit) {
1141                 // language dependent commands (once per document)
1142                 snippets.insert(tclass[*cit].langpreamble(buffer().language()));
1143                 // commands for language changing (for multilanguage documents)
1144                 if (use_babel && !UsedLanguages_.empty()) {
1145                         snippets.insert(tclass[*cit].babelpreamble(buffer().language()));
1146                         for (lang_it lit = lbeg; lit != lend; ++lit)
1147                                 snippets.insert(tclass[*cit].babelpreamble(*lit));
1148                 }
1149         }
1150         if (use_babel && !UsedLanguages_.empty()) {
1151                 FloatList const & floats = params_.documentClass().floats();
1152                 UsedFloats::const_iterator fit = usedFloats_.begin();
1153                 UsedFloats::const_iterator fend = usedFloats_.end();
1154                 for (; fit != fend; ++fit) {
1155                         Floating const & fl = floats.getType(fit->first);
1156                         docstring const type = from_ascii(fl.floattype());
1157                         docstring const flname = from_utf8(fl.name());
1158                         docstring name = translateIfPossible(flname,
1159                                 buffer().language()->code());
1160                         snippets.insert(getFloatI18nPreamble(
1161                                 type, name,
1162                                 from_ascii(buffer().language()->babel())));
1163                         for (lang_it lit = lbeg; lit != lend; ++lit) {
1164                                 name = translateIfPossible(flname,
1165                                         (*lit)->code());
1166                                 snippets.insert(getFloatI18nPreamble(
1167                                         type, name,
1168                                         from_ascii((*lit)->babel())));
1169                         }
1170                 }
1171         }
1172
1173         odocstringstream tcpreamble;
1174         set<docstring>::const_iterator const send = snippets.end();
1175         set<docstring>::const_iterator it = snippets.begin();
1176         for (; it != send; ++it)
1177                 tcpreamble << *it;
1178         return tcpreamble.str();
1179 }
1180
1181
1182 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1183 {
1184         // Definition of entities used in the document that are LyX related.
1185         odocstringstream entities;
1186
1187         if (mustProvide("lyxarrow")) {
1188                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
1189         }
1190
1191         return entities.str();
1192 }
1193
1194
1195 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1196 {
1197         odocstringstream sgmlpreamble;
1198         // FIXME UNICODE
1199         docstring const basename(from_utf8(onlyPath(fname)));
1200
1201         FileMap::const_iterator end = IncludedFiles_.end();
1202         for (FileMap::const_iterator fi = IncludedFiles_.begin();
1203              fi != end; ++fi)
1204                 // FIXME UNICODE
1205                 sgmlpreamble << "\n<!ENTITY " << fi->first
1206                              << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1207                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
1208
1209         return sgmlpreamble.str();
1210 }
1211
1212
1213 void LaTeXFeatures::showStruct() const
1214 {
1215         lyxerr << "LyX needs the following commands when LaTeXing:"
1216                << "\n***** Packages:" << getPackages()
1217                << "\n***** Macros:" << to_utf8(getMacros())
1218                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1219                << "\n***** done." << endl;
1220 }
1221
1222
1223 Buffer const & LaTeXFeatures::buffer() const
1224 {
1225         return *buffer_;
1226 }
1227
1228
1229 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1230 {
1231         buffer_ = &buffer;
1232 }
1233
1234
1235 BufferParams const & LaTeXFeatures::bufferParams() const
1236 {
1237         return params_;
1238 }
1239
1240
1241 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1242 {
1243         FloatList const & floats = params_.documentClass().floats();
1244
1245         // Here we will output the code to create the needed float styles.
1246         // We will try to do this as minimal as possible.
1247         // \floatstyle{ruled}
1248         // \newfloat{algorithm}{htbp}{loa}
1249         // \providecommand{\algorithmname}{Algorithm}
1250         // \floatname{algorithm}{\protect\algorithmname}
1251         UsedFloats::const_iterator cit = usedFloats_.begin();
1252         UsedFloats::const_iterator end = usedFloats_.end();
1253         for (; cit != end; ++cit) {
1254                 Floating const & fl = floats.getType(cit->first);
1255
1256                 // For builtin floats we do nothing.
1257                 if (!fl.needsFloatPkg())
1258                         continue;
1259
1260                 // We have to special case "table" and "figure"
1261                 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1262                         // Output code to modify "table" or "figure"
1263                         // but only if builtin == false
1264                         // and that have to be true at this point in the
1265                         // function.
1266                         docstring const type = from_ascii(fl.floattype());
1267                         docstring const placement = from_ascii(fl.placement());
1268                         docstring const style = from_ascii(fl.style());
1269                         if (!style.empty()) {
1270                                 os << "\\floatstyle{" << style << "}\n"
1271                                    << "\\restylefloat{" << type << "}\n";
1272                         }
1273                         if (!placement.empty()) {
1274                                 os << "\\floatplacement{" << type << "}{"
1275                                    << placement << "}\n";
1276                         }
1277                 } else {
1278                         // The other non builtin floats.
1279
1280                         docstring const type = from_ascii(fl.floattype());
1281                         docstring const placement = from_ascii(fl.placement());
1282                         docstring const ext = from_ascii(fl.ext());
1283                         docstring const within = from_ascii(fl.within());
1284                         docstring const style = from_ascii(fl.style());
1285                         docstring const name = translateIfPossible(
1286                                         from_utf8(fl.name()),
1287                                         buffer().language()->code());
1288                         os << "\\floatstyle{" << style << "}\n"
1289                            << "\\newfloat{" << type << "}{" << placement
1290                            << "}{" << ext << '}';
1291                         if (!within.empty())
1292                                 os << '[' << within << ']';
1293                         os << '\n'
1294                            << "\\providecommand{\\" << type << "name}{"
1295                            << name << "}\n"
1296                            << "\\floatname{" << type << "}{\\protect\\"
1297                            << type << "name}\n";
1298
1299                         // What missing here is to code to minimalize the code
1300                         // output so that the same floatstyle will not be
1301                         // used several times, when the same style is still in
1302                         // effect. (Lgb)
1303                 }
1304                 if (cit->second)
1305                         os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";
1306         }
1307 }
1308
1309
1310 } // namespace lyx