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