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