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