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