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 char const * bibliofeatures[] = {
 720         // Known bibliography packages (will be loaded before natbib)
 721         "achicago",
 722         "apacite",
 723         "apalike",
 724         "astron",
 725         "authordate1-4",
 726         "chicago",
 727         "harvard",
 728         "mslapa",
 729         "named"
 730 };
 731
 732 int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
 733
 734 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 735
 736 }
 737
 738
 739 string const LaTeXFeatures::getColorOptions() const
 740 {
 741         ostringstream colors;
 742
 743         // Handling the color packages separately is needed to be able to load them
 744         // before babel when hyperref is loaded with the colorlinks option
 745         // for more info see Bufferparams.cpp
 746
 747         // [x]color.sty
 748         if (mustProvide("color") || mustProvide("xcolor")) {
 749                 string const package =
 750                         (mustProvide("xcolor") ? "xcolor" : "color");
 751                 if (params_.graphics_driver == "default"
 752                         || params_.graphics_driver == "none")
 753                         colors << "\\usepackage{" << package << "}\n";
 754                 else
 755                         colors << "\\usepackage["
 756                                  << params_.graphics_driver
 757                                  << "]{" << package << "}\n";
 758         }
 759
 760         // pdfcolmk must be loaded after color
 761         if (mustProvide("pdfcolmk"))
 762                 colors << "\\usepackage{pdfcolmk}\n";
 763
 764         // the following 3 color commands must be set after color
 765         // is loaded and before pdfpages, therefore add the command
 766         // here define the set color
 767         if (mustProvide("pagecolor")) {
 768                 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
 769                 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
 770                 // set the page color
 771                 colors << "\\pagecolor{page_backgroundcolor}\n";
 772         }
 773
 774         if (mustProvide("fontcolor")) {
 775                 colors << "\\definecolor{document_fontcolor}{rgb}{";
 776                 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
 777                 // set the color
 778                 colors << "\\color{document_fontcolor}\n";
 779         }
 780
 781         if (mustProvide("lyxgreyedout")) {
 782                 colors << "\\definecolor{note_fontcolor}{rgb}{";
 783                 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
 784                 // the color will be set together with the definition of
 785                 // the lyxgreyedout environment (see lyxgreyedout_def)
 786         }
 787
 788         // color for shaded boxes
 789         if (isRequired("framed") && mustProvide("color")) {
 790                 colors << "\\definecolor{shadecolor}{rgb}{";
 791                 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
 792                 // this color is automatically used by the LaTeX-package "framed"
 793         }
 794
 795         return colors.str();
 796 }
 797
 798
 799 string const LaTeXFeatures::getPackages() const
 800 {
 801         ostringstream packages;
 802
 803         // FIXME: currently, we can only load packages and macros known
 804         // to LyX.
 805         // However, with the Require tag of layouts/custom insets,
 806         // also unknown packages can be requested. They are silently
 807         // swallowed now. We should change this eventually.
 808
 809         //
 810         //  These are all the 'simple' includes.  i.e
 811         //  packages which we just \usepackage{package}
 812         //
 813         for (int i = 0; i < nb_simplefeatures; ++i) {
 814                 if (mustProvide(simplefeatures[i]))
 815                         packages << "\\usepackage{"
 816                                  << simplefeatures[i] << "}\n";
 817         }
 818
 819         //
 820         // The rest of these packages are somewhat more complicated
 821         // than those above.
 822         //
 823
 824         // if fontspec is used, AMS packages have to be loaded before
 825         // fontspec (in BufferParams)
 826         string const amsPackages = loadAMSPackages();
 827         if (!params_.useNonTeXFonts && !amsPackages.empty())
 828                 packages << amsPackages;
 829
 830         // fixltx2e must be loaded after amsthm, since amsthm produces an error with
 831         // the redefined \[ command (bug 7233). Load it as early as possible, since
 832         // other packages might profit from it.
 833         if (mustProvide("fixltx2e"))
 834                 packages << "\\usepackage{fixltx2e}\n";
 835
 836         if (mustProvide("cancel") &&
 837             params_.use_package("cancel") != BufferParams::package_off)
 838                 packages << "\\usepackage{cancel}\n";
 839         // wasysym is a simple feature, but it must be after amsmath if both
 840         // are used
 841         // wasysym redefines some integrals (e.g. iint) from amsmath. That
 842         // leads to inconsistent integrals. We only load this package if
 843         // the document does not contain integrals (then isRequired("esint")
 844         // is false) or if esint is used, since esint redefines all relevant
 845         // integral symbols from wasysym and amsmath.
 846         // See http://www.lyx.org/trac/ticket/1942
 847         if (mustProvide("wasysym") &&
 848             params_.use_package("wasysym") != BufferParams::package_off &&
 849             (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
 850                 packages << "\\usepackage{wasysym}\n";
 851
 852         // accents must be loaded after amsmath
 853         if (mustProvide("accents") &&
 854             params_.use_package("accents") != BufferParams::package_off)
 855                 packages << "\\usepackage{accents}\n";
 856
 857         // mathdots must be loaded after amsmath
 858         if (mustProvide("mathdots") &&
 859                 params_.use_package("mathdots") != BufferParams::package_off)
 860                 packages << "\\usepackage{mathdots}\n";
 861
 862         // yhmath must be loaded after amsmath
 863         if (mustProvide("yhmath") &&
 864             params_.use_package("yhmath") != BufferParams::package_off)
 865                 packages << "\\usepackage{yhmath}\n";
 866
 867         // stmaryrd must be loaded after amsmath
 868         if (mustProvide("stmaryrd") &&
 869             params_.use_package("stmaryrd") != BufferParams::package_off)
 870                 packages << "\\usepackage{stmaryrd}\n";
 871
 872         if (mustProvide("stackrel") &&
 873             params_.use_package("stackrel") != BufferParams::package_off)
 874                 packages << "\\usepackage{stackrel}\n";
 875
 876         if (mustProvide("undertilde") &&
 877                 params_.use_package("undertilde") != BufferParams::package_off)
 878                 packages << "\\usepackage{undertilde}\n";
 879
 880         // [x]color and pdfcolmk are handled in getColorOptions() above
 881
 882         // makeidx.sty
 883         if (isRequired("makeidx") || isRequired("splitidx")) {
 884                 if (!isProvided("makeidx") && !isRequired("splitidx"))
 885                         packages << "\\usepackage{makeidx}\n";
 886                 if (mustProvide("splitidx"))
 887                         packages << "\\usepackage{splitidx}\n";
 888                 packages << "\\makeindex\n";
 889         }
 890
 891         // graphicx.sty
 892         if (mustProvide("graphicx") && params_.graphics_driver != "none") {
 893                 if (params_.graphics_driver == "default")
 894                         packages << "\\usepackage{graphicx}\n";
 895                 else
 896                         packages << "\\usepackage["
 897                                  << params_.graphics_driver
 898                                  << "]{graphicx}\n";
 899         }
 900
 901         // lyxskak.sty --- newer chess support based on skak.sty
 902         if (mustProvide("chess"))
 903                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
 904
 905         // setspace.sty
 906         if (mustProvide("setspace") && !isProvided("SetSpace"))
 907                 packages << "\\usepackage{setspace}\n";
 908
 909         // esint must be after amsmath and wasysym, since it will redeclare
 910         // inconsistent integral symbols
 911         if (mustProvide("esint") &&
 912             params_.use_package("esint") != BufferParams::package_off)
 913                 packages << "\\usepackage{esint}\n";
 914
 915         // Known bibliography packages (simple \usepackage{package})
 916         for (int i = 0; i < nb_bibliofeatures; ++i) {
 917                 if (mustProvide(bibliofeatures[i]))
 918                         packages << "\\usepackage{"
 919                                  << bibliofeatures[i] << "}\n";
 920         }
 921
 922         // Compatibility between achicago and natbib
 923         if (mustProvide("achicago") && mustProvide("natbib"))
 924                 packages << "\\let\\achicagobib\\thebibliography\n";
 925
 926         // natbib.sty
 927         // Some classes load natbib themselves, but still allow (or even require)
 928         // plain numeric citations (ReVTeX is such a case, see bug 5182).
 929         // This special case is indicated by the "natbib-internal" key.
 930         if (mustProvide("natbib") && !isProvided("natbib-internal")) {
 931                 packages << "\\usepackage[";
 932                 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
 933                         packages << "numbers";
 934                 else
 935                         packages << "authoryear";
 936                 packages << "]{natbib}\n";
 937         }
 938
 939         // Compatibility between achicago and natbib
 940         if (mustProvide("achicago") && mustProvide("natbib")) {
 941                 packages << "\\let\\thebibliography\\achicagobib\n";
 942                 packages << "\\let\\SCcite\\astroncite\n";
 943                 packages << "\\let\\UnexpandableProtect\\protect\n";
 944         }
 945
 946         // jurabib -- we need version 0.6 at least.
 947         if (mustProvide("jurabib"))
 948                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
 949
 950         // xargs -- we need version 1.09 at least
 951         if (mustProvide("xargs"))
 952                 packages << "\\usepackage{xargs}[2008/03/08]\n";
 953
 954         if (mustProvide("xy"))
 955                 packages << "\\usepackage[all]{xy}\n";
 956
 957         if (mustProvide("feyn"))
 958                 packages << "\\usepackage{feyn}\n"; //Diagram
 959
 960         if (mustProvide("ulem"))
 961                 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
 962                             "\\usepackage{ulem}\n";
 963
 964         if (mustProvide("mhchem") &&
 965             params_.use_package("mhchem") != BufferParams::package_off)
 966                 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
 967                             "\\usepackage{mhchem}\n";
 968
 969         if (mustProvide("nomencl")) {
 970                 // Make it work with the new and old version of the package,
 971                 // but don't use the compatibility option since it is
 972                 // incompatible to other packages.
 973                 packages << "\\usepackage{nomencl}\n"
 974                             "% the following is useful when we have the old nomencl.sty package\n"
 975                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
 976                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
 977                             "\\makenomenclature\n";
 978         }
 979
 980         // fixltx2e provides subscript
 981         if (mustProvide("subscript") && !isRequired("fixltx2e"))
 982                 packages << "\\usepackage{subscript}\n";
 983
 984         return packages.str();
 985 }
 986
 987
 988 string LaTeXFeatures::getPreambleSnippets() const
 989 {
 990         ostringstream snip;
 991         SnippetList::const_iterator pit  = preamble_snippets_.begin();
 992         SnippetList::const_iterator pend = preamble_snippets_.end();
 993         for (; pit != pend; ++pit)
 994                 snip << *pit << '\n';
 995         return snip.str();
 996 }
 997
 998
 999 std::string LaTeXFeatures::getCSSSnippets() const
1000 {
1001         ostringstream snip;
1002         SnippetList::const_iterator pit  = css_snippets_.begin();
1003         SnippetList::const_iterator pend = css_snippets_.end();
1004         for (; pit != pend; ++pit)
1005                 snip << *pit << '\n';
1006         return snip.str();
1007 }
1008
1009
1010 docstring const LaTeXFeatures::getMacros() const
1011 {
1012         odocstringstream macros;
1013
1014         if (!preamble_snippets_.empty()) {
1015                 macros << '\n';
1016                 macros << from_utf8(getPreambleSnippets());
1017         }
1018
1019         if (mustProvide("papersize")) {
1020                 if (runparams_.flavor == OutputParams::LATEX)
1021                         macros << papersizedvi_def << '\n';
1022                 else
1023                         macros << papersizepdf_def << '\n';
1024         }
1025
1026         if (mustProvide("LyX")) {
1027                 if (isRequired("hyperref"))
1028                         macros << lyx_hyperref_def << '\n';
1029                 else
1030                         macros << lyx_def << '\n';
1031         }
1032
1033         if (mustProvide("noun"))
1034                 macros << noun_def << '\n';
1035
1036         if (mustProvide("lyxarrow"))
1037                 macros << lyxarrow_def << '\n';
1038
1039         if (!usePolyglossia() && mustProvide("textgreek")) {
1040                 // Avoid a LaTeX error if times fonts are used and the grtimes
1041                 // package is installed but actual fonts are not (bug 6469).
1042                 if (params_.fonts_roman == "times")
1043                         macros << subst(textgreek_def,
1044                                         from_ascii("\\greektext #1"),
1045                                         from_ascii("%\n  \\IfFileExists"
1046                                                    "{grtm10.tfm}{}{\\fontfamily"
1047                                                    "{cmr}}\\greektext #1"))
1048                                << '\n';
1049                 else
1050                         macros << textgreek_def << '\n';
1051         }
1052
1053         if (!usePolyglossia() && mustProvide("textcyr"))
1054                 macros << textcyr_def << '\n';
1055
1056         if (mustProvide("lyxmathsym"))
1057                 macros << lyxmathsym_def << '\n';
1058
1059         if (mustProvide("cedilla"))
1060                 macros << cedilla_def << '\n';
1061
1062         if (mustProvide("subring"))
1063                 macros << subring_def << '\n';
1064
1065         if (mustProvide("subdot"))
1066                 macros << subdot_def << '\n';
1067
1068         if (mustProvide("subhat"))
1069                 macros << subhat_def << '\n';
1070
1071         if (mustProvide("subtilde"))
1072                 macros << subtilde_def << '\n';
1073
1074         if (mustProvide("dacute"))
1075                 macros << dacute_def << '\n';
1076
1077         if (mustProvide("tipasymb"))
1078                 macros << tipasymb_def << '\n';
1079
1080         if (mustProvide("dgrave"))
1081                 macros << dgrave_def << '\n';
1082
1083         if (mustProvide("rcap"))
1084                 macros << rcap_def << '\n';
1085
1086         if (mustProvide("ogonek"))
1087                 macros << ogonek_def << '\n';
1088
1089         // quotes.
1090         if (mustProvide("quotesinglbase"))
1091                 macros << quotesinglbase_def << '\n';
1092         if (mustProvide("quotedblbase"))
1093                 macros << quotedblbase_def << '\n';
1094         if (mustProvide("guilsinglleft"))
1095                 macros << guilsinglleft_def << '\n';
1096         if (mustProvide("guilsinglright"))
1097                 macros << guilsinglright_def << '\n';
1098         if (mustProvide("guillemotleft"))
1099                 macros << guillemotleft_def << '\n';
1100         if (mustProvide("guillemotright"))
1101                 macros << guillemotright_def << '\n';
1102
1103         // Math mode
1104         if (mustProvide("binom") && !isRequired("amsmath"))
1105                 macros << binom_def << '\n';
1106         if (mustProvide("mathcircumflex"))
1107                 macros << mathcircumflex_def << '\n';
1108
1109         // other
1110         if (mustProvide("ParagraphLeftIndent"))
1111                 macros << paragraphleftindent_def;
1112         if (mustProvide("NeedLyXFootnoteCode"))
1113                 macros << floatingfootnote_def;
1114
1115         // some problems with tex->html converters
1116         if (mustProvide("NeedTabularnewline"))
1117                 macros << tabularnewline_def;
1118
1119         // greyed-out environment (note inset)
1120         // the color is specified in the routine
1121         // getColorOptions() to avoid LaTeX-package clashes
1122         if (mustProvide("lyxgreyedout"))
1123                 macros << lyxgreyedout_def;
1124
1125         if (mustProvide("lyxdot"))
1126                 macros << lyxdot_def << '\n';
1127
1128         // floats
1129         getFloatDefinitions(macros);
1130
1131         if (mustProvide("refstyle"))
1132                 macros << lyxref_def << '\n';
1133
1134         // change tracking
1135         if (mustProvide("ct-dvipost"))
1136                 macros << changetracking_dvipost_def;
1137
1138         if (mustProvide("ct-xcolor-ulem")) {
1139                 streamsize const prec = macros.precision(2);
1140
1141                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1142                 macros << "\\providecolor{lyxadded}{rgb}{"
1143                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1144
1145                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1146                 macros << "\\providecolor{lyxdeleted}{rgb}{"
1147                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1148
1149                 macros.precision(prec);
1150
1151                 if (isRequired("hyperref"))
1152                         macros << changetracking_xcolor_ulem_hyperref_def;
1153                 else
1154                         macros << changetracking_xcolor_ulem_def;
1155         }
1156
1157         if (mustProvide("ct-none"))
1158                 macros << changetracking_none_def;
1159
1160         if (mustProvide("rtloutputdblcol"))
1161                 macros << rtloutputdblcol_def;
1162
1163         return macros.str();
1164 }
1165
1166
1167 string const LaTeXFeatures::getBabelPresettings() const
1168 {
1169         ostringstream tmp;
1170
1171         LanguageList::const_iterator it  = UsedLanguages_.begin();
1172         LanguageList::const_iterator end = UsedLanguages_.end();
1173         for (; it != end; ++it)
1174                 if (!(*it)->babel_presettings().empty())
1175                         tmp << (*it)->babel_presettings() << '\n';
1176         if (!params_.language->babel_presettings().empty())
1177                 tmp << params_.language->babel_presettings() << '\n';
1178
1179         if (!contains(tmp.str(), '@'))
1180                 return tmp.str();
1181
1182         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1183 }
1184
1185
1186 string const LaTeXFeatures::getBabelPostsettings() const
1187 {
1188         ostringstream tmp;
1189
1190         LanguageList::const_iterator it  = UsedLanguages_.begin();
1191         LanguageList::const_iterator end = UsedLanguages_.end();
1192         for (; it != end; ++it)
1193                 if (!(*it)->babel_postsettings().empty())
1194                         tmp << (*it)->babel_postsettings() << '\n';
1195         if (!params_.language->babel_postsettings().empty())
1196                 tmp << params_.language->babel_postsettings() << '\n';
1197
1198         if (!contains(tmp.str(), '@'))
1199                 return tmp.str();
1200
1201         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1202 }
1203
1204
1205 bool LaTeXFeatures::needBabelLangOptions() const
1206 {
1207         if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1208                 return true;
1209
1210         LanguageList::const_iterator it  = UsedLanguages_.begin();
1211         LanguageList::const_iterator end = UsedLanguages_.end();
1212         for (; it != end; ++it)
1213                 if ((*it)->asBabelOptions())
1214                         return true;
1215
1216         return false;
1217 }
1218
1219
1220 string const LaTeXFeatures::loadAMSPackages() const
1221 {
1222         ostringstream tmp;
1223         if (mustProvide("amsthm"))
1224                 tmp << "\\usepackage{amsthm}\n";
1225
1226         if (mustProvide("amsmath")
1227             && params_.use_package("amsmath") != BufferParams::package_off) {
1228                 tmp << "\\usepackage{amsmath}\n";
1229         } else {
1230                 // amsbsy and amstext are already provided by amsmath
1231                 if (mustProvide("amsbsy"))
1232                         tmp << "\\usepackage{amsbsy}\n";
1233                 if (mustProvide("amstext"))
1234                         tmp << "\\usepackage{amstext}\n";
1235         }
1236
1237         if (mustProvide("amssymb")
1238             && params_.use_package("amssymb") != BufferParams::package_off)
1239                 tmp << "\\usepackage{amssymb}\n";
1240
1241         return tmp.str();
1242 }
1243
1244
1245 docstring const LaTeXFeatures::getTClassPreamble() const
1246 {
1247         // the text class specific preamble
1248         DocumentClass const & tclass = params_.documentClass();
1249         odocstringstream tcpreamble;
1250
1251         tcpreamble << tclass.preamble();
1252
1253         list<docstring>::const_iterator cit = usedLayouts_.begin();
1254         list<docstring>::const_iterator end = usedLayouts_.end();
1255         for (; cit != end; ++cit)
1256                 tcpreamble << tclass[*cit].preamble();
1257
1258         cit = usedInsetLayouts_.begin();
1259         end = usedInsetLayouts_.end();
1260         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1261         for (; cit != end; ++cit) {
1262                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1263                 if (it == ils.end())
1264                         continue;
1265                 tcpreamble << it->second.preamble();
1266         }
1267
1268         return tcpreamble.str();
1269 }
1270
1271
1272 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1273 {
1274         DocumentClass const & tclass = params_.documentClass();
1275         odocstringstream tcpreamble;
1276
1277         tcpreamble << tclass.htmlpreamble();
1278
1279         list<docstring>::const_iterator cit = usedLayouts_.begin();
1280         list<docstring>::const_iterator end = usedLayouts_.end();
1281         for (; cit != end; ++cit)
1282                 tcpreamble << tclass[*cit].htmlpreamble();
1283
1284         cit = usedInsetLayouts_.begin();
1285         end = usedInsetLayouts_.end();
1286         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1287         for (; cit != end; ++cit) {
1288                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1289                 if (it == ils.end())
1290                         continue;
1291                 tcpreamble << it->second.htmlpreamble();
1292         }
1293
1294         return tcpreamble.str();
1295 }
1296
1297
1298 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1299 {
1300         DocumentClass const & tclass = params_.documentClass();
1301         odocstringstream tcpreamble;
1302
1303         tcpreamble << tclass.htmlstyles();
1304
1305         list<docstring>::const_iterator cit = usedLayouts_.begin();
1306         list<docstring>::const_iterator end = usedLayouts_.end();
1307         for (; cit != end; ++cit)
1308                 tcpreamble << tclass[*cit].htmlstyle();
1309
1310         cit = usedInsetLayouts_.begin();
1311         end = usedInsetLayouts_.end();
1312         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1313         for (; cit != end; ++cit) {
1314                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1315                 if (it == ils.end())
1316                         continue;
1317                 tcpreamble << it->second.htmlstyle();
1318         }
1319
1320         return tcpreamble.str();
1321 }
1322
1323
1324 namespace {
1325
1326 docstring const getFloatI18nPreamble(docstring const & type,
1327                         docstring const & name, Language const * lang,
1328                         Encoding const & enc, bool const polyglossia)
1329 {
1330         // Check whether name can be encoded in the buffer encoding
1331         bool encodable = true;
1332         for (size_t i = 0; i < name.size(); ++i) {
1333                 if (!enc.encodable(name[i])) {
1334                         encodable = false;
1335                         break;
1336                 }
1337         }
1338
1339         docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1340                                                : from_ascii(lang->babel());
1341         docstring const langenc = from_ascii(lang->encoding()->iconvName());
1342         docstring const texenc = from_ascii(lang->encoding()->latexName());
1343         docstring const bufenc = from_ascii(enc.iconvName());
1344         docstring const s1 = docstring(1, 0xF0000);
1345         docstring const s2 = docstring(1, 0xF0001);
1346         docstring const translated = encodable ? name
1347                 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1348                         + s1 + langenc + s2 + name + s1 + bufenc + s2;
1349
1350         odocstringstream os;
1351         os << "\\addto\\captions" << language
1352            << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1353         return os.str();
1354 }
1355
1356
1357 docstring const i18npreamble(docstring const & templ, Language const * lang,
1358                 Encoding const & enc, bool const polyglossia)
1359 {
1360         if (templ.empty())
1361                 return templ;
1362
1363         string preamble = polyglossia ?
1364                 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1365                 subst(to_utf8(templ), "$$lang", lang->babel());
1366
1367         string const langenc = lang->encoding()->iconvName();
1368         string const texenc = lang->encoding()->latexName();
1369         string const bufenc = enc.iconvName();
1370         // First and second character of plane 15 (Private Use Area)
1371         string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1372         string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1373         // FIXME UNICODE
1374         // lyx::regex is not unicode-safe.
1375         // Should use QRegExp or (boost::u32regex, but that requires ICU)
1376         static regex const reg("_\\(([^\\)]+)\\)");
1377         smatch sub;
1378         while (regex_search(preamble, sub, reg)) {
1379                 string const key = sub.str(1);
1380                 docstring const name = lang->translateLayout(key);
1381                 // Check whether name can be encoded in the buffer encoding
1382                 bool encodable = true;
1383                 for (size_t i = 0; i < name.size(); ++i) {
1384                         if (!enc.encodable(name[i])) {
1385                                 encodable = false;
1386                                 break;
1387                         }
1388                 }
1389                 string const translated = encodable ? to_utf8(name)
1390                         : "\\inputencoding{" + texenc + "}"
1391                         + s1 + langenc + s2 + to_utf8(name)
1392                         + s1 + bufenc + s2;
1393                 preamble = subst(preamble, sub.str(), translated);
1394         }
1395         return from_utf8(preamble);
1396 }
1397
1398 }
1399
1400
1401 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1402 {
1403         DocumentClass const & tclass = params_.documentClass();
1404         // collect preamble snippets in a set to prevent multiple identical
1405         // commands (would happen if e.g. both theorem and theorem* are used)
1406         set<docstring> snippets;
1407         typedef LanguageList::const_iterator lang_it;
1408         lang_it const lbeg = UsedLanguages_.begin();
1409         lang_it const lend =  UsedLanguages_.end();
1410         list<docstring>::const_iterator cit = usedLayouts_.begin();
1411         list<docstring>::const_iterator end = usedLayouts_.end();
1412         for (; cit != end; ++cit) {
1413                 // language dependent commands (once per document)
1414                 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1415                                                 buffer().language(),
1416                                                 buffer().params().encoding(),
1417                                                 use_polyglossia));
1418                 // commands for language changing (for multilanguage documents)
1419                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1420                         snippets.insert(i18npreamble(
1421                                                 tclass[*cit].babelpreamble(),
1422                                                 buffer().language(),
1423                                                 buffer().params().encoding(),
1424                                                 use_polyglossia));
1425                         for (lang_it lit = lbeg; lit != lend; ++lit)
1426                                 snippets.insert(i18npreamble(
1427                                                 tclass[*cit].babelpreamble(),
1428                                                 *lit,
1429                                                 buffer().params().encoding(),
1430                                                 use_polyglossia));
1431                 }
1432         }
1433         if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1434                 FloatList const & floats = params_.documentClass().floats();
1435                 UsedFloats::const_iterator fit = usedFloats_.begin();
1436                 UsedFloats::const_iterator fend = usedFloats_.end();
1437                 for (; fit != fend; ++fit) {
1438                         Floating const & fl = floats.getType(fit->first);
1439                         // we assume builtin floats are translated
1440                         if (fl.isPredefined())
1441                                 continue;
1442                         docstring const type = from_ascii(fl.floattype());
1443                         docstring const flname = from_utf8(fl.name());
1444                         docstring name = buffer().language()->translateLayout(fl.name());
1445                         // only request translation if we have a real translation
1446                         // (that differs from the source)
1447                         if (flname != name)
1448                                 snippets.insert(getFloatI18nPreamble(
1449                                                 type, name, buffer().language(),
1450                                                 buffer().params().encoding(),
1451                                                 use_polyglossia));
1452                         for (lang_it lit = lbeg; lit != lend; ++lit) {
1453                                 string const code = (*lit)->code();
1454                                 name = (*lit)->translateLayout(fl.name());
1455                                 // we assume we have a suitable translation if
1456                                 // either the language is English (we need to
1457                                 // translate into English if English is a secondary
1458                                 // language) or if translateIfPossible returns
1459                                 // something different to the English source.
1460                                 bool const have_translation =
1461                                         (flname != name || contains(code, "en"));
1462                                 if (have_translation)
1463                                         snippets.insert(getFloatI18nPreamble(
1464                                                 type, name, *lit,
1465                                                 buffer().params().encoding(),
1466                                                 use_polyglossia));
1467                         }
1468                 }
1469         }
1470
1471         cit = usedInsetLayouts_.begin();
1472         end = usedInsetLayouts_.end();
1473         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1474         for (; cit != end; ++cit) {
1475                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1476                 if (it == ils.end())
1477                         continue;
1478                 // language dependent commands (once per document)
1479                 snippets.insert(i18npreamble(it->second.langpreamble(),
1480                                                 buffer().language(),
1481                                                 buffer().params().encoding(),
1482                                                 use_polyglossia));
1483                 // commands for language changing (for multilanguage documents)
1484                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1485                         snippets.insert(i18npreamble(
1486                                                 it->second.babelpreamble(),
1487                                                 buffer().language(),
1488                                                 buffer().params().encoding(),
1489                                                 use_polyglossia));
1490                         for (lang_it lit = lbeg; lit != lend; ++lit)
1491                                 snippets.insert(i18npreamble(
1492                                                 it->second.babelpreamble(),
1493                                                 *lit,
1494                                                 buffer().params().encoding(),
1495                                                 use_polyglossia));
1496                 }
1497         }
1498
1499         odocstringstream tcpreamble;
1500         set<docstring>::const_iterator const send = snippets.end();
1501         set<docstring>::const_iterator it = snippets.begin();
1502         for (; it != send; ++it)
1503                 tcpreamble << *it;
1504         return tcpreamble.str();
1505 }
1506
1507
1508 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1509 {
1510         // Definition of entities used in the document that are LyX related.
1511         odocstringstream entities;
1512
1513         if (mustProvide("lyxarrow")) {
1514                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
1515         }
1516
1517         return entities.str();
1518 }
1519
1520
1521 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1522 {
1523         odocstringstream sgmlpreamble;
1524         // FIXME UNICODE
1525         docstring const basename(from_utf8(onlyPath(fname)));
1526
1527         FileMap::const_iterator end = IncludedFiles_.end();
1528         for (FileMap::const_iterator fi = IncludedFiles_.begin();
1529              fi != end; ++fi)
1530                 // FIXME UNICODE
1531                 sgmlpreamble << "\n<!ENTITY " << fi->first
1532                              << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1533                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
1534
1535         return sgmlpreamble.str();
1536 }
1537
1538
1539 void LaTeXFeatures::showStruct() const
1540 {
1541         lyxerr << "LyX needs the following commands when LaTeXing:"
1542                << "\n***** Packages:" << getPackages()
1543                << "\n***** Macros:" << to_utf8(getMacros())
1544                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1545                << "\n***** done." << endl;
1546 }
1547
1548
1549 Buffer const & LaTeXFeatures::buffer() const
1550 {
1551         return *buffer_;
1552 }
1553
1554
1555 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1556 {
1557         buffer_ = &buffer;
1558 }
1559
1560
1561 BufferParams const & LaTeXFeatures::bufferParams() const
1562 {
1563         return params_;
1564 }
1565
1566
1567 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1568 {
1569         FloatList const & floats = params_.documentClass().floats();
1570
1571         // Here we will output the code to create the needed float styles.
1572         // We will try to do this as minimal as possible.
1573         // \floatstyle{ruled}
1574         // \newfloat{algorithm}{htbp}{loa}
1575         // \providecommand{\algorithmname}{Algorithm}
1576         // \floatname{algorithm}{\protect\algorithmname}
1577         UsedFloats::const_iterator cit = usedFloats_.begin();
1578         UsedFloats::const_iterator end = usedFloats_.end();
1579         for (; cit != end; ++cit) {
1580                 Floating const & fl = floats.getType(cit->first);
1581
1582                 // For builtin floats we do nothing.
1583                 if (fl.isPredefined())
1584                         continue;
1585
1586                 // We have to special case "table" and "figure"
1587                 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1588                         // Output code to modify "table" or "figure"
1589                         // but only if builtin == false
1590                         // and that have to be true at this point in the
1591                         // function.
1592                         docstring const type = from_ascii(fl.floattype());
1593                         docstring const placement = from_ascii(fl.placement());
1594                         docstring const style = from_ascii(fl.style());
1595                         if (!style.empty()) {
1596                                 os << "\\floatstyle{" << style << "}\n"
1597                                    << "\\restylefloat{" << type << "}\n";
1598                         }
1599                         if (!placement.empty()) {
1600                                 os << "\\floatplacement{" << type << "}{"
1601                                    << placement << "}\n";
1602                         }
1603                 } else {
1604                         // The other non builtin floats.
1605
1606                         docstring const type = from_ascii(fl.floattype());
1607                         docstring const placement = from_ascii(fl.placement());
1608                         docstring const ext = from_ascii(fl.ext());
1609                         docstring const within = from_ascii(fl.within());
1610                         docstring const style = from_ascii(fl.style());
1611                         docstring const name =
1612                                 buffer().language()->translateLayout(fl.name());
1613                         os << "\\floatstyle{" << style << "}\n"
1614                            << "\\newfloat{" << type << "}{" << placement
1615                            << "}{" << ext << '}';
1616                         if (!within.empty())
1617                                 os << '[' << within << ']';
1618                         os << '\n'
1619                            << "\\providecommand{\\" << type << "name}{"
1620                            << name << "}\n"
1621                            << "\\floatname{" << type << "}{\\protect\\"
1622                            << type << "name}\n";
1623
1624                         // What missing here is to code to minimalize the code
1625                         // output so that the same floatstyle will not be
1626                         // used several times, when the same style is still in
1627                         // effect. (Lgb)
1628                 }
1629                 if (cit->second)
1630                         os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";
1631         }
1632 }
1633
1634
1635 void LaTeXFeatures::resolveAlternatives()
1636 {
1637         for (Features::iterator it = features_.begin(); it != features_.end();) {
1638                 if (contains(*it, '|')) {
1639                         vector<string> const alternatives = getVectorFromString(*it, "|");
1640                         vector<string>::const_iterator const end = alternatives.end();
1641                         vector<string>::const_iterator ita = alternatives.begin();
1642                         for (; ita != end; ++ita) {
1643                                 if (isRequired(*ita))
1644                                         break;
1645                         }
1646                         if (ita == end)
1647                                 require(alternatives.front());
1648                         features_.erase(it);
1649                         it = features_.begin();
1650                 } else
1651                         ++it;
1652         }
1653 }
1654
1655
1656 } // namespace lyx