2 * \file tex2lyx/text.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
21 #include "FloatList.h"
22 #include "LaTeXPackages.h"
27 #include "insets/ExternalTemplate.h"
29 #include "support/lassert.h"
30 #include "support/convert.h"
31 #include "support/FileName.h"
32 #include "support/filetools.h"
33 #include "support/lstrings.h"
34 #include "support/lyxtime.h"
43 using namespace lyx::support;
50 void output_arguments(ostream &, Parser &, bool, bool, bool, Context &,
51 Layout::LaTeXArgMap const &);
56 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
57 Context const & context, InsetLayout const * layout)
59 bool const forcePlainLayout =
60 layout ? layout->forcePlainLayout() : false;
61 Context newcontext(true, context.textclass);
63 newcontext.layout = &context.textclass.plainLayout();
65 newcontext.font = context.font;
67 output_arguments(os, p, outer, false, false, newcontext,
69 parse_text(p, os, flags, outer, newcontext);
71 output_arguments(os, p, outer, false, true, newcontext,
72 layout->postcommandargs());
73 newcontext.check_end_layout(os);
79 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
80 Context const & context, string const & name)
82 InsetLayout const * layout = 0;
83 DocumentClass::InsetLayouts::const_iterator it =
84 context.textclass.insetLayouts().find(from_ascii(name));
85 if (it != context.textclass.insetLayouts().end())
86 layout = &(it->second);
87 parse_text_in_inset(p, os, flags, outer, context, layout);
90 /// parses a paragraph snippet, useful for example for \\emph{...}
91 void parse_text_snippet(Parser & p, ostream & os, unsigned flags, bool outer,
94 Context newcontext(context);
95 // Don't inherit the paragraph-level extra stuff
96 newcontext.par_extra_stuff.clear();
97 parse_text(p, os, flags, outer, newcontext);
98 // Make sure that we don't create invalid .lyx files
99 context.need_layout = newcontext.need_layout;
100 context.need_end_layout = newcontext.need_end_layout;
105 * Thin wrapper around parse_text_snippet() using a string.
107 * We completely ignore \c context.need_layout and \c context.need_end_layout,
108 * because our return value is not used directly (otherwise the stream version
109 * of parse_text_snippet() could be used). That means that the caller needs
110 * to do layout management manually.
111 * This is intended to parse text that does not create any layout changes.
113 string parse_text_snippet(Parser & p, unsigned flags, const bool outer,
116 Context newcontext(context);
117 newcontext.need_layout = false;
118 newcontext.need_end_layout = false;
119 newcontext.new_layout_allowed = false;
120 // Avoid warning by Context::~Context()
121 newcontext.par_extra_stuff.clear();
123 parse_text_snippet(p, os, flags, outer, newcontext);
127 string fboxrule = "";
129 string shadow_size = "";
131 char const * const known_ref_commands[] = { "ref", "pageref", "vref",
132 "vpageref", "prettyref", "nameref", "eqref", 0 };
134 char const * const known_coded_ref_commands[] = { "ref", "pageref", "vref",
135 "vpageref", "formatted", "nameref", "eqref", 0 };
137 char const * const known_refstyle_commands[] = { "algref", "chapref", "corref",
138 "eqref", "enuref", "figref", "fnref", "lemref", "parref", "partref", "propref",
139 "secref", "subsecref", "tabref", "thmref", 0 };
141 char const * const known_refstyle_prefixes[] = { "alg", "chap", "cor",
142 "eq", "enu", "fig", "fn", "lem", "par", "part", "prop",
143 "sec", "subsec", "tab", "thm", 0 };
147 * supported CJK encodings
148 * JIS does not work with LyX's encoding conversion
150 const char * const supported_CJK_encodings[] = {
151 "EUC-JP", "KS", "GB", "UTF8",
152 "Bg5", /*"JIS",*/ "SJIS", 0};
155 * the same as supported_CJK_encodings with their corresponding LyX language name
156 * FIXME: The mapping "UTF8" => "chinese-traditional" is only correct for files
158 * NOTE: "Bg5", "JIS" and "SJIS" are not supported by LyX, on re-export the
159 * encodings "UTF8", "EUC-JP" and "EUC-JP" will be used.
160 * please keep this in sync with supported_CJK_encodings line by line!
162 const char * const supported_CJK_languages[] = {
163 "japanese-cjk", "korean", "chinese-simplified", "chinese-traditional",
164 "chinese-traditional", /*"japanese-cjk",*/ "japanese-cjk", 0};
168 * The starred forms are also known except for "citefullauthor",
169 * "citeyear" and "citeyearpar".
171 char const * const known_natbib_commands[] = { "cite", "citet", "citep",
172 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
173 "citefullauthor", "Citet", "Citep", "Citealt", "Citealp", "Citeauthor", 0 };
177 * No starred form other than "cite*" known.
179 char const * const known_jurabib_commands[] = { "cite", "citet", "citep",
180 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
181 // jurabib commands not (yet) supported by LyX:
183 // "footcite", "footcitet", "footcitep", "footcitealt", "footcitealp",
184 // "footciteauthor", "footciteyear", "footciteyearpar",
185 "citefield", "citetitle", 0 };
189 * Known starred forms: \cite*, \citeauthor*, \Citeauthor*, \parencite*, \citetitle*.
191 char const * const known_biblatex_commands[] = { "cite", "Cite", "textcite", "Textcite",
192 "parencite", "Parencite", "citeauthor", "Citeauthor", "citeyear", "smartcite", "Smartcite",
193 "footcite", "Footcite", "autocite", "Autocite", "citetitle", "fullcite", "footfullcite",
194 "supercite", "cites", "Cites", "textcites", "Textcites", "parencites", "Parencites",
195 "smartcites", "Smartcites", "autocites", "Autocites", 0 };
197 // Whether we need to insert a bibtex inset in a comment
198 bool need_commentbib = false;
200 /// LaTeX names for quotes
201 char const * const known_quotes[] = { "dq", "guillemotleft", "flqq", "og",
202 "guillemotright", "frqq", "fg", "glq", "glqq", "textquoteleft", "grq", "grqq",
203 "quotedblbase", "textquotedblleft", "quotesinglbase", "textquoteright", "flq",
204 "guilsinglleft", "frq", "guilsinglright", 0};
206 /// the same as known_quotes with .lyx names
207 char const * const known_coded_quotes[] = { "prd", "ard", "ard", "ard",
208 "ald", "ald", "ald", "gls", "gld", "els", "els", "grd",
209 "gld", "grd", "gls", "ers", "fls",
210 "fls", "frs", "frs", 0};
212 /// LaTeX names for font sizes
213 char const * const known_sizes[] = { "tiny", "scriptsize", "footnotesize",
214 "small", "normalsize", "large", "Large", "LARGE", "huge", "Huge", 0};
216 /// the same as known_sizes with .lyx names
217 char const * const known_coded_sizes[] = { "tiny", "scriptsize", "footnotesize",
218 "small", "normal", "large", "larger", "largest", "huge", "giant", 0};
220 /// LaTeX 2.09 names for font families
221 char const * const known_old_font_families[] = { "rm", "sf", "tt", 0};
223 /// LaTeX names for font families
224 char const * const known_font_families[] = { "rmfamily", "sffamily",
227 /// LaTeX names for font family changing commands
228 char const * const known_text_font_families[] = { "textrm", "textsf",
231 /// The same as known_old_font_families, known_font_families and
232 /// known_text_font_families with .lyx names
233 char const * const known_coded_font_families[] = { "roman", "sans",
236 /// LaTeX 2.09 names for font series
237 char const * const known_old_font_series[] = { "bf", 0};
239 /// LaTeX names for font series
240 char const * const known_font_series[] = { "bfseries", "mdseries", 0};
242 /// LaTeX names for font series changing commands
243 char const * const known_text_font_series[] = { "textbf", "textmd", 0};
245 /// The same as known_old_font_series, known_font_series and
246 /// known_text_font_series with .lyx names
247 char const * const known_coded_font_series[] = { "bold", "medium", 0};
249 /// LaTeX 2.09 names for font shapes
250 char const * const known_old_font_shapes[] = { "it", "sl", "sc", 0};
252 /// LaTeX names for font shapes
253 char const * const known_font_shapes[] = { "itshape", "slshape", "scshape",
256 /// LaTeX names for font shape changing commands
257 char const * const known_text_font_shapes[] = { "textit", "textsl", "textsc",
260 /// The same as known_old_font_shapes, known_font_shapes and
261 /// known_text_font_shapes with .lyx names
262 char const * const known_coded_font_shapes[] = { "italic", "slanted",
263 "smallcaps", "up", 0};
265 /// Known special characters which need skip_spaces_braces() afterwards
266 char const * const known_special_chars[] = {"ldots",
267 "lyxarrow", "textcompwordmark",
268 "slash", "textasciitilde", "textasciicircum", "textbackslash",
269 "LyX", "TeX", "LaTeXe",
272 /// special characters from known_special_chars which may have a \\protect before
273 char const * const known_special_protect_chars[] = {"LyX", "TeX",
274 "LaTeXe", "LaTeX", 0};
276 /// the same as known_special_chars with .lyx names
277 char const * const known_coded_special_chars[] = {"\\SpecialChar ldots\n",
278 "\\SpecialChar menuseparator\n", "\\SpecialChar ligaturebreak\n",
279 "\\SpecialChar breakableslash\n", "~", "^", "\n\\backslash\n",
280 "\\SpecialChar LyX\n", "\\SpecialChar TeX\n", "\\SpecialChar LaTeX2e\n",
281 "\\SpecialChar LaTeX\n", 0};
284 * Graphics file extensions known by the dvips driver of the graphics package.
285 * These extensions are used to complete the filename of an included
286 * graphics file if it does not contain an extension.
287 * The order must be the same that latex uses to find a file, because we
288 * will use the first extension that matches.
289 * This is only an approximation for the common cases. If we would want to
290 * do it right in all cases, we would need to know which graphics driver is
291 * used and know the extensions of every driver of the graphics package.
293 char const * const known_dvips_graphics_formats[] = {"eps", "ps", "eps.gz",
294 "ps.gz", "eps.Z", "ps.Z", 0};
297 * Graphics file extensions known by the pdftex driver of the graphics package.
298 * \sa known_dvips_graphics_formats
300 char const * const known_pdftex_graphics_formats[] = {"png", "pdf", "jpg",
304 * Known file extensions for TeX files as used by \\include.
306 char const * const known_tex_extensions[] = {"tex", 0};
308 /// spaces known by InsetSpace
309 char const * const known_spaces[] = { " ", "space", ",",
310 "thinspace", "quad", "qquad", "enspace", "enskip",
311 "negthinspace", "negmedspace", "negthickspace", "textvisiblespace",
312 "hfill", "dotfill", "hrulefill", "leftarrowfill", "rightarrowfill",
313 "upbracefill", "downbracefill", 0};
315 /// the same as known_spaces with .lyx names
316 char const * const known_coded_spaces[] = { "space{}", "space{}",
317 "thinspace{}", "thinspace{}", "quad{}", "qquad{}", "enspace{}", "enskip{}",
318 "negthinspace{}", "negmedspace{}", "negthickspace{}", "textvisiblespace{}",
319 "hfill{}", "dotfill{}", "hrulefill{}", "leftarrowfill{}", "rightarrowfill{}",
320 "upbracefill{}", "downbracefill{}", 0};
322 /// known TIPA combining diacritical marks
323 char const * const known_tipa_marks[] = {"textsubwedge", "textsubumlaut",
324 "textsubtilde", "textseagull", "textsubbridge", "textinvsubbridge",
325 "textsubsquare", "textsubrhalfring", "textsublhalfring", "textsubplus",
326 "textovercross", "textsubarch", "textsuperimposetilde", "textraising",
327 "textlowering", "textadvancing", "textretracting", "textdoublegrave",
328 "texthighrise", "textlowrise", "textrisefall", "textsyllabic",
329 "textsubring", "textsubbar", 0};
331 /// TIPA tones that need special handling
332 char const * const known_tones[] = {"15", "51", "45", "12", "454", 0};
334 // string to store the float type to be able to determine the type of subfloats
335 string float_type = "";
337 // string to store the float status of minted listings
338 string minted_float = "";
340 // whether a caption has been parsed for a floating minted listing
341 bool minted_float_has_caption = false;
343 // The caption for non-floating minted listings
344 string minted_nonfloat_caption = "";
347 /// splits "x=z, y=b" into a map and an ordered keyword vector
348 void split_map(string const & s, map<string, string> & res, vector<string> & keys)
353 keys.resize(v.size());
354 for (size_t i = 0; i < v.size(); ++i) {
355 size_t const pos = v[i].find('=');
356 string const index = trimSpaceAndEol(v[i].substr(0, pos));
357 string const value = trimSpaceAndEol(v[i].substr(pos + 1, string::npos));
365 * Split a LaTeX length into value and unit.
366 * The latter can be a real unit like "pt", or a latex length variable
367 * like "\textwidth". The unit may contain additional stuff like glue
368 * lengths, but we don't care, because such lengths are ERT anyway.
369 * \returns true if \p value and \p unit are valid.
371 bool splitLatexLength(string const & len, string & value, string & unit)
375 const string::size_type i = len.find_first_not_of(" -+0123456789.,");
376 //'4,5' is a valid LaTeX length number. Change it to '4.5'
377 string const length = subst(len, ',', '.');
378 if (i == string::npos)
381 if (len[0] == '\\') {
382 // We had something like \textwidth without a factor
388 value = trimSpaceAndEol(string(length, 0, i));
392 // 'cM' is a valid LaTeX length unit. Change it to 'cm'
393 if (contains(len, '\\'))
394 unit = trimSpaceAndEol(string(len, i));
396 unit = ascii_lowercase(trimSpaceAndEol(string(len, i)));
401 /// A simple function to translate a latex length to something LyX can
402 /// understand. Not perfect, but rather best-effort.
403 bool translate_len(string const & length, string & valstring, string & unit)
405 if (!splitLatexLength(length, valstring, unit))
407 // LyX uses percent values
409 istringstream iss(valstring);
414 string const percentval = oss.str();
416 if (unit.empty() || unit[0] != '\\')
418 string::size_type const i = unit.find(' ');
419 string const endlen = (i == string::npos) ? string() : string(unit, i);
420 if (unit == "\\textwidth") {
421 valstring = percentval;
422 unit = "text%" + endlen;
423 } else if (unit == "\\columnwidth") {
424 valstring = percentval;
425 unit = "col%" + endlen;
426 } else if (unit == "\\paperwidth") {
427 valstring = percentval;
428 unit = "page%" + endlen;
429 } else if (unit == "\\linewidth") {
430 valstring = percentval;
431 unit = "line%" + endlen;
432 } else if (unit == "\\paperheight") {
433 valstring = percentval;
434 unit = "pheight%" + endlen;
435 } else if (unit == "\\textheight") {
436 valstring = percentval;
437 unit = "theight%" + endlen;
438 } else if (unit == "\\baselineskip") {
439 valstring = percentval;
440 unit = "baselineskip%" + endlen;
448 string translate_len(string const & length)
452 if (translate_len(length, value, unit))
454 // If the input is invalid, return what we have.
462 * Translates a LaTeX length into \p value, \p unit and
463 * \p special parts suitable for a box inset.
464 * The difference from translate_len() is that a box inset knows about
465 * some special "units" that are stored in \p special.
467 void translate_box_len(string const & length, string & value, string & unit, string & special)
469 if (translate_len(length, value, unit)) {
470 if (unit == "\\height" || unit == "\\depth" ||
471 unit == "\\totalheight" || unit == "\\width") {
472 special = unit.substr(1);
473 // The unit is not used, but LyX requires a dummy setting
486 * Find a file with basename \p name in path \p path and an extension
489 string find_file(string const & name, string const & path,
490 char const * const * extensions)
492 for (char const * const * what = extensions; *what; ++what) {
493 string const trial = addExtension(name, *what);
494 if (makeAbsPath(trial, path).exists())
501 void begin_inset(ostream & os, string const & name)
503 os << "\n\\begin_inset " << name;
507 void begin_command_inset(ostream & os, string const & name,
508 string const & latexname)
510 begin_inset(os, "CommandInset ");
511 os << name << "\nLatexCommand " << latexname << '\n';
515 void end_inset(ostream & os)
517 os << "\n\\end_inset\n\n";
521 bool skip_braces(Parser & p)
523 if (p.next_token().cat() != catBegin)
526 if (p.next_token().cat() == catEnd) {
535 /// replace LaTeX commands in \p s from the unicodesymbols file with their
537 docstring convert_unicodesymbols(docstring s)
540 for (size_t i = 0; i < s.size();) {
549 docstring parsed = normalize_c(encodings.fromLaTeXCommand(s,
550 Encodings::TEXT_CMD, termination, rem, &req));
551 set<string>::const_iterator it = req.begin();
552 set<string>::const_iterator en = req.end();
553 for (; it != en; ++it)
554 preamble.registerAutomaticallyLoadedPackage(*it);
557 if (s.empty() || s[0] != '\\')
566 /// try to convert \p s to a valid InsetCommand argument
567 string convert_command_inset_arg(string s)
570 // since we don't know the input encoding we can't use from_utf8
571 s = to_utf8(convert_unicodesymbols(from_ascii(s)));
572 // LyX cannot handle newlines in a latex command
573 return subst(s, "\n", " ");
577 void output_ert(ostream & os, string const & s, Context & context)
579 context.check_layout(os);
580 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
582 os << "\n\\backslash\n";
583 else if (*it == '\n') {
584 context.new_paragraph(os);
585 context.check_layout(os);
589 context.check_end_layout(os);
593 void output_ert_inset(ostream & os, string const & s, Context & context)
595 // We must have a valid layout before outputting the ERT inset.
596 context.check_layout(os);
597 Context newcontext(true, context.textclass);
598 InsetLayout const & layout = context.textclass.insetLayout(from_ascii("ERT"));
599 if (layout.forcePlainLayout())
600 newcontext.layout = &context.textclass.plainLayout();
601 begin_inset(os, "ERT");
602 os << "\nstatus collapsed\n";
603 output_ert(os, s, newcontext);
608 void output_comment(Parser & p, ostream & os, string const & s,
611 if (p.next_token().cat() == catNewline)
612 output_ert_inset(os, '%' + s, context);
614 output_ert_inset(os, '%' + s + '\n', context);
618 Layout const * findLayout(TextClass const & textclass, string const & name, bool command)
620 Layout const * layout = findLayoutWithoutModule(textclass, name, command);
623 if (checkModule(name, command))
624 return findLayoutWithoutModule(textclass, name, command);
629 InsetLayout const * findInsetLayout(TextClass const & textclass, string const & name, bool command)
631 InsetLayout const * insetlayout = findInsetLayoutWithoutModule(textclass, name, command);
634 if (checkModule(name, command))
635 return findInsetLayoutWithoutModule(textclass, name, command);
640 void eat_whitespace(Parser &, ostream &, Context &, bool);
644 * Skips whitespace and braces.
645 * This should be called after a command has been parsed that is not put into
646 * ERT, and where LyX adds "{}" if needed.
648 void skip_spaces_braces(Parser & p, bool keepws = false)
650 /* The following four examples produce the same typeset output and
651 should be handled by this function:
659 // Unfortunately we need to skip comments, too.
660 // We can't use eat_whitespace since writing them after the {}
661 // results in different output in some cases.
662 bool const skipped_spaces = p.skip_spaces(true);
663 bool const skipped_braces = skip_braces(p);
664 if (keepws && skipped_spaces && !skipped_braces)
665 // put back the space (it is better handled by check_space)
666 p.unskip_spaces(true);
670 void output_arguments(ostream & os, Parser & p, bool outer, bool need_layout, bool post,
671 Context & context, Layout::LaTeXArgMap const & latexargs)
674 context.check_layout(os);
679 Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
680 Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
681 for (; lait != laend; ++lait) {
683 eat_whitespace(p, os, context, false);
684 if (lait->second.mandatory) {
685 if (p.next_token().cat() != catBegin)
687 p.get_token(); // eat '{'
689 context.check_layout(os);
692 begin_inset(os, "Argument ");
695 os << i << "\nstatus collapsed\n\n";
696 parse_text_in_inset(p, os, FLAG_BRACE_LAST, outer, context);
699 if (p.next_token().cat() == catEscape ||
700 p.next_token().character() != '[')
702 p.get_token(); // eat '['
704 context.check_layout(os);
707 begin_inset(os, "Argument ");
710 os << i << "\nstatus collapsed\n\n";
711 parse_text_in_inset(p, os, FLAG_BRACK_LAST, outer, context);
714 eat_whitespace(p, os, context, false);
719 void output_command_layout(ostream & os, Parser & p, bool outer,
720 Context & parent_context,
721 Layout const * newlayout)
723 TeXFont const oldFont = parent_context.font;
724 // save the current font size
725 string const size = oldFont.size;
726 // reset the font size to default, because the font size switches
727 // don't affect section headings and the like
728 parent_context.font.size = Context::normalfont.size;
729 // we only need to write the font change if we have an open layout
730 if (!parent_context.atParagraphStart())
731 output_font_change(os, oldFont, parent_context.font);
732 parent_context.check_end_layout(os);
733 Context context(true, parent_context.textclass, newlayout,
734 parent_context.layout, parent_context.font);
735 if (parent_context.deeper_paragraph) {
736 // We are beginning a nested environment after a
737 // deeper paragraph inside the outer list environment.
738 // Therefore we don't need to output a "begin deeper".
739 context.need_end_deeper = true;
741 context.check_deeper(os);
742 output_arguments(os, p, outer, true, false, context,
743 context.layout->latexargs());
744 parse_text(p, os, FLAG_ITEM, outer, context);
745 output_arguments(os, p, outer, false, true, context,
746 context.layout->postcommandargs());
747 context.check_end_layout(os);
748 if (parent_context.deeper_paragraph) {
749 // We must suppress the "end deeper" because we
750 // suppressed the "begin deeper" above.
751 context.need_end_deeper = false;
753 context.check_end_deeper(os);
754 // We don't need really a new paragraph, but
755 // we must make sure that the next item gets a \begin_layout.
756 parent_context.new_paragraph(os);
757 // Set the font size to the original value. No need to output it here
758 // (Context::begin_layout() will do that if needed)
759 parent_context.font.size = size;
764 * Output a space if necessary.
765 * This function gets called for every whitespace token.
767 * We have three cases here:
768 * 1. A space must be suppressed. Example: The lyxcode case below
769 * 2. A space may be suppressed. Example: Spaces before "\par"
770 * 3. A space must not be suppressed. Example: A space between two words
772 * We currently handle only 1. and 3 and from 2. only the case of
773 * spaces before newlines as a side effect.
775 * 2. could be used to suppress as many spaces as possible. This has two effects:
776 * - Reimporting LyX generated LaTeX files changes almost no whitespace
777 * - Superflous whitespace from non LyX generated LaTeX files is removed.
778 * The drawback is that the logic inside the function becomes
779 * complicated, and that is the reason why it is not implemented.
781 void check_space(Parser & p, ostream & os, Context & context)
783 Token const next = p.next_token();
784 Token const curr = p.curr_token();
785 // A space before a single newline and vice versa must be ignored
786 // LyX emits a newline before \end{lyxcode}.
787 // This newline must be ignored,
788 // otherwise LyX will add an additional protected space.
789 if (next.cat() == catSpace ||
790 next.cat() == catNewline ||
791 (next.cs() == "end" && context.layout->free_spacing && curr.cat() == catNewline)) {
794 context.check_layout(os);
800 * Parse all arguments of \p command
802 void parse_arguments(string const & command,
803 vector<ArgumentType> const & template_arguments,
804 Parser & p, ostream & os, bool outer, Context & context)
806 string ert = command;
807 size_t no_arguments = template_arguments.size();
808 for (size_t i = 0; i < no_arguments; ++i) {
809 switch (template_arguments[i]) {
812 // This argument contains regular LaTeX
813 output_ert_inset(os, ert + '{', context);
814 eat_whitespace(p, os, context, false);
815 if (template_arguments[i] == required)
816 parse_text(p, os, FLAG_ITEM, outer, context);
818 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
822 // This argument consists only of a single item.
823 // The presence of '{' or not must be preserved.
825 if (p.next_token().cat() == catBegin)
826 ert += '{' + p.verbatim_item() + '}';
828 ert += p.verbatim_item();
832 // This argument may contain special characters
833 ert += '{' + p.verbatim_item() + '}';
837 // true because we must not eat whitespace
838 // if an optional arg follows we must not strip the
839 // brackets from this one
840 if (i < no_arguments - 1 &&
841 template_arguments[i+1] == optional)
842 ert += p.getFullOpt(true);
844 ert += p.getOpt(true);
848 output_ert_inset(os, ert, context);
853 * Check whether \p command is a known command. If yes,
854 * handle the command with all arguments.
855 * \return true if the command was parsed, false otherwise.
857 bool parse_command(string const & command, Parser & p, ostream & os,
858 bool outer, Context & context)
860 if (known_commands.find(command) != known_commands.end()) {
861 parse_arguments(command, known_commands[command], p, os,
869 /// Parses a minipage or parbox
870 void parse_box(Parser & p, ostream & os, unsigned outer_flags,
871 unsigned inner_flags, bool outer, Context & parent_context,
872 string const & outer_type, string const & special,
873 string inner_type, string const & frame_color,
874 string const & background_color)
878 string hor_pos = "l";
879 // We need to set the height to the LaTeX default of 1\\totalheight
880 // for the case when no height argument is given
881 string height_value = "1";
882 string height_unit = "in";
883 string height_special = "totalheight";
888 string width_special = "none";
889 string thickness = "0.4pt";
890 if (!fboxrule.empty())
891 thickness = fboxrule;
895 if (!fboxsep.empty())
896 separation = fboxsep;
900 if (!shadow_size.empty())
901 shadowsize = shadow_size;
904 string framecolor = "black";
905 string backgroundcolor = "none";
906 if (!frame_color.empty())
907 framecolor = frame_color;
908 if (!background_color.empty())
909 backgroundcolor = background_color;
910 // if there is a color box around the \begin statements have not yet been parsed
912 if (!frame_color.empty() || !background_color.empty()) {
913 eat_whitespace(p, os, parent_context, false);
914 p.get_token().asInput(); // the '{'
916 if (p.next_token().asInput() == "\\begin") {
917 p.get_token().asInput();
919 inner_type = "minipage";
920 inner_flags = FLAG_END;
921 active_environments.push_back("minipage");
924 else if (p.next_token().asInput() == "\\parbox") {
925 p.get_token().asInput();
926 inner_type = "parbox";
927 inner_flags = FLAG_ITEM;
930 else if (p.next_token().asInput() == "\\makebox") {
931 p.get_token().asInput();
932 inner_type = "makebox";
933 inner_flags = FLAG_ITEM;
935 // in case there is just \colorbox{color}{text}
938 inner_type = "makebox";
939 inner_flags = FLAG_BRACE_LAST;
944 if (!p.hasOpt() && (inner_type == "makebox" || outer_type == "mbox"))
946 if (!inner_type.empty() && p.hasOpt()) {
947 if (inner_type != "makebox")
948 position = p.getArg('[', ']');
950 latex_width = p.getArg('[', ']');
951 translate_box_len(latex_width, width_value, width_unit, width_special);
954 if (position != "t" && position != "c" && position != "b") {
955 cerr << "invalid position " << position << " for "
956 << inner_type << endl;
960 if (inner_type != "makebox") {
961 latex_height = p.getArg('[', ']');
962 translate_box_len(latex_height, height_value, height_unit, height_special);
964 string const opt = p.getArg('[', ']');
967 if (hor_pos != "l" && hor_pos != "c" &&
968 hor_pos != "r" && hor_pos != "s") {
969 cerr << "invalid hor_pos " << hor_pos
970 << " for " << inner_type << endl;
977 inner_pos = p.getArg('[', ']');
978 if (inner_pos != "c" && inner_pos != "t" &&
979 inner_pos != "b" && inner_pos != "s") {
980 cerr << "invalid inner_pos "
981 << inner_pos << " for "
982 << inner_type << endl;
983 inner_pos = position;
987 if (inner_type == "makebox")
991 if (inner_type.empty()) {
992 if (special.empty() && outer_type != "framebox")
993 latex_width = "1\\columnwidth";
996 latex_width = p2.getArg('[', ']');
997 string const opt = p2.getArg('[', ']');
1000 if (hor_pos != "l" && hor_pos != "c" &&
1001 hor_pos != "r" && hor_pos != "s") {
1002 cerr << "invalid hor_pos " << hor_pos
1003 << " for " << outer_type << endl;
1007 if (outer_type == "framebox")
1011 } else if (inner_type != "makebox")
1012 latex_width = p.verbatim_item();
1013 // if e.g. only \ovalbox{content} was used, set the width to 1\columnwidth
1014 // as this is LyX's standard for such cases (except for makebox)
1015 // \framebox is more special and handled below
1016 if (latex_width.empty() && inner_type != "makebox"
1017 && outer_type != "framebox")
1018 latex_width = "1\\columnwidth";
1020 translate_len(latex_width, width_value, width_unit);
1022 bool shadedparbox = false;
1023 if (inner_type == "shaded") {
1024 eat_whitespace(p, os, parent_context, false);
1025 if (outer_type == "parbox") {
1027 if (p.next_token().cat() == catBegin)
1029 eat_whitespace(p, os, parent_context, false);
1030 shadedparbox = true;
1035 // If we already read the inner box we have to push the inner env
1036 if (!outer_type.empty() && !inner_type.empty() &&
1037 (inner_flags & FLAG_END))
1038 active_environments.push_back(inner_type);
1039 bool use_ert = false;
1040 if (!outer_type.empty() && !inner_type.empty()) {
1041 // Look whether there is some content after the end of the
1042 // inner box, but before the end of the outer box.
1043 // If yes, we need to output ERT.
1045 if (inner_flags & FLAG_END)
1046 p.ertEnvironment(inner_type);
1049 p.skip_spaces(true);
1050 bool const outer_env(outer_type == "framed" || outer_type == "minipage");
1051 if ((outer_env && p.next_token().asInput() != "\\end") ||
1052 (!outer_env && p.next_token().cat() != catEnd)) {
1053 // something is between the end of the inner box and
1054 // the end of the outer box, so we need to use ERT.
1062 if (!outer_type.empty()) {
1063 if (outer_flags & FLAG_END)
1064 ss << "\\begin{" << outer_type << '}';
1066 ss << '\\' << outer_type << '{';
1067 if (!special.empty())
1071 if (!inner_type.empty()) {
1072 if (inner_type != "shaded") {
1073 if (inner_flags & FLAG_END)
1074 ss << "\\begin{" << inner_type << '}';
1076 ss << '\\' << inner_type;
1078 if (!position.empty())
1079 ss << '[' << position << ']';
1080 if (!latex_height.empty())
1081 ss << '[' << latex_height << ']';
1082 if (!inner_pos.empty())
1083 ss << '[' << inner_pos << ']';
1084 ss << '{' << latex_width << '}';
1085 if (!(inner_flags & FLAG_END))
1088 if (inner_type == "shaded")
1089 ss << "\\begin{shaded}";
1090 output_ert_inset(os, ss.str(), parent_context);
1091 if (!inner_type.empty()) {
1092 parse_text(p, os, inner_flags, outer, parent_context);
1093 if (inner_flags & FLAG_END)
1094 output_ert_inset(os, "\\end{" + inner_type + '}',
1097 output_ert_inset(os, "}", parent_context);
1099 if (!outer_type.empty()) {
1100 // If we already read the inner box we have to pop
1102 if (!inner_type.empty() && (inner_flags & FLAG_END))
1103 active_environments.pop_back();
1105 // Ensure that the end of the outer box is parsed correctly:
1106 // The opening brace has been eaten by parse_outer_box()
1107 if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1108 outer_flags &= ~FLAG_ITEM;
1109 outer_flags |= FLAG_BRACE_LAST;
1111 parse_text(p, os, outer_flags, outer, parent_context);
1112 if (outer_flags & FLAG_END)
1113 output_ert_inset(os, "\\end{" + outer_type + '}',
1116 output_ert_inset(os, "}", parent_context);
1119 // LyX does not like empty positions, so we have
1120 // to set them to the LaTeX default values here.
1121 if (position.empty())
1123 if (inner_pos.empty())
1124 inner_pos = position;
1125 parent_context.check_layout(os);
1126 begin_inset(os, "Box ");
1127 if (outer_type == "framed")
1129 else if (outer_type == "framebox" || outer_type == "fbox" || !frame_color.empty())
1131 else if (outer_type == "shadowbox")
1132 os << "Shadowbox\n";
1133 else if ((outer_type == "shaded" && inner_type.empty()) ||
1134 (outer_type == "minipage" && inner_type == "shaded") ||
1135 (outer_type == "parbox" && inner_type == "shaded")) {
1137 preamble.registerAutomaticallyLoadedPackage("color");
1138 } else if (outer_type == "doublebox")
1139 os << "Doublebox\n";
1140 else if (outer_type.empty() || outer_type == "mbox")
1141 os << "Frameless\n";
1143 os << outer_type << '\n';
1144 os << "position \"" << position << "\"\n";
1145 os << "hor_pos \"" << hor_pos << "\"\n";
1146 if (outer_type == "mbox")
1147 os << "has_inner_box 1\n";
1148 else if (!frame_color.empty() && inner_type == "makebox")
1149 os << "has_inner_box 0\n";
1151 os << "has_inner_box " << !inner_type.empty() << "\n";
1152 os << "inner_pos \"" << inner_pos << "\"\n";
1153 os << "use_parbox " << (inner_type == "parbox" || shadedparbox)
1155 if (outer_type == "mbox")
1156 os << "use_makebox 1\n";
1157 else if (!frame_color.empty())
1158 os << "use_makebox 0\n";
1160 os << "use_makebox " << (inner_type == "makebox") << '\n';
1161 if (outer_type == "mbox" || (outer_type == "fbox" && inner_type.empty()))
1162 os << "width \"\"\n";
1163 // for values like "1.5\width" LyX uses "1.5in" as width ad sets "width" as sepecial
1164 else if (contains(width_unit, '\\'))
1165 os << "width \"" << width_value << "in" << "\"\n";
1167 os << "width \"" << width_value << width_unit << "\"\n";
1168 if (contains(width_unit, '\\')) {
1169 width_unit.erase (0,1); // remove the leading '\'
1170 os << "special \"" << width_unit << "\"\n";
1172 os << "special \"" << width_special << "\"\n";
1173 if (contains(height_unit, '\\'))
1174 os << "height \"" << height_value << "in" << "\"\n";
1176 os << "height \"" << height_value << height_unit << "\"\n";
1177 os << "height_special \"" << height_special << "\"\n";
1178 os << "thickness \"" << thickness << "\"\n";
1179 os << "separation \"" << separation << "\"\n";
1180 os << "shadowsize \"" << shadowsize << "\"\n";
1181 os << "framecolor \"" << framecolor << "\"\n";
1182 os << "backgroundcolor \"" << backgroundcolor << "\"\n";
1183 os << "status open\n\n";
1185 // Unfortunately we can't use parse_text_in_inset:
1186 // InsetBox::forcePlainLayout() is hard coded and does not
1187 // use the inset layout. Apart from that do we call parse_text
1188 // up to two times, but need only one check_end_layout.
1189 bool const forcePlainLayout =
1190 (!inner_type.empty() || inner_type == "makebox") &&
1191 outer_type != "shaded" && outer_type != "framed";
1192 Context context(true, parent_context.textclass);
1193 if (forcePlainLayout)
1194 context.layout = &context.textclass.plainLayout();
1196 context.font = parent_context.font;
1198 // If we have no inner box the contents will be read with the outer box
1199 if (!inner_type.empty())
1200 parse_text(p, os, inner_flags, outer, context);
1202 // Ensure that the end of the outer box is parsed correctly:
1203 // The opening brace has been eaten by parse_outer_box()
1204 if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1205 outer_flags &= ~FLAG_ITEM;
1206 outer_flags |= FLAG_BRACE_LAST;
1209 // Find end of outer box, output contents if inner_type is
1210 // empty and output possible comments
1211 if (!outer_type.empty()) {
1212 // If we already read the inner box we have to pop
1214 if (!inner_type.empty() && (inner_flags & FLAG_END))
1215 active_environments.pop_back();
1216 // This does not output anything but comments if
1217 // inner_type is not empty (see use_ert)
1218 parse_text(p, os, outer_flags, outer, context);
1221 context.check_end_layout(os);
1223 #ifdef PRESERVE_LAYOUT
1224 // LyX puts a % after the end of the minipage
1225 if (p.next_token().cat() == catNewline && p.next_token().cs().size() > 1) {
1227 //output_comment(p, os, "dummy", parent_context);
1230 parent_context.new_paragraph(os);
1232 else if (p.next_token().cat() == catSpace || p.next_token().cat() == catNewline) {
1233 //output_comment(p, os, "dummy", parent_context);
1236 // We add a protected space if something real follows
1237 if (p.good() && p.next_token().cat() != catComment) {
1238 begin_inset(os, "space ~\n");
1244 if (inner_type == "minipage" && (!frame_color.empty() || !background_color.empty()))
1245 active_environments.pop_back();
1246 if (inner_flags != FLAG_BRACE_LAST && (!frame_color.empty() || !background_color.empty())) {
1247 // in this case we have to eat the the closing brace of the color box
1248 p.get_token().asInput(); // the '}'
1250 if (p.next_token().asInput() == "}") {
1251 // in this case we assume that the closing brace is from the box settings
1252 // therefore reset these values for the next box
1258 // all boxes except of Frameless and Shaded require calc
1259 if (!(outer_type.empty() || outer_type == "mbox") &&
1260 !((outer_type == "shaded" && inner_type.empty()) ||
1261 (outer_type == "minipage" && inner_type == "shaded") ||
1262 (outer_type == "parbox" && inner_type == "shaded")))
1263 preamble.registerAutomaticallyLoadedPackage("calc");
1267 void parse_outer_box(Parser & p, ostream & os, unsigned flags, bool outer,
1268 Context & parent_context, string const & outer_type,
1269 string const & special)
1271 eat_whitespace(p, os, parent_context, false);
1272 if (flags & FLAG_ITEM) {
1274 if (p.next_token().cat() == catBegin)
1277 cerr << "Warning: Ignoring missing '{' after \\"
1278 << outer_type << '.' << endl;
1279 eat_whitespace(p, os, parent_context, false);
1282 unsigned int inner_flags = 0;
1284 if (outer_type == "minipage" || outer_type == "parbox") {
1285 p.skip_spaces(true);
1286 while (p.hasOpt()) {
1288 p.skip_spaces(true);
1291 p.skip_spaces(true);
1292 if (outer_type == "parbox") {
1294 if (p.next_token().cat() == catBegin)
1296 p.skip_spaces(true);
1299 if (outer_type == "shaded" || outer_type == "mbox") {
1300 // These boxes never have an inner box
1302 } else if (p.next_token().asInput() == "\\parbox") {
1303 inner = p.get_token().cs();
1304 inner_flags = FLAG_ITEM;
1305 } else if (p.next_token().asInput() == "\\begin") {
1306 // Is this a minipage or shaded box?
1309 inner = p.getArg('{', '}');
1311 if (inner == "minipage" || inner == "shaded")
1312 inner_flags = FLAG_END;
1317 if (inner_flags == FLAG_END) {
1318 if (inner != "shaded")
1322 eat_whitespace(p, os, parent_context, false);
1324 parse_box(p, os, flags, FLAG_END, outer, parent_context,
1325 outer_type, special, inner, "", "");
1327 if (inner_flags == FLAG_ITEM) {
1329 eat_whitespace(p, os, parent_context, false);
1331 parse_box(p, os, flags, inner_flags, outer, parent_context,
1332 outer_type, special, inner, "", "");
1337 void parse_listings(Parser & p, ostream & os, Context & parent_context,
1338 bool in_line, bool use_minted)
1340 parent_context.check_layout(os);
1341 begin_inset(os, "listings\n");
1342 string arg = p.hasOpt() ? subst(p.verbatimOption(), "\n", "") : string();
1344 while ((i = arg.find(", ")) != string::npos
1345 || (i = arg.find(",\t")) != string::npos)
1346 arg.erase(i + 1, 1);
1349 string const language = p.getArg('{', '}');
1350 p.skip_spaces(true);
1351 arg += string(arg.empty() ? "" : ",") + "language=" + language;
1352 if (!minted_float.empty()) {
1353 arg += string(arg.empty() ? "" : ",") + minted_float;
1354 minted_nonfloat_caption.clear();
1358 os << "lstparams " << '"' << arg << '"' << '\n';
1359 if (arg.find("\\color") != string::npos)
1360 preamble.registerAutomaticallyLoadedPackage("color");
1363 os << "inline true\n";
1365 os << "inline false\n";
1366 os << "status collapsed\n";
1367 Context context(true, parent_context.textclass);
1368 context.layout = &parent_context.textclass.plainLayout();
1369 if (use_minted && prefixIs(minted_nonfloat_caption, "[t]")) {
1370 minted_nonfloat_caption.erase(0,3);
1371 os << "\n\\begin_layout Plain Layout\n";
1372 begin_inset(os, "Caption Standard\n");
1373 Context newcontext(true, context.textclass,
1374 context.layout, 0, context.font);
1375 newcontext.check_layout(os);
1376 os << minted_nonfloat_caption << "\n";
1377 newcontext.check_end_layout(os);
1379 os << "\n\\end_layout\n";
1380 minted_nonfloat_caption.clear();
1384 // set catcodes to verbatim early, just in case.
1385 p.setCatcodes(VERBATIM_CATCODES);
1386 string delim = p.get_token().asInput();
1387 //FIXME: handler error condition
1388 s = p.verbatimStuff(delim).second;
1389 // context.new_paragraph(os);
1390 } else if (use_minted) {
1391 s = p.verbatimEnvironment("minted");
1393 s = p.verbatimEnvironment("lstlisting");
1395 output_ert(os, s, context);
1396 if (use_minted && prefixIs(minted_nonfloat_caption, "[b]")) {
1397 minted_nonfloat_caption.erase(0,3);
1398 os << "\n\\begin_layout Plain Layout\n";
1399 begin_inset(os, "Caption Standard\n");
1400 Context newcontext(true, context.textclass,
1401 context.layout, 0, context.font);
1402 newcontext.check_layout(os);
1403 os << minted_nonfloat_caption << "\n";
1404 newcontext.check_end_layout(os);
1406 os << "\n\\end_layout\n";
1407 minted_nonfloat_caption.clear();
1409 // Don't close the inset here for floating minted listings.
1410 // It will be closed at the end of the listing environment.
1411 if (!use_minted || minted_float.empty())
1414 eat_whitespace(p, os, parent_context, true);
1415 Token t = p.get_token();
1416 if (t.asInput() != "\\end") {
1417 // If anything follows, collect it into a caption.
1418 minted_float_has_caption = true;
1419 os << "\n\\begin_layout Plain Layout\n"; // outer layout
1420 begin_inset(os, "Caption Standard\n");
1421 os << "\n\\begin_layout Plain Layout\n"; // inner layout
1428 /// parse an unknown environment
1429 void parse_unknown_environment(Parser & p, string const & name, ostream & os,
1430 unsigned flags, bool outer,
1431 Context & parent_context)
1433 if (name == "tabbing")
1434 // We need to remember that we have to handle '\=' specially
1435 flags |= FLAG_TABBING;
1437 // We need to translate font changes and paragraphs inside the
1438 // environment to ERT if we have a non standard font.
1439 // Otherwise things like
1440 // \large\begin{foo}\huge bar\end{foo}
1442 bool const specialfont =
1443 (parent_context.font != parent_context.normalfont);
1444 bool const new_layout_allowed = parent_context.new_layout_allowed;
1446 parent_context.new_layout_allowed = false;
1447 output_ert_inset(os, "\\begin{" + name + "}", parent_context);
1448 parse_text_snippet(p, os, flags, outer, parent_context);
1449 output_ert_inset(os, "\\end{" + name + "}", parent_context);
1451 parent_context.new_layout_allowed = new_layout_allowed;
1455 void parse_environment(Parser & p, ostream & os, bool outer,
1456 string & last_env, Context & parent_context)
1458 Layout const * newlayout;
1459 InsetLayout const * newinsetlayout = 0;
1460 string const name = p.getArg('{', '}');
1461 const bool is_starred = suffixIs(name, '*');
1462 string const unstarred_name = rtrim(name, "*");
1463 active_environments.push_back(name);
1465 if (is_math_env(name)) {
1466 parent_context.check_layout(os);
1467 begin_inset(os, "Formula ");
1468 os << "\\begin{" << name << "}";
1469 parse_math(p, os, FLAG_END, MATH_MODE);
1470 os << "\\end{" << name << "}";
1472 if (is_display_math_env(name)) {
1473 // Prevent the conversion of a line break to a space
1474 // (bug 7668). This does not change the output, but
1475 // looks ugly in LyX.
1476 eat_whitespace(p, os, parent_context, false);
1480 else if (is_known(name, preamble.polyglossia_languages)) {
1481 // We must begin a new paragraph if not already done
1482 if (! parent_context.atParagraphStart()) {
1483 parent_context.check_end_layout(os);
1484 parent_context.new_paragraph(os);
1486 // save the language in the context so that it is
1487 // handled by parse_text
1488 parent_context.font.language = preamble.polyglossia2lyx(name);
1489 parse_text(p, os, FLAG_END, outer, parent_context);
1490 // Just in case the environment is empty
1491 parent_context.extra_stuff.erase();
1492 // We must begin a new paragraph to reset the language
1493 parent_context.new_paragraph(os);
1497 else if (unstarred_name == "tabular" || name == "longtable") {
1498 eat_whitespace(p, os, parent_context, false);
1499 string width = "0pt";
1500 if (name == "tabular*") {
1501 width = lyx::translate_len(p.getArg('{', '}'));
1502 eat_whitespace(p, os, parent_context, false);
1504 parent_context.check_layout(os);
1505 begin_inset(os, "Tabular ");
1506 handle_tabular(p, os, name, width, parent_context);
1511 else if (parent_context.textclass.floats().typeExist(unstarred_name)) {
1512 eat_whitespace(p, os, parent_context, false);
1513 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1514 eat_whitespace(p, os, parent_context, false);
1515 parent_context.check_layout(os);
1516 begin_inset(os, "Float " + unstarred_name + "\n");
1517 // store the float type for subfloats
1518 // subfloats only work with figures and tables
1519 if (unstarred_name == "figure")
1520 float_type = unstarred_name;
1521 else if (unstarred_name == "table")
1522 float_type = unstarred_name;
1526 os << "placement " << opt << '\n';
1527 if (contains(opt, "H"))
1528 preamble.registerAutomaticallyLoadedPackage("float");
1530 Floating const & fl = parent_context.textclass.floats()
1531 .getType(unstarred_name);
1532 if (!fl.floattype().empty() && fl.usesFloatPkg())
1533 preamble.registerAutomaticallyLoadedPackage("float");
1536 os << "wide " << convert<string>(is_starred)
1537 << "\nsideways false"
1538 << "\nstatus open\n\n";
1539 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1541 // We don't need really a new paragraph, but
1542 // we must make sure that the next item gets a \begin_layout.
1543 parent_context.new_paragraph(os);
1545 // the float is parsed thus delete the type
1549 else if (unstarred_name == "sidewaysfigure"
1550 || unstarred_name == "sidewaystable"
1551 || unstarred_name == "sidewaysalgorithm") {
1552 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1553 eat_whitespace(p, os, parent_context, false);
1554 parent_context.check_layout(os);
1555 if (unstarred_name == "sidewaysfigure")
1556 begin_inset(os, "Float figure\n");
1557 else if (unstarred_name == "sidewaystable")
1558 begin_inset(os, "Float table\n");
1559 else if (unstarred_name == "sidewaysalgorithm")
1560 begin_inset(os, "Float algorithm\n");
1562 os << "placement " << opt << '\n';
1563 if (contains(opt, "H"))
1564 preamble.registerAutomaticallyLoadedPackage("float");
1565 os << "wide " << convert<string>(is_starred)
1566 << "\nsideways true"
1567 << "\nstatus open\n\n";
1568 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1570 // We don't need really a new paragraph, but
1571 // we must make sure that the next item gets a \begin_layout.
1572 parent_context.new_paragraph(os);
1574 preamble.registerAutomaticallyLoadedPackage("rotfloat");
1577 else if (name == "wrapfigure" || name == "wraptable") {
1578 // syntax is \begin{wrapfigure}[lines]{placement}[overhang]{width}
1579 eat_whitespace(p, os, parent_context, false);
1580 parent_context.check_layout(os);
1583 string overhang = "0col%";
1586 lines = p.getArg('[', ']');
1587 string const placement = p.getArg('{', '}');
1589 overhang = p.getArg('[', ']');
1590 string const width = p.getArg('{', '}');
1592 if (name == "wrapfigure")
1593 begin_inset(os, "Wrap figure\n");
1595 begin_inset(os, "Wrap table\n");
1596 os << "lines " << lines
1597 << "\nplacement " << placement
1598 << "\noverhang " << lyx::translate_len(overhang)
1599 << "\nwidth " << lyx::translate_len(width)
1600 << "\nstatus open\n\n";
1601 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1603 // We don't need really a new paragraph, but
1604 // we must make sure that the next item gets a \begin_layout.
1605 parent_context.new_paragraph(os);
1607 preamble.registerAutomaticallyLoadedPackage("wrapfig");
1610 else if (name == "minipage") {
1611 eat_whitespace(p, os, parent_context, false);
1612 // Test whether this is an outer box of a shaded box
1614 // swallow arguments
1615 while (p.hasOpt()) {
1617 p.skip_spaces(true);
1620 p.skip_spaces(true);
1621 Token t = p.get_token();
1622 bool shaded = false;
1623 if (t.asInput() == "\\begin") {
1624 p.skip_spaces(true);
1625 if (p.getArg('{', '}') == "shaded")
1630 parse_outer_box(p, os, FLAG_END, outer,
1631 parent_context, name, "shaded");
1633 parse_box(p, os, 0, FLAG_END, outer, parent_context,
1634 "", "", name, "", "");
1638 else if (name == "comment") {
1639 eat_whitespace(p, os, parent_context, false);
1640 parent_context.check_layout(os);
1641 begin_inset(os, "Note Comment\n");
1642 os << "status open\n";
1643 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1646 skip_braces(p); // eat {} that might by set by LyX behind comments
1647 preamble.registerAutomaticallyLoadedPackage("verbatim");
1650 else if (unstarred_name == "verbatim") {
1651 // FIXME: this should go in the generic code that
1652 // handles environments defined in layout file that
1653 // have "PassThru 1". However, the code over there is
1654 // already too complicated for my taste.
1655 string const ascii_name =
1656 (name == "verbatim*") ? "Verbatim*" : "Verbatim";
1657 parent_context.new_paragraph(os);
1658 Context context(true, parent_context.textclass,
1659 &parent_context.textclass[from_ascii(ascii_name)]);
1660 string s = p.verbatimEnvironment(name);
1661 output_ert(os, s, context);
1665 else if (name == "IPA") {
1666 eat_whitespace(p, os, parent_context, false);
1667 parent_context.check_layout(os);
1668 begin_inset(os, "IPA\n");
1669 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1672 preamble.registerAutomaticallyLoadedPackage("tipa");
1673 preamble.registerAutomaticallyLoadedPackage("tipx");
1676 else if (name == "CJK") {
1677 // the scheme is \begin{CJK}{encoding}{mapping}text\end{CJK}
1678 // It is impossible to decide if a CJK environment was in its own paragraph or within
1679 // a line. We therefore always assume a paragraph since the latter is a rare case.
1680 eat_whitespace(p, os, parent_context, false);
1681 parent_context.check_end_layout(os);
1682 // store the encoding to be able to reset it
1683 string const encoding_old = p.getEncoding();
1684 string const encoding = p.getArg('{', '}');
1685 // FIXME: For some reason JIS does not work. Although the text
1686 // in tests/CJK.tex is identical with the SJIS version if you
1687 // convert both snippets using the recode command line utility,
1688 // the resulting .lyx file contains some extra characters if
1689 // you set buggy_encoding to false for JIS.
1690 bool const buggy_encoding = encoding == "JIS";
1691 if (!buggy_encoding)
1692 p.setEncoding(encoding, Encoding::CJK);
1694 // FIXME: This will read garbage, since the data is not encoded in utf8.
1695 p.setEncoding("UTF-8");
1697 // LyX only supports the same mapping for all CJK
1698 // environments, so we might need to output everything as ERT
1699 string const mapping = trim(p.getArg('{', '}'));
1700 char const * const * const where =
1701 is_known(encoding, supported_CJK_encodings);
1702 if (!buggy_encoding && !preamble.fontCJKSet())
1703 preamble.fontCJK(mapping);
1704 bool knownMapping = mapping == preamble.fontCJK();
1705 if (buggy_encoding || !knownMapping || !where) {
1706 parent_context.check_layout(os);
1707 output_ert_inset(os, "\\begin{" + name + "}{" + encoding + "}{" + mapping + "}",
1709 // we must parse the content as verbatim because e.g. JIS can contain
1710 // normally invalid characters
1711 // FIXME: This works only for the most simple cases.
1712 // Since TeX control characters are not parsed,
1713 // things like comments are completely wrong.
1714 string const s = p.plainEnvironment("CJK");
1715 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
1717 output_ert_inset(os, "\\", parent_context);
1718 else if (*it == '$')
1719 output_ert_inset(os, "$", parent_context);
1720 else if (*it == '\n' && it + 1 != et && s.begin() + 1 != it)
1725 output_ert_inset(os, "\\end{" + name + "}",
1729 supported_CJK_languages[where - supported_CJK_encodings];
1730 // store the language because we must reset it at the end
1731 string const lang_old = parent_context.font.language;
1732 parent_context.font.language = lang;
1733 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1734 parent_context.font.language = lang_old;
1735 parent_context.new_paragraph(os);
1737 p.setEncoding(encoding_old);
1741 else if (name == "lyxgreyedout") {
1742 eat_whitespace(p, os, parent_context, false);
1743 parent_context.check_layout(os);
1744 begin_inset(os, "Note Greyedout\n");
1745 os << "status open\n";
1746 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1749 if (!preamble.notefontcolor().empty())
1750 preamble.registerAutomaticallyLoadedPackage("color");
1753 else if (name == "btSect") {
1754 eat_whitespace(p, os, parent_context, false);
1755 parent_context.check_layout(os);
1756 begin_command_inset(os, "bibtex", "bibtex");
1757 string bibstyle = "plain";
1759 bibstyle = p.getArg('[', ']');
1760 p.skip_spaces(true);
1762 string const bibfile = p.getArg('{', '}');
1763 eat_whitespace(p, os, parent_context, false);
1764 Token t = p.get_token();
1765 if (t.asInput() == "\\btPrintCited") {
1766 p.skip_spaces(true);
1767 os << "btprint " << '"' << "btPrintCited" << '"' << "\n";
1769 if (t.asInput() == "\\btPrintNotCited") {
1770 p.skip_spaces(true);
1771 os << "btprint " << '"' << "btPrintNotCited" << '"' << "\n";
1773 if (t.asInput() == "\\btPrintAll") {
1774 p.skip_spaces(true);
1775 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
1777 os << "bibfiles " << '"' << bibfile << "\"\n"
1778 << "options " << '"' << bibstyle << "\"\n";
1779 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1784 else if (name == "framed" || name == "shaded") {
1785 eat_whitespace(p, os, parent_context, false);
1786 parse_outer_box(p, os, FLAG_END, outer, parent_context, name, "");
1788 preamble.registerAutomaticallyLoadedPackage("framed");
1791 else if (name == "listing") {
1792 minted_float = "float";
1793 eat_whitespace(p, os, parent_context, false);
1794 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1796 minted_float += "=" + opt;
1797 // If something precedes \begin{minted}, we output it at the end
1798 // as a caption, in order to keep it inside the listings inset.
1799 eat_whitespace(p, os, parent_context, true);
1801 Token const & t = p.get_token();
1802 p.skip_spaces(true);
1803 string const envname = p.next_token().cat() == catBegin
1804 ? p.getArg('{', '}') : string();
1805 bool prologue = t.asInput() != "\\begin" || envname != "minted";
1807 minted_float_has_caption = false;
1808 string content = parse_text_snippet(p, FLAG_END, outer,
1810 size_t i = content.find("\\begin_inset listings");
1811 bool minted_env = i != string::npos;
1814 caption = content.substr(0, i);
1815 content.erase(0, i);
1817 parent_context.check_layout(os);
1818 if (minted_env && minted_float_has_caption) {
1819 eat_whitespace(p, os, parent_context, true);
1820 os << content << "\n";
1821 if (!caption.empty())
1822 os << caption << "\n";
1823 os << "\n\\end_layout\n"; // close inner layout
1824 end_inset(os); // close caption inset
1825 os << "\n\\end_layout\n"; // close outer layout
1826 } else if (!caption.empty()) {
1828 begin_inset(os, "listings\n");
1829 os << "lstparams " << '"' << minted_float << '"' << '\n';
1830 os << "inline false\n";
1831 os << "status collapsed\n";
1833 os << "\n\\begin_layout Plain Layout\n";
1834 begin_inset(os, "Caption Standard\n");
1835 Context newcontext(true, parent_context.textclass,
1836 0, 0, parent_context.font);
1837 newcontext.check_layout(os);
1838 os << caption << "\n";
1839 newcontext.check_end_layout(os);
1841 os << "\n\\end_layout\n";
1842 } else if (content.empty()) {
1843 begin_inset(os, "listings\n");
1844 os << "lstparams " << '"' << minted_float << '"' << '\n';
1845 os << "inline false\n";
1846 os << "status collapsed\n";
1848 os << content << "\n";
1850 end_inset(os); // close listings inset
1851 parent_context.check_end_layout(os);
1852 parent_context.new_paragraph(os);
1854 minted_float.clear();
1855 minted_float_has_caption = false;
1858 else if (name == "lstlisting" || name == "minted") {
1859 bool use_minted = name == "minted";
1860 eat_whitespace(p, os, parent_context, false);
1861 if (use_minted && minted_float.empty()) {
1862 // look ahead for a bottom caption
1864 bool found_end_minted = false;
1865 while (!found_end_minted && p.good()) {
1866 Token const & t = p.get_token();
1868 string const envname =
1869 p.next_token().cat() == catBegin
1870 ? p.getArg('{', '}') : string();
1871 found_end_minted = t.asInput() == "\\end"
1872 && envname == "minted";
1874 eat_whitespace(p, os, parent_context, true);
1875 Token const & t = p.get_token();
1876 p.skip_spaces(true);
1877 if (t.asInput() == "\\lyxmintcaption") {
1878 string const pos = p.getArg('[', ']');
1880 string const caption =
1881 parse_text_snippet(p, FLAG_ITEM,
1882 false, parent_context);
1883 minted_nonfloat_caption = "[b]" + caption;
1888 parse_listings(p, os, parent_context, false, use_minted);
1892 else if (!parent_context.new_layout_allowed)
1893 parse_unknown_environment(p, name, os, FLAG_END, outer,
1896 // Alignment and spacing settings
1897 // FIXME (bug xxxx): These settings can span multiple paragraphs and
1898 // therefore are totally broken!
1899 // Note that \centering, raggedright, and raggedleft cannot be handled, as
1900 // they are commands not environments. They are furthermore switches that
1901 // can be ended by another switches, but also by commands like \footnote or
1902 // \parbox. So the only safe way is to leave them untouched.
1903 else if (name == "center" || name == "centering" ||
1904 name == "flushleft" || name == "flushright" ||
1905 name == "singlespace" || name == "onehalfspace" ||
1906 name == "doublespace" || name == "spacing") {
1907 eat_whitespace(p, os, parent_context, false);
1908 // We must begin a new paragraph if not already done
1909 if (! parent_context.atParagraphStart()) {
1910 parent_context.check_end_layout(os);
1911 parent_context.new_paragraph(os);
1913 if (name == "flushleft")
1914 parent_context.add_extra_stuff("\\align left\n");
1915 else if (name == "flushright")
1916 parent_context.add_extra_stuff("\\align right\n");
1917 else if (name == "center" || name == "centering")
1918 parent_context.add_extra_stuff("\\align center\n");
1919 else if (name == "singlespace")
1920 parent_context.add_extra_stuff("\\paragraph_spacing single\n");
1921 else if (name == "onehalfspace") {
1922 parent_context.add_extra_stuff("\\paragraph_spacing onehalf\n");
1923 preamble.registerAutomaticallyLoadedPackage("setspace");
1924 } else if (name == "doublespace") {
1925 parent_context.add_extra_stuff("\\paragraph_spacing double\n");
1926 preamble.registerAutomaticallyLoadedPackage("setspace");
1927 } else if (name == "spacing") {
1928 parent_context.add_extra_stuff("\\paragraph_spacing other " + p.verbatim_item() + "\n");
1929 preamble.registerAutomaticallyLoadedPackage("setspace");
1931 parse_text(p, os, FLAG_END, outer, parent_context);
1932 // Just in case the environment is empty
1933 parent_context.extra_stuff.erase();
1934 // We must begin a new paragraph to reset the alignment
1935 parent_context.new_paragraph(os);
1939 // The single '=' is meant here.
1940 else if ((newlayout = findLayout(parent_context.textclass, name, false))) {
1941 eat_whitespace(p, os, parent_context, false);
1942 Context context(true, parent_context.textclass, newlayout,
1943 parent_context.layout, parent_context.font);
1944 if (parent_context.deeper_paragraph) {
1945 // We are beginning a nested environment after a
1946 // deeper paragraph inside the outer list environment.
1947 // Therefore we don't need to output a "begin deeper".
1948 context.need_end_deeper = true;
1950 parent_context.check_end_layout(os);
1951 if (last_env == name) {
1952 // we need to output a separator since LyX would export
1953 // the two environments as one otherwise (bug 5716)
1954 TeX2LyXDocClass const & textclass(parent_context.textclass);
1955 Context newcontext(true, textclass,
1956 &(textclass.defaultLayout()));
1957 newcontext.check_layout(os);
1958 begin_inset(os, "Separator plain\n");
1960 newcontext.check_end_layout(os);
1962 switch (context.layout->latextype) {
1963 case LATEX_LIST_ENVIRONMENT:
1964 context.add_par_extra_stuff("\\labelwidthstring "
1965 + p.verbatim_item() + '\n');
1968 case LATEX_BIB_ENVIRONMENT:
1969 p.verbatim_item(); // swallow next arg
1975 context.check_deeper(os);
1976 // handle known optional and required arguments
1977 // Unfortunately LyX can't handle arguments of list arguments (bug 7468):
1978 // It is impossible to place anything after the environment name,
1979 // but before the first \\item.
1980 if (context.layout->latextype == LATEX_ENVIRONMENT)
1981 output_arguments(os, p, outer, false, false, context,
1982 context.layout->latexargs());
1983 parse_text(p, os, FLAG_END, outer, context);
1984 if (context.layout->latextype == LATEX_ENVIRONMENT)
1985 output_arguments(os, p, outer, false, true, context,
1986 context.layout->postcommandargs());
1987 context.check_end_layout(os);
1988 if (parent_context.deeper_paragraph) {
1989 // We must suppress the "end deeper" because we
1990 // suppressed the "begin deeper" above.
1991 context.need_end_deeper = false;
1993 context.check_end_deeper(os);
1994 parent_context.new_paragraph(os);
1996 if (!preamble.titleLayoutFound())
1997 preamble.titleLayoutFound(newlayout->intitle);
1998 set<string> const & req = newlayout->requires();
1999 set<string>::const_iterator it = req.begin();
2000 set<string>::const_iterator en = req.end();
2001 for (; it != en; ++it)
2002 preamble.registerAutomaticallyLoadedPackage(*it);
2005 // The single '=' is meant here.
2006 else if ((newinsetlayout = findInsetLayout(parent_context.textclass, name, false))) {
2007 eat_whitespace(p, os, parent_context, false);
2008 parent_context.check_layout(os);
2009 begin_inset(os, "Flex ");
2010 os << to_utf8(newinsetlayout->name()) << '\n'
2011 << "status collapsed\n";
2012 if (newinsetlayout->isPassThru()) {
2013 string const arg = p.verbatimEnvironment(name);
2014 Context context(true, parent_context.textclass,
2015 &parent_context.textclass.plainLayout(),
2016 parent_context.layout);
2017 output_ert(os, arg, parent_context);
2019 parse_text_in_inset(p, os, FLAG_END, false, parent_context, newinsetlayout);
2023 else if (name == "appendix") {
2024 // This is no good latex style, but it works and is used in some documents...
2025 eat_whitespace(p, os, parent_context, false);
2026 parent_context.check_end_layout(os);
2027 Context context(true, parent_context.textclass, parent_context.layout,
2028 parent_context.layout, parent_context.font);
2029 context.check_layout(os);
2030 os << "\\start_of_appendix\n";
2031 parse_text(p, os, FLAG_END, outer, context);
2032 context.check_end_layout(os);
2036 else if (known_environments.find(name) != known_environments.end()) {
2037 vector<ArgumentType> arguments = known_environments[name];
2038 // The last "argument" denotes wether we may translate the
2039 // environment contents to LyX
2040 // The default required if no argument is given makes us
2041 // compatible with the reLyXre environment.
2042 ArgumentType contents = arguments.empty() ?
2045 if (!arguments.empty())
2046 arguments.pop_back();
2047 // See comment in parse_unknown_environment()
2048 bool const specialfont =
2049 (parent_context.font != parent_context.normalfont);
2050 bool const new_layout_allowed =
2051 parent_context.new_layout_allowed;
2053 parent_context.new_layout_allowed = false;
2054 parse_arguments("\\begin{" + name + "}", arguments, p, os,
2055 outer, parent_context);
2056 if (contents == verbatim)
2057 output_ert_inset(os, p.ertEnvironment(name),
2060 parse_text_snippet(p, os, FLAG_END, outer,
2062 output_ert_inset(os, "\\end{" + name + "}", parent_context);
2064 parent_context.new_layout_allowed = new_layout_allowed;
2068 parse_unknown_environment(p, name, os, FLAG_END, outer,
2072 active_environments.pop_back();
2076 /// parses a comment and outputs it to \p os.
2077 void parse_comment(Parser & p, ostream & os, Token const & t, Context & context)
2079 LASSERT(t.cat() == catComment, return);
2080 if (!t.cs().empty()) {
2081 context.check_layout(os);
2082 output_comment(p, os, t.cs(), context);
2083 if (p.next_token().cat() == catNewline) {
2084 // A newline after a comment line starts a new
2086 if (context.new_layout_allowed) {
2087 if(!context.atParagraphStart())
2088 // Only start a new paragraph if not already
2089 // done (we might get called recursively)
2090 context.new_paragraph(os);
2092 output_ert_inset(os, "\n", context);
2093 eat_whitespace(p, os, context, true);
2096 // "%\n" combination
2103 * Reads spaces and comments until the first non-space, non-comment token.
2104 * New paragraphs (double newlines or \\par) are handled like simple spaces
2105 * if \p eatParagraph is true.
2106 * Spaces are skipped, but comments are written to \p os.
2108 void eat_whitespace(Parser & p, ostream & os, Context & context,
2112 Token const & t = p.get_token();
2113 if (t.cat() == catComment)
2114 parse_comment(p, os, t, context);
2115 else if ((! eatParagraph && p.isParagraph()) ||
2116 (t.cat() != catSpace && t.cat() != catNewline)) {
2125 * Set a font attribute, parse text and reset the font attribute.
2126 * \param attribute Attribute name (e.g. \\family, \\shape etc.)
2127 * \param currentvalue Current value of the attribute. Is set to the new
2128 * value during parsing.
2129 * \param newvalue New value of the attribute
2131 void parse_text_attributes(Parser & p, ostream & os, unsigned flags, bool outer,
2132 Context & context, string const & attribute,
2133 string & currentvalue, string const & newvalue)
2135 context.check_layout(os);
2136 string const oldvalue = currentvalue;
2137 currentvalue = newvalue;
2138 os << '\n' << attribute << ' ' << newvalue << "\n";
2139 parse_text_snippet(p, os, flags, outer, context);
2140 context.check_layout(os);
2141 os << '\n' << attribute << ' ' << oldvalue << "\n";
2142 currentvalue = oldvalue;
2146 /// get the arguments of a natbib or jurabib citation command
2147 void get_cite_arguments(Parser & p, bool natbibOrder,
2148 string & before, string & after, bool const qualified = false)
2150 // We need to distinguish "" and "[]", so we can't use p.getOpt().
2152 // text before the citation
2154 // text after the citation
2155 after = qualified ? p.getFullOpt(false, '(', ')') : p.getFullOpt();
2157 if (!after.empty()) {
2158 before = qualified ? p.getFullOpt(false, '(', ')') : p.getFullOpt();
2159 if (natbibOrder && !before.empty())
2160 swap(before, after);
2165 /// Convert filenames with TeX macros and/or quotes to something LyX
2167 string const normalize_filename(string const & name)
2172 Token const & t = p.get_token();
2173 if (t.cat() != catEscape)
2175 else if (t.cs() == "lyxdot") {
2176 // This is used by LyX for simple dots in relative
2180 } else if (t.cs() == "space") {
2183 } else if (t.cs() == "string") {
2184 // Convert \string" to " and \string~ to ~
2185 Token const & n = p.next_token();
2186 if (n.asInput() != "\"" && n.asInput() != "~")
2191 // Strip quotes. This is a bit complicated (see latex_path()).
2192 string full = os.str();
2193 if (!full.empty() && full[0] == '"') {
2194 string base = removeExtension(full);
2195 string ext = getExtension(full);
2196 if (!base.empty() && base[base.length()-1] == '"')
2199 return addExtension(trim(base, "\""), ext);
2200 if (full[full.length()-1] == '"')
2203 return trim(full, "\"");
2209 /// Convert \p name from TeX convention (relative to master file) to LyX
2210 /// convention (relative to .lyx file) if it is relative
2211 void fix_child_filename(string & name)
2213 string const absMasterTeX = getMasterFilePath(true);
2214 bool const isabs = FileName::isAbsolute(name);
2215 // convert from "relative to .tex master" to absolute original path
2217 name = makeAbsPath(name, absMasterTeX).absFileName();
2218 bool copyfile = copyFiles();
2219 string const absParentLyX = getParentFilePath(false);
2222 // convert from absolute original path to "relative to master file"
2223 string const rel = to_utf8(makeRelPath(from_utf8(name),
2224 from_utf8(absMasterTeX)));
2225 // re-interpret "relative to .tex file" as "relative to .lyx file"
2226 // (is different if the master .lyx file resides in a
2227 // different path than the master .tex file)
2228 string const absMasterLyX = getMasterFilePath(false);
2229 abs = makeAbsPath(rel, absMasterLyX).absFileName();
2230 // Do not copy if the new path is impossible to create. Example:
2231 // absMasterTeX = "/foo/bar/"
2232 // absMasterLyX = "/bar/"
2233 // name = "/baz.eps" => new absolute name would be "/../baz.eps"
2234 if (contains(name, "/../"))
2241 // convert from absolute original path to
2242 // "relative to .lyx file"
2243 name = to_utf8(makeRelPath(from_utf8(abs),
2244 from_utf8(absParentLyX)));
2248 // convert from absolute original path to "relative to .lyx file"
2249 name = to_utf8(makeRelPath(from_utf8(name),
2250 from_utf8(absParentLyX)));
2255 void copy_file(FileName const & src, string dstname)
2259 string const absParent = getParentFilePath(false);
2261 if (FileName::isAbsolute(dstname))
2262 dst = FileName(dstname);
2264 dst = makeAbsPath(dstname, absParent);
2265 FileName const srcpath = src.onlyPath();
2266 FileName const dstpath = dst.onlyPath();
2267 if (equivalent(srcpath, dstpath))
2269 if (!dstpath.isDirectory()) {
2270 if (!dstpath.createPath()) {
2271 cerr << "Warning: Could not create directory for file `"
2272 << dst.absFileName() << "´." << endl;
2276 if (dst.isReadableFile()) {
2277 if (overwriteFiles())
2278 cerr << "Warning: Overwriting existing file `"
2279 << dst.absFileName() << "´." << endl;
2281 cerr << "Warning: Not overwriting existing file `"
2282 << dst.absFileName() << "´." << endl;
2286 if (!src.copyTo(dst))
2287 cerr << "Warning: Could not copy file `" << src.absFileName()
2288 << "´ to `" << dst.absFileName() << "´." << endl;
2292 /// Parse a literate Chunk section. The initial "<<" is already parsed.
2293 bool parse_chunk(Parser & p, ostream & os, Context & context)
2295 // check whether a chunk is possible here.
2296 if (!context.textclass.hasInsetLayout(from_ascii("Flex:Chunk"))) {
2302 // read the parameters
2303 Parser::Arg const params = p.verbatimStuff(">>=\n", false);
2304 if (!params.first) {
2309 Parser::Arg const code = p.verbatimStuff("\n@");
2314 string const post_chunk = p.verbatimStuff("\n").second + '\n';
2315 if (post_chunk[0] != ' ' && post_chunk[0] != '\n') {
2319 // The last newline read is important for paragraph handling
2323 //cerr << "params=[" << params.second << "], code=[" << code.second << "]" <<endl;
2324 // We must have a valid layout before outputting the Chunk inset.
2325 context.check_layout(os);
2326 Context chunkcontext(true, context.textclass);
2327 chunkcontext.layout = &context.textclass.plainLayout();
2328 begin_inset(os, "Flex Chunk");
2329 os << "\nstatus open\n";
2330 if (!params.second.empty()) {
2331 chunkcontext.check_layout(os);
2332 Context paramscontext(true, context.textclass);
2333 paramscontext.layout = &context.textclass.plainLayout();
2334 begin_inset(os, "Argument 1");
2335 os << "\nstatus open\n";
2336 output_ert(os, params.second, paramscontext);
2339 output_ert(os, code.second, chunkcontext);
2347 /// detects \\def, \\long\\def and \\global\\long\\def with ws and comments
2348 bool is_macro(Parser & p)
2350 Token first = p.curr_token();
2351 if (first.cat() != catEscape || !p.good())
2353 if (first.cs() == "def")
2355 if (first.cs() != "global" && first.cs() != "long")
2357 Token second = p.get_token();
2359 while (p.good() && !p.isParagraph() && (second.cat() == catSpace ||
2360 second.cat() == catNewline || second.cat() == catComment)) {
2361 second = p.get_token();
2364 bool secondvalid = second.cat() == catEscape;
2366 bool thirdvalid = false;
2367 if (p.good() && first.cs() == "global" && secondvalid &&
2368 second.cs() == "long") {
2369 third = p.get_token();
2371 while (p.good() && !p.isParagraph() &&
2372 (third.cat() == catSpace ||
2373 third.cat() == catNewline ||
2374 third.cat() == catComment)) {
2375 third = p.get_token();
2378 thirdvalid = third.cat() == catEscape;
2380 for (int i = 0; i < pos; ++i)
2385 return (first.cs() == "global" || first.cs() == "long") &&
2386 second.cs() == "def";
2387 return first.cs() == "global" && second.cs() == "long" &&
2388 third.cs() == "def";
2392 /// Parse a macro definition (assumes that is_macro() returned true)
2393 void parse_macro(Parser & p, ostream & os, Context & context)
2395 context.check_layout(os);
2396 Token first = p.curr_token();
2399 string command = first.asInput();
2400 if (first.cs() != "def") {
2402 eat_whitespace(p, os, context, false);
2403 second = p.curr_token();
2404 command += second.asInput();
2405 if (second.cs() != "def") {
2407 eat_whitespace(p, os, context, false);
2408 third = p.curr_token();
2409 command += third.asInput();
2412 eat_whitespace(p, os, context, false);
2413 string const name = p.get_token().cs();
2414 eat_whitespace(p, os, context, false);
2420 while (p.next_token().cat() != catBegin) {
2421 if (p.next_token().cat() == catParameter) {
2426 // followed by number?
2427 if (p.next_token().cat() == catOther) {
2428 string s = p.get_token().asInput();
2430 // number = current arity + 1?
2431 if (s.size() == 1 && s[0] == arity + '0' + 1)
2436 paramtext += p.get_token().cs();
2438 paramtext += p.get_token().cs();
2443 // only output simple (i.e. compatible) macro as FormulaMacros
2444 string ert = '\\' + name + ' ' + paramtext + '{' + p.verbatim_item() + '}';
2446 context.check_layout(os);
2447 begin_inset(os, "FormulaMacro");
2448 os << "\n\\def" << ert;
2451 output_ert_inset(os, command + ert, context);
2455 void registerExternalTemplatePackages(string const & name)
2457 external::TemplateManager const & etm = external::TemplateManager::get();
2458 external::Template const * const et = etm.getTemplateByName(name);
2461 external::Template::Formats::const_iterator cit = et->formats.end();
2463 cit = et->formats.find("PDFLaTeX");
2464 if (cit == et->formats.end())
2465 // If the template has not specified a PDFLaTeX output,
2466 // we try the LaTeX format.
2467 cit = et->formats.find("LaTeX");
2468 if (cit == et->formats.end())
2470 vector<string>::const_iterator qit = cit->second.requirements.begin();
2471 vector<string>::const_iterator qend = cit->second.requirements.end();
2472 for (; qit != qend; ++qit)
2473 preamble.registerAutomaticallyLoadedPackage(*qit);
2476 } // anonymous namespace
2479 void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
2482 Layout const * newlayout = 0;
2483 InsetLayout const * newinsetlayout = 0;
2484 char const * const * where = 0;
2485 // Store the latest bibliographystyle, addcontentslineContent and
2486 // nocite{*} option (needed for bibtex inset)
2488 string contentslineContent;
2489 string bibliographystyle = "default";
2490 bool const use_natbib = isProvided("natbib");
2491 bool const use_jurabib = isProvided("jurabib");
2492 bool const use_biblatex = isProvided("biblatex")
2493 && preamble.citeEngine() != "biblatex-natbib";
2494 bool const use_biblatex_natbib = isProvided("biblatex-natbib")
2495 || (isProvided("biblatex") && preamble.citeEngine() == "biblatex-natbib");
2496 need_commentbib = use_biblatex || use_biblatex_natbib;
2499 // it is impossible to determine the correct encoding for non-CJK Japanese.
2500 // Therefore write a note at the beginning of the document
2501 if (is_nonCJKJapanese) {
2502 context.check_layout(os);
2503 begin_inset(os, "Note Note\n");
2504 os << "status open\n\\begin_layout Plain Layout\n"
2505 << "\\series bold\n"
2506 << "Important information:\n"
2507 << "\\end_layout\n\n"
2508 << "\\begin_layout Plain Layout\n"
2509 << "The original LaTeX source for this document is in Japanese (pLaTeX).\n"
2510 << " It was therefore impossible for tex2lyx to determine the correct encoding.\n"
2511 << " The iconv encoding " << p.getEncoding() << " was used.\n"
2512 << " If this is incorrect, you must run the tex2lyx program on the command line\n"
2513 << " and specify the encoding using the -e command-line switch.\n"
2514 << " In addition, you might want to double check that the desired output encoding\n"
2515 << " is correctly selected in Document > Settings > Language.\n"
2516 << "\\end_layout\n";
2518 is_nonCJKJapanese = false;
2521 bool have_cycled = false;
2523 // Leave here only after at least one cycle
2524 if (have_cycled && flags & FLAG_LEAVE) {
2525 flags &= ~FLAG_LEAVE;
2529 Token const & t = p.get_token();
2531 debugToken(cerr, t, flags);
2534 if (flags & FLAG_ITEM) {
2535 if (t.cat() == catSpace)
2538 flags &= ~FLAG_ITEM;
2539 if (t.cat() == catBegin) {
2540 // skip the brace and collect everything to the next matching
2542 flags |= FLAG_BRACE_LAST;
2546 // handle only this single token, leave the loop if done
2547 flags |= FLAG_LEAVE;
2550 if (t.cat() != catEscape && t.character() == ']' &&
2551 (flags & FLAG_BRACK_LAST))
2553 if (t.cat() == catEnd && (flags & FLAG_BRACE_LAST))
2556 // If there is anything between \end{env} and \begin{env} we
2557 // don't need to output a separator.
2558 if (t.cat() != catSpace && t.cat() != catNewline &&
2559 t.asInput() != "\\begin")
2566 bool const starred = p.next_token().asInput() == "*";
2567 string const starredname(starred ? (t.cs() + '*') : t.cs());
2568 if (t.cat() == catMath) {
2569 // we are inside some text mode thingy, so opening new math is allowed
2570 context.check_layout(os);
2571 begin_inset(os, "Formula ");
2572 Token const & n = p.get_token();
2573 bool const display(n.cat() == catMath && outer);
2575 // TeX's $$...$$ syntax for displayed math
2577 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2579 p.get_token(); // skip the second '$' token
2581 // simple $...$ stuff
2584 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2589 // Prevent the conversion of a line break to a
2590 // space (bug 7668). This does not change the
2591 // output, but looks ugly in LyX.
2592 eat_whitespace(p, os, context, false);
2597 if (t.cat() == catSuper || t.cat() == catSub) {
2598 cerr << "catcode " << t << " illegal in text mode\n";
2602 // Basic support for english quotes. This should be
2603 // extended to other quotes, but is not so easy (a
2604 // left english quote is the same as a right german
2606 if (t.asInput() == "`" && p.next_token().asInput() == "`") {
2607 context.check_layout(os);
2608 begin_inset(os, "Quotes ");
2615 if (t.asInput() == "'" && p.next_token().asInput() == "'") {
2616 context.check_layout(os);
2617 begin_inset(os, "Quotes ");
2625 if (t.asInput() == ">" && p.next_token().asInput() == ">") {
2626 context.check_layout(os);
2627 begin_inset(os, "Quotes ");
2635 if (t.asInput() == "<"
2636 && p.next_token().asInput() == "<") {
2637 bool has_chunk = false;
2641 has_chunk = parse_chunk(p, os, context);
2647 context.check_layout(os);
2648 begin_inset(os, "Quotes ");
2649 //FIXME: this is a right danish quote;
2650 // why not a left french quote?
2659 if (t.cat() == catSpace || (t.cat() == catNewline && ! p.isParagraph())) {
2660 check_space(p, os, context);
2664 // babel shorthands (also used by polyglossia)
2665 // Since these can have different meanings for different languages
2666 // we import them as ERT (but they must be put in ERT to get output
2668 if (t.asInput() == "\"") {
2670 // These are known pairs. We put them together in
2671 // one ERT inset. In other cases (such as "a), only
2672 // the quotation mark is ERTed.
2673 if (p.next_token().asInput() == "\""
2674 || p.next_token().asInput() == "|"
2675 || p.next_token().asInput() == "-"
2676 || p.next_token().asInput() == "~"
2677 || p.next_token().asInput() == "="
2678 || p.next_token().asInput() == "/"
2679 || p.next_token().asInput() == "~"
2680 || p.next_token().asInput() == "'"
2681 || p.next_token().asInput() == "`"
2682 || p.next_token().asInput() == "<"
2683 || p.next_token().asInput() == ">") {
2684 s += p.next_token().asInput();
2687 output_ert_inset(os, s, context);
2691 if (t.character() == '[' && noweb_mode &&
2692 p.next_token().character() == '[') {
2693 // These can contain underscores
2695 string const s = p.getFullOpt() + ']';
2696 if (p.next_token().character() == ']')
2699 cerr << "Warning: Inserting missing ']' in '"
2700 << s << "'." << endl;
2701 output_ert_inset(os, s, context);
2705 if (t.cat() == catLetter) {
2706 context.check_layout(os);
2711 if (t.cat() == catOther ||
2712 t.cat() == catAlign ||
2713 t.cat() == catParameter) {
2714 context.check_layout(os);
2715 if (t.asInput() == "-" && p.next_token().asInput() == "-" &&
2716 context.merging_hyphens_allowed &&
2717 context.font.family != "ttfamily" &&
2718 !context.layout->pass_thru) {
2719 if (p.next_next_token().asInput() == "-") {
2721 os << to_utf8(docstring(1, 0x2014));
2725 os << to_utf8(docstring(1, 0x2013));
2728 // This translates "&" to "\\&" which may be wrong...
2733 if (p.isParagraph()) {
2734 // In minted floating listings we will collect
2735 // everything into the caption, where multiple
2736 // paragraphs are forbidden.
2737 if (minted_float.empty()) {
2738 if (context.new_layout_allowed)
2739 context.new_paragraph(os);
2741 output_ert_inset(os, "\\par ", context);
2744 eat_whitespace(p, os, context, true);
2748 if (t.cat() == catActive) {
2749 context.check_layout(os);
2750 if (t.character() == '~') {
2751 if (context.layout->free_spacing)
2754 begin_inset(os, "space ~\n");
2762 if (t.cat() == catBegin) {
2763 Token const next = p.next_token();
2764 Token const end = p.next_next_token();
2765 if (next.cat() == catEnd) {
2767 Token const prev = p.prev_token();
2769 if (p.next_token().character() == '`')
2770 ; // ignore it in {}``
2772 output_ert_inset(os, "{}", context);
2773 } else if (next.cat() == catEscape &&
2774 is_known(next.cs(), known_quotes) &&
2775 end.cat() == catEnd) {
2776 // Something like {\textquoteright} (e.g.
2777 // from writer2latex). LyX writes
2778 // \textquoteright{}, so we may skip the
2779 // braces here for better readability.
2780 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2782 } else if (p.next_token().asInput() == "\\ascii") {
2783 // handle the \ascii characters
2784 // (the case without braces is handled later)
2785 // the code is "{\ascii\xxx}"
2786 p.get_token(); // eat \ascii
2787 string name2 = p.get_token().asInput();
2788 p.get_token(); // eat the final '}'
2789 string const name = "{\\ascii" + name2 + "}";
2793 // get the character from unicodesymbols
2794 docstring s = encodings.fromLaTeXCommand(from_utf8(name),
2795 Encodings::TEXT_CMD, termination, rem, &req);
2797 context.check_layout(os);
2800 output_ert_inset(os,
2801 to_utf8(rem), context);
2802 for (set<string>::const_iterator it = req.begin();
2803 it != req.end(); ++it)
2804 preamble.registerAutomaticallyLoadedPackage(*it);
2806 // we did not find a non-ert version
2807 output_ert_inset(os, name, context);
2809 context.check_layout(os);
2810 // special handling of font attribute changes
2811 Token const prev = p.prev_token();
2812 TeXFont const oldFont = context.font;
2813 if (next.character() == '[' ||
2814 next.character() == ']' ||
2815 next.character() == '*') {
2817 if (p.next_token().cat() == catEnd) {
2822 output_ert_inset(os, "{", context);
2823 parse_text_snippet(p, os,
2826 output_ert_inset(os, "}", context);
2828 } else if (! context.new_layout_allowed) {
2829 output_ert_inset(os, "{", context);
2830 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2832 output_ert_inset(os, "}", context);
2833 } else if (is_known(next.cs(), known_sizes)) {
2834 // next will change the size, so we must
2836 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2838 if (!context.atParagraphStart())
2840 << context.font.size << "\n";
2841 } else if (is_known(next.cs(), known_font_families)) {
2842 // next will change the font family, so we
2843 // must reset it here
2844 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2846 if (!context.atParagraphStart())
2848 << context.font.family << "\n";
2849 } else if (is_known(next.cs(), known_font_series)) {
2850 // next will change the font series, so we
2851 // must reset it here
2852 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2854 if (!context.atParagraphStart())
2856 << context.font.series << "\n";
2857 } else if (is_known(next.cs(), known_font_shapes)) {
2858 // next will change the font shape, so we
2859 // must reset it here
2860 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2862 if (!context.atParagraphStart())
2864 << context.font.shape << "\n";
2865 } else if (is_known(next.cs(), known_old_font_families) ||
2866 is_known(next.cs(), known_old_font_series) ||
2867 is_known(next.cs(), known_old_font_shapes)) {
2868 // next will change the font family, series
2869 // and shape, so we must reset it here
2870 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2872 if (!context.atParagraphStart())
2874 << context.font.family
2876 << context.font.series
2878 << context.font.shape << "\n";
2880 output_ert_inset(os, "{", context);
2881 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2883 output_ert_inset(os, "}", context);
2889 if (t.cat() == catEnd) {
2890 if (flags & FLAG_BRACE_LAST) {
2893 cerr << "stray '}' in text\n";
2894 output_ert_inset(os, "}", context);
2898 if (t.cat() == catComment) {
2899 parse_comment(p, os, t, context);
2904 // control sequences
2907 if (t.cs() == "(" || t.cs() == "[") {
2908 bool const simple = t.cs() == "(";
2909 context.check_layout(os);
2910 begin_inset(os, "Formula");
2911 os << " \\" << t.cs();
2912 parse_math(p, os, simple ? FLAG_SIMPLE2 : FLAG_EQUATION, MATH_MODE);
2913 os << '\\' << (simple ? ')' : ']');
2916 // Prevent the conversion of a line break to a
2917 // space (bug 7668). This does not change the
2918 // output, but looks ugly in LyX.
2919 eat_whitespace(p, os, context, false);
2924 if (t.cs() == "begin") {
2925 parse_environment(p, os, outer, last_env,
2930 if (t.cs() == "end") {
2931 if (flags & FLAG_END) {
2932 // eat environment name
2933 string const name = p.getArg('{', '}');
2934 if (name != active_environment())
2935 cerr << "\\end{" + name + "} does not match \\begin{"
2936 + active_environment() + "}\n";
2939 p.error("found 'end' unexpectedly");
2943 if (t.cs() == "item") {
2945 bool const optarg = p.hasOpt();
2947 // FIXME: This swallows comments, but we cannot use
2948 // eat_whitespace() since we must not output
2949 // anything before the item.
2950 p.skip_spaces(true);
2951 s = p.verbatimOption();
2953 p.skip_spaces(false);
2955 context.check_layout(os);
2956 if (context.has_item) {
2957 // An item in an unknown list-like environment
2958 // FIXME: Do this in check_layout()!
2959 context.has_item = false;
2961 output_ert_inset(os, "\\item", context);
2963 output_ert_inset(os, "\\item ", context);
2966 if (context.layout->labeltype != LABEL_MANUAL) {
2967 // handle option of itemize item
2968 begin_inset(os, "Argument item:1\n");
2969 os << "status open\n";
2970 os << "\n\\begin_layout Plain Layout\n";
2972 os << parse_text_snippet(p2,
2973 FLAG_BRACK_LAST, outer, context);
2974 // we must not use context.check_end_layout(os)
2975 // because that would close the outer itemize layout
2976 os << "\n\\end_layout\n";
2978 eat_whitespace(p, os, context, false);
2979 } else if (!s.empty()) {
2980 // LyX adds braces around the argument,
2981 // so we need to remove them here.
2982 if (s.size() > 2 && s[0] == '{' &&
2983 s[s.size()-1] == '}')
2984 s = s.substr(1, s.size()-2);
2985 // If the argument contains a space we
2986 // must put it into ERT: Otherwise LyX
2987 // would misinterpret the space as
2988 // item delimiter (bug 7663)
2989 if (contains(s, ' ')) {
2990 output_ert_inset(os, s, context);
2993 os << parse_text_snippet(p2,
2994 FLAG_BRACK_LAST, outer, context);
2996 // The space is needed to separate the
2997 // item from the rest of the sentence.
2999 eat_whitespace(p, os, context, false);
3005 if (t.cs() == "bibitem") {
3007 context.check_layout(os);
3008 eat_whitespace(p, os, context, false);
3009 string label = convert_command_inset_arg(p.verbatimOption());
3010 string key = convert_command_inset_arg(p.verbatim_item());
3011 if (contains(label, '\\') || contains(key, '\\')) {
3012 // LyX can't handle LaTeX commands in labels or keys
3013 output_ert_inset(os, t.asInput() + '[' + label +
3014 "]{" + p.verbatim_item() + '}',
3017 begin_command_inset(os, "bibitem", "bibitem");
3018 os << "label \"" << label << "\"\n"
3019 << "key \"" << key << "\"\n"
3020 << "literal \"true\"\n";
3027 // catch the case of \def\inputGnumericTable
3029 if (t.cs() == "def") {
3030 Token second = p.next_token();
3031 if (second.cs() == "inputGnumericTable") {
3035 Token third = p.get_token();
3037 if (third.cs() == "input") {
3041 string name = normalize_filename(p.verbatim_item());
3042 string const path = getMasterFilePath(true);
3043 // We want to preserve relative / absolute filenames,
3044 // therefore path is only used for testing
3045 // The file extension is in every case ".tex".
3046 // So we need to remove this extension and check for
3047 // the original one.
3048 name = removeExtension(name);
3049 if (!makeAbsPath(name, path).exists()) {
3050 char const * const Gnumeric_formats[] = {"gnumeric",
3052 string const Gnumeric_name =
3053 find_file(name, path, Gnumeric_formats);
3054 if (!Gnumeric_name.empty())
3055 name = Gnumeric_name;
3057 FileName const absname = makeAbsPath(name, path);
3058 if (absname.exists()) {
3059 fix_child_filename(name);
3060 copy_file(absname, name);
3062 cerr << "Warning: Could not find file '"
3063 << name << "'." << endl;
3064 context.check_layout(os);
3065 begin_inset(os, "External\n\ttemplate ");
3066 os << "GnumericSpreadsheet\n\tfilename "
3069 context.check_layout(os);
3071 // register the packages that are automatically loaded
3072 // by the Gnumeric template
3073 registerExternalTemplatePackages("GnumericSpreadsheet");
3078 parse_macro(p, os, context);
3082 if (t.cs() == "noindent") {
3084 context.add_par_extra_stuff("\\noindent\n");
3088 if (t.cs() == "appendix") {
3089 context.add_par_extra_stuff("\\start_of_appendix\n");
3090 // We need to start a new paragraph. Otherwise the
3091 // appendix in 'bla\appendix\chapter{' would start
3093 context.new_paragraph(os);
3094 // We need to make sure that the paragraph is
3095 // generated even if it is empty. Otherwise the
3096 // appendix in '\par\appendix\par\chapter{' would
3098 context.check_layout(os);
3099 // FIXME: This is a hack to prevent paragraph
3100 // deletion if it is empty. Handle this better!
3101 output_comment(p, os,
3102 "dummy comment inserted by tex2lyx to "
3103 "ensure that this paragraph is not empty",
3105 // Both measures above may generate an additional
3106 // empty paragraph, but that does not hurt, because
3107 // whitespace does not matter here.
3108 eat_whitespace(p, os, context, true);
3112 // Must catch empty dates before findLayout is called below
3113 if (t.cs() == "date") {
3114 eat_whitespace(p, os, context, false);
3116 string const date = p.verbatim_item();
3119 preamble.suppressDate(true);
3122 preamble.suppressDate(false);
3123 if (context.new_layout_allowed &&
3124 (newlayout = findLayout(context.textclass,
3127 output_command_layout(os, p, outer,
3128 context, newlayout);
3129 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3130 if (!preamble.titleLayoutFound())
3131 preamble.titleLayoutFound(newlayout->intitle);
3132 set<string> const & req = newlayout->requires();
3133 set<string>::const_iterator it = req.begin();
3134 set<string>::const_iterator en = req.end();
3135 for (; it != en; ++it)
3136 preamble.registerAutomaticallyLoadedPackage(*it);
3138 output_ert_inset(os,
3139 "\\date{" + p.verbatim_item() + '}',
3145 // Starred section headings
3146 // Must attempt to parse "Section*" before "Section".
3147 if ((p.next_token().asInput() == "*") &&
3148 context.new_layout_allowed &&
3149 (newlayout = findLayout(context.textclass, t.cs() + '*', true))) {
3152 output_command_layout(os, p, outer, context, newlayout);
3154 if (!preamble.titleLayoutFound())
3155 preamble.titleLayoutFound(newlayout->intitle);
3156 set<string> const & req = newlayout->requires();
3157 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3158 preamble.registerAutomaticallyLoadedPackage(*it);
3162 // Section headings and the like
3163 if (context.new_layout_allowed &&
3164 (newlayout = findLayout(context.textclass, t.cs(), true))) {
3166 output_command_layout(os, p, outer, context, newlayout);
3168 if (!preamble.titleLayoutFound())
3169 preamble.titleLayoutFound(newlayout->intitle);
3170 set<string> const & req = newlayout->requires();
3171 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3172 preamble.registerAutomaticallyLoadedPackage(*it);
3176 if (t.cs() == "subfloat") {
3177 // the syntax is \subfloat[list entry][sub caption]{content}
3178 // if it is a table of figure depends on the surrounding float
3180 // do nothing if there is no outer float
3181 if (!float_type.empty()) {
3182 context.check_layout(os);
3184 begin_inset(os, "Float " + float_type + "\n");
3186 << "\nsideways false"
3187 << "\nstatus collapsed\n\n";
3190 bool has_caption = false;
3191 if (p.next_token().cat() != catEscape &&
3192 p.next_token().character() == '[') {
3193 p.get_token(); // eat '['
3194 caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
3197 // In case we have two optional args, the second is the caption.
3198 if (p.next_token().cat() != catEscape &&
3199 p.next_token().character() == '[') {
3200 p.get_token(); // eat '['
3201 caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
3204 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3205 // the caption comes always as the last
3207 // we must make sure that the caption gets a \begin_layout
3208 os << "\n\\begin_layout Plain Layout";
3210 begin_inset(os, "Caption Standard\n");
3211 Context newcontext(true, context.textclass,
3212 0, 0, context.font);
3213 newcontext.check_layout(os);
3214 os << caption << "\n";
3215 newcontext.check_end_layout(os);
3218 // close the layout we opened
3219 os << "\n\\end_layout";
3224 // if the float type is not supported or there is no surrounding float
3229 opt_arg1 = convert_command_inset_arg(p.getFullOpt());
3231 opt_arg2 = convert_command_inset_arg(p.getFullOpt());
3233 output_ert_inset(os, t.asInput() + opt_arg1 + opt_arg2
3234 + "{" + p.verbatim_item() + '}', context);
3239 if (t.cs() == "includegraphics") {
3240 bool const clip = p.next_token().asInput() == "*";
3243 string const arg = p.getArg('[', ']');
3244 map<string, string> opts;
3245 vector<string> keys;
3246 split_map(arg, opts, keys);
3248 opts["clip"] = string();
3249 string name = normalize_filename(p.verbatim_item());
3251 string const path = getMasterFilePath(true);
3252 // We want to preserve relative / absolute filenames,
3253 // therefore path is only used for testing
3254 if (!makeAbsPath(name, path).exists()) {
3255 // The file extension is probably missing.
3256 // Now try to find it out.
3257 string const dvips_name =
3258 find_file(name, path,
3259 known_dvips_graphics_formats);
3260 string const pdftex_name =
3261 find_file(name, path,
3262 known_pdftex_graphics_formats);
3263 if (!dvips_name.empty()) {
3264 if (!pdftex_name.empty()) {
3265 cerr << "This file contains the "
3267 "\"\\includegraphics{"
3269 "However, files\n\""
3270 << dvips_name << "\" and\n\""
3271 << pdftex_name << "\"\n"
3272 "both exist, so I had to make a "
3273 "choice and took the first one.\n"
3274 "Please move the unwanted one "
3275 "someplace else and try again\n"
3276 "if my choice was wrong."
3280 } else if (!pdftex_name.empty()) {
3286 FileName const absname = makeAbsPath(name, path);
3287 if (absname.exists()) {
3288 fix_child_filename(name);
3289 copy_file(absname, name);
3291 cerr << "Warning: Could not find graphics file '"
3292 << name << "'." << endl;
3294 context.check_layout(os);
3295 begin_inset(os, "Graphics ");
3296 os << "\n\tfilename " << name << '\n';
3297 if (opts.find("width") != opts.end())
3299 << translate_len(opts["width"]) << '\n';
3300 if (opts.find("height") != opts.end())
3302 << translate_len(opts["height"]) << '\n';
3303 if (opts.find("scale") != opts.end()) {
3304 istringstream iss(opts["scale"]);
3308 os << "\tscale " << val << '\n';
3310 if (opts.find("angle") != opts.end()) {
3311 os << "\trotateAngle "
3312 << opts["angle"] << '\n';
3313 vector<string>::const_iterator a =
3314 find(keys.begin(), keys.end(), "angle");
3315 vector<string>::const_iterator s =
3316 find(keys.begin(), keys.end(), "width");
3317 if (s == keys.end())
3318 s = find(keys.begin(), keys.end(), "height");
3319 if (s == keys.end())
3320 s = find(keys.begin(), keys.end(), "scale");
3321 if (s != keys.end() && distance(s, a) > 0)
3322 os << "\tscaleBeforeRotation\n";
3324 if (opts.find("origin") != opts.end()) {
3326 string const opt = opts["origin"];
3327 if (opt.find('l') != string::npos) ss << "left";
3328 if (opt.find('r') != string::npos) ss << "right";
3329 if (opt.find('c') != string::npos) ss << "center";
3330 if (opt.find('t') != string::npos) ss << "Top";
3331 if (opt.find('b') != string::npos) ss << "Bottom";
3332 if (opt.find('B') != string::npos) ss << "Baseline";
3333 if (!ss.str().empty())
3334 os << "\trotateOrigin " << ss.str() << '\n';
3336 cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
3338 if (opts.find("keepaspectratio") != opts.end())
3339 os << "\tkeepAspectRatio\n";
3340 if (opts.find("clip") != opts.end())
3342 if (opts.find("draft") != opts.end())
3344 if (opts.find("bb") != opts.end())
3345 os << "\tBoundingBox "
3346 << opts["bb"] << '\n';
3347 int numberOfbbOptions = 0;
3348 if (opts.find("bbllx") != opts.end())
3349 numberOfbbOptions++;
3350 if (opts.find("bblly") != opts.end())
3351 numberOfbbOptions++;
3352 if (opts.find("bburx") != opts.end())
3353 numberOfbbOptions++;
3354 if (opts.find("bbury") != opts.end())
3355 numberOfbbOptions++;
3356 if (numberOfbbOptions == 4)
3357 os << "\tBoundingBox "
3358 << opts["bbllx"] << " " << opts["bblly"] << " "
3359 << opts["bburx"] << " " << opts["bbury"] << '\n';
3360 else if (numberOfbbOptions > 0)
3361 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
3362 numberOfbbOptions = 0;
3363 if (opts.find("natwidth") != opts.end())
3364 numberOfbbOptions++;
3365 if (opts.find("natheight") != opts.end())
3366 numberOfbbOptions++;
3367 if (numberOfbbOptions == 2)
3368 os << "\tBoundingBox 0bp 0bp "
3369 << opts["natwidth"] << " " << opts["natheight"] << '\n';
3370 else if (numberOfbbOptions > 0)
3371 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
3372 ostringstream special;
3373 if (opts.find("hiresbb") != opts.end())
3374 special << "hiresbb,";
3375 if (opts.find("trim") != opts.end())
3377 if (opts.find("viewport") != opts.end())
3378 special << "viewport=" << opts["viewport"] << ',';
3379 if (opts.find("totalheight") != opts.end())
3380 special << "totalheight=" << opts["totalheight"] << ',';
3381 if (opts.find("type") != opts.end())
3382 special << "type=" << opts["type"] << ',';
3383 if (opts.find("ext") != opts.end())
3384 special << "ext=" << opts["ext"] << ',';
3385 if (opts.find("read") != opts.end())
3386 special << "read=" << opts["read"] << ',';
3387 if (opts.find("command") != opts.end())
3388 special << "command=" << opts["command"] << ',';
3389 string s_special = special.str();
3390 if (!s_special.empty()) {
3391 // We had special arguments. Remove the trailing ','.
3392 os << "\tspecial " << s_special.substr(0, s_special.size() - 1) << '\n';
3394 // TODO: Handle the unknown settings better.
3395 // Warn about invalid options.
3396 // Check whether some option was given twice.
3398 preamble.registerAutomaticallyLoadedPackage("graphicx");
3402 if (t.cs() == "footnote" ||
3403 (t.cs() == "thanks" && context.layout->intitle)) {
3405 context.check_layout(os);
3406 begin_inset(os, "Foot\n");
3407 os << "status collapsed\n\n";
3408 parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3413 if (t.cs() == "marginpar") {
3415 context.check_layout(os);
3416 begin_inset(os, "Marginal\n");
3417 os << "status collapsed\n\n";
3418 parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3423 if (t.cs() == "lstinline" || t.cs() == "mintinline") {
3424 bool const use_minted = t.cs() == "mintinline";
3426 parse_listings(p, os, context, true, use_minted);
3430 if (t.cs() == "ensuremath") {
3432 context.check_layout(os);
3433 string const s = p.verbatim_item();
3434 //FIXME: this never triggers in UTF8
3435 if (s == "\xb1" || s == "\xb3" || s == "\xb2" || s == "\xb5")
3438 output_ert_inset(os, "\\ensuremath{" + s + "}",
3443 else if (t.cs() == "makeindex" || t.cs() == "maketitle") {
3444 if (preamble.titleLayoutFound()) {
3446 skip_spaces_braces(p);
3448 output_ert_inset(os, t.asInput(), context);
3452 if (t.cs() == "tableofcontents"
3453 || t.cs() == "lstlistoflistings"
3454 || t.cs() == "listoflistings") {
3455 string name = t.cs();
3456 if (preamble.minted() && name == "listoflistings")
3457 name.insert(0, "lst");
3458 context.check_layout(os);
3459 begin_command_inset(os, "toc", name);
3461 skip_spaces_braces(p);
3462 if (name == "lstlistoflistings") {
3463 if (preamble.minted())
3464 preamble.registerAutomaticallyLoadedPackage("minted");
3466 preamble.registerAutomaticallyLoadedPackage("listings");
3471 if (t.cs() == "listoffigures" || t.cs() == "listoftables") {
3472 context.check_layout(os);
3473 if (t.cs() == "listoffigures")
3474 begin_inset(os, "FloatList figure\n");
3476 begin_inset(os, "FloatList table\n");
3478 skip_spaces_braces(p);
3482 if (t.cs() == "listof") {
3483 p.skip_spaces(true);
3484 string const name = p.get_token().cs();
3485 if (context.textclass.floats().typeExist(name)) {
3486 context.check_layout(os);
3487 begin_inset(os, "FloatList ");
3490 p.get_token(); // swallow second arg
3492 output_ert_inset(os, "\\listof{" + name + "}", context);
3496 if ((where = is_known(t.cs(), known_text_font_families))) {
3497 parse_text_attributes(p, os, FLAG_ITEM, outer,
3498 context, "\\family", context.font.family,
3499 known_coded_font_families[where - known_text_font_families]);
3503 if ((where = is_known(t.cs(), known_text_font_series))) {
3504 parse_text_attributes(p, os, FLAG_ITEM, outer,
3505 context, "\\series", context.font.series,
3506 known_coded_font_series[where - known_text_font_series]);
3510 if ((where = is_known(t.cs(), known_text_font_shapes))) {
3511 parse_text_attributes(p, os, FLAG_ITEM, outer,
3512 context, "\\shape", context.font.shape,
3513 known_coded_font_shapes[where - known_text_font_shapes]);
3517 if (t.cs() == "textnormal" || t.cs() == "normalfont") {
3518 context.check_layout(os);
3519 TeXFont oldFont = context.font;
3520 context.font.init();
3521 context.font.size = oldFont.size;
3522 os << "\n\\family " << context.font.family << "\n";
3523 os << "\n\\series " << context.font.series << "\n";
3524 os << "\n\\shape " << context.font.shape << "\n";
3525 if (t.cs() == "textnormal") {
3526 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3527 output_font_change(os, context.font, oldFont);
3528 context.font = oldFont;
3530 eat_whitespace(p, os, context, false);
3534 if (t.cs() == "textcolor") {
3535 // scheme is \textcolor{color name}{text}
3536 string const color = p.verbatim_item();
3537 // we support the predefined colors of the color and the xcolor package
3538 if (color == "black" || color == "blue" || color == "cyan"
3539 || color == "green" || color == "magenta" || color == "red"
3540 || color == "white" || color == "yellow") {
3541 context.check_layout(os);
3542 os << "\n\\color " << color << "\n";
3543 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3544 context.check_layout(os);
3545 os << "\n\\color inherit\n";
3546 preamble.registerAutomaticallyLoadedPackage("color");
3547 } else if (color == "brown" || color == "darkgray" || color == "gray"
3548 || color == "lightgray" || color == "lime" || color == "olive"
3549 || color == "orange" || color == "pink" || color == "purple"
3550 || color == "teal" || color == "violet") {
3551 context.check_layout(os);
3552 os << "\n\\color " << color << "\n";
3553 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3554 context.check_layout(os);
3555 os << "\n\\color inherit\n";
3556 preamble.registerAutomaticallyLoadedPackage("xcolor");
3558 // for custom defined colors
3559 output_ert_inset(os, t.asInput() + "{" + color + "}", context);
3563 if (t.cs() == "underbar" || t.cs() == "uline") {
3564 // \underbar is not 100% correct (LyX outputs \uline
3565 // of ulem.sty). The difference is that \ulem allows
3566 // line breaks, and \underbar does not.
3567 // Do NOT handle \underline.
3568 // \underbar cuts through y, g, q, p etc.,
3569 // \underline does not.
3570 context.check_layout(os);
3571 os << "\n\\bar under\n";
3572 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3573 context.check_layout(os);
3574 os << "\n\\bar default\n";
3575 preamble.registerAutomaticallyLoadedPackage("ulem");
3579 if (t.cs() == "sout") {
3580 context.check_layout(os);
3581 os << "\n\\strikeout on\n";
3582 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3583 context.check_layout(os);
3584 os << "\n\\strikeout default\n";
3585 preamble.registerAutomaticallyLoadedPackage("ulem");
3589 if (t.cs() == "uuline" || t.cs() == "uwave"
3590 || t.cs() == "emph" || t.cs() == "noun"
3591 || t.cs() == "xout") {
3592 context.check_layout(os);
3593 os << "\n\\" << t.cs() << " on\n";
3594 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3595 context.check_layout(os);
3596 os << "\n\\" << t.cs() << " default\n";
3597 if (t.cs() == "uuline" || t.cs() == "uwave" || t.cs() == "xout")
3598 preamble.registerAutomaticallyLoadedPackage("ulem");
3602 if (t.cs() == "lyxadded" || t.cs() == "lyxdeleted") {
3603 context.check_layout(os);
3604 string name = p.getArg('{', '}');
3605 string localtime = p.getArg('{', '}');
3606 preamble.registerAuthor(name);
3607 Author const & author = preamble.getAuthor(name);
3608 // from_asctime_utc() will fail if LyX decides to output the
3609 // time in the text language.
3610 time_t ptime = from_asctime_utc(localtime);
3611 if (ptime == static_cast<time_t>(-1)) {
3612 cerr << "Warning: Could not parse time `" << localtime
3613 << "´ for change tracking, using current time instead.\n";
3614 ptime = current_time();
3616 if (t.cs() == "lyxadded")
3617 os << "\n\\change_inserted ";
3619 os << "\n\\change_deleted ";
3620 os << author.bufferId() << ' ' << ptime << '\n';
3621 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3622 bool dvipost = LaTeXPackages::isAvailable("dvipost");
3623 bool xcolorulem = LaTeXPackages::isAvailable("ulem") &&
3624 LaTeXPackages::isAvailable("xcolor");
3625 // No need to test for luatex, since luatex comes in
3626 // two flavours (dvi and pdf), like latex, and those
3627 // are detected by pdflatex.
3628 if (pdflatex || xetex) {
3630 preamble.registerAutomaticallyLoadedPackage("ulem");
3631 preamble.registerAutomaticallyLoadedPackage("xcolor");
3632 preamble.registerAutomaticallyLoadedPackage("pdfcolmk");
3636 preamble.registerAutomaticallyLoadedPackage("dvipost");
3637 } else if (xcolorulem) {
3638 preamble.registerAutomaticallyLoadedPackage("ulem");
3639 preamble.registerAutomaticallyLoadedPackage("xcolor");
3645 if (t.cs() == "textipa") {
3646 context.check_layout(os);
3647 begin_inset(os, "IPA\n");
3648 bool merging_hyphens_allowed = context.merging_hyphens_allowed;
3649 context.merging_hyphens_allowed = false;
3650 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3651 context.merging_hyphens_allowed = merging_hyphens_allowed;
3653 preamble.registerAutomaticallyLoadedPackage("tipa");
3654 preamble.registerAutomaticallyLoadedPackage("tipx");
3658 if (t.cs() == "texttoptiebar" || t.cs() == "textbottomtiebar") {
3659 context.check_layout(os);
3660 begin_inset(os, "IPADeco " + t.cs().substr(4) + "\n");
3661 os << "status open\n";
3662 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3668 if (t.cs() == "textvertline") {
3669 // FIXME: This is not correct, \textvertline is higher than |
3675 if (t.cs() == "tone" ) {
3676 context.check_layout(os);
3677 // register the tone package
3678 preamble.registerAutomaticallyLoadedPackage("tone");
3679 string content = trimSpaceAndEol(p.verbatim_item());
3680 string command = t.asInput() + "{" + content + "}";
3681 // some tones can be detected by unicodesymbols, some need special code
3682 if (is_known(content, known_tones)) {
3683 os << "\\IPAChar " << command << "\n";
3686 // try to see whether the string is in unicodesymbols
3690 docstring s = encodings.fromLaTeXCommand(from_utf8(command),
3691 Encodings::TEXT_CMD | Encodings::MATH_CMD,
3692 termination, rem, &req);
3696 output_ert_inset(os, to_utf8(rem), context);
3697 for (set<string>::const_iterator it = req.begin();
3698 it != req.end(); ++it)
3699 preamble.registerAutomaticallyLoadedPackage(*it);
3701 // we did not find a non-ert version
3702 output_ert_inset(os, command, context);
3706 if (t.cs() == "phantom" || t.cs() == "hphantom" ||
3707 t.cs() == "vphantom") {
3708 context.check_layout(os);
3709 if (t.cs() == "phantom")
3710 begin_inset(os, "Phantom Phantom\n");
3711 if (t.cs() == "hphantom")
3712 begin_inset(os, "Phantom HPhantom\n");
3713 if (t.cs() == "vphantom")
3714 begin_inset(os, "Phantom VPhantom\n");
3715 os << "status open\n";
3716 parse_text_in_inset(p, os, FLAG_ITEM, outer, context,
3722 if (t.cs() == "href") {
3723 context.check_layout(os);
3724 string target = convert_command_inset_arg(p.verbatim_item());
3725 string name = convert_command_inset_arg(p.verbatim_item());
3727 size_t i = target.find(':');
3728 if (i != string::npos) {
3729 type = target.substr(0, i + 1);
3730 if (type == "mailto:" || type == "file:")
3731 target = target.substr(i + 1);
3732 // handle the case that name is equal to target, except of "http(s)://"
3733 else if (target.substr(i + 3) == name && (type == "http:" || type == "https:"))
3736 begin_command_inset(os, "href", "href");
3738 os << "name \"" << name << "\"\n";
3739 os << "target \"" << target << "\"\n";
3740 if (type == "mailto:" || type == "file:")
3741 os << "type \"" << type << "\"\n";
3742 os << "literal \"true\"\n";
3744 skip_spaces_braces(p);
3748 if (t.cs() == "lyxline") {
3749 // swallow size argument (it is not used anyway)
3751 if (!context.atParagraphStart()) {
3752 // so our line is in the middle of a paragraph
3753 // we need to add a new line, lest this line
3754 // follow the other content on that line and
3755 // run off the side of the page
3756 // FIXME: This may create an empty paragraph,
3757 // but without that it would not be
3758 // possible to set noindent below.
3759 // Fortunately LaTeX does not care
3760 // about the empty paragraph.
3761 context.new_paragraph(os);
3763 if (preamble.indentParagraphs()) {
3764 // we need to unindent, lest the line be too long
3765 context.add_par_extra_stuff("\\noindent\n");
3767 context.check_layout(os);
3768 begin_command_inset(os, "line", "rule");
3769 os << "offset \"0.5ex\"\n"
3770 "width \"100line%\"\n"
3776 if (t.cs() == "rule") {
3777 string const offset = (p.hasOpt() ? p.getArg('[', ']') : string());
3778 string const width = p.getArg('{', '}');
3779 string const thickness = p.getArg('{', '}');
3780 context.check_layout(os);
3781 begin_command_inset(os, "line", "rule");
3782 if (!offset.empty())
3783 os << "offset \"" << translate_len(offset) << "\"\n";
3784 os << "width \"" << translate_len(width) << "\"\n"
3785 "height \"" << translate_len(thickness) << "\"\n";
3790 // handle refstyle first to catch \eqref which can also occur
3791 // without refstyle. Only recognize these commands if
3792 // refstyle.sty was found in the preamble (otherwise \eqref
3793 // and user defined ref commands could be misdetected).
3794 if ((where = is_known(t.cs(), known_refstyle_commands))
3795 && preamble.refstyle()) {
3796 context.check_layout(os);
3797 begin_command_inset(os, "ref", "formatted");
3798 os << "reference \"";
3799 os << known_refstyle_prefixes[where - known_refstyle_commands]
3801 os << convert_command_inset_arg(p.verbatim_item())
3803 os << "plural \"false\"\n";
3804 os << "caps \"false\"\n";
3805 os << "noprefix \"false\"\n";
3807 preamble.registerAutomaticallyLoadedPackage("refstyle");
3811 // if refstyle is used, we must not convert \prettyref to a
3812 // formatted reference, since that would result in a refstyle command.
3813 if ((where = is_known(t.cs(), known_ref_commands)) &&
3814 (t.cs() != "prettyref" || !preamble.refstyle())) {
3815 string const opt = p.getOpt();
3817 context.check_layout(os);
3818 begin_command_inset(os, "ref",
3819 known_coded_ref_commands[where - known_ref_commands]);
3820 os << "reference \""
3821 << convert_command_inset_arg(p.verbatim_item())
3823 os << "plural \"false\"\n";
3824 os << "caps \"false\"\n";
3825 os << "noprefix \"false\"\n";
3827 if (t.cs() == "vref" || t.cs() == "vpageref")
3828 preamble.registerAutomaticallyLoadedPackage("varioref");
3829 else if (t.cs() == "prettyref")
3830 preamble.registerAutomaticallyLoadedPackage("prettyref");
3832 // LyX does not yet support optional arguments of ref commands
3833 output_ert_inset(os, t.asInput() + '[' + opt + "]{" +
3834 p.verbatim_item() + '}', context);
3840 is_known(t.cs(), known_natbib_commands) &&
3841 ((t.cs() != "citefullauthor" &&
3842 t.cs() != "citeyear" &&
3843 t.cs() != "citeyearpar") ||
3844 p.next_token().asInput() != "*")) {
3845 context.check_layout(os);
3846 string command = t.cs();
3847 if (p.next_token().asInput() == "*") {
3851 if (command == "citefullauthor")
3852 // alternative name for "\\citeauthor*"
3853 command = "citeauthor*";
3855 // text before the citation
3857 // text after the citation
3859 get_cite_arguments(p, true, before, after);
3861 if (command == "cite") {
3862 // \cite without optional argument means
3863 // \citet, \cite with at least one optional
3864 // argument means \citep.
3865 if (before.empty() && after.empty())
3870 if (before.empty() && after == "[]")
3871 // avoid \citet[]{a}
3873 else if (before == "[]" && after == "[]") {
3874 // avoid \citet[][]{a}
3878 // remove the brackets around after and before
3879 if (!after.empty()) {
3881 after.erase(after.length() - 1, 1);
3882 after = convert_command_inset_arg(after);
3884 if (!before.empty()) {
3886 before.erase(before.length() - 1, 1);
3887 before = convert_command_inset_arg(before);
3889 begin_command_inset(os, "citation", command);
3890 os << "after " << '"' << after << '"' << "\n";
3891 os << "before " << '"' << before << '"' << "\n";
3893 << convert_command_inset_arg(p.verbatim_item())
3895 << "literal \"true\"\n";
3897 // Need to set the cite engine if natbib is loaded by
3898 // the document class directly
3899 if (preamble.citeEngine() == "basic")
3900 preamble.citeEngine("natbib");
3905 && is_known(t.cs(), known_biblatex_commands)
3906 && ((t.cs() == "cite"
3907 || t.cs() == "citeauthor"
3908 || t.cs() == "Citeauthor"
3909 || t.cs() == "parencite"
3910 || t.cs() == "citetitle")
3911 || p.next_token().asInput() != "*"))
3912 || (use_biblatex_natbib
3913 && (is_known(t.cs(), known_biblatex_commands)
3914 || is_known(t.cs(), known_natbib_commands))
3915 && ((t.cs() == "cite" || t.cs() == "citet" || t.cs() == "Citet"
3916 || t.cs() == "citep" || t.cs() == "Citep" || t.cs() == "citealt"
3917 || t.cs() == "Citealt" || t.cs() == "citealp" || t.cs() == "Citealp"
3918 || t.cs() == "citeauthor" || t.cs() == "Citeauthor"
3919 || t.cs() == "parencite" || t.cs() == "citetitle")
3920 || p.next_token().asInput() != "*"))){
3921 context.check_layout(os);
3922 string command = t.cs();
3923 if (p.next_token().asInput() == "*") {
3928 bool const qualified = suffixIs(command, "s");
3930 command = rtrim(command, "s");
3932 // text before the citation
3934 // text after the citation
3936 get_cite_arguments(p, true, before, after, qualified);
3938 // These use natbib cmd names in LyX
3939 // for inter-citeengine compativility
3940 if (command == "citeyear")
3941 command = "citebyear";
3942 else if (command == "cite*")
3943 command = "citeyear";
3944 else if (command == "textcite")
3946 else if (command == "Textcite")
3948 else if (command == "parencite")
3950 else if (command == "Parencite")
3952 else if (command == "parencite*")
3953 command = "citeyearpar";
3954 else if (command == "smartcite")
3955 command = "footcite";
3956 else if (command == "Smartcite")
3957 command = "Footcite";
3959 string const emptyarg = qualified ? "()" : "[]";
3960 if (before.empty() && after == emptyarg)
3963 else if (before == emptyarg && after == emptyarg) {
3964 // avoid \cite[][]{a}
3968 // remove the brackets around after and before
3969 if (!after.empty()) {
3971 after.erase(after.length() - 1, 1);
3972 after = convert_command_inset_arg(after);
3974 if (!before.empty()) {
3976 before.erase(before.length() - 1, 1);
3977 before = convert_command_inset_arg(before);
3979 string keys, pretextlist, posttextlist;
3981 map<string, string> pres;
3982 map<string, string> posts;
3983 vector<string> lkeys;
3984 // text before the citation
3986 // text after the citation
3990 get_cite_arguments(p, true, lbefore, lafter);
3991 // remove the brackets around after and before
3992 if (!lafter.empty()) {
3994 lafter.erase(lafter.length() - 1, 1);
3995 lafter = convert_command_inset_arg(lafter);
3997 if (!lbefore.empty()) {
3998 lbefore.erase(0, 1);
3999 lbefore.erase(lbefore.length() - 1, 1);
4000 lbefore = convert_command_inset_arg(lbefore);
4002 if (lbefore.empty() && lafter == "[]")
4005 else if (lbefore == "[]" && lafter == "[]") {
4006 // avoid \cite[][]{a}
4010 lkey = p.getArg('{', '}');
4013 if (!lbefore.empty())
4014 pres.insert(make_pair(lkey, lbefore));
4015 if (!lafter.empty())
4016 posts.insert(make_pair(lkey, lafter));
4017 lkeys.push_back(lkey);
4019 keys = convert_command_inset_arg(getStringFromVector(lkeys));
4020 for (auto const & ptl : pres) {
4021 if (!pretextlist.empty())
4022 pretextlist += '\t';
4023 pretextlist += ptl.first + " " + ptl.second;
4025 for (auto const & potl : posts) {
4026 if (!posttextlist.empty())
4027 posttextlist += '\t';
4028 posttextlist += potl.first + " " + potl.second;
4031 keys = convert_command_inset_arg(p.verbatim_item());
4032 begin_command_inset(os, "citation", command);
4033 os << "after " << '"' << after << '"' << "\n";
4034 os << "before " << '"' << before << '"' << "\n";
4038 if (!pretextlist.empty())
4039 os << "pretextlist " << '"' << pretextlist << '"' << "\n";
4040 if (!posttextlist.empty())
4041 os << "posttextlist " << '"' << posttextlist << '"' << "\n";
4042 os << "literal \"true\"\n";
4044 // Need to set the cite engine if biblatex is loaded by
4045 // the document class directly
4046 if (preamble.citeEngine() == "basic")
4047 use_biblatex_natbib ?
4048 preamble.citeEngine("biblatex-natbib")
4049 : preamble.citeEngine("biblatex");
4054 is_known(t.cs(), known_jurabib_commands) &&
4055 (t.cs() == "cite" || p.next_token().asInput() != "*")) {
4056 context.check_layout(os);
4057 string command = t.cs();
4058 if (p.next_token().asInput() == "*") {
4062 char argumentOrder = '\0';
4063 vector<string> const options =
4064 preamble.getPackageOptions("jurabib");
4065 if (find(options.begin(), options.end(),
4066 "natbiborder") != options.end())
4067 argumentOrder = 'n';
4068 else if (find(options.begin(), options.end(),
4069 "jurabiborder") != options.end())
4070 argumentOrder = 'j';
4072 // text before the citation
4074 // text after the citation
4076 get_cite_arguments(p, argumentOrder != 'j', before, after);
4078 string const citation = p.verbatim_item();
4079 if (!before.empty() && argumentOrder == '\0') {
4080 cerr << "Warning: Assuming argument order "
4081 "of jurabib version 0.6 for\n'"
4082 << command << before << after << '{'
4083 << citation << "}'.\n"
4084 "Add 'jurabiborder' to the jurabib "
4085 "package options if you used an\n"
4086 "earlier jurabib version." << endl;
4088 if (!after.empty()) {
4090 after.erase(after.length() - 1, 1);
4092 if (!before.empty()) {
4094 before.erase(before.length() - 1, 1);
4096 begin_command_inset(os, "citation", command);
4097 os << "after " << '"' << after << "\"\n"
4098 << "before " << '"' << before << "\"\n"
4099 << "key " << '"' << citation << "\"\n"
4100 << "literal \"true\"\n";
4102 // Need to set the cite engine if jurabib is loaded by
4103 // the document class directly
4104 if (preamble.citeEngine() == "basic")
4105 preamble.citeEngine("jurabib");
4109 if (t.cs() == "cite"
4110 || t.cs() == "nocite") {
4111 context.check_layout(os);
4112 string after = convert_command_inset_arg(p.getArg('[', ']'));
4113 string key = convert_command_inset_arg(p.verbatim_item());
4114 // store the case that it is "\nocite{*}" to use it later for
4117 begin_command_inset(os, "citation", t.cs());
4118 os << "after " << '"' << after << "\"\n"
4119 << "key " << '"' << key << "\"\n"
4120 << "literal \"true\"\n";
4122 } else if (t.cs() == "nocite")
4127 if (t.cs() == "index" ||
4128 (t.cs() == "sindex" && preamble.use_indices() == "true")) {
4129 context.check_layout(os);
4130 string const arg = (t.cs() == "sindex" && p.hasOpt()) ?
4131 p.getArg('[', ']') : "";
4132 string const kind = arg.empty() ? "idx" : arg;
4133 begin_inset(os, "Index ");
4134 os << kind << "\nstatus collapsed\n";
4135 parse_text_in_inset(p, os, FLAG_ITEM, false, context, "Index");
4138 preamble.registerAutomaticallyLoadedPackage("splitidx");
4142 if (t.cs() == "nomenclature") {
4143 context.check_layout(os);
4144 begin_command_inset(os, "nomenclature", "nomenclature");
4145 string prefix = convert_command_inset_arg(p.getArg('[', ']'));
4146 if (!prefix.empty())
4147 os << "prefix " << '"' << prefix << '"' << "\n";
4148 os << "symbol " << '"'
4149 << convert_command_inset_arg(p.verbatim_item());
4150 os << "\"\ndescription \""
4151 << convert_command_inset_arg(p.verbatim_item())
4153 << "literal \"true\"\n";
4155 preamble.registerAutomaticallyLoadedPackage("nomencl");
4159 if (t.cs() == "label") {
4160 context.check_layout(os);
4161 begin_command_inset(os, "label", "label");
4163 << convert_command_inset_arg(p.verbatim_item())
4169 if (t.cs() == "lyxmintcaption") {
4170 string const pos = p.getArg('[', ']');
4172 string const caption =
4173 parse_text_snippet(p, FLAG_ITEM, false,
4175 minted_nonfloat_caption = "[t]" + caption;
4177 // We already got the caption at the bottom,
4178 // so simply skip it.
4179 parse_text_snippet(p, FLAG_ITEM, false, context);
4184 if (t.cs() == "printindex" || t.cs() == "printsubindex") {
4185 context.check_layout(os);
4186 string commandname = t.cs();
4188 if (p.next_token().asInput() == "*") {
4193 begin_command_inset(os, "index_print", commandname);
4194 string const indexname = p.getArg('[', ']');
4196 if (indexname.empty())
4197 os << "type \"idx\"\n";
4199 os << "type \"" << indexname << "\"\n";
4200 os << "literal \"true\"\n";
4203 skip_spaces_braces(p);
4204 preamble.registerAutomaticallyLoadedPackage("makeidx");
4205 if (preamble.use_indices() == "true")
4206 preamble.registerAutomaticallyLoadedPackage("splitidx");
4210 if (t.cs() == "printnomenclature") {
4212 string width_type = "";
4213 context.check_layout(os);
4214 begin_command_inset(os, "nomencl_print", "printnomenclature");
4215 // case of a custom width
4217 width = p.getArg('[', ']');
4218 width = translate_len(width);
4219 width_type = "custom";
4221 // case of no custom width
4222 // the case of no custom width but the width set
4223 // via \settowidth{\nomlabelwidth}{***} cannot be supported
4224 // because the user could have set anything, not only the width
4225 // of the longest label (which would be width_type = "auto")
4226 string label = convert_command_inset_arg(p.getArg('{', '}'));
4227 if (label.empty() && width_type.empty())
4228 width_type = "none";
4229 os << "set_width \"" << width_type << "\"\n";
4230 if (width_type == "custom")
4231 os << "width \"" << width << '\"';
4233 skip_spaces_braces(p);
4234 preamble.registerAutomaticallyLoadedPackage("nomencl");
4238 if ((t.cs() == "textsuperscript" || t.cs() == "textsubscript")) {
4239 context.check_layout(os);
4240 begin_inset(os, "script ");
4241 os << t.cs().substr(4) << '\n';
4242 newinsetlayout = findInsetLayout(context.textclass, t.cs(), true);
4243 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
4245 if (t.cs() == "textsubscript")
4246 preamble.registerAutomaticallyLoadedPackage("subscript");
4250 if ((where = is_known(t.cs(), known_quotes))) {
4251 context.check_layout(os);
4252 begin_inset(os, "Quotes ");
4253 os << known_coded_quotes[where - known_quotes];
4255 // LyX adds {} after the quote, so we have to eat
4256 // spaces here if there are any before a possible
4258 eat_whitespace(p, os, context, false);
4263 if ((where = is_known(t.cs(), known_sizes)) &&
4264 context.new_layout_allowed) {
4265 context.check_layout(os);
4266 TeXFont const oldFont = context.font;
4267 context.font.size = known_coded_sizes[where - known_sizes];
4268 output_font_change(os, oldFont, context.font);
4269 eat_whitespace(p, os, context, false);
4273 if ((where = is_known(t.cs(), known_font_families)) &&
4274 context.new_layout_allowed) {
4275 context.check_layout(os);
4276 TeXFont const oldFont = context.font;
4277 context.font.family =
4278 known_coded_font_families[where - known_font_families];
4279 output_font_change(os, oldFont, context.font);
4280 eat_whitespace(p, os, context, false);
4284 if ((where = is_known(t.cs(), known_font_series)) &&
4285 context.new_layout_allowed) {
4286 context.check_layout(os);
4287 TeXFont const oldFont = context.font;
4288 context.font.series =
4289 known_coded_font_series[where - known_font_series];
4290 output_font_change(os, oldFont, context.font);
4291 eat_whitespace(p, os, context, false);
4295 if ((where = is_known(t.cs(), known_font_shapes)) &&
4296 context.new_layout_allowed) {
4297 context.check_layout(os);
4298 TeXFont const oldFont = context.font;
4299 context.font.shape =
4300 known_coded_font_shapes[where - known_font_shapes];
4301 output_font_change(os, oldFont, context.font);
4302 eat_whitespace(p, os, context, false);
4305 if ((where = is_known(t.cs(), known_old_font_families)) &&
4306 context.new_layout_allowed) {
4307 context.check_layout(os);
4308 TeXFont const oldFont = context.font;
4309 context.font.init();
4310 context.font.size = oldFont.size;
4311 context.font.family =
4312 known_coded_font_families[where - known_old_font_families];
4313 output_font_change(os, oldFont, context.font);
4314 eat_whitespace(p, os, context, false);
4318 if ((where = is_known(t.cs(), known_old_font_series)) &&
4319 context.new_layout_allowed) {
4320 context.check_layout(os);
4321 TeXFont const oldFont = context.font;
4322 context.font.init();
4323 context.font.size = oldFont.size;
4324 context.font.series =
4325 known_coded_font_series[where - known_old_font_series];
4326 output_font_change(os, oldFont, context.font);
4327 eat_whitespace(p, os, context, false);
4331 if ((where = is_known(t.cs(), known_old_font_shapes)) &&
4332 context.new_layout_allowed) {
4333 context.check_layout(os);
4334 TeXFont const oldFont = context.font;
4335 context.font.init();
4336 context.font.size = oldFont.size;
4337 context.font.shape =
4338 known_coded_font_shapes[where - known_old_font_shapes];
4339 output_font_change(os, oldFont, context.font);
4340 eat_whitespace(p, os, context, false);
4344 if (t.cs() == "selectlanguage") {
4345 context.check_layout(os);
4346 // save the language for the case that a
4347 // \foreignlanguage is used
4348 context.font.language = babel2lyx(p.verbatim_item());
4349 os << "\n\\lang " << context.font.language << "\n";
4353 if (t.cs() == "foreignlanguage") {
4354 string const lang = babel2lyx(p.verbatim_item());
4355 parse_text_attributes(p, os, FLAG_ITEM, outer,
4357 context.font.language, lang);
4361 if (prefixIs(t.cs(), "text") && preamble.usePolyglossia()
4362 && is_known(t.cs().substr(4), preamble.polyglossia_languages)) {
4363 // scheme is \textLANGUAGE{text} where LANGUAGE is in polyglossia_languages[]
4365 // We have to output the whole command if it has an option
4366 // because LyX doesn't support this yet, see bug #8214,
4367 // only if there is a single option specifying a variant, we can handle it.
4369 string langopts = p.getOpt();
4370 // check if the option contains a variant, if yes, extract it
4371 string::size_type pos_var = langopts.find("variant");
4372 string::size_type i = langopts.find(',');
4373 string::size_type k = langopts.find('=', pos_var);
4374 if (pos_var != string::npos && i == string::npos) {
4376 variant = langopts.substr(k + 1, langopts.length() - k - 2);
4377 lang = preamble.polyglossia2lyx(variant);
4378 parse_text_attributes(p, os, FLAG_ITEM, outer,
4380 context.font.language, lang);
4382 output_ert_inset(os, t.asInput() + langopts, context);
4384 lang = preamble.polyglossia2lyx(t.cs().substr(4, string::npos));
4385 parse_text_attributes(p, os, FLAG_ITEM, outer,
4387 context.font.language, lang);
4392 if (t.cs() == "inputencoding") {
4393 // nothing to write here
4394 string const enc = subst(p.verbatim_item(), "\n", " ");
4395 p.setEncoding(enc, Encoding::inputenc);
4399 if (is_known(t.cs(), known_special_chars) ||
4400 (t.cs() == "protect" &&
4401 p.next_token().cat() == catEscape &&
4402 is_known(p.next_token().cs(), known_special_protect_chars))) {
4403 // LyX sometimes puts a \protect in front, so we have to ignore it
4405 t.cs() == "protect" ? p.get_token().cs() : t.cs(),
4406 known_special_chars);
4407 context.check_layout(os);
4408 os << known_coded_special_chars[where - known_special_chars];
4409 skip_spaces_braces(p);
4413 if ((t.cs() == "nobreakdash" && p.next_token().asInput() == "-") ||
4414 (t.cs() == "protect" && p.next_token().asInput() == "\\nobreakdash" &&
4415 p.next_next_token().asInput() == "-") ||
4416 (t.cs() == "@" && p.next_token().asInput() == ".")) {
4417 // LyX sometimes puts a \protect in front, so we have to ignore it
4418 if (t.cs() == "protect")
4420 context.check_layout(os);
4421 if (t.cs() == "nobreakdash")
4422 os << "\\SpecialChar nobreakdash\n";
4424 os << "\\SpecialChar endofsentence\n";
4429 if (t.cs() == "textquotedbl") {
4430 context.check_layout(os);
4436 if (t.cs() == "_" || t.cs() == "&" || t.cs() == "#"
4437 || t.cs() == "$" || t.cs() == "{" || t.cs() == "}"
4438 || t.cs() == "%" || t.cs() == "-") {
4439 context.check_layout(os);
4441 os << "\\SpecialChar softhyphen\n";
4447 if (t.cs() == "char") {
4448 context.check_layout(os);
4449 if (p.next_token().character() == '`') {
4451 if (p.next_token().cs() == "\"") {
4456 output_ert_inset(os, "\\char`", context);
4459 output_ert_inset(os, "\\char", context);
4464 if (t.cs() == "verb") {
4465 context.check_layout(os);
4466 // set catcodes to verbatim early, just in case.
4467 p.setCatcodes(VERBATIM_CATCODES);
4468 string delim = p.get_token().asInput();
4469 Parser::Arg arg = p.verbatimStuff(delim);
4471 output_ert_inset(os, "\\verb" + delim
4472 + arg.second + delim, context);
4474 cerr << "invalid \\verb command. Skipping" << endl;
4478 // Problem: \= creates a tabstop inside the tabbing environment
4479 // and else an accent. In the latter case we really would want
4480 // \={o} instead of \= o.
4481 if (t.cs() == "=" && (flags & FLAG_TABBING)) {
4482 output_ert_inset(os, t.asInput(), context);
4486 if (t.cs() == "\\") {
4487 context.check_layout(os);
4489 output_ert_inset(os, "\\\\" + p.getOpt(), context);
4490 else if (p.next_token().asInput() == "*") {
4492 // getOpt() eats the following space if there
4493 // is no optional argument, but that is OK
4494 // here since it has no effect in the output.
4495 output_ert_inset(os, "\\\\*" + p.getOpt(), context);
4498 begin_inset(os, "Newline newline");
4504 if (t.cs() == "newline" ||
4505 (t.cs() == "linebreak" && !p.hasOpt())) {
4506 context.check_layout(os);
4507 begin_inset(os, "Newline ");
4510 skip_spaces_braces(p);
4514 if (t.cs() == "input" || t.cs() == "include"
4515 || t.cs() == "verbatiminput") {
4516 string name = t.cs();
4517 if (t.cs() == "verbatiminput"
4518 && p.next_token().asInput() == "*")
4519 name += p.get_token().asInput();
4520 context.check_layout(os);
4521 string filename(normalize_filename(p.getArg('{', '}')));
4522 string const path = getMasterFilePath(true);
4523 // We want to preserve relative / absolute filenames,
4524 // therefore path is only used for testing
4525 if ((t.cs() == "include" || t.cs() == "input") &&
4526 !makeAbsPath(filename, path).exists()) {
4527 // The file extension is probably missing.
4528 // Now try to find it out.
4529 string const tex_name =
4530 find_file(filename, path,
4531 known_tex_extensions);
4532 if (!tex_name.empty())
4533 filename = tex_name;
4535 bool external = false;
4537 if (makeAbsPath(filename, path).exists()) {
4538 string const abstexname =
4539 makeAbsPath(filename, path).absFileName();
4540 string const absfigname =
4541 changeExtension(abstexname, ".fig");
4542 fix_child_filename(filename);
4543 string const lyxname = changeExtension(filename,
4544 roundtripMode() ? ".lyx.lyx" : ".lyx");
4545 string const abslyxname = makeAbsPath(
4546 lyxname, getParentFilePath(false)).absFileName();
4548 if (!skipChildren())
4549 external = FileName(absfigname).exists();
4550 if (t.cs() == "input" && !skipChildren()) {
4551 string const ext = getExtension(abstexname);
4553 // Combined PS/LaTeX:
4554 // x.eps, x.pstex_t (old xfig)
4555 // x.pstex, x.pstex_t (new xfig, e.g. 3.2.5)
4556 FileName const absepsname(
4557 changeExtension(abstexname, ".eps"));
4558 FileName const abspstexname(
4559 changeExtension(abstexname, ".pstex"));
4560 bool const xfigeps =
4561 (absepsname.exists() ||
4562 abspstexname.exists()) &&
4565 // Combined PDF/LaTeX:
4566 // x.pdf, x.pdftex_t (old xfig)
4567 // x.pdf, x.pdf_t (new xfig, e.g. 3.2.5)
4568 FileName const abspdfname(
4569 changeExtension(abstexname, ".pdf"));
4570 bool const xfigpdf =
4571 abspdfname.exists() &&
4572 (ext == "pdftex_t" || ext == "pdf_t");
4576 // Combined PS/PDF/LaTeX:
4577 // x_pspdftex.eps, x_pspdftex.pdf, x.pspdftex
4578 string const absbase2(
4579 removeExtension(abstexname) + "_pspdftex");
4580 FileName const abseps2name(
4581 addExtension(absbase2, ".eps"));
4582 FileName const abspdf2name(
4583 addExtension(absbase2, ".pdf"));
4584 bool const xfigboth =
4585 abspdf2name.exists() &&
4586 abseps2name.exists() && ext == "pspdftex";
4588 xfig = xfigpdf || xfigeps || xfigboth;
4589 external = external && xfig;
4592 outname = changeExtension(filename, ".fig");
4593 FileName abssrc(changeExtension(abstexname, ".fig"));
4594 copy_file(abssrc, outname);
4596 // Don't try to convert, the result
4597 // would be full of ERT.
4599 FileName abssrc(abstexname);
4600 copy_file(abssrc, outname);
4601 } else if (t.cs() != "verbatiminput" &&
4603 tex2lyx(abstexname, FileName(abslyxname),
4606 // no need to call copy_file
4607 // tex2lyx creates the file
4610 FileName abssrc(abstexname);
4611 copy_file(abssrc, outname);
4614 cerr << "Warning: Could not find included file '"
4615 << filename << "'." << endl;
4619 begin_inset(os, "External\n");
4620 os << "\ttemplate XFig\n"
4621 << "\tfilename " << outname << '\n';
4622 registerExternalTemplatePackages("XFig");
4624 begin_command_inset(os, "include", name);
4625 outname = subst(outname, "\"", "\\\"");
4626 os << "preview false\n"
4627 "filename \"" << outname << "\"\n";
4628 if (t.cs() == "verbatiminput")
4629 preamble.registerAutomaticallyLoadedPackage("verbatim");
4635 if (t.cs() == "bibliographystyle") {
4636 // store new bibliographystyle
4637 bibliographystyle = p.verbatim_item();
4638 // If any other command than \bibliography, \addcontentsline
4639 // and \nocite{*} follows, we need to output the style
4640 // (because it might be used by that command).
4641 // Otherwise, it will automatically be output by LyX.
4644 for (Token t2 = p.get_token(); p.good(); t2 = p.get_token()) {
4645 if (t2.cat() == catBegin)
4647 if (t2.cat() != catEscape)
4649 if (t2.cs() == "nocite") {
4650 if (p.getArg('{', '}') == "*")
4652 } else if (t2.cs() == "bibliography")
4654 else if (t2.cs() == "phantomsection") {
4658 else if (t2.cs() == "addcontentsline") {
4659 // get the 3 arguments of \addcontentsline
4662 contentslineContent = p.getArg('{', '}');
4663 // if the last argument is not \refname we must output
4664 if (contentslineContent == "\\refname")
4671 output_ert_inset(os,
4672 "\\bibliographystyle{" + bibliographystyle + '}',
4678 if (t.cs() == "phantomsection") {
4679 // we only support this if it occurs between
4680 // \bibliographystyle and \bibliography
4681 if (bibliographystyle.empty())
4682 output_ert_inset(os, "\\phantomsection", context);
4686 if (t.cs() == "addcontentsline") {
4687 context.check_layout(os);
4688 // get the 3 arguments of \addcontentsline
4689 string const one = p.getArg('{', '}');
4690 string const two = p.getArg('{', '}');
4691 string const three = p.getArg('{', '}');
4692 // only if it is a \refname, we support if for the bibtex inset
4693 if (contentslineContent != "\\refname") {
4694 output_ert_inset(os,
4695 "\\addcontentsline{" + one + "}{" + two + "}{"+ three + '}',
4701 else if (t.cs() == "bibliography") {
4702 context.check_layout(os);
4704 begin_command_inset(os, "bibtex", "bibtex");
4705 if (!btprint.empty()) {
4706 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
4707 // clear the string because the next BibTeX inset can be without the
4708 // \nocite{*} option
4711 os << "bibfiles " << '"' << normalize_filename(p.verbatim_item()) << '"' << "\n";
4712 // Do we have addcontentsline?
4713 if (contentslineContent == "\\refname") {
4714 BibOpts = "bibtotoc";
4715 // clear string because next BibTeX inset can be without addcontentsline
4716 contentslineContent.clear();
4718 // Do we have a bibliographystyle set?
4719 if (!bibliographystyle.empty()) {
4720 if (BibOpts.empty())
4721 BibOpts = normalize_filename(bibliographystyle);
4723 BibOpts = BibOpts + ',' + normalize_filename(bibliographystyle);
4724 // clear it because each bibtex entry has its style
4725 // and we need an empty string to handle \phantomsection
4726 bibliographystyle.clear();
4728 os << "options " << '"' << BibOpts << '"' << "\n";
4733 if (t.cs() == "printbibliography") {
4734 context.check_layout(os);
4736 string bbloptions = p.hasOpt() ? p.getArg('[', ']') : string();
4737 vector<string> opts = getVectorFromString(bbloptions);
4738 vector<string>::iterator it =
4739 find(opts.begin(), opts.end(), "heading=bibintoc");
4740 if (it != opts.end()) {
4742 BibOpts = "bibtotoc";
4744 bbloptions = getStringFromVector(opts);
4745 begin_command_inset(os, "bibtex", "bibtex");
4746 if (!btprint.empty()) {
4747 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
4748 // clear the string because the next BibTeX inset can be without the
4749 // \nocite{*} option
4753 for (auto const & bf : preamble.biblatex_bibliographies) {
4754 if (!bibfiles.empty())
4756 bibfiles += normalize_filename(bf);
4758 if (!bibfiles.empty())
4759 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
4760 // Do we have addcontentsline?
4761 if (contentslineContent == "\\refname") {
4762 BibOpts = "bibtotoc";
4763 // clear string because next BibTeX inset can be without addcontentsline
4764 contentslineContent.clear();
4766 os << "options " << '"' << BibOpts << '"' << "\n";
4767 if (!bbloptions.empty())
4768 os << "biblatexopts " << '"' << bbloptions << '"' << "\n";
4770 need_commentbib = false;
4774 if (t.cs() == "bibbysection") {
4775 context.check_layout(os);
4777 string bbloptions = p.hasOpt() ? p.getArg('[', ']') : string();
4778 vector<string> opts = getVectorFromString(bbloptions);
4779 vector<string>::iterator it =
4780 find(opts.begin(), opts.end(), "heading=bibintoc");
4781 if (it != opts.end()) {
4783 BibOpts = "bibtotoc";
4785 bbloptions = getStringFromVector(opts);
4786 begin_command_inset(os, "bibtex", "bibtex");
4787 os << "btprint " << '"' << "bibbysection" << '"' << "\n";
4789 for (auto const & bf : preamble.biblatex_bibliographies) {
4790 if (!bibfiles.empty())
4792 bibfiles += normalize_filename(bf);
4794 if (!bibfiles.empty())
4795 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
4796 os << "options " << '"' << BibOpts << '"' << "\n";
4797 if (!bbloptions.empty())
4798 os << "biblatexopts " << '"' << bbloptions << '"' << "\n";
4800 need_commentbib = false;
4804 if (t.cs() == "parbox") {
4805 // Test whether this is an outer box of a shaded box
4807 // swallow arguments
4808 while (p.hasOpt()) {
4810 p.skip_spaces(true);
4813 p.skip_spaces(true);
4815 if (p.next_token().cat() == catBegin)
4817 p.skip_spaces(true);
4818 Token to = p.get_token();
4819 bool shaded = false;
4820 if (to.asInput() == "\\begin") {
4821 p.skip_spaces(true);
4822 if (p.getArg('{', '}') == "shaded")
4827 parse_outer_box(p, os, FLAG_ITEM, outer,
4828 context, "parbox", "shaded");
4830 parse_box(p, os, 0, FLAG_ITEM, outer, context,
4831 "", "", t.cs(), "", "");
4835 if (t.cs() == "fbox" || t.cs() == "mbox" ||
4836 t.cs() == "ovalbox" || t.cs() == "Ovalbox" ||
4837 t.cs() == "shadowbox" || t.cs() == "doublebox") {
4838 parse_outer_box(p, os, FLAG_ITEM, outer, context, t.cs(), "");
4842 if (t.cs() == "fcolorbox" || t.cs() == "colorbox") {
4843 string backgroundcolor;
4844 preamble.registerAutomaticallyLoadedPackage("xcolor");
4845 if (t.cs() == "fcolorbox") {
4846 string const framecolor = p.getArg('{', '}');
4847 backgroundcolor = p.getArg('{', '}');
4848 parse_box(p, os, 0, 0, outer, context, "", "", "", framecolor, backgroundcolor);
4850 backgroundcolor = p.getArg('{', '}');
4851 parse_box(p, os, 0, 0, outer, context, "", "", "", "", backgroundcolor);
4856 // FIXME: due to the compiler limit of "if" nestings
4857 // the code for the alignment was put here
4858 // put them in their own if if this is fixed
4859 if (t.cs() == "fboxrule" || t.cs() == "fboxsep"
4860 || t.cs() == "shadowsize"
4861 || t.cs() == "raggedleft" || t.cs() == "centering"
4862 || t.cs() == "raggedright") {
4863 if (t.cs() == "fboxrule")
4865 if (t.cs() == "fboxsep")
4867 if (t.cs() == "shadowsize")
4869 if (t.cs() != "raggedleft" && t.cs() != "centering"
4870 && t.cs() != "raggedright") {
4871 p.skip_spaces(true);
4872 while (p.good() && p.next_token().cat() != catSpace
4873 && p.next_token().cat() != catNewline
4874 && p.next_token().cat() != catEscape) {
4875 if (t.cs() == "fboxrule")
4876 fboxrule = fboxrule + p.get_token().asInput();
4877 if (t.cs() == "fboxsep")
4878 fboxsep = fboxsep + p.get_token().asInput();
4879 if (t.cs() == "shadowsize")
4880 shadow_size = shadow_size + p.get_token().asInput();
4883 output_ert_inset(os, t.asInput(), context);
4888 //\framebox() is part of the picture environment and different from \framebox{}
4889 //\framebox{} will be parsed by parse_outer_box
4890 if (t.cs() == "framebox") {
4891 if (p.next_token().character() == '(') {
4892 //the syntax is: \framebox(x,y)[position]{content}
4893 string arg = t.asInput();
4894 arg += p.getFullParentheseArg();
4895 arg += p.getFullOpt();
4896 eat_whitespace(p, os, context, false);
4897 output_ert_inset(os, arg + '{', context);
4898 parse_text(p, os, FLAG_ITEM, outer, context);
4899 output_ert_inset(os, "}", context);
4901 //the syntax is: \framebox[width][position]{content}
4902 string special = p.getFullOpt();
4903 special += p.getOpt();
4904 parse_outer_box(p, os, FLAG_ITEM, outer,
4905 context, t.cs(), special);
4910 //\makebox() is part of the picture environment and different from \makebox{}
4911 //\makebox{} will be parsed by parse_box
4912 if (t.cs() == "makebox") {
4913 if (p.next_token().character() == '(') {
4914 //the syntax is: \makebox(x,y)[position]{content}
4915 string arg = t.asInput();
4916 arg += p.getFullParentheseArg();
4917 arg += p.getFullOpt();
4918 eat_whitespace(p, os, context, false);
4919 output_ert_inset(os, arg + '{', context);
4920 parse_text(p, os, FLAG_ITEM, outer, context);
4921 output_ert_inset(os, "}", context);
4923 //the syntax is: \makebox[width][position]{content}
4924 parse_box(p, os, 0, FLAG_ITEM, outer, context,
4925 "", "", t.cs(), "", "");
4929 if (t.cs() == "smallskip" ||
4930 t.cs() == "medskip" ||
4931 t.cs() == "bigskip" ||
4932 t.cs() == "vfill") {
4933 context.check_layout(os);
4934 begin_inset(os, "VSpace ");
4937 skip_spaces_braces(p);
4941 if ((where = is_known(t.cs(), known_spaces))) {
4942 context.check_layout(os);
4943 begin_inset(os, "space ");
4944 os << '\\' << known_coded_spaces[where - known_spaces]
4947 // LaTeX swallows whitespace after all spaces except
4948 // "\\,". We have to do that here, too, because LyX
4949 // adds "{}" which would make the spaces significant.
4951 eat_whitespace(p, os, context, false);
4952 // LyX adds "{}" after all spaces except "\\ " and
4953 // "\\,", so we have to remove "{}".
4954 // "\\,{}" is equivalent to "\\," in LaTeX, so we
4955 // remove the braces after "\\,", too.
4961 if (t.cs() == "newpage" ||
4962 (t.cs() == "pagebreak" && !p.hasOpt()) ||
4963 t.cs() == "clearpage" ||
4964 t.cs() == "cleardoublepage") {
4965 context.check_layout(os);
4966 begin_inset(os, "Newpage ");
4969 skip_spaces_braces(p);
4973 if (t.cs() == "DeclareRobustCommand" ||
4974 t.cs() == "DeclareRobustCommandx" ||
4975 t.cs() == "newcommand" ||
4976 t.cs() == "newcommandx" ||
4977 t.cs() == "providecommand" ||
4978 t.cs() == "providecommandx" ||
4979 t.cs() == "renewcommand" ||
4980 t.cs() == "renewcommandx") {
4981 // DeclareRobustCommand, DeclareRobustCommandx,
4982 // providecommand and providecommandx could be handled
4983 // by parse_command(), but we need to call
4984 // add_known_command() here.
4985 string name = t.asInput();
4986 if (p.next_token().asInput() == "*") {
4987 // Starred form. Eat '*'
4991 string const command = p.verbatim_item();
4992 string const opt1 = p.getFullOpt();
4993 string const opt2 = p.getFullOpt();
4994 add_known_command(command, opt1, !opt2.empty());
4995 string const ert = name + '{' + command + '}' +
4997 '{' + p.verbatim_item() + '}';
4999 if (t.cs() == "DeclareRobustCommand" ||
5000 t.cs() == "DeclareRobustCommandx" ||
5001 t.cs() == "providecommand" ||
5002 t.cs() == "providecommandx" ||
5003 name[name.length()-1] == '*')
5004 output_ert_inset(os, ert, context);
5006 context.check_layout(os);
5007 begin_inset(os, "FormulaMacro");
5014 if (t.cs() == "let" && p.next_token().asInput() != "*") {
5015 // let could be handled by parse_command(),
5016 // but we need to call add_known_command() here.
5017 string ert = t.asInput();
5020 if (p.next_token().cat() == catBegin) {
5021 name = p.verbatim_item();
5022 ert += '{' + name + '}';
5024 name = p.verbatim_item();
5029 if (p.next_token().cat() == catBegin) {
5030 command = p.verbatim_item();
5031 ert += '{' + command + '}';
5033 command = p.verbatim_item();
5036 // If command is known, make name known too, to parse
5037 // its arguments correctly. For this reason we also
5038 // have commands in syntax.default that are hardcoded.
5039 CommandMap::iterator it = known_commands.find(command);
5040 if (it != known_commands.end())
5041 known_commands[t.asInput()] = it->second;
5042 output_ert_inset(os, ert, context);
5046 if (t.cs() == "hspace" || t.cs() == "vspace") {
5049 string name = t.asInput();
5050 string const length = p.verbatim_item();
5053 bool valid = splitLatexLength(length, valstring, unit);
5054 bool known_hspace = false;
5055 bool known_vspace = false;
5056 bool known_unit = false;
5059 istringstream iss(valstring);
5062 if (t.cs()[0] == 'h') {
5063 if (unit == "\\fill") {
5068 known_hspace = true;
5071 if (unit == "\\smallskipamount") {
5073 known_vspace = true;
5074 } else if (unit == "\\medskipamount") {
5076 known_vspace = true;
5077 } else if (unit == "\\bigskipamount") {
5079 known_vspace = true;
5080 } else if (unit == "\\fill") {
5082 known_vspace = true;
5086 if (!known_hspace && !known_vspace) {
5087 switch (unitFromString(unit)) {
5103 //unitFromString(unit) fails for relative units like Length::PCW
5104 // therefore handle them separately
5105 if (unit == "\\paperwidth" || unit == "\\columnwidth"
5106 || unit == "\\textwidth" || unit == "\\linewidth"
5107 || unit == "\\textheight" || unit == "\\paperheight"
5108 || unit == "\\baselineskip")
5116 // check for glue lengths
5117 bool is_gluelength = false;
5118 string gluelength = length;
5119 string::size_type i = length.find(" minus");
5120 if (i == string::npos) {
5121 i = length.find(" plus");
5122 if (i != string::npos)
5123 is_gluelength = true;
5125 is_gluelength = true;
5126 // if yes transform "9xx minus 8yy plus 7zz"
5128 if (is_gluelength) {
5129 i = gluelength.find(" minus");
5130 if (i != string::npos)
5131 gluelength.replace(i, 7, "-");
5132 i = gluelength.find(" plus");
5133 if (i != string::npos)
5134 gluelength.replace(i, 6, "+");
5137 if (t.cs()[0] == 'h' && (known_unit || known_hspace || is_gluelength)) {
5138 // Literal horizontal length or known variable
5139 context.check_layout(os);
5140 begin_inset(os, "space ");
5148 if (known_unit && !known_hspace)
5149 os << "\n\\length " << translate_len(length);
5151 os << "\n\\length " << gluelength;
5153 } else if (known_unit || known_vspace || is_gluelength) {
5154 // Literal vertical length or known variable
5155 context.check_layout(os);
5156 begin_inset(os, "VSpace ");
5159 if (known_unit && !known_vspace)
5160 os << translate_len(length);
5167 // LyX can't handle other length variables in Inset VSpace/space
5172 output_ert_inset(os, name + '{' + unit + '}', context);
5173 else if (value == -1.0)
5174 output_ert_inset(os, name + "{-" + unit + '}', context);
5176 output_ert_inset(os, name + '{' + valstring + unit + '}', context);
5178 output_ert_inset(os, name + '{' + length + '}', context);
5183 // The single '=' is meant here.
5184 if ((newinsetlayout = findInsetLayout(context.textclass, starredname, true))) {
5188 context.check_layout(os);
5189 docstring const name = newinsetlayout->name();
5190 bool const caption = name.find(from_ascii("Caption:")) == 0;
5192 // Already done for floating minted listings.
5193 if (minted_float.empty()) {
5194 begin_inset(os, "Caption ");
5195 os << to_utf8(name.substr(8)) << '\n';
5198 begin_inset(os, "Flex ");
5199 os << to_utf8(name) << '\n'
5200 << "status collapsed\n";
5202 if (!minted_float.empty()) {
5203 parse_text_snippet(p, os, FLAG_ITEM, false, context);
5204 } else if (newinsetlayout->isPassThru()) {
5205 // set catcodes to verbatim early, just in case.
5206 p.setCatcodes(VERBATIM_CATCODES);
5207 string delim = p.get_token().asInput();
5209 cerr << "Warning: bad delimiter for command " << t.asInput() << endl;
5210 //FIXME: handle error condition
5211 string const arg = p.verbatimStuff("}").second;
5212 Context newcontext(true, context.textclass);
5213 if (newinsetlayout->forcePlainLayout())
5214 newcontext.layout = &context.textclass.plainLayout();
5215 output_ert(os, arg, newcontext);
5217 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
5220 // Minted caption insets are not closed here because
5221 // we collect everything into the caption.
5222 if (minted_float.empty())
5227 if (t.cs() == "includepdf") {
5229 string const arg = p.getArg('[', ']');
5230 map<string, string> opts;
5231 vector<string> keys;
5232 split_map(arg, opts, keys);
5233 string name = normalize_filename(p.verbatim_item());
5234 string const path = getMasterFilePath(true);
5235 // We want to preserve relative / absolute filenames,
5236 // therefore path is only used for testing
5237 if (!makeAbsPath(name, path).exists()) {
5238 // The file extension is probably missing.
5239 // Now try to find it out.
5240 char const * const pdfpages_format[] = {"pdf", 0};
5241 string const pdftex_name =
5242 find_file(name, path, pdfpages_format);
5243 if (!pdftex_name.empty()) {
5248 FileName const absname = makeAbsPath(name, path);
5249 if (absname.exists())
5251 fix_child_filename(name);
5252 copy_file(absname, name);
5254 cerr << "Warning: Could not find file '"
5255 << name << "'." << endl;
5257 context.check_layout(os);
5258 begin_inset(os, "External\n\ttemplate ");
5259 os << "PDFPages\n\tfilename "
5261 // parse the options
5262 if (opts.find("pages") != opts.end())
5263 os << "\textra LaTeX \"pages="
5264 << opts["pages"] << "\"\n";
5265 if (opts.find("angle") != opts.end())
5266 os << "\trotateAngle "
5267 << opts["angle"] << '\n';
5268 if (opts.find("origin") != opts.end()) {
5270 string const opt = opts["origin"];
5271 if (opt == "tl") ss << "topleft";
5272 if (opt == "bl") ss << "bottomleft";
5273 if (opt == "Bl") ss << "baselineleft";
5274 if (opt == "c") ss << "center";
5275 if (opt == "tc") ss << "topcenter";
5276 if (opt == "bc") ss << "bottomcenter";
5277 if (opt == "Bc") ss << "baselinecenter";
5278 if (opt == "tr") ss << "topright";
5279 if (opt == "br") ss << "bottomright";
5280 if (opt == "Br") ss << "baselineright";
5281 if (!ss.str().empty())
5282 os << "\trotateOrigin " << ss.str() << '\n';
5284 cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
5286 if (opts.find("width") != opts.end())
5288 << translate_len(opts["width"]) << '\n';
5289 if (opts.find("height") != opts.end())
5291 << translate_len(opts["height"]) << '\n';
5292 if (opts.find("keepaspectratio") != opts.end())
5293 os << "\tkeepAspectRatio\n";
5295 context.check_layout(os);
5296 registerExternalTemplatePackages("PDFPages");
5300 if (t.cs() == "loadgame") {
5302 string name = normalize_filename(p.verbatim_item());
5303 string const path = getMasterFilePath(true);
5304 // We want to preserve relative / absolute filenames,
5305 // therefore path is only used for testing
5306 if (!makeAbsPath(name, path).exists()) {
5307 // The file extension is probably missing.
5308 // Now try to find it out.
5309 char const * const lyxskak_format[] = {"fen", 0};
5310 string const lyxskak_name =
5311 find_file(name, path, lyxskak_format);
5312 if (!lyxskak_name.empty())
5313 name = lyxskak_name;
5315 FileName const absname = makeAbsPath(name, path);
5316 if (absname.exists())
5318 fix_child_filename(name);
5319 copy_file(absname, name);
5321 cerr << "Warning: Could not find file '"
5322 << name << "'." << endl;
5323 context.check_layout(os);
5324 begin_inset(os, "External\n\ttemplate ");
5325 os << "ChessDiagram\n\tfilename "
5328 context.check_layout(os);
5329 // after a \loadgame follows a \showboard
5330 if (p.get_token().asInput() == "showboard")
5332 registerExternalTemplatePackages("ChessDiagram");
5336 // try to see whether the string is in unicodesymbols
5337 // Only use text mode commands, since we are in text mode here,
5338 // and math commands may be invalid (bug 6797)
5339 string name = t.asInput();
5340 // handle the dingbats, cyrillic and greek
5341 if (name == "\\ding" || name == "\\textcyr" ||
5342 (name == "\\textgreek" && !preamble.usePolyglossia()))
5343 name = name + '{' + p.getArg('{', '}') + '}';
5344 // handle the ifsym characters
5345 else if (name == "\\textifsymbol") {
5346 string const optif = p.getFullOpt();
5347 string const argif = p.getArg('{', '}');
5348 name = name + optif + '{' + argif + '}';
5350 // handle the \ascii characters
5351 // the case of \ascii within braces, as LyX outputs it, is already
5352 // handled for t.cat() == catBegin
5353 else if (name == "\\ascii") {
5354 // the code is "\asci\xxx"
5355 name = "{" + name + p.get_token().asInput() + "}";
5358 // handle some TIPA special characters
5359 else if (preamble.isPackageUsed("tipa")) {
5360 if (name == "\\s") {
5361 // fromLaTeXCommand() does not yet
5362 // recognize tipa short cuts
5363 name = "\\textsyllabic";
5364 } else if (name == "\\=" &&
5365 p.next_token().asInput() == "*") {
5366 // fromLaTeXCommand() does not yet
5367 // recognize tipa short cuts
5369 name = "\\textsubbar";
5370 } else if (name == "\\textdoublevertline") {
5371 // FIXME: This is not correct,
5372 // \textvertline is higher than \textbardbl
5373 name = "\\textbardbl";
5375 } else if (name == "\\!" ) {
5376 if (p.next_token().asInput() == "b") {
5377 p.get_token(); // eat 'b'
5380 } else if (p.next_token().asInput() == "d") {
5384 } else if (p.next_token().asInput() == "g") {
5388 } else if (p.next_token().asInput() == "G") {
5390 name = "\\texthtscg";
5392 } else if (p.next_token().asInput() == "j") {
5394 name = "\\texthtbardotlessj";
5396 } else if (p.next_token().asInput() == "o") {
5398 name = "\\textbullseye";
5401 } else if (name == "\\*" ) {
5402 if (p.next_token().asInput() == "k") {
5404 name = "\\textturnk";
5406 } else if (p.next_token().asInput() == "r") {
5407 p.get_token(); // eat 'b'
5408 name = "\\textturnr";
5410 } else if (p.next_token().asInput() == "t") {
5412 name = "\\textturnt";
5414 } else if (p.next_token().asInput() == "w") {
5416 name = "\\textturnw";
5421 if ((name.size() == 2 &&
5422 contains("\"'.=^`bcdHkrtuv~", name[1]) &&
5423 p.next_token().asInput() != "*") ||
5424 is_known(name.substr(1), known_tipa_marks)) {
5425 // name is a command that corresponds to a
5426 // combining character in unicodesymbols.
5427 // Append the argument, fromLaTeXCommand()
5428 // will either convert it to a single
5429 // character or a combining sequence.
5430 name += '{' + p.verbatim_item() + '}';
5432 // now get the character from unicodesymbols
5436 docstring s = normalize_c(encodings.fromLaTeXCommand(from_utf8(name),
5437 Encodings::TEXT_CMD, termination, rem, &req));
5439 context.check_layout(os);
5442 output_ert_inset(os, to_utf8(rem), context);
5444 skip_spaces_braces(p);
5445 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
5446 preamble.registerAutomaticallyLoadedPackage(*it);
5448 //cerr << "#: " << t << " mode: " << mode << endl;
5449 // heuristic: read up to next non-nested space
5451 string s = t.asInput();
5452 string z = p.verbatim_item();
5453 while (p.good() && z != " " && !z.empty()) {
5454 //cerr << "read: " << z << endl;
5456 z = p.verbatim_item();
5458 cerr << "found ERT: " << s << endl;
5459 output_ert_inset(os, s + ' ', context);
5462 if (t.asInput() == name &&
5463 p.next_token().asInput() == "*") {
5464 // Starred commands like \vspace*{}
5465 p.get_token(); // Eat '*'
5468 if (!parse_command(name, p, os, outer, context))
5469 output_ert_inset(os, name, context);
5475 string guessLanguage(Parser & p, string const & lang)
5477 typedef std::map<std::string, size_t> LangMap;
5478 // map from language names to number of characters
5481 for (char const * const * i = supported_CJK_languages; *i; i++)
5482 used[string(*i)] = 0;
5485 Token const t = p.get_token();
5486 // comments are not counted for any language
5487 if (t.cat() == catComment)
5489 // commands are not counted as well, but we need to detect
5490 // \begin{CJK} and switch encoding if needed
5491 if (t.cat() == catEscape) {
5492 if (t.cs() == "inputencoding") {
5493 string const enc = subst(p.verbatim_item(), "\n", " ");
5494 p.setEncoding(enc, Encoding::inputenc);
5497 if (t.cs() != "begin")
5500 // Non-CJK content is counted for lang.
5501 // We do not care about the real language here:
5502 // If we have more non-CJK contents than CJK contents,
5503 // we simply use the language that was specified as
5504 // babel main language.
5505 used[lang] += t.asInput().length();
5508 // Now we are starting an environment
5510 string const name = p.getArg('{', '}');
5511 if (name != "CJK") {
5515 // It is a CJK environment
5517 /* name = */ p.getArg('{', '}');
5518 string const encoding = p.getArg('{', '}');
5519 /* mapping = */ p.getArg('{', '}');
5520 string const encoding_old = p.getEncoding();
5521 char const * const * const where =
5522 is_known(encoding, supported_CJK_encodings);
5524 p.setEncoding(encoding, Encoding::CJK);
5526 p.setEncoding("UTF-8");
5527 string const text = p.ertEnvironment("CJK");
5528 p.setEncoding(encoding_old);
5531 // ignore contents in unknown CJK encoding
5534 // the language of the text
5536 supported_CJK_languages[where - supported_CJK_encodings];
5537 used[cjk] += text.length();
5539 LangMap::const_iterator use = used.begin();
5540 for (LangMap::const_iterator it = used.begin(); it != used.end(); ++it) {
5541 if (it->second > use->second)
5548 void check_comment_bib(ostream & os, Context & context)
5550 if (!need_commentbib)
5552 // We have a bibliography database, but no bibliography with biblatex
5553 // which is completely valid. Insert a bibtex inset in a note.
5554 context.check_layout(os);
5555 begin_inset(os, "Note Note\n");
5556 os << "status open\n";
5557 os << "\\begin_layout Plain Layout\n";
5558 begin_command_inset(os, "bibtex", "bibtex");
5560 for (auto const & bf : preamble.biblatex_bibliographies) {
5561 if (!bibfiles.empty())
5563 bibfiles += normalize_filename(bf);
5565 if (!bibfiles.empty())
5566 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
5567 end_inset(os);// Bibtex
5568 os << "\\end_layout\n";
5569 end_inset(os);// Note