2 * \file LaTeXFeatures.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * Full author contact details are available in file CREDITS.
17 #include "LaTeXFeatures.h"
20 #include "BufferParams.h"
22 #include "Converter.h"
25 #include "FloatList.h"
27 #include "LaTeXFonts.h"
28 #include "LaTeXPackages.h"
32 #include "TextClass.h"
34 #include "texstream.h"
36 #include "insets/InsetLayout.h"
38 #include "support/debug.h"
39 #include "support/docstream.h"
40 #include "support/FileName.h"
41 #include "support/filetools.h"
42 #include "support/gettext.h"
43 #include "support/lstrings.h"
44 #include "support/regex.h"
50 using namespace lyx::support;
55 /////////////////////////////////////////////////////////////////////
59 /////////////////////////////////////////////////////////////////////
61 //\NeedsTeXFormat{LaTeX2e}
62 //\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
63 //\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
65 static docstring const lyx_def = from_ascii(
66 "\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}");
68 static docstring const lyx_hyperref_def = from_ascii(
69 "\\providecommand{\\LyX}{\\texorpdfstring%\n"
70 " {L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}\n"
73 static docstring const noun_def = from_ascii(
74 "\\newcommand{\\noun}[1]{\\textsc{#1}}");
76 static docstring const lyxarrow_def = from_ascii(
77 "\\DeclareRobustCommand*{\\lyxarrow}{%\n"
79 "{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
80 "{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}");
82 // ZERO WIDTH SPACE (ZWSP) is actually not a space character
83 // but marks a line break opportunity. Several commands provide a
84 // line break opportunity. They differ in side-effects:
85 // \allowbreak prevents hyphenation after hyphen or dash + ZWSP
86 // \linebreak[<n>] takes an optional argument denoting "urgency".
87 // The \LyXZeroWidthSpace wrapper allows customization in the preamble.
88 static docstring const lyxZWSP_def = from_ascii(
89 "\\newcommand*\\LyXZeroWidthSpace{\\hspace{0pt}}");
91 // for quotes without babel. This does not give perfect results, but
92 // anybody serious about non-english quotes should use babel (JMarc).
94 static docstring const quotedblbase_def = from_ascii(
95 "\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
96 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
97 " \\penalty10000\\hskip0em\\relax%\n"
100 static docstring const quotesinglbase_def = from_ascii(
101 "\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
102 " \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
103 " \\penalty10000\\hskip0em\\relax%\n"
106 static docstring const guillemotleft_def = from_ascii(
107 "\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
108 " {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
109 "\\penalty10000\\hskip0pt\\relax%\n"
112 static docstring const guillemotright_def = from_ascii(
113 "\\ProvideTextCommandDefault{\\guillemotright}{%\n"
114 " \\penalty10000\\hskip0pt%\n"
115 " {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
118 static docstring const guilsinglleft_def = from_ascii(
119 "\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
120 " {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
121 " \\penalty10000\\hskip0pt\\relax%\n"
124 static docstring const guilsinglright_def = from_ascii(
125 "\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
126 " \\penalty10000\\hskip0pt%\n"
127 " {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
130 static docstring const textquotedbl_def = from_ascii(
131 "\\DeclareTextSymbolDefault{\\textquotedbl}{T1}");
133 static docstring const textquotedblp_xetex_def = from_ascii(
134 "\\providecommand\\textquotedblplain{%\n"
135 " \\bgroup\\addfontfeatures{Mapping=}\\char34\\egroup}");
137 static docstring const textquotedblp_luatex_def = from_ascii(
138 "\\providecommand\\textquotedblplain{%\n"
139 " \\bgroup\\addfontfeatures{RawFeature=-tlig}\\char34\\egroup}");
141 static docstring const textquotesinglep_xetex_def = from_ascii(
142 "\\providecommand\\textquotesingleplain{%\n"
143 " \\bgroup\\addfontfeatures{Mapping=}\\char39\\egroup}");
145 static docstring const textquotesinglep_luatex_def = from_ascii(
146 "\\providecommand\\textquotesingleplain{%\n"
147 " \\bgroup\\addfontfeatures{RawFeature=-tlig}\\char39\\egroup}");
149 static docstring const paragraphleftindent_def = from_ascii(
150 "\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
152 " \\begin{list}{}{%\n"
153 " \\setlength{\\topsep}{0pt}%\n"
154 " \\addtolength{\\leftmargin}{#1}\n"
155 // ho hum, yet more things commented out with no hint as to why they
156 // weren't just removed
157 // "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
158 // "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
159 // "%% \\setlength\\listparindent\\parindent%\n"
160 // "%% \\setlength\\itemindent\\parindent%\n"
161 " \\setlength{\\parsep}{0pt plus 1pt}%\n"
167 static docstring const floatingfootnote_def = from_ascii(
168 "%% Special footnote code from the package 'stblftnt.sty'\n"
169 "%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
170 "\\let\\SF@@footnote\\footnote\n"
171 "\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
172 " \\expandafter\\SF@@footnote\n"
174 " \\expandafter\\SF@gobble@opt\n"
177 "\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
178 " \\SF@gobble@twobracket\n"
181 "\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
182 " \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
183 "\\def\\SF@gobble@twobracket[#1]#2{}\n");
185 static docstring const binom_def = from_ascii(
186 "%% Binom macro for standard LaTeX users\n"
187 "\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n");
189 static docstring const mathcircumflex_def = from_ascii(
190 "%% For printing a cirumflex inside a formula\n"
191 "\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n");
193 static docstring const tabularnewline_def = from_ascii(
194 "%% Because html converters don't know tabularnewline\n"
195 "\\providecommand{\\tabularnewline}{\\\\}\n");
197 static docstring const lyxgreyedout_def = from_ascii(
198 "%% The greyedout annotation environment\n"
199 "\\newenvironment{lyxgreyedout}\n"
200 " {\\textcolor{note_fontcolor}\\bgroup\\ignorespaces}\n"
201 " {\\ignorespacesafterend\\egroup}\n");
203 // We want to omit the file extension for includegraphics, but this does not
204 // work when the filename contains other dots.
205 // Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
206 static docstring const lyxdot_def = from_ascii(
207 "%% A simple dot to overcome graphicx limitations\n"
208 "\\newcommand{\\lyxdot}{.}\n");
210 static docstring const changetracking_dvipost_def = from_ascii(
211 "%% Change tracking with dvipost\n"
213 "\\dvipost{osstart color push Red}\n"
214 "\\dvipost{osend color pop}\n"
215 "\\dvipost{cbstart color push Blue}\n"
216 "\\dvipost{cbend color pop}\n"
217 "\\DeclareRobustCommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
218 "\\DeclareRobustCommand{\\lyxdeleted}[3]{%\n"
219 "\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n");
221 static docstring const changetracking_xcolor_ulem_def = from_ascii(
222 "%% Change tracking with ulem\n"
223 "\\DeclareRobustCommand{\\lyxadded}[3]{{\\color{lyxadded}{}#3}}\n"
224 "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\lyxsout{#3}}}\n"
225 "\\DeclareRobustCommand{\\lyxsout}[1]{\\ifx\\\\#1\\else\\sout{#1}\\fi}\n");
227 static docstring const changetracking_xcolor_ulem_hyperref_def = from_ascii(
228 "%% Change tracking with ulem\n"
229 "\\DeclareRobustCommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}{}}{}#3}}\n"
230 "\\DeclareRobustCommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\lyxsout{#3}}{}}}\n"
231 "\\DeclareRobustCommand{\\lyxsout}[1]{\\ifx\\\\#1\\else\\sout{#1}\\fi}\n");
233 static docstring const changetracking_tikz_math_sout_def = from_ascii(
234 "%% Strike out display math with tikz\n"
235 "\\usepackage{tikz}\n"
236 "\\usetikzlibrary{calc}\n"
237 "\\newcommand{\\lyxmathsout}[1]{%\n"
238 " \\tikz[baseline=(math.base)]{\n"
239 " \\node[inner sep=0pt,outer sep=0pt](math){#1};\n"
240 " \\draw($(math.south west)+(2em,.5em)$)--($(math.north east)-(2em,.5em)$);\n"
244 static docstring const changetracking_none_def = from_ascii(
245 "\\newcommand{\\lyxadded}[3]{#3}\n"
246 "\\newcommand{\\lyxdeleted}[3]{}\n");
248 static docstring const textgreek_LGR_def = from_ascii(
249 "\\DeclareFontEncoding{LGR}{}{}\n");
250 static docstring const textgreek_def = from_ascii(
251 "\\DeclareRobustCommand{\\greektext}{%\n"
252 " \\fontencoding{LGR}\\selectfont\\def\\encodingdefault{LGR}}\n"
253 "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n");
255 static docstring const textcyr_T2A_def = from_ascii(
256 "\\InputIfFileExists{t2aenc.def}{}{%\n"
257 " \\errmessage{File `t2aenc.def' not found: Cyrillic script not supported}}\n");
258 static docstring const textcyr_def = from_ascii(
259 "\\DeclareRobustCommand{\\cyrtext}{%\n"
260 " \\fontencoding{T2A}\\selectfont\\def\\encodingdefault{T2A}}\n"
261 "\\DeclareRobustCommand{\\textcyrillic}[1]{\\leavevmode{\\cyrtext #1}}\n");
263 static docstring const lyxmathsym_def = from_ascii(
264 "\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
265 " \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n");
267 static docstring const papersizedvi_def = from_ascii(
268 "\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n");
270 static docstring const papersizepdf_def = from_ascii(
271 "\\pdfpageheight\\paperheight\n"
272 "\\pdfpagewidth\\paperwidth\n");
274 static docstring const papersizepdflua_def = from_ascii(
275 "% Backwards compatibility for LuaTeX < 0.90\n"
276 "\\@ifundefined{pageheight}{\\let\\pageheight\\pdfpageheight}{}\n"
277 "\\@ifundefined{pagewidth}{\\let\\pagewidth\\pdfpagewidth}{}\n"
278 "\\pageheight\\paperheight\n"
279 "\\pagewidth\\paperwidth\n");
281 static docstring const cedilla_def = from_ascii(
282 "\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
283 "\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n");
285 static docstring const subring_def = from_ascii(
286 "\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
287 "\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n");
289 static docstring const subdot_def = from_ascii(
290 "\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
291 "\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n");
293 static docstring const subhat_def = from_ascii(
294 "\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
295 "\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n");
297 static docstring const subtilde_def = from_ascii(
298 "\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
299 "\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n");
301 static docstring const dacute_def = from_ascii(
302 "\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n");
304 static docstring const tipasymb_def = from_ascii(
305 "\\DeclareFontEncoding{T3}{}{}\n"
306 "\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n");
308 static docstring const dgrave_def = from_ascii(
309 "\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n");
311 static docstring const rcap_def = from_ascii(
312 "\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n");
314 static docstring const ogonek_def = from_ascii(
315 "\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
316 " \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
317 " \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
318 " \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
319 "\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n");
321 static docstring const lyxaccent_def = from_ascii(
322 "%% custom text accent \\LyxTextAccent[<rise value (length)>]{<accent>}{<base>}\n"
323 "\\newcommand*{\\LyxTextAccent}[3][0ex]{%\n"
324 " \\hmode@bgroup\\ooalign{\\null#3\\crcr\\hidewidth\n"
325 " \\raise#1\\hbox{#2}\\hidewidth}\\egroup}\n"
326 "%% select a font size smaller than the current font size:\n"
327 "\\newcommand{\\LyxAccentSize}[1][\\sf@size]{%\n"
328 " \\check@mathfonts\\fontsize#1\\z@\\math@fontsfalse\\selectfont\n"
331 static docstring const textcommabelow_def = from_ascii(
332 "\\ProvideTextCommandDefault{\\textcommabelow}[1]{%%\n"
333 " \\LyxTextAccent[-.31ex]{\\LyxAccentSize,}{#1}}\n");
335 static docstring const textcommaabove_def = from_ascii(
336 "\\ProvideTextCommandDefault{\\textcommaabove}[1]{%%\n"
337 " \\LyxTextAccent[.5ex]{\\LyxAccentSize`}{#1}}\n");
339 static docstring const textcommaaboveright_def = from_ascii(
340 "\\ProvideTextCommandDefault{\\textcommaaboveright}[1]{%%\n"
341 " \\LyxTextAccent[.5ex]{\\LyxAccentSize\\ '}{#1}}\n");
343 // Baltic languages use a comma-accent instead of a cedilla
344 static docstring const textbaltic_def = from_ascii(
345 "%% use comma accent instead of cedilla for these characters:\n"
346 "\\DeclareTextCompositeCommand{\\c}{T1}{g}{\\textcommaabove{g}}\n"
347 "\\DeclareTextCompositeCommand{\\c}{T1}{G}{\\textcommabelow{G}}\n"
348 "\\DeclareTextCompositeCommand{\\c}{T1}{k}{\\textcommabelow{k}}\n"
349 "\\DeclareTextCompositeCommand{\\c}{T1}{K}{\\textcommabelow{K}}\n"
350 "\\DeclareTextCompositeCommand{\\c}{T1}{l}{\\textcommabelow{l}}\n"
351 "\\DeclareTextCompositeCommand{\\c}{T1}{L}{\\textcommabelow{L}}\n"
352 "\\DeclareTextCompositeCommand{\\c}{T1}{n}{\\textcommabelow{n}}\n"
353 "\\DeclareTextCompositeCommand{\\c}{T1}{N}{\\textcommabelow{N}}\n"
354 "\\DeclareTextCompositeCommand{\\c}{T1}{r}{\\textcommabelow{r}}\n"
355 "\\DeclareTextCompositeCommand{\\c}{T1}{R}{\\textcommabelow{R}}\n");
357 // split-level fractions
358 static docstring const xfrac_def = from_ascii(
359 "\\usepackage{xfrac}\n");
360 static docstring const smallLetterFrac_def = from_ascii(
361 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{default}{text}\n"
362 " {phantom=c, scale-factor=1.0, slash-left-kern=-.05em}\n"
363 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmr}{text}\n"
364 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
365 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{lmss}{text}\n"
366 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
367 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmr}{text}\n"
368 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
369 "\\DeclareCollectionInstance{smallLetterFrac}{xfrac}{cmss}{text}\n"
370 " {slash-symbol-font=ptm, phantom=c, scale-factor=1, slash-left-kern=-.05em}\n"
371 "\\newcommand{\\smallLetterFrac}[2]{%\n"
372 " {\\UseCollection{xfrac}{smallLetterFrac}\\sfrac{#1}{#2}}}\n");
374 static docstring const lyxref_def = from_ascii(
375 "\\RS@ifundefined{subsecref}\n"
376 " {\\newref{subsec}{name = \\RSsectxt}}\n"
378 "\\RS@ifundefined{thmref}\n"
379 " {\\def\\RSthmtxt{theorem~}\\newref{thm}{name = \\RSthmtxt}}\n"
381 "\\RS@ifundefined{lemref}\n"
382 " {\\def\\RSlemtxt{lemma~}\\newref{lem}{name = \\RSlemtxt}}\n"
385 // Make sure the columns are also outputed as rtl
386 static docstring const rtloutputdblcol_def = from_ascii(
387 "\\def\\@outputdblcol{%\n"
388 " \\if@firstcolumn\n"
389 " \\global \\@firstcolumnfalse\n"
390 " \\global \\setbox\\@leftcolumn \\box\\@outputbox\n"
392 " \\global \\@firstcolumntrue\n"
393 " \\setbox\\@outputbox \\vbox {%\n"
394 " \\hb@xt@\\textwidth {%\n"
395 " \\kern\\textwidth \\kern-\\columnwidth %**\n"
396 " \\hb@xt@\\columnwidth {%\n"
397 " \\box\\@leftcolumn \\hss}%\n"
398 " \\kern-\\textwidth %**\n"
400 " {\\normalcolor\\vrule \\@width\\columnseprule}%\n"
402 " \\kern-\\textwidth %**\n"
403 " \\hb@xt@\\columnwidth {%\n"
404 " \\box\\@outputbox \\hss}%\n"
405 " \\kern-\\columnwidth \\kern\\textwidth %**\n"
408 " \\@combinedblfloats\n"
411 " \\@dblfloatplacement\n"
412 " \\@startdblcolumn\n"
413 " \\@whilesw\\if@fcolmade \\fi\n"
415 " \\@startdblcolumn}%\n"
419 "\\@mparswitchtrue\n");
421 static docstring const lyxmintcaption_def = from_ascii(
422 "\\long\\def\\lyxmintcaption[#1]#2{%\n"
423 " \\ifx#1t\\vskip\\baselineskip\\fi%\n"
424 " \\refstepcounter{listing}\\noindent%\n"
425 " \\addcontentsline{lol}{listing}%\n"
426 " {\\protect\\numberline{\\thelisting}{\\ignorespaces #2}}%\n"
427 " \\setbox\\@tempboxa\\hbox{\\listingscaption~\\thelisting: #2}%\n"
428 " \\ifdim \\wd\\@tempboxa >\\linewidth%\n"
429 " \\parbox[t]{\\linewidth}{\\unhbox\\@tempboxa}\\else%\n"
430 " \\hbox to\\linewidth{\\hfil\\box\\@tempboxa\\hfil}\\fi%\n"
431 " \\ifx#1b\\vskip\\baselineskip\\fi\n"
435 /////////////////////////////////////////////////////////////////////
439 /////////////////////////////////////////////////////////////////////
441 static docstring const lyxnoun_style = from_ascii(
443 " font-variant: small-caps;\n"
447 // this is how it normally renders, but it might not always do so.
448 static docstring const lyxstrikeout_style = from_ascii(
450 " text-decoration: line-through;\n"
454 /////////////////////////////////////////////////////////////////////
458 /////////////////////////////////////////////////////////////////////
461 LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
462 OutputParams const & r)
463 : buffer_(&b), params_(p), runparams_(r), in_float_(false),
464 in_deleted_inset_(false)
468 LaTeXFeatures::LangPackage LaTeXFeatures::langPackage() const
470 string const local_lp = bufferParams().lang_package;
472 // Locally, custom is just stored as a string
473 // in bufferParams().lang_package.
474 if (local_lp != "auto"
475 && local_lp != "babel"
476 && local_lp != "default"
477 && local_lp != "none")
478 return LANG_PACK_CUSTOM;
480 if (local_lp == "none")
481 return LANG_PACK_NONE;
483 /* If "auto" is selected, we load polyglossia with non-TeX fonts,
484 * else we select babel.
485 * If babel is selected (either directly or via the "auto"
486 * mechanism), we really do only require it if we have
487 * a language that needs it.
489 bool const polyglossia_required =
490 params_.useNonTeXFonts
491 && isAvailable("polyglossia")
492 && !isProvided("babel")
493 && this->hasOnlyPolyglossiaLanguages();
494 bool const babel_required =
495 !bufferParams().language->babel().empty()
496 || !this->getBabelLanguages().empty();
498 if (local_lp == "auto") {
499 // polyglossia requirement has priority over babel
500 if (polyglossia_required)
501 return LANG_PACK_POLYGLOSSIA;
502 else if (babel_required)
503 return LANG_PACK_BABEL;
506 if (local_lp == "babel") {
508 return LANG_PACK_BABEL;
511 if (local_lp == "default") {
512 switch (lyxrc.language_package_selection) {
514 // polyglossia requirement has priority over babel
515 if (polyglossia_required)
516 return LANG_PACK_POLYGLOSSIA;
517 else if (babel_required)
518 return LANG_PACK_BABEL;
520 case LyXRC::LP_BABEL:
522 return LANG_PACK_BABEL;
524 case LyXRC::LP_CUSTOM:
525 return LANG_PACK_CUSTOM;
527 return LANG_PACK_NONE;
531 return LANG_PACK_NONE;
535 void LaTeXFeatures::require(string const & name)
537 features_.insert(name);
541 void LaTeXFeatures::require(set<string> const & names)
543 features_.insert(names.begin(), names.end());
547 void LaTeXFeatures::provide(string const & name)
549 provides_.insert(name);
553 void LaTeXFeatures::useLayout(docstring const & layoutname)
555 useLayout(layoutname, 0);
559 void LaTeXFeatures::useLayout(docstring const & layoutname, int level)
561 // Some code to avoid loops in dependency definition
562 const int maxlevel = 30;
563 if (level > maxlevel) {
564 lyxerr << "LaTeXFeatures::useLayout: maximum level of "
565 << "recursion attained by layout "
566 << to_utf8(layoutname) << endl;
570 DocumentClass const & tclass = params_.documentClass();
571 if (tclass.hasLayout(layoutname)) {
572 // Is this layout already in usedLayouts?
573 if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
574 != usedLayouts_.end())
577 Layout const & layout = tclass[layoutname];
578 require(layout.requires());
580 if (!layout.depends_on().empty()) {
581 useLayout(layout.depends_on(), level + 1);
583 usedLayouts_.push_back(layoutname);
585 lyxerr << "LaTeXFeatures::useLayout: layout `"
586 << to_utf8(layoutname) << "' does not exist in this class"
592 void LaTeXFeatures::useInsetLayout(InsetLayout const & lay)
594 docstring const & lname = lay.name();
595 DocumentClass const & tclass = params_.documentClass();
597 // this is a default inset layout, nothing useful here
598 if (!tclass.hasInsetLayout(lname))
600 // Is this layout already in usedInsetLayouts?
601 if (find(usedInsetLayouts_.begin(), usedInsetLayouts_.end(), lname)
602 != usedInsetLayouts_.end())
605 require(lay.requires());
606 usedInsetLayouts_.push_back(lname);
610 bool LaTeXFeatures::isRequired(string const & name) const
612 return features_.find(name) != features_.end();
616 bool LaTeXFeatures::isProvided(string const & name) const
618 // Currently, this is only features provided by babel languages
619 // (such as textgreek)
620 if (provides_.find(name) != provides_.end())
623 if (params_.useNonTeXFonts)
624 return params_.documentClass().provides(name);
626 bool const ot1 = (params_.main_font_encoding() == "default"
627 || params_.main_font_encoding() == "OT1");
628 bool const complete = (params_.fontsSans() == "default"
629 && params_.fontsTypewriter() == "default");
630 bool const nomath = (params_.fontsMath() == "default");
631 return params_.documentClass().provides(name)
632 || theLaTeXFonts().getLaTeXFont(
633 from_ascii(params_.fontsRoman())).provides(name, ot1,
636 || theLaTeXFonts().getLaTeXFont(
637 from_ascii(params_.fontsSans())).provides(name, ot1,
640 || theLaTeXFonts().getLaTeXFont(
641 from_ascii(params_.fontsTypewriter())).provides(name, ot1,
644 || theLaTeXFonts().getLaTeXFont(
645 from_ascii(params_.fontsMath())).provides(name, ot1,
651 bool LaTeXFeatures::mustProvide(string const & name) const
653 return isRequired(name) && !isProvided(name);
657 bool LaTeXFeatures::isAvailable(string const & name)
659 string::size_type const i = name.find("->");
660 if (i != string::npos) {
661 string const from = name.substr(0,i);
662 string const to = name.substr(i+2);
663 //LYXERR0("from=[" << from << "] to=[" << to << "]");
664 return theConverters().isReachable(from, to);
666 return LaTeXPackages::isAvailable(name);
672 void addSnippet(std::list<TexString> & list, TexString ts, bool allow_dupes)
675 // test the absense of duplicates, i.e. elements with same str
676 none_of(list.begin(), list.end(), [&](TexString const & ts2){
677 return ts.str == ts2.str;
680 list.push_back(move(ts));
684 TexString getSnippets(std::list<TexString> const & list)
686 otexstringstream snip;
687 for (TexString const & ts : list)
688 snip << TexString(ts) << '\n';
689 return snip.release();
695 void LaTeXFeatures::addPreambleSnippet(TexString ts, bool allow_dupes)
697 addSnippet(preamble_snippets_, move(ts), allow_dupes);
701 void LaTeXFeatures::addPreambleSnippet(docstring const & str, bool allow_dupes)
703 addSnippet(preamble_snippets_, TexString(str), allow_dupes);
707 void LaTeXFeatures::addCSSSnippet(std::string const & snippet)
709 addSnippet(css_snippets_, TexString(from_ascii(snippet)), false);
713 TexString LaTeXFeatures::getPreambleSnippets() const
715 return getSnippets(preamble_snippets_);
719 docstring LaTeXFeatures::getCSSSnippets() const
721 return getSnippets(css_snippets_).str;
726 void LaTeXFeatures::useFloat(string const & name, bool subfloat)
728 if (!usedFloats_[name])
729 usedFloats_[name] = subfloat;
732 // We only need float.sty if we use non builtin floats, or if we
733 // use the "H" modifier. This includes modified table and
734 // figure floats. (Lgb)
735 Floating const & fl = params_.documentClass().floats().getType(name);
736 if (!fl.floattype().empty() && fl.usesFloatPkg()) {
742 void LaTeXFeatures::useLanguage(Language const * lang)
744 if (!lang->babel().empty() || !lang->polyglossia().empty())
745 UsedLanguages_.insert(lang);
746 if (!lang->requires().empty())
747 require(lang->requires());
748 // currently only supported for Babel
749 if (!lang->provides().empty() && useBabel())
750 provide(lang->provides());
751 // CJK languages do not have a babel name.
752 // They use the CJK package
753 if (lang->encoding()->package() == Encoding::CJK)
755 // japanese package is special
756 if (lang->encoding()->package() == Encoding::japanese)
761 void LaTeXFeatures::includeFile(docstring const & key, string const & name)
763 IncludedFiles_[key] = name;
767 bool LaTeXFeatures::hasLanguages() const
769 return !UsedLanguages_.empty();
773 bool LaTeXFeatures::hasOnlyPolyglossiaLanguages() const
775 // first the main language
776 if (params_.language->polyglossia().empty())
778 // now the secondary languages
779 LanguageList::const_iterator const begin = UsedLanguages_.begin();
780 for (LanguageList::const_iterator cit = begin;
781 cit != UsedLanguages_.end();
783 if ((*cit)->polyglossia().empty())
790 bool LaTeXFeatures::hasPolyglossiaExclusiveLanguages() const
792 // first the main language
793 if (params_.language->isPolyglossiaExclusive())
795 // now the secondary languages
796 LanguageList::const_iterator const begin = UsedLanguages_.begin();
797 for (LanguageList::const_iterator cit = begin;
798 cit != UsedLanguages_.end();
800 if ((*cit)->isPolyglossiaExclusive())
807 vector<string> LaTeXFeatures::getPolyglossiaExclusiveLanguages() const
809 vector<string> result;
810 // first the main language
811 if (params_.language->isPolyglossiaExclusive())
812 result.push_back(params_.language->display());
813 // now the secondary languages
814 LanguageList::const_iterator const begin = UsedLanguages_.begin();
815 for (LanguageList::const_iterator cit = begin;
816 cit != UsedLanguages_.end();
818 if ((*cit)->isPolyglossiaExclusive())
819 result.push_back((*cit)->display());
825 vector<string> LaTeXFeatures::getBabelExclusiveLanguages() const
827 vector<string> result;
828 // first the main language
829 if (params_.language->isBabelExclusive())
830 result.push_back(params_.language->display());
831 // now the secondary languages
832 LanguageList::const_iterator const begin = UsedLanguages_.begin();
833 for (LanguageList::const_iterator cit = begin;
834 cit != UsedLanguages_.end();
836 if ((*cit)->isBabelExclusive())
837 result.push_back((*cit)->display());
843 string LaTeXFeatures::getBabelLanguages() const
848 LanguageList::const_iterator const begin = UsedLanguages_.begin();
849 for (LanguageList::const_iterator cit = begin;
850 cit != UsedLanguages_.end();
852 if ((*cit)->babel().empty())
858 langs << (*cit)->babel();
864 set<string> LaTeXFeatures::getPolyglossiaLanguages() const
868 LanguageList::const_iterator const begin = UsedLanguages_.begin();
869 for (LanguageList::const_iterator cit = begin;
870 cit != UsedLanguages_.end();
872 // We do not need the variants here
873 langs.insert((*cit)->polyglossia());
879 set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
881 // This does only find encodings of languages supported by babel, but
882 // that does not matter since we don't have a language with an
883 // encoding supported by inputenc but without babel support.
885 for (auto const & lang : UsedLanguages_)
886 if (lang->encoding()->latexName() != doc_encoding &&
887 (lang->encoding()->package() == Encoding::inputenc
888 || lang->encoding()->package() == Encoding::japanese))
889 encs.insert(lang->encoding()->latexName());
894 void LaTeXFeatures::getFontEncodings(vector<string> & encs, bool const onlylangs) const
897 // these must be loaded if glyphs of this script are used
898 // unless a language providing them is used in the document
899 if (mustProvide("textgreek")
900 && find(encs.begin(), encs.end(), "LGR") == encs.end())
901 encs.insert(encs.begin(), "LGR");
902 if (mustProvide("textcyrillic")
903 && find(encs.begin(), encs.end(), "T2A") == encs.end())
904 encs.insert(encs.begin(), "T2A");
907 for (auto const & lang : UsedLanguages_) {
908 vector<string> extraencs =
909 getVectorFromString(lang->fontenc(buffer().masterParams()));
910 for (auto const & extra : extraencs) {
911 if (extra != "none" && find(encs.begin(), encs.end(), extra) == encs.end())
912 encs.insert(encs.begin(), extra);
919 char const * simplefeatures[] = {
920 // note that the package order here will be the same in the LaTeX-output
928 // subfig is handled in BufferParams.cpp
932 /*For a successful cooperation of the `wrapfig' package with the
933 `float' package you should load the `wrapfig' package *after*
934 the `float' package. See the caption package documentation
965 // listings is handled in BufferParams.cpp
989 char const * bibliofeatures[] = {
990 // Known bibliography packages (will be loaded before natbib)
1006 int const nb_bibliofeatures = sizeof(bibliofeatures) / sizeof(char const *);
1008 int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
1013 string const LaTeXFeatures::getColorOptions() const
1015 ostringstream colors;
1017 // Handling the color packages separately is needed to be able to load them
1018 // before babel when hyperref is loaded with the colorlinks option
1019 // for more info see Bufferparams.cpp
1022 if (mustProvide("color") || mustProvide("xcolor")) {
1023 string const package =
1024 (mustProvide("xcolor") ? "xcolor" : "color");
1025 if (params_.graphics_driver == "default"
1026 || params_.graphics_driver == "none")
1027 colors << "\\usepackage{" << package << "}\n";
1029 colors << "\\usepackage["
1030 << params_.graphics_driver
1031 << "]{" << package << "}\n";
1034 // pdfcolmk must be loaded after color
1035 if (mustProvide("pdfcolmk"))
1036 colors << "\\usepackage{pdfcolmk}\n";
1038 // the following 3 color commands must be set after color
1039 // is loaded and before pdfpages, therefore add the command
1040 // here define the set color
1041 if (mustProvide("pagecolor")) {
1042 colors << "\\definecolor{page_backgroundcolor}{rgb}{";
1043 colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
1044 // set the page color
1045 colors << "\\pagecolor{page_backgroundcolor}\n";
1048 if (mustProvide("fontcolor")) {
1049 colors << "\\definecolor{document_fontcolor}{rgb}{";
1050 colors << outputLaTeXColor(params_.fontcolor) << "}\n";
1052 colors << "\\color{document_fontcolor}\n";
1055 if (mustProvide("lyxgreyedout")) {
1056 colors << "\\definecolor{note_fontcolor}{rgb}{";
1057 colors << outputLaTeXColor(params_.notefontcolor) << "}\n";
1058 // the color will be set together with the definition of
1059 // the lyxgreyedout environment (see lyxgreyedout_def)
1062 // color for shaded boxes
1063 if (isRequired("framed") && mustProvide("color")) {
1064 colors << "\\definecolor{shadecolor}{rgb}{";
1065 colors << outputLaTeXColor(params_.boxbgcolor) << "}\n";
1066 // this color is automatically used by the LaTeX-package "framed"
1069 return colors.str();
1073 string const LaTeXFeatures::getPackageOptions() const
1075 ostringstream packageopts;
1076 // Output all the package option stuff we have been asked to do.
1077 map<string, string>::const_iterator it =
1078 params_.documentClass().packageOptions().begin();
1079 map<string, string>::const_iterator en =
1080 params_.documentClass().packageOptions().end();
1081 for (; it != en; ++it)
1082 if (mustProvide(it->first))
1083 packageopts << "\\PassOptionsToPackage{" << it->second << "}"
1084 << "{" << it->first << "}\n";
1085 return packageopts.str();
1089 string const LaTeXFeatures::getPackages() const
1091 ostringstream packages;
1093 // FIXME: currently, we can only load packages and macros known
1095 // However, with the Require tag of layouts/custom insets,
1096 // also unknown packages can be requested. They are silently
1097 // swallowed now. We should change this eventually.
1099 // These are all the 'simple' includes. i.e
1100 // packages which we just \usepackage{package}
1101 for (int i = 0; i < nb_simplefeatures; ++i) {
1102 if (mustProvide(simplefeatures[i]))
1103 packages << "\\usepackage{" << simplefeatures[i] << "}\n";
1106 // The rest of these packages are somewhat more complicated
1107 // than those above.
1109 // [pdf]lscape is used to rotate longtables
1110 if (mustProvide("lscape")) {
1111 if (runparams_.flavor == OutputParams::LATEX
1112 || runparams_.flavor == OutputParams::DVILUATEX)
1113 packages << "\\usepackage{lscape}\n";
1115 packages << "\\usepackage{pdflscape}\n";
1118 // The tipa package and its extensions (tipx, tone) must not
1119 // be loaded with non-TeX fonts, since fontspec includes the
1120 // respective macros
1121 if (mustProvide("tipa") && !params_.useNonTeXFonts)
1122 packages << "\\usepackage{tipa}\n";
1123 if (mustProvide("tipx") && !params_.useNonTeXFonts)
1124 packages << "\\usepackage{tipx}\n";
1125 if (mustProvide("extraipa") && !params_.useNonTeXFonts)
1126 packages << "\\usepackage{extraipa}\n";
1127 if (mustProvide("tone") && !params_.useNonTeXFonts)
1128 packages << "\\usepackage{tone}\n";
1130 // if fontspec or newtxmath is used, AMS packages have to be loaded
1131 // before fontspec (in BufferParams)
1132 string const amsPackages = loadAMSPackages();
1133 bool const ot1 = (params_.main_font_encoding() == "default"
1134 || params_.main_font_encoding() == "OT1");
1135 bool const use_newtxmath =
1136 theLaTeXFonts().getLaTeXFont(from_ascii(params_.fontsMath())).getUsedPackage(
1137 ot1, false, false) == "newtxmath";
1139 if (!params_.useNonTeXFonts && !use_newtxmath && !amsPackages.empty())
1140 packages << amsPackages;
1142 if (mustProvide("cancel") &&
1143 params_.use_package("cancel") != BufferParams::package_off)
1144 packages << "\\usepackage{cancel}\n";
1146 // marvosym and bbding both define the \Cross macro
1147 if (mustProvide("marvosym")) {
1148 if (mustProvide("bbding"))
1149 packages << "\\let\\Cross\\relax\n";
1150 packages << "\\usepackage{marvosym}\n";
1153 // accents must be loaded after amsmath
1154 if (mustProvide("accents") &&
1155 params_.use_package("accents") != BufferParams::package_off)
1156 packages << "\\usepackage{accents}\n";
1158 // mathdots must be loaded after amsmath
1159 if (mustProvide("mathdots") &&
1160 params_.use_package("mathdots") != BufferParams::package_off)
1161 packages << "\\usepackage{mathdots}\n";
1163 // yhmath must be loaded after amsmath
1164 if (mustProvide("yhmath") &&
1165 params_.use_package("yhmath") != BufferParams::package_off)
1166 packages << "\\usepackage{yhmath}\n";
1168 // stmaryrd must be loaded after amsmath
1169 if (mustProvide("stmaryrd") &&
1170 params_.use_package("stmaryrd") != BufferParams::package_off)
1171 packages << "\\usepackage{stmaryrd}\n";
1173 if (mustProvide("stackrel") &&
1174 params_.use_package("stackrel") != BufferParams::package_off)
1175 packages << "\\usepackage{stackrel}\n";
1177 if (mustProvide("undertilde") &&
1178 params_.use_package("undertilde") != BufferParams::package_off)
1179 packages << "\\usepackage{undertilde}\n";
1181 // [x]color and pdfcolmk are handled in getColorOptions() above
1184 if (isRequired("makeidx") || isRequired("splitidx")) {
1185 if (!isProvided("makeidx") && !isRequired("splitidx"))
1186 packages << "\\usepackage{makeidx}\n";
1187 if (mustProvide("splitidx"))
1188 packages << "\\usepackage{splitidx}\n";
1189 packages << "\\makeindex\n";
1193 if (mustProvide("graphicx") && params_.graphics_driver != "none") {
1194 if (params_.graphics_driver == "default")
1195 packages << "\\usepackage{graphicx}\n";
1197 packages << "\\usepackage["
1198 << params_.graphics_driver
1202 // lyxskak.sty --- newer chess support based on skak.sty
1203 if (mustProvide("chess"))
1204 packages << "\\usepackage[ps,mover]{lyxskak}\n";
1207 if (mustProvide("setspace") && !isProvided("SetSpace"))
1208 packages << "\\usepackage{setspace}\n";
1210 // we need to assure that mhchem is loaded before esint and every other
1211 // package that redefines command of amsmath because mhchem loads amlatex
1212 // (this info is from the author of mhchem from June 2013)
1213 if (mustProvide("mhchem") &&
1214 params_.use_package("mhchem") != BufferParams::package_off)
1215 packages << "\\PassOptionsToPackage{version=3}{mhchem}\n"
1216 "\\usepackage{mhchem}\n";
1218 // wasysym is a simple feature, but it must be after amsmath if both
1220 // wasysym redefines some integrals (e.g. iint) from amsmath. That
1221 // leads to inconsistent integrals. We only load this package if
1222 // the document does not contain integrals (then isRequired("esint")
1223 // is false) or if esint is used, since esint redefines all relevant
1224 // integral symbols from wasysym and amsmath.
1225 // See http://www.lyx.org/trac/ticket/1942
1226 if (mustProvide("wasysym") &&
1227 params_.use_package("wasysym") != BufferParams::package_off &&
1228 (params_.use_package("esint") != BufferParams::package_off || !isRequired("esint")))
1229 packages << "\\usepackage{wasysym}\n";
1231 // esint must be after amsmath (and packages requiring amsmath, like mhchem)
1232 // and wasysym, since it will redeclare inconsistent integral symbols
1233 if (mustProvide("esint") &&
1234 params_.use_package("esint") != BufferParams::package_off)
1235 packages << "\\usepackage{esint}\n";
1237 // Known bibliography packages (simple \usepackage{package})
1238 for (int i = 0; i < nb_bibliofeatures; ++i) {
1239 if (mustProvide(bibliofeatures[i]))
1240 packages << "\\usepackage{"
1241 << bibliofeatures[i] << "}\n";
1244 // Compatibility between achicago and natbib
1245 if (mustProvide("achicago") && mustProvide("natbib"))
1246 packages << "\\let\\achicagobib\\thebibliography\n";
1249 // Some classes load natbib themselves, but still allow (or even require)
1250 // plain numeric citations (ReVTeX is such a case, see bug 5182).
1251 // This special case is indicated by the "natbib-internal" key.
1252 if (mustProvide("natbib")
1253 && !isProvided("natbib-internal")
1254 && !isProvided("biblatex")
1255 && !isProvided("biblatex-natbib")
1256 && !isProvided("jurabib")) {
1257 packages << "\\usepackage[";
1258 if (params_.citeEngineType() == ENGINE_TYPE_NUMERICAL)
1259 packages << "numbers";
1261 packages << "authoryear";
1262 if (!params_.biblio_opts.empty())
1263 packages << ',' << params_.biblio_opts;
1264 packages << "]{natbib}\n";
1267 // Compatibility between achicago and natbib
1268 if (mustProvide("achicago") && mustProvide("natbib")) {
1269 packages << "\\let\\thebibliography\\achicagobib\n";
1270 packages << "\\let\\SCcite\\astroncite\n";
1271 packages << "\\let\\UnexpandableProtect\\protect\n";
1274 // jurabib -- we need version 0.6 at least.
1275 if (mustProvide("jurabib")
1276 && !isProvided("natbib-internal")
1277 && !isProvided("natbib")
1278 && !isProvided("biblatex")
1279 && !isProvided("biblatex-natbib")) {
1280 packages << "\\usepackage";
1281 if (!params_.biblio_opts.empty())
1282 packages << '[' << params_.biblio_opts << ']';
1283 packages << "{jurabib}[2004/01/25]\n";
1286 // opcit -- we pass custombst as we output \bibliographystyle ourselves
1287 if (mustProvide("opcit")) {
1288 if (isRequired("hyperref"))
1289 packages << "\\usepackage[custombst,hyperref]{opcit}\n";
1291 packages << "\\usepackage[custombst]{opcit}\n";
1294 // xargs -- we need version 1.09 at least
1295 if (mustProvide("xargs"))
1296 packages << "\\usepackage{xargs}[2008/03/08]\n";
1298 if (mustProvide("xy"))
1299 packages << "\\usepackage[all]{xy}\n";
1301 if (mustProvide("feyn"))
1302 packages << "\\usepackage{feyn}\n"; //Diagram
1304 if (mustProvide("ulem"))
1305 packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
1306 "\\usepackage{ulem}\n";
1308 if (mustProvide("nomencl")) {
1309 // Make it work with the new and old version of the package,
1310 // but don't use the compatibility option since it is
1311 // incompatible to other packages.
1312 packages << "\\usepackage{nomencl}\n"
1313 "% the following is useful when we have the old nomencl.sty package\n"
1314 "\\providecommand{\\printnomenclature}{\\printglossary}\n"
1315 "\\providecommand{\\makenomenclature}{\\makeglossary}\n"
1316 "\\makenomenclature\n";
1319 // fixltx2e provides subscript
1320 if (mustProvide("subscript") && !isRequired("fixltx2e"))
1321 packages << "\\usepackage{subscript}\n";
1323 // footmisc must be loaded after setspace
1324 // Set options here, load the package after the user preamble to
1325 // avoid problems with manual loaded footmisc.
1326 if (mustProvide("footmisc"))
1327 packages << "\\PassOptionsToPackage{stable}{footmisc}\n";
1329 if (mustProvide("microtype")){
1330 packages << "\\usepackage{microtype}\n";
1333 return packages.str();
1337 TexString LaTeXFeatures::getMacros() const
1339 otexstringstream macros;
1341 if (!preamble_snippets_.empty()) {
1343 macros << getPreambleSnippets();
1346 if (mustProvide("xetexdashbreakstate"))
1347 macros << "\\XeTeXdashbreakstate 0" << '\n';
1349 if (mustProvide("papersize")) {
1350 if (runparams_.flavor == OutputParams::LATEX
1351 || runparams_.flavor == OutputParams::DVILUATEX)
1352 macros << papersizedvi_def << '\n';
1353 else if (runparams_.flavor == OutputParams::LUATEX)
1354 macros << papersizepdflua_def << '\n';
1356 macros << papersizepdf_def << '\n';
1359 if (mustProvide("LyX")) {
1360 if (isRequired("hyperref"))
1361 macros << lyx_hyperref_def << '\n';
1363 macros << lyx_def << '\n';
1366 if (mustProvide("noun"))
1367 macros << noun_def << '\n';
1369 if (mustProvide("lyxarrow"))
1370 macros << lyxarrow_def << '\n';
1372 if (mustProvide("lyxzerowidthspace"))
1373 macros << lyxZWSP_def << '\n';
1375 if (!usePolyglossia() && mustProvide("textgreek")) {
1376 // ensure LGR font encoding is defined also if fontenc is not loaded by LyX
1377 if (params_.main_font_encoding() == "default")
1378 macros << textgreek_LGR_def;
1379 macros << textgreek_def << '\n';
1382 if (!usePolyglossia() && mustProvide("textcyrillic")) {
1383 // ensure T2A font encoding is set up also if fontenc is not loaded by LyX
1384 if (params_.main_font_encoding() == "default")
1385 macros << textcyr_T2A_def;
1386 macros << textcyr_def << '\n';
1389 // non-standard text accents:
1390 if (mustProvide("textcommaabove") || mustProvide("textcommaaboveright") ||
1391 mustProvide("textcommabelow") || mustProvide("textbaltic"))
1392 macros << lyxaccent_def;
1394 if (mustProvide("textcommabelow") || mustProvide("textbaltic"))
1395 macros << textcommabelow_def << '\n';
1397 if (mustProvide("textcommaabove") || mustProvide("textbaltic"))
1398 macros << textcommaabove_def << '\n';
1400 if (mustProvide("textcommaaboveright"))
1401 macros << textcommaaboveright_def << '\n';
1403 if (mustProvide("textbaltic"))
1404 macros << textbaltic_def << '\n';
1406 // split-level fractions
1407 if (mustProvide("xfrac") || mustProvide("smallLetterFrac"))
1408 macros << xfrac_def << '\n';
1410 if (mustProvide("smallLetterFrac"))
1411 macros << smallLetterFrac_def << '\n';
1413 if (mustProvide("lyxmathsym"))
1414 macros << lyxmathsym_def << '\n';
1416 if (mustProvide("cedilla"))
1417 macros << cedilla_def << '\n';
1419 if (mustProvide("subring"))
1420 macros << subring_def << '\n';
1422 if (mustProvide("subdot"))
1423 macros << subdot_def << '\n';
1425 if (mustProvide("subhat"))
1426 macros << subhat_def << '\n';
1428 if (mustProvide("subtilde"))
1429 macros << subtilde_def << '\n';
1431 if (mustProvide("dacute"))
1432 macros << dacute_def << '\n';
1434 if (mustProvide("tipasymb"))
1435 macros << tipasymb_def << '\n';
1437 if (mustProvide("dgrave"))
1438 macros << dgrave_def << '\n';
1440 if (mustProvide("rcap"))
1441 macros << rcap_def << '\n';
1443 if (mustProvide("ogonek"))
1444 macros << ogonek_def << '\n';
1447 if (mustProvide("quotesinglbase"))
1448 macros << quotesinglbase_def << '\n';
1449 if (mustProvide("quotedblbase"))
1450 macros << quotedblbase_def << '\n';
1451 if (mustProvide("guilsinglleft"))
1452 macros << guilsinglleft_def << '\n';
1453 if (mustProvide("guilsinglright"))
1454 macros << guilsinglright_def << '\n';
1455 if (mustProvide("guillemotleft"))
1456 macros << guillemotleft_def << '\n';
1457 if (mustProvide("guillemotright"))
1458 macros << guillemotright_def << '\n';
1459 if (mustProvide("textquotedbl"))
1460 macros << textquotedbl_def << '\n';
1461 if (mustProvide("textquotesinglep")) {
1462 if (runparams_.flavor == OutputParams::XETEX)
1463 macros << textquotesinglep_xetex_def << '\n';
1465 macros << textquotesinglep_luatex_def << '\n';
1467 if (mustProvide("textquotedblp")) {
1468 if (runparams_.flavor == OutputParams::XETEX)
1469 macros << textquotedblp_xetex_def << '\n';
1471 macros << textquotedblp_luatex_def << '\n';
1475 if (mustProvide("binom") && !isRequired("amsmath"))
1476 macros << binom_def << '\n';
1477 if (mustProvide("mathcircumflex"))
1478 macros << mathcircumflex_def << '\n';
1481 if (mustProvide("ParagraphLeftIndent"))
1482 macros << paragraphleftindent_def;
1483 if (mustProvide("NeedLyXFootnoteCode"))
1484 macros << floatingfootnote_def;
1486 // some problems with tex->html converters
1487 if (mustProvide("NeedTabularnewline"))
1488 macros << tabularnewline_def;
1490 // greyed-out environment (note inset)
1491 // the color is specified in the routine
1492 // getColorOptions() to avoid LaTeX-package clashes
1493 if (mustProvide("lyxgreyedout"))
1494 macros << lyxgreyedout_def;
1496 if (mustProvide("lyxdot"))
1497 macros << lyxdot_def << '\n';
1500 getFloatDefinitions(macros);
1502 if (mustProvide("refstyle"))
1503 macros << lyxref_def << '\n';
1506 if (mustProvide("ct-dvipost"))
1507 macros << changetracking_dvipost_def;
1509 if (mustProvide("ct-xcolor-ulem")) {
1510 streamsize const prec = macros.os().precision(2);
1512 RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
1513 macros << "\\providecolor{lyxadded}{rgb}{"
1514 << cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
1516 RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
1517 macros << "\\providecolor{lyxdeleted}{rgb}{"
1518 << cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
1520 macros.os().precision(prec);
1522 if (isRequired("hyperref"))
1523 macros << changetracking_xcolor_ulem_hyperref_def;
1525 macros << changetracking_xcolor_ulem_def;
1528 if (mustProvide("ct-tikz-math-sout"))
1529 macros << changetracking_tikz_math_sout_def;
1531 if (mustProvide("ct-none"))
1532 macros << changetracking_none_def;
1534 if (mustProvide("rtloutputdblcol"))
1535 macros << rtloutputdblcol_def;
1537 if (mustProvide("lyxmintcaption"))
1538 macros << lyxmintcaption_def;
1540 return macros.release();
1544 docstring const LaTeXFeatures::getBabelPresettings() const
1546 odocstringstream tmp;
1548 for (Language const * lang : UsedLanguages_)
1549 if (!lang->babel_presettings().empty())
1550 tmp << lang->babel_presettings() << '\n';
1551 if (!params_.language->babel_presettings().empty())
1552 tmp << params_.language->babel_presettings() << '\n';
1554 if (!contains(tmp.str(), '@'))
1557 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1561 docstring const LaTeXFeatures::getBabelPostsettings() const
1563 odocstringstream tmp;
1565 for (Language const * lang : UsedLanguages_)
1566 if (!lang->babel_postsettings().empty())
1567 tmp << lang->babel_postsettings() << '\n';
1568 if (!params_.language->babel_postsettings().empty())
1569 tmp << params_.language->babel_postsettings() << '\n';
1571 if (!contains(tmp.str(), '@'))
1574 return "\\makeatletter\n" + tmp.str() + "\\makeatother\n";
1578 bool LaTeXFeatures::needBabelLangOptions() const
1580 if (!lyxrc.language_global_options || params_.language->asBabelOptions())
1583 LanguageList::const_iterator it = UsedLanguages_.begin();
1584 LanguageList::const_iterator end = UsedLanguages_.end();
1585 for (; it != end; ++it)
1586 if ((*it)->asBabelOptions())
1593 string const LaTeXFeatures::loadAMSPackages() const
1597 if (mustProvide("amsmath")
1598 && params_.use_package("amsmath") != BufferParams::package_off) {
1599 tmp << "\\usepackage{amsmath}\n";
1601 // amsbsy and amstext are already provided by amsmath
1602 if (mustProvide("amsbsy"))
1603 tmp << "\\usepackage{amsbsy}\n";
1604 if (mustProvide("amstext"))
1605 tmp << "\\usepackage{amstext}\n";
1608 if (mustProvide("amsthm"))
1609 tmp << "\\usepackage{amsthm}\n";
1611 if (mustProvide("amssymb")
1612 && params_.use_package("amssymb") != BufferParams::package_off)
1613 tmp << "\\usepackage{amssymb}\n";
1619 docstring const LaTeXFeatures::getTClassPreamble() const
1621 // the text class specific preamble
1622 DocumentClass const & tclass = params_.documentClass();
1623 odocstringstream tcpreamble;
1625 tcpreamble << tclass.preamble();
1627 list<docstring>::const_iterator cit = usedLayouts_.begin();
1628 list<docstring>::const_iterator end = usedLayouts_.end();
1629 for (; cit != end; ++cit)
1630 // For InPreamble layouts, we output the preamble stuff earlier
1631 // (before the layouts). See Paragraph::Private::validate.
1632 if (!tclass[*cit].inpreamble)
1633 tcpreamble << tclass[*cit].preamble();
1635 cit = usedInsetLayouts_.begin();
1636 end = usedInsetLayouts_.end();
1637 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1638 for (; cit != end; ++cit) {
1639 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1640 if (it == ils.end())
1642 tcpreamble << it->second.preamble();
1645 return tcpreamble.str();
1649 docstring const LaTeXFeatures::getTClassHTMLPreamble() const
1651 DocumentClass const & tclass = params_.documentClass();
1652 odocstringstream tcpreamble;
1654 tcpreamble << tclass.htmlpreamble();
1656 list<docstring>::const_iterator cit = usedLayouts_.begin();
1657 list<docstring>::const_iterator end = usedLayouts_.end();
1658 for (; cit != end; ++cit)
1659 tcpreamble << tclass[*cit].htmlpreamble();
1661 cit = usedInsetLayouts_.begin();
1662 end = usedInsetLayouts_.end();
1663 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1664 for (; cit != end; ++cit) {
1665 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1666 if (it == ils.end())
1668 tcpreamble << it->second.htmlpreamble();
1671 return tcpreamble.str();
1675 docstring const LaTeXFeatures::getTClassHTMLStyles() const
1677 DocumentClass const & tclass = params_.documentClass();
1678 odocstringstream tcpreamble;
1680 if (mustProvide("noun"))
1681 tcpreamble << lyxnoun_style;
1682 // this isn't exact, but it won't hurt that much if it
1684 if (mustProvide("ulem"))
1685 tcpreamble << lyxstrikeout_style;
1687 tcpreamble << tclass.htmlstyles();
1689 list<docstring>::const_iterator cit = usedLayouts_.begin();
1690 list<docstring>::const_iterator end = usedLayouts_.end();
1691 for (; cit != end; ++cit)
1692 tcpreamble << tclass[*cit].htmlstyle();
1694 cit = usedInsetLayouts_.begin();
1695 end = usedInsetLayouts_.end();
1696 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1697 for (; cit != end; ++cit) {
1698 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1699 if (it == ils.end())
1701 tcpreamble << it->second.htmlstyle();
1704 return tcpreamble.str();
1710 docstring const getFloatI18nPreamble(docstring const & type,
1711 docstring const & name, Language const * lang,
1712 Encoding const & enc, bool const polyglossia)
1714 // Check whether name can be encoded in the buffer encoding
1715 bool encodable = true;
1716 for (size_t i = 0; i < name.size(); ++i) {
1717 if (!enc.encodable(name[i])) {
1723 docstring const language = polyglossia ? from_ascii(lang->polyglossia())
1724 : from_ascii(lang->babel());
1725 docstring const langenc = from_ascii(lang->encoding()->iconvName());
1726 docstring const texenc = from_ascii(lang->encoding()->latexName());
1727 docstring const bufenc = from_ascii(enc.iconvName());
1728 docstring const s1 = docstring(1, 0xF0000);
1729 docstring const s2 = docstring(1, 0xF0001);
1730 docstring const translated = encodable ? name
1731 : from_ascii("\\inputencoding{") + texenc + from_ascii("}")
1732 + s1 + langenc + s2 + name + s1 + bufenc + s2;
1734 odocstringstream os;
1735 os << "\\addto\\captions" << language
1736 << "{\\renewcommand{\\" << type << "name}{" << translated << "}}\n";
1741 docstring const i18npreamble(docstring const & templ, Language const * lang,
1742 Encoding const & enc, bool const polyglossia,
1743 bool const need_fixedwidth)
1748 string preamble = polyglossia ?
1749 subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
1750 subst(to_utf8(templ), "$$lang", lang->babel());
1752 string const langenc = lang->encoding()->iconvName();
1753 string const texenc = lang->encoding()->latexName();
1754 string const bufenc = enc.iconvName();
1755 Encoding const * testenc(&enc);
1756 bool lang_fallback = false;
1757 bool ascii_fallback = false;
1758 if (need_fixedwidth && !enc.hasFixedWidth()) {
1759 if (lang->encoding()->hasFixedWidth()) {
1760 testenc = lang->encoding();
1761 lang_fallback = true;
1763 // We need a fixed width encoding, but both the buffer
1764 // encoding and the language encoding are variable
1765 // width. As a last fallback, try to convert to pure
1766 // ASCII using the LaTeX commands defined in unicodesymbols.
1767 testenc = encodings.fromLyXName("ascii");
1770 ascii_fallback = true;
1773 // First and second character of plane 15 (Private Use Area)
1774 string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
1775 string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
1777 // lyx::regex is not unicode-safe.
1778 // Should use QRegExp or (boost::u32regex, but that requires ICU)
1779 static regex const reg("_\\(([^\\)]+)\\)");
1781 while (regex_search(preamble, sub, reg)) {
1782 string const key = sub.str(1);
1783 docstring const name = lang->translateLayout(key);
1784 // Check whether name can be encoded in the buffer encoding
1785 bool encodable = true;
1786 for (size_t i = 0; i < name.size() && encodable; ++i)
1787 if (!testenc->encodable(name[i]))
1790 if (encodable && !lang_fallback)
1791 translated = to_utf8(name);
1792 else if (ascii_fallback)
1793 translated = to_ascii(testenc->latexString(name).first);
1795 translated = "\\inputencoding{" + texenc + "}"
1796 + s1 + langenc + s2 + to_utf8(name)
1798 preamble = subst(preamble, sub.str(), translated);
1800 return from_utf8(preamble);
1806 docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel,
1807 bool use_polyglossia, bool use_minted) const
1809 DocumentClass const & tclass = params_.documentClass();
1810 // collect preamble snippets in a set to prevent multiple identical
1811 // commands (would happen if e.g. both theorem and theorem* are used)
1812 set<docstring> snippets;
1813 typedef LanguageList::const_iterator lang_it;
1814 lang_it const lbeg = UsedLanguages_.begin();
1815 lang_it const lend = UsedLanguages_.end();
1816 list<docstring>::const_iterator cit = usedLayouts_.begin();
1817 list<docstring>::const_iterator end = usedLayouts_.end();
1818 for (; cit != end; ++cit) {
1819 // language dependent commands (once per document)
1820 snippets.insert(i18npreamble(tclass[*cit].langpreamble(),
1821 buffer().language(),
1822 buffer().params().encoding(),
1823 use_polyglossia, false));
1824 // commands for language changing (for multilanguage documents)
1825 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1826 snippets.insert(i18npreamble(
1827 tclass[*cit].babelpreamble(),
1828 buffer().language(),
1829 buffer().params().encoding(),
1830 use_polyglossia, false));
1831 for (lang_it lit = lbeg; lit != lend; ++lit)
1832 snippets.insert(i18npreamble(
1833 tclass[*cit].babelpreamble(),
1835 buffer().params().encoding(),
1836 use_polyglossia, false));
1839 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1840 FloatList const & floats = params_.documentClass().floats();
1841 UsedFloats::const_iterator fit = usedFloats_.begin();
1842 UsedFloats::const_iterator fend = usedFloats_.end();
1843 for (; fit != fend; ++fit) {
1844 Floating const & fl = floats.getType(fit->first);
1845 // we assume builtin floats are translated
1846 if (fl.isPredefined())
1848 docstring const type = from_ascii(fl.floattype());
1849 docstring const flname = from_utf8(fl.name());
1850 docstring name = buffer().language()->translateLayout(fl.name());
1851 // only request translation if we have a real translation
1852 // (that differs from the source)
1854 snippets.insert(getFloatI18nPreamble(
1855 type, name, buffer().language(),
1856 buffer().params().encoding(),
1858 for (lang_it lit = lbeg; lit != lend; ++lit) {
1859 string const code = (*lit)->code();
1860 name = (*lit)->translateLayout(fl.name());
1861 // we assume we have a suitable translation if
1862 // either the language is English (we need to
1863 // translate into English if English is a secondary
1864 // language) or if translateIfPossible returns
1865 // something different to the English source.
1866 bool const have_translation =
1867 (flname != name || contains(code, "en"));
1868 if (have_translation)
1869 snippets.insert(getFloatI18nPreamble(
1871 buffer().params().encoding(),
1877 cit = usedInsetLayouts_.begin();
1878 end = usedInsetLayouts_.end();
1879 TextClass::InsetLayouts const & ils = tclass.insetLayouts();
1880 for (; cit != end; ++cit) {
1881 TextClass::InsetLayouts::const_iterator it = ils.find(*cit);
1882 if (it == ils.end())
1884 // The listings package does not work with variable width
1885 // encodings, only with fixed width encodings. Therefore we
1886 // need to force a fixed width encoding for
1887 // \lstlistlistingname and \lstlistingname (bug 9382).
1888 // This needs to be consistent with InsetListings::latex().
1889 bool const need_fixedwidth = !use_minted &&
1890 !runparams_.isFullUnicode() &&
1891 it->second.fixedwidthpreambleencoding();
1892 // language dependent commands (once per document)
1893 snippets.insert(i18npreamble(it->second.langpreamble(),
1894 buffer().language(),
1895 buffer().params().encoding(),
1896 use_polyglossia, need_fixedwidth));
1897 // commands for language changing (for multilanguage documents)
1898 if ((use_babel || use_polyglossia) && !UsedLanguages_.empty()) {
1899 snippets.insert(i18npreamble(
1900 it->second.babelpreamble(),
1901 buffer().language(),
1902 buffer().params().encoding(),
1903 use_polyglossia, need_fixedwidth));
1904 for (lang_it lit = lbeg; lit != lend; ++lit)
1905 snippets.insert(i18npreamble(
1906 it->second.babelpreamble(),
1908 buffer().params().encoding(),
1909 use_polyglossia, need_fixedwidth));
1913 odocstringstream tcpreamble;
1914 set<docstring>::const_iterator const send = snippets.end();
1915 set<docstring>::const_iterator it = snippets.begin();
1916 for (; it != send; ++it)
1918 return tcpreamble.str();
1922 docstring const LaTeXFeatures::getLyXSGMLEntities() const
1924 // Definition of entities used in the document that are LyX related.
1925 odocstringstream entities;
1927 if (mustProvide("lyxarrow")) {
1928 entities << "<!ENTITY lyxarrow \"->\">" << '\n';
1931 return entities.str();
1935 docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
1937 odocstringstream sgmlpreamble;
1939 docstring const basename(from_utf8(onlyPath(fname)));
1941 FileMap::const_iterator end = IncludedFiles_.end();
1942 for (FileMap::const_iterator fi = IncludedFiles_.begin();
1945 sgmlpreamble << "\n<!ENTITY " << fi->first
1946 << (isSGMLFileName(fi->second) ? " SYSTEM \"" : " \"")
1947 << makeRelPath(from_utf8(fi->second), basename) << "\">";
1949 return sgmlpreamble.str();
1953 void LaTeXFeatures::showStruct() const
1955 lyxerr << "LyX needs the following commands when LaTeXing:"
1956 << "\n***** Packages:" << getPackages()
1957 << "\n***** Macros:" << to_utf8(getMacros().str)
1958 << "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
1959 << "\n***** done." << endl;
1963 Buffer const & LaTeXFeatures::buffer() const
1969 void LaTeXFeatures::setBuffer(Buffer const & buffer)
1975 BufferParams const & LaTeXFeatures::bufferParams() const
1981 void LaTeXFeatures::getFloatDefinitions(otexstream & os) const
1983 FloatList const & floats = params_.documentClass().floats();
1985 // Here we will output the code to create the needed float styles.
1986 // We will try to do this as minimal as possible.
1987 // \floatstyle{ruled}
1988 // \newfloat{algorithm}{htbp}{loa}
1989 // \providecommand{\algorithmname}{Algorithm}
1990 // \floatname{algorithm}{\protect\algorithmname}
1991 UsedFloats::const_iterator cit = usedFloats_.begin();
1992 UsedFloats::const_iterator end = usedFloats_.end();
1993 for (; cit != end; ++cit) {
1994 Floating const & fl = floats.getType(cit->first);
1996 // For builtin floats we do nothing.
1997 if (fl.isPredefined())
2000 // We have to special case "table" and "figure"
2001 if (fl.floattype() == "tabular" || fl.floattype() == "figure") {
2002 // Output code to modify "table" or "figure"
2003 // but only if builtin == false
2004 // and that have to be true at this point in the
2006 docstring const type = from_ascii(fl.floattype());
2007 docstring const placement = from_ascii(fl.placement());
2008 docstring const style = from_ascii(fl.style());
2009 if (!style.empty()) {
2010 os << "\\floatstyle{" << style << "}\n"
2011 << "\\restylefloat{" << type << "}\n";
2013 if (!placement.empty()) {
2014 os << "\\floatplacement{" << type << "}{"
2015 << placement << "}\n";
2018 // The other non builtin floats.
2020 docstring const type = from_ascii(fl.floattype());
2021 docstring const placement = from_ascii(fl.placement());
2022 docstring const ext = from_ascii(fl.ext());
2023 docstring const within = from_ascii(fl.within());
2024 docstring const style = from_ascii(fl.style());
2025 docstring const name =
2026 buffer().language()->translateLayout(fl.name());
2027 os << "\\floatstyle{" << style << "}\n"
2028 << "\\newfloat{" << type << "}{" << placement
2029 << "}{" << ext << '}';
2030 if (!within.empty())
2031 os << '[' << within << ']';
2033 << "\\providecommand{\\" << type << "name}{"
2035 << "\\floatname{" << type << "}{\\protect\\"
2036 << type << "name}\n";
2038 // What missing here is to code to minimalize the code
2039 // output so that the same floatstyle will not be
2040 // used several times, when the same style is still in
2044 // The subfig package is loaded later
2045 os << "\n\\AtBeginDocument{\\newsubfloat{" << from_ascii(fl.floattype()) << "}}\n";
2050 void LaTeXFeatures::resolveAlternatives()
2052 for (Features::iterator it = features_.begin(); it != features_.end();) {
2053 if (contains(*it, '|')) {
2054 vector<string> const alternatives = getVectorFromString(*it, "|");
2055 vector<string>::const_iterator const end = alternatives.end();
2056 vector<string>::const_iterator ita = alternatives.begin();
2057 // Is any alternative already required? => use that
2058 for (; ita != end; ++ita) {
2059 if (isRequired(*ita))
2062 // Is any alternative available? => use the first one
2065 for (ita = alternatives.begin(); ita != end; ++ita) {
2066 if (isAvailable(*ita)) {
2072 // This will not work, but not requiring something
2073 // would be more confusing
2075 require(alternatives.front());
2076 features_.erase(it);
2077 it = features_.begin();
2084 void LaTeXFeatures::expandMultiples()
2086 for (Features::iterator it = features_.begin(); it != features_.end();) {
2087 if (contains(*it, ',')) {
2088 vector<string> const multiples = getVectorFromString(*it, ",");
2089 vector<string>::const_iterator const end = multiples.end();
2090 vector<string>::const_iterator itm = multiples.begin();
2091 // Do nothing if any multiple is already required
2092 for (; itm != end; ++itm) {
2093 if (!isRequired(*itm))
2096 features_.erase(it);
2097 it = features_.begin();