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