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
485 void begin_inset(ostream & os, string const & name)
487 os << "\n\\begin_inset " << name;
491 void begin_command_inset(ostream & os, string const & name,
492 string const & latexname)
494 begin_inset(os, "CommandInset ");
495 os << name << "\nLatexCommand " << latexname << '\n';
499 void end_inset(ostream & os)
501 os << "\n\\end_inset\n\n";
505 bool skip_braces(Parser & p)
507 if (p.next_token().cat() != catBegin)
510 if (p.next_token().cat() == catEnd) {
519 /// replace LaTeX commands in \p s from the unicodesymbols file with their
521 docstring convert_unicodesymbols(docstring s)
524 for (size_t i = 0; i < s.size();) {
533 docstring parsed = normalize_c(encodings.fromLaTeXCommand(s,
534 Encodings::TEXT_CMD, termination, rem, &req));
535 set<string>::const_iterator it = req.begin();
536 set<string>::const_iterator en = req.end();
537 for (; it != en; ++it)
538 preamble.registerAutomaticallyLoadedPackage(*it);
541 if (s.empty() || s[0] != '\\')
550 /// try to convert \p s to a valid InsetCommand argument
551 string convert_command_inset_arg(string s)
554 // since we don't know the input encoding we can't use from_utf8
555 s = to_utf8(convert_unicodesymbols(from_ascii(s)));
556 // LyX cannot handle newlines in a latex command
557 return subst(s, "\n", " ");
561 void output_ert(ostream & os, string const & s, Context & context)
563 context.check_layout(os);
564 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
566 os << "\n\\backslash\n";
567 else if (*it == '\n') {
568 context.new_paragraph(os);
569 context.check_layout(os);
573 context.check_end_layout(os);
577 void output_ert_inset(ostream & os, string const & s, Context & context)
579 // We must have a valid layout before outputting the ERT inset.
580 context.check_layout(os);
581 Context newcontext(true, context.textclass);
582 InsetLayout const & layout = context.textclass.insetLayout(from_ascii("ERT"));
583 if (layout.forcePlainLayout())
584 newcontext.layout = &context.textclass.plainLayout();
585 begin_inset(os, "ERT");
586 os << "\nstatus collapsed\n";
587 output_ert(os, s, newcontext);
592 void output_comment(Parser & p, ostream & os, string const & s,
595 if (p.next_token().cat() == catNewline)
596 output_ert_inset(os, '%' + s, context);
598 output_ert_inset(os, '%' + s + '\n', context);
602 Layout const * findLayout(TextClass const & textclass, string const & name, bool command)
604 Layout const * layout = findLayoutWithoutModule(textclass, name, command);
607 if (checkModule(name, command))
608 return findLayoutWithoutModule(textclass, name, command);
613 InsetLayout const * findInsetLayout(TextClass const & textclass, string const & name, bool command)
615 InsetLayout const * insetlayout = findInsetLayoutWithoutModule(textclass, name, command);
618 if (checkModule(name, command))
619 return findInsetLayoutWithoutModule(textclass, name, command);
624 void eat_whitespace(Parser &, ostream &, Context &, bool);
628 * Skips whitespace and braces.
629 * This should be called after a command has been parsed that is not put into
630 * ERT, and where LyX adds "{}" if needed.
632 void skip_spaces_braces(Parser & p, bool keepws = false)
634 /* The following four examples produce the same typeset output and
635 should be handled by this function:
643 // Unfortunately we need to skip comments, too.
644 // We can't use eat_whitespace since writing them after the {}
645 // results in different output in some cases.
646 bool const skipped_spaces = p.skip_spaces(true);
647 bool const skipped_braces = skip_braces(p);
648 if (keepws && skipped_spaces && !skipped_braces)
649 // put back the space (it is better handled by check_space)
650 p.unskip_spaces(true);
654 void output_arguments(ostream & os, Parser & p, bool outer, bool need_layout, bool post,
655 Context & context, Layout::LaTeXArgMap const & latexargs)
658 context.check_layout(os);
663 Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
664 Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
665 for (; lait != laend; ++lait) {
667 eat_whitespace(p, os, context, false);
668 if (lait->second.mandatory) {
669 if (p.next_token().cat() != catBegin)
671 p.get_token(); // eat '{'
673 context.check_layout(os);
676 begin_inset(os, "Argument ");
679 os << i << "\nstatus collapsed\n\n";
680 parse_text_in_inset(p, os, FLAG_BRACE_LAST, outer, context);
683 if (p.next_token().cat() == catEscape ||
684 p.next_token().character() != '[')
686 p.get_token(); // eat '['
688 context.check_layout(os);
691 begin_inset(os, "Argument ");
694 os << i << "\nstatus collapsed\n\n";
695 parse_text_in_inset(p, os, FLAG_BRACK_LAST, outer, context);
698 eat_whitespace(p, os, context, false);
703 void output_command_layout(ostream & os, Parser & p, bool outer,
704 Context & parent_context,
705 Layout const * newlayout)
707 TeXFont const oldFont = parent_context.font;
708 // save the current font size
709 string const size = oldFont.size;
710 // reset the font size to default, because the font size switches
711 // don't affect section headings and the like
712 parent_context.font.size = Context::normalfont.size;
713 // we only need to write the font change if we have an open layout
714 if (!parent_context.atParagraphStart())
715 output_font_change(os, oldFont, parent_context.font);
716 parent_context.check_end_layout(os);
717 Context context(true, parent_context.textclass, newlayout,
718 parent_context.layout, parent_context.font);
719 if (parent_context.deeper_paragraph) {
720 // We are beginning a nested environment after a
721 // deeper paragraph inside the outer list environment.
722 // Therefore we don't need to output a "begin deeper".
723 context.need_end_deeper = true;
725 context.check_deeper(os);
726 output_arguments(os, p, outer, true, false, context,
727 context.layout->latexargs());
728 parse_text(p, os, FLAG_ITEM, outer, context);
729 output_arguments(os, p, outer, false, true, context,
730 context.layout->postcommandargs());
731 context.check_end_layout(os);
732 if (parent_context.deeper_paragraph) {
733 // We must suppress the "end deeper" because we
734 // suppressed the "begin deeper" above.
735 context.need_end_deeper = false;
737 context.check_end_deeper(os);
738 // We don't need really a new paragraph, but
739 // we must make sure that the next item gets a \begin_layout.
740 parent_context.new_paragraph(os);
741 // Set the font size to the original value. No need to output it here
742 // (Context::begin_layout() will do that if needed)
743 parent_context.font.size = size;
748 * Output a space if necessary.
749 * This function gets called for every whitespace token.
751 * We have three cases here:
752 * 1. A space must be suppressed. Example: The lyxcode case below
753 * 2. A space may be suppressed. Example: Spaces before "\par"
754 * 3. A space must not be suppressed. Example: A space between two words
756 * We currently handle only 1. and 3 and from 2. only the case of
757 * spaces before newlines as a side effect.
759 * 2. could be used to suppress as many spaces as possible. This has two effects:
760 * - Reimporting LyX generated LaTeX files changes almost no whitespace
761 * - Superflous whitespace from non LyX generated LaTeX files is removed.
762 * The drawback is that the logic inside the function becomes
763 * complicated, and that is the reason why it is not implemented.
765 void check_space(Parser & p, ostream & os, Context & context)
767 Token const next = p.next_token();
768 Token const curr = p.curr_token();
769 // A space before a single newline and vice versa must be ignored
770 // LyX emits a newline before \end{lyxcode}.
771 // This newline must be ignored,
772 // otherwise LyX will add an additional protected space.
773 if (next.cat() == catSpace ||
774 next.cat() == catNewline ||
775 (next.cs() == "end" && context.layout->free_spacing && curr.cat() == catNewline)) {
778 context.check_layout(os);
784 * Parse all arguments of \p command
786 void parse_arguments(string const & command,
787 vector<ArgumentType> const & template_arguments,
788 Parser & p, ostream & os, bool outer, Context & context)
790 string ert = command;
791 size_t no_arguments = template_arguments.size();
792 for (size_t i = 0; i < no_arguments; ++i) {
793 switch (template_arguments[i]) {
796 // This argument contains regular LaTeX
797 output_ert_inset(os, ert + '{', context);
798 eat_whitespace(p, os, context, false);
799 if (template_arguments[i] == required)
800 parse_text(p, os, FLAG_ITEM, outer, context);
802 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
806 // This argument consists only of a single item.
807 // The presence of '{' or not must be preserved.
809 if (p.next_token().cat() == catBegin)
810 ert += '{' + p.verbatim_item() + '}';
812 ert += p.verbatim_item();
816 // This argument may contain special characters
817 ert += '{' + p.verbatim_item() + '}';
821 // true because we must not eat whitespace
822 // if an optional arg follows we must not strip the
823 // brackets from this one
824 if (i < no_arguments - 1 &&
825 template_arguments[i+1] == optional)
826 ert += p.getFullOpt(true);
828 ert += p.getOpt(true);
832 output_ert_inset(os, ert, context);
837 * Check whether \p command is a known command. If yes,
838 * handle the command with all arguments.
839 * \return true if the command was parsed, false otherwise.
841 bool parse_command(string const & command, Parser & p, ostream & os,
842 bool outer, Context & context)
844 if (known_commands.find(command) != known_commands.end()) {
845 parse_arguments(command, known_commands[command], p, os,
853 /// Parses a minipage or parbox
854 void parse_box(Parser & p, ostream & os, unsigned outer_flags,
855 unsigned inner_flags, bool outer, Context & parent_context,
856 string const & outer_type, string const & special,
857 string inner_type, string const & frame_color,
858 string const & background_color)
862 string hor_pos = "l";
863 // We need to set the height to the LaTeX default of 1\\totalheight
864 // for the case when no height argument is given
865 string height_value = "1";
866 string height_unit = "in";
867 string height_special = "totalheight";
872 string width_special = "none";
873 string thickness = "0.4pt";
874 if (!fboxrule.empty())
875 thickness = fboxrule;
879 if (!fboxsep.empty())
880 separation = fboxsep;
884 if (!shadow_size.empty())
885 shadowsize = shadow_size;
888 string framecolor = "black";
889 string backgroundcolor = "none";
890 if (!frame_color.empty())
891 framecolor = frame_color;
892 if (!background_color.empty())
893 backgroundcolor = background_color;
894 // if there is a color box around the \begin statements have not yet been parsed
896 if (!frame_color.empty() || !background_color.empty()) {
897 eat_whitespace(p, os, parent_context, false);
898 p.get_token().asInput(); // the '{'
900 if (p.next_token().asInput() == "\\begin") {
901 p.get_token().asInput();
903 inner_type = "minipage";
904 inner_flags = FLAG_END;
905 active_environments.push_back("minipage");
908 else if (p.next_token().asInput() == "\\parbox") {
909 p.get_token().asInput();
910 inner_type = "parbox";
911 inner_flags = FLAG_ITEM;
914 else if (p.next_token().asInput() == "\\makebox") {
915 p.get_token().asInput();
916 inner_type = "makebox";
917 inner_flags = FLAG_ITEM;
919 // in case there is just \colorbox{color}{text}
922 inner_type = "makebox";
923 inner_flags = FLAG_BRACE_LAST;
928 if (!p.hasOpt() && (inner_type == "makebox" || outer_type == "mbox"))
930 if (!inner_type.empty() && p.hasOpt()) {
931 if (inner_type != "makebox")
932 position = p.getArg('[', ']');
934 latex_width = p.getArg('[', ']');
935 translate_box_len(latex_width, width_value, width_unit, width_special);
938 if (position != "t" && position != "c" && position != "b") {
939 cerr << "invalid position " << position << " for "
940 << inner_type << endl;
944 if (inner_type != "makebox") {
945 latex_height = p.getArg('[', ']');
946 translate_box_len(latex_height, height_value, height_unit, height_special);
948 string const opt = p.getArg('[', ']');
951 if (hor_pos != "l" && hor_pos != "c" &&
952 hor_pos != "r" && hor_pos != "s") {
953 cerr << "invalid hor_pos " << hor_pos
954 << " for " << inner_type << endl;
961 inner_pos = p.getArg('[', ']');
962 if (inner_pos != "c" && inner_pos != "t" &&
963 inner_pos != "b" && inner_pos != "s") {
964 cerr << "invalid inner_pos "
965 << inner_pos << " for "
966 << inner_type << endl;
967 inner_pos = position;
971 if (inner_type == "makebox")
975 if (inner_type.empty()) {
976 if (special.empty() && outer_type != "framebox")
977 latex_width = "1\\columnwidth";
980 latex_width = p2.getArg('[', ']');
981 string const opt = p2.getArg('[', ']');
984 if (hor_pos != "l" && hor_pos != "c" &&
985 hor_pos != "r" && hor_pos != "s") {
986 cerr << "invalid hor_pos " << hor_pos
987 << " for " << outer_type << endl;
991 if (outer_type == "framebox")
995 } else if (inner_type != "makebox")
996 latex_width = p.verbatim_item();
997 // if e.g. only \ovalbox{content} was used, set the width to 1\columnwidth
998 // as this is LyX's standard for such cases (except for makebox)
999 // \framebox is more special and handled below
1000 if (latex_width.empty() && inner_type != "makebox"
1001 && outer_type != "framebox")
1002 latex_width = "1\\columnwidth";
1004 translate_len(latex_width, width_value, width_unit);
1006 bool shadedparbox = false;
1007 if (inner_type == "shaded") {
1008 eat_whitespace(p, os, parent_context, false);
1009 if (outer_type == "parbox") {
1011 if (p.next_token().cat() == catBegin)
1013 eat_whitespace(p, os, parent_context, false);
1014 shadedparbox = true;
1019 // If we already read the inner box we have to push the inner env
1020 if (!outer_type.empty() && !inner_type.empty() &&
1021 (inner_flags & FLAG_END))
1022 active_environments.push_back(inner_type);
1023 bool use_ert = false;
1024 if (!outer_type.empty() && !inner_type.empty()) {
1025 // Look whether there is some content after the end of the
1026 // inner box, but before the end of the outer box.
1027 // If yes, we need to output ERT.
1029 if (inner_flags & FLAG_END)
1030 p.ertEnvironment(inner_type);
1033 p.skip_spaces(true);
1034 bool const outer_env(outer_type == "framed" || outer_type == "minipage");
1035 if ((outer_env && p.next_token().asInput() != "\\end") ||
1036 (!outer_env && p.next_token().cat() != catEnd)) {
1037 // something is between the end of the inner box and
1038 // the end of the outer box, so we need to use ERT.
1046 if (!outer_type.empty()) {
1047 if (outer_flags & FLAG_END)
1048 ss << "\\begin{" << outer_type << '}';
1050 ss << '\\' << outer_type << '{';
1051 if (!special.empty())
1055 if (!inner_type.empty()) {
1056 if (inner_type != "shaded") {
1057 if (inner_flags & FLAG_END)
1058 ss << "\\begin{" << inner_type << '}';
1060 ss << '\\' << inner_type;
1062 if (!position.empty())
1063 ss << '[' << position << ']';
1064 if (!latex_height.empty())
1065 ss << '[' << latex_height << ']';
1066 if (!inner_pos.empty())
1067 ss << '[' << inner_pos << ']';
1068 ss << '{' << latex_width << '}';
1069 if (!(inner_flags & FLAG_END))
1072 if (inner_type == "shaded")
1073 ss << "\\begin{shaded}";
1074 output_ert_inset(os, ss.str(), parent_context);
1075 if (!inner_type.empty()) {
1076 parse_text(p, os, inner_flags, outer, parent_context);
1077 if (inner_flags & FLAG_END)
1078 output_ert_inset(os, "\\end{" + inner_type + '}',
1081 output_ert_inset(os, "}", parent_context);
1083 if (!outer_type.empty()) {
1084 // If we already read the inner box we have to pop
1086 if (!inner_type.empty() && (inner_flags & FLAG_END))
1087 active_environments.pop_back();
1089 // Ensure that the end of the outer box is parsed correctly:
1090 // The opening brace has been eaten by parse_outer_box()
1091 if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1092 outer_flags &= ~FLAG_ITEM;
1093 outer_flags |= FLAG_BRACE_LAST;
1095 parse_text(p, os, outer_flags, outer, parent_context);
1096 if (outer_flags & FLAG_END)
1097 output_ert_inset(os, "\\end{" + outer_type + '}',
1100 output_ert_inset(os, "}", parent_context);
1103 // LyX does not like empty positions, so we have
1104 // to set them to the LaTeX default values here.
1105 if (position.empty())
1107 if (inner_pos.empty())
1108 inner_pos = position;
1109 parent_context.check_layout(os);
1110 begin_inset(os, "Box ");
1111 if (outer_type == "framed")
1113 else if (outer_type == "framebox" || outer_type == "fbox" || !frame_color.empty())
1115 else if (outer_type == "shadowbox")
1116 os << "Shadowbox\n";
1117 else if ((outer_type == "shaded" && inner_type.empty()) ||
1118 (outer_type == "minipage" && inner_type == "shaded") ||
1119 (outer_type == "parbox" && inner_type == "shaded")) {
1121 preamble.registerAutomaticallyLoadedPackage("color");
1122 } else if (outer_type == "doublebox")
1123 os << "Doublebox\n";
1124 else if (outer_type.empty() || outer_type == "mbox")
1125 os << "Frameless\n";
1127 os << outer_type << '\n';
1128 os << "position \"" << position << "\"\n";
1129 os << "hor_pos \"" << hor_pos << "\"\n";
1130 if (outer_type == "mbox")
1131 os << "has_inner_box 1\n";
1132 else if (!frame_color.empty() && inner_type == "makebox")
1133 os << "has_inner_box 0\n";
1135 os << "has_inner_box " << !inner_type.empty() << "\n";
1136 os << "inner_pos \"" << inner_pos << "\"\n";
1137 os << "use_parbox " << (inner_type == "parbox" || shadedparbox)
1139 if (outer_type == "mbox")
1140 os << "use_makebox 1\n";
1141 else if (!frame_color.empty())
1142 os << "use_makebox 0\n";
1144 os << "use_makebox " << (inner_type == "makebox") << '\n';
1145 if (outer_type == "mbox" || (outer_type == "fbox" && inner_type.empty()))
1146 os << "width \"\"\n";
1147 // for values like "1.5\width" LyX uses "1.5in" as width ad sets "width" as sepecial
1148 else if (contains(width_unit, '\\'))
1149 os << "width \"" << width_value << "in" << "\"\n";
1151 os << "width \"" << width_value << width_unit << "\"\n";
1152 if (contains(width_unit, '\\')) {
1153 width_unit.erase (0,1); // remove the leading '\'
1154 os << "special \"" << width_unit << "\"\n";
1156 os << "special \"" << width_special << "\"\n";
1157 if (contains(height_unit, '\\'))
1158 os << "height \"" << height_value << "in" << "\"\n";
1160 os << "height \"" << height_value << height_unit << "\"\n";
1161 os << "height_special \"" << height_special << "\"\n";
1162 os << "thickness \"" << thickness << "\"\n";
1163 os << "separation \"" << separation << "\"\n";
1164 os << "shadowsize \"" << shadowsize << "\"\n";
1165 os << "framecolor \"" << framecolor << "\"\n";
1166 os << "backgroundcolor \"" << backgroundcolor << "\"\n";
1167 os << "status open\n\n";
1169 // Unfortunately we can't use parse_text_in_inset:
1170 // InsetBox::forcePlainLayout() is hard coded and does not
1171 // use the inset layout. Apart from that do we call parse_text
1172 // up to two times, but need only one check_end_layout.
1173 bool const forcePlainLayout =
1174 (!inner_type.empty() || inner_type == "makebox") &&
1175 outer_type != "shaded" && outer_type != "framed";
1176 Context context(true, parent_context.textclass);
1177 if (forcePlainLayout)
1178 context.layout = &context.textclass.plainLayout();
1180 context.font = parent_context.font;
1182 // If we have no inner box the contents will be read with the outer box
1183 if (!inner_type.empty())
1184 parse_text(p, os, inner_flags, outer, context);
1186 // Ensure that the end of the outer box is parsed correctly:
1187 // The opening brace has been eaten by parse_outer_box()
1188 if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1189 outer_flags &= ~FLAG_ITEM;
1190 outer_flags |= FLAG_BRACE_LAST;
1193 // Find end of outer box, output contents if inner_type is
1194 // empty and output possible comments
1195 if (!outer_type.empty()) {
1196 // If we already read the inner box we have to pop
1198 if (!inner_type.empty() && (inner_flags & FLAG_END))
1199 active_environments.pop_back();
1200 // This does not output anything but comments if
1201 // inner_type is not empty (see use_ert)
1202 parse_text(p, os, outer_flags, outer, context);
1205 context.check_end_layout(os);
1207 #ifdef PRESERVE_LAYOUT
1208 // LyX puts a % after the end of the minipage
1209 if (p.next_token().cat() == catNewline && p.next_token().cs().size() > 1) {
1211 //output_comment(p, os, "dummy", parent_context);
1214 parent_context.new_paragraph(os);
1216 else if (p.next_token().cat() == catSpace || p.next_token().cat() == catNewline) {
1217 //output_comment(p, os, "dummy", parent_context);
1220 // We add a protected space if something real follows
1221 if (p.good() && p.next_token().cat() != catComment) {
1222 begin_inset(os, "space ~\n");
1228 if (inner_type == "minipage" && (!frame_color.empty() || !background_color.empty()))
1229 active_environments.pop_back();
1230 if (inner_flags != FLAG_BRACE_LAST && (!frame_color.empty() || !background_color.empty())) {
1231 // in this case we have to eat the the closing brace of the color box
1232 p.get_token().asInput(); // the '}'
1234 if (p.next_token().asInput() == "}") {
1235 // in this case we assume that the closing brace is from the box settings
1236 // therefore reset these values for the next box
1242 // all boxes except of Frameless and Shaded require calc
1243 if (!(outer_type.empty() || outer_type == "mbox") &&
1244 !((outer_type == "shaded" && inner_type.empty()) ||
1245 (outer_type == "minipage" && inner_type == "shaded") ||
1246 (outer_type == "parbox" && inner_type == "shaded")))
1247 preamble.registerAutomaticallyLoadedPackage("calc");
1251 void parse_outer_box(Parser & p, ostream & os, unsigned flags, bool outer,
1252 Context & parent_context, string const & outer_type,
1253 string const & special)
1255 eat_whitespace(p, os, parent_context, false);
1256 if (flags & FLAG_ITEM) {
1258 if (p.next_token().cat() == catBegin)
1261 cerr << "Warning: Ignoring missing '{' after \\"
1262 << outer_type << '.' << endl;
1263 eat_whitespace(p, os, parent_context, false);
1266 unsigned int inner_flags = 0;
1268 if (outer_type == "minipage" || outer_type == "parbox") {
1269 p.skip_spaces(true);
1270 while (p.hasOpt()) {
1272 p.skip_spaces(true);
1275 p.skip_spaces(true);
1276 if (outer_type == "parbox") {
1278 if (p.next_token().cat() == catBegin)
1280 p.skip_spaces(true);
1283 if (outer_type == "shaded" || outer_type == "mbox") {
1284 // These boxes never have an inner box
1286 } else if (p.next_token().asInput() == "\\parbox") {
1287 inner = p.get_token().cs();
1288 inner_flags = FLAG_ITEM;
1289 } else if (p.next_token().asInput() == "\\begin") {
1290 // Is this a minipage or shaded box?
1293 inner = p.getArg('{', '}');
1295 if (inner == "minipage" || inner == "shaded")
1296 inner_flags = FLAG_END;
1301 if (inner_flags == FLAG_END) {
1302 if (inner != "shaded")
1306 eat_whitespace(p, os, parent_context, false);
1308 parse_box(p, os, flags, FLAG_END, outer, parent_context,
1309 outer_type, special, inner, "", "");
1311 if (inner_flags == FLAG_ITEM) {
1313 eat_whitespace(p, os, parent_context, false);
1315 parse_box(p, os, flags, inner_flags, outer, parent_context,
1316 outer_type, special, inner, "", "");
1321 void parse_listings(Parser & p, ostream & os, Context & parent_context,
1322 bool in_line, bool use_minted)
1324 parent_context.check_layout(os);
1325 begin_inset(os, "listings\n");
1326 string arg = p.hasOpt() ? subst(p.verbatimOption(), "\n", "") : string();
1328 while ((i = arg.find(", ")) != string::npos
1329 || (i = arg.find(",\t")) != string::npos)
1330 arg.erase(i + 1, 1);
1333 string const language = p.getArg('{', '}');
1334 p.skip_spaces(true);
1335 arg += string(arg.empty() ? "" : ",") + "language=" + language;
1336 if (!minted_float.empty()) {
1337 arg += string(arg.empty() ? "" : ",") + minted_float;
1338 minted_nonfloat_caption.clear();
1342 os << "lstparams " << '"' << arg << '"' << '\n';
1343 if (arg.find("\\color") != string::npos)
1344 preamble.registerAutomaticallyLoadedPackage("color");
1347 os << "inline true\n";
1349 os << "inline false\n";
1350 os << "status collapsed\n";
1351 Context context(true, parent_context.textclass);
1352 context.layout = &parent_context.textclass.plainLayout();
1353 if (use_minted && prefixIs(minted_nonfloat_caption, "[t]")) {
1354 minted_nonfloat_caption.erase(0,3);
1355 os << "\n\\begin_layout Plain Layout\n";
1356 begin_inset(os, "Caption Standard\n");
1357 Context newcontext(true, context.textclass,
1358 context.layout, 0, context.font);
1359 newcontext.check_layout(os);
1360 os << minted_nonfloat_caption << "\n";
1361 newcontext.check_end_layout(os);
1363 os << "\n\\end_layout\n";
1364 minted_nonfloat_caption.clear();
1368 // set catcodes to verbatim early, just in case.
1369 p.setCatcodes(VERBATIM_CATCODES);
1370 string delim = p.get_token().asInput();
1371 //FIXME: handler error condition
1372 s = p.verbatimStuff(delim).second;
1373 // context.new_paragraph(os);
1374 } else if (use_minted) {
1375 s = p.verbatimEnvironment("minted");
1377 s = p.verbatimEnvironment("lstlisting");
1379 output_ert(os, s, context);
1380 if (use_minted && prefixIs(minted_nonfloat_caption, "[b]")) {
1381 minted_nonfloat_caption.erase(0,3);
1382 os << "\n\\begin_layout Plain Layout\n";
1383 begin_inset(os, "Caption Standard\n");
1384 Context newcontext(true, context.textclass,
1385 context.layout, 0, context.font);
1386 newcontext.check_layout(os);
1387 os << minted_nonfloat_caption << "\n";
1388 newcontext.check_end_layout(os);
1390 os << "\n\\end_layout\n";
1391 minted_nonfloat_caption.clear();
1393 // Don't close the inset here for floating minted listings.
1394 // It will be closed at the end of the listing environment.
1395 if (!use_minted || minted_float.empty())
1398 eat_whitespace(p, os, parent_context, true);
1399 Token t = p.get_token();
1400 if (t.asInput() != "\\end") {
1401 // If anything follows, collect it into a caption.
1402 minted_float_has_caption = true;
1403 os << "\n\\begin_layout Plain Layout\n"; // outer layout
1404 begin_inset(os, "Caption Standard\n");
1405 os << "\n\\begin_layout Plain Layout\n"; // inner layout
1412 /// parse an unknown environment
1413 void parse_unknown_environment(Parser & p, string const & name, ostream & os,
1414 unsigned flags, bool outer,
1415 Context & parent_context)
1417 if (name == "tabbing")
1418 // We need to remember that we have to handle '\=' specially
1419 flags |= FLAG_TABBING;
1421 // We need to translate font changes and paragraphs inside the
1422 // environment to ERT if we have a non standard font.
1423 // Otherwise things like
1424 // \large\begin{foo}\huge bar\end{foo}
1426 bool const specialfont =
1427 (parent_context.font != parent_context.normalfont);
1428 bool const new_layout_allowed = parent_context.new_layout_allowed;
1430 parent_context.new_layout_allowed = false;
1431 output_ert_inset(os, "\\begin{" + name + "}", parent_context);
1432 parse_text_snippet(p, os, flags, outer, parent_context);
1433 output_ert_inset(os, "\\end{" + name + "}", parent_context);
1435 parent_context.new_layout_allowed = new_layout_allowed;
1439 void parse_environment(Parser & p, ostream & os, bool outer,
1440 string & last_env, Context & parent_context)
1442 Layout const * newlayout;
1443 InsetLayout const * newinsetlayout = 0;
1444 string const name = p.getArg('{', '}');
1445 const bool is_starred = suffixIs(name, '*');
1446 string const unstarred_name = rtrim(name, "*");
1447 active_environments.push_back(name);
1449 if (is_math_env(name)) {
1450 parent_context.check_layout(os);
1451 begin_inset(os, "Formula ");
1452 os << "\\begin{" << name << "}";
1453 parse_math(p, os, FLAG_END, MATH_MODE);
1454 os << "\\end{" << name << "}";
1456 if (is_display_math_env(name)) {
1457 // Prevent the conversion of a line break to a space
1458 // (bug 7668). This does not change the output, but
1459 // looks ugly in LyX.
1460 eat_whitespace(p, os, parent_context, false);
1464 else if (is_known(name, preamble.polyglossia_languages)) {
1465 // We must begin a new paragraph if not already done
1466 if (! parent_context.atParagraphStart()) {
1467 parent_context.check_end_layout(os);
1468 parent_context.new_paragraph(os);
1470 // save the language in the context so that it is
1471 // handled by parse_text
1472 parent_context.font.language = preamble.polyglossia2lyx(name);
1473 parse_text(p, os, FLAG_END, outer, parent_context);
1474 // Just in case the environment is empty
1475 parent_context.extra_stuff.erase();
1476 // We must begin a new paragraph to reset the language
1477 parent_context.new_paragraph(os);
1481 else if (unstarred_name == "tabular" || name == "longtable") {
1482 eat_whitespace(p, os, parent_context, false);
1483 string width = "0pt";
1484 if (name == "tabular*") {
1485 width = lyx::translate_len(p.getArg('{', '}'));
1486 eat_whitespace(p, os, parent_context, false);
1488 parent_context.check_layout(os);
1489 begin_inset(os, "Tabular ");
1490 handle_tabular(p, os, name, width, parent_context);
1495 else if (parent_context.textclass.floats().typeExist(unstarred_name)) {
1496 eat_whitespace(p, os, parent_context, false);
1497 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1498 eat_whitespace(p, os, parent_context, false);
1499 parent_context.check_layout(os);
1500 begin_inset(os, "Float " + unstarred_name + "\n");
1501 // store the float type for subfloats
1502 // subfloats only work with figures and tables
1503 if (unstarred_name == "figure")
1504 float_type = unstarred_name;
1505 else if (unstarred_name == "table")
1506 float_type = unstarred_name;
1510 os << "placement " << opt << '\n';
1511 if (contains(opt, "H"))
1512 preamble.registerAutomaticallyLoadedPackage("float");
1514 Floating const & fl = parent_context.textclass.floats()
1515 .getType(unstarred_name);
1516 if (!fl.floattype().empty() && fl.usesFloatPkg())
1517 preamble.registerAutomaticallyLoadedPackage("float");
1520 os << "wide " << convert<string>(is_starred)
1521 << "\nsideways false"
1522 << "\nstatus open\n\n";
1523 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1525 // We don't need really a new paragraph, but
1526 // we must make sure that the next item gets a \begin_layout.
1527 parent_context.new_paragraph(os);
1529 // the float is parsed thus delete the type
1533 else if (unstarred_name == "sidewaysfigure"
1534 || unstarred_name == "sidewaystable"
1535 || unstarred_name == "sidewaysalgorithm") {
1536 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1537 eat_whitespace(p, os, parent_context, false);
1538 parent_context.check_layout(os);
1539 if (unstarred_name == "sidewaysfigure")
1540 begin_inset(os, "Float figure\n");
1541 else if (unstarred_name == "sidewaystable")
1542 begin_inset(os, "Float table\n");
1543 else if (unstarred_name == "sidewaysalgorithm")
1544 begin_inset(os, "Float algorithm\n");
1546 os << "placement " << opt << '\n';
1547 if (contains(opt, "H"))
1548 preamble.registerAutomaticallyLoadedPackage("float");
1549 os << "wide " << convert<string>(is_starred)
1550 << "\nsideways true"
1551 << "\nstatus open\n\n";
1552 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1554 // We don't need really a new paragraph, but
1555 // we must make sure that the next item gets a \begin_layout.
1556 parent_context.new_paragraph(os);
1558 preamble.registerAutomaticallyLoadedPackage("rotfloat");
1561 else if (name == "wrapfigure" || name == "wraptable") {
1562 // syntax is \begin{wrapfigure}[lines]{placement}[overhang]{width}
1563 eat_whitespace(p, os, parent_context, false);
1564 parent_context.check_layout(os);
1567 string overhang = "0col%";
1570 lines = p.getArg('[', ']');
1571 string const placement = p.getArg('{', '}');
1573 overhang = p.getArg('[', ']');
1574 string const width = p.getArg('{', '}');
1576 if (name == "wrapfigure")
1577 begin_inset(os, "Wrap figure\n");
1579 begin_inset(os, "Wrap table\n");
1580 os << "lines " << lines
1581 << "\nplacement " << placement
1582 << "\noverhang " << lyx::translate_len(overhang)
1583 << "\nwidth " << lyx::translate_len(width)
1584 << "\nstatus open\n\n";
1585 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1587 // We don't need really a new paragraph, but
1588 // we must make sure that the next item gets a \begin_layout.
1589 parent_context.new_paragraph(os);
1591 preamble.registerAutomaticallyLoadedPackage("wrapfig");
1594 else if (name == "minipage") {
1595 eat_whitespace(p, os, parent_context, false);
1596 // Test whether this is an outer box of a shaded box
1598 // swallow arguments
1599 while (p.hasOpt()) {
1601 p.skip_spaces(true);
1604 p.skip_spaces(true);
1605 Token t = p.get_token();
1606 bool shaded = false;
1607 if (t.asInput() == "\\begin") {
1608 p.skip_spaces(true);
1609 if (p.getArg('{', '}') == "shaded")
1614 parse_outer_box(p, os, FLAG_END, outer,
1615 parent_context, name, "shaded");
1617 parse_box(p, os, 0, FLAG_END, outer, parent_context,
1618 "", "", name, "", "");
1622 else if (name == "comment") {
1623 eat_whitespace(p, os, parent_context, false);
1624 parent_context.check_layout(os);
1625 begin_inset(os, "Note Comment\n");
1626 os << "status open\n";
1627 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1630 skip_braces(p); // eat {} that might by set by LyX behind comments
1631 preamble.registerAutomaticallyLoadedPackage("verbatim");
1634 else if (unstarred_name == "verbatim") {
1635 // FIXME: this should go in the generic code that
1636 // handles environments defined in layout file that
1637 // have "PassThru 1". However, the code over there is
1638 // already too complicated for my taste.
1639 string const ascii_name =
1640 (name == "verbatim*") ? "Verbatim*" : "Verbatim";
1641 parent_context.new_paragraph(os);
1642 Context context(true, parent_context.textclass,
1643 &parent_context.textclass[from_ascii(ascii_name)]);
1644 string s = p.verbatimEnvironment(name);
1645 output_ert(os, s, context);
1649 else if (name == "IPA") {
1650 eat_whitespace(p, os, parent_context, false);
1651 parent_context.check_layout(os);
1652 begin_inset(os, "IPA\n");
1653 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1656 preamble.registerAutomaticallyLoadedPackage("tipa");
1657 preamble.registerAutomaticallyLoadedPackage("tipx");
1660 else if (name == "CJK") {
1661 // the scheme is \begin{CJK}{encoding}{mapping}text\end{CJK}
1662 // It is impossible to decide if a CJK environment was in its own paragraph or within
1663 // a line. We therefore always assume a paragraph since the latter is a rare case.
1664 eat_whitespace(p, os, parent_context, false);
1665 parent_context.check_end_layout(os);
1666 // store the encoding to be able to reset it
1667 string const encoding_old = p.getEncoding();
1668 string const encoding = p.getArg('{', '}');
1669 // FIXME: For some reason JIS does not work. Although the text
1670 // in tests/CJK.tex is identical with the SJIS version if you
1671 // convert both snippets using the recode command line utility,
1672 // the resulting .lyx file contains some extra characters if
1673 // you set buggy_encoding to false for JIS.
1674 bool const buggy_encoding = encoding == "JIS";
1675 if (!buggy_encoding)
1676 p.setEncoding(encoding, Encoding::CJK);
1678 // FIXME: This will read garbage, since the data is not encoded in utf8.
1679 p.setEncoding("UTF-8");
1681 // LyX only supports the same mapping for all CJK
1682 // environments, so we might need to output everything as ERT
1683 string const mapping = trim(p.getArg('{', '}'));
1684 char const * const * const where =
1685 is_known(encoding, supported_CJK_encodings);
1686 if (!buggy_encoding && !preamble.fontCJKSet())
1687 preamble.fontCJK(mapping);
1688 bool knownMapping = mapping == preamble.fontCJK();
1689 if (buggy_encoding || !knownMapping || !where) {
1690 parent_context.check_layout(os);
1691 output_ert_inset(os, "\\begin{" + name + "}{" + encoding + "}{" + mapping + "}",
1693 // we must parse the content as verbatim because e.g. JIS can contain
1694 // normally invalid characters
1695 // FIXME: This works only for the most simple cases.
1696 // Since TeX control characters are not parsed,
1697 // things like comments are completely wrong.
1698 string const s = p.plainEnvironment("CJK");
1699 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
1701 output_ert_inset(os, "\\", parent_context);
1702 else if (*it == '$')
1703 output_ert_inset(os, "$", parent_context);
1704 else if (*it == '\n' && it + 1 != et && s.begin() + 1 != it)
1709 output_ert_inset(os, "\\end{" + name + "}",
1713 supported_CJK_languages[where - supported_CJK_encodings];
1714 // store the language because we must reset it at the end
1715 string const lang_old = parent_context.font.language;
1716 parent_context.font.language = lang;
1717 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1718 parent_context.font.language = lang_old;
1719 parent_context.new_paragraph(os);
1721 p.setEncoding(encoding_old);
1725 else if (name == "lyxgreyedout") {
1726 eat_whitespace(p, os, parent_context, false);
1727 parent_context.check_layout(os);
1728 begin_inset(os, "Note Greyedout\n");
1729 os << "status open\n";
1730 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1733 if (!preamble.notefontcolor().empty())
1734 preamble.registerAutomaticallyLoadedPackage("color");
1737 else if (name == "btSect") {
1738 eat_whitespace(p, os, parent_context, false);
1739 parent_context.check_layout(os);
1740 begin_command_inset(os, "bibtex", "bibtex");
1741 string bibstyle = "plain";
1743 bibstyle = p.getArg('[', ']');
1744 p.skip_spaces(true);
1746 string const bibfile = p.getArg('{', '}');
1747 eat_whitespace(p, os, parent_context, false);
1748 Token t = p.get_token();
1749 if (t.asInput() == "\\btPrintCited") {
1750 p.skip_spaces(true);
1751 os << "btprint " << '"' << "btPrintCited" << '"' << "\n";
1753 if (t.asInput() == "\\btPrintNotCited") {
1754 p.skip_spaces(true);
1755 os << "btprint " << '"' << "btPrintNotCited" << '"' << "\n";
1757 if (t.asInput() == "\\btPrintAll") {
1758 p.skip_spaces(true);
1759 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
1761 os << "bibfiles " << '"' << bibfile << "\"\n"
1762 << "options " << '"' << bibstyle << "\"\n";
1763 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1768 else if (name == "framed" || name == "shaded") {
1769 eat_whitespace(p, os, parent_context, false);
1770 parse_outer_box(p, os, FLAG_END, outer, parent_context, name, "");
1772 preamble.registerAutomaticallyLoadedPackage("framed");
1775 else if (name == "listing") {
1776 minted_float = "float";
1777 eat_whitespace(p, os, parent_context, false);
1778 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1780 minted_float += "=" + opt;
1781 // If something precedes \begin{minted}, we output it at the end
1782 // as a caption, in order to keep it inside the listings inset.
1783 eat_whitespace(p, os, parent_context, true);
1785 Token const & t = p.get_token();
1786 p.skip_spaces(true);
1787 string const envname = p.next_token().cat() == catBegin
1788 ? p.getArg('{', '}') : string();
1789 bool prologue = t.asInput() != "\\begin" || envname != "minted";
1791 minted_float_has_caption = false;
1792 string content = parse_text_snippet(p, FLAG_END, outer,
1794 size_t i = content.find("\\begin_inset listings");
1795 bool minted_env = i != string::npos;
1798 caption = content.substr(0, i);
1799 content.erase(0, i);
1801 parent_context.check_layout(os);
1802 if (minted_env && minted_float_has_caption) {
1803 eat_whitespace(p, os, parent_context, true);
1804 os << content << "\n";
1805 if (!caption.empty())
1806 os << caption << "\n";
1807 os << "\n\\end_layout\n"; // close inner layout
1808 end_inset(os); // close caption inset
1809 os << "\n\\end_layout\n"; // close outer layout
1810 } else if (!caption.empty()) {
1812 begin_inset(os, "listings\n");
1813 os << "lstparams " << '"' << minted_float << '"' << '\n';
1814 os << "inline false\n";
1815 os << "status collapsed\n";
1817 os << "\n\\begin_layout Plain Layout\n";
1818 begin_inset(os, "Caption Standard\n");
1819 Context newcontext(true, parent_context.textclass,
1820 0, 0, parent_context.font);
1821 newcontext.check_layout(os);
1822 os << caption << "\n";
1823 newcontext.check_end_layout(os);
1825 os << "\n\\end_layout\n";
1826 } else if (content.empty()) {
1827 begin_inset(os, "listings\n");
1828 os << "lstparams " << '"' << minted_float << '"' << '\n';
1829 os << "inline false\n";
1830 os << "status collapsed\n";
1832 os << content << "\n";
1834 end_inset(os); // close listings inset
1835 parent_context.check_end_layout(os);
1836 parent_context.new_paragraph(os);
1838 minted_float.clear();
1839 minted_float_has_caption = false;
1842 else if (name == "lstlisting" || name == "minted") {
1843 bool use_minted = name == "minted";
1844 eat_whitespace(p, os, parent_context, false);
1845 if (use_minted && minted_float.empty()) {
1846 // look ahead for a bottom caption
1848 bool found_end_minted = false;
1849 while (!found_end_minted && p.good()) {
1850 Token const & t = p.get_token();
1852 string const envname =
1853 p.next_token().cat() == catBegin
1854 ? p.getArg('{', '}') : string();
1855 found_end_minted = t.asInput() == "\\end"
1856 && envname == "minted";
1858 eat_whitespace(p, os, parent_context, true);
1859 Token const & t = p.get_token();
1860 p.skip_spaces(true);
1861 if (t.asInput() == "\\lyxmintcaption") {
1862 string const pos = p.getArg('[', ']');
1864 string const caption =
1865 parse_text_snippet(p, FLAG_ITEM,
1866 false, parent_context);
1867 minted_nonfloat_caption = "[b]" + caption;
1872 parse_listings(p, os, parent_context, false, use_minted);
1876 else if (!parent_context.new_layout_allowed)
1877 parse_unknown_environment(p, name, os, FLAG_END, outer,
1880 // Alignment and spacing settings
1881 // FIXME (bug xxxx): These settings can span multiple paragraphs and
1882 // therefore are totally broken!
1883 // Note that \centering, \raggedright, and \raggedleft cannot be handled, as
1884 // they are commands not environments. They are furthermore switches that
1885 // can be ended by another switches, but also by commands like \footnote or
1886 // \parbox. So the only safe way is to leave them untouched.
1887 // However, we support the pseudo-environments
1888 // \begin{centering} ... \end{centering}
1889 // \begin{raggedright} ... \end{raggedright}
1890 // \begin{raggedleft} ... \end{raggedleft}
1891 // since they are used by LyX in floats (for spacing reasons)
1892 else if (name == "center" || name == "centering" ||
1893 name == "flushleft" || name == "raggedright" ||
1894 name == "flushright" || name == "raggedleft" ||
1895 name == "singlespace" || name == "onehalfspace" ||
1896 name == "doublespace" || name == "spacing") {
1897 eat_whitespace(p, os, parent_context, false);
1898 // We must begin a new paragraph if not already done
1899 if (! parent_context.atParagraphStart()) {
1900 parent_context.check_end_layout(os);
1901 parent_context.new_paragraph(os);
1903 if (name == "flushleft" || name == "raggedright")
1904 parent_context.add_extra_stuff("\\align left\n");
1905 else if (name == "flushright" || name == "raggedleft")
1906 parent_context.add_extra_stuff("\\align right\n");
1907 else if (name == "center" || name == "centering")
1908 parent_context.add_extra_stuff("\\align center\n");
1909 else if (name == "singlespace")
1910 parent_context.add_extra_stuff("\\paragraph_spacing single\n");
1911 else if (name == "onehalfspace") {
1912 parent_context.add_extra_stuff("\\paragraph_spacing onehalf\n");
1913 preamble.registerAutomaticallyLoadedPackage("setspace");
1914 } else if (name == "doublespace") {
1915 parent_context.add_extra_stuff("\\paragraph_spacing double\n");
1916 preamble.registerAutomaticallyLoadedPackage("setspace");
1917 } else if (name == "spacing") {
1918 parent_context.add_extra_stuff("\\paragraph_spacing other " + p.verbatim_item() + "\n");
1919 preamble.registerAutomaticallyLoadedPackage("setspace");
1921 parse_text(p, os, FLAG_END, outer, parent_context);
1922 // Just in case the environment is empty
1923 parent_context.extra_stuff.erase();
1924 // We must begin a new paragraph to reset the alignment
1925 parent_context.new_paragraph(os);
1929 // The single '=' is meant here.
1930 else if ((newlayout = findLayout(parent_context.textclass, name, false))) {
1931 eat_whitespace(p, os, parent_context, false);
1932 Context context(true, parent_context.textclass, newlayout,
1933 parent_context.layout, parent_context.font);
1934 if (parent_context.deeper_paragraph) {
1935 // We are beginning a nested environment after a
1936 // deeper paragraph inside the outer list environment.
1937 // Therefore we don't need to output a "begin deeper".
1938 context.need_end_deeper = true;
1940 parent_context.check_end_layout(os);
1941 if (last_env == name) {
1942 // we need to output a separator since LyX would export
1943 // the two environments as one otherwise (bug 5716)
1944 TeX2LyXDocClass const & textclass(parent_context.textclass);
1945 Context newcontext(true, textclass,
1946 &(textclass.defaultLayout()));
1947 newcontext.check_layout(os);
1948 begin_inset(os, "Separator plain\n");
1950 newcontext.check_end_layout(os);
1952 switch (context.layout->latextype) {
1953 case LATEX_LIST_ENVIRONMENT:
1954 context.add_par_extra_stuff("\\labelwidthstring "
1955 + p.verbatim_item() + '\n');
1958 case LATEX_BIB_ENVIRONMENT:
1959 p.verbatim_item(); // swallow next arg
1965 context.check_deeper(os);
1966 // handle known optional and required arguments
1967 // Unfortunately LyX can't handle arguments of list arguments (bug 7468):
1968 // It is impossible to place anything after the environment name,
1969 // but before the first \\item.
1970 if (context.layout->latextype == LATEX_ENVIRONMENT)
1971 output_arguments(os, p, outer, false, false, context,
1972 context.layout->latexargs());
1973 parse_text(p, os, FLAG_END, outer, context);
1974 if (context.layout->latextype == LATEX_ENVIRONMENT)
1975 output_arguments(os, p, outer, false, true, context,
1976 context.layout->postcommandargs());
1977 context.check_end_layout(os);
1978 if (parent_context.deeper_paragraph) {
1979 // We must suppress the "end deeper" because we
1980 // suppressed the "begin deeper" above.
1981 context.need_end_deeper = false;
1983 context.check_end_deeper(os);
1984 parent_context.new_paragraph(os);
1986 if (!preamble.titleLayoutFound())
1987 preamble.titleLayoutFound(newlayout->intitle);
1988 set<string> const & req = newlayout->requires();
1989 set<string>::const_iterator it = req.begin();
1990 set<string>::const_iterator en = req.end();
1991 for (; it != en; ++it)
1992 preamble.registerAutomaticallyLoadedPackage(*it);
1995 // The single '=' is meant here.
1996 else if ((newinsetlayout = findInsetLayout(parent_context.textclass, name, false))) {
1997 eat_whitespace(p, os, parent_context, false);
1998 parent_context.check_layout(os);
1999 begin_inset(os, "Flex ");
2000 os << to_utf8(newinsetlayout->name()) << '\n'
2001 << "status collapsed\n";
2002 if (newinsetlayout->isPassThru()) {
2003 string const arg = p.verbatimEnvironment(name);
2004 Context context(true, parent_context.textclass,
2005 &parent_context.textclass.plainLayout(),
2006 parent_context.layout);
2007 output_ert(os, arg, parent_context);
2009 parse_text_in_inset(p, os, FLAG_END, false, parent_context, newinsetlayout);
2013 else if (name == "appendix") {
2014 // This is no good latex style, but it works and is used in some documents...
2015 eat_whitespace(p, os, parent_context, false);
2016 parent_context.check_end_layout(os);
2017 Context context(true, parent_context.textclass, parent_context.layout,
2018 parent_context.layout, parent_context.font);
2019 context.check_layout(os);
2020 os << "\\start_of_appendix\n";
2021 parse_text(p, os, FLAG_END, outer, context);
2022 context.check_end_layout(os);
2026 else if (known_environments.find(name) != known_environments.end()) {
2027 vector<ArgumentType> arguments = known_environments[name];
2028 // The last "argument" denotes wether we may translate the
2029 // environment contents to LyX
2030 // The default required if no argument is given makes us
2031 // compatible with the reLyXre environment.
2032 ArgumentType contents = arguments.empty() ?
2035 if (!arguments.empty())
2036 arguments.pop_back();
2037 // See comment in parse_unknown_environment()
2038 bool const specialfont =
2039 (parent_context.font != parent_context.normalfont);
2040 bool const new_layout_allowed =
2041 parent_context.new_layout_allowed;
2043 parent_context.new_layout_allowed = false;
2044 parse_arguments("\\begin{" + name + "}", arguments, p, os,
2045 outer, parent_context);
2046 if (contents == verbatim)
2047 output_ert_inset(os, p.ertEnvironment(name),
2050 parse_text_snippet(p, os, FLAG_END, outer,
2052 output_ert_inset(os, "\\end{" + name + "}", parent_context);
2054 parent_context.new_layout_allowed = new_layout_allowed;
2058 parse_unknown_environment(p, name, os, FLAG_END, outer,
2062 active_environments.pop_back();
2066 /// parses a comment and outputs it to \p os.
2067 void parse_comment(Parser & p, ostream & os, Token const & t, Context & context)
2069 LASSERT(t.cat() == catComment, return);
2070 if (!t.cs().empty()) {
2071 context.check_layout(os);
2072 output_comment(p, os, t.cs(), context);
2073 if (p.next_token().cat() == catNewline) {
2074 // A newline after a comment line starts a new
2076 if (context.new_layout_allowed) {
2077 if(!context.atParagraphStart())
2078 // Only start a new paragraph if not already
2079 // done (we might get called recursively)
2080 context.new_paragraph(os);
2082 output_ert_inset(os, "\n", context);
2083 eat_whitespace(p, os, context, true);
2086 // "%\n" combination
2093 * Reads spaces and comments until the first non-space, non-comment token.
2094 * New paragraphs (double newlines or \\par) are handled like simple spaces
2095 * if \p eatParagraph is true.
2096 * Spaces are skipped, but comments are written to \p os.
2098 void eat_whitespace(Parser & p, ostream & os, Context & context,
2102 Token const & t = p.get_token();
2103 if (t.cat() == catComment)
2104 parse_comment(p, os, t, context);
2105 else if ((! eatParagraph && p.isParagraph()) ||
2106 (t.cat() != catSpace && t.cat() != catNewline)) {
2115 * Set a font attribute, parse text and reset the font attribute.
2116 * \param attribute Attribute name (e.g. \\family, \\shape etc.)
2117 * \param currentvalue Current value of the attribute. Is set to the new
2118 * value during parsing.
2119 * \param newvalue New value of the attribute
2121 void parse_text_attributes(Parser & p, ostream & os, unsigned flags, bool outer,
2122 Context & context, string const & attribute,
2123 string & currentvalue, string const & newvalue)
2125 context.check_layout(os);
2126 string const oldvalue = currentvalue;
2127 currentvalue = newvalue;
2128 os << '\n' << attribute << ' ' << newvalue << "\n";
2129 parse_text_snippet(p, os, flags, outer, context);
2130 context.check_layout(os);
2131 os << '\n' << attribute << ' ' << oldvalue << "\n";
2132 currentvalue = oldvalue;
2136 /// get the arguments of a natbib or jurabib citation command
2137 void get_cite_arguments(Parser & p, bool natbibOrder,
2138 string & before, string & after, bool const qualified = false)
2140 // We need to distinguish "" and "[]", so we can't use p.getOpt().
2142 // text before the citation
2144 // text after the citation
2145 after = qualified ? p.getFullOpt(false, '(', ')') : p.getFullOpt();
2147 if (!after.empty()) {
2148 before = qualified ? p.getFullOpt(false, '(', ')') : p.getFullOpt();
2149 if (natbibOrder && !before.empty())
2150 swap(before, after);
2155 void copy_file(FileName const & src, string dstname)
2159 string const absParent = getParentFilePath(false);
2161 if (FileName::isAbsolute(dstname))
2162 dst = FileName(dstname);
2164 dst = makeAbsPath(dstname, absParent);
2165 FileName const srcpath = src.onlyPath();
2166 FileName const dstpath = dst.onlyPath();
2167 if (equivalent(srcpath, dstpath))
2169 if (!dstpath.isDirectory()) {
2170 if (!dstpath.createPath()) {
2171 cerr << "Warning: Could not create directory for file `"
2172 << dst.absFileName() << "´." << endl;
2176 if (dst.isReadableFile()) {
2177 if (overwriteFiles())
2178 cerr << "Warning: Overwriting existing file `"
2179 << dst.absFileName() << "´." << endl;
2181 cerr << "Warning: Not overwriting existing file `"
2182 << dst.absFileName() << "´." << endl;
2186 if (!src.copyTo(dst))
2187 cerr << "Warning: Could not copy file `" << src.absFileName()
2188 << "´ to `" << dst.absFileName() << "´." << endl;
2192 /// Parse a literate Chunk section. The initial "<<" is already parsed.
2193 bool parse_chunk(Parser & p, ostream & os, Context & context)
2195 // check whether a chunk is possible here.
2196 if (!context.textclass.hasInsetLayout(from_ascii("Flex:Chunk"))) {
2202 // read the parameters
2203 Parser::Arg const params = p.verbatimStuff(">>=\n", false);
2204 if (!params.first) {
2209 Parser::Arg const code = p.verbatimStuff("\n@");
2214 string const post_chunk = p.verbatimStuff("\n").second + '\n';
2215 if (post_chunk[0] != ' ' && post_chunk[0] != '\n') {
2219 // The last newline read is important for paragraph handling
2223 //cerr << "params=[" << params.second << "], code=[" << code.second << "]" <<endl;
2224 // We must have a valid layout before outputting the Chunk inset.
2225 context.check_layout(os);
2226 Context chunkcontext(true, context.textclass);
2227 chunkcontext.layout = &context.textclass.plainLayout();
2228 begin_inset(os, "Flex Chunk");
2229 os << "\nstatus open\n";
2230 if (!params.second.empty()) {
2231 chunkcontext.check_layout(os);
2232 Context paramscontext(true, context.textclass);
2233 paramscontext.layout = &context.textclass.plainLayout();
2234 begin_inset(os, "Argument 1");
2235 os << "\nstatus open\n";
2236 output_ert(os, params.second, paramscontext);
2239 output_ert(os, code.second, chunkcontext);
2247 /// detects \\def, \\long\\def and \\global\\long\\def with ws and comments
2248 bool is_macro(Parser & p)
2250 Token first = p.curr_token();
2251 if (first.cat() != catEscape || !p.good())
2253 if (first.cs() == "def")
2255 if (first.cs() != "global" && first.cs() != "long")
2257 Token second = p.get_token();
2259 while (p.good() && !p.isParagraph() && (second.cat() == catSpace ||
2260 second.cat() == catNewline || second.cat() == catComment)) {
2261 second = p.get_token();
2264 bool secondvalid = second.cat() == catEscape;
2266 bool thirdvalid = false;
2267 if (p.good() && first.cs() == "global" && secondvalid &&
2268 second.cs() == "long") {
2269 third = p.get_token();
2271 while (p.good() && !p.isParagraph() &&
2272 (third.cat() == catSpace ||
2273 third.cat() == catNewline ||
2274 third.cat() == catComment)) {
2275 third = p.get_token();
2278 thirdvalid = third.cat() == catEscape;
2280 for (int i = 0; i < pos; ++i)
2285 return (first.cs() == "global" || first.cs() == "long") &&
2286 second.cs() == "def";
2287 return first.cs() == "global" && second.cs() == "long" &&
2288 third.cs() == "def";
2292 /// Parse a macro definition (assumes that is_macro() returned true)
2293 void parse_macro(Parser & p, ostream & os, Context & context)
2295 context.check_layout(os);
2296 Token first = p.curr_token();
2299 string command = first.asInput();
2300 if (first.cs() != "def") {
2302 eat_whitespace(p, os, context, false);
2303 second = p.curr_token();
2304 command += second.asInput();
2305 if (second.cs() != "def") {
2307 eat_whitespace(p, os, context, false);
2308 third = p.curr_token();
2309 command += third.asInput();
2312 eat_whitespace(p, os, context, false);
2313 string const name = p.get_token().cs();
2314 eat_whitespace(p, os, context, false);
2320 while (p.next_token().cat() != catBegin) {
2321 if (p.next_token().cat() == catParameter) {
2326 // followed by number?
2327 if (p.next_token().cat() == catOther) {
2328 string s = p.get_token().asInput();
2330 // number = current arity + 1?
2331 if (s.size() == 1 && s[0] == arity + '0' + 1)
2336 paramtext += p.get_token().cs();
2338 paramtext += p.get_token().cs();
2343 // only output simple (i.e. compatible) macro as FormulaMacros
2344 string ert = '\\' + name + ' ' + paramtext + '{' + p.verbatim_item() + '}';
2346 context.check_layout(os);
2347 begin_inset(os, "FormulaMacro");
2348 os << "\n\\def" << ert;
2351 output_ert_inset(os, command + ert, context);
2355 void registerExternalTemplatePackages(string const & name)
2357 external::TemplateManager const & etm = external::TemplateManager::get();
2358 external::Template const * const et = etm.getTemplateByName(name);
2361 external::Template::Formats::const_iterator cit = et->formats.end();
2363 cit = et->formats.find("PDFLaTeX");
2364 if (cit == et->formats.end())
2365 // If the template has not specified a PDFLaTeX output,
2366 // we try the LaTeX format.
2367 cit = et->formats.find("LaTeX");
2368 if (cit == et->formats.end())
2370 vector<string>::const_iterator qit = cit->second.requirements.begin();
2371 vector<string>::const_iterator qend = cit->second.requirements.end();
2372 for (; qit != qend; ++qit)
2373 preamble.registerAutomaticallyLoadedPackage(*qit);
2376 } // anonymous namespace
2380 * Find a file with basename \p name in path \p path and an extension
2383 string find_file(string const & name, string const & path,
2384 char const * const * extensions)
2386 for (char const * const * what = extensions; *what; ++what) {
2387 string const trial = addExtension(name, *what);
2388 if (makeAbsPath(trial, path).exists())
2395 /// Convert filenames with TeX macros and/or quotes to something LyX
2397 string const normalize_filename(string const & name)
2402 Token const & t = p.get_token();
2403 if (t.cat() != catEscape)
2405 else if (t.cs() == "lyxdot") {
2406 // This is used by LyX for simple dots in relative
2410 } else if (t.cs() == "space") {
2413 } else if (t.cs() == "string") {
2414 // Convert \string" to " and \string~ to ~
2415 Token const & n = p.next_token();
2416 if (n.asInput() != "\"" && n.asInput() != "~")
2421 // Strip quotes. This is a bit complicated (see latex_path()).
2422 string full = os.str();
2423 if (!full.empty() && full[0] == '"') {
2424 string base = removeExtension(full);
2425 string ext = getExtension(full);
2426 if (!base.empty() && base[base.length()-1] == '"')
2429 return addExtension(trim(base, "\""), ext);
2430 if (full[full.length()-1] == '"')
2433 return trim(full, "\"");
2439 /// Convert \p name from TeX convention (relative to master file) to LyX
2440 /// convention (relative to .lyx file) if it is relative
2441 void fix_child_filename(string & name)
2443 string const absMasterTeX = getMasterFilePath(true);
2444 bool const isabs = FileName::isAbsolute(name);
2445 // convert from "relative to .tex master" to absolute original path
2447 name = makeAbsPath(name, absMasterTeX).absFileName();
2448 bool copyfile = copyFiles();
2449 string const absParentLyX = getParentFilePath(false);
2452 // convert from absolute original path to "relative to master file"
2453 string const rel = to_utf8(makeRelPath(from_utf8(name),
2454 from_utf8(absMasterTeX)));
2455 // re-interpret "relative to .tex file" as "relative to .lyx file"
2456 // (is different if the master .lyx file resides in a
2457 // different path than the master .tex file)
2458 string const absMasterLyX = getMasterFilePath(false);
2459 abs = makeAbsPath(rel, absMasterLyX).absFileName();
2460 // Do not copy if the new path is impossible to create. Example:
2461 // absMasterTeX = "/foo/bar/"
2462 // absMasterLyX = "/bar/"
2463 // name = "/baz.eps" => new absolute name would be "/../baz.eps"
2464 if (contains(name, "/../"))
2471 // convert from absolute original path to
2472 // "relative to .lyx file"
2473 name = to_utf8(makeRelPath(from_utf8(abs),
2474 from_utf8(absParentLyX)));
2478 // convert from absolute original path to "relative to .lyx file"
2479 name = to_utf8(makeRelPath(from_utf8(name),
2480 from_utf8(absParentLyX)));
2485 void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
2488 Layout const * newlayout = 0;
2489 InsetLayout const * newinsetlayout = 0;
2490 char const * const * where = 0;
2491 // Store the latest bibliographystyle, addcontentslineContent and
2492 // nocite{*} option (needed for bibtex inset)
2494 string contentslineContent;
2495 string bibliographystyle = "default";
2496 bool const use_natbib = isProvided("natbib");
2497 bool const use_jurabib = isProvided("jurabib");
2498 bool const use_biblatex = isProvided("biblatex")
2499 && preamble.citeEngine() != "biblatex-natbib";
2500 bool const use_biblatex_natbib = isProvided("biblatex-natbib")
2501 || (isProvided("biblatex") && preamble.citeEngine() == "biblatex-natbib");
2502 need_commentbib = use_biblatex || use_biblatex_natbib;
2505 // it is impossible to determine the correct encoding for non-CJK Japanese.
2506 // Therefore write a note at the beginning of the document
2507 if (is_nonCJKJapanese) {
2508 context.check_layout(os);
2509 begin_inset(os, "Note Note\n");
2510 os << "status open\n\\begin_layout Plain Layout\n"
2511 << "\\series bold\n"
2512 << "Important information:\n"
2513 << "\\end_layout\n\n"
2514 << "\\begin_layout Plain Layout\n"
2515 << "The original LaTeX source for this document is in Japanese (pLaTeX).\n"
2516 << " It was therefore impossible for tex2lyx to determine the correct encoding.\n"
2517 << " The iconv encoding " << p.getEncoding() << " was used.\n"
2518 << " If this is incorrect, you must run the tex2lyx program on the command line\n"
2519 << " and specify the encoding using the -e command-line switch.\n"
2520 << " In addition, you might want to double check that the desired output encoding\n"
2521 << " is correctly selected in Document > Settings > Language.\n"
2522 << "\\end_layout\n";
2524 is_nonCJKJapanese = false;
2527 bool have_cycled = false;
2529 // Leave here only after at least one cycle
2530 if (have_cycled && flags & FLAG_LEAVE) {
2531 flags &= ~FLAG_LEAVE;
2535 Token const & t = p.get_token();
2537 debugToken(cerr, t, flags);
2540 if (flags & FLAG_ITEM) {
2541 if (t.cat() == catSpace)
2544 flags &= ~FLAG_ITEM;
2545 if (t.cat() == catBegin) {
2546 // skip the brace and collect everything to the next matching
2548 flags |= FLAG_BRACE_LAST;
2552 // handle only this single token, leave the loop if done
2553 flags |= FLAG_LEAVE;
2556 if (t.cat() != catEscape && t.character() == ']' &&
2557 (flags & FLAG_BRACK_LAST))
2559 if (t.cat() == catEnd && (flags & FLAG_BRACE_LAST))
2562 // If there is anything between \end{env} and \begin{env} we
2563 // don't need to output a separator.
2564 if (t.cat() != catSpace && t.cat() != catNewline &&
2565 t.asInput() != "\\begin")
2572 bool const starred = p.next_token().asInput() == "*";
2573 string const starredname(starred ? (t.cs() + '*') : t.cs());
2574 if (t.cat() == catMath) {
2575 // we are inside some text mode thingy, so opening new math is allowed
2576 context.check_layout(os);
2577 begin_inset(os, "Formula ");
2578 Token const & n = p.get_token();
2579 bool const display(n.cat() == catMath && outer);
2581 // TeX's $$...$$ syntax for displayed math
2583 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2585 p.get_token(); // skip the second '$' token
2587 // simple $...$ stuff
2590 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2595 // Prevent the conversion of a line break to a
2596 // space (bug 7668). This does not change the
2597 // output, but looks ugly in LyX.
2598 eat_whitespace(p, os, context, false);
2603 if (t.cat() == catSuper || t.cat() == catSub) {
2604 cerr << "catcode " << t << " illegal in text mode\n";
2608 // Basic support for english quotes. This should be
2609 // extended to other quotes, but is not so easy (a
2610 // left english quote is the same as a right german
2612 if (t.asInput() == "`" && p.next_token().asInput() == "`") {
2613 context.check_layout(os);
2614 begin_inset(os, "Quotes ");
2621 if (t.asInput() == "'" && p.next_token().asInput() == "'") {
2622 context.check_layout(os);
2623 begin_inset(os, "Quotes ");
2631 if (t.asInput() == ">" && p.next_token().asInput() == ">") {
2632 context.check_layout(os);
2633 begin_inset(os, "Quotes ");
2641 if (t.asInput() == "<"
2642 && p.next_token().asInput() == "<") {
2643 bool has_chunk = false;
2647 has_chunk = parse_chunk(p, os, context);
2653 context.check_layout(os);
2654 begin_inset(os, "Quotes ");
2655 //FIXME: this is a right danish quote;
2656 // why not a left french quote?
2665 if (t.cat() == catSpace || (t.cat() == catNewline && ! p.isParagraph())) {
2666 check_space(p, os, context);
2670 // babel shorthands (also used by polyglossia)
2671 // Since these can have different meanings for different languages
2672 // we import them as ERT (but they must be put in ERT to get output
2674 if (t.asInput() == "\"") {
2676 // These are known pairs. We put them together in
2677 // one ERT inset. In other cases (such as "a), only
2678 // the quotation mark is ERTed.
2679 if (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 || p.next_token().asInput() == "/"
2685 || p.next_token().asInput() == "~"
2686 || p.next_token().asInput() == "'"
2687 || p.next_token().asInput() == "`"
2688 || p.next_token().asInput() == "<"
2689 || p.next_token().asInput() == ">") {
2690 s += p.next_token().asInput();
2693 output_ert_inset(os, s, context);
2697 if (t.character() == '[' && noweb_mode &&
2698 p.next_token().character() == '[') {
2699 // These can contain underscores
2701 string const s = p.getFullOpt() + ']';
2702 if (p.next_token().character() == ']')
2705 cerr << "Warning: Inserting missing ']' in '"
2706 << s << "'." << endl;
2707 output_ert_inset(os, s, context);
2711 if (t.cat() == catLetter) {
2712 context.check_layout(os);
2717 if (t.cat() == catOther ||
2718 t.cat() == catAlign ||
2719 t.cat() == catParameter) {
2720 context.check_layout(os);
2721 if (t.asInput() == "-" && p.next_token().asInput() == "-" &&
2722 context.merging_hyphens_allowed &&
2723 context.font.family != "ttfamily" &&
2724 !context.layout->pass_thru) {
2725 if (p.next_next_token().asInput() == "-") {
2727 os << to_utf8(docstring(1, 0x2014));
2731 os << to_utf8(docstring(1, 0x2013));
2734 // This translates "&" to "\\&" which may be wrong...
2739 if (p.isParagraph()) {
2740 // In minted floating listings we will collect
2741 // everything into the caption, where multiple
2742 // paragraphs are forbidden.
2743 if (minted_float.empty()) {
2744 if (context.new_layout_allowed)
2745 context.new_paragraph(os);
2747 output_ert_inset(os, "\\par ", context);
2750 eat_whitespace(p, os, context, true);
2754 if (t.cat() == catActive) {
2755 context.check_layout(os);
2756 if (t.character() == '~') {
2757 if (context.layout->free_spacing)
2760 begin_inset(os, "space ~\n");
2768 if (t.cat() == catBegin) {
2769 Token const next = p.next_token();
2770 Token const end = p.next_next_token();
2771 if (next.cat() == catEnd) {
2773 Token const prev = p.prev_token();
2775 if (p.next_token().character() == '`')
2776 ; // ignore it in {}``
2778 output_ert_inset(os, "{}", context);
2779 } else if (next.cat() == catEscape &&
2780 is_known(next.cs(), known_quotes) &&
2781 end.cat() == catEnd) {
2782 // Something like {\textquoteright} (e.g.
2783 // from writer2latex). LyX writes
2784 // \textquoteright{}, so we may skip the
2785 // braces here for better readability.
2786 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2788 } else if (p.next_token().asInput() == "\\ascii") {
2789 // handle the \ascii characters
2790 // (the case without braces is handled later)
2791 // the code is "{\ascii\xxx}"
2792 p.get_token(); // eat \ascii
2793 string name2 = p.get_token().asInput();
2794 p.get_token(); // eat the final '}'
2795 string const name = "{\\ascii" + name2 + "}";
2799 // get the character from unicodesymbols
2800 docstring s = encodings.fromLaTeXCommand(from_utf8(name),
2801 Encodings::TEXT_CMD, termination, rem, &req);
2803 context.check_layout(os);
2806 output_ert_inset(os,
2807 to_utf8(rem), context);
2808 for (set<string>::const_iterator it = req.begin();
2809 it != req.end(); ++it)
2810 preamble.registerAutomaticallyLoadedPackage(*it);
2812 // we did not find a non-ert version
2813 output_ert_inset(os, name, context);
2815 context.check_layout(os);
2816 // special handling of font attribute changes
2817 Token const prev = p.prev_token();
2818 TeXFont const oldFont = context.font;
2819 if (next.character() == '[' ||
2820 next.character() == ']' ||
2821 next.character() == '*') {
2823 if (p.next_token().cat() == catEnd) {
2828 output_ert_inset(os, "{", context);
2829 parse_text_snippet(p, os,
2832 output_ert_inset(os, "}", context);
2834 } else if (! context.new_layout_allowed) {
2835 output_ert_inset(os, "{", context);
2836 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2838 output_ert_inset(os, "}", context);
2839 } else if (is_known(next.cs(), known_sizes)) {
2840 // next will change the size, so we must
2842 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2844 if (!context.atParagraphStart())
2846 << context.font.size << "\n";
2847 } else if (is_known(next.cs(), known_font_families)) {
2848 // next will change the font family, so we
2849 // must reset it here
2850 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2852 if (!context.atParagraphStart())
2854 << context.font.family << "\n";
2855 } else if (is_known(next.cs(), known_font_series)) {
2856 // next will change the font series, so we
2857 // must reset it here
2858 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2860 if (!context.atParagraphStart())
2862 << context.font.series << "\n";
2863 } else if (is_known(next.cs(), known_font_shapes)) {
2864 // next will change the font shape, so we
2865 // must reset it here
2866 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2868 if (!context.atParagraphStart())
2870 << context.font.shape << "\n";
2871 } else if (is_known(next.cs(), known_old_font_families) ||
2872 is_known(next.cs(), known_old_font_series) ||
2873 is_known(next.cs(), known_old_font_shapes)) {
2874 // next will change the font family, series
2875 // and shape, so we must reset it here
2876 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2878 if (!context.atParagraphStart())
2880 << context.font.family
2882 << context.font.series
2884 << context.font.shape << "\n";
2886 output_ert_inset(os, "{", context);
2887 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2889 output_ert_inset(os, "}", context);
2895 if (t.cat() == catEnd) {
2896 if (flags & FLAG_BRACE_LAST) {
2899 cerr << "stray '}' in text\n";
2900 output_ert_inset(os, "}", context);
2904 if (t.cat() == catComment) {
2905 parse_comment(p, os, t, context);
2910 // control sequences
2913 if (t.cs() == "(" || t.cs() == "[") {
2914 bool const simple = t.cs() == "(";
2915 context.check_layout(os);
2916 begin_inset(os, "Formula");
2917 os << " \\" << t.cs();
2918 parse_math(p, os, simple ? FLAG_SIMPLE2 : FLAG_EQUATION, MATH_MODE);
2919 os << '\\' << (simple ? ')' : ']');
2922 // Prevent the conversion of a line break to a
2923 // space (bug 7668). This does not change the
2924 // output, but looks ugly in LyX.
2925 eat_whitespace(p, os, context, false);
2930 if (t.cs() == "begin") {
2931 parse_environment(p, os, outer, last_env,
2936 if (t.cs() == "end") {
2937 if (flags & FLAG_END) {
2938 // eat environment name
2939 string const name = p.getArg('{', '}');
2940 if (name != active_environment())
2941 cerr << "\\end{" + name + "} does not match \\begin{"
2942 + active_environment() + "}\n";
2945 p.error("found 'end' unexpectedly");
2949 if (t.cs() == "item") {
2951 bool const optarg = p.hasOpt();
2953 // FIXME: This swallows comments, but we cannot use
2954 // eat_whitespace() since we must not output
2955 // anything before the item.
2956 p.skip_spaces(true);
2957 s = p.verbatimOption();
2959 p.skip_spaces(false);
2961 context.check_layout(os);
2962 if (context.has_item) {
2963 // An item in an unknown list-like environment
2964 // FIXME: Do this in check_layout()!
2965 context.has_item = false;
2967 output_ert_inset(os, "\\item", context);
2969 output_ert_inset(os, "\\item ", context);
2972 if (context.layout->labeltype != LABEL_MANUAL) {
2973 // handle option of itemize item
2974 begin_inset(os, "Argument item:1\n");
2975 os << "status open\n";
2976 os << "\n\\begin_layout Plain Layout\n";
2978 os << parse_text_snippet(p2,
2979 FLAG_BRACK_LAST, outer, context);
2980 // we must not use context.check_end_layout(os)
2981 // because that would close the outer itemize layout
2982 os << "\n\\end_layout\n";
2984 eat_whitespace(p, os, context, false);
2985 } else if (!s.empty()) {
2986 // LyX adds braces around the argument,
2987 // so we need to remove them here.
2988 if (s.size() > 2 && s[0] == '{' &&
2989 s[s.size()-1] == '}')
2990 s = s.substr(1, s.size()-2);
2991 // If the argument contains a space we
2992 // must put it into ERT: Otherwise LyX
2993 // would misinterpret the space as
2994 // item delimiter (bug 7663)
2995 if (contains(s, ' ')) {
2996 output_ert_inset(os, s, context);
2999 os << parse_text_snippet(p2,
3000 FLAG_BRACK_LAST, outer, context);
3002 // The space is needed to separate the
3003 // item from the rest of the sentence.
3005 eat_whitespace(p, os, context, false);
3011 if (t.cs() == "bibitem") {
3013 context.check_layout(os);
3014 eat_whitespace(p, os, context, false);
3015 string label = convert_command_inset_arg(p.verbatimOption());
3016 string key = convert_command_inset_arg(p.verbatim_item());
3017 if (contains(label, '\\') || contains(key, '\\')) {
3018 // LyX can't handle LaTeX commands in labels or keys
3019 output_ert_inset(os, t.asInput() + '[' + label +
3020 "]{" + p.verbatim_item() + '}',
3023 begin_command_inset(os, "bibitem", "bibitem");
3024 os << "label \"" << label << "\"\n"
3025 << "key \"" << key << "\"\n"
3026 << "literal \"true\"\n";
3033 // catch the case of \def\inputGnumericTable
3035 if (t.cs() == "def") {
3036 Token second = p.next_token();
3037 if (second.cs() == "inputGnumericTable") {
3041 Token third = p.get_token();
3043 if (third.cs() == "input") {
3047 string name = normalize_filename(p.verbatim_item());
3048 string const path = getMasterFilePath(true);
3049 // We want to preserve relative / absolute filenames,
3050 // therefore path is only used for testing
3051 // The file extension is in every case ".tex".
3052 // So we need to remove this extension and check for
3053 // the original one.
3054 name = removeExtension(name);
3055 if (!makeAbsPath(name, path).exists()) {
3056 char const * const Gnumeric_formats[] = {"gnumeric",
3058 string const Gnumeric_name =
3059 find_file(name, path, Gnumeric_formats);
3060 if (!Gnumeric_name.empty())
3061 name = Gnumeric_name;
3063 FileName const absname = makeAbsPath(name, path);
3064 if (absname.exists()) {
3065 fix_child_filename(name);
3066 copy_file(absname, name);
3068 cerr << "Warning: Could not find file '"
3069 << name << "'." << endl;
3070 context.check_layout(os);
3071 begin_inset(os, "External\n\ttemplate ");
3072 os << "GnumericSpreadsheet\n\tfilename "
3075 context.check_layout(os);
3077 // register the packages that are automatically loaded
3078 // by the Gnumeric template
3079 registerExternalTemplatePackages("GnumericSpreadsheet");
3084 parse_macro(p, os, context);
3088 if (t.cs() == "noindent") {
3090 context.add_par_extra_stuff("\\noindent\n");
3094 if (t.cs() == "appendix") {
3095 context.add_par_extra_stuff("\\start_of_appendix\n");
3096 // We need to start a new paragraph. Otherwise the
3097 // appendix in 'bla\appendix\chapter{' would start
3099 context.new_paragraph(os);
3100 // We need to make sure that the paragraph is
3101 // generated even if it is empty. Otherwise the
3102 // appendix in '\par\appendix\par\chapter{' would
3104 context.check_layout(os);
3105 // FIXME: This is a hack to prevent paragraph
3106 // deletion if it is empty. Handle this better!
3107 output_comment(p, os,
3108 "dummy comment inserted by tex2lyx to "
3109 "ensure that this paragraph is not empty",
3111 // Both measures above may generate an additional
3112 // empty paragraph, but that does not hurt, because
3113 // whitespace does not matter here.
3114 eat_whitespace(p, os, context, true);
3118 // Must catch empty dates before findLayout is called below
3119 if (t.cs() == "date") {
3120 eat_whitespace(p, os, context, false);
3122 string const date = p.verbatim_item();
3125 preamble.suppressDate(true);
3128 preamble.suppressDate(false);
3129 if (context.new_layout_allowed &&
3130 (newlayout = findLayout(context.textclass,
3133 output_command_layout(os, p, outer,
3134 context, newlayout);
3135 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3136 if (!preamble.titleLayoutFound())
3137 preamble.titleLayoutFound(newlayout->intitle);
3138 set<string> const & req = newlayout->requires();
3139 set<string>::const_iterator it = req.begin();
3140 set<string>::const_iterator en = req.end();
3141 for (; it != en; ++it)
3142 preamble.registerAutomaticallyLoadedPackage(*it);
3144 output_ert_inset(os,
3145 "\\date{" + p.verbatim_item() + '}',
3151 // Starred section headings
3152 // Must attempt to parse "Section*" before "Section".
3153 if ((p.next_token().asInput() == "*") &&
3154 context.new_layout_allowed &&
3155 (newlayout = findLayout(context.textclass, t.cs() + '*', true))) {
3158 output_command_layout(os, p, outer, context, newlayout);
3160 if (!preamble.titleLayoutFound())
3161 preamble.titleLayoutFound(newlayout->intitle);
3162 set<string> const & req = newlayout->requires();
3163 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3164 preamble.registerAutomaticallyLoadedPackage(*it);
3168 // Section headings and the like
3169 if (context.new_layout_allowed &&
3170 (newlayout = findLayout(context.textclass, t.cs(), true))) {
3172 output_command_layout(os, p, outer, context, newlayout);
3174 if (!preamble.titleLayoutFound())
3175 preamble.titleLayoutFound(newlayout->intitle);
3176 set<string> const & req = newlayout->requires();
3177 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3178 preamble.registerAutomaticallyLoadedPackage(*it);
3182 if (t.cs() == "subfloat") {
3183 // the syntax is \subfloat[list entry][sub caption]{content}
3184 // if it is a table of figure depends on the surrounding float
3186 // do nothing if there is no outer float
3187 if (!float_type.empty()) {
3188 context.check_layout(os);
3190 begin_inset(os, "Float " + float_type + "\n");
3192 << "\nsideways false"
3193 << "\nstatus collapsed\n\n";
3196 bool has_caption = false;
3197 if (p.next_token().cat() != catEscape &&
3198 p.next_token().character() == '[') {
3199 p.get_token(); // eat '['
3200 caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
3203 // In case we have two optional args, the second is the caption.
3204 if (p.next_token().cat() != catEscape &&
3205 p.next_token().character() == '[') {
3206 p.get_token(); // eat '['
3207 caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
3210 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3211 // the caption comes always as the last
3213 // we must make sure that the caption gets a \begin_layout
3214 os << "\n\\begin_layout Plain Layout";
3216 begin_inset(os, "Caption Standard\n");
3217 Context newcontext(true, context.textclass,
3218 0, 0, context.font);
3219 newcontext.check_layout(os);
3220 os << caption << "\n";
3221 newcontext.check_end_layout(os);
3224 // close the layout we opened
3225 os << "\n\\end_layout";
3230 // if the float type is not supported or there is no surrounding float
3235 opt_arg1 = convert_command_inset_arg(p.getFullOpt());
3237 opt_arg2 = convert_command_inset_arg(p.getFullOpt());
3239 output_ert_inset(os, t.asInput() + opt_arg1 + opt_arg2
3240 + "{" + p.verbatim_item() + '}', context);
3245 if (t.cs() == "includegraphics") {
3246 bool const clip = p.next_token().asInput() == "*";
3249 string const arg = p.getArg('[', ']');
3250 map<string, string> opts;
3251 vector<string> keys;
3252 split_map(arg, opts, keys);
3254 opts["clip"] = string();
3255 string name = normalize_filename(p.verbatim_item());
3257 string const path = getMasterFilePath(true);
3258 // We want to preserve relative / absolute filenames,
3259 // therefore path is only used for testing
3260 if (!makeAbsPath(name, path).exists()) {
3261 // The file extension is probably missing.
3262 // Now try to find it out.
3263 string const dvips_name =
3264 find_file(name, path,
3265 known_dvips_graphics_formats);
3266 string const pdftex_name =
3267 find_file(name, path,
3268 known_pdftex_graphics_formats);
3269 if (!dvips_name.empty()) {
3270 if (!pdftex_name.empty()) {
3271 cerr << "This file contains the "
3273 "\"\\includegraphics{"
3275 "However, files\n\""
3276 << dvips_name << "\" and\n\""
3277 << pdftex_name << "\"\n"
3278 "both exist, so I had to make a "
3279 "choice and took the first one.\n"
3280 "Please move the unwanted one "
3281 "someplace else and try again\n"
3282 "if my choice was wrong."
3286 } else if (!pdftex_name.empty()) {
3292 FileName const absname = makeAbsPath(name, path);
3293 if (absname.exists()) {
3294 fix_child_filename(name);
3295 copy_file(absname, name);
3297 cerr << "Warning: Could not find graphics file '"
3298 << name << "'." << endl;
3300 context.check_layout(os);
3301 begin_inset(os, "Graphics ");
3302 os << "\n\tfilename " << name << '\n';
3303 if (opts.find("width") != opts.end())
3305 << translate_len(opts["width"]) << '\n';
3306 if (opts.find("height") != opts.end())
3308 << translate_len(opts["height"]) << '\n';
3309 if (opts.find("scale") != opts.end()) {
3310 istringstream iss(opts["scale"]);
3314 os << "\tscale " << val << '\n';
3316 if (opts.find("angle") != opts.end()) {
3317 os << "\trotateAngle "
3318 << opts["angle"] << '\n';
3319 vector<string>::const_iterator a =
3320 find(keys.begin(), keys.end(), "angle");
3321 vector<string>::const_iterator s =
3322 find(keys.begin(), keys.end(), "width");
3323 if (s == keys.end())
3324 s = find(keys.begin(), keys.end(), "height");
3325 if (s == keys.end())
3326 s = find(keys.begin(), keys.end(), "scale");
3327 if (s != keys.end() && distance(s, a) > 0)
3328 os << "\tscaleBeforeRotation\n";
3330 if (opts.find("origin") != opts.end()) {
3332 string const opt = opts["origin"];
3333 if (opt.find('l') != string::npos) ss << "left";
3334 if (opt.find('r') != string::npos) ss << "right";
3335 if (opt.find('c') != string::npos) ss << "center";
3336 if (opt.find('t') != string::npos) ss << "Top";
3337 if (opt.find('b') != string::npos) ss << "Bottom";
3338 if (opt.find('B') != string::npos) ss << "Baseline";
3339 if (!ss.str().empty())
3340 os << "\trotateOrigin " << ss.str() << '\n';
3342 cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
3344 if (opts.find("keepaspectratio") != opts.end())
3345 os << "\tkeepAspectRatio\n";
3346 if (opts.find("clip") != opts.end())
3348 if (opts.find("draft") != opts.end())
3350 if (opts.find("bb") != opts.end())
3351 os << "\tBoundingBox "
3352 << opts["bb"] << '\n';
3353 int numberOfbbOptions = 0;
3354 if (opts.find("bbllx") != opts.end())
3355 numberOfbbOptions++;
3356 if (opts.find("bblly") != opts.end())
3357 numberOfbbOptions++;
3358 if (opts.find("bburx") != opts.end())
3359 numberOfbbOptions++;
3360 if (opts.find("bbury") != opts.end())
3361 numberOfbbOptions++;
3362 if (numberOfbbOptions == 4)
3363 os << "\tBoundingBox "
3364 << opts["bbllx"] << " " << opts["bblly"] << " "
3365 << opts["bburx"] << " " << opts["bbury"] << '\n';
3366 else if (numberOfbbOptions > 0)
3367 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
3368 numberOfbbOptions = 0;
3369 if (opts.find("natwidth") != opts.end())
3370 numberOfbbOptions++;
3371 if (opts.find("natheight") != opts.end())
3372 numberOfbbOptions++;
3373 if (numberOfbbOptions == 2)
3374 os << "\tBoundingBox 0bp 0bp "
3375 << opts["natwidth"] << " " << opts["natheight"] << '\n';
3376 else if (numberOfbbOptions > 0)
3377 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
3378 ostringstream special;
3379 if (opts.find("hiresbb") != opts.end())
3380 special << "hiresbb,";
3381 if (opts.find("trim") != opts.end())
3383 if (opts.find("viewport") != opts.end())
3384 special << "viewport=" << opts["viewport"] << ',';
3385 if (opts.find("totalheight") != opts.end())
3386 special << "totalheight=" << opts["totalheight"] << ',';
3387 if (opts.find("type") != opts.end())
3388 special << "type=" << opts["type"] << ',';
3389 if (opts.find("ext") != opts.end())
3390 special << "ext=" << opts["ext"] << ',';
3391 if (opts.find("read") != opts.end())
3392 special << "read=" << opts["read"] << ',';
3393 if (opts.find("command") != opts.end())
3394 special << "command=" << opts["command"] << ',';
3395 string s_special = special.str();
3396 if (!s_special.empty()) {
3397 // We had special arguments. Remove the trailing ','.
3398 os << "\tspecial " << s_special.substr(0, s_special.size() - 1) << '\n';
3400 // TODO: Handle the unknown settings better.
3401 // Warn about invalid options.
3402 // Check whether some option was given twice.
3404 preamble.registerAutomaticallyLoadedPackage("graphicx");
3408 if (t.cs() == "footnote" ||
3409 (t.cs() == "thanks" && context.layout->intitle)) {
3411 context.check_layout(os);
3412 begin_inset(os, "Foot\n");
3413 os << "status collapsed\n\n";
3414 parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3419 if (t.cs() == "marginpar") {
3421 context.check_layout(os);
3422 begin_inset(os, "Marginal\n");
3423 os << "status collapsed\n\n";
3424 parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3429 if (t.cs() == "lstinline" || t.cs() == "mintinline") {
3430 bool const use_minted = t.cs() == "mintinline";
3432 parse_listings(p, os, context, true, use_minted);
3436 if (t.cs() == "ensuremath") {
3438 context.check_layout(os);
3439 string const s = p.verbatim_item();
3440 //FIXME: this never triggers in UTF8
3441 if (s == "\xb1" || s == "\xb3" || s == "\xb2" || s == "\xb5")
3444 output_ert_inset(os, "\\ensuremath{" + s + "}",
3449 else if (t.cs() == "makeindex" || t.cs() == "maketitle") {
3450 if (preamble.titleLayoutFound()) {
3452 skip_spaces_braces(p);
3454 output_ert_inset(os, t.asInput(), context);
3458 if (t.cs() == "tableofcontents"
3459 || t.cs() == "lstlistoflistings"
3460 || t.cs() == "listoflistings") {
3461 string name = t.cs();
3462 if (preamble.minted() && name == "listoflistings")
3463 name.insert(0, "lst");
3464 context.check_layout(os);
3465 begin_command_inset(os, "toc", name);
3467 skip_spaces_braces(p);
3468 if (name == "lstlistoflistings") {
3469 if (preamble.minted())
3470 preamble.registerAutomaticallyLoadedPackage("minted");
3472 preamble.registerAutomaticallyLoadedPackage("listings");
3477 if (t.cs() == "listoffigures" || t.cs() == "listoftables") {
3478 context.check_layout(os);
3479 if (t.cs() == "listoffigures")
3480 begin_inset(os, "FloatList figure\n");
3482 begin_inset(os, "FloatList table\n");
3484 skip_spaces_braces(p);
3488 if (t.cs() == "listof") {
3489 p.skip_spaces(true);
3490 string const name = p.get_token().cs();
3491 if (context.textclass.floats().typeExist(name)) {
3492 context.check_layout(os);
3493 begin_inset(os, "FloatList ");
3496 p.get_token(); // swallow second arg
3498 output_ert_inset(os, "\\listof{" + name + "}", context);
3502 if ((where = is_known(t.cs(), known_text_font_families))) {
3503 parse_text_attributes(p, os, FLAG_ITEM, outer,
3504 context, "\\family", context.font.family,
3505 known_coded_font_families[where - known_text_font_families]);
3509 if ((where = is_known(t.cs(), known_text_font_series))) {
3510 parse_text_attributes(p, os, FLAG_ITEM, outer,
3511 context, "\\series", context.font.series,
3512 known_coded_font_series[where - known_text_font_series]);
3516 if ((where = is_known(t.cs(), known_text_font_shapes))) {
3517 parse_text_attributes(p, os, FLAG_ITEM, outer,
3518 context, "\\shape", context.font.shape,
3519 known_coded_font_shapes[where - known_text_font_shapes]);
3523 if (t.cs() == "textnormal" || t.cs() == "normalfont") {
3524 context.check_layout(os);
3525 TeXFont oldFont = context.font;
3526 context.font.init();
3527 context.font.size = oldFont.size;
3528 os << "\n\\family " << context.font.family << "\n";
3529 os << "\n\\series " << context.font.series << "\n";
3530 os << "\n\\shape " << context.font.shape << "\n";
3531 if (t.cs() == "textnormal") {
3532 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3533 output_font_change(os, context.font, oldFont);
3534 context.font = oldFont;
3536 eat_whitespace(p, os, context, false);
3540 if (t.cs() == "textcolor") {
3541 // scheme is \textcolor{color name}{text}
3542 string const color = p.verbatim_item();
3543 // we support the predefined colors of the color and the xcolor package
3544 if (color == "black" || color == "blue" || color == "cyan"
3545 || color == "green" || color == "magenta" || color == "red"
3546 || color == "white" || color == "yellow") {
3547 context.check_layout(os);
3548 os << "\n\\color " << color << "\n";
3549 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3550 context.check_layout(os);
3551 os << "\n\\color inherit\n";
3552 preamble.registerAutomaticallyLoadedPackage("color");
3553 } else if (color == "brown" || color == "darkgray" || color == "gray"
3554 || color == "lightgray" || color == "lime" || color == "olive"
3555 || color == "orange" || color == "pink" || color == "purple"
3556 || color == "teal" || color == "violet") {
3557 context.check_layout(os);
3558 os << "\n\\color " << color << "\n";
3559 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3560 context.check_layout(os);
3561 os << "\n\\color inherit\n";
3562 preamble.registerAutomaticallyLoadedPackage("xcolor");
3564 // for custom defined colors
3565 output_ert_inset(os, t.asInput() + "{" + color + "}", context);
3569 if (t.cs() == "underbar" || t.cs() == "uline") {
3570 // \underbar is not 100% correct (LyX outputs \uline
3571 // of ulem.sty). The difference is that \ulem allows
3572 // line breaks, and \underbar does not.
3573 // Do NOT handle \underline.
3574 // \underbar cuts through y, g, q, p etc.,
3575 // \underline does not.
3576 context.check_layout(os);
3577 os << "\n\\bar under\n";
3578 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3579 context.check_layout(os);
3580 os << "\n\\bar default\n";
3581 preamble.registerAutomaticallyLoadedPackage("ulem");
3585 if (t.cs() == "sout") {
3586 context.check_layout(os);
3587 os << "\n\\strikeout on\n";
3588 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3589 context.check_layout(os);
3590 os << "\n\\strikeout default\n";
3591 preamble.registerAutomaticallyLoadedPackage("ulem");
3595 if (t.cs() == "uuline" || t.cs() == "uwave"
3596 || t.cs() == "emph" || t.cs() == "noun"
3597 || t.cs() == "xout") {
3598 context.check_layout(os);
3599 os << "\n\\" << t.cs() << " on\n";
3600 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3601 context.check_layout(os);
3602 os << "\n\\" << t.cs() << " default\n";
3603 if (t.cs() == "uuline" || t.cs() == "uwave" || t.cs() == "xout")
3604 preamble.registerAutomaticallyLoadedPackage("ulem");
3608 if (t.cs() == "lyxadded" || t.cs() == "lyxdeleted") {
3609 context.check_layout(os);
3610 string name = p.getArg('{', '}');
3611 string localtime = p.getArg('{', '}');
3612 preamble.registerAuthor(name);
3613 Author const & author = preamble.getAuthor(name);
3614 // from_asctime_utc() will fail if LyX decides to output the
3615 // time in the text language.
3616 time_t ptime = from_asctime_utc(localtime);
3617 if (ptime == static_cast<time_t>(-1)) {
3618 cerr << "Warning: Could not parse time `" << localtime
3619 << "´ for change tracking, using current time instead.\n";
3620 ptime = current_time();
3622 if (t.cs() == "lyxadded")
3623 os << "\n\\change_inserted ";
3625 os << "\n\\change_deleted ";
3626 os << author.bufferId() << ' ' << ptime << '\n';
3627 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3628 bool dvipost = LaTeXPackages::isAvailable("dvipost");
3629 bool xcolorulem = LaTeXPackages::isAvailable("ulem") &&
3630 LaTeXPackages::isAvailable("xcolor");
3631 // No need to test for luatex, since luatex comes in
3632 // two flavours (dvi and pdf), like latex, and those
3633 // are detected by pdflatex.
3634 if (pdflatex || xetex) {
3636 preamble.registerAutomaticallyLoadedPackage("ulem");
3637 preamble.registerAutomaticallyLoadedPackage("xcolor");
3638 preamble.registerAutomaticallyLoadedPackage("pdfcolmk");
3642 preamble.registerAutomaticallyLoadedPackage("dvipost");
3643 } else if (xcolorulem) {
3644 preamble.registerAutomaticallyLoadedPackage("ulem");
3645 preamble.registerAutomaticallyLoadedPackage("xcolor");
3651 if (t.cs() == "textipa") {
3652 context.check_layout(os);
3653 begin_inset(os, "IPA\n");
3654 bool merging_hyphens_allowed = context.merging_hyphens_allowed;
3655 context.merging_hyphens_allowed = false;
3656 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3657 context.merging_hyphens_allowed = merging_hyphens_allowed;
3659 preamble.registerAutomaticallyLoadedPackage("tipa");
3660 preamble.registerAutomaticallyLoadedPackage("tipx");
3664 if (t.cs() == "texttoptiebar" || t.cs() == "textbottomtiebar") {
3665 context.check_layout(os);
3666 begin_inset(os, "IPADeco " + t.cs().substr(4) + "\n");
3667 os << "status open\n";
3668 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3674 if (t.cs() == "textvertline") {
3675 // FIXME: This is not correct, \textvertline is higher than |
3681 if (t.cs() == "tone" ) {
3682 context.check_layout(os);
3683 // register the tone package
3684 preamble.registerAutomaticallyLoadedPackage("tone");
3685 string content = trimSpaceAndEol(p.verbatim_item());
3686 string command = t.asInput() + "{" + content + "}";
3687 // some tones can be detected by unicodesymbols, some need special code
3688 if (is_known(content, known_tones)) {
3689 os << "\\IPAChar " << command << "\n";
3692 // try to see whether the string is in unicodesymbols
3696 docstring s = encodings.fromLaTeXCommand(from_utf8(command),
3697 Encodings::TEXT_CMD | Encodings::MATH_CMD,
3698 termination, rem, &req);
3702 output_ert_inset(os, to_utf8(rem), context);
3703 for (set<string>::const_iterator it = req.begin();
3704 it != req.end(); ++it)
3705 preamble.registerAutomaticallyLoadedPackage(*it);
3707 // we did not find a non-ert version
3708 output_ert_inset(os, command, context);
3712 if (t.cs() == "phantom" || t.cs() == "hphantom" ||
3713 t.cs() == "vphantom") {
3714 context.check_layout(os);
3715 if (t.cs() == "phantom")
3716 begin_inset(os, "Phantom Phantom\n");
3717 if (t.cs() == "hphantom")
3718 begin_inset(os, "Phantom HPhantom\n");
3719 if (t.cs() == "vphantom")
3720 begin_inset(os, "Phantom VPhantom\n");
3721 os << "status open\n";
3722 parse_text_in_inset(p, os, FLAG_ITEM, outer, context,
3728 if (t.cs() == "href") {
3729 context.check_layout(os);
3730 string target = convert_command_inset_arg(p.verbatim_item());
3731 string name = convert_command_inset_arg(p.verbatim_item());
3733 size_t i = target.find(':');
3734 if (i != string::npos) {
3735 type = target.substr(0, i + 1);
3736 if (type == "mailto:" || type == "file:")
3737 target = target.substr(i + 1);
3738 // handle the case that name is equal to target, except of "http(s)://"
3739 else if (target.substr(i + 3) == name && (type == "http:" || type == "https:"))
3742 begin_command_inset(os, "href", "href");
3744 os << "name \"" << name << "\"\n";
3745 os << "target \"" << target << "\"\n";
3746 if (type == "mailto:" || type == "file:")
3747 os << "type \"" << type << "\"\n";
3748 os << "literal \"true\"\n";
3750 skip_spaces_braces(p);
3754 if (t.cs() == "lyxline") {
3755 // swallow size argument (it is not used anyway)
3757 if (!context.atParagraphStart()) {
3758 // so our line is in the middle of a paragraph
3759 // we need to add a new line, lest this line
3760 // follow the other content on that line and
3761 // run off the side of the page
3762 // FIXME: This may create an empty paragraph,
3763 // but without that it would not be
3764 // possible to set noindent below.
3765 // Fortunately LaTeX does not care
3766 // about the empty paragraph.
3767 context.new_paragraph(os);
3769 if (preamble.indentParagraphs()) {
3770 // we need to unindent, lest the line be too long
3771 context.add_par_extra_stuff("\\noindent\n");
3773 context.check_layout(os);
3774 begin_command_inset(os, "line", "rule");
3775 os << "offset \"0.5ex\"\n"
3776 "width \"100line%\"\n"
3782 if (t.cs() == "rule") {
3783 string const offset = (p.hasOpt() ? p.getArg('[', ']') : string());
3784 string const width = p.getArg('{', '}');
3785 string const thickness = p.getArg('{', '}');
3786 context.check_layout(os);
3787 begin_command_inset(os, "line", "rule");
3788 if (!offset.empty())
3789 os << "offset \"" << translate_len(offset) << "\"\n";
3790 os << "width \"" << translate_len(width) << "\"\n"
3791 "height \"" << translate_len(thickness) << "\"\n";
3796 // handle refstyle first to catch \eqref which can also occur
3797 // without refstyle. Only recognize these commands if
3798 // refstyle.sty was found in the preamble (otherwise \eqref
3799 // and user defined ref commands could be misdetected).
3800 if ((where = is_known(t.cs(), known_refstyle_commands))
3801 && preamble.refstyle()) {
3802 context.check_layout(os);
3803 begin_command_inset(os, "ref", "formatted");
3804 os << "reference \"";
3805 os << known_refstyle_prefixes[where - known_refstyle_commands]
3807 os << convert_command_inset_arg(p.verbatim_item())
3809 os << "plural \"false\"\n";
3810 os << "caps \"false\"\n";
3811 os << "noprefix \"false\"\n";
3813 preamble.registerAutomaticallyLoadedPackage("refstyle");
3817 // if refstyle is used, we must not convert \prettyref to a
3818 // formatted reference, since that would result in a refstyle command.
3819 if ((where = is_known(t.cs(), known_ref_commands)) &&
3820 (t.cs() != "prettyref" || !preamble.refstyle())) {
3821 string const opt = p.getOpt();
3823 context.check_layout(os);
3824 begin_command_inset(os, "ref",
3825 known_coded_ref_commands[where - known_ref_commands]);
3826 os << "reference \""
3827 << convert_command_inset_arg(p.verbatim_item())
3829 os << "plural \"false\"\n";
3830 os << "caps \"false\"\n";
3831 os << "noprefix \"false\"\n";
3833 if (t.cs() == "vref" || t.cs() == "vpageref")
3834 preamble.registerAutomaticallyLoadedPackage("varioref");
3835 else if (t.cs() == "prettyref")
3836 preamble.registerAutomaticallyLoadedPackage("prettyref");
3838 // LyX does not yet support optional arguments of ref commands
3839 output_ert_inset(os, t.asInput() + '[' + opt + "]{" +
3840 p.verbatim_item() + '}', context);
3846 is_known(t.cs(), known_natbib_commands) &&
3847 ((t.cs() != "citefullauthor" &&
3848 t.cs() != "citeyear" &&
3849 t.cs() != "citeyearpar") ||
3850 p.next_token().asInput() != "*")) {
3851 context.check_layout(os);
3852 string command = t.cs();
3853 if (p.next_token().asInput() == "*") {
3857 if (command == "citefullauthor")
3858 // alternative name for "\\citeauthor*"
3859 command = "citeauthor*";
3861 // text before the citation
3863 // text after the citation
3865 get_cite_arguments(p, true, before, after);
3867 if (command == "cite") {
3868 // \cite without optional argument means
3869 // \citet, \cite with at least one optional
3870 // argument means \citep.
3871 if (before.empty() && after.empty())
3876 if (before.empty() && after == "[]")
3877 // avoid \citet[]{a}
3879 else if (before == "[]" && after == "[]") {
3880 // avoid \citet[][]{a}
3884 // remove the brackets around after and before
3885 if (!after.empty()) {
3887 after.erase(after.length() - 1, 1);
3888 after = convert_command_inset_arg(after);
3890 if (!before.empty()) {
3892 before.erase(before.length() - 1, 1);
3893 before = convert_command_inset_arg(before);
3895 begin_command_inset(os, "citation", command);
3896 os << "after " << '"' << after << '"' << "\n";
3897 os << "before " << '"' << before << '"' << "\n";
3899 << convert_command_inset_arg(p.verbatim_item())
3901 << "literal \"true\"\n";
3903 // Need to set the cite engine if natbib is loaded by
3904 // the document class directly
3905 if (preamble.citeEngine() == "basic")
3906 preamble.citeEngine("natbib");
3911 && is_known(t.cs(), known_biblatex_commands)
3912 && ((t.cs() == "cite"
3913 || t.cs() == "citeauthor"
3914 || t.cs() == "Citeauthor"
3915 || t.cs() == "parencite"
3916 || t.cs() == "citetitle")
3917 || p.next_token().asInput() != "*"))
3918 || (use_biblatex_natbib
3919 && (is_known(t.cs(), known_biblatex_commands)
3920 || is_known(t.cs(), known_natbib_commands))
3921 && ((t.cs() == "cite" || t.cs() == "citet" || t.cs() == "Citet"
3922 || t.cs() == "citep" || t.cs() == "Citep" || t.cs() == "citealt"
3923 || t.cs() == "Citealt" || t.cs() == "citealp" || t.cs() == "Citealp"
3924 || t.cs() == "citeauthor" || t.cs() == "Citeauthor"
3925 || t.cs() == "parencite" || t.cs() == "citetitle")
3926 || p.next_token().asInput() != "*"))){
3927 context.check_layout(os);
3928 string command = t.cs();
3929 if (p.next_token().asInput() == "*") {
3934 bool const qualified = suffixIs(command, "s");
3936 command = rtrim(command, "s");
3938 // text before the citation
3940 // text after the citation
3942 get_cite_arguments(p, true, before, after, qualified);
3944 // These use natbib cmd names in LyX
3945 // for inter-citeengine compativility
3946 if (command == "citeyear")
3947 command = "citebyear";
3948 else if (command == "cite*")
3949 command = "citeyear";
3950 else if (command == "textcite")
3952 else if (command == "Textcite")
3954 else if (command == "parencite")
3956 else if (command == "Parencite")
3958 else if (command == "parencite*")
3959 command = "citeyearpar";
3960 else if (command == "smartcite")
3961 command = "footcite";
3962 else if (command == "Smartcite")
3963 command = "Footcite";
3965 string const emptyarg = qualified ? "()" : "[]";
3966 if (before.empty() && after == emptyarg)
3969 else if (before == emptyarg && after == emptyarg) {
3970 // avoid \cite[][]{a}
3974 // remove the brackets around after and before
3975 if (!after.empty()) {
3977 after.erase(after.length() - 1, 1);
3978 after = convert_command_inset_arg(after);
3980 if (!before.empty()) {
3982 before.erase(before.length() - 1, 1);
3983 before = convert_command_inset_arg(before);
3985 string keys, pretextlist, posttextlist;
3987 map<string, string> pres;
3988 map<string, string> posts;
3989 vector<string> lkeys;
3990 // text before the citation
3992 // text after the citation
3996 get_cite_arguments(p, true, lbefore, lafter);
3997 // remove the brackets around after and before
3998 if (!lafter.empty()) {
4000 lafter.erase(lafter.length() - 1, 1);
4001 lafter = convert_command_inset_arg(lafter);
4003 if (!lbefore.empty()) {
4004 lbefore.erase(0, 1);
4005 lbefore.erase(lbefore.length() - 1, 1);
4006 lbefore = convert_command_inset_arg(lbefore);
4008 if (lbefore.empty() && lafter == "[]")
4011 else if (lbefore == "[]" && lafter == "[]") {
4012 // avoid \cite[][]{a}
4016 lkey = p.getArg('{', '}');
4019 if (!lbefore.empty())
4020 pres.insert(make_pair(lkey, lbefore));
4021 if (!lafter.empty())
4022 posts.insert(make_pair(lkey, lafter));
4023 lkeys.push_back(lkey);
4025 keys = convert_command_inset_arg(getStringFromVector(lkeys));
4026 for (auto const & ptl : pres) {
4027 if (!pretextlist.empty())
4028 pretextlist += '\t';
4029 pretextlist += ptl.first + " " + ptl.second;
4031 for (auto const & potl : posts) {
4032 if (!posttextlist.empty())
4033 posttextlist += '\t';
4034 posttextlist += potl.first + " " + potl.second;
4037 keys = convert_command_inset_arg(p.verbatim_item());
4038 begin_command_inset(os, "citation", command);
4039 os << "after " << '"' << after << '"' << "\n";
4040 os << "before " << '"' << before << '"' << "\n";
4044 if (!pretextlist.empty())
4045 os << "pretextlist " << '"' << pretextlist << '"' << "\n";
4046 if (!posttextlist.empty())
4047 os << "posttextlist " << '"' << posttextlist << '"' << "\n";
4048 os << "literal \"true\"\n";
4050 // Need to set the cite engine if biblatex is loaded by
4051 // the document class directly
4052 if (preamble.citeEngine() == "basic")
4053 use_biblatex_natbib ?
4054 preamble.citeEngine("biblatex-natbib")
4055 : preamble.citeEngine("biblatex");
4060 is_known(t.cs(), known_jurabib_commands) &&
4061 (t.cs() == "cite" || p.next_token().asInput() != "*")) {
4062 context.check_layout(os);
4063 string command = t.cs();
4064 if (p.next_token().asInput() == "*") {
4068 char argumentOrder = '\0';
4069 vector<string> const options =
4070 preamble.getPackageOptions("jurabib");
4071 if (find(options.begin(), options.end(),
4072 "natbiborder") != options.end())
4073 argumentOrder = 'n';
4074 else if (find(options.begin(), options.end(),
4075 "jurabiborder") != options.end())
4076 argumentOrder = 'j';
4078 // text before the citation
4080 // text after the citation
4082 get_cite_arguments(p, argumentOrder != 'j', before, after);
4084 string const citation = p.verbatim_item();
4085 if (!before.empty() && argumentOrder == '\0') {
4086 cerr << "Warning: Assuming argument order "
4087 "of jurabib version 0.6 for\n'"
4088 << command << before << after << '{'
4089 << citation << "}'.\n"
4090 "Add 'jurabiborder' to the jurabib "
4091 "package options if you used an\n"
4092 "earlier jurabib version." << endl;
4094 if (!after.empty()) {
4096 after.erase(after.length() - 1, 1);
4098 if (!before.empty()) {
4100 before.erase(before.length() - 1, 1);
4102 begin_command_inset(os, "citation", command);
4103 os << "after " << '"' << after << "\"\n"
4104 << "before " << '"' << before << "\"\n"
4105 << "key " << '"' << citation << "\"\n"
4106 << "literal \"true\"\n";
4108 // Need to set the cite engine if jurabib is loaded by
4109 // the document class directly
4110 if (preamble.citeEngine() == "basic")
4111 preamble.citeEngine("jurabib");
4115 if (t.cs() == "cite"
4116 || t.cs() == "nocite") {
4117 context.check_layout(os);
4118 string after = convert_command_inset_arg(p.getArg('[', ']'));
4119 string key = convert_command_inset_arg(p.verbatim_item());
4120 // store the case that it is "\nocite{*}" to use it later for
4123 begin_command_inset(os, "citation", t.cs());
4124 os << "after " << '"' << after << "\"\n"
4125 << "key " << '"' << key << "\"\n"
4126 << "literal \"true\"\n";
4128 } else if (t.cs() == "nocite")
4133 if (t.cs() == "index" ||
4134 (t.cs() == "sindex" && preamble.use_indices() == "true")) {
4135 context.check_layout(os);
4136 string const arg = (t.cs() == "sindex" && p.hasOpt()) ?
4137 p.getArg('[', ']') : "";
4138 string const kind = arg.empty() ? "idx" : arg;
4139 begin_inset(os, "Index ");
4140 os << kind << "\nstatus collapsed\n";
4141 parse_text_in_inset(p, os, FLAG_ITEM, false, context, "Index");
4144 preamble.registerAutomaticallyLoadedPackage("splitidx");
4148 if (t.cs() == "nomenclature") {
4149 context.check_layout(os);
4150 begin_command_inset(os, "nomenclature", "nomenclature");
4151 string prefix = convert_command_inset_arg(p.getArg('[', ']'));
4152 if (!prefix.empty())
4153 os << "prefix " << '"' << prefix << '"' << "\n";
4154 os << "symbol " << '"'
4155 << convert_command_inset_arg(p.verbatim_item());
4156 os << "\"\ndescription \""
4157 << convert_command_inset_arg(p.verbatim_item())
4159 << "literal \"true\"\n";
4161 preamble.registerAutomaticallyLoadedPackage("nomencl");
4165 if (t.cs() == "label") {
4166 context.check_layout(os);
4167 begin_command_inset(os, "label", "label");
4169 << convert_command_inset_arg(p.verbatim_item())
4175 if (t.cs() == "lyxmintcaption") {
4176 string const pos = p.getArg('[', ']');
4178 string const caption =
4179 parse_text_snippet(p, FLAG_ITEM, false,
4181 minted_nonfloat_caption = "[t]" + caption;
4183 // We already got the caption at the bottom,
4184 // so simply skip it.
4185 parse_text_snippet(p, FLAG_ITEM, false, context);
4190 if (t.cs() == "printindex" || t.cs() == "printsubindex") {
4191 context.check_layout(os);
4192 string commandname = t.cs();
4194 if (p.next_token().asInput() == "*") {
4199 begin_command_inset(os, "index_print", commandname);
4200 string const indexname = p.getArg('[', ']');
4202 if (indexname.empty())
4203 os << "type \"idx\"\n";
4205 os << "type \"" << indexname << "\"\n";
4206 os << "literal \"true\"\n";
4209 skip_spaces_braces(p);
4210 preamble.registerAutomaticallyLoadedPackage("makeidx");
4211 if (preamble.use_indices() == "true")
4212 preamble.registerAutomaticallyLoadedPackage("splitidx");
4216 if (t.cs() == "printnomenclature") {
4218 string width_type = "";
4219 context.check_layout(os);
4220 begin_command_inset(os, "nomencl_print", "printnomenclature");
4221 // case of a custom width
4223 width = p.getArg('[', ']');
4224 width = translate_len(width);
4225 width_type = "custom";
4227 // case of no custom width
4228 // the case of no custom width but the width set
4229 // via \settowidth{\nomlabelwidth}{***} cannot be supported
4230 // because the user could have set anything, not only the width
4231 // of the longest label (which would be width_type = "auto")
4232 string label = convert_command_inset_arg(p.getArg('{', '}'));
4233 if (label.empty() && width_type.empty())
4234 width_type = "none";
4235 os << "set_width \"" << width_type << "\"\n";
4236 if (width_type == "custom")
4237 os << "width \"" << width << '\"';
4239 skip_spaces_braces(p);
4240 preamble.registerAutomaticallyLoadedPackage("nomencl");
4244 if ((t.cs() == "textsuperscript" || t.cs() == "textsubscript")) {
4245 context.check_layout(os);
4246 begin_inset(os, "script ");
4247 os << t.cs().substr(4) << '\n';
4248 newinsetlayout = findInsetLayout(context.textclass, t.cs(), true);
4249 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
4251 if (t.cs() == "textsubscript")
4252 preamble.registerAutomaticallyLoadedPackage("subscript");
4256 if ((where = is_known(t.cs(), known_quotes))) {
4257 context.check_layout(os);
4258 begin_inset(os, "Quotes ");
4259 os << known_coded_quotes[where - known_quotes];
4261 // LyX adds {} after the quote, so we have to eat
4262 // spaces here if there are any before a possible
4264 eat_whitespace(p, os, context, false);
4269 if ((where = is_known(t.cs(), known_sizes)) &&
4270 context.new_layout_allowed) {
4271 context.check_layout(os);
4272 TeXFont const oldFont = context.font;
4273 context.font.size = known_coded_sizes[where - known_sizes];
4274 output_font_change(os, oldFont, context.font);
4275 eat_whitespace(p, os, context, false);
4279 if ((where = is_known(t.cs(), known_font_families)) &&
4280 context.new_layout_allowed) {
4281 context.check_layout(os);
4282 TeXFont const oldFont = context.font;
4283 context.font.family =
4284 known_coded_font_families[where - known_font_families];
4285 output_font_change(os, oldFont, context.font);
4286 eat_whitespace(p, os, context, false);
4290 if ((where = is_known(t.cs(), known_font_series)) &&
4291 context.new_layout_allowed) {
4292 context.check_layout(os);
4293 TeXFont const oldFont = context.font;
4294 context.font.series =
4295 known_coded_font_series[where - known_font_series];
4296 output_font_change(os, oldFont, context.font);
4297 eat_whitespace(p, os, context, false);
4301 if ((where = is_known(t.cs(), known_font_shapes)) &&
4302 context.new_layout_allowed) {
4303 context.check_layout(os);
4304 TeXFont const oldFont = context.font;
4305 context.font.shape =
4306 known_coded_font_shapes[where - known_font_shapes];
4307 output_font_change(os, oldFont, context.font);
4308 eat_whitespace(p, os, context, false);
4311 if ((where = is_known(t.cs(), known_old_font_families)) &&
4312 context.new_layout_allowed) {
4313 context.check_layout(os);
4314 TeXFont const oldFont = context.font;
4315 context.font.init();
4316 context.font.size = oldFont.size;
4317 context.font.family =
4318 known_coded_font_families[where - known_old_font_families];
4319 output_font_change(os, oldFont, context.font);
4320 eat_whitespace(p, os, context, false);
4324 if ((where = is_known(t.cs(), known_old_font_series)) &&
4325 context.new_layout_allowed) {
4326 context.check_layout(os);
4327 TeXFont const oldFont = context.font;
4328 context.font.init();
4329 context.font.size = oldFont.size;
4330 context.font.series =
4331 known_coded_font_series[where - known_old_font_series];
4332 output_font_change(os, oldFont, context.font);
4333 eat_whitespace(p, os, context, false);
4337 if ((where = is_known(t.cs(), known_old_font_shapes)) &&
4338 context.new_layout_allowed) {
4339 context.check_layout(os);
4340 TeXFont const oldFont = context.font;
4341 context.font.init();
4342 context.font.size = oldFont.size;
4343 context.font.shape =
4344 known_coded_font_shapes[where - known_old_font_shapes];
4345 output_font_change(os, oldFont, context.font);
4346 eat_whitespace(p, os, context, false);
4350 if (t.cs() == "selectlanguage") {
4351 context.check_layout(os);
4352 // save the language for the case that a
4353 // \foreignlanguage is used
4354 context.font.language = babel2lyx(p.verbatim_item());
4355 os << "\n\\lang " << context.font.language << "\n";
4359 if (t.cs() == "foreignlanguage") {
4360 string const lang = babel2lyx(p.verbatim_item());
4361 parse_text_attributes(p, os, FLAG_ITEM, outer,
4363 context.font.language, lang);
4367 if (prefixIs(t.cs(), "text") && preamble.usePolyglossia()
4368 && is_known(t.cs().substr(4), preamble.polyglossia_languages)) {
4369 // scheme is \textLANGUAGE{text} where LANGUAGE is in polyglossia_languages[]
4371 // We have to output the whole command if it has an option
4372 // because LyX doesn't support this yet, see bug #8214,
4373 // only if there is a single option specifying a variant, we can handle it.
4375 string langopts = p.getOpt();
4376 // check if the option contains a variant, if yes, extract it
4377 string::size_type pos_var = langopts.find("variant");
4378 string::size_type i = langopts.find(',');
4379 string::size_type k = langopts.find('=', pos_var);
4380 if (pos_var != string::npos && i == string::npos) {
4382 variant = langopts.substr(k + 1, langopts.length() - k - 2);
4383 lang = preamble.polyglossia2lyx(variant);
4384 parse_text_attributes(p, os, FLAG_ITEM, outer,
4386 context.font.language, lang);
4388 output_ert_inset(os, t.asInput() + langopts, context);
4390 lang = preamble.polyglossia2lyx(t.cs().substr(4, string::npos));
4391 parse_text_attributes(p, os, FLAG_ITEM, outer,
4393 context.font.language, lang);
4398 if (t.cs() == "inputencoding") {
4399 // nothing to write here
4400 string const enc = subst(p.verbatim_item(), "\n", " ");
4401 p.setEncoding(enc, Encoding::inputenc);
4405 if (is_known(t.cs(), known_special_chars) ||
4406 (t.cs() == "protect" &&
4407 p.next_token().cat() == catEscape &&
4408 is_known(p.next_token().cs(), known_special_protect_chars))) {
4409 // LyX sometimes puts a \protect in front, so we have to ignore it
4411 t.cs() == "protect" ? p.get_token().cs() : t.cs(),
4412 known_special_chars);
4413 context.check_layout(os);
4414 os << known_coded_special_chars[where - known_special_chars];
4415 skip_spaces_braces(p);
4419 if ((t.cs() == "nobreakdash" && p.next_token().asInput() == "-") ||
4420 (t.cs() == "protect" && p.next_token().asInput() == "\\nobreakdash" &&
4421 p.next_next_token().asInput() == "-") ||
4422 (t.cs() == "@" && p.next_token().asInput() == ".")) {
4423 // LyX sometimes puts a \protect in front, so we have to ignore it
4424 if (t.cs() == "protect")
4426 context.check_layout(os);
4427 if (t.cs() == "nobreakdash")
4428 os << "\\SpecialChar nobreakdash\n";
4430 os << "\\SpecialChar endofsentence\n";
4435 if (t.cs() == "textquotedbl") {
4436 context.check_layout(os);
4442 if (t.cs() == "_" || t.cs() == "&" || t.cs() == "#"
4443 || t.cs() == "$" || t.cs() == "{" || t.cs() == "}"
4444 || t.cs() == "%" || t.cs() == "-") {
4445 context.check_layout(os);
4447 os << "\\SpecialChar softhyphen\n";
4453 if (t.cs() == "char") {
4454 context.check_layout(os);
4455 if (p.next_token().character() == '`') {
4457 if (p.next_token().cs() == "\"") {
4462 output_ert_inset(os, "\\char`", context);
4465 output_ert_inset(os, "\\char", context);
4470 if (t.cs() == "verb") {
4471 context.check_layout(os);
4472 // set catcodes to verbatim early, just in case.
4473 p.setCatcodes(VERBATIM_CATCODES);
4474 string delim = p.get_token().asInput();
4475 Parser::Arg arg = p.verbatimStuff(delim);
4477 output_ert_inset(os, "\\verb" + delim
4478 + arg.second + delim, context);
4480 cerr << "invalid \\verb command. Skipping" << endl;
4484 // Problem: \= creates a tabstop inside the tabbing environment
4485 // and else an accent. In the latter case we really would want
4486 // \={o} instead of \= o.
4487 if (t.cs() == "=" && (flags & FLAG_TABBING)) {
4488 output_ert_inset(os, t.asInput(), context);
4492 if (t.cs() == "\\") {
4493 context.check_layout(os);
4495 output_ert_inset(os, "\\\\" + p.getOpt(), context);
4496 else if (p.next_token().asInput() == "*") {
4498 // getOpt() eats the following space if there
4499 // is no optional argument, but that is OK
4500 // here since it has no effect in the output.
4501 output_ert_inset(os, "\\\\*" + p.getOpt(), context);
4504 begin_inset(os, "Newline newline");
4510 if (t.cs() == "newline" ||
4511 (t.cs() == "linebreak" && !p.hasOpt())) {
4512 context.check_layout(os);
4513 begin_inset(os, "Newline ");
4516 skip_spaces_braces(p);
4520 if (t.cs() == "input" || t.cs() == "include"
4521 || t.cs() == "verbatiminput") {
4522 string name = t.cs();
4523 if (t.cs() == "verbatiminput"
4524 && p.next_token().asInput() == "*")
4525 name += p.get_token().asInput();
4526 context.check_layout(os);
4527 string filename(normalize_filename(p.getArg('{', '}')));
4528 string const path = getMasterFilePath(true);
4529 // We want to preserve relative / absolute filenames,
4530 // therefore path is only used for testing
4531 if ((t.cs() == "include" || t.cs() == "input") &&
4532 !makeAbsPath(filename, path).exists()) {
4533 // The file extension is probably missing.
4534 // Now try to find it out.
4535 string const tex_name =
4536 find_file(filename, path,
4537 known_tex_extensions);
4538 if (!tex_name.empty())
4539 filename = tex_name;
4541 bool external = false;
4543 if (makeAbsPath(filename, path).exists()) {
4544 string const abstexname =
4545 makeAbsPath(filename, path).absFileName();
4546 string const absfigname =
4547 changeExtension(abstexname, ".fig");
4548 fix_child_filename(filename);
4549 string const lyxname = changeExtension(filename,
4550 roundtripMode() ? ".lyx.lyx" : ".lyx");
4551 string const abslyxname = makeAbsPath(
4552 lyxname, getParentFilePath(false)).absFileName();
4554 if (!skipChildren())
4555 external = FileName(absfigname).exists();
4556 if (t.cs() == "input" && !skipChildren()) {
4557 string const ext = getExtension(abstexname);
4559 // Combined PS/LaTeX:
4560 // x.eps, x.pstex_t (old xfig)
4561 // x.pstex, x.pstex_t (new xfig, e.g. 3.2.5)
4562 FileName const absepsname(
4563 changeExtension(abstexname, ".eps"));
4564 FileName const abspstexname(
4565 changeExtension(abstexname, ".pstex"));
4566 bool const xfigeps =
4567 (absepsname.exists() ||
4568 abspstexname.exists()) &&
4571 // Combined PDF/LaTeX:
4572 // x.pdf, x.pdftex_t (old xfig)
4573 // x.pdf, x.pdf_t (new xfig, e.g. 3.2.5)
4574 FileName const abspdfname(
4575 changeExtension(abstexname, ".pdf"));
4576 bool const xfigpdf =
4577 abspdfname.exists() &&
4578 (ext == "pdftex_t" || ext == "pdf_t");
4582 // Combined PS/PDF/LaTeX:
4583 // x_pspdftex.eps, x_pspdftex.pdf, x.pspdftex
4584 string const absbase2(
4585 removeExtension(abstexname) + "_pspdftex");
4586 FileName const abseps2name(
4587 addExtension(absbase2, ".eps"));
4588 FileName const abspdf2name(
4589 addExtension(absbase2, ".pdf"));
4590 bool const xfigboth =
4591 abspdf2name.exists() &&
4592 abseps2name.exists() && ext == "pspdftex";
4594 xfig = xfigpdf || xfigeps || xfigboth;
4595 external = external && xfig;
4598 outname = changeExtension(filename, ".fig");
4599 FileName abssrc(changeExtension(abstexname, ".fig"));
4600 copy_file(abssrc, outname);
4602 // Don't try to convert, the result
4603 // would be full of ERT.
4605 FileName abssrc(abstexname);
4606 copy_file(abssrc, outname);
4607 } else if (t.cs() != "verbatiminput" &&
4609 tex2lyx(abstexname, FileName(abslyxname),
4612 // no need to call copy_file
4613 // tex2lyx creates the file
4616 FileName abssrc(abstexname);
4617 copy_file(abssrc, outname);
4620 cerr << "Warning: Could not find included file '"
4621 << filename << "'." << endl;
4625 begin_inset(os, "External\n");
4626 os << "\ttemplate XFig\n"
4627 << "\tfilename " << outname << '\n';
4628 registerExternalTemplatePackages("XFig");
4630 begin_command_inset(os, "include", name);
4631 outname = subst(outname, "\"", "\\\"");
4632 os << "preview false\n"
4633 "filename \"" << outname << "\"\n";
4634 if (t.cs() == "verbatiminput")
4635 preamble.registerAutomaticallyLoadedPackage("verbatim");
4641 if (t.cs() == "bibliographystyle") {
4642 // store new bibliographystyle
4643 bibliographystyle = p.verbatim_item();
4644 // If any other command than \bibliography, \addcontentsline
4645 // and \nocite{*} follows, we need to output the style
4646 // (because it might be used by that command).
4647 // Otherwise, it will automatically be output by LyX.
4650 for (Token t2 = p.get_token(); p.good(); t2 = p.get_token()) {
4651 if (t2.cat() == catBegin)
4653 if (t2.cat() != catEscape)
4655 if (t2.cs() == "nocite") {
4656 if (p.getArg('{', '}') == "*")
4658 } else if (t2.cs() == "bibliography")
4660 else if (t2.cs() == "phantomsection") {
4664 else if (t2.cs() == "addcontentsline") {
4665 // get the 3 arguments of \addcontentsline
4668 contentslineContent = p.getArg('{', '}');
4669 // if the last argument is not \refname we must output
4670 if (contentslineContent == "\\refname")
4677 output_ert_inset(os,
4678 "\\bibliographystyle{" + bibliographystyle + '}',
4684 if (t.cs() == "phantomsection") {
4685 // we only support this if it occurs between
4686 // \bibliographystyle and \bibliography
4687 if (bibliographystyle.empty())
4688 output_ert_inset(os, "\\phantomsection", context);
4692 if (t.cs() == "addcontentsline") {
4693 context.check_layout(os);
4694 // get the 3 arguments of \addcontentsline
4695 string const one = p.getArg('{', '}');
4696 string const two = p.getArg('{', '}');
4697 string const three = p.getArg('{', '}');
4698 // only if it is a \refname, we support if for the bibtex inset
4699 if (contentslineContent != "\\refname") {
4700 output_ert_inset(os,
4701 "\\addcontentsline{" + one + "}{" + two + "}{"+ three + '}',
4707 else if (t.cs() == "bibliography") {
4708 context.check_layout(os);
4710 begin_command_inset(os, "bibtex", "bibtex");
4711 if (!btprint.empty()) {
4712 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
4713 // clear the string because the next BibTeX inset can be without the
4714 // \nocite{*} option
4717 os << "bibfiles " << '"' << normalize_filename(p.verbatim_item()) << '"' << "\n";
4718 // Do we have addcontentsline?
4719 if (contentslineContent == "\\refname") {
4720 BibOpts = "bibtotoc";
4721 // clear string because next BibTeX inset can be without addcontentsline
4722 contentslineContent.clear();
4724 // Do we have a bibliographystyle set?
4725 if (!bibliographystyle.empty()) {
4726 if (BibOpts.empty())
4727 BibOpts = normalize_filename(bibliographystyle);
4729 BibOpts = BibOpts + ',' + normalize_filename(bibliographystyle);
4730 // clear it because each bibtex entry has its style
4731 // and we need an empty string to handle \phantomsection
4732 bibliographystyle.clear();
4734 os << "options " << '"' << BibOpts << '"' << "\n";
4739 if (t.cs() == "printbibliography") {
4740 context.check_layout(os);
4742 string bbloptions = p.hasOpt() ? p.getArg('[', ']') : string();
4743 vector<string> opts = getVectorFromString(bbloptions);
4744 vector<string>::iterator it =
4745 find(opts.begin(), opts.end(), "heading=bibintoc");
4746 if (it != opts.end()) {
4748 BibOpts = "bibtotoc";
4750 bbloptions = getStringFromVector(opts);
4751 begin_command_inset(os, "bibtex", "bibtex");
4752 if (!btprint.empty()) {
4753 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
4754 // clear the string because the next BibTeX inset can be without the
4755 // \nocite{*} option
4759 for (auto const & bf : preamble.biblatex_bibliographies) {
4760 if (!bibfiles.empty())
4762 bibfiles += normalize_filename(bf);
4764 if (!bibfiles.empty())
4765 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
4766 // Do we have addcontentsline?
4767 if (contentslineContent == "\\refname") {
4768 BibOpts = "bibtotoc";
4769 // clear string because next BibTeX inset can be without addcontentsline
4770 contentslineContent.clear();
4772 os << "options " << '"' << BibOpts << '"' << "\n";
4773 if (!bbloptions.empty())
4774 os << "biblatexopts " << '"' << bbloptions << '"' << "\n";
4776 need_commentbib = false;
4780 if (t.cs() == "bibbysection") {
4781 context.check_layout(os);
4783 string bbloptions = p.hasOpt() ? p.getArg('[', ']') : string();
4784 vector<string> opts = getVectorFromString(bbloptions);
4785 vector<string>::iterator it =
4786 find(opts.begin(), opts.end(), "heading=bibintoc");
4787 if (it != opts.end()) {
4789 BibOpts = "bibtotoc";
4791 bbloptions = getStringFromVector(opts);
4792 begin_command_inset(os, "bibtex", "bibtex");
4793 os << "btprint " << '"' << "bibbysection" << '"' << "\n";
4795 for (auto const & bf : preamble.biblatex_bibliographies) {
4796 if (!bibfiles.empty())
4798 bibfiles += normalize_filename(bf);
4800 if (!bibfiles.empty())
4801 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
4802 os << "options " << '"' << BibOpts << '"' << "\n";
4803 if (!bbloptions.empty())
4804 os << "biblatexopts " << '"' << bbloptions << '"' << "\n";
4806 need_commentbib = false;
4810 if (t.cs() == "parbox") {
4811 // Test whether this is an outer box of a shaded box
4813 // swallow arguments
4814 while (p.hasOpt()) {
4816 p.skip_spaces(true);
4819 p.skip_spaces(true);
4821 if (p.next_token().cat() == catBegin)
4823 p.skip_spaces(true);
4824 Token to = p.get_token();
4825 bool shaded = false;
4826 if (to.asInput() == "\\begin") {
4827 p.skip_spaces(true);
4828 if (p.getArg('{', '}') == "shaded")
4833 parse_outer_box(p, os, FLAG_ITEM, outer,
4834 context, "parbox", "shaded");
4836 parse_box(p, os, 0, FLAG_ITEM, outer, context,
4837 "", "", t.cs(), "", "");
4841 if (t.cs() == "fbox" || t.cs() == "mbox" ||
4842 t.cs() == "ovalbox" || t.cs() == "Ovalbox" ||
4843 t.cs() == "shadowbox" || t.cs() == "doublebox") {
4844 parse_outer_box(p, os, FLAG_ITEM, outer, context, t.cs(), "");
4848 if (t.cs() == "fcolorbox" || t.cs() == "colorbox") {
4849 string backgroundcolor;
4850 preamble.registerAutomaticallyLoadedPackage("xcolor");
4851 if (t.cs() == "fcolorbox") {
4852 string const framecolor = p.getArg('{', '}');
4853 backgroundcolor = p.getArg('{', '}');
4854 parse_box(p, os, 0, 0, outer, context, "", "", "", framecolor, backgroundcolor);
4856 backgroundcolor = p.getArg('{', '}');
4857 parse_box(p, os, 0, 0, outer, context, "", "", "", "", backgroundcolor);
4862 // FIXME: due to the compiler limit of "if" nestings
4863 // the code for the alignment was put here
4864 // put them in their own if if this is fixed
4865 if (t.cs() == "fboxrule" || t.cs() == "fboxsep"
4866 || t.cs() == "shadowsize"
4867 || t.cs() == "raggedleft" || t.cs() == "centering"
4868 || t.cs() == "raggedright") {
4869 if (t.cs() == "fboxrule")
4871 if (t.cs() == "fboxsep")
4873 if (t.cs() == "shadowsize")
4875 if (t.cs() != "raggedleft" && t.cs() != "centering"
4876 && t.cs() != "raggedright") {
4877 p.skip_spaces(true);
4878 while (p.good() && p.next_token().cat() != catSpace
4879 && p.next_token().cat() != catNewline
4880 && p.next_token().cat() != catEscape) {
4881 if (t.cs() == "fboxrule")
4882 fboxrule = fboxrule + p.get_token().asInput();
4883 if (t.cs() == "fboxsep")
4884 fboxsep = fboxsep + p.get_token().asInput();
4885 if (t.cs() == "shadowsize")
4886 shadow_size = shadow_size + p.get_token().asInput();
4889 output_ert_inset(os, t.asInput(), context);
4894 //\framebox() is part of the picture environment and different from \framebox{}
4895 //\framebox{} will be parsed by parse_outer_box
4896 if (t.cs() == "framebox") {
4897 if (p.next_token().character() == '(') {
4898 //the syntax is: \framebox(x,y)[position]{content}
4899 string arg = t.asInput();
4900 arg += p.getFullParentheseArg();
4901 arg += p.getFullOpt();
4902 eat_whitespace(p, os, context, false);
4903 output_ert_inset(os, arg + '{', context);
4904 parse_text(p, os, FLAG_ITEM, outer, context);
4905 output_ert_inset(os, "}", context);
4907 //the syntax is: \framebox[width][position]{content}
4908 string special = p.getFullOpt();
4909 special += p.getOpt();
4910 parse_outer_box(p, os, FLAG_ITEM, outer,
4911 context, t.cs(), special);
4916 //\makebox() is part of the picture environment and different from \makebox{}
4917 //\makebox{} will be parsed by parse_box
4918 if (t.cs() == "makebox") {
4919 if (p.next_token().character() == '(') {
4920 //the syntax is: \makebox(x,y)[position]{content}
4921 string arg = t.asInput();
4922 arg += p.getFullParentheseArg();
4923 arg += p.getFullOpt();
4924 eat_whitespace(p, os, context, false);
4925 output_ert_inset(os, arg + '{', context);
4926 parse_text(p, os, FLAG_ITEM, outer, context);
4927 output_ert_inset(os, "}", context);
4929 //the syntax is: \makebox[width][position]{content}
4930 parse_box(p, os, 0, FLAG_ITEM, outer, context,
4931 "", "", t.cs(), "", "");
4935 if (t.cs() == "smallskip" ||
4936 t.cs() == "medskip" ||
4937 t.cs() == "bigskip" ||
4938 t.cs() == "vfill") {
4939 context.check_layout(os);
4940 begin_inset(os, "VSpace ");
4943 skip_spaces_braces(p);
4947 if ((where = is_known(t.cs(), known_spaces))) {
4948 context.check_layout(os);
4949 begin_inset(os, "space ");
4950 os << '\\' << known_coded_spaces[where - known_spaces]
4953 // LaTeX swallows whitespace after all spaces except
4954 // "\\,". We have to do that here, too, because LyX
4955 // adds "{}" which would make the spaces significant.
4957 eat_whitespace(p, os, context, false);
4958 // LyX adds "{}" after all spaces except "\\ " and
4959 // "\\,", so we have to remove "{}".
4960 // "\\,{}" is equivalent to "\\," in LaTeX, so we
4961 // remove the braces after "\\,", too.
4967 if (t.cs() == "newpage" ||
4968 (t.cs() == "pagebreak" && !p.hasOpt()) ||
4969 t.cs() == "clearpage" ||
4970 t.cs() == "cleardoublepage") {
4971 context.check_layout(os);
4972 begin_inset(os, "Newpage ");
4975 skip_spaces_braces(p);
4979 if (t.cs() == "DeclareRobustCommand" ||
4980 t.cs() == "DeclareRobustCommandx" ||
4981 t.cs() == "newcommand" ||
4982 t.cs() == "newcommandx" ||
4983 t.cs() == "providecommand" ||
4984 t.cs() == "providecommandx" ||
4985 t.cs() == "renewcommand" ||
4986 t.cs() == "renewcommandx") {
4987 // DeclareRobustCommand, DeclareRobustCommandx,
4988 // providecommand and providecommandx could be handled
4989 // by parse_command(), but we need to call
4990 // add_known_command() here.
4991 string name = t.asInput();
4992 if (p.next_token().asInput() == "*") {
4993 // Starred form. Eat '*'
4997 string const command = p.verbatim_item();
4998 string const opt1 = p.getFullOpt();
4999 string const opt2 = p.getFullOpt();
5000 add_known_command(command, opt1, !opt2.empty());
5001 string const ert = name + '{' + command + '}' +
5003 '{' + p.verbatim_item() + '}';
5005 if (t.cs() == "DeclareRobustCommand" ||
5006 t.cs() == "DeclareRobustCommandx" ||
5007 t.cs() == "providecommand" ||
5008 t.cs() == "providecommandx" ||
5009 name[name.length()-1] == '*')
5010 output_ert_inset(os, ert, context);
5012 context.check_layout(os);
5013 begin_inset(os, "FormulaMacro");
5020 if (t.cs() == "let" && p.next_token().asInput() != "*") {
5021 // let could be handled by parse_command(),
5022 // but we need to call add_known_command() here.
5023 string ert = t.asInput();
5026 if (p.next_token().cat() == catBegin) {
5027 name = p.verbatim_item();
5028 ert += '{' + name + '}';
5030 name = p.verbatim_item();
5035 if (p.next_token().cat() == catBegin) {
5036 command = p.verbatim_item();
5037 ert += '{' + command + '}';
5039 command = p.verbatim_item();
5042 // If command is known, make name known too, to parse
5043 // its arguments correctly. For this reason we also
5044 // have commands in syntax.default that are hardcoded.
5045 CommandMap::iterator it = known_commands.find(command);
5046 if (it != known_commands.end())
5047 known_commands[t.asInput()] = it->second;
5048 output_ert_inset(os, ert, context);
5052 if (t.cs() == "hspace" || t.cs() == "vspace") {
5055 string name = t.asInput();
5056 string const length = p.verbatim_item();
5059 bool valid = splitLatexLength(length, valstring, unit);
5060 bool known_hspace = false;
5061 bool known_vspace = false;
5062 bool known_unit = false;
5065 istringstream iss(valstring);
5068 if (t.cs()[0] == 'h') {
5069 if (unit == "\\fill") {
5074 known_hspace = true;
5077 if (unit == "\\smallskipamount") {
5079 known_vspace = true;
5080 } else if (unit == "\\medskipamount") {
5082 known_vspace = true;
5083 } else if (unit == "\\bigskipamount") {
5085 known_vspace = true;
5086 } else if (unit == "\\fill") {
5088 known_vspace = true;
5092 if (!known_hspace && !known_vspace) {
5093 switch (unitFromString(unit)) {
5109 //unitFromString(unit) fails for relative units like Length::PCW
5110 // therefore handle them separately
5111 if (unit == "\\paperwidth" || unit == "\\columnwidth"
5112 || unit == "\\textwidth" || unit == "\\linewidth"
5113 || unit == "\\textheight" || unit == "\\paperheight"
5114 || unit == "\\baselineskip")
5122 // check for glue lengths
5123 bool is_gluelength = false;
5124 string gluelength = length;
5125 string::size_type i = length.find(" minus");
5126 if (i == string::npos) {
5127 i = length.find(" plus");
5128 if (i != string::npos)
5129 is_gluelength = true;
5131 is_gluelength = true;
5132 // if yes transform "9xx minus 8yy plus 7zz"
5134 if (is_gluelength) {
5135 i = gluelength.find(" minus");
5136 if (i != string::npos)
5137 gluelength.replace(i, 7, "-");
5138 i = gluelength.find(" plus");
5139 if (i != string::npos)
5140 gluelength.replace(i, 6, "+");
5143 if (t.cs()[0] == 'h' && (known_unit || known_hspace || is_gluelength)) {
5144 // Literal horizontal length or known variable
5145 context.check_layout(os);
5146 begin_inset(os, "space ");
5154 if (known_unit && !known_hspace)
5155 os << "\n\\length " << translate_len(length);
5157 os << "\n\\length " << gluelength;
5159 } else if (known_unit || known_vspace || is_gluelength) {
5160 // Literal vertical length or known variable
5161 context.check_layout(os);
5162 begin_inset(os, "VSpace ");
5165 if (known_unit && !known_vspace)
5166 os << translate_len(length);
5173 // LyX can't handle other length variables in Inset VSpace/space
5178 output_ert_inset(os, name + '{' + unit + '}', context);
5179 else if (value == -1.0)
5180 output_ert_inset(os, name + "{-" + unit + '}', context);
5182 output_ert_inset(os, name + '{' + valstring + unit + '}', context);
5184 output_ert_inset(os, name + '{' + length + '}', context);
5189 // The single '=' is meant here.
5190 if ((newinsetlayout = findInsetLayout(context.textclass, starredname, true))) {
5194 context.check_layout(os);
5195 docstring const name = newinsetlayout->name();
5196 bool const caption = name.find(from_ascii("Caption:")) == 0;
5198 // Already done for floating minted listings.
5199 if (minted_float.empty()) {
5200 begin_inset(os, "Caption ");
5201 os << to_utf8(name.substr(8)) << '\n';
5204 begin_inset(os, "Flex ");
5205 os << to_utf8(name) << '\n'
5206 << "status collapsed\n";
5208 if (!minted_float.empty()) {
5209 parse_text_snippet(p, os, FLAG_ITEM, false, context);
5210 } else if (newinsetlayout->isPassThru()) {
5211 // set catcodes to verbatim early, just in case.
5212 p.setCatcodes(VERBATIM_CATCODES);
5213 string delim = p.get_token().asInput();
5215 cerr << "Warning: bad delimiter for command " << t.asInput() << endl;
5216 //FIXME: handle error condition
5217 string const arg = p.verbatimStuff("}").second;
5218 Context newcontext(true, context.textclass);
5219 if (newinsetlayout->forcePlainLayout())
5220 newcontext.layout = &context.textclass.plainLayout();
5221 output_ert(os, arg, newcontext);
5223 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
5226 // Minted caption insets are not closed here because
5227 // we collect everything into the caption.
5228 if (minted_float.empty())
5233 if (t.cs() == "includepdf") {
5235 string const arg = p.getArg('[', ']');
5236 map<string, string> opts;
5237 vector<string> keys;
5238 split_map(arg, opts, keys);
5239 string name = normalize_filename(p.verbatim_item());
5240 string const path = getMasterFilePath(true);
5241 // We want to preserve relative / absolute filenames,
5242 // therefore path is only used for testing
5243 if (!makeAbsPath(name, path).exists()) {
5244 // The file extension is probably missing.
5245 // Now try to find it out.
5246 char const * const pdfpages_format[] = {"pdf", 0};
5247 string const pdftex_name =
5248 find_file(name, path, pdfpages_format);
5249 if (!pdftex_name.empty()) {
5254 FileName const absname = makeAbsPath(name, path);
5255 if (absname.exists())
5257 fix_child_filename(name);
5258 copy_file(absname, name);
5260 cerr << "Warning: Could not find file '"
5261 << name << "'." << endl;
5263 context.check_layout(os);
5264 begin_inset(os, "External\n\ttemplate ");
5265 os << "PDFPages\n\tfilename "
5267 // parse the options
5268 if (opts.find("pages") != opts.end())
5269 os << "\textra LaTeX \"pages="
5270 << opts["pages"] << "\"\n";
5271 if (opts.find("angle") != opts.end())
5272 os << "\trotateAngle "
5273 << opts["angle"] << '\n';
5274 if (opts.find("origin") != opts.end()) {
5276 string const opt = opts["origin"];
5277 if (opt == "tl") ss << "topleft";
5278 if (opt == "bl") ss << "bottomleft";
5279 if (opt == "Bl") ss << "baselineleft";
5280 if (opt == "c") ss << "center";
5281 if (opt == "tc") ss << "topcenter";
5282 if (opt == "bc") ss << "bottomcenter";
5283 if (opt == "Bc") ss << "baselinecenter";
5284 if (opt == "tr") ss << "topright";
5285 if (opt == "br") ss << "bottomright";
5286 if (opt == "Br") ss << "baselineright";
5287 if (!ss.str().empty())
5288 os << "\trotateOrigin " << ss.str() << '\n';
5290 cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
5292 if (opts.find("width") != opts.end())
5294 << translate_len(opts["width"]) << '\n';
5295 if (opts.find("height") != opts.end())
5297 << translate_len(opts["height"]) << '\n';
5298 if (opts.find("keepaspectratio") != opts.end())
5299 os << "\tkeepAspectRatio\n";
5301 context.check_layout(os);
5302 registerExternalTemplatePackages("PDFPages");
5306 if (t.cs() == "loadgame") {
5308 string name = normalize_filename(p.verbatim_item());
5309 string const path = getMasterFilePath(true);
5310 // We want to preserve relative / absolute filenames,
5311 // therefore path is only used for testing
5312 if (!makeAbsPath(name, path).exists()) {
5313 // The file extension is probably missing.
5314 // Now try to find it out.
5315 char const * const lyxskak_format[] = {"fen", 0};
5316 string const lyxskak_name =
5317 find_file(name, path, lyxskak_format);
5318 if (!lyxskak_name.empty())
5319 name = lyxskak_name;
5321 FileName const absname = makeAbsPath(name, path);
5322 if (absname.exists())
5324 fix_child_filename(name);
5325 copy_file(absname, name);
5327 cerr << "Warning: Could not find file '"
5328 << name << "'." << endl;
5329 context.check_layout(os);
5330 begin_inset(os, "External\n\ttemplate ");
5331 os << "ChessDiagram\n\tfilename "
5334 context.check_layout(os);
5335 // after a \loadgame follows a \showboard
5336 if (p.get_token().asInput() == "showboard")
5338 registerExternalTemplatePackages("ChessDiagram");
5342 // try to see whether the string is in unicodesymbols
5343 // Only use text mode commands, since we are in text mode here,
5344 // and math commands may be invalid (bug 6797)
5345 string name = t.asInput();
5346 // handle the dingbats, cyrillic and greek
5347 if (name == "\\ding" || name == "\\textcyr" ||
5348 (name == "\\textgreek" && !preamble.usePolyglossia()))
5349 name = name + '{' + p.getArg('{', '}') + '}';
5350 // handle the ifsym characters
5351 else if (name == "\\textifsymbol") {
5352 string const optif = p.getFullOpt();
5353 string const argif = p.getArg('{', '}');
5354 name = name + optif + '{' + argif + '}';
5356 // handle the \ascii characters
5357 // the case of \ascii within braces, as LyX outputs it, is already
5358 // handled for t.cat() == catBegin
5359 else if (name == "\\ascii") {
5360 // the code is "\asci\xxx"
5361 name = "{" + name + p.get_token().asInput() + "}";
5364 // handle some TIPA special characters
5365 else if (preamble.isPackageUsed("tipa")) {
5366 if (name == "\\s") {
5367 // fromLaTeXCommand() does not yet
5368 // recognize tipa short cuts
5369 name = "\\textsyllabic";
5370 } else if (name == "\\=" &&
5371 p.next_token().asInput() == "*") {
5372 // fromLaTeXCommand() does not yet
5373 // recognize tipa short cuts
5375 name = "\\textsubbar";
5376 } else if (name == "\\textdoublevertline") {
5377 // FIXME: This is not correct,
5378 // \textvertline is higher than \textbardbl
5379 name = "\\textbardbl";
5381 } else if (name == "\\!" ) {
5382 if (p.next_token().asInput() == "b") {
5383 p.get_token(); // eat 'b'
5386 } else if (p.next_token().asInput() == "d") {
5390 } else if (p.next_token().asInput() == "g") {
5394 } else if (p.next_token().asInput() == "G") {
5396 name = "\\texthtscg";
5398 } else if (p.next_token().asInput() == "j") {
5400 name = "\\texthtbardotlessj";
5402 } else if (p.next_token().asInput() == "o") {
5404 name = "\\textbullseye";
5407 } else if (name == "\\*" ) {
5408 if (p.next_token().asInput() == "k") {
5410 name = "\\textturnk";
5412 } else if (p.next_token().asInput() == "r") {
5413 p.get_token(); // eat 'b'
5414 name = "\\textturnr";
5416 } else if (p.next_token().asInput() == "t") {
5418 name = "\\textturnt";
5420 } else if (p.next_token().asInput() == "w") {
5422 name = "\\textturnw";
5427 if ((name.size() == 2 &&
5428 contains("\"'.=^`bcdHkrtuv~", name[1]) &&
5429 p.next_token().asInput() != "*") ||
5430 is_known(name.substr(1), known_tipa_marks)) {
5431 // name is a command that corresponds to a
5432 // combining character in unicodesymbols.
5433 // Append the argument, fromLaTeXCommand()
5434 // will either convert it to a single
5435 // character or a combining sequence.
5436 name += '{' + p.verbatim_item() + '}';
5438 // now get the character from unicodesymbols
5442 docstring s = normalize_c(encodings.fromLaTeXCommand(from_utf8(name),
5443 Encodings::TEXT_CMD, termination, rem, &req));
5445 context.check_layout(os);
5448 output_ert_inset(os, to_utf8(rem), context);
5450 skip_spaces_braces(p);
5451 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
5452 preamble.registerAutomaticallyLoadedPackage(*it);
5454 //cerr << "#: " << t << " mode: " << mode << endl;
5455 // heuristic: read up to next non-nested space
5457 string s = t.asInput();
5458 string z = p.verbatim_item();
5459 while (p.good() && z != " " && !z.empty()) {
5460 //cerr << "read: " << z << endl;
5462 z = p.verbatim_item();
5464 cerr << "found ERT: " << s << endl;
5465 output_ert_inset(os, s + ' ', context);
5468 if (t.asInput() == name &&
5469 p.next_token().asInput() == "*") {
5470 // Starred commands like \vspace*{}
5471 p.get_token(); // Eat '*'
5474 if (!parse_command(name, p, os, outer, context))
5475 output_ert_inset(os, name, context);
5481 string guessLanguage(Parser & p, string const & lang)
5483 typedef std::map<std::string, size_t> LangMap;
5484 // map from language names to number of characters
5487 for (char const * const * i = supported_CJK_languages; *i; i++)
5488 used[string(*i)] = 0;
5491 Token const t = p.get_token();
5492 // comments are not counted for any language
5493 if (t.cat() == catComment)
5495 // commands are not counted as well, but we need to detect
5496 // \begin{CJK} and switch encoding if needed
5497 if (t.cat() == catEscape) {
5498 if (t.cs() == "inputencoding") {
5499 string const enc = subst(p.verbatim_item(), "\n", " ");
5500 p.setEncoding(enc, Encoding::inputenc);
5503 if (t.cs() != "begin")
5506 // Non-CJK content is counted for lang.
5507 // We do not care about the real language here:
5508 // If we have more non-CJK contents than CJK contents,
5509 // we simply use the language that was specified as
5510 // babel main language.
5511 used[lang] += t.asInput().length();
5514 // Now we are starting an environment
5516 string const name = p.getArg('{', '}');
5517 if (name != "CJK") {
5521 // It is a CJK environment
5523 /* name = */ p.getArg('{', '}');
5524 string const encoding = p.getArg('{', '}');
5525 /* mapping = */ p.getArg('{', '}');
5526 string const encoding_old = p.getEncoding();
5527 char const * const * const where =
5528 is_known(encoding, supported_CJK_encodings);
5530 p.setEncoding(encoding, Encoding::CJK);
5532 p.setEncoding("UTF-8");
5533 string const text = p.ertEnvironment("CJK");
5534 p.setEncoding(encoding_old);
5537 // ignore contents in unknown CJK encoding
5540 // the language of the text
5542 supported_CJK_languages[where - supported_CJK_encodings];
5543 used[cjk] += text.length();
5545 LangMap::const_iterator use = used.begin();
5546 for (LangMap::const_iterator it = used.begin(); it != used.end(); ++it) {
5547 if (it->second > use->second)
5554 void check_comment_bib(ostream & os, Context & context)
5556 if (!need_commentbib)
5558 // We have a bibliography database, but no bibliography with biblatex
5559 // which is completely valid. Insert a bibtex inset in a note.
5560 context.check_layout(os);
5561 begin_inset(os, "Note Note\n");
5562 os << "status open\n";
5563 os << "\\begin_layout Plain Layout\n";
5564 begin_command_inset(os, "bibtex", "bibtex");
5566 for (auto const & bf : preamble.biblatex_bibliographies) {
5567 if (!bibfiles.empty())
5569 bibfiles += normalize_filename(bf);
5571 if (!bibfiles.empty())
5572 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
5573 end_inset(os);// Bibtex
5574 os << "\\end_layout\n";
5575 end_inset(os);// Note