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         "pxfonts",
 603         "mathdesign",
 604         "mathrsfs",
 605         "mathabx",
 606         "ascii",
 607         "url",
 608         "covington",
 609         "csquotes",
 610         "enumitem",
 611         "endnotes",
 612         "hhline",
 613         "ifthen",
 614         // listings is handled in BufferParams.cpp
 615         "bm",
 616         "pdfpages",
 617         "amscd",
 618         "slashed",
 619         "multirow",
 620         "tfrupee"
 621 };
 622
 623 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 624
 625 }
 626
 627
 628 string const LaTeXFeatures::getColorOptions() const
 629 {
 630         ostringstream colors;
 631
 632         // Handling the color packages separately is needed to be able to load them
 633         // before babel when hyperref is loaded with the colorlinks option
 634         // for more info see Bufferparams.cpp
 635
 636         // [x]color.sty
 637         if (mustProvide("color") || mustProvide("xcolor")) {
 638                 string const package =
 639                         (mustProvide("xcolor") ? "xcolor" : "color");
 640                 if (params_.graphics_driver == "default"
 641                         || params_.graphics_driver == "none")
 642                         colors << "\\usepackage{" << package << "}\n";
 643                 else
 644                         colors << "\\usepackage["
 645                                  << params_.graphics_driver
 646                                  << "]{" << package << "}\n";
 647         }
 648
 649         // pdfcolmk must be loaded after color
 650         if (mustProvide("pdfcolmk"))
 651                 colors << "\\usepackage{pdfcolmk}\n";
 652
 653         // the following 3 color commands must be set after color
 654         // is loaded and before pdfpages, therefore add the command
 655         // here define the set color
 656         if (mustProvide("pagecolor")) {
 657                 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
 658                 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
 659                 // set the page color
 660                 colors << "\\pagecolor{page_backgroundcolor}\n";
 661         }
 662
 663         if (mustProvide("fontcolor")) {
 664                 colors << "\\definecolor{document_fontcolor}{rgb}{";
 665                 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
 666                 // set the color
 667                 colors << "\\color{document_fontcolor}\n";
 668         }
 669
 670         if (mustProvide("lyxgreyedout")) {
 671                 colors << "\\definecolor{note_fontcolor}{rgb}{";
 672                 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
 673                 // the color will be set together with the definition of
 674                 // the lyxgreyedout environment (see lyxgreyedout_def)
 675         }
 676
 677         // color for shaded boxes
 678         if (isRequired("framed") && mustProvide("color")) {
 679                 colors << "\\definecolor{shadecolor}{rgb}{";
 680                 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
 681                 // this color is automatically used by the LaTeX-package "framed"
 682         }
 683
 684         return colors.str();
 685 }
 686
 687
 688 string const LaTeXFeatures::getPackages() const
 689 {
 690         ostringstream packages;
 691         DocumentClass const & tclass = params_.documentClass();
 692
 693         // FIXME: currently, we can only load packages and macros known
 694         // to LyX.
 695         // However, with the Require tag of layouts/custom insets,
 696         // also unknown packages can be requested. They are silently
 697         // swallowed now. We should change this eventually.
 698
 699         //
 700         //  These are all the 'simple' includes.  i.e
 701         //  packages which we just \usepackage{package}
 702         //
 703         for (int i = 0; i < nb_simplefeatures; ++i) {
 704                 if (mustProvide(simplefeatures[i]))
 705                         packages << "\\usepackage{"
 706                                  << simplefeatures[i] << "}\n";
 707         }
 708
 709         //
 710         // The rest of these packages are somewhat more complicated
 711         // than those above.
 712         //
 713
 714         // if fontspec is used, AMS packages have to be loaded before
 715         // fontspec (in BufferParams)
 716         string const amsPackages = loadAMSPackages();
 717         if (!params_.useNonTeXFonts && !amsPackages.empty())
 718                 packages << amsPackages;
 719
 720         // fixltx2e must be loaded after amsthm, since amsthm produces an error with
 721         // the redefined \[ command (bug 7233). Load is as early as possible, since
 722         // other packages might profit from it.
 723         if (mustProvide("fixltx2e"))
 724                 packages << "\\usepackage{fixltx2e}\n";
 725
 726         // wasysym is a simple feature, but it must be after amsmath if both
 727         // are used
 728         // wasysym redefines some integrals (e.g. iint) from amsmath. That
 729         // leads to inconsistent integrals. We only load this package if
 730         // the document does not contain integrals (then isRequired("esint")
 731         // is false) or if esint is used, since esint redefines all relevant
 732         // integral symbols from wasysym and amsmath.
 733         // See http://www.lyx.org/trac/ticket/1942
 734         if (mustProvide("wasysym") &&
 735             (params_.use_esint != BufferParams::package_off || !isRequired("esint")))
 736                 packages << "\\usepackage{wasysym}\n";
 737
 738         // accents must be loaded after amsmath
 739         if (mustProvide("accents"))
 740                 packages << "\\usepackage{accents}\n";
 741
 742         // mathdots must be loaded after amsmath
 743         if (mustProvide("mathdots") &&
 744                 params_.use_mathdots != BufferParams::package_off)
 745                 packages << "\\usepackage{mathdots}\n";
 746
 747         // yhmath must be loaded after amsmath
 748         if (mustProvide("yhmath"))
 749                 packages << "\\usepackage{yhmath}\n";
 750
 751         if (mustProvide("undertilde") &&
 752                 params_.use_undertilde != BufferParams::package_off)
 753                 packages << "\\usepackage{undertilde}\n";
 754
 755         // [x]color and pdfcolmk are handled in getColorOptions() above
 756
 757         // makeidx.sty
 758         if (isRequired("makeidx") || isRequired("splitidx")) {
 759                 if (!tclass.provides("makeidx") && !isRequired("splitidx"))
 760                         packages << "\\usepackage{makeidx}\n";
 761                 if (!tclass.provides("splitidx") && isRequired("splitidx"))
 762                         packages << "\\usepackage{splitidx}\n";
 763                 packages << "\\makeindex\n";
 764         }
 765
 766         // graphicx.sty
 767         if (mustProvide("graphicx") && params_.graphics_driver != "none") {
 768                 if (params_.graphics_driver == "default")
 769                         packages << "\\usepackage{graphicx}\n";
 770                 else
 771                         packages << "\\usepackage["
 772                                  << params_.graphics_driver
 773                                  << "]{graphicx}\n";
 774         }
 775
 776         // lyxskak.sty --- newer chess support based on skak.sty
 777         if (mustProvide("chess"))
 778                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
 779
 780         // setspace.sty
 781         if (mustProvide("setspace") && !tclass.provides("SetSpace"))
 782                 packages << "\\usepackage{setspace}\n";
 783
 784         // esint must be after amsmath and wasysym, since it will redeclare
 785         // inconsistent integral symbols
 786         if (mustProvide("esint") &&
 787             params_.use_esint != BufferParams::package_off)
 788                 packages << "\\usepackage{esint}\n";
 789
 790         // natbib.sty
 791         // Some classes load natbib themselves, but still allow (or even require)
 792         // plain numeric citations (ReVTeX is such a case, see bug 5182).
 793         // This special case is indicated by the "natbib-internal" key.
 794         if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
 795                 packages << "\\usepackage[";
 796                 if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
 797                         packages << "numbers";
 798                 else
 799                         packages << "authoryear";
 800                 packages << "]{natbib}\n";
 801         }
 802
 803         // jurabib -- we need version 0.6 at least.
 804         if (mustProvide("jurabib"))
 805                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
 806
 807         // xargs -- we need version 1.09 at least
 808         if (mustProvide("xargs"))
 809                 packages << "\\usepackage{xargs}[2008/03/08]\n";
 810
 811         // bibtopic -- the dot provides the aux file naming which
 812         // LyX can detect.
 813         if (mustProvide("bibtopic"))
 814                 packages << "\\usepackage[dot]{bibtopic}\n";
 815
 816         if (mustProvide("xy"))
 817                 packages << "\\usepackage[all]{xy}\n";
 818
 819         if (mustProvide("feyn"))
 820                 packages << "\\usepackage{feyn}\n"; //Diagram
 821
 822         if (mustProvide("ulem"))
 823                 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
 824                             "\\usepackage{ulem}\n";
 825
 826         if (params_.use_mhchem == BufferParams::package_on ||
 827             (mustProvide("mhchem") &&
 828              params_.use_mhchem != BufferParams::package_off))
 829                 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
 830                             "\\usepackage{mhchem}\n";
 831
 832         if (mustProvide("nomencl")) {
 833                 // Make it work with the new and old version of the package,
 834                 // but don't use the compatibility option since it is
 835                 // incompatible to other packages.
 836                 packages << "\\usepackage{nomencl}\n"
 837                             "% the following is useful when we have the old nomencl.sty package\n"
 838                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
 839                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
 840                             "\\makenomenclature\n";
 841         }
 842
 843         // fixltx2e provides subscript
 844         if (mustProvide("subscript") && !isRequired("fixltx2e"))
 845                 packages << "\\usepackage{subscript}\n";
 846
 847         return packages.str();
 848 }
 849
 850
 851 string LaTeXFeatures::getPreambleSnippets() const
 852 {
 853         ostringstream snip;
 854         SnippetList::const_iterator pit  = preamble_snippets_.begin();
 855         SnippetList::const_iterator pend = preamble_snippets_.end();
 856         for (; pit != pend; ++pit)
 857                 snip << *pit << '\n';
 858         return snip.str();
 859 }
 860
 861
 862 docstring const LaTeXFeatures::getMacros() const
 863 {
 864         odocstringstream macros;
 865
 866         if (!preamble_snippets_.empty()) {
 867                 macros << '\n';
 868                 macros << from_utf8(getPreambleSnippets());
 869         }
 870
 871         if (mustProvide("papersize")) {
 872                 if (runparams_.flavor == OutputParams::LATEX)
 873                         macros << papersizedvi_def << '\n';
 874                 else
 875                         macros << papersizepdf_def << '\n';
 876         }
 877
 878         if (mustProvide("LyX")) {
 879                 if (isRequired("hyperref"))
 880                         macros << lyx_hyperref_def << '\n';
 881                 else
 882                         macros << lyx_def << '\n';
 883         }
 884
 885         if (mustProvide("noun"))
 886                 macros << noun_def << '\n';
 887
 888         if (mustProvide("lyxarrow"))
 889                 macros << lyxarrow_def << '\n';
 890
 891         if (!usePolyglossia() && mustProvide("textgreek")) {
 892                 // Avoid a LaTeX error if times fonts are used and the grtimes
 893                 // package is installed but actual fonts are not (bug 6469).
 894                 if (params_.fonts_roman == "times")
 895                         macros << subst(textgreek_def,
 896                                         from_ascii("\\greektext #1"),
 897                                         from_ascii("%\n  \\IfFileExists"
 898                                                    "{grtm10.tfm}{}{\\fontfamily"
 899                                                    "{cmr}}\\greektext #1"))
 900                                << '\n';
 901                 else
 902                         macros << textgreek_def << '\n';
 903         }
 904
 905         if (!usePolyglossia() && mustProvide("textcyr"))
 906                 macros << textcyr_def << '\n';
 907
 908         if (mustProvide("lyxmathsym"))
 909                 macros << lyxmathsym_def << '\n';
 910
 911         if (mustProvide("cedilla"))
 912                 macros << cedilla_def << '\n';
 913
 914         if (mustProvide("subring"))
 915                 macros << subring_def << '\n';
 916
 917         if (mustProvide("subdot"))
 918                 macros << subdot_def << '\n';
 919
 920         if (mustProvide("subhat"))
 921                 macros << subhat_def << '\n';
 922
 923         if (mustProvide("subtilde"))
 924                 macros << subtilde_def << '\n';
 925
 926         if (mustProvide("dacute"))
 927                 macros << dacute_def << '\n';
 928
 929         if (mustProvide("tipasymb"))
 930                 macros << tipasymb_def << '\n';
 931
 932         if (mustProvide("dgrave"))
 933                 macros << dgrave_def << '\n';
 934
 935         if (mustProvide("rcap"))
 936                 macros << rcap_def << '\n';
 937
 938         if (mustProvide("ogonek"))
 939                 macros << ogonek_def << '\n';
 940
 941         // quotes.
 942         if (mustProvide("quotesinglbase"))
 943                 macros << quotesinglbase_def << '\n';
 944         if (mustProvide("quotedblbase"))
 945                 macros << quotedblbase_def << '\n';
 946         if (mustProvide("guilsinglleft"))
 947                 macros << guilsinglleft_def << '\n';
 948         if (mustProvide("guilsinglright"))
 949                 macros << guilsinglright_def << '\n';
 950         if (mustProvide("guillemotleft"))
 951                 macros << guillemotleft_def << '\n';
 952         if (mustProvide("guillemotright"))
 953                 macros << guillemotright_def << '\n';
 954
 955         // Math mode
 956         if (mustProvide("binom") && !isRequired("amsmath"))
 957                 macros << binom_def << '\n';
 958         if (mustProvide("mathcircumflex"))
 959                 macros << mathcircumflex_def << '\n';
 960
 961         // other
 962         if (mustProvide("ParagraphLeftIndent"))
 963                 macros << paragraphleftindent_def;
 964         if (mustProvide("NeedLyXFootnoteCode"))
 965                 macros << floatingfootnote_def;
 966
 967         // some problems with tex->html converters
 968         if (mustProvide("NeedTabularnewline"))
 969                 macros << tabularnewline_def;
 970
 971         // greyed-out environment (note inset)
 972         // the color is specified in the routine
 973         // getColorOptions() to avoid LaTeX-package clashes
 974         if (mustProvide("lyxgreyedout"))
 975                 macros << lyxgreyedout_def;
 976
 977         if (mustProvide("lyxdot"))
 978                 macros << lyxdot_def << '\n';
 979
 980         // floats
 981         getFloatDefinitions(macros);
 982
 983         if (mustProvide("refstyle"))
 984                 macros << lyxref_def << '\n';
 985
 986         // change tracking
 987         if (mustProvide("ct-dvipost"))
 988                 macros << changetracking_dvipost_def;
 989
 990         if (mustProvide("ct-xcolor-ulem")) {
 991                 streamsize const prec = macros.precision(2);
 992
 993                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
 994                 macros << "\\providecolor{lyxadded}{rgb}{"
 995                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
 996
 997                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
 998                 macros << "\\providecolor{lyxdeleted}{rgb}{"
 999                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1000
1001                 macros.precision(prec);
1002
1003                 if (isRequired("hyperref"))
1004                         macros << changetracking_xcolor_ulem_hyperref_def;
1005                 else
1006                         macros << changetracking_xcolor_ulem_def;
1007         }
1008
1009         if (mustProvide("ct-none"))
1010                 macros << changetracking_none_def;
1011
1012         return macros.str();
1013 }
1014
1015
1016 string const LaTeXFeatures::getBabelPresettings() const
1017 {
1018         ostringstream tmp;
1019
1020         LanguageList::const_iterator it  = UsedLanguages_.begin();
1021         LanguageList::const_iterator end = UsedLanguages_.end();
1022         for (; it != end; ++it)
1023                 if (!(*it)->babel_presettings().empty())
1024                         tmp << (*it)->babel_presettings() << '\n';
1025         if (!params_.language->babel_presettings().empty())
1026                 tmp << params_.language->babel_presettings() << '\n';
1027
1028         return tmp.str();
1029 }
1030
1031
1032 string const LaTeXFeatures::getBabelPostsettings() const
1033 {
1034         ostringstream tmp;
1035
1036         LanguageList::const_iterator it  = UsedLanguages_.begin();
1037         LanguageList::const_iterator end = UsedLanguages_.end();
1038         for (; it != end; ++it)
1039                 if (!(*it)->babel_postsettings().empty())
1040                         tmp << (*it)->babel_postsettings() << '\n';
1041         if (!params_.language->babel_postsettings().empty())
1042                 tmp << params_.language->babel_postsettings() << '\n';
1043
1044         return tmp.str();
1045 }
1046
1047
1048 bool LaTeXFeatures::needBabelLangOptions() const
1049 {
1050         if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1051                 return true;
1052
1053         LanguageList::const_iterator it  = UsedLanguages_.begin();
1054         LanguageList::const_iterator end = UsedLanguages_.end();
1055         for (; it != end; ++it)
1056                 if ((*it)->asBabelOptions())
1057                         return true;
1058
1059         return false;
1060 }
1061
1062
1063 string const LaTeXFeatures::loadAMSPackages() const
1064 {
1065         ostringstream tmp;
1066         if (mustProvide("amsthm"))
1067                 tmp << "\\usepackage{amsthm}\n";
1068
1069         if (mustProvide("amsmath")
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                         Encoding const & enc, bool const polyglossia)
1168 {
1169         docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1170                                                : from_ascii(lang->babel());
1171         docstring const langenc = from_ascii(lang->encoding()->iconvName());
1172         docstring const texenc = from_ascii(lang->encoding()->latexName());
1173         docstring const bufenc = from_ascii(enc.iconvName());
1174         docstring const s1 = docstring(1, 0xF0000);
1175         docstring const s2 = docstring(1, 0xF0001);
1176         docstring const translated = (langenc == bufenc) ? name
1177                 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1178                         + s1 + langenc + s2 + translated + s1 + bufenc + s2;
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                                                 buffer().params().encoding(),
1203                                                 use_polyglossia));
1204                 // commands for language changing (for multilanguage documents)
1205                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1206                         snippets.insert(tclass[*cit].babelpreamble(
1207                                                 buffer().language(),
1208                                                 buffer().params().encoding(),
1209                                                 use_polyglossia));
1210                         for (lang_it lit = lbeg; lit != lend; ++lit)
1211                                 snippets.insert(tclass[*cit].babelpreamble(
1212                                                 *lit,
1213                                                 buffer().params().encoding(),
1214                                                 use_polyglossia));
1215                 }
1216         }
1217         if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1218                 FloatList const & floats = params_.documentClass().floats();
1219                 UsedFloats::const_iterator fit = usedFloats_.begin();
1220                 UsedFloats::const_iterator fend = usedFloats_.end();
1221                 for (; fit != fend; ++fit) {
1222                         Floating const & fl = floats.getType(fit->first);
1223                         // we assume builtin floats are translated
1224                         if (fl.isPredefined())
1225                                 continue;
1226                         docstring const type = from_ascii(fl.floattype());
1227                         docstring const flname = from_utf8(fl.name());
1228                         docstring name = buffer().language()->translateLayout(fl.name());
1229                         // only request translation if we have a real translation
1230                         // (that differs from the source)
1231                         if (flname != name)
1232                                 snippets.insert(getFloatI18nPreamble(
1233                                                 type, name, buffer().language(),
1234                                                 buffer().params().encoding(),
1235                                                 use_polyglossia));
1236                         for (lang_it lit = lbeg; lit != lend; ++lit) {
1237                                 string const code = (*lit)->code();
1238                                 name = (*lit)->translateLayout(fl.name());
1239                                 // we assume we have a suitable translation if
1240                                 // either the language is English (we need to
1241                                 // translate into English if English is a secondary
1242                                 // language) or if translateIfPossible returns
1243                                 // something different to the English source.
1244                                 bool const have_translation =
1245                                         (flname != name || contains(code, "en"));
1246                                 if (have_translation)
1247                                         snippets.insert(getFloatI18nPreamble(
1248                                                 type, name, *lit,
1249                                                 buffer().params().encoding(),
1250                                                 use_polyglossia));
1251                         }
1252                 }
1253         }
1254
1255         odocstringstream tcpreamble;
1256         set<docstring>::const_iterator const send = snippets.end();
1257         set<docstring>::const_iterator it = snippets.begin();
1258         for (; it != send; ++it)
1259                 tcpreamble << *it;
1260         return tcpreamble.str();
1261 }
1262
1263
1264 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1265 {
1266         // Definition of entities used in the document that are LyX related.
1267         odocstringstream entities;
1268
1269         if (mustProvide("lyxarrow")) {
1270                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
1271         }
1272
1273         return entities.str();
1274 }
1275
1276
1277 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1278 {
1279         odocstringstream sgmlpreamble;
1280         // FIXME UNICODE
1281         docstring const basename(from_utf8(onlyPath(fname)));
1282
1283         FileMap::const_iterator end = IncludedFiles_.end();
1284         for (FileMap::const_iterator fi = IncludedFiles_.begin();
1285              fi != end; ++fi)
1286                 // FIXME UNICODE
1287                 sgmlpreamble << "\n<!ENTITY " << fi->first
1288                              << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1289                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
1290
1291         return sgmlpreamble.str();
1292 }
1293
1294
1295 void LaTeXFeatures::showStruct() const
1296 {
1297         lyxerr << "LyX needs the following commands when LaTeXing:"
1298                << "\n***** Packages:" << getPackages()
1299                << "\n***** Macros:" << to_utf8(getMacros())
1300                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1301                << "\n***** done." << endl;
1302 }
1303
1304
1305 Buffer const & LaTeXFeatures::buffer() const
1306 {
1307         return *buffer_;
1308 }
1309
1310
1311 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1312 {
1313         buffer_ = &buffer;
1314 }
1315
1316
1317 BufferParams const & LaTeXFeatures::bufferParams() const
1318 {
1319         return params_;
1320 }
1321
1322
1323 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1324 {
1325         FloatList const & floats = params_.documentClass().floats();
1326
1327         // Here we will output the code to create the needed float styles.
1328         // We will try to do this as minimal as possible.
1329         // \floatstyle{ruled}
1330         // \newfloat{algorithm}{htbp}{loa}
1331         // \providecommand{\algorithmname}{Algorithm}
1332         // \floatname{algorithm}{\protect\algorithmname}
1333         UsedFloats::const_iterator cit = usedFloats_.begin();
1334         UsedFloats::const_iterator end = usedFloats_.end();
1335         for (; cit != end; ++cit) {
1336                 Floating const & fl = floats.getType(cit->first);
1337
1338                 // For builtin floats we do nothing.
1339                 if (fl.isPredefined())
1340                         continue;
1341
1342                 // We have to special case "table" and "figure"
1343                 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1344                         // Output code to modify "table" or "figure"
1345                         // but only if builtin == false
1346                         // and that have to be true at this point in the
1347                         // function.
1348                         docstring const type = from_ascii(fl.floattype());
1349                         docstring const placement = from_ascii(fl.placement());
1350                         docstring const style = from_ascii(fl.style());
1351                         if (!style.empty()) {
1352                                 os << "\\floatstyle{" << style << "}\n"
1353                                    << "\\restylefloat{" << type << "}\n";
1354                         }
1355                         if (!placement.empty()) {
1356                                 os << "\\floatplacement{" << type << "}{"
1357                                    << placement << "}\n";
1358                         }
1359                 } else {
1360                         // The other non builtin floats.
1361
1362                         docstring const type = from_ascii(fl.floattype());
1363                         docstring const placement = from_ascii(fl.placement());
1364                         docstring const ext = from_ascii(fl.ext());
1365                         docstring const within = from_ascii(fl.within());
1366                         docstring const style = from_ascii(fl.style());
1367                         docstring const name =
1368                                 buffer().language()->translateLayout(fl.name());
1369                         os << "\\floatstyle{" << style << "}\n"
1370                            << "\\newfloat{" << type << "}{" << placement
1371                            << "}{" << ext << '}';
1372                         if (!within.empty())
1373                                 os << '[' << within << ']';
1374                         os << '\n'
1375                            << "\\providecommand{\\" << type << "name}{"
1376                            << name << "}\n"
1377                            << "\\floatname{" << type << "}{\\protect\\"
1378                            << type << "name}\n";
1379
1380                         // What missing here is to code to minimalize the code
1381                         // output so that the same floatstyle will not be
1382                         // used several times, when the same style is still in
1383                         // effect. (Lgb)
1384                 }
1385                 if (cit->second)
1386                         os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";
1387         }
1388 }
1389
1390
1391 void LaTeXFeatures::resolveAlternatives()
1392 {
1393         for (Features::iterator it = features_.begin(); it != features_.end();) {
1394                 if (contains(*it, '|')) {
1395                         vector<string> const alternatives = getVectorFromString(*it, "|");
1396                         vector<string>::const_iterator const end = alternatives.end();
1397                         vector<string>::const_iterator ita = alternatives.begin();
1398                         for (; ita != end; ++ita) {
1399                                 if (isRequired(*ita))
1400                                         break;
1401                         }
1402                         if (ita == end)
1403                                 require(alternatives.front());
1404                         features_.erase(it);
1405                         it = features_.begin();
1406                 } else
1407                         ++it;
1408         }
1409 }
1410
1411
1412 } // namespace lyx