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         "\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
 188         "\\newcommand{\\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         "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
 194         "\\newcommand{\\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         "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
 199         "\\newcommand{\\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 // LaTeXFeatures
 320 //
 321 /////////////////////////////////////////////////////////////////////
 322
 323
 324 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
 325                              OutputParams const & r)
 326         : buffer_(&b), params_(p), runparams_(r), in_float_(false)
 327 {}
 328
 329
 330 LaTeXFeatures::LangPackage LaTeXFeatures::langPackage(bool englishbabel) const
 331 {
 332         string const local_lp = bufferParams().lang_package;
 333
 334         // Locally, custom is just stored as a string
 335         // in bufferParams().lang_package.
 336         if (local_lp != "auto"
 337             && local_lp != "babel"
 338             && local_lp != "default"
 339             && local_lp != "none")
 340                  return LANG_PACK_CUSTOM;
 341
 342         if (local_lp == "none")
 343                 return LANG_PACK_NONE;
 344
 345         /* If "auto" is selected, we load polyglossia if required,
 346          * else we select babel.
 347          * If babel is selected (either directly or via the "auto"
 348          * mechanism), we really do only require it if we have
 349          * a language that needs it.
 350          * English alone normally does not require babel (since it is
 351          * the default language of LaTeX). However, in some cases we
 352          * need to surpass this exception (see Font::validate).
 353          */
 354         bool const polyglossia_required =
 355                 isRequired("polyglossia")
 356                 && isAvailable("polyglossia")
 357                 && !isProvided("babel")
 358                 && this->hasOnlyPolyglossiaLanguages();
 359         bool const babel_required =
 360                 ((englishbabel || bufferParams().language->lang() != "english")
 361                  && !bufferParams().language->babel().empty())
 362                 || !this->getBabelLanguages().empty();
 363
 364         if (local_lp == "auto") {
 365                 // polyglossia requirement has priority over babel
 366                 if (polyglossia_required)
 367                         return LANG_PACK_POLYGLOSSIA;
 368                 else if (babel_required)
 369                         return LANG_PACK_BABEL;
 370         }
 371
 372         if (local_lp == "babel") {
 373                 if (babel_required)
 374                         return LANG_PACK_BABEL;
 375         }
 376
 377         if (local_lp == "default") {
 378                 switch (lyxrc.language_package_selection) {
 379                 case LyXRC::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                         break;
 386                 case LyXRC::LP_BABEL:
 387                         if (babel_required)
 388                                 return LANG_PACK_BABEL;
 389                         break;
 390                 case LyXRC::LP_CUSTOM:
 391                         return LANG_PACK_CUSTOM;
 392                 case LyXRC::LP_NONE:
 393                         return LANG_PACK_NONE;
 394                 }
 395         }
 396
 397         return LANG_PACK_NONE;
 398 }
 399
 400
 401 void LaTeXFeatures::require(string const & name)
 402 {
 403         features_.insert(name);
 404 }
 405
 406
 407 void LaTeXFeatures::require(set<string> const & names)
 408 {
 409         features_.insert(names.begin(), names.end());
 410 }
 411
 412
 413 void LaTeXFeatures::useLayout(docstring const & layoutname)
 414 {
 415         // Some code to avoid loops in dependency definition
 416         static int level = 0;
 417         const int maxlevel = 30;
 418         if (level > maxlevel) {
 419                 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
 420                        << "recursion attained by layout "
 421                        << to_utf8(layoutname) << endl;
 422                 return;
 423         }
 424
 425         DocumentClass const & tclass = params_.documentClass();
 426         if (tclass.hasLayout(layoutname)) {
 427                 // Is this layout already in usedLayouts?
 428                 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
 429                     != usedLayouts_.end())
 430                         return;
 431
 432                 Layout const & layout = tclass[layoutname];
 433                 require(layout.requires());
 434
 435                 if (!layout.depends_on().empty()) {
 436                         ++level;
 437                         useLayout(layout.depends_on());
 438                         --level;
 439                 }
 440                 usedLayouts_.push_back(layoutname);
 441         } else {
 442                 lyxerr << "LaTeXFeatures::useLayout: layout `"
 443                        << to_utf8(layoutname) << "' does not exist in this class"
 444                        << endl;
 445         }
 446
 447         --level;
 448 }
 449
 450
 451 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
 452 {
 453         docstring const & lname = lay.name();
 454         DocumentClass const & tclass = params_.documentClass();
 455
 456         // this is a default inset layout, nothing useful here
 457         if (!tclass.hasInsetLayout(lname))
 458                 return;
 459         // Is this layout already in usedInsetLayouts?
 460         if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
 461                         != usedInsetLayouts_.end())
 462                 return;
 463
 464         require(lay.requires());
 465         usedInsetLayouts_.push_back(lname);
 466 }
 467
 468
 469 bool LaTeXFeatures::isRequired(string const & name) const
 470 {
 471         return features_.find(name) != features_.end();
 472 }
 473
 474
 475 bool LaTeXFeatures::isProvided(string const & name) const
 476 {
 477         if (params_.useNonTeXFonts)
 478                 return params_.documentClass().provides(name);
 479
 480         bool const ot1 = (params_.font_encoding() == "default"
 481                 || params_.font_encoding() == "OT1");
 482         bool const complete = (params_.fonts_sans == "default")
 483                 && (params_.fonts_typewriter == "default");
 484         bool const nomath = (params_.fonts_math == "default");
 485         return params_.documentClass().provides(name)
 486                 || theLaTeXFonts().getLaTeXFont(
 487                         from_ascii(params_.fonts_roman)).provides(name, ot1,
 488                                                                   complete,
 489                                                                   nomath)
 490                 || theLaTeXFonts().getLaTeXFont(
 491                         from_ascii(params_.fonts_sans)).provides(name, ot1,
 492                                                                  complete,
 493                                                                  nomath)
 494                 || theLaTeXFonts().getLaTeXFont(
 495                         from_ascii(params_.fonts_typewriter)).provides(name, ot1,
 496                                                                        complete,
 497                                                                        nomath)
 498                 || theLaTeXFonts().getLaTeXFont(
 499                         from_ascii(params_.fonts_math)).provides(name, ot1,
 500                                                                        complete,
 501                                                                        nomath);
 502 }
 503
 504 bool LaTeXFeatures::mustProvide(string const & name) const
 505 {
 506         return isRequired(name) && !isProvided(name);
 507 }
 508
 509
 510 bool LaTeXFeatures::isAvailable(string const & name)
 511 {
 512         string::size_type const i = name.find("->");
 513         if (i != string::npos) {
 514                 string const from = name.substr(0,i);
 515                 string const to = name.substr(i+2);
 516                 //LYXERR0("from=[" << from << "] to=[" << to << "]");
 517                 return theConverters().isReachable(from, to);
 518         }
 519         return LaTeXPackages::isAvailable(name);
 520 }
 521
 522
 523 void LaTeXFeatures::addPreambleSnippet(string const & preamble)
 524 {
 525         SnippetList::const_iterator begin = preamble_snippets_.begin();
 526         SnippetList::const_iterator end   = preamble_snippets_.end();
 527         if (find(begin, end, preamble) == end)
 528                 preamble_snippets_.push_back(preamble);
 529 }
 530
 531
 532 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
 533 {
 534         SnippetList::const_iterator begin = css_snippets_.begin();
 535         SnippetList::const_iterator end   = css_snippets_.end();
 536         if (find(begin, end, snippet) == end)
 537                 css_snippets_.push_back(snippet);
 538 }
 539
 540
 541 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
 542 {
 543         if (!usedFloats_[name])
 544                 usedFloats_[name] = subfloat;
 545         if (subfloat)
 546                 require("subfig");
 547         // We only need float.sty if we use non builtin floats, or if we
 548         // use the "H" modifier. This includes modified table and
 549         // figure floats. (Lgb)
 550         Floating const & fl = params_.documentClass().floats().getType(name);
 551         if (!fl.floattype().empty() && fl.usesFloatPkg()) {
 552                 require("float");
 553         }
 554 }
 555
 556
 557 void LaTeXFeatures::useLanguage(Language const * lang)
 558 {
 559         if (!lang->babel().empty() || !lang->polyglossia().empty())
 560                 UsedLanguages_.insert(lang);
 561         if (!lang->requires().empty())
 562                 require(lang->requires());
 563         // CJK languages do not have a babel name.
 564         // They use the CJK package
 565         if (lang->encoding()->package() == Encoding::CJK)
 566                 require("CJK");
 567         // japanese package is special
 568         if (lang->encoding()->package() == Encoding::japanese)
 569                 require("japanese");
 570 }
 571
 572
 573 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
 574 {
 575         IncludedFiles_[key] = name;
 576 }
 577
 578
 579 bool LaTeXFeatures::hasLanguages() const
 580 {
 581         return !UsedLanguages_.empty();
 582 }
 583
 584
 585 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
 586 {
 587         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 588         for (LanguageList::const_iterator cit = begin;
 589              cit != UsedLanguages_.end();
 590              ++cit) {
 591                 if ((*cit)->polyglossia().empty())
 592                         return false;
 593         }
 594         return true;
 595 }
 596
 597
 598 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
 599 {
 600         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 601         for (LanguageList::const_iterator cit = begin;
 602              cit != UsedLanguages_.end();
 603              ++cit) {
 604                 if ((*cit)->babel().empty() && !(*cit)->polyglossia().empty() && (*cit)->requires().empty())
 605                         return true;
 606         }
 607         return false;
 608 }
 609
 610
 611 string LaTeXFeatures::getBabelLanguages() const
 612 {
 613         ostringstream languages;
 614
 615         bool first = true;
 616         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 617         for (LanguageList::const_iterator cit = begin;
 618              cit != UsedLanguages_.end();
 619              ++cit) {
 620                 if ((*cit)->babel().empty())
 621                         continue;
 622                 if (!first)
 623                         languages << ',';
 624                 else
 625                         first = false;
 626                 languages << (*cit)->babel();
 627         }
 628         return languages.str();
 629 }
 630
 631
 632 std::map<std::string, std::string> LaTeXFeatures::getPolyglossiaLanguages() const
 633 {
 634         std::map<std::string, std::string> languages;
 635
 636         LanguageList::const_iterator const begin = UsedLanguages_.begin();
 637         for (LanguageList::const_iterator cit = begin;
 638              cit != UsedLanguages_.end();
 639              ++cit) {
 640                 languages[(*cit)->polyglossia()] = (*cit)->polyglossiaOpts();
 641         }
 642         return languages;
 643 }
 644
 645
 646 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
 647 {
 648         // This does only find encodings of languages supported by babel, but
 649         // that does not matter since we don't have a language with an
 650         // encoding supported by inputenc but without babel support.
 651         set<string> encodings;
 652         LanguageList::const_iterator it  = UsedLanguages_.begin();
 653         LanguageList::const_iterator end = UsedLanguages_.end();
 654         for (; it != end; ++it)
 655                 if ((*it)->encoding()->latexName() != doc_encoding &&
 656                     ((*it)->encoding()->package() == Encoding::inputenc
 657                      || (*it)->encoding()->package() == Encoding::japanese))
 658                         encodings.insert((*it)->encoding()->latexName());
 659         return encodings;
 660 }
 661
 662 namespace {
 663
 664 char const * simplefeatures[] = {
 665 // note that the package order here will be the same in the LaTeX-output
 666         "array",
 667         "verbatim",
 668         "longtable",
 669         "rotating",
 670         "latexsym",
 671         "pifont",
 672         // subfig is handled in BufferParams.cpp
 673         "varioref",
 674         "prettyref",
 675         "refstyle",
 676         /*For a successful cooperation of the `wrapfig' package with the
 677           `float' package you should load the `wrapfig' package *after*
 678           the `float' package. See the caption package documentation
 679           for explanation.*/
 680         "float",
 681         "rotfloat",
 682         "wrapfig",
 683         "booktabs",
 684         "dvipost",
 685         "fancybox",
 686         "calc",
 687         "units",
 688         "tipa",
 689         "tipx",
 690         "tone",
 691         "framed",
 692         "soul",
 693         "textcomp",
 694         "pmboxdraw",
 695         "bbding",
 696         "ifsym",
 697         "marvosym",
 698         "txfonts",
 699         "pxfonts",
 700         "mathdesign",
 701         "mathrsfs",
 702         "mathabx",
 703         "mathtools",
 704         "cancel",
 705         "ascii",
 706         "url",
 707         "covington",
 708         "csquotes",
 709         "enumitem",
 710         "endnotes",
 711         "hhline",
 712         "ifthen",
 713         // listings is handled in BufferParams.cpp
 714         "bm",
 715         "pdfpages",
 716         "amscd",
 717         "slashed",
 718         "multirow",
 719         "tfrupee"
 720 };
 721
 722 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
 723
 724 }
 725
 726
 727 string const LaTeXFeatures::getColorOptions() const
 728 {
 729         ostringstream colors;
 730
 731         // Handling the color packages separately is needed to be able to load them
 732         // before babel when hyperref is loaded with the colorlinks option
 733         // for more info see Bufferparams.cpp
 734
 735         // [x]color.sty
 736         if (mustProvide("color") || mustProvide("xcolor")) {
 737                 string const package =
 738                         (mustProvide("xcolor") ? "xcolor" : "color");
 739                 if (params_.graphics_driver == "default"
 740                         || params_.graphics_driver == "none")
 741                         colors << "\\usepackage{" << package << "}\n";
 742                 else
 743                         colors << "\\usepackage["
 744                                  << params_.graphics_driver
 745                                  << "]{" << package << "}\n";
 746         }
 747
 748         // pdfcolmk must be loaded after color
 749         if (mustProvide("pdfcolmk"))
 750                 colors << "\\usepackage{pdfcolmk}\n";
 751
 752         // the following 3 color commands must be set after color
 753         // is loaded and before pdfpages, therefore add the command
 754         // here define the set color
 755         if (mustProvide("pagecolor")) {
 756                 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
 757                 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
 758                 // set the page color
 759                 colors << "\\pagecolor{page_backgroundcolor}\n";
 760         }
 761
 762         if (mustProvide("fontcolor")) {
 763                 colors << "\\definecolor{document_fontcolor}{rgb}{";
 764                 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
 765                 // set the color
 766                 colors << "\\color{document_fontcolor}\n";
 767         }
 768
 769         if (mustProvide("lyxgreyedout")) {
 770                 colors << "\\definecolor{note_fontcolor}{rgb}{";
 771                 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
 772                 // the color will be set together with the definition of
 773                 // the lyxgreyedout environment (see lyxgreyedout_def)
 774         }
 775
 776         // color for shaded boxes
 777         if (isRequired("framed") && mustProvide("color")) {
 778                 colors << "\\definecolor{shadecolor}{rgb}{";
 779                 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
 780                 // this color is automatically used by the LaTeX-package "framed"
 781         }
 782
 783         return colors.str();
 784 }
 785
 786
 787 string const LaTeXFeatures::getPackages() const
 788 {
 789         ostringstream packages;
 790
 791         // FIXME: currently, we can only load packages and macros known
 792         // to LyX.
 793         // However, with the Require tag of layouts/custom insets,
 794         // also unknown packages can be requested. They are silently
 795         // swallowed now. We should change this eventually.
 796
 797         //
 798         //  These are all the 'simple' includes.  i.e
 799         //  packages which we just \usepackage{package}
 800         //
 801         for (int i = 0; i < nb_simplefeatures; ++i) {
 802                 if (mustProvide(simplefeatures[i]))
 803                         packages << "\\usepackage{"
 804                                  << simplefeatures[i] << "}\n";
 805         }
 806
 807         //
 808         // The rest of these packages are somewhat more complicated
 809         // than those above.
 810         //
 811
 812         // if fontspec is used, AMS packages have to be loaded before
 813         // fontspec (in BufferParams)
 814         string const amsPackages = loadAMSPackages();
 815         if (!params_.useNonTeXFonts && !amsPackages.empty())
 816                 packages << amsPackages;
 817
 818         // fixltx2e must be loaded after amsthm, since amsthm produces an error with
 819         // the redefined \[ command (bug 7233). Load it as early as possible, since
 820         // other packages might profit from it.
 821         if (mustProvide("fixltx2e"))
 822                 packages << "\\usepackage{fixltx2e}\n";
 823
 824         // wasysym is a simple feature, but it must be after amsmath if both
 825         // are used
 826         // wasysym redefines some integrals (e.g. iint) from amsmath. That
 827         // leads to inconsistent integrals. We only load this package if
 828         // the document does not contain integrals (then isRequired("esint")
 829         // is false) or if esint is used, since esint redefines all relevant
 830         // integral symbols from wasysym and amsmath.
 831         // See http://www.lyx.org/trac/ticket/1942
 832         if (mustProvide("wasysym") &&
 833             params_.use_package("wasysym") != BufferParams::package_off &&
 834             (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
 835                 packages << "\\usepackage{wasysym}\n";
 836
 837         // accents must be loaded after amsmath
 838         if (mustProvide("accents") &&
 839             params_.use_package("accents") != BufferParams::package_off)
 840                 packages << "\\usepackage{accents}\n";
 841
 842         // mathdots must be loaded after amsmath
 843         if (mustProvide("mathdots") &&
 844                 params_.use_package("mathdots") != BufferParams::package_off)
 845                 packages << "\\usepackage{mathdots}\n";
 846
 847         // yhmath must be loaded after amsmath
 848         if (mustProvide("yhmath") &&
 849             params_.use_package("yhmath") != BufferParams::package_off)
 850                 packages << "\\usepackage{yhmath}\n";
 851
 852         if (mustProvide("undertilde") &&
 853                 params_.use_package("undertilde") != BufferParams::package_off)
 854                 packages << "\\usepackage{undertilde}\n";
 855
 856         // [x]color and pdfcolmk are handled in getColorOptions() above
 857
 858         // makeidx.sty
 859         if (isRequired("makeidx") || isRequired("splitidx")) {
 860                 if (!isProvided("makeidx") && !isRequired("splitidx"))
 861                         packages << "\\usepackage{makeidx}\n";
 862                 if (mustProvide("splitidx"))
 863                         packages << "\\usepackage{splitidx}\n";
 864                 packages << "\\makeindex\n";
 865         }
 866
 867         // graphicx.sty
 868         if (mustProvide("graphicx") && params_.graphics_driver != "none") {
 869                 if (params_.graphics_driver == "default")
 870                         packages << "\\usepackage{graphicx}\n";
 871                 else
 872                         packages << "\\usepackage["
 873                                  << params_.graphics_driver
 874                                  << "]{graphicx}\n";
 875         }
 876
 877         // lyxskak.sty --- newer chess support based on skak.sty
 878         if (mustProvide("chess"))
 879                 packages << "\\usepackage[ps,mover]{lyxskak}\n";
 880
 881         // setspace.sty
 882         if (mustProvide("setspace") && !isProvided("SetSpace"))
 883                 packages << "\\usepackage{setspace}\n";
 884
 885         // esint must be after amsmath and wasysym, since it will redeclare
 886         // inconsistent integral symbols
 887         if (mustProvide("esint") &&
 888             params_.use_package("esint") != BufferParams::package_off)
 889                 packages << "\\usepackage{esint}\n";
 890
 891         // natbib.sty
 892         // Some classes load natbib themselves, but still allow (or even require)
 893         // plain numeric citations (ReVTeX is such a case, see bug 5182).
 894         // This special case is indicated by the "natbib-internal" key.
 895         if (mustProvide("natbib") && !isProvided("natbib-internal")) {
 896                 packages << "\\usepackage[";
 897                 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
 898                         packages << "numbers";
 899                 else
 900                         packages << "authoryear";
 901                 packages << "]{natbib}\n";
 902         }
 903
 904         // jurabib -- we need version 0.6 at least.
 905         if (mustProvide("jurabib"))
 906                 packages << "\\usepackage{jurabib}[2004/01/25]\n";
 907
 908         // xargs -- we need version 1.09 at least
 909         if (mustProvide("xargs"))
 910                 packages << "\\usepackage{xargs}[2008/03/08]\n";
 911
 912         if (mustProvide("xy"))
 913                 packages << "\\usepackage[all]{xy}\n";
 914
 915         if (mustProvide("feyn"))
 916                 packages << "\\usepackage{feyn}\n"; //Diagram
 917
 918         if (mustProvide("ulem"))
 919                 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
 920                             "\\usepackage{ulem}\n";
 921
 922         if (mustProvide("mhchem") &&
 923             params_.use_package("mhchem") != BufferParams::package_off)
 924                 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
 925                             "\\usepackage{mhchem}\n";
 926
 927         if (mustProvide("nomencl")) {
 928                 // Make it work with the new and old version of the package,
 929                 // but don't use the compatibility option since it is
 930                 // incompatible to other packages.
 931                 packages << "\\usepackage{nomencl}\n"
 932                             "% the following is useful when we have the old nomencl.sty package\n"
 933                             "\\providecommand{\\printnomenclature}{\\printglossary}\n"
 934                             "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
 935                             "\\makenomenclature\n";
 936         }
 937
 938         // fixltx2e provides subscript
 939         if (mustProvide("subscript") && !isRequired("fixltx2e"))
 940                 packages << "\\usepackage{subscript}\n";
 941
 942         return packages.str();
 943 }
 944
 945
 946 string LaTeXFeatures::getPreambleSnippets() const
 947 {
 948         ostringstream snip;
 949         SnippetList::const_iterator pit  = preamble_snippets_.begin();
 950         SnippetList::const_iterator pend = preamble_snippets_.end();
 951         for (; pit != pend; ++pit)
 952                 snip << *pit << '\n';
 953         return snip.str();
 954 }
 955
 956
 957 std::string LaTeXFeatures::getCSSSnippets() const
 958 {
 959         ostringstream snip;
 960         SnippetList::const_iterator pit  = css_snippets_.begin();
 961         SnippetList::const_iterator pend = css_snippets_.end();
 962         for (; pit != pend; ++pit)
 963                 snip << *pit << '\n';
 964         return snip.str();
 965 }
 966
 967
 968 docstring const LaTeXFeatures::getMacros() const
 969 {
 970         odocstringstream macros;
 971
 972         if (!preamble_snippets_.empty()) {
 973                 macros << '\n';
 974                 macros << from_utf8(getPreambleSnippets());
 975         }
 976
 977         if (mustProvide("papersize")) {
 978                 if (runparams_.flavor == OutputParams::LATEX)
 979                         macros << papersizedvi_def << '\n';
 980                 else
 981                         macros << papersizepdf_def << '\n';
 982         }
 983
 984         if (mustProvide("LyX")) {
 985                 if (isRequired("hyperref"))
 986                         macros << lyx_hyperref_def << '\n';
 987                 else
 988                         macros << lyx_def << '\n';
 989         }
 990
 991         if (mustProvide("noun"))
 992                 macros << noun_def << '\n';
 993
 994         if (mustProvide("lyxarrow"))
 995                 macros << lyxarrow_def << '\n';
 996
 997         if (!usePolyglossia() && mustProvide("textgreek")) {
 998                 // Avoid a LaTeX error if times fonts are used and the grtimes
 999                 // package is installed but actual fonts are not (bug 6469).
1000                 if (params_.fonts_roman == "times")
1001                         macros << subst(textgreek_def,
1002                                         from_ascii("\\greektext #1"),
1003                                         from_ascii("%\n  \\IfFileExists"
1004                                                    "{grtm10.tfm}{}{\\fontfamily"
1005                                                    "{cmr}}\\greektext #1"))
1006                                << '\n';
1007                 else
1008                         macros << textgreek_def << '\n';
1009         }
1010
1011         if (!usePolyglossia() && mustProvide("textcyr"))
1012                 macros << textcyr_def << '\n';
1013
1014         if (mustProvide("lyxmathsym"))
1015                 macros << lyxmathsym_def << '\n';
1016
1017         if (mustProvide("cedilla"))
1018                 macros << cedilla_def << '\n';
1019
1020         if (mustProvide("subring"))
1021                 macros << subring_def << '\n';
1022
1023         if (mustProvide("subdot"))
1024                 macros << subdot_def << '\n';
1025
1026         if (mustProvide("subhat"))
1027                 macros << subhat_def << '\n';
1028
1029         if (mustProvide("subtilde"))
1030                 macros << subtilde_def << '\n';
1031
1032         if (mustProvide("dacute"))
1033                 macros << dacute_def << '\n';
1034
1035         if (mustProvide("tipasymb"))
1036                 macros << tipasymb_def << '\n';
1037
1038         if (mustProvide("dgrave"))
1039                 macros << dgrave_def << '\n';
1040
1041         if (mustProvide("rcap"))
1042                 macros << rcap_def << '\n';
1043
1044         if (mustProvide("ogonek"))
1045                 macros << ogonek_def << '\n';
1046
1047         // quotes.
1048         if (mustProvide("quotesinglbase"))
1049                 macros << quotesinglbase_def << '\n';
1050         if (mustProvide("quotedblbase"))
1051                 macros << quotedblbase_def << '\n';
1052         if (mustProvide("guilsinglleft"))
1053                 macros << guilsinglleft_def << '\n';
1054         if (mustProvide("guilsinglright"))
1055                 macros << guilsinglright_def << '\n';
1056         if (mustProvide("guillemotleft"))
1057                 macros << guillemotleft_def << '\n';
1058         if (mustProvide("guillemotright"))
1059                 macros << guillemotright_def << '\n';
1060
1061         // Math mode
1062         if (mustProvide("binom") && !isRequired("amsmath"))
1063                 macros << binom_def << '\n';
1064         if (mustProvide("mathcircumflex"))
1065                 macros << mathcircumflex_def << '\n';
1066
1067         // other
1068         if (mustProvide("ParagraphLeftIndent"))
1069                 macros << paragraphleftindent_def;
1070         if (mustProvide("NeedLyXFootnoteCode"))
1071                 macros << floatingfootnote_def;
1072
1073         // some problems with tex->html converters
1074         if (mustProvide("NeedTabularnewline"))
1075                 macros << tabularnewline_def;
1076
1077         // greyed-out environment (note inset)
1078         // the color is specified in the routine
1079         // getColorOptions() to avoid LaTeX-package clashes
1080         if (mustProvide("lyxgreyedout"))
1081                 macros << lyxgreyedout_def;
1082
1083         if (mustProvide("lyxdot"))
1084                 macros << lyxdot_def << '\n';
1085
1086         // floats
1087         getFloatDefinitions(macros);
1088
1089         if (mustProvide("refstyle"))
1090                 macros << lyxref_def << '\n';
1091
1092         // change tracking
1093         if (mustProvide("ct-dvipost"))
1094                 macros << changetracking_dvipost_def;
1095
1096         if (mustProvide("ct-xcolor-ulem")) {
1097                 streamsize const prec = macros.precision(2);
1098
1099                 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1100                 macros << "\\providecolor{lyxadded}{rgb}{"
1101                        << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1102
1103                 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1104                 macros << "\\providecolor{lyxdeleted}{rgb}{"
1105                        << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1106
1107                 macros.precision(prec);
1108
1109                 if (isRequired("hyperref"))
1110                         macros << changetracking_xcolor_ulem_hyperref_def;
1111                 else
1112                         macros << changetracking_xcolor_ulem_def;
1113         }
1114
1115         if (mustProvide("ct-none"))
1116                 macros << changetracking_none_def;
1117
1118         if (mustProvide("rtloutputdblcol"))
1119                 macros << rtloutputdblcol_def;
1120
1121         return macros.str();
1122 }
1123
1124
1125 string const LaTeXFeatures::getBabelPresettings() const
1126 {
1127         ostringstream tmp;
1128
1129         LanguageList::const_iterator it  = UsedLanguages_.begin();
1130         LanguageList::const_iterator end = UsedLanguages_.end();
1131         for (; it != end; ++it)
1132                 if (!(*it)->babel_presettings().empty())
1133                         tmp << (*it)->babel_presettings() << '\n';
1134         if (!params_.language->babel_presettings().empty())
1135                 tmp << params_.language->babel_presettings() << '\n';
1136
1137         if (!contains(tmp.str(), '@'))
1138                 return tmp.str();
1139
1140         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1141 }
1142
1143
1144 string const LaTeXFeatures::getBabelPostsettings() const
1145 {
1146         ostringstream tmp;
1147
1148         LanguageList::const_iterator it  = UsedLanguages_.begin();
1149         LanguageList::const_iterator end = UsedLanguages_.end();
1150         for (; it != end; ++it)
1151                 if (!(*it)->babel_postsettings().empty())
1152                         tmp << (*it)->babel_postsettings() << '\n';
1153         if (!params_.language->babel_postsettings().empty())
1154                 tmp << params_.language->babel_postsettings() << '\n';
1155
1156         if (!contains(tmp.str(), '@'))
1157                 return tmp.str();
1158
1159         return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1160 }
1161
1162
1163 bool LaTeXFeatures::needBabelLangOptions() const
1164 {
1165         if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1166                 return true;
1167
1168         LanguageList::const_iterator it  = UsedLanguages_.begin();
1169         LanguageList::const_iterator end = UsedLanguages_.end();
1170         for (; it != end; ++it)
1171                 if ((*it)->asBabelOptions())
1172                         return true;
1173
1174         return false;
1175 }
1176
1177
1178 string const LaTeXFeatures::loadAMSPackages() const
1179 {
1180         ostringstream tmp;
1181         if (mustProvide("amsthm"))
1182                 tmp << "\\usepackage{amsthm}\n";
1183
1184         if (mustProvide("amsmath")
1185             && params_.use_package("amsmath") != BufferParams::package_off) {
1186                 tmp << "\\usepackage{amsmath}\n";
1187         } else {
1188                 // amsbsy and amstext are already provided by amsmath
1189                 if (mustProvide("amsbsy"))
1190                         tmp << "\\usepackage{amsbsy}\n";
1191                 if (mustProvide("amstext"))
1192                         tmp << "\\usepackage{amstext}\n";
1193         }
1194
1195         if (mustProvide("amssymb")
1196             && params_.use_package("amssymb") != BufferParams::package_off)
1197                 tmp << "\\usepackage{amssymb}\n";
1198
1199         return tmp.str();
1200 }
1201
1202
1203 docstring const LaTeXFeatures::getTClassPreamble() const
1204 {
1205         // the text class specific preamble
1206         DocumentClass const & tclass = params_.documentClass();
1207         odocstringstream tcpreamble;
1208
1209         tcpreamble << tclass.preamble();
1210
1211         list<docstring>::const_iterator cit = usedLayouts_.begin();
1212         list<docstring>::const_iterator end = usedLayouts_.end();
1213         for (; cit != end; ++cit)
1214                 tcpreamble << tclass[*cit].preamble();
1215
1216         cit = usedInsetLayouts_.begin();
1217         end = usedInsetLayouts_.end();
1218         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1219         for (; cit != end; ++cit) {
1220                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1221                 if (it == ils.end())
1222                         continue;
1223                 tcpreamble << it->second.preamble();
1224         }
1225
1226         return tcpreamble.str();
1227 }
1228
1229
1230 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1231 {
1232         DocumentClass const & tclass = params_.documentClass();
1233         odocstringstream tcpreamble;
1234
1235         tcpreamble << tclass.htmlpreamble();
1236
1237         list<docstring>::const_iterator cit = usedLayouts_.begin();
1238         list<docstring>::const_iterator end = usedLayouts_.end();
1239         for (; cit != end; ++cit)
1240                 tcpreamble << tclass[*cit].htmlpreamble();
1241
1242         cit = usedInsetLayouts_.begin();
1243         end = usedInsetLayouts_.end();
1244         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1245         for (; cit != end; ++cit) {
1246                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1247                 if (it == ils.end())
1248                         continue;
1249                 tcpreamble << it->second.htmlpreamble();
1250         }
1251
1252         return tcpreamble.str();
1253 }
1254
1255
1256 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1257 {
1258         DocumentClass const & tclass = params_.documentClass();
1259         odocstringstream tcpreamble;
1260
1261         tcpreamble << tclass.htmlstyles();
1262
1263         list<docstring>::const_iterator cit = usedLayouts_.begin();
1264         list<docstring>::const_iterator end = usedLayouts_.end();
1265         for (; cit != end; ++cit)
1266                 tcpreamble << tclass[*cit].htmlstyle();
1267
1268         cit = usedInsetLayouts_.begin();
1269         end = usedInsetLayouts_.end();
1270         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1271         for (; cit != end; ++cit) {
1272                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1273                 if (it == ils.end())
1274                         continue;
1275                 tcpreamble << it->second.htmlstyle();
1276         }
1277
1278         return tcpreamble.str();
1279 }
1280
1281
1282 namespace {
1283 docstring const getFloatI18nPreamble(docstring const & type,
1284                         docstring const & name, Language const * lang,
1285                         Encoding const & enc, bool const polyglossia)
1286 {
1287         // Check whether name can be encoded in the buffer encoding
1288         bool encodable = true;
1289         for (size_t i = 0; i < name.size(); ++i) {
1290                 if (!enc.encodable(name[i])) {
1291                         encodable = false;
1292                         break;
1293                 }
1294         }
1295
1296         docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1297                                                : from_ascii(lang->babel());
1298         docstring const langenc = from_ascii(lang->encoding()->iconvName());
1299         docstring const texenc = from_ascii(lang->encoding()->latexName());
1300         docstring const bufenc = from_ascii(enc.iconvName());
1301         docstring const s1 = docstring(1, 0xF0000);
1302         docstring const s2 = docstring(1, 0xF0001);
1303         docstring const translated = encodable ? name
1304                 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1305                         + s1 + langenc + s2 + name + s1 + bufenc + s2;
1306
1307         odocstringstream os;
1308         os << "\\addto\\captions" << language
1309            << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1310         return os.str();
1311 }
1312
1313
1314 docstring const i18npreamble(docstring const & templ, Language const * lang,
1315                 Encoding const & enc, bool const polyglossia)
1316 {
1317         if (templ.empty())
1318                 return templ;
1319
1320         string preamble = polyglossia ?
1321                 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1322                 subst(to_utf8(templ), "$$lang", lang->babel());
1323
1324         string const langenc = lang->encoding()->iconvName();
1325         string const texenc = lang->encoding()->latexName();
1326         string const bufenc = enc.iconvName();
1327         // First and second character of plane 15 (Private Use Area)
1328         string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1329         string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1330         // FIXME UNICODE
1331         // lyx::regex is not unicode-safe.
1332         // Should use QRegExp or (boost::u32regex, but that requires ICU)
1333         static regex const reg("_\\(([^\\)]+)\\)");
1334         smatch sub;
1335         while (regex_search(preamble, sub, reg)) {
1336                 string const key = sub.str(1);
1337                 docstring const name = lang->translateLayout(key);
1338                 // Check whether name can be encoded in the buffer encoding
1339                 bool encodable = true;
1340                 for (size_t i = 0; i < name.size(); ++i) {
1341                         if (!enc.encodable(name[i])) {
1342                                 encodable = false;
1343                                 break;
1344                         }
1345                 }
1346                 string const translated = encodable ? to_utf8(name)
1347                         : "\\inputencoding{" + texenc + "}"
1348                         + s1 + langenc + s2 + to_utf8(name)
1349                         + s1 + bufenc + s2;
1350                 preamble = subst(preamble, sub.str(), translated);
1351         }
1352         return from_utf8(preamble);
1353 }
1354
1355 }
1356
1357
1358 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const
1359 {
1360         DocumentClass const & tclass = params_.documentClass();
1361         // collect preamble snippets in a set to prevent multiple identical
1362         // commands (would happen if e.g. both theorem and theorem* are used)
1363         set<docstring> snippets;
1364         typedef LanguageList::const_iterator lang_it;
1365         lang_it const lbeg = UsedLanguages_.begin();
1366         lang_it const lend =  UsedLanguages_.end();
1367         list<docstring>::const_iterator cit = usedLayouts_.begin();
1368         list<docstring>::const_iterator end = usedLayouts_.end();
1369         for (; cit != end; ++cit) {
1370                 // language dependent commands (once per document)
1371                 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1372                                                 buffer().language(),
1373                                                 buffer().params().encoding(),
1374                                                 use_polyglossia));
1375                 // commands for language changing (for multilanguage documents)
1376                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1377                         snippets.insert(i18npreamble(
1378                                                 tclass[*cit].babelpreamble(),
1379                                                 buffer().language(),
1380                                                 buffer().params().encoding(),
1381                                                 use_polyglossia));
1382                         for (lang_it lit = lbeg; lit != lend; ++lit)
1383                                 snippets.insert(i18npreamble(
1384                                                 tclass[*cit].babelpreamble(),
1385                                                 *lit,
1386                                                 buffer().params().encoding(),
1387                                                 use_polyglossia));
1388                 }
1389         }
1390         if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1391                 FloatList const & floats = params_.documentClass().floats();
1392                 UsedFloats::const_iterator fit = usedFloats_.begin();
1393                 UsedFloats::const_iterator fend = usedFloats_.end();
1394                 for (; fit != fend; ++fit) {
1395                         Floating const & fl = floats.getType(fit->first);
1396                         // we assume builtin floats are translated
1397                         if (fl.isPredefined())
1398                                 continue;
1399                         docstring const type = from_ascii(fl.floattype());
1400                         docstring const flname = from_utf8(fl.name());
1401                         docstring name = buffer().language()->translateLayout(fl.name());
1402                         // only request translation if we have a real translation
1403                         // (that differs from the source)
1404                         if (flname != name)
1405                                 snippets.insert(getFloatI18nPreamble(
1406                                                 type, name, buffer().language(),
1407                                                 buffer().params().encoding(),
1408                                                 use_polyglossia));
1409                         for (lang_it lit = lbeg; lit != lend; ++lit) {
1410                                 string const code = (*lit)->code();
1411                                 name = (*lit)->translateLayout(fl.name());
1412                                 // we assume we have a suitable translation if
1413                                 // either the language is English (we need to
1414                                 // translate into English if English is a secondary
1415                                 // language) or if translateIfPossible returns
1416                                 // something different to the English source.
1417                                 bool const have_translation =
1418                                         (flname != name || contains(code, "en"));
1419                                 if (have_translation)
1420                                         snippets.insert(getFloatI18nPreamble(
1421                                                 type, name, *lit,
1422                                                 buffer().params().encoding(),
1423                                                 use_polyglossia));
1424                         }
1425                 }
1426         }
1427
1428         cit = usedInsetLayouts_.begin();
1429         end = usedInsetLayouts_.end();
1430         TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1431         for (; cit != end; ++cit) {
1432                 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1433                 if (it == ils.end())
1434                         continue;
1435                 // language dependent commands (once per document)
1436                 snippets.insert(i18npreamble(it->second.langpreamble(),
1437                                                 buffer().language(),
1438                                                 buffer().params().encoding(),
1439                                                 use_polyglossia));
1440                 // commands for language changing (for multilanguage documents)
1441                 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1442                         snippets.insert(i18npreamble(
1443                                                 it->second.babelpreamble(),
1444                                                 buffer().language(),
1445                                                 buffer().params().encoding(),
1446                                                 use_polyglossia));
1447                         for (lang_it lit = lbeg; lit != lend; ++lit)
1448                                 snippets.insert(i18npreamble(
1449                                                 it->second.babelpreamble(),
1450                                                 *lit,
1451                                                 buffer().params().encoding(),
1452                                                 use_polyglossia));
1453                 }
1454         }
1455
1456         odocstringstream tcpreamble;
1457         set<docstring>::const_iterator const send = snippets.end();
1458         set<docstring>::const_iterator it = snippets.begin();
1459         for (; it != send; ++it)
1460                 tcpreamble << *it;
1461         return tcpreamble.str();
1462 }
1463
1464
1465 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1466 {
1467         // Definition of entities used in the document that are LyX related.
1468         odocstringstream entities;
1469
1470         if (mustProvide("lyxarrow")) {
1471                 entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
1472         }
1473
1474         return entities.str();
1475 }
1476
1477
1478 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1479 {
1480         odocstringstream sgmlpreamble;
1481         // FIXME UNICODE
1482         docstring const basename(from_utf8(onlyPath(fname)));
1483
1484         FileMap::const_iterator end = IncludedFiles_.end();
1485         for (FileMap::const_iterator fi = IncludedFiles_.begin();
1486              fi != end; ++fi)
1487                 // FIXME UNICODE
1488                 sgmlpreamble << "\n<!ENTITY " << fi->first
1489                              << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1490                              << makeRelPath(from_utf8(fi->second), basename) << "\">";
1491
1492         return sgmlpreamble.str();
1493 }
1494
1495
1496 void LaTeXFeatures::showStruct() const
1497 {
1498         lyxerr << "LyX needs the following commands when LaTeXing:"
1499                << "\n***** Packages:" << getPackages()
1500                << "\n***** Macros:" << to_utf8(getMacros())
1501                << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1502                << "\n***** done." << endl;
1503 }
1504
1505
1506 Buffer const & LaTeXFeatures::buffer() const
1507 {
1508         return *buffer_;
1509 }
1510
1511
1512 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1513 {
1514         buffer_ = &buffer;
1515 }
1516
1517
1518 BufferParams const & LaTeXFeatures::bufferParams() const
1519 {
1520         return params_;
1521 }
1522
1523
1524 void LaTeXFeatures::getFloatDefinitions(odocstream & os) const
1525 {
1526         FloatList const & floats = params_.documentClass().floats();
1527
1528         // Here we will output the code to create the needed float styles.
1529         // We will try to do this as minimal as possible.
1530         // \floatstyle{ruled}
1531         // \newfloat{algorithm}{htbp}{loa}
1532         // \providecommand{\algorithmname}{Algorithm}
1533         // \floatname{algorithm}{\protect\algorithmname}
1534         UsedFloats::const_iterator cit = usedFloats_.begin();
1535         UsedFloats::const_iterator end = usedFloats_.end();
1536         for (; cit != end; ++cit) {
1537                 Floating const & fl = floats.getType(cit->first);
1538
1539                 // For builtin floats we do nothing.
1540                 if (fl.isPredefined())
1541                         continue;
1542
1543                 // We have to special case "table" and "figure"
1544                 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
1545                         // Output code to modify "table" or "figure"
1546                         // but only if builtin == false
1547                         // and that have to be true at this point in the
1548                         // function.
1549                         docstring const type = from_ascii(fl.floattype());
1550                         docstring const placement = from_ascii(fl.placement());
1551                         docstring const style = from_ascii(fl.style());
1552                         if (!style.empty()) {
1553                                 os << "\\floatstyle{" << style << "}\n"
1554                                    << "\\restylefloat{" << type << "}\n";
1555                         }
1556                         if (!placement.empty()) {
1557                                 os << "\\floatplacement{" << type << "}{"
1558                                    << placement << "}\n";
1559                         }
1560                 } else {
1561                         // The other non builtin floats.
1562
1563                         docstring const type = from_ascii(fl.floattype());
1564                         docstring const placement = from_ascii(fl.placement());
1565                         docstring const ext = from_ascii(fl.ext());
1566                         docstring const within = from_ascii(fl.within());
1567                         docstring const style = from_ascii(fl.style());
1568                         docstring const name =
1569                                 buffer().language()->translateLayout(fl.name());
1570                         os << "\\floatstyle{" << style << "}\n"
1571                            << "\\newfloat{" << type << "}{" << placement
1572                            << "}{" << ext << '}';
1573                         if (!within.empty())
1574                                 os << '[' << within << ']';
1575                         os << '\n'
1576                            << "\\providecommand{\\" << type << "name}{"
1577                            << name << "}\n"
1578                            << "\\floatname{" << type << "}{\\protect\\"
1579                            << type << "name}\n";
1580
1581                         // What missing here is to code to minimalize the code
1582                         // output so that the same floatstyle will not be
1583                         // used several times, when the same style is still in
1584                         // effect. (Lgb)
1585                 }
1586                 if (cit->second)
1587                         os << "\n\\newsubfloat{" << from_ascii(fl.floattype()) << "}\n";
1588         }
1589 }
1590
1591
1592 void LaTeXFeatures::resolveAlternatives()
1593 {
1594         for (Features::iterator it = features_.begin(); it != features_.end();) {
1595                 if (contains(*it, '|')) {
1596                         vector<string> const alternatives = getVectorFromString(*it, "|");
1597                         vector<string>::const_iterator const end = alternatives.end();
1598                         vector<string>::const_iterator ita = alternatives.begin();
1599                         for (; ita != end; ++ita) {
1600                                 if (isRequired(*ita))
1601                                         break;
1602                         }
1603                         if (ita == end)
1604                                 require(alternatives.front());
1605                         features_.erase(it);
1606                         it = features_.begin();
1607                 } else
1608                         ++it;
1609         }
1610 }
1611
1612
1613 } // namespace lyx