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