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