src/LaTeXFeatures.cpp

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