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