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