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