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         string const amsPackages = loadAMSPackages();
 714         if (!params_.useNonTeXFonts && !amsPackages.empty())
 715                 packages << amsPackages;
 716
 717         // fixltx2e must be loaded after amsthm, since amsthm produces an error with
 718         // the redefined \[ command (bug 7233). Load is as early as possible, since
 719         // other packages might profit from it.
 720         if (mustProvide("fixltx2e"))
 721                 packages << "\\usepackage{fixltx2e}\n";
 722
 723         // wasysym is a simple feature, but it must be after amsmath if both
 724         // are used
 725         // wasysym redefines some integrals (e.g. iint) from amsmath. That
 726         // leads to inconsistent integrals. We only load this package if
 727         // the document does not contain integrals (then isRequired("esint")
 728         // is false) or if esint is used, since esint redefines all relevant
 729         // integral symbols from wasysym and amsmath.
 730         // See http://www.lyx.org/trac/ticket/1942
 731         if (mustProvide("wasysym") &&
 732             (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
 733                 packages << "\\usepackage{wasysym}\n";
 734
 735         // accents must be loaded after amsmath
 736         if (mustProvide("accents"))
 737                 packages << "\\usepackage{accents}\n";
 738
 739         // mathdots must be loaded after amsmath
 740         if (mustProvide("mathdots") &&
 741                 params_.use_mathdots != BufferParams::package_off)
 742                 packages << "\\usepackage{mathdots}\n";
 743
 744         // yhmath must be loaded after amsmath
 745         if (mustProvide("yhmath"))
 746                 packages << "\\usepackage{yhmath}\n";
 747
 748         if (mustProvide("undertilde") &&
 749                 params_.use_undertilde != BufferParams::package_off)
 750                 packages << "\\usepackage{undertilde}\n";
 751
 752         // [x]color and pdfcolmk are handled in getColorOptions() above
 753
 754         // makeidx.sty
 755         if (isRequired("makeidx") || isRequired("splitidx")) {
 756                 if (!tclass.provides("makeidx") && !isRequired("splitidx"))
 757                         packages << "\\usepackage{makeidx}\n";
 758                 if (!tclass.provides("splitidx") && isRequired("splitidx"))
 759                         packages << "\\usepackage{splitidx}\n";
 760                 packages << "\\makeindex\n";
 761         }
 762
 763         // graphicx.sty
 764         if (mustProvide("graphicx") && params_.graphics_driver != "none") {
 765                 if (params_.graphics_driver == "default")
 766                         packages << "\\usepackage{graphicx}\n";
 767                 else
 768                         packages << "\\usepackage["
 769                                  << params_.graphics_driver
 770                                  << "]{graphicx}\n";
 771         }
 772
 773         // lyxskak.sty --- newer chess support based on skak.sty
 774         if (mustProvide("chess"))
 775                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
 776
 777         // setspace.sty
 778         if (mustProvide("setspace") && !tclass.provides("SetSpace"))
 779                 packages << "\\usepackage{setspace}\n";
 780
 781         // esint must be after amsmath and wasysym, since it will redeclare
 782         // inconsistent integral symbols
 783         if (mustProvide("esint") &&
 784             params_.use_esint != BufferParams::package_off)
 785                 packages << "\\usepackage{esint}\n";
 786
 787         // natbib.sty
 788         // Some classes load natbib themselves, but still allow (or even require)
 789         // plain numeric citations (ReVTeX is such a case, see bug 5182).
 790         // This special case is indicated by the "natbib-internal" key.
 791         if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
 792                 packages << "\\usepackage[";
 793                 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
 794                         packages << "numbers";
 795                 else
 796                         packages << "authoryear";
 797                 packages << "]{natbib}\n";
 798         }
 799
 800         // jurabib -- we need version 0.6 at least.
 801         if (mustProvide("jurabib"))
 802                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
 803
 804         // xargs -- we need version 1.09 at least
 805         if (mustProvide("xargs"))
 806                 packages << "\\usepackage{xargs}[2008/03/08]\n";
 807
 808         // bibtopic -- the dot provides the aux file naming which
 809         // LyX can detect.
 810         if (mustProvide("bibtopic"))
 811                 packages << "\\usepackage[dot]{bibtopic}\n";
 812
 813         if (mustProvide("xy"))
 814                 packages << "\\usepackage[all]{xy}\n";
 815
 816         if (mustProvide("feyn"))
 817                 packages << "\\usepackage{feyn}\n"; //Diagram
 818
 819         if (mustProvide("ulem"))
 820                 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
 821                             "\\usepackage{ulem}\n";
 822
 823         if (params_.use_mhchem == BufferParams::package_on ||
 824             (mustProvide("mhchem") &&
 825              params_.use_mhchem != BufferParams::package_off))
 826                 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
 827                             "\\usepackage{mhchem}\n";
 828
 829         if (mustProvide("nomencl")) {
 830                 // Make it work with the new and old version of the package,
 831                 // but don't use the compatibility option since it is
 832                 // incompatible to other packages.
 833                 packages << "\\usepackage{nomencl}\n"
 834                             "% the following is useful when we have the old nomencl.sty package\n"
 835                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
 836                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
 837                             "\\makenomenclature\n";
 838         }
 839
 840         // fixltx2e provides subscript
 841         if (mustProvide("subscript") && !isRequired("fixltx2e"))
 842                 packages << "\\usepackage{subscript}\n";
 843
 844         return packages.str();
 845 }
 846
 847
 848 string LaTeXFeatures::getPreambleSnippets() const
 849 {
 850         ostringstream snip;
 851         SnippetList::const_iterator pit  = preamble_snippets_.begin();
 852         SnippetList::const_iterator pend = preamble_snippets_.end();
 853         for (; pit != pend; ++pit)
 854                 snip << *pit << '\n';
 855         return snip.str();
 856 }
 857
 858
 859 docstring const LaTeXFeatures::getMacros() const
 860 {
 861         odocstringstream macros;
 862
 863         if (!preamble_snippets_.empty()) {
 864                 macros << '\n';
 865                 macros << from_utf8(getPreambleSnippets());
 866         }
 867
 868         if (mustProvide("papersize")) {
 869                 if (runparams_.flavor == OutputParams::LATEX)
 870                         macros << papersizedvi_def << '\n';
 871                 else
 872                         macros << papersizepdf_def << '\n';
 873         }
 874
 875         if (mustProvide("LyX")) {
 876                 if (isRequired("hyperref"))
 877                         macros << lyx_hyperref_def << '\n';
 878                 else
 879                         macros << lyx_def << '\n';
 880         }
 881
 882         if (mustProvide("noun"))
 883                 macros << noun_def << '\n';
 884
 885         if (mustProvide("lyxarrow"))
 886                 macros << lyxarrow_def << '\n';
 887
 888         if (!usePolyglossia() && mustProvide("textgreek")) {
 889                 // Avoid a LaTeX error if times fonts are used and the grtimes
 890                 // package is installed but actual fonts are not (bug 6469).
 891                 if (params_.fonts_roman == "times")
 892                         macros << subst(textgreek_def,
 893                                         from_ascii("\\greektext #1"),
 894                                         from_ascii("%\n  \\IfFileExists"
 895                                                    "{grtm10.tfm}{}{\\fontfamily"
 896                                                    "{cmr}}\\greektext #1"))
 897                                << '\n';
 898                 else
 899                         macros << textgreek_def << '\n';
 900         }
 901
 902         if (!usePolyglossia() && mustProvide("textcyr"))
 903                 macros << textcyr_def << '\n';
 904
 905         if (mustProvide("lyxmathsym"))
 906                 macros << lyxmathsym_def << '\n';
 907
 908         if (mustProvide("cedilla"))
 909                 macros << cedilla_def << '\n';
 910
 911         if (mustProvide("subring"))
 912                 macros << subring_def << '\n';
 913
 914         if (mustProvide("subdot"))
 915                 macros << subdot_def << '\n';
 916
 917         if (mustProvide("subhat"))
 918                 macros << subhat_def << '\n';
 919
 920         if (mustProvide("subtilde"))
 921                 macros << subtilde_def << '\n';
 922
 923         if (mustProvide("dacute"))
 924                 macros << dacute_def << '\n';
 925
 926         if (mustProvide("tipasymb"))
 927                 macros << tipasymb_def << '\n';
 928
 929         if (mustProvide("dgrave"))
 930                 macros << dgrave_def << '\n';
 931
 932         if (mustProvide("rcap"))
 933                 macros << rcap_def << '\n';
 934
 935         if (mustProvide("ogonek"))
 936                 macros << ogonek_def << '\n';
 937
 938         // quotes.
 939         if (mustProvide("quotesinglbase"))
 940                 macros << quotesinglbase_def << '\n';
 941         if (mustProvide("quotedblbase"))
 942                 macros << quotedblbase_def << '\n';
 943         if (mustProvide("guilsinglleft"))
 944                 macros << guilsinglleft_def << '\n';
 945         if (mustProvide("guilsinglright"))
 946                 macros << guilsinglright_def << '\n';
 947         if (mustProvide("guillemotleft"))
 948                 macros << guillemotleft_def << '\n';
 949         if (mustProvide("guillemotright"))
 950                 macros << guillemotright_def << '\n';
 951
 952         // Math mode
 953         if (mustProvide("binom") && !isRequired("amsmath"))
 954                 macros << binom_def << '\n';
 955         if (mustProvide("mathcircumflex"))
 956                 macros << mathcircumflex_def << '\n';
 957
 958         // other
 959         if (mustProvide("ParagraphLeftIndent"))
 960                 macros << paragraphleftindent_def;
 961         if (mustProvide("NeedLyXFootnoteCode"))
 962                 macros << floatingfootnote_def;
 963
 964         // some problems with tex->html converters
 965         if (mustProvide("NeedTabularnewline"))
 966                 macros << tabularnewline_def;
 967
 968         // greyed-out environment (note inset)
 969         // the color is specified in the routine
 970         // getColorOptions() to avoid LaTeX-package clashes
 971         if (mustProvide("lyxgreyedout"))
 972                 macros << lyxgreyedout_def;
 973
 974         if (mustProvide("lyxdot"))
 975                 macros << lyxdot_def << '\n';
 976
 977         // floats
 978         getFloatDefinitions(macros);
 979
 980         if (mustProvide("refstyle"))
 981                 macros << lyxref_def << '\n';
 982
 983         // change tracking
 984         if (mustProvide("ct-dvipost"))
 985                 macros << changetracking_dvipost_def;
 986
 987         if (mustProvide("ct-xcolor-ulem")) {
 988                 streamsize const prec = macros.precision(2);
 989
 990                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
 991                 macros << "\\providecolor{lyxadded}{rgb}{"
 992                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
 993
 994                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
 995                 macros << "\\providecolor{lyxdeleted}{rgb}{"
 996                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
 997
 998                 macros.precision(prec);
 999
1000                 if (isRequired("hyperref"))
1001                         macros << changetracking_xcolor_ulem_hyperref_def;
1002                 else
1003                         macros << changetracking_xcolor_ulem_def;
1004         }
1005
1006         if (mustProvide("ct-none"))
1007                 macros << changetracking_none_def;
1008
1009         return macros.str();
1010 }
1011
1012
1013 string const LaTeXFeatures::getBabelPresettings() const
1014 {
1015         ostringstream tmp;
1016
1017         LanguageList::const_iterator it  = UsedLanguages_.begin();
1018         LanguageList::const_iterator end = UsedLanguages_.end();
1019         for (; it != end; ++it)
1020                 if (!(*it)->babel_presettings().empty())
1021                         tmp << (*it)->babel_presettings() << '\n';
1022         if (!params_.language->babel_presettings().empty())
1023                 tmp << params_.language->babel_presettings() << '\n';
1024
1025         return tmp.str();
1026 }
1027
1028
1029 string const LaTeXFeatures::getBabelPostsettings() const
1030 {
1031         ostringstream tmp;
1032
1033         LanguageList::const_iterator it  = UsedLanguages_.begin();
1034         LanguageList::const_iterator end = UsedLanguages_.end();
1035         for (; it != end; ++it)
1036                 if (!(*it)->babel_postsettings().empty())
1037                         tmp << (*it)->babel_postsettings() << '\n';
1038         if (!params_.language->babel_postsettings().empty())
1039                 tmp << params_.language->babel_postsettings() << '\n';
1040
1041         return tmp.str();
1042 }
1043
1044
1045 bool LaTeXFeatures::needBabelLangOptions() const
1046 {
1047         if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1048                 return true;
1049
1050         LanguageList::const_iterator it  = UsedLanguages_.begin();
1051         LanguageList::const_iterator end = UsedLanguages_.end();
1052         for (; it != end; ++it)
1053                 if ((*it)->asBabelOptions())
1054                         return true;
1055
1056         return false;
1057 }
1058
1059
1060 string const LaTeXFeatures::loadAMSPackages() const
1061 {
1062         ostringstream tmp;
1063         if (mustProvide("amsthm"))
1064                 tmp << "\\usepackage{amsthm}\n";
1065
1066         if (mustProvide("amsmath")
1067             && params_.use_amsmath != BufferParams::package_off) {
1068                 tmp << "\\usepackage{amsmath}\n";
1069         } else {
1070                 // amsbsy and amstext are already provided by amsmath
1071                 if (mustProvide("amsbsy"))
1072                         tmp << "\\usepackage{amsbsy}\n";
1073                 if (mustProvide("amstext"))
1074                         tmp << "\\usepackage{amstext}\n";
1075         }
1076
1077         if (mustProvide("amssymb")
1078             || params_.use_amsmath == BufferParams::package_on)
1079                 tmp << "\\usepackage{amssymb}\n";
1080
1081         return tmp.str();
1082 }
1083
1084
1085 docstring const LaTeXFeatures::getTClassPreamble() const
1086 {
1087         // the text class specific preamble
1088         DocumentClass const & tclass = params_.documentClass();
1089         odocstringstream tcpreamble;
1090
1091         tcpreamble << tclass.preamble();
1092
1093         list<docstring>::const_iterator cit = usedLayouts_.begin();
1094         list<docstring>::const_iterator end = usedLayouts_.end();
1095         for (; cit != end; ++cit)
1096                 tcpreamble << tclass[*cit].preamble();
1097
1098         cit = usedInsetLayouts_.begin();
1099         end = usedInsetLayouts_.end();
1100         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1101         for (; cit != end; ++cit) {
1102                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1103                 if (it == ils.end())
1104                         continue;
1105                 tcpreamble << it->second.preamble();
1106         }
1107
1108         return tcpreamble.str();
1109 }
1110
1111
1112 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1113 {
1114         DocumentClass const & tclass = params_.documentClass();
1115         odocstringstream tcpreamble;
1116
1117         tcpreamble << tclass.htmlpreamble();
1118
1119         list<docstring>::const_iterator cit = usedLayouts_.begin();
1120         list<docstring>::const_iterator end = usedLayouts_.end();
1121         for (; cit != end; ++cit)
1122                 tcpreamble << tclass[*cit].htmlpreamble();
1123
1124         cit = usedInsetLayouts_.begin();
1125         end = usedInsetLayouts_.end();
1126         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1127         for (; cit != end; ++cit) {
1128                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1129                 if (it == ils.end())
1130                         continue;
1131                 tcpreamble << it->second.htmlpreamble();
1132         }
1133
1134         return tcpreamble.str();
1135 }
1136
1137
1138 docstring const LaTeXFeatures::getTClassHTMLStyles() const {
1139         DocumentClass const & tclass = params_.documentClass();
1140         odocstringstream tcpreamble;
1141
1142         list<docstring>::const_iterator cit = usedLayouts_.begin();
1143         list<docstring>::const_iterator end = usedLayouts_.end();
1144         for (; cit != end; ++cit)
1145                 tcpreamble << tclass[*cit].htmlstyle();
1146
1147         cit = usedInsetLayouts_.begin();
1148         end = usedInsetLayouts_.end();
1149         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1150         for (; cit != end; ++cit) {
1151                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1152                 if (it == ils.end())
1153                         continue;
1154                 tcpreamble << it->second.htmlstyle();
1155         }
1156
1157         return tcpreamble.str();
1158 }
1159
1160
1161 namespace {
1162 docstring const getFloatI18nPreamble(docstring const & type,
1163                         docstring const & name, Language const * lang,
1164                         Encoding const & enc, bool const polyglossia)
1165 {
1166         docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1167                                                : from_ascii(lang->babel());
1168         docstring const langenc = from_ascii(lang->encoding()->iconvName());
1169         docstring const texenc = from_ascii(lang->encoding()->latexName());
1170         docstring const bufenc = from_ascii(enc.iconvName());
1171         docstring const s1 = docstring(1, 0xF0000);
1172         docstring const s2 = docstring(1, 0xF0001);
1173         docstring const translated = (langenc == bufenc) ? name
1174                 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1175                         + s1 + langenc + s2 + translated + s1 + bufenc + s2;
1176
1177         odocstringstream os;
1178         os << "\\addto\\captions" << language
1179            << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1180         return os.str();
1181 }
1182 }
1183
1184
1185 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1186 {
1187         DocumentClass const & tclass = params_.documentClass();
1188         // collect preamble snippets in a set to prevent multiple identical
1189         // commands (would happen if e.g. both theorem and theorem* are used)
1190         set<docstring> snippets;
1191         typedef LanguageList::const_iterator lang_it;
1192         lang_it const lbeg = UsedLanguages_.begin();
1193         lang_it const lend =  UsedLanguages_.end();
1194         list<docstring>::const_iterator cit = usedLayouts_.begin();
1195         list<docstring>::const_iterator end = usedLayouts_.end();
1196         for (; cit != end; ++cit) {
1197                 // language dependent commands (once per document)
1198                 snippets.insert(tclass[*cit].langpreamble(buffer().language(),
1199                                                 buffer().params().encoding(),
1200                                                 use_polyglossia));
1201                 // commands for language changing (for multilanguage documents)
1202                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1203                         snippets.insert(tclass[*cit].babelpreamble(
1204                                                 buffer().language(),
1205                                                 buffer().params().encoding(),
1206                                                 use_polyglossia));
1207                         for (lang_it lit = lbeg; lit != lend; ++lit)
1208                                 snippets.insert(tclass[*cit].babelpreamble(
1209                                                 *lit,
1210                                                 buffer().params().encoding(),
1211                                                 use_polyglossia));
1212                 }
1213         }
1214         if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1215                 FloatList const & floats = params_.documentClass().floats();
1216                 UsedFloats::const_iterator fit = usedFloats_.begin();
1217                 UsedFloats::const_iterator fend = usedFloats_.end();
1218                 for (; fit != fend; ++fit) {
1219                         Floating const & fl = floats.getType(fit->first);
1220                         // we assume builtin floats are translated
1221                         if (fl.isPredefined())
1222                                 continue;
1223                         docstring const type = from_ascii(fl.floattype());
1224                         docstring const flname = from_utf8(fl.name());
1225                         docstring name = buffer().language()->translateLayout(fl.name());
1226                         // only request translation if we have a real translation
1227                         // (that differs from the source)
1228                         if (flname != name)
1229                                 snippets.insert(getFloatI18nPreamble(
1230                                                 type, name, buffer().language(),
1231                                                 buffer().params().encoding(),
1232                                                 use_polyglossia));
1233                         for (lang_it lit = lbeg; lit != lend; ++lit) {
1234                                 string const code = (*lit)->code();
1235                                 name = (*lit)->translateLayout(fl.name());
1236                                 // we assume we have a suitable translation if
1237                                 // either the language is English (we need to
1238                                 // translate into English if English is a secondary
1239                                 // language) or if translateIfPossible returns
1240                                 // something different to the English source.
1241                                 bool const have_translation =
1242                                         (flname != name || contains(code, "en"));
1243                                 if (have_translation)
1244                                         snippets.insert(getFloatI18nPreamble(
1245                                                 type, name, *lit,
1246                                                 buffer().params().encoding(),
1247                                                 use_polyglossia));
1248                         }
1249                 }
1250         }
1251
1252         odocstringstream tcpreamble;
1253         set<docstring>::const_iterator const send = snippets.end();
1254         set<docstring>::const_iterator it = snippets.begin();
1255         for (; it != send; ++it)
1256                 tcpreamble << *it;
1257         return tcpreamble.str();
1258 }
1259
1260
1261 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1262 {
1263         // Definition of entities used in the document that are LyX related.
1264         odocstringstream entities;
1265
1266         if (mustProvide("lyxarrow")) {
1267                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
1268         }
1269
1270         return entities.str();
1271 }
1272
1273
1274 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1275 {
1276         odocstringstream sgmlpreamble;
1277         // FIXME UNICODE
1278         docstring const basename(from_utf8(onlyPath(fname)));
1279
1280         FileMap::const_iterator end = IncludedFiles_.end();
1281         for (FileMap::const_iterator fi = IncludedFiles_.begin();
1282              fi != end; ++fi)
1283                 // FIXME UNICODE
1284                 sgmlpreamble << "\n<!ENTITY " << fi->first
1285                              << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1286                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
1287
1288         return sgmlpreamble.str();
1289 }
1290
1291
1292 void LaTeXFeatures::showStruct() const
1293 {
1294         lyxerr << "LyX needs the following commands when LaTeXing:"
1295                << "\n***** Packages:" << getPackages()
1296                << "\n***** Macros:" << to_utf8(getMacros())
1297                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1298                << "\n***** done." << endl;
1299 }
1300
1301
1302 Buffer const & LaTeXFeatures::buffer() const
1303 {
1304         return *buffer_;
1305 }
1306
1307
1308 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1309 {
1310         buffer_ = &buffer;
1311 }
1312
1313
1314 BufferParams const & LaTeXFeatures::bufferParams() const
1315 {
1316         return params_;
1317 }
1318
1319
1320 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1321 {
1322         FloatList const & floats = params_.documentClass().floats();
1323
1324         // Here we will output the code to create the needed float styles.
1325         // We will try to do this as minimal as possible.
1326         // \floatstyle{ruled}
1327         // \newfloat{algorithm}{htbp}{loa}
1328         // \providecommand{\algorithmname}{Algorithm}
1329         // \floatname{algorithm}{\protect\algorithmname}
1330         UsedFloats::const_iterator cit = usedFloats_.begin();
1331         UsedFloats::const_iterator end = usedFloats_.end();
1332         for (; cit != end; ++cit) {
1333                 Floating const & fl = floats.getType(cit->first);
1334
1335                 // For builtin floats we do nothing.
1336                 if (fl.isPredefined())
1337                         continue;
1338
1339                 // We have to special case "table" and "figure"
1340                 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1341                         // Output code to modify "table" or "figure"
1342                         // but only if builtin == false
1343                         // and that have to be true at this point in the
1344                         // function.
1345                         docstring const type = from_ascii(fl.floattype());
1346                         docstring const placement = from_ascii(fl.placement());
1347                         docstring const style = from_ascii(fl.style());
1348                         if (!style.empty()) {
1349                                 os << "\\floatstyle{" << style << "}\n"
1350                                    << "\\restylefloat{" << type << "}\n";
1351                         }
1352                         if (!placement.empty()) {
1353                                 os << "\\floatplacement{" << type << "}{"
1354                                    << placement << "}\n";
1355                         }
1356                 } else {
1357                         // The other non builtin floats.
1358
1359                         docstring const type = from_ascii(fl.floattype());
1360                         docstring const placement = from_ascii(fl.placement());
1361                         docstring const ext = from_ascii(fl.ext());
1362                         docstring const within = from_ascii(fl.within());
1363                         docstring const style = from_ascii(fl.style());
1364                         docstring const name =
1365                                 buffer().language()->translateLayout(fl.name());
1366                         os << "\\floatstyle{" << style << "}\n"
1367                            << "\\newfloat{" << type << "}{" << placement
1368                            << "}{" << ext << '}';
1369                         if (!within.empty())
1370                                 os << '[' << within << ']';
1371                         os << '\n'
1372                            << "\\providecommand{\\" << type << "name}{"
1373                            << name << "}\n"
1374                            << "\\floatname{" << type << "}{\\protect\\"
1375                            << type << "name}\n";
1376
1377                         // What missing here is to code to minimalize the code
1378                         // output so that the same floatstyle will not be
1379                         // used several times, when the same style is still in
1380                         // effect. (Lgb)
1381                 }
1382                 if (cit->second)
1383                         os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";
1384         }
1385 }
1386
1387
1388 void LaTeXFeatures::resolveAlternatives()
1389 {
1390         for (Features::iterator it = features_.begin(); it != features_.end();) {
1391                 if (contains(*it, '|')) {
1392                         vector<string> const alternatives = getVectorFromString(*it, "|");
1393                         vector<string>::const_iterator const end = alternatives.end();
1394                         vector<string>::const_iterator ita = alternatives.begin();
1395                         for (; ita != end; ++ita) {
1396                                 if (isRequired(*ita))
1397                                         break;
1398                         }
1399                         if (ita == end)
1400                                 require(alternatives.front());
1401                         features_.erase(it);
1402                         it = features_.begin();
1403                 } else
1404                         ++it;
1405         }
1406 }
1407
1408
1409 } // namespace lyx