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