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