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