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, string, 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,
60 bool const forcePlainLayout =
61 layout ? layout->forcePlainLayout() : false;
62 Context newcontext(true, context.textclass);
64 newcontext.layout = &context.textclass.plainLayout();
66 newcontext.font = context.font;
68 output_arguments(os, p, outer, false, string(), newcontext,
70 // If we have a latex param, we eat it here.
71 if (!context.latexparam.empty()) {
73 Context dummy(true, context.textclass);
74 parse_text(p, oss, FLAG_RDELIM, outer, dummy,
75 string(1, context.latexparam.back()));
77 parse_text(p, os, flags, outer, newcontext, rdelim);
79 output_arguments(os, p, outer, false, "post", newcontext,
80 layout->postcommandargs());
81 newcontext.check_end_layout(os);
87 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
88 Context const & context, string const & name,
89 string const rdelim = string())
91 InsetLayout const * layout = 0;
92 DocumentClass::InsetLayouts::const_iterator it =
93 context.textclass.insetLayouts().find(from_ascii(name));
94 if (it != context.textclass.insetLayouts().end())
95 layout = &(it->second);
96 parse_text_in_inset(p, os, flags, outer, context, layout, rdelim);
99 /// parses a paragraph snippet, useful for example for \\emph{...}
100 void parse_text_snippet(Parser & p, ostream & os, unsigned flags, bool outer,
103 Context newcontext(context);
104 // Don't inherit the paragraph-level extra stuff
105 newcontext.par_extra_stuff.clear();
106 parse_text(p, os, flags, outer, newcontext);
107 // Make sure that we don't create invalid .lyx files
108 context.need_layout = newcontext.need_layout;
109 context.need_end_layout = newcontext.need_end_layout;
114 * Thin wrapper around parse_text_snippet() using a string.
116 * We completely ignore \c context.need_layout and \c context.need_end_layout,
117 * because our return value is not used directly (otherwise the stream version
118 * of parse_text_snippet() could be used). That means that the caller needs
119 * to do layout management manually.
120 * This is intended to parse text that does not create any layout changes.
122 string parse_text_snippet(Parser & p, unsigned flags, const bool outer,
125 Context newcontext(context);
126 newcontext.need_layout = false;
127 newcontext.need_end_layout = false;
128 newcontext.new_layout_allowed = false;
129 // Avoid warning by Context::~Context()
130 newcontext.par_extra_stuff.clear();
132 parse_text_snippet(p, os, flags, outer, newcontext);
136 string fboxrule = "";
138 string shadow_size = "";
140 char const * const known_ref_commands[] = { "ref", "pageref", "vref",
141 "vpageref", "prettyref", "nameref", "eqref", 0 };
143 char const * const known_coded_ref_commands[] = { "ref", "pageref", "vref",
144 "vpageref", "formatted", "nameref", "eqref", 0 };
146 char const * const known_refstyle_commands[] = { "algref", "chapref", "corref",
147 "eqref", "enuref", "figref", "fnref", "lemref", "parref", "partref", "propref",
148 "secref", "subsecref", "tabref", "thmref", 0 };
150 char const * const known_refstyle_prefixes[] = { "alg", "chap", "cor",
151 "eq", "enu", "fig", "fn", "lem", "par", "part", "prop",
152 "sec", "subsec", "tab", "thm", 0 };
156 * supported CJK encodings
157 * JIS does not work with LyX's encoding conversion
159 const char * const supported_CJK_encodings[] = {
160 "EUC-JP", "KS", "GB", "UTF8",
161 "Bg5", /*"JIS",*/ "SJIS", 0};
164 * the same as supported_CJK_encodings with their corresponding LyX language name
165 * FIXME: The mapping "UTF8" => "chinese-traditional" is only correct for files
167 * NOTE: "Bg5", "JIS" and "SJIS" are not supported by LyX, on re-export the
168 * encodings "UTF8", "EUC-JP" and "EUC-JP" will be used.
169 * please keep this in sync with supported_CJK_encodings line by line!
171 const char * const supported_CJK_languages[] = {
172 "japanese-cjk", "korean", "chinese-simplified", "chinese-traditional",
173 "chinese-traditional", /*"japanese-cjk",*/ "japanese-cjk", 0};
177 * The starred forms are also known except for "citefullauthor",
178 * "citeyear" and "citeyearpar".
180 char const * const known_natbib_commands[] = { "cite", "citet", "citep",
181 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
182 "citefullauthor", "Citet", "Citep", "Citealt", "Citealp", "Citeauthor", 0 };
186 * No starred form other than "cite*" known.
188 char const * const known_jurabib_commands[] = { "cite", "citet", "citep",
189 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
190 // jurabib commands not (yet) supported by LyX:
192 // "footcite", "footcitet", "footcitep", "footcitealt", "footcitealp",
193 // "footciteauthor", "footciteyear", "footciteyearpar",
194 "citefield", "citetitle", 0 };
198 * Known starred forms: \cite*, \citeauthor*, \Citeauthor*, \parencite*, \citetitle*.
200 char const * const known_biblatex_commands[] = { "cite", "Cite", "textcite", "Textcite",
201 "parencite", "Parencite", "citeauthor", "Citeauthor", "citeyear", "smartcite", "Smartcite",
202 "footcite", "Footcite", "autocite", "Autocite", "citetitle", "fullcite", "footfullcite",
203 "supercite", "cites", "Cites", "textcites", "Textcites", "parencites", "Parencites",
204 "smartcites", "Smartcites", "autocites", "Autocites", 0 };
206 // Whether we need to insert a bibtex inset in a comment
207 bool need_commentbib = false;
209 /// LaTeX names for quotes
210 char const * const known_quotes[] = { "dq", "guillemotleft", "flqq", "og",
211 "guillemotright", "frqq", "fg", "glq", "glqq", "textquoteleft", "grq", "grqq",
212 "quotedblbase", "textquotedblleft", "quotesinglbase", "textquoteright", "flq",
213 "guilsinglleft", "frq", "guilsinglright", "textquotedblright", "textquotesingle",
216 /// the same as known_quotes with .lyx names
217 char const * const known_coded_quotes[] = { "qrd", "ard", "ard", "ard",
218 "ald", "ald", "ald", "gls", "gld", "els", "els", "eld",
219 "gld", "eld", "gls", "ers", "ars",
220 "ars", "als", "als", "erd", "qrs", "qrd", 0};
222 /// LaTeX names for font sizes
223 char const * const known_sizes[] = { "tiny", "scriptsize", "footnotesize",
224 "small", "normalsize", "large", "Large", "LARGE", "huge", "Huge", 0};
226 /// the same as known_sizes with .lyx names
227 char const * const known_coded_sizes[] = { "tiny", "scriptsize", "footnotesize",
228 "small", "normal", "large", "larger", "largest", "huge", "giant", 0};
230 /// LaTeX 2.09 names for font families
231 char const * const known_old_font_families[] = { "rm", "sf", "tt", 0};
233 /// LaTeX names for font families
234 char const * const known_font_families[] = { "rmfamily", "sffamily",
237 /// LaTeX names for font family changing commands
238 char const * const known_text_font_families[] = { "textrm", "textsf",
241 /// The same as known_old_font_families, known_font_families and
242 /// known_text_font_families with .lyx names
243 char const * const known_coded_font_families[] = { "roman", "sans",
246 /// LaTeX 2.09 names for font series
247 char const * const known_old_font_series[] = { "bf", 0};
249 /// LaTeX names for font series
250 char const * const known_font_series[] = { "bfseries", "mdseries", 0};
252 /// LaTeX names for font series changing commands
253 char const * const known_text_font_series[] = { "textbf", "textmd", 0};
255 /// The same as known_old_font_series, known_font_series and
256 /// known_text_font_series with .lyx names
257 char const * const known_coded_font_series[] = { "bold", "medium", 0};
259 /// LaTeX 2.09 names for font shapes
260 char const * const known_old_font_shapes[] = { "it", "sl", "sc", 0};
262 /// LaTeX names for font shapes
263 char const * const known_font_shapes[] = { "itshape", "slshape", "scshape",
266 /// LaTeX names for font shape changing commands
267 char const * const known_text_font_shapes[] = { "textit", "textsl", "textsc",
270 /// The same as known_old_font_shapes, known_font_shapes and
271 /// known_text_font_shapes with .lyx names
272 char const * const known_coded_font_shapes[] = { "italic", "slanted",
273 "smallcaps", "up", 0};
275 /// Known special characters which need skip_spaces_braces() afterwards
276 char const * const known_special_chars[] = {"ldots",
277 "lyxarrow", "textcompwordmark",
278 "slash", "textasciitilde", "textasciicircum", "textbackslash",
279 "LyX", "TeX", "LaTeXe",
282 /// special characters from known_special_chars which may have a \\protect before
283 char const * const known_special_protect_chars[] = {"LyX", "TeX",
284 "LaTeXe", "LaTeX", 0};
286 /// the same as known_special_chars with .lyx names
287 char const * const known_coded_special_chars[] = {"\\SpecialChar ldots\n",
288 "\\SpecialChar menuseparator\n", "\\SpecialChar ligaturebreak\n",
289 "\\SpecialChar breakableslash\n", "~", "^", "\n\\backslash\n",
290 "\\SpecialChar LyX\n", "\\SpecialChar TeX\n", "\\SpecialChar LaTeX2e\n",
291 "\\SpecialChar LaTeX\n", 0};
294 * Graphics file extensions known by the dvips driver of the graphics package.
295 * These extensions are used to complete the filename of an included
296 * graphics file if it does not contain an extension.
297 * The order must be the same that latex uses to find a file, because we
298 * will use the first extension that matches.
299 * This is only an approximation for the common cases. If we would want to
300 * do it right in all cases, we would need to know which graphics driver is
301 * used and know the extensions of every driver of the graphics package.
303 char const * const known_dvips_graphics_formats[] = {"eps", "ps", "eps.gz",
304 "ps.gz", "eps.Z", "ps.Z", 0};
307 * Graphics file extensions known by the pdftex driver of the graphics package.
308 * \sa known_dvips_graphics_formats
310 char const * const known_pdftex_graphics_formats[] = {"png", "pdf", "jpg",
314 * Known file extensions for TeX files as used by \\include.
316 char const * const known_tex_extensions[] = {"tex", 0};
318 /// spaces known by InsetSpace
319 char const * const known_spaces[] = { " ", "space", ",",
320 "thinspace", "quad", "qquad", "enspace", "enskip",
321 "negthinspace", "negmedspace", "negthickspace", "textvisiblespace",
322 "hfill", "dotfill", "hrulefill", "leftarrowfill", "rightarrowfill",
323 "upbracefill", "downbracefill", 0};
325 /// the same as known_spaces with .lyx names
326 char const * const known_coded_spaces[] = { "space{}", "space{}",
327 "thinspace{}", "thinspace{}", "quad{}", "qquad{}", "enspace{}", "enskip{}",
328 "negthinspace{}", "negmedspace{}", "negthickspace{}", "textvisiblespace{}",
329 "hfill{}", "dotfill{}", "hrulefill{}", "leftarrowfill{}", "rightarrowfill{}",
330 "upbracefill{}", "downbracefill{}", 0};
332 /// known TIPA combining diacritical marks
333 char const * const known_tipa_marks[] = {"textsubwedge", "textsubumlaut",
334 "textsubtilde", "textseagull", "textsubbridge", "textinvsubbridge",
335 "textsubsquare", "textsubrhalfring", "textsublhalfring", "textsubplus",
336 "textovercross", "textsubarch", "textsuperimposetilde", "textraising",
337 "textlowering", "textadvancing", "textretracting", "textdoublegrave",
338 "texthighrise", "textlowrise", "textrisefall", "textsyllabic",
339 "textsubring", "textsubbar", 0};
341 /// TIPA tones that need special handling
342 char const * const known_tones[] = {"15", "51", "45", "12", "454", 0};
344 // string to store the float type to be able to determine the type of subfloats
345 string float_type = "";
347 // string to store the float status of minted listings
348 string minted_float = "";
350 // whether a caption has been parsed for a floating minted listing
351 bool minted_float_has_caption = false;
353 // The caption for non-floating minted listings
354 string minted_nonfloat_caption = "";
356 // Characters that have to be escaped by \\ in LaTeX
357 char const * const known_escaped_chars[] = {
358 "&", "_", "$", "%", "#", "^", "{", "}", 0};
361 /// splits "x=z, y=b" into a map and an ordered keyword vector
362 void split_map(string const & s, map<string, string> & res, vector<string> & keys)
367 keys.resize(v.size());
368 for (size_t i = 0; i < v.size(); ++i) {
369 size_t const pos = v[i].find('=');
370 string const index = trimSpaceAndEol(v[i].substr(0, pos));
371 string const value = trimSpaceAndEol(v[i].substr(pos + 1, string::npos));
379 * Split a LaTeX length into value and unit.
380 * The latter can be a real unit like "pt", or a latex length variable
381 * like "\textwidth". The unit may contain additional stuff like glue
382 * lengths, but we don't care, because such lengths are ERT anyway.
383 * \returns true if \p value and \p unit are valid.
385 bool splitLatexLength(string const & len, string & value, string & unit)
389 const string::size_type i = len.find_first_not_of(" -+0123456789.,");
390 //'4,5' is a valid LaTeX length number. Change it to '4.5'
391 string const length = subst(len, ',', '.');
392 if (i == string::npos)
395 if (len[0] == '\\') {
396 // We had something like \textwidth without a factor
402 value = trimSpaceAndEol(string(length, 0, i));
406 // 'cM' is a valid LaTeX length unit. Change it to 'cm'
407 if (contains(len, '\\'))
408 unit = trimSpaceAndEol(string(len, i));
410 unit = ascii_lowercase(trimSpaceAndEol(string(len, i)));
415 /// A simple function to translate a latex length to something LyX can
416 /// understand. Not perfect, but rather best-effort.
417 bool translate_len(string const & length, string & valstring, string & unit)
419 if (!splitLatexLength(length, valstring, unit))
421 // LyX uses percent values
423 istringstream iss(valstring);
428 string const percentval = oss.str();
430 if (unit.empty() || unit[0] != '\\')
432 string::size_type const i = unit.find(' ');
433 string const endlen = (i == string::npos) ? string() : string(unit, i);
434 if (unit == "\\textwidth") {
435 valstring = percentval;
436 unit = "text%" + endlen;
437 } else if (unit == "\\columnwidth") {
438 valstring = percentval;
439 unit = "col%" + endlen;
440 } else if (unit == "\\paperwidth") {
441 valstring = percentval;
442 unit = "page%" + endlen;
443 } else if (unit == "\\linewidth") {
444 valstring = percentval;
445 unit = "line%" + endlen;
446 } else if (unit == "\\paperheight") {
447 valstring = percentval;
448 unit = "pheight%" + endlen;
449 } else if (unit == "\\textheight") {
450 valstring = percentval;
451 unit = "theight%" + endlen;
452 } else if (unit == "\\baselineskip") {
453 valstring = percentval;
454 unit = "baselineskip%" + endlen;
460 /// If we have ambiguous quotation marks, make a smart guess
461 /// based on main quote style
462 string guessQuoteStyle(string in, bool const opening)
465 if (prefixIs(in, "qr")) {// straight quote
467 res = subst(res, "r", "l");
468 } else if (in == "eld") {// ``
469 if (preamble.quotesStyle() == "german")
471 else if (preamble.quotesStyle() == "british")
473 else if (preamble.quotesStyle() == "french")
475 else if (preamble.quotesStyle() == "russian")
477 } else if (in == "erd") {// ''
478 if (preamble.quotesStyle() == "polish")
480 else if (preamble.quotesStyle() == "british")
482 else if (preamble.quotesStyle() == "french")
484 else if (preamble.quotesStyle() == "swedish")
485 res = opening ? "sld" : "srd";
486 } else if (in == "els") {// `
487 if (preamble.quotesStyle() == "german")
489 else if (preamble.quotesStyle() == "british")
491 } else if (in == "ers") {// '
492 if (preamble.quotesStyle() == "polish")
494 else if (preamble.quotesStyle() == "british")
496 else if (preamble.quotesStyle() == "swedish")
497 res = opening ? "sls" : "srs";
498 } else if (in == "ard") {// >>
499 if (preamble.quotesStyle() == "swiss")
501 else if (preamble.quotesStyle() == "french")
503 else if (preamble.quotesStyle() == "russian")
505 } else if (in == "ald") {// <<
506 if (preamble.quotesStyle() == "swiss")
508 else if (preamble.quotesStyle() == "french")
510 else if (preamble.quotesStyle() == "russian")
512 } else if (in == "ars") {// >
513 if (preamble.quotesStyle() == "swiss")
515 } else if (in == "als") {// <
516 if (preamble.quotesStyle() == "swiss")
518 } else if (in == "gld") {// ,,
519 if (preamble.quotesStyle() == "polish")
521 else if (preamble.quotesStyle() == "russian")
523 } else if (in == "gls") {// ,
524 if (preamble.quotesStyle() == "polish")
534 string translate_len(string const & length)
538 if (translate_len(length, value, unit))
540 // If the input is invalid, return what we have.
548 * Translates a LaTeX length into \p value, \p unit and
549 * \p special parts suitable for a box inset.
550 * The difference from translate_len() is that a box inset knows about
551 * some special "units" that are stored in \p special.
553 void translate_box_len(string const & length, string & value, string & unit, string & special)
555 if (translate_len(length, value, unit)) {
556 if (unit == "\\height" || unit == "\\depth" ||
557 unit == "\\totalheight" || unit == "\\width") {
558 special = unit.substr(1);
559 // The unit is not used, but LyX requires a dummy setting
571 void begin_inset(ostream & os, string const & name)
573 os << "\n\\begin_inset " << name;
577 void begin_command_inset(ostream & os, string const & name,
578 string const & latexname)
580 begin_inset(os, "CommandInset ");
581 os << name << "\nLatexCommand " << latexname << '\n';
585 void end_inset(ostream & os)
587 os << "\n\\end_inset\n\n";
591 bool skip_braces(Parser & p)
593 if (p.next_token().cat() != catBegin)
596 if (p.next_token().cat() == catEnd) {
605 /// replace LaTeX commands in \p s from the unicodesymbols file with their
607 pair<bool, docstring> convert_unicodesymbols(docstring s)
611 for (size_t i = 0; i < s.size();) {
620 docstring parsed = normalize_c(encodings.fromLaTeXCommand(s,
621 Encodings::TEXT_CMD, termination, rem, &req));
622 set<string>::const_iterator it = req.begin();
623 set<string>::const_iterator en = req.end();
624 for (; it != en; ++it)
625 preamble.registerAutomaticallyLoadedPackage(*it);
628 if (s.empty() || s[0] != '\\')
632 for (auto const & c : known_escaped_chars)
633 if (c != 0 && prefixIs(s, from_ascii("\\") + c))
638 return make_pair(res, os.str());
642 /// try to convert \p s to a valid InsetCommand argument
643 /// return whether this succeeded. If not, these command insets
644 /// get the "literate" flag.
645 pair<bool, string> convert_latexed_command_inset_arg(string s)
647 bool success = false;
649 // since we don't know the input encoding we can't use from_utf8
650 pair<bool, docstring> res = convert_unicodesymbols(from_ascii(s));
652 s = to_utf8(res.second);
654 // LyX cannot handle newlines in a latex command
655 return make_pair(success, subst(s, "\n", " "));
658 /// try to convert \p s to a valid InsetCommand argument
659 /// without trying to recode macros.
660 string convert_literate_command_inset_arg(string s)
662 // LyX cannot handle newlines in a latex command
663 return subst(s, "\n", " ");
666 void output_ert(ostream & os, string const & s, Context & context)
668 context.check_layout(os);
669 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
671 os << "\n\\backslash\n";
672 else if (*it == '\n') {
673 context.new_paragraph(os);
674 context.check_layout(os);
678 context.check_end_layout(os);
682 void output_ert_inset(ostream & os, string const & s, Context & context)
684 // We must have a valid layout before outputting the ERT inset.
685 context.check_layout(os);
686 Context newcontext(true, context.textclass);
687 InsetLayout const & layout = context.textclass.insetLayout(from_ascii("ERT"));
688 if (layout.forcePlainLayout())
689 newcontext.layout = &context.textclass.plainLayout();
690 begin_inset(os, "ERT");
691 os << "\nstatus collapsed\n";
692 output_ert(os, s, newcontext);
697 void output_comment(Parser & p, ostream & os, string const & s,
700 if (p.next_token().cat() == catNewline)
701 output_ert_inset(os, '%' + s, context);
703 output_ert_inset(os, '%' + s + '\n', context);
707 Layout const * findLayout(TextClass const & textclass, string const & name, bool command,
708 string const & latexparam = string())
710 Layout const * layout = findLayoutWithoutModule(textclass, name, command, latexparam);
713 if (checkModule(name, command))
714 return findLayoutWithoutModule(textclass, name, command, latexparam);
719 InsetLayout const * findInsetLayout(TextClass const & textclass, string const & name, bool command,
720 string const & latexparam = string())
722 InsetLayout const * insetlayout =
723 findInsetLayoutWithoutModule(textclass, name, command, latexparam);
726 if (checkModule(name, command))
727 return findInsetLayoutWithoutModule(textclass, name, command, latexparam);
732 void eat_whitespace(Parser &, ostream &, Context &, bool eatParagraph,
733 bool eatNewline = true);
737 * Skips whitespace and braces.
738 * This should be called after a command has been parsed that is not put into
739 * ERT, and where LyX adds "{}" if needed.
741 void skip_spaces_braces(Parser & p, bool keepws = false)
743 /* The following four examples produce the same typeset output and
744 should be handled by this function:
752 // Unfortunately we need to skip comments, too.
753 // We can't use eat_whitespace since writing them after the {}
754 // results in different output in some cases.
755 bool const skipped_spaces = p.skip_spaces(true);
756 bool const skipped_braces = skip_braces(p);
757 if (keepws && skipped_spaces && !skipped_braces)
758 // put back the space (it is better handled by check_space)
759 p.unskip_spaces(true);
763 void output_arguments(ostream & os, Parser & p, bool outer, bool need_layout, string const prefix,
764 Context & context, Layout::LaTeXArgMap const & latexargs)
766 if (context.layout->latextype != LATEX_ITEM_ENVIRONMENT || !prefix.empty()) {
768 context.check_layout(os);
774 Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
775 Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
776 for (; lait != laend; ++lait) {
778 eat_whitespace(p, os, context, false);
779 if (lait->second.mandatory) {
780 if (p.next_token().cat() != catBegin)
782 string ldelim = to_utf8(lait->second.ldelim);
783 string rdelim = to_utf8(lait->second.rdelim);
788 p.get_token(); // eat ldelim
789 if (ldelim.size() > 1)
790 p.get_token(); // eat ldelim
792 context.check_layout(os);
795 begin_inset(os, "Argument ");
798 os << i << "\nstatus collapsed\n\n";
799 parse_text_in_inset(p, os, FLAG_RDELIM, outer, context, 0, rdelim);
802 string ldelim = to_utf8(lait->second.ldelim);
803 string rdelim = to_utf8(lait->second.rdelim);
808 string tok = p.next_token().asInput();
809 // we only support delimiters with max 2 chars for now.
810 if (ldelim.size() > 1)
811 tok += p.next_next_token().asInput();
812 if (p.next_token().cat() == catEscape || tok != ldelim)
814 p.get_token(); // eat ldelim
815 if (ldelim.size() > 1)
816 p.get_token(); // eat ldelim
818 context.check_layout(os);
821 begin_inset(os, "Argument ");
824 os << i << "\nstatus collapsed\n\n";
825 parse_text_in_inset(p, os, FLAG_RDELIM, outer, context, 0, rdelim);
828 eat_whitespace(p, os, context, false);
833 void output_command_layout(ostream & os, Parser & p, bool outer,
834 Context & parent_context,
835 Layout const * newlayout)
837 TeXFont const oldFont = parent_context.font;
838 // save the current font size
839 string const size = oldFont.size;
840 // reset the font size to default, because the font size switches
841 // don't affect section headings and the like
842 parent_context.font.size = Context::normalfont.size;
843 // we only need to write the font change if we have an open layout
844 if (!parent_context.atParagraphStart())
845 output_font_change(os, oldFont, parent_context.font);
846 parent_context.check_end_layout(os);
847 Context context(true, parent_context.textclass, newlayout,
848 parent_context.layout, parent_context.font);
849 if (parent_context.deeper_paragraph) {
850 // We are beginning a nested environment after a
851 // deeper paragraph inside the outer list environment.
852 // Therefore we don't need to output a "begin deeper".
853 context.need_end_deeper = true;
855 context.check_deeper(os);
856 output_arguments(os, p, outer, true, string(), context,
857 context.layout->latexargs());
858 // If we have a latex param, we eat it here.
859 if (!parent_context.latexparam.empty()) {
861 Context dummy(true, parent_context.textclass);
862 parse_text(p, oss, FLAG_RDELIM, outer, dummy,
863 string(1, parent_context.latexparam.back()));
865 parse_text(p, os, FLAG_ITEM, outer, context);
866 output_arguments(os, p, outer, false, "post", context,
867 context.layout->postcommandargs());
868 context.check_end_layout(os);
869 if (parent_context.deeper_paragraph) {
870 // We must suppress the "end deeper" because we
871 // suppressed the "begin deeper" above.
872 context.need_end_deeper = false;
874 context.check_end_deeper(os);
875 // We don't need really a new paragraph, but
876 // we must make sure that the next item gets a \begin_layout.
877 parent_context.new_paragraph(os);
878 // Set the font size to the original value. No need to output it here
879 // (Context::begin_layout() will do that if needed)
880 parent_context.font.size = size;
885 * Output a space if necessary.
886 * This function gets called for every whitespace token.
888 * We have three cases here:
889 * 1. A space must be suppressed. Example: The lyxcode case below
890 * 2. A space may be suppressed. Example: Spaces before "\par"
891 * 3. A space must not be suppressed. Example: A space between two words
893 * We currently handle only 1. and 3 and from 2. only the case of
894 * spaces before newlines as a side effect.
896 * 2. could be used to suppress as many spaces as possible. This has two effects:
897 * - Reimporting LyX generated LaTeX files changes almost no whitespace
898 * - Superflous whitespace from non LyX generated LaTeX files is removed.
899 * The drawback is that the logic inside the function becomes
900 * complicated, and that is the reason why it is not implemented.
902 void check_space(Parser & p, ostream & os, Context & context)
904 Token const next = p.next_token();
905 Token const curr = p.curr_token();
906 // A space before a single newline and vice versa must be ignored
907 // LyX emits a newline before \end{lyxcode}.
908 // This newline must be ignored,
909 // otherwise LyX will add an additional protected space.
910 if (next.cat() == catSpace ||
911 next.cat() == catNewline ||
912 (next.cs() == "end" && context.layout->free_spacing && curr.cat() == catNewline)) {
915 context.check_layout(os);
921 * Parse all arguments of \p command
923 void parse_arguments(string const & command,
924 vector<ArgumentType> const & template_arguments,
925 Parser & p, ostream & os, bool outer, Context & context)
927 string ert = command;
928 size_t no_arguments = template_arguments.size();
929 for (size_t i = 0; i < no_arguments; ++i) {
930 switch (template_arguments[i]) {
933 // This argument contains regular LaTeX
934 output_ert_inset(os, ert + '{', context);
935 eat_whitespace(p, os, context, false);
936 if (template_arguments[i] == required)
937 parse_text(p, os, FLAG_ITEM, outer, context);
939 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
943 // This argument consists only of a single item.
944 // The presence of '{' or not must be preserved.
946 if (p.next_token().cat() == catBegin)
947 ert += '{' + p.verbatim_item() + '}';
949 ert += p.verbatim_item();
953 // This argument may contain special characters
954 ert += '{' + p.verbatim_item() + '}';
958 // true because we must not eat whitespace
959 // if an optional arg follows we must not strip the
960 // brackets from this one
961 if (i < no_arguments - 1 &&
962 template_arguments[i+1] == optional)
963 ert += p.getFullOpt(true);
965 ert += p.getOpt(true);
969 output_ert_inset(os, ert, context);
974 * Check whether \p command is a known command. If yes,
975 * handle the command with all arguments.
976 * \return true if the command was parsed, false otherwise.
978 bool parse_command(string const & command, Parser & p, ostream & os,
979 bool outer, Context & context)
981 if (known_commands.find(command) != known_commands.end()) {
982 parse_arguments(command, known_commands[command], p, os,
990 /// Parses a minipage or parbox
991 void parse_box(Parser & p, ostream & os, unsigned outer_flags,
992 unsigned inner_flags, bool outer, Context & parent_context,
993 string const & outer_type, string const & special,
994 string inner_type, string const & frame_color,
995 string const & background_color)
999 string hor_pos = "l";
1000 // We need to set the height to the LaTeX default of 1\\totalheight
1001 // for the case when no height argument is given
1002 string height_value = "1";
1003 string height_unit = "in";
1004 string height_special = "totalheight";
1005 string latex_height;
1009 string width_special = "none";
1010 string thickness = "0.4pt";
1011 if (!fboxrule.empty())
1012 thickness = fboxrule;
1014 thickness = "0.4pt";
1016 if (!fboxsep.empty())
1017 separation = fboxsep;
1021 if (!shadow_size.empty())
1022 shadowsize = shadow_size;
1025 string framecolor = "black";
1026 string backgroundcolor = "none";
1027 if (!frame_color.empty())
1028 framecolor = frame_color;
1029 if (!background_color.empty())
1030 backgroundcolor = background_color;
1031 // if there is a color box around the \begin statements have not yet been parsed
1033 if (!frame_color.empty() || !background_color.empty()) {
1034 eat_whitespace(p, os, parent_context, false);
1035 p.get_token().asInput(); // the '{'
1037 if (p.next_token().asInput() == "\\begin") {
1038 p.get_token().asInput();
1040 inner_type = "minipage";
1041 inner_flags = FLAG_END;
1042 active_environments.push_back("minipage");
1045 else if (p.next_token().asInput() == "\\parbox") {
1046 p.get_token().asInput();
1047 inner_type = "parbox";
1048 inner_flags = FLAG_ITEM;
1051 else if (p.next_token().asInput() == "\\makebox") {
1052 p.get_token().asInput();
1053 inner_type = "makebox";
1054 inner_flags = FLAG_ITEM;
1056 // in case there is just \colorbox{color}{text}
1059 inner_type = "makebox";
1060 inner_flags = FLAG_BRACE_LAST;
1065 if (!p.hasOpt() && (inner_type == "makebox" || outer_type == "mbox"))
1067 if (!inner_type.empty() && p.hasOpt()) {
1068 if (inner_type != "makebox")
1069 position = p.getArg('[', ']');
1071 latex_width = p.getArg('[', ']');
1072 translate_box_len(latex_width, width_value, width_unit, width_special);
1075 if (position != "t" && position != "c" && position != "b") {
1076 cerr << "invalid position " << position << " for "
1077 << inner_type << endl;
1081 if (inner_type != "makebox") {
1082 latex_height = p.getArg('[', ']');
1083 translate_box_len(latex_height, height_value, height_unit, height_special);
1085 string const opt = p.getArg('[', ']');
1088 if (hor_pos != "l" && hor_pos != "c" &&
1089 hor_pos != "r" && hor_pos != "s") {
1090 cerr << "invalid hor_pos " << hor_pos
1091 << " for " << inner_type << endl;
1098 inner_pos = p.getArg('[', ']');
1099 if (inner_pos != "c" && inner_pos != "t" &&
1100 inner_pos != "b" && inner_pos != "s") {
1101 cerr << "invalid inner_pos "
1102 << inner_pos << " for "
1103 << inner_type << endl;
1104 inner_pos = position;
1108 if (inner_type == "makebox")
1112 if (inner_type.empty()) {
1113 if (special.empty() && outer_type != "framebox")
1114 latex_width = "1\\columnwidth";
1117 latex_width = p2.getArg('[', ']');
1118 string const opt = p2.getArg('[', ']');
1121 if (hor_pos != "l" && hor_pos != "c" &&
1122 hor_pos != "r" && hor_pos != "s") {
1123 cerr << "invalid hor_pos " << hor_pos
1124 << " for " << outer_type << endl;
1128 if (outer_type == "framebox")
1132 } else if (inner_type != "makebox")
1133 latex_width = p.verbatim_item();
1134 // if e.g. only \ovalbox{content} was used, set the width to 1\columnwidth
1135 // as this is LyX's standard for such cases (except for makebox)
1136 // \framebox is more special and handled below
1137 if (latex_width.empty() && inner_type != "makebox"
1138 && outer_type != "framebox")
1139 latex_width = "1\\columnwidth";
1141 translate_len(latex_width, width_value, width_unit);
1143 bool shadedparbox = false;
1144 if (inner_type == "shaded") {
1145 eat_whitespace(p, os, parent_context, false);
1146 if (outer_type == "parbox") {
1148 if (p.next_token().cat() == catBegin)
1150 eat_whitespace(p, os, parent_context, false);
1151 shadedparbox = true;
1156 // If we already read the inner box we have to push the inner env
1157 if (!outer_type.empty() && !inner_type.empty() &&
1158 (inner_flags & FLAG_END))
1159 active_environments.push_back(inner_type);
1160 bool use_ert = false;
1161 if (!outer_type.empty() && !inner_type.empty()) {
1162 // Look whether there is some content after the end of the
1163 // inner box, but before the end of the outer box.
1164 // If yes, we need to output ERT.
1166 if (inner_flags & FLAG_END)
1167 p.ertEnvironment(inner_type);
1170 p.skip_spaces(true);
1171 bool const outer_env(outer_type == "framed" || outer_type == "minipage");
1172 if ((outer_env && p.next_token().asInput() != "\\end") ||
1173 (!outer_env && p.next_token().cat() != catEnd)) {
1174 // something is between the end of the inner box and
1175 // the end of the outer box, so we need to use ERT.
1183 if (!outer_type.empty()) {
1184 if (outer_flags & FLAG_END)
1185 ss << "\\begin{" << outer_type << '}';
1187 ss << '\\' << outer_type << '{';
1188 if (!special.empty())
1192 if (!inner_type.empty()) {
1193 if (inner_type != "shaded") {
1194 if (inner_flags & FLAG_END)
1195 ss << "\\begin{" << inner_type << '}';
1197 ss << '\\' << inner_type;
1199 if (!position.empty())
1200 ss << '[' << position << ']';
1201 if (!latex_height.empty())
1202 ss << '[' << latex_height << ']';
1203 if (!inner_pos.empty())
1204 ss << '[' << inner_pos << ']';
1205 ss << '{' << latex_width << '}';
1206 if (!(inner_flags & FLAG_END))
1209 if (inner_type == "shaded")
1210 ss << "\\begin{shaded}";
1211 output_ert_inset(os, ss.str(), parent_context);
1212 if (!inner_type.empty()) {
1213 parse_text(p, os, inner_flags, outer, parent_context);
1214 if (inner_flags & FLAG_END)
1215 output_ert_inset(os, "\\end{" + inner_type + '}',
1218 output_ert_inset(os, "}", parent_context);
1220 if (!outer_type.empty()) {
1221 // If we already read the inner box we have to pop
1223 if (!inner_type.empty() && (inner_flags & FLAG_END))
1224 active_environments.pop_back();
1226 // Ensure that the end of the outer box is parsed correctly:
1227 // The opening brace has been eaten by parse_outer_box()
1228 if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1229 outer_flags &= ~FLAG_ITEM;
1230 outer_flags |= FLAG_BRACE_LAST;
1232 parse_text(p, os, outer_flags, outer, parent_context);
1233 if (outer_flags & FLAG_END)
1234 output_ert_inset(os, "\\end{" + outer_type + '}',
1237 output_ert_inset(os, "}", parent_context);
1240 // LyX does not like empty positions, so we have
1241 // to set them to the LaTeX default values here.
1242 if (position.empty())
1244 if (inner_pos.empty())
1245 inner_pos = position;
1246 parent_context.check_layout(os);
1247 begin_inset(os, "Box ");
1248 if (outer_type == "framed")
1250 else if (outer_type == "framebox" || outer_type == "fbox" || !frame_color.empty())
1252 else if (outer_type == "shadowbox")
1253 os << "Shadowbox\n";
1254 else if ((outer_type == "shaded" && inner_type.empty()) ||
1255 (outer_type == "minipage" && inner_type == "shaded") ||
1256 (outer_type == "parbox" && inner_type == "shaded")) {
1258 preamble.registerAutomaticallyLoadedPackage("color");
1259 } else if (outer_type == "doublebox")
1260 os << "Doublebox\n";
1261 else if (outer_type.empty() || outer_type == "mbox")
1262 os << "Frameless\n";
1264 os << outer_type << '\n';
1265 os << "position \"" << position << "\"\n";
1266 os << "hor_pos \"" << hor_pos << "\"\n";
1267 if (outer_type == "mbox")
1268 os << "has_inner_box 1\n";
1269 else if (!frame_color.empty() && inner_type == "makebox")
1270 os << "has_inner_box 0\n";
1272 os << "has_inner_box " << !inner_type.empty() << "\n";
1273 os << "inner_pos \"" << inner_pos << "\"\n";
1274 os << "use_parbox " << (inner_type == "parbox" || shadedparbox)
1276 if (outer_type == "mbox")
1277 os << "use_makebox 1\n";
1278 else if (!frame_color.empty())
1279 os << "use_makebox 0\n";
1281 os << "use_makebox " << (inner_type == "makebox") << '\n';
1282 if (outer_type == "mbox" || (outer_type == "fbox" && inner_type.empty()))
1283 os << "width \"\"\n";
1284 // for values like "1.5\width" LyX uses "1.5in" as width ad sets "width" as sepecial
1285 else if (contains(width_unit, '\\'))
1286 os << "width \"" << width_value << "in" << "\"\n";
1288 os << "width \"" << width_value << width_unit << "\"\n";
1289 if (contains(width_unit, '\\')) {
1290 width_unit.erase (0,1); // remove the leading '\'
1291 os << "special \"" << width_unit << "\"\n";
1293 os << "special \"" << width_special << "\"\n";
1294 if (contains(height_unit, '\\'))
1295 os << "height \"" << height_value << "in" << "\"\n";
1297 os << "height \"" << height_value << height_unit << "\"\n";
1298 os << "height_special \"" << height_special << "\"\n";
1299 os << "thickness \"" << thickness << "\"\n";
1300 os << "separation \"" << separation << "\"\n";
1301 os << "shadowsize \"" << shadowsize << "\"\n";
1302 os << "framecolor \"" << framecolor << "\"\n";
1303 os << "backgroundcolor \"" << backgroundcolor << "\"\n";
1304 os << "status open\n\n";
1306 // Unfortunately we can't use parse_text_in_inset:
1307 // InsetBox::forcePlainLayout() is hard coded and does not
1308 // use the inset layout. Apart from that do we call parse_text
1309 // up to two times, but need only one check_end_layout.
1310 bool const forcePlainLayout =
1311 (!inner_type.empty() || inner_type == "makebox") &&
1312 outer_type != "shaded" && outer_type != "framed";
1313 Context context(true, parent_context.textclass);
1314 if (forcePlainLayout)
1315 context.layout = &context.textclass.plainLayout();
1317 context.font = parent_context.font;
1319 // If we have no inner box the contents will be read with the outer box
1320 if (!inner_type.empty())
1321 parse_text(p, os, inner_flags, outer, context);
1323 // Ensure that the end of the outer box is parsed correctly:
1324 // The opening brace has been eaten by parse_outer_box()
1325 if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1326 outer_flags &= ~FLAG_ITEM;
1327 outer_flags |= FLAG_BRACE_LAST;
1330 // Find end of outer box, output contents if inner_type is
1331 // empty and output possible comments
1332 if (!outer_type.empty()) {
1333 // If we already read the inner box we have to pop
1335 if (!inner_type.empty() && (inner_flags & FLAG_END))
1336 active_environments.pop_back();
1337 // This does not output anything but comments if
1338 // inner_type is not empty (see use_ert)
1339 parse_text(p, os, outer_flags, outer, context);
1342 context.check_end_layout(os);
1344 #ifdef PRESERVE_LAYOUT
1345 // LyX puts a % after the end of the minipage
1346 if (p.next_token().cat() == catNewline && p.next_token().cs().size() > 1) {
1348 //output_comment(p, os, "dummy", parent_context);
1351 parent_context.new_paragraph(os);
1353 else if (p.next_token().cat() == catSpace || p.next_token().cat() == catNewline) {
1354 //output_comment(p, os, "dummy", parent_context);
1357 // We add a protected space if something real follows
1358 if (p.good() && p.next_token().cat() != catComment) {
1359 begin_inset(os, "space ~\n");
1365 if (inner_type == "minipage" && (!frame_color.empty() || !background_color.empty()))
1366 active_environments.pop_back();
1367 if (inner_flags != FLAG_BRACE_LAST && (!frame_color.empty() || !background_color.empty())) {
1368 // in this case we have to eat the the closing brace of the color box
1369 p.get_token().asInput(); // the '}'
1371 if (p.next_token().asInput() == "}") {
1372 // in this case we assume that the closing brace is from the box settings
1373 // therefore reset these values for the next box
1379 // all boxes except of Frameless and Shaded require calc
1380 if (!(outer_type.empty() || outer_type == "mbox") &&
1381 !((outer_type == "shaded" && inner_type.empty()) ||
1382 (outer_type == "minipage" && inner_type == "shaded") ||
1383 (outer_type == "parbox" && inner_type == "shaded")))
1384 preamble.registerAutomaticallyLoadedPackage("calc");
1388 void parse_outer_box(Parser & p, ostream & os, unsigned flags, bool outer,
1389 Context & parent_context, string const & outer_type,
1390 string const & special)
1392 eat_whitespace(p, os, parent_context, false);
1393 if (flags & FLAG_ITEM) {
1395 if (p.next_token().cat() == catBegin)
1398 cerr << "Warning: Ignoring missing '{' after \\"
1399 << outer_type << '.' << endl;
1400 eat_whitespace(p, os, parent_context, false);
1403 unsigned int inner_flags = 0;
1405 if (outer_type == "minipage" || outer_type == "parbox") {
1406 p.skip_spaces(true);
1407 while (p.hasOpt()) {
1409 p.skip_spaces(true);
1412 p.skip_spaces(true);
1413 if (outer_type == "parbox") {
1415 if (p.next_token().cat() == catBegin)
1417 p.skip_spaces(true);
1420 if (outer_type == "shaded" || outer_type == "mbox") {
1421 // These boxes never have an inner box
1423 } else if (p.next_token().asInput() == "\\parbox") {
1424 inner = p.get_token().cs();
1425 inner_flags = FLAG_ITEM;
1426 } else if (p.next_token().asInput() == "\\begin") {
1427 // Is this a minipage or shaded box?
1430 inner = p.getArg('{', '}');
1432 if (inner == "minipage" || inner == "shaded")
1433 inner_flags = FLAG_END;
1438 if (inner_flags == FLAG_END) {
1439 if (inner != "shaded")
1443 eat_whitespace(p, os, parent_context, false);
1445 parse_box(p, os, flags, FLAG_END, outer, parent_context,
1446 outer_type, special, inner, "", "");
1448 if (inner_flags == FLAG_ITEM) {
1450 eat_whitespace(p, os, parent_context, false);
1452 parse_box(p, os, flags, inner_flags, outer, parent_context,
1453 outer_type, special, inner, "", "");
1458 void parse_listings(Parser & p, ostream & os, Context & parent_context,
1459 bool in_line, bool use_minted)
1461 parent_context.check_layout(os);
1462 begin_inset(os, "listings\n");
1463 string arg = p.hasOpt() ? subst(p.verbatimOption(), "\n", "") : string();
1465 while ((i = arg.find(", ")) != string::npos
1466 || (i = arg.find(",\t")) != string::npos)
1467 arg.erase(i + 1, 1);
1470 string const language = p.getArg('{', '}');
1471 p.skip_spaces(true);
1472 arg += string(arg.empty() ? "" : ",") + "language=" + language;
1473 if (!minted_float.empty()) {
1474 arg += string(arg.empty() ? "" : ",") + minted_float;
1475 minted_nonfloat_caption.clear();
1479 os << "lstparams " << '"' << arg << '"' << '\n';
1480 if (arg.find("\\color") != string::npos)
1481 preamble.registerAutomaticallyLoadedPackage("color");
1484 os << "inline true\n";
1486 os << "inline false\n";
1487 os << "status open\n";
1488 Context context(true, parent_context.textclass);
1489 context.layout = &parent_context.textclass.plainLayout();
1490 if (use_minted && prefixIs(minted_nonfloat_caption, "[t]")) {
1491 minted_nonfloat_caption.erase(0,3);
1492 os << "\n\\begin_layout Plain Layout\n";
1493 begin_inset(os, "Caption Standard\n");
1494 Context newcontext(true, context.textclass,
1495 context.layout, 0, context.font);
1496 newcontext.check_layout(os);
1497 os << minted_nonfloat_caption << "\n";
1498 newcontext.check_end_layout(os);
1500 os << "\n\\end_layout\n";
1501 minted_nonfloat_caption.clear();
1505 // set catcodes to verbatim early, just in case.
1506 p.setCatcodes(VERBATIM_CATCODES);
1507 string delim = p.get_token().asInput();
1508 //FIXME: handler error condition
1509 s = p.verbatimStuff(delim).second;
1510 // context.new_paragraph(os);
1511 } else if (use_minted) {
1512 s = p.verbatimEnvironment("minted");
1514 s = p.verbatimEnvironment("lstlisting");
1516 output_ert(os, s, context);
1517 if (use_minted && prefixIs(minted_nonfloat_caption, "[b]")) {
1518 minted_nonfloat_caption.erase(0,3);
1519 os << "\n\\begin_layout Plain Layout\n";
1520 begin_inset(os, "Caption Standard\n");
1521 Context newcontext(true, context.textclass,
1522 context.layout, 0, context.font);
1523 newcontext.check_layout(os);
1524 os << minted_nonfloat_caption << "\n";
1525 newcontext.check_end_layout(os);
1527 os << "\n\\end_layout\n";
1528 minted_nonfloat_caption.clear();
1530 // Don't close the inset here for floating minted listings.
1531 // It will be closed at the end of the listing environment.
1532 if (!use_minted || minted_float.empty())
1535 eat_whitespace(p, os, parent_context, true);
1536 Token t = p.get_token();
1537 if (t.asInput() != "\\end") {
1538 // If anything follows, collect it into a caption.
1539 minted_float_has_caption = true;
1540 os << "\n\\begin_layout Plain Layout\n"; // outer layout
1541 begin_inset(os, "Caption Standard\n");
1542 os << "\n\\begin_layout Plain Layout\n"; // inner layout
1549 /// parse an unknown environment
1550 void parse_unknown_environment(Parser & p, string const & name, ostream & os,
1551 unsigned flags, bool outer,
1552 Context & parent_context)
1554 if (name == "tabbing")
1555 // We need to remember that we have to handle '\=' specially
1556 flags |= FLAG_TABBING;
1558 // We need to translate font changes and paragraphs inside the
1559 // environment to ERT if we have a non standard font.
1560 // Otherwise things like
1561 // \large\begin{foo}\huge bar\end{foo}
1563 bool const specialfont =
1564 (parent_context.font != parent_context.normalfont);
1565 bool const new_layout_allowed = parent_context.new_layout_allowed;
1567 parent_context.new_layout_allowed = false;
1568 output_ert_inset(os, "\\begin{" + name + "}", parent_context);
1569 parse_text_snippet(p, os, flags, outer, parent_context);
1570 output_ert_inset(os, "\\end{" + name + "}", parent_context);
1572 parent_context.new_layout_allowed = new_layout_allowed;
1576 void parse_environment(Parser & p, ostream & os, bool outer,
1577 string & last_env, Context & parent_context)
1579 Layout const * newlayout;
1580 InsetLayout const * newinsetlayout = 0;
1581 string const name = p.getArg('{', '}');
1582 const bool is_starred = suffixIs(name, '*');
1583 string const unstarred_name = rtrim(name, "*");
1584 active_environments.push_back(name);
1586 if (is_math_env(name)) {
1587 parent_context.check_layout(os);
1588 begin_inset(os, "Formula ");
1589 os << "\\begin{" << name << "}";
1590 parse_math(p, os, FLAG_END, MATH_MODE);
1591 os << "\\end{" << name << "}";
1593 if (is_display_math_env(name)) {
1594 // Prevent the conversion of a line break to a space
1595 // (bug 7668). This does not change the output, but
1596 // looks ugly in LyX.
1597 eat_whitespace(p, os, parent_context, false);
1601 else if (is_known(name, preamble.polyglossia_languages)) {
1602 // We must begin a new paragraph if not already done
1603 if (! parent_context.atParagraphStart()) {
1604 parent_context.check_end_layout(os);
1605 parent_context.new_paragraph(os);
1607 // save the language in the context so that it is
1608 // handled by parse_text
1609 parent_context.font.language = preamble.polyglossia2lyx(name);
1610 parse_text(p, os, FLAG_END, outer, parent_context);
1611 // Just in case the environment is empty
1612 parent_context.extra_stuff.erase();
1613 // We must begin a new paragraph to reset the language
1614 parent_context.new_paragraph(os);
1618 else if (unstarred_name == "tabular" || name == "longtable"
1619 || name == "tabularx" || name == "xltabular") {
1620 eat_whitespace(p, os, parent_context, false);
1621 string width = "0pt";
1623 if ((name == "longtable" || name == "xltabular") && p.hasOpt()) {
1624 string const opt = p.getArg('[', ']');
1627 else if (opt == "l")
1629 else if (opt == "r")
1632 if (name == "tabular*" || name == "tabularx" || name == "xltabular") {
1633 width = lyx::translate_len(p.getArg('{', '}'));
1634 eat_whitespace(p, os, parent_context, false);
1636 parent_context.check_layout(os);
1637 begin_inset(os, "Tabular ");
1638 handle_tabular(p, os, name, width, halign, parent_context);
1643 else if (parent_context.textclass.floats().typeExist(unstarred_name)) {
1644 eat_whitespace(p, os, parent_context, false);
1645 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1646 eat_whitespace(p, os, parent_context, false);
1647 parent_context.check_layout(os);
1648 begin_inset(os, "Float " + unstarred_name + "\n");
1649 // store the float type for subfloats
1650 // subfloats only work with figures and tables
1651 if (unstarred_name == "figure")
1652 float_type = unstarred_name;
1653 else if (unstarred_name == "table")
1654 float_type = unstarred_name;
1658 os << "placement " << opt << '\n';
1659 if (contains(opt, "H"))
1660 preamble.registerAutomaticallyLoadedPackage("float");
1662 Floating const & fl = parent_context.textclass.floats()
1663 .getType(unstarred_name);
1664 if (!fl.floattype().empty() && fl.usesFloatPkg())
1665 preamble.registerAutomaticallyLoadedPackage("float");
1668 os << "wide " << convert<string>(is_starred)
1669 << "\nsideways false"
1670 << "\nstatus open\n\n";
1671 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1673 // We don't need really a new paragraph, but
1674 // we must make sure that the next item gets a \begin_layout.
1675 parent_context.new_paragraph(os);
1677 // the float is parsed thus delete the type
1681 else if (unstarred_name == "sidewaysfigure"
1682 || unstarred_name == "sidewaystable"
1683 || unstarred_name == "sidewaysalgorithm") {
1684 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1685 eat_whitespace(p, os, parent_context, false);
1686 parent_context.check_layout(os);
1687 if (unstarred_name == "sidewaysfigure")
1688 begin_inset(os, "Float figure\n");
1689 else if (unstarred_name == "sidewaystable")
1690 begin_inset(os, "Float table\n");
1691 else if (unstarred_name == "sidewaysalgorithm")
1692 begin_inset(os, "Float algorithm\n");
1694 os << "placement " << opt << '\n';
1695 if (contains(opt, "H"))
1696 preamble.registerAutomaticallyLoadedPackage("float");
1697 os << "wide " << convert<string>(is_starred)
1698 << "\nsideways true"
1699 << "\nstatus open\n\n";
1700 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1702 // We don't need really a new paragraph, but
1703 // we must make sure that the next item gets a \begin_layout.
1704 parent_context.new_paragraph(os);
1706 preamble.registerAutomaticallyLoadedPackage("rotfloat");
1709 else if (name == "wrapfigure" || name == "wraptable") {
1710 // syntax is \begin{wrapfigure}[lines]{placement}[overhang]{width}
1711 eat_whitespace(p, os, parent_context, false);
1712 parent_context.check_layout(os);
1715 string overhang = "0col%";
1718 lines = p.getArg('[', ']');
1719 string const placement = p.getArg('{', '}');
1721 overhang = p.getArg('[', ']');
1722 string const width = p.getArg('{', '}');
1724 if (name == "wrapfigure")
1725 begin_inset(os, "Wrap figure\n");
1727 begin_inset(os, "Wrap table\n");
1728 os << "lines " << lines
1729 << "\nplacement " << placement
1730 << "\noverhang " << lyx::translate_len(overhang)
1731 << "\nwidth " << lyx::translate_len(width)
1732 << "\nstatus open\n\n";
1733 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1735 // We don't need really a new paragraph, but
1736 // we must make sure that the next item gets a \begin_layout.
1737 parent_context.new_paragraph(os);
1739 preamble.registerAutomaticallyLoadedPackage("wrapfig");
1742 else if (name == "minipage") {
1743 eat_whitespace(p, os, parent_context, false);
1744 // Test whether this is an outer box of a shaded box
1746 // swallow arguments
1747 while (p.hasOpt()) {
1749 p.skip_spaces(true);
1752 p.skip_spaces(true);
1753 Token t = p.get_token();
1754 bool shaded = false;
1755 if (t.asInput() == "\\begin") {
1756 p.skip_spaces(true);
1757 if (p.getArg('{', '}') == "shaded")
1762 parse_outer_box(p, os, FLAG_END, outer,
1763 parent_context, name, "shaded");
1765 parse_box(p, os, 0, FLAG_END, outer, parent_context,
1766 "", "", name, "", "");
1770 else if (name == "comment") {
1771 eat_whitespace(p, os, parent_context, false);
1772 parent_context.check_layout(os);
1773 begin_inset(os, "Note Comment\n");
1774 os << "status open\n";
1775 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1778 skip_braces(p); // eat {} that might by set by LyX behind comments
1779 preamble.registerAutomaticallyLoadedPackage("verbatim");
1782 else if (unstarred_name == "verbatim") {
1783 // FIXME: this should go in the generic code that
1784 // handles environments defined in layout file that
1785 // have "PassThru 1". However, the code over there is
1786 // already too complicated for my taste.
1787 string const ascii_name =
1788 (name == "verbatim*") ? "Verbatim*" : "Verbatim";
1789 parent_context.new_paragraph(os);
1790 Context context(true, parent_context.textclass,
1791 &parent_context.textclass[from_ascii(ascii_name)]);
1792 string s = p.verbatimEnvironment(name);
1793 output_ert(os, s, context);
1797 else if (name == "IPA") {
1798 eat_whitespace(p, os, parent_context, false);
1799 parent_context.check_layout(os);
1800 begin_inset(os, "IPA\n");
1801 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1804 preamble.registerAutomaticallyLoadedPackage("tipa");
1805 preamble.registerAutomaticallyLoadedPackage("tipx");
1808 else if (name == parent_context.textclass.titlename()
1809 && parent_context.textclass.titletype() == TITLE_ENVIRONMENT) {
1810 parse_text(p, os, FLAG_END, outer, parent_context);
1811 // Just in case the environment is empty
1812 parent_context.extra_stuff.erase();
1813 // We must begin a new paragraph
1814 parent_context.new_paragraph(os);
1818 else if (name == "CJK") {
1819 // the scheme is \begin{CJK}{encoding}{mapping}text\end{CJK}
1820 // It is impossible to decide if a CJK environment was in its own paragraph or within
1821 // a line. We therefore always assume a paragraph since the latter is a rare case.
1822 eat_whitespace(p, os, parent_context, false);
1823 parent_context.check_end_layout(os);
1824 // store the encoding to be able to reset it
1825 string const encoding_old = p.getEncoding();
1826 string const encoding = p.getArg('{', '}');
1827 // FIXME: For some reason JIS does not work. Although the text
1828 // in tests/CJK.tex is identical with the SJIS version if you
1829 // convert both snippets using the recode command line utility,
1830 // the resulting .lyx file contains some extra characters if
1831 // you set buggy_encoding to false for JIS.
1832 bool const buggy_encoding = encoding == "JIS";
1833 if (!buggy_encoding)
1834 p.setEncoding(encoding, Encoding::CJK);
1836 // FIXME: This will read garbage, since the data is not encoded in utf8.
1837 p.setEncoding("UTF-8");
1839 // LyX only supports the same mapping for all CJK
1840 // environments, so we might need to output everything as ERT
1841 string const mapping = trim(p.getArg('{', '}'));
1842 char const * const * const where =
1843 is_known(encoding, supported_CJK_encodings);
1844 if (!buggy_encoding && !preamble.fontCJKSet())
1845 preamble.fontCJK(mapping);
1846 bool knownMapping = mapping == preamble.fontCJK();
1847 if (buggy_encoding || !knownMapping || !where) {
1848 parent_context.check_layout(os);
1849 output_ert_inset(os, "\\begin{" + name + "}{" + encoding + "}{" + mapping + "}",
1851 // we must parse the content as verbatim because e.g. JIS can contain
1852 // normally invalid characters
1853 // FIXME: This works only for the most simple cases.
1854 // Since TeX control characters are not parsed,
1855 // things like comments are completely wrong.
1856 string const s = p.plainEnvironment("CJK");
1857 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
1860 if (snip == "\\" || is_known(snip, known_escaped_chars))
1861 output_ert_inset(os, snip, parent_context);
1862 else if (*it == '\n' && it + 1 != et && s.begin() + 1 != it)
1867 output_ert_inset(os, "\\end{" + name + "}",
1871 supported_CJK_languages[where - supported_CJK_encodings];
1872 // store the language because we must reset it at the end
1873 string const lang_old = parent_context.font.language;
1874 parent_context.font.language = lang;
1875 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1876 parent_context.font.language = lang_old;
1877 parent_context.new_paragraph(os);
1879 p.setEncoding(encoding_old);
1883 else if (name == "lyxgreyedout") {
1884 eat_whitespace(p, os, parent_context, false);
1885 parent_context.check_layout(os);
1886 begin_inset(os, "Note Greyedout\n");
1887 os << "status open\n";
1888 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1891 if (!preamble.notefontcolor().empty())
1892 preamble.registerAutomaticallyLoadedPackage("color");
1895 else if (name == "btSect") {
1896 eat_whitespace(p, os, parent_context, false);
1897 parent_context.check_layout(os);
1898 begin_command_inset(os, "bibtex", "bibtex");
1899 string bibstyle = "plain";
1901 bibstyle = p.getArg('[', ']');
1902 p.skip_spaces(true);
1904 string const bibfile = p.getArg('{', '}');
1905 eat_whitespace(p, os, parent_context, false);
1906 Token t = p.get_token();
1907 if (t.asInput() == "\\btPrintCited") {
1908 p.skip_spaces(true);
1909 os << "btprint " << '"' << "btPrintCited" << '"' << "\n";
1911 if (t.asInput() == "\\btPrintNotCited") {
1912 p.skip_spaces(true);
1913 os << "btprint " << '"' << "btPrintNotCited" << '"' << "\n";
1915 if (t.asInput() == "\\btPrintAll") {
1916 p.skip_spaces(true);
1917 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
1919 os << "bibfiles " << '"' << bibfile << "\"\n"
1920 << "options " << '"' << bibstyle << "\"\n";
1921 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1926 else if (name == "framed" || name == "shaded") {
1927 eat_whitespace(p, os, parent_context, false);
1928 parse_outer_box(p, os, FLAG_END, outer, parent_context, name, "");
1930 preamble.registerAutomaticallyLoadedPackage("framed");
1933 else if (name == "listing") {
1934 minted_float = "float";
1935 eat_whitespace(p, os, parent_context, false);
1936 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1938 minted_float += "=" + opt;
1939 // If something precedes \begin{minted}, we output it at the end
1940 // as a caption, in order to keep it inside the listings inset.
1941 eat_whitespace(p, os, parent_context, true);
1943 Token const & t = p.get_token();
1944 p.skip_spaces(true);
1945 string const envname = p.next_token().cat() == catBegin
1946 ? p.getArg('{', '}') : string();
1947 bool prologue = t.asInput() != "\\begin" || envname != "minted";
1949 minted_float_has_caption = false;
1950 string content = parse_text_snippet(p, FLAG_END, outer,
1952 size_t i = content.find("\\begin_inset listings");
1953 bool minted_env = i != string::npos;
1956 caption = content.substr(0, i);
1957 content.erase(0, i);
1959 parent_context.check_layout(os);
1960 if (minted_env && minted_float_has_caption) {
1961 eat_whitespace(p, os, parent_context, true);
1962 os << content << "\n";
1963 if (!caption.empty())
1964 os << caption << "\n";
1965 os << "\n\\end_layout\n"; // close inner layout
1966 end_inset(os); // close caption inset
1967 os << "\n\\end_layout\n"; // close outer layout
1968 } else if (!caption.empty()) {
1970 begin_inset(os, "listings\n");
1971 os << "lstparams " << '"' << minted_float << '"' << '\n';
1972 os << "inline false\n";
1973 os << "status collapsed\n";
1975 os << "\n\\begin_layout Plain Layout\n";
1976 begin_inset(os, "Caption Standard\n");
1977 Context newcontext(true, parent_context.textclass,
1978 0, 0, parent_context.font);
1979 newcontext.check_layout(os);
1980 os << caption << "\n";
1981 newcontext.check_end_layout(os);
1983 os << "\n\\end_layout\n";
1984 } else if (content.empty()) {
1985 begin_inset(os, "listings\n");
1986 os << "lstparams " << '"' << minted_float << '"' << '\n';
1987 os << "inline false\n";
1988 os << "status collapsed\n";
1990 os << content << "\n";
1992 end_inset(os); // close listings inset
1993 parent_context.check_end_layout(os);
1994 parent_context.new_paragraph(os);
1996 minted_float.clear();
1997 minted_float_has_caption = false;
2000 else if (name == "lstlisting" || name == "minted") {
2001 bool use_minted = name == "minted";
2002 // with listings, we do not eat newlines here since
2003 // \begin{lstlistings}
2006 // // \begin{lstlistings}%
2009 // reads [foo] as content, whereas
2010 // // \begin{lstlistings}%
2013 // \begin{lstlistings}[foo,
2015 // reads [foo...] as argument.
2016 eat_whitespace(p, os, parent_context, false, use_minted);
2017 if (use_minted && minted_float.empty()) {
2018 // look ahead for a bottom caption
2020 bool found_end_minted = false;
2021 while (!found_end_minted && p.good()) {
2022 Token const & t = p.get_token();
2024 string const envname =
2025 p.next_token().cat() == catBegin
2026 ? p.getArg('{', '}') : string();
2027 found_end_minted = t.asInput() == "\\end"
2028 && envname == "minted";
2030 eat_whitespace(p, os, parent_context, true);
2031 Token const & t = p.get_token();
2032 p.skip_spaces(true);
2033 if (t.asInput() == "\\lyxmintcaption") {
2034 string const pos = p.getArg('[', ']');
2036 string const caption =
2037 parse_text_snippet(p, FLAG_ITEM,
2038 false, parent_context);
2039 minted_nonfloat_caption = "[b]" + caption;
2040 eat_whitespace(p, os, parent_context, true);
2045 parse_listings(p, os, parent_context, false, use_minted);
2049 else if (!parent_context.new_layout_allowed)
2050 parse_unknown_environment(p, name, os, FLAG_END, outer,
2053 // Alignment and spacing settings
2054 // FIXME (bug xxxx): These settings can span multiple paragraphs and
2055 // therefore are totally broken!
2056 // Note that \centering, \raggedright, and \raggedleft cannot be handled, as
2057 // they are commands not environments. They are furthermore switches that
2058 // can be ended by another switches, but also by commands like \footnote or
2059 // \parbox. So the only safe way is to leave them untouched.
2060 // However, we support the pseudo-environments
2061 // \begin{centering} ... \end{centering}
2062 // \begin{raggedright} ... \end{raggedright}
2063 // \begin{raggedleft} ... \end{raggedleft}
2064 // since they are used by LyX in floats (for spacing reasons)
2065 else if (name == "center" || name == "centering" ||
2066 name == "flushleft" || name == "raggedright" ||
2067 name == "flushright" || name == "raggedleft" ||
2068 name == "singlespace" || name == "onehalfspace" ||
2069 name == "doublespace" || name == "spacing") {
2070 eat_whitespace(p, os, parent_context, false);
2071 // We must begin a new paragraph if not already done
2072 if (! parent_context.atParagraphStart()) {
2073 parent_context.check_end_layout(os);
2074 parent_context.new_paragraph(os);
2076 if (name == "flushleft" || name == "raggedright")
2077 parent_context.add_extra_stuff("\\align left\n");
2078 else if (name == "flushright" || name == "raggedleft")
2079 parent_context.add_extra_stuff("\\align right\n");
2080 else if (name == "center" || name == "centering")
2081 parent_context.add_extra_stuff("\\align center\n");
2082 else if (name == "singlespace")
2083 parent_context.add_extra_stuff("\\paragraph_spacing single\n");
2084 else if (name == "onehalfspace") {
2085 parent_context.add_extra_stuff("\\paragraph_spacing onehalf\n");
2086 preamble.registerAutomaticallyLoadedPackage("setspace");
2087 } else if (name == "doublespace") {
2088 parent_context.add_extra_stuff("\\paragraph_spacing double\n");
2089 preamble.registerAutomaticallyLoadedPackage("setspace");
2090 } else if (name == "spacing") {
2091 parent_context.add_extra_stuff("\\paragraph_spacing other " + p.verbatim_item() + "\n");
2092 preamble.registerAutomaticallyLoadedPackage("setspace");
2094 parse_text(p, os, FLAG_END, outer, parent_context);
2095 // Just in case the environment is empty
2096 parent_context.extra_stuff.erase();
2097 // We must begin a new paragraph to reset the alignment
2098 parent_context.new_paragraph(os);
2102 // The single '=' is meant here.
2103 else if ((newlayout = findLayout(parent_context.textclass, name, false))) {
2104 eat_whitespace(p, os, parent_context, false);
2105 Context context(true, parent_context.textclass, newlayout,
2106 parent_context.layout, parent_context.font);
2107 if (parent_context.deeper_paragraph) {
2108 // We are beginning a nested environment after a
2109 // deeper paragraph inside the outer list environment.
2110 // Therefore we don't need to output a "begin deeper".
2111 context.need_end_deeper = true;
2113 parent_context.check_end_layout(os);
2114 if (last_env == name) {
2115 // we need to output a separator since LyX would export
2116 // the two environments as one otherwise (bug 5716)
2117 TeX2LyXDocClass const & textclass(parent_context.textclass);
2118 Context newcontext(true, textclass,
2119 &(textclass.defaultLayout()));
2120 newcontext.check_layout(os);
2121 begin_inset(os, "Separator plain\n");
2123 newcontext.check_end_layout(os);
2125 switch (context.layout->latextype) {
2126 case LATEX_LIST_ENVIRONMENT:
2127 context.add_par_extra_stuff("\\labelwidthstring "
2128 + p.verbatim_item() + '\n');
2131 case LATEX_BIB_ENVIRONMENT:
2132 p.verbatim_item(); // swallow next arg
2138 context.check_deeper(os);
2139 if (newlayout->keepempty) {
2140 // We need to start a new paragraph
2141 // even if it is empty.
2142 context.new_paragraph(os);
2143 context.check_layout(os);
2145 // handle known optional and required arguments
2146 if (context.layout->latextype == LATEX_ENVIRONMENT)
2147 output_arguments(os, p, outer, false, string(), context,
2148 context.layout->latexargs());
2149 else if (context.layout->latextype == LATEX_ITEM_ENVIRONMENT) {
2151 output_arguments(oss, p, outer, false, string(), context,
2152 context.layout->latexargs());
2153 context.list_extra_stuff = oss.str();
2155 parse_text(p, os, FLAG_END, outer, context);
2156 if (context.layout->latextype == LATEX_ENVIRONMENT)
2157 output_arguments(os, p, outer, false, "post", context,
2158 context.layout->postcommandargs());
2159 context.check_end_layout(os);
2160 if (parent_context.deeper_paragraph) {
2161 // We must suppress the "end deeper" because we
2162 // suppressed the "begin deeper" above.
2163 context.need_end_deeper = false;
2165 context.check_end_deeper(os);
2166 parent_context.new_paragraph(os);
2168 if (!preamble.titleLayoutFound())
2169 preamble.titleLayoutFound(newlayout->intitle);
2170 set<string> const & req = newlayout->requires();
2171 set<string>::const_iterator it = req.begin();
2172 set<string>::const_iterator en = req.end();
2173 for (; it != en; ++it)
2174 preamble.registerAutomaticallyLoadedPackage(*it);
2177 // The single '=' is meant here.
2178 else if ((newinsetlayout = findInsetLayout(parent_context.textclass, name, false))) {
2179 eat_whitespace(p, os, parent_context, false);
2180 parent_context.check_layout(os);
2181 begin_inset(os, "Flex ");
2182 docstring flex_name = newinsetlayout->name();
2183 // FIXME: what do we do if the prefix is not Flex: ?
2184 if (prefixIs(flex_name, from_ascii("Flex:")))
2185 flex_name.erase(0, 5);
2186 os << to_utf8(flex_name) << '\n'
2187 << "status collapsed\n";
2188 if (newinsetlayout->isPassThru()) {
2189 string const arg = p.verbatimEnvironment(name);
2190 Context context(true, parent_context.textclass,
2191 &parent_context.textclass.plainLayout(),
2192 parent_context.layout);
2193 output_ert(os, arg, parent_context);
2195 parse_text_in_inset(p, os, FLAG_END, false, parent_context, newinsetlayout);
2199 else if (name == "appendix") {
2200 // This is no good latex style, but it works and is used in some documents...
2201 eat_whitespace(p, os, parent_context, false);
2202 parent_context.check_end_layout(os);
2203 Context context(true, parent_context.textclass, parent_context.layout,
2204 parent_context.layout, parent_context.font);
2205 context.check_layout(os);
2206 os << "\\start_of_appendix\n";
2207 parse_text(p, os, FLAG_END, outer, context);
2208 context.check_end_layout(os);
2212 else if (known_environments.find(name) != known_environments.end()) {
2213 vector<ArgumentType> arguments = known_environments[name];
2214 // The last "argument" denotes wether we may translate the
2215 // environment contents to LyX
2216 // The default required if no argument is given makes us
2217 // compatible with the reLyXre environment.
2218 ArgumentType contents = arguments.empty() ?
2221 if (!arguments.empty())
2222 arguments.pop_back();
2223 // See comment in parse_unknown_environment()
2224 bool const specialfont =
2225 (parent_context.font != parent_context.normalfont);
2226 bool const new_layout_allowed =
2227 parent_context.new_layout_allowed;
2229 parent_context.new_layout_allowed = false;
2230 parse_arguments("\\begin{" + name + "}", arguments, p, os,
2231 outer, parent_context);
2232 if (contents == verbatim)
2233 output_ert_inset(os, p.ertEnvironment(name),
2236 parse_text_snippet(p, os, FLAG_END, outer,
2238 output_ert_inset(os, "\\end{" + name + "}", parent_context);
2240 parent_context.new_layout_allowed = new_layout_allowed;
2244 parse_unknown_environment(p, name, os, FLAG_END, outer,
2248 active_environments.pop_back();
2252 /// parses a comment and outputs it to \p os.
2253 void parse_comment(Parser & p, ostream & os, Token const & t, Context & context,
2254 bool skipNewlines = false)
2256 LASSERT(t.cat() == catComment, return);
2257 if (!t.cs().empty()) {
2258 context.check_layout(os);
2259 output_comment(p, os, t.cs(), context);
2260 if (p.next_token().cat() == catNewline) {
2261 // A newline after a comment line starts a new
2263 if (context.new_layout_allowed) {
2264 if(!context.atParagraphStart())
2265 // Only start a new paragraph if not already
2266 // done (we might get called recursively)
2267 context.new_paragraph(os);
2269 output_ert_inset(os, "\n", context);
2270 eat_whitespace(p, os, context, true);
2272 } else if (!skipNewlines) {
2273 // "%\n" combination
2280 * Reads spaces and comments until the first non-space, non-comment token.
2281 * New paragraphs (double newlines or \\par) are handled like simple spaces
2282 * if \p eatParagraph is true.
2283 * If \p eatNewline is false, newlines won't be treated as whitespace.
2284 * Spaces are skipped, but comments are written to \p os.
2286 void eat_whitespace(Parser & p, ostream & os, Context & context,
2287 bool eatParagraph, bool eatNewline)
2290 Token const & t = p.get_token();
2291 if (t.cat() == catComment)
2292 parse_comment(p, os, t, context, !eatNewline);
2293 else if ((!eatParagraph && p.isParagraph()) ||
2294 (t.cat() != catSpace && (t.cat() != catNewline || !eatNewline))) {
2303 * Set a font attribute, parse text and reset the font attribute.
2304 * \param attribute Attribute name (e.g. \\family, \\shape etc.)
2305 * \param currentvalue Current value of the attribute. Is set to the new
2306 * value during parsing.
2307 * \param newvalue New value of the attribute
2309 void parse_text_attributes(Parser & p, ostream & os, unsigned flags, bool outer,
2310 Context & context, string const & attribute,
2311 string & currentvalue, string const & newvalue)
2313 context.check_layout(os);
2314 string const oldvalue = currentvalue;
2315 currentvalue = newvalue;
2316 os << '\n' << attribute << ' ' << newvalue << "\n";
2317 parse_text_snippet(p, os, flags, outer, context);
2318 context.check_layout(os);
2319 os << '\n' << attribute << ' ' << oldvalue << "\n";
2320 currentvalue = oldvalue;
2324 /// get the arguments of a natbib or jurabib citation command
2325 void get_cite_arguments(Parser & p, bool natbibOrder,
2326 string & before, string & after, bool const qualified = false)
2328 // We need to distinguish "" and "[]", so we can't use p.getOpt().
2330 // text before the citation
2332 // text after the citation
2333 after = qualified ? p.getFullOpt(false, '(', ')') : p.getFullOpt();
2335 if (!after.empty()) {
2336 before = qualified ? p.getFullOpt(false, '(', ')') : p.getFullOpt();
2337 if (natbibOrder && !before.empty())
2338 swap(before, after);
2343 void copy_file(FileName const & src, string dstname)
2347 string const absParent = getParentFilePath(false);
2349 if (FileName::isAbsolute(dstname))
2350 dst = FileName(dstname);
2352 dst = makeAbsPath(dstname, absParent);
2353 FileName const srcpath = src.onlyPath();
2354 FileName const dstpath = dst.onlyPath();
2355 if (equivalent(srcpath, dstpath))
2357 if (!dstpath.isDirectory()) {
2358 if (!dstpath.createPath()) {
2359 cerr << "Warning: Could not create directory for file `"
2360 << dst.absFileName() << "´." << endl;
2364 if (dst.isReadableFile()) {
2365 if (overwriteFiles())
2366 cerr << "Warning: Overwriting existing file `"
2367 << dst.absFileName() << "´." << endl;
2369 cerr << "Warning: Not overwriting existing file `"
2370 << dst.absFileName() << "´." << endl;
2374 if (!src.copyTo(dst))
2375 cerr << "Warning: Could not copy file `" << src.absFileName()
2376 << "´ to `" << dst.absFileName() << "´." << endl;
2380 /// Parse a literate Chunk section. The initial "<<" is already parsed.
2381 bool parse_chunk(Parser & p, ostream & os, Context & context)
2383 // check whether a chunk is possible here.
2384 if (!context.textclass.hasInsetLayout(from_ascii("Flex:Chunk"))) {
2390 // read the parameters
2391 Parser::Arg const params = p.verbatimStuff(">>=\n", false);
2392 if (!params.first) {
2397 Parser::Arg const code = p.verbatimStuff("\n@");
2402 string const post_chunk = p.verbatimStuff("\n").second + '\n';
2403 if (post_chunk[0] != ' ' && post_chunk[0] != '\n') {
2407 // The last newline read is important for paragraph handling
2411 //cerr << "params=[" << params.second << "], code=[" << code.second << "]" <<endl;
2412 // We must have a valid layout before outputting the Chunk inset.
2413 context.check_layout(os);
2414 Context chunkcontext(true, context.textclass);
2415 chunkcontext.layout = &context.textclass.plainLayout();
2416 begin_inset(os, "Flex Chunk");
2417 os << "\nstatus open\n";
2418 if (!params.second.empty()) {
2419 chunkcontext.check_layout(os);
2420 Context paramscontext(true, context.textclass);
2421 paramscontext.layout = &context.textclass.plainLayout();
2422 begin_inset(os, "Argument 1");
2423 os << "\nstatus open\n";
2424 output_ert(os, params.second, paramscontext);
2427 output_ert(os, code.second, chunkcontext);
2435 /// detects \\def, \\long\\def and \\global\\long\\def with ws and comments
2436 bool is_macro(Parser & p)
2438 Token first = p.curr_token();
2439 if (first.cat() != catEscape || !p.good())
2441 if (first.cs() == "def")
2443 if (first.cs() != "global" && first.cs() != "long")
2445 Token second = p.get_token();
2447 while (p.good() && !p.isParagraph() && (second.cat() == catSpace ||
2448 second.cat() == catNewline || second.cat() == catComment)) {
2449 second = p.get_token();
2452 bool secondvalid = second.cat() == catEscape;
2454 bool thirdvalid = false;
2455 if (p.good() && first.cs() == "global" && secondvalid &&
2456 second.cs() == "long") {
2457 third = p.get_token();
2459 while (p.good() && !p.isParagraph() &&
2460 (third.cat() == catSpace ||
2461 third.cat() == catNewline ||
2462 third.cat() == catComment)) {
2463 third = p.get_token();
2466 thirdvalid = third.cat() == catEscape;
2468 for (int i = 0; i < pos; ++i)
2473 return (first.cs() == "global" || first.cs() == "long") &&
2474 second.cs() == "def";
2475 return first.cs() == "global" && second.cs() == "long" &&
2476 third.cs() == "def";
2480 /// Parse a macro definition (assumes that is_macro() returned true)
2481 void parse_macro(Parser & p, ostream & os, Context & context)
2483 context.check_layout(os);
2484 Token first = p.curr_token();
2487 string command = first.asInput();
2488 if (first.cs() != "def") {
2490 eat_whitespace(p, os, context, false);
2491 second = p.curr_token();
2492 command += second.asInput();
2493 if (second.cs() != "def") {
2495 eat_whitespace(p, os, context, false);
2496 third = p.curr_token();
2497 command += third.asInput();
2500 eat_whitespace(p, os, context, false);
2501 string const name = p.get_token().cs();
2502 eat_whitespace(p, os, context, false);
2508 while (p.next_token().cat() != catBegin) {
2509 if (p.next_token().cat() == catParameter) {
2514 // followed by number?
2515 if (p.next_token().cat() == catOther) {
2516 string s = p.get_token().asInput();
2518 // number = current arity + 1?
2519 if (s.size() == 1 && s[0] == arity + '0' + 1)
2524 paramtext += p.get_token().cs();
2526 paramtext += p.get_token().cs();
2531 // only output simple (i.e. compatible) macro as FormulaMacros
2532 string ert = '\\' + name + ' ' + paramtext + '{' + p.verbatim_item() + '}';
2534 context.check_layout(os);
2535 begin_inset(os, "FormulaMacro");
2536 os << "\n\\def" << ert;
2539 output_ert_inset(os, command + ert, context);
2543 void registerExternalTemplatePackages(string const & name)
2545 external::TemplateManager const & etm = external::TemplateManager::get();
2546 external::Template const * const et = etm.getTemplateByName(name);
2549 external::Template::Formats::const_iterator cit = et->formats.end();
2551 cit = et->formats.find("PDFLaTeX");
2552 if (cit == et->formats.end())
2553 // If the template has not specified a PDFLaTeX output,
2554 // we try the LaTeX format.
2555 cit = et->formats.find("LaTeX");
2556 if (cit == et->formats.end())
2558 vector<string>::const_iterator qit = cit->second.requirements.begin();
2559 vector<string>::const_iterator qend = cit->second.requirements.end();
2560 for (; qit != qend; ++qit)
2561 preamble.registerAutomaticallyLoadedPackage(*qit);
2564 } // anonymous namespace
2568 * Find a file with basename \p name in path \p path and an extension
2571 string find_file(string const & name, string const & path,
2572 char const * const * extensions)
2574 for (char const * const * what = extensions; *what; ++what) {
2575 string const trial = addExtension(name, *what);
2576 if (makeAbsPath(trial, path).exists())
2583 /// Convert filenames with TeX macros and/or quotes to something LyX
2585 string const normalize_filename(string const & name)
2590 Token const & t = p.get_token();
2591 if (t.cat() != catEscape)
2593 else if (t.cs() == "lyxdot") {
2594 // This is used by LyX for simple dots in relative
2598 } else if (t.cs() == "space") {
2601 } else if (t.cs() == "string") {
2602 // Convert \string" to " and \string~ to ~
2603 Token const & n = p.next_token();
2604 if (n.asInput() != "\"" && n.asInput() != "~")
2609 // Strip quotes. This is a bit complicated (see latex_path()).
2610 string full = os.str();
2611 if (!full.empty() && full[0] == '"') {
2612 string base = removeExtension(full);
2613 string ext = getExtension(full);
2614 if (!base.empty() && base[base.length()-1] == '"')
2617 return addExtension(trim(base, "\""), ext);
2618 if (full[full.length()-1] == '"')
2621 return trim(full, "\"");
2627 /// Convert \p name from TeX convention (relative to master file) to LyX
2628 /// convention (relative to .lyx file) if it is relative
2629 void fix_child_filename(string & name)
2631 string const absMasterTeX = getMasterFilePath(true);
2632 bool const isabs = FileName::isAbsolute(name);
2633 // convert from "relative to .tex master" to absolute original path
2635 name = makeAbsPath(name, absMasterTeX).absFileName();
2636 bool copyfile = copyFiles();
2637 string const absParentLyX = getParentFilePath(false);
2640 // convert from absolute original path to "relative to master file"
2641 string const rel = to_utf8(makeRelPath(from_utf8(name),
2642 from_utf8(absMasterTeX)));
2643 // re-interpret "relative to .tex file" as "relative to .lyx file"
2644 // (is different if the master .lyx file resides in a
2645 // different path than the master .tex file)
2646 string const absMasterLyX = getMasterFilePath(false);
2647 abs = makeAbsPath(rel, absMasterLyX).absFileName();
2648 // Do not copy if the new path is impossible to create. Example:
2649 // absMasterTeX = "/foo/bar/"
2650 // absMasterLyX = "/bar/"
2651 // name = "/baz.eps" => new absolute name would be "/../baz.eps"
2652 if (contains(name, "/../"))
2659 // convert from absolute original path to
2660 // "relative to .lyx file"
2661 name = to_utf8(makeRelPath(from_utf8(abs),
2662 from_utf8(absParentLyX)));
2666 // convert from absolute original path to "relative to .lyx file"
2667 name = to_utf8(makeRelPath(from_utf8(name),
2668 from_utf8(absParentLyX)));
2673 void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
2674 Context & context, string const rdelim)
2676 Layout const * newlayout = 0;
2677 InsetLayout const * newinsetlayout = 0;
2678 char const * const * where = 0;
2679 // Store the latest bibliographystyle, addcontentslineContent and
2680 // nocite{*} option (needed for bibtex inset)
2682 string contentslineContent;
2683 // Some classes provide a \bibliographystyle, so do not output
2684 // any if none is explicitly set.
2685 string bibliographystyle;
2686 bool const use_natbib = isProvided("natbib");
2687 bool const use_jurabib = isProvided("jurabib");
2688 bool const use_biblatex = isProvided("biblatex")
2689 && preamble.citeEngine() != "biblatex-natbib";
2690 bool const use_biblatex_natbib = isProvided("biblatex-natbib")
2691 || (isProvided("biblatex") && preamble.citeEngine() == "biblatex-natbib");
2692 need_commentbib = use_biblatex || use_biblatex_natbib;
2695 // it is impossible to determine the correct encoding for non-CJK Japanese.
2696 // Therefore write a note at the beginning of the document
2697 if (is_nonCJKJapanese) {
2698 context.check_layout(os);
2699 begin_inset(os, "Note Note\n");
2700 os << "status open\n\\begin_layout Plain Layout\n"
2701 << "\\series bold\n"
2702 << "Important information:\n"
2703 << "\\end_layout\n\n"
2704 << "\\begin_layout Plain Layout\n"
2705 << "The original LaTeX source for this document is in Japanese (pLaTeX).\n"
2706 << " It was therefore impossible for tex2lyx to determine the correct encoding.\n"
2707 << " The iconv encoding " << p.getEncoding() << " was used.\n"
2708 << " If this is incorrect, you must run the tex2lyx program on the command line\n"
2709 << " and specify the encoding using the -e command-line switch.\n"
2710 << " In addition, you might want to double check that the desired output encoding\n"
2711 << " is correctly selected in Document > Settings > Language.\n"
2712 << "\\end_layout\n";
2714 is_nonCJKJapanese = false;
2717 bool have_cycled = false;
2719 // Leave here only after at least one cycle
2720 if (have_cycled && flags & FLAG_LEAVE) {
2721 flags &= ~FLAG_LEAVE;
2725 Token const & t = p.get_token();
2727 debugToken(cerr, t, flags);
2730 if (flags & FLAG_ITEM) {
2731 if (t.cat() == catSpace)
2734 flags &= ~FLAG_ITEM;
2735 if (t.cat() == catBegin) {
2736 // skip the brace and collect everything to the next matching
2738 flags |= FLAG_BRACE_LAST;
2742 // handle only this single token, leave the loop if done
2743 flags |= FLAG_LEAVE;
2746 if (t.cat() != catEscape && t.character() == ']' &&
2747 (flags & FLAG_BRACK_LAST))
2749 if (t.cat() == catEnd && (flags & FLAG_BRACE_LAST))
2751 string tok = t.asInput();
2752 // we only support delimiters with max 2 chars for now.
2753 if (rdelim.size() > 1)
2754 tok += p.next_token().asInput();
2755 if (t.cat() != catEscape && !rdelim.empty()
2756 && tok == rdelim && (flags & FLAG_RDELIM)) {
2757 if (rdelim.size() > 1)
2758 p.get_token(); // eat rdelim
2762 // If there is anything between \end{env} and \begin{env} we
2763 // don't need to output a separator.
2764 if (t.cat() != catSpace && t.cat() != catNewline &&
2765 t.asInput() != "\\begin")
2772 bool const starred = p.next_token().asInput() == "*";
2773 string const starredname(starred ? (t.cs() + '*') : t.cs());
2774 if (t.cat() == catMath) {
2775 // we are inside some text mode thingy, so opening new math is allowed
2776 context.check_layout(os);
2777 begin_inset(os, "Formula ");
2778 Token const & n = p.get_token();
2779 bool const display(n.cat() == catMath && outer);
2781 // TeX's $$...$$ syntax for displayed math
2783 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2785 p.get_token(); // skip the second '$' token
2787 // simple $...$ stuff
2790 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2795 // Prevent the conversion of a line break to a
2796 // space (bug 7668). This does not change the
2797 // output, but looks ugly in LyX.
2798 eat_whitespace(p, os, context, false);
2803 if (t.cat() == catSuper || t.cat() == catSub) {
2804 cerr << "catcode " << t << " illegal in text mode\n";
2808 // Basic support for quotes. We try to disambiguate
2809 // quotes from the context (e.g., a left english quote is
2810 // the same as a right german quote...).
2811 // Try to make a smart guess about the side
2812 Token const prev = p.prev_token();
2813 bool const opening = (prev.cat() != catSpace && prev.character() != 0
2814 && prev.character() != '\n' && prev.character() != '~');
2815 if (t.asInput() == "`" && p.next_token().asInput() == "`") {
2816 context.check_layout(os);
2817 begin_inset(os, "Quotes ");
2818 os << guessQuoteStyle("eld", opening);
2824 if (t.asInput() == "'" && p.next_token().asInput() == "'") {
2825 context.check_layout(os);
2826 begin_inset(os, "Quotes ");
2827 os << guessQuoteStyle("erd", opening);
2834 if (t.asInput() == ">" && p.next_token().asInput() == ">") {
2835 context.check_layout(os);
2836 begin_inset(os, "Quotes ");
2837 os << guessQuoteStyle("ald", opening);
2844 if (t.asInput() == "<"
2845 && p.next_token().asInput() == "<") {
2846 bool has_chunk = false;
2850 has_chunk = parse_chunk(p, os, context);
2856 context.check_layout(os);
2857 begin_inset(os, "Quotes ");
2858 os << guessQuoteStyle("ard", opening);
2866 if (t.cat() == catSpace || (t.cat() == catNewline && ! p.isParagraph())) {
2867 check_space(p, os, context);
2871 // babel shorthands (also used by polyglossia)
2872 // Since these can have different meanings for different languages
2873 // we import them as ERT (but they must be put in ERT to get output
2875 if (t.asInput() == "\"") {
2877 // These are known pairs. We put them together in
2878 // one ERT inset. In other cases (such as "a), only
2879 // the quotation mark is ERTed.
2880 if (p.next_token().asInput() == "\""
2881 || p.next_token().asInput() == "|"
2882 || p.next_token().asInput() == "-"
2883 || p.next_token().asInput() == "~"
2884 || p.next_token().asInput() == "="
2885 || p.next_token().asInput() == "/"
2886 || p.next_token().asInput() == "~"
2887 || p.next_token().asInput() == "'"
2888 || p.next_token().asInput() == "`"
2889 || p.next_token().asInput() == "<"
2890 || p.next_token().asInput() == ">") {
2891 s += p.next_token().asInput();
2894 output_ert_inset(os, s, context);
2898 if (t.character() == '[' && noweb_mode &&
2899 p.next_token().character() == '[') {
2900 // These can contain underscores
2902 string const s = p.getFullOpt() + ']';
2903 if (p.next_token().character() == ']')
2906 cerr << "Warning: Inserting missing ']' in '"
2907 << s << "'." << endl;
2908 output_ert_inset(os, s, context);
2912 if (t.cat() == catLetter) {
2913 context.check_layout(os);
2918 if (t.cat() == catOther ||
2919 t.cat() == catAlign ||
2920 t.cat() == catParameter) {
2921 context.check_layout(os);
2922 if (t.asInput() == "-" && p.next_token().asInput() == "-" &&
2923 context.merging_hyphens_allowed &&
2924 context.font.family != "ttfamily" &&
2925 !context.layout->pass_thru) {
2926 if (p.next_next_token().asInput() == "-") {
2928 os << to_utf8(docstring(1, 0x2014));
2932 os << to_utf8(docstring(1, 0x2013));
2935 // This translates "&" to "\\&" which may be wrong...
2940 if (p.isParagraph()) {
2941 // In minted floating listings we will collect
2942 // everything into the caption, where multiple
2943 // paragraphs are forbidden.
2944 if (minted_float.empty()) {
2945 if (context.new_layout_allowed)
2946 context.new_paragraph(os);
2948 output_ert_inset(os, "\\par ", context);
2951 eat_whitespace(p, os, context, true);
2955 if (t.cat() == catActive) {
2956 context.check_layout(os);
2957 if (t.character() == '~') {
2958 if (context.layout->free_spacing)
2961 begin_inset(os, "space ~\n");
2969 if (t.cat() == catBegin) {
2970 Token const next = p.next_token();
2971 Token const end = p.next_next_token();
2972 if (next.cat() == catEnd) {
2974 Token const prev = p.prev_token();
2976 if (p.next_token().character() == '`')
2977 ; // ignore it in {}``
2979 output_ert_inset(os, "{}", context);
2980 } else if (next.cat() == catEscape &&
2981 is_known(next.cs(), known_quotes) &&
2982 end.cat() == catEnd) {
2983 // Something like {\textquoteright} (e.g.
2984 // from writer2latex). We may skip the
2985 // braces here for better readability.
2986 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2988 } else if (p.next_token().asInput() == "\\ascii") {
2989 // handle the \ascii characters
2990 // (the case without braces is handled later)
2991 // the code is "{\ascii\xxx}"
2992 p.get_token(); // eat \ascii
2993 string name2 = p.get_token().asInput();
2994 p.get_token(); // eat the final '}'
2995 string const name = "{\\ascii" + name2 + "}";
2999 // get the character from unicodesymbols
3000 docstring s = encodings.fromLaTeXCommand(from_utf8(name),
3001 Encodings::TEXT_CMD, termination, rem, &req);
3003 context.check_layout(os);
3006 output_ert_inset(os,
3007 to_utf8(rem), context);
3008 for (set<string>::const_iterator it = req.begin();
3009 it != req.end(); ++it)
3010 preamble.registerAutomaticallyLoadedPackage(*it);
3012 // we did not find a non-ert version
3013 output_ert_inset(os, name, context);
3015 context.check_layout(os);
3016 // special handling of font attribute changes
3017 Token const prev = p.prev_token();
3018 TeXFont const oldFont = context.font;
3019 if (next.character() == '[' ||
3020 next.character() == ']' ||
3021 next.character() == '*') {
3023 if (p.next_token().cat() == catEnd) {
3028 output_ert_inset(os, "{", context);
3029 parse_text_snippet(p, os,
3032 output_ert_inset(os, "}", context);
3034 } else if (! context.new_layout_allowed) {
3035 output_ert_inset(os, "{", context);
3036 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3038 output_ert_inset(os, "}", context);
3039 } else if (is_known(next.cs(), known_sizes)) {
3040 // next will change the size, so we must
3042 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3044 if (!context.atParagraphStart())
3046 << context.font.size << "\n";
3047 } else if (is_known(next.cs(), known_font_families)) {
3048 // next will change the font family, so we
3049 // must reset it here
3050 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3052 if (!context.atParagraphStart())
3054 << context.font.family << "\n";
3055 } else if (is_known(next.cs(), known_font_series)) {
3056 // next will change the font series, so we
3057 // must reset it here
3058 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3060 if (!context.atParagraphStart())
3062 << context.font.series << "\n";
3063 } else if (is_known(next.cs(), known_font_shapes)) {
3064 // next will change the font shape, so we
3065 // must reset it here
3066 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3068 if (!context.atParagraphStart())
3070 << context.font.shape << "\n";
3071 } else if (is_known(next.cs(), known_old_font_families) ||
3072 is_known(next.cs(), known_old_font_series) ||
3073 is_known(next.cs(), known_old_font_shapes)) {
3074 // next will change the font family, series
3075 // and shape, so we must reset it here
3076 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3078 if (!context.atParagraphStart())
3080 << context.font.family
3082 << context.font.series
3084 << context.font.shape << "\n";
3086 output_ert_inset(os, "{", context);
3087 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3089 output_ert_inset(os, "}", context);
3095 if (t.cat() == catEnd) {
3096 if (flags & FLAG_BRACE_LAST) {
3099 cerr << "stray '}' in text\n";
3100 output_ert_inset(os, "}", context);
3104 if (t.cat() == catComment) {
3105 parse_comment(p, os, t, context);
3110 // control sequences
3113 if (t.cs() == "(" || t.cs() == "[") {
3114 bool const simple = t.cs() == "(";
3115 context.check_layout(os);
3116 begin_inset(os, "Formula");
3117 os << " \\" << t.cs();
3118 parse_math(p, os, simple ? FLAG_SIMPLE2 : FLAG_EQUATION, MATH_MODE);
3119 os << '\\' << (simple ? ')' : ']');
3122 // Prevent the conversion of a line break to a
3123 // space (bug 7668). This does not change the
3124 // output, but looks ugly in LyX.
3125 eat_whitespace(p, os, context, false);
3130 if (t.cs() == "begin") {
3131 parse_environment(p, os, outer, last_env,
3136 if (t.cs() == "end") {
3137 if (flags & FLAG_END) {
3138 // eat environment name
3139 string const name = p.getArg('{', '}');
3140 if (name != active_environment())
3141 cerr << "\\end{" + name + "} does not match \\begin{"
3142 + active_environment() + "}\n";
3145 p.error("found 'end' unexpectedly");
3149 // "item" by default, but could be something else
3150 if (t.cs() == context.layout->itemcommand()) {
3152 if (context.layout->labeltype == LABEL_MANUAL) {
3153 // FIXME: This swallows comments, but we cannot use
3154 // eat_whitespace() since we must not output
3155 // anything before the item.
3156 p.skip_spaces(true);
3157 s = p.verbatimOption();
3159 p.skip_spaces(false);
3161 context.check_layout(os);
3162 if (context.has_item) {
3163 // An item in an unknown list-like environment
3164 // FIXME: Do this in check_layout()!
3165 context.has_item = false;
3166 string item = "\\" + context.layout->itemcommand();
3169 output_ert_inset(os, item, context);
3171 if (context.layout->labeltype != LABEL_MANUAL)
3172 output_arguments(os, p, outer, false, "item", context,
3173 context.layout->itemargs());
3174 if (!context.list_extra_stuff.empty()) {
3175 os << context.list_extra_stuff;
3176 context.list_extra_stuff.clear();
3178 else if (!s.empty()) {
3179 // LyX adds braces around the argument,
3180 // so we need to remove them here.
3181 if (s.size() > 2 && s[0] == '{' &&
3182 s[s.size()-1] == '}')
3183 s = s.substr(1, s.size()-2);
3184 // If the argument contains a space we
3185 // must put it into ERT: Otherwise LyX
3186 // would misinterpret the space as
3187 // item delimiter (bug 7663)
3188 if (contains(s, ' ')) {
3189 output_ert_inset(os, s, context);
3192 os << parse_text_snippet(p2,
3193 FLAG_BRACK_LAST, outer, context);
3195 // The space is needed to separate the
3196 // item from the rest of the sentence.
3198 eat_whitespace(p, os, context, false);
3203 if (t.cs() == "bibitem") {
3205 context.check_layout(os);
3206 eat_whitespace(p, os, context, false);
3207 string label = p.verbatimOption();
3208 pair<bool, string> lbl = convert_latexed_command_inset_arg(label);
3209 bool const literal = !lbl.first;
3210 label = literal ? subst(label, "\n", " ") : lbl.second;
3211 string lit = literal ? "\"true\"" : "\"false\"";
3212 string key = convert_literate_command_inset_arg(p.verbatim_item());
3213 begin_command_inset(os, "bibitem", "bibitem");
3214 os << "label \"" << label << "\"\n"
3215 << "key \"" << key << "\"\n"
3216 << "literal " << lit << "\n";
3222 // catch the case of \def\inputGnumericTable
3224 if (t.cs() == "def") {
3225 Token second = p.next_token();
3226 if (second.cs() == "inputGnumericTable") {
3230 Token third = p.get_token();
3232 if (third.cs() == "input") {
3236 string name = normalize_filename(p.verbatim_item());
3237 string const path = getMasterFilePath(true);
3238 // We want to preserve relative / absolute filenames,
3239 // therefore path is only used for testing
3240 // The file extension is in every case ".tex".
3241 // So we need to remove this extension and check for
3242 // the original one.
3243 name = removeExtension(name);
3244 if (!makeAbsPath(name, path).exists()) {
3245 char const * const Gnumeric_formats[] = {"gnumeric",
3247 string const Gnumeric_name =
3248 find_file(name, path, Gnumeric_formats);
3249 if (!Gnumeric_name.empty())
3250 name = Gnumeric_name;
3252 FileName const absname = makeAbsPath(name, path);
3253 if (absname.exists()) {
3254 fix_child_filename(name);
3255 copy_file(absname, name);
3257 cerr << "Warning: Could not find file '"
3258 << name << "'." << endl;
3259 context.check_layout(os);
3260 begin_inset(os, "External\n\ttemplate ");
3261 os << "GnumericSpreadsheet\n\tfilename "
3264 context.check_layout(os);
3266 // register the packages that are automatically loaded
3267 // by the Gnumeric template
3268 registerExternalTemplatePackages("GnumericSpreadsheet");
3273 parse_macro(p, os, context);
3277 if (t.cs() == "noindent") {
3279 context.add_par_extra_stuff("\\noindent\n");
3283 if (t.cs() == "appendix") {
3284 context.add_par_extra_stuff("\\start_of_appendix\n");
3285 // We need to start a new paragraph. Otherwise the
3286 // appendix in 'bla\appendix\chapter{' would start
3288 context.new_paragraph(os);
3289 // We need to make sure that the paragraph is
3290 // generated even if it is empty. Otherwise the
3291 // appendix in '\par\appendix\par\chapter{' would
3293 context.check_layout(os);
3294 // FIXME: This is a hack to prevent paragraph
3295 // deletion if it is empty. Handle this better!
3296 output_comment(p, os,
3297 "dummy comment inserted by tex2lyx to "
3298 "ensure that this paragraph is not empty",
3300 // Both measures above may generate an additional
3301 // empty paragraph, but that does not hurt, because
3302 // whitespace does not matter here.
3303 eat_whitespace(p, os, context, true);
3307 // Must catch empty dates before findLayout is called below
3308 if (t.cs() == "date") {
3309 eat_whitespace(p, os, context, false);
3311 string const date = p.verbatim_item();
3314 preamble.suppressDate(true);
3317 preamble.suppressDate(false);
3318 if (context.new_layout_allowed &&
3319 (newlayout = findLayout(context.textclass,
3322 output_command_layout(os, p, outer,
3323 context, newlayout);
3324 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3325 if (!preamble.titleLayoutFound())
3326 preamble.titleLayoutFound(newlayout->intitle);
3327 set<string> const & req = newlayout->requires();
3328 set<string>::const_iterator it = req.begin();
3329 set<string>::const_iterator en = req.end();
3330 for (; it != en; ++it)
3331 preamble.registerAutomaticallyLoadedPackage(*it);
3333 output_ert_inset(os,
3334 "\\date{" + p.verbatim_item() + '}',
3340 // Before we look for the layout name with star and alone below, we check the layouts including
3341 // the LateXParam, which might be one or several options or a star.
3342 // The single '=' is meant here.
3343 if (context.new_layout_allowed &&
3344 (newlayout = findLayout(context.textclass, t.cs(), true, p.getCommandLatexParam()))) {
3345 // store the latexparam here. This is eaten in output_command_layout
3346 context.latexparam = newlayout->latexparam();
3348 output_command_layout(os, p, outer, context, newlayout);
3349 context.latexparam.clear();
3351 if (!preamble.titleLayoutFound())
3352 preamble.titleLayoutFound(newlayout->intitle);
3353 set<string> const & req = newlayout->requires();
3354 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3355 preamble.registerAutomaticallyLoadedPackage(*it);
3360 // Starred section headings
3361 // Must attempt to parse "Section*" before "Section".
3362 if ((p.next_token().asInput() == "*") &&
3363 context.new_layout_allowed &&
3364 (newlayout = findLayout(context.textclass, t.cs() + '*', true))) {
3367 output_command_layout(os, p, outer, context, newlayout);
3369 if (!preamble.titleLayoutFound())
3370 preamble.titleLayoutFound(newlayout->intitle);
3371 set<string> const & req = newlayout->requires();
3372 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3373 preamble.registerAutomaticallyLoadedPackage(*it);
3377 // Section headings and the like
3378 if (context.new_layout_allowed &&
3379 (newlayout = findLayout(context.textclass, t.cs(), true))) {
3381 output_command_layout(os, p, outer, context, newlayout);
3383 if (!preamble.titleLayoutFound())
3384 preamble.titleLayoutFound(newlayout->intitle);
3385 set<string> const & req = newlayout->requires();
3386 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3387 preamble.registerAutomaticallyLoadedPackage(*it);
3391 if (t.cs() == "subfloat") {
3392 // the syntax is \subfloat[list entry][sub caption]{content}
3393 // if it is a table of figure depends on the surrounding float
3395 // do nothing if there is no outer float
3396 if (!float_type.empty()) {
3397 context.check_layout(os);
3399 begin_inset(os, "Float " + float_type + "\n");
3401 << "\nsideways false"
3402 << "\nstatus collapsed\n\n";
3405 bool has_caption = false;
3406 if (p.next_token().cat() != catEscape &&
3407 p.next_token().character() == '[') {
3408 p.get_token(); // eat '['
3409 caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
3412 // In case we have two optional args, the second is the caption.
3413 if (p.next_token().cat() != catEscape &&
3414 p.next_token().character() == '[') {
3415 p.get_token(); // eat '['
3416 caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
3419 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3420 // the caption comes always as the last
3422 // we must make sure that the caption gets a \begin_layout
3423 os << "\n\\begin_layout Plain Layout";
3425 begin_inset(os, "Caption Standard\n");
3426 Context newcontext(true, context.textclass,
3427 0, 0, context.font);
3428 newcontext.check_layout(os);
3429 os << caption << "\n";
3430 newcontext.check_end_layout(os);
3433 // close the layout we opened
3434 os << "\n\\end_layout";
3439 // if the float type is not supported or there is no surrounding float
3444 opt_arg1 = convert_literate_command_inset_arg(p.getFullOpt());
3446 opt_arg2 = convert_literate_command_inset_arg(p.getFullOpt());
3448 output_ert_inset(os, t.asInput() + opt_arg1 + opt_arg2
3449 + "{" + p.verbatim_item() + '}', context);
3454 if (t.cs() == "xymatrix") {
3455 // we must open a new math because LyX's xy support is in math
3456 context.check_layout(os);
3457 begin_inset(os, "Formula ");
3459 os << "\\" << t.cs() << '{';
3460 parse_math(p, os, FLAG_ITEM, MATH_MODE);
3463 preamble.registerAutomaticallyLoadedPackage("xy");
3467 if (t.cs() == "includegraphics") {
3468 bool const clip = p.next_token().asInput() == "*";
3471 string const arg = p.getArg('[', ']');
3472 map<string, string> opts;
3473 vector<string> keys;
3474 split_map(arg, opts, keys);
3476 opts["clip"] = string();
3477 string name = normalize_filename(p.verbatim_item());
3479 string const path = getMasterFilePath(true);
3480 // We want to preserve relative / absolute filenames,
3481 // therefore path is only used for testing
3482 if (!makeAbsPath(name, path).exists()) {
3483 // The file extension is probably missing.
3484 // Now try to find it out.
3485 string const dvips_name =
3486 find_file(name, path,
3487 known_dvips_graphics_formats);
3488 string const pdftex_name =
3489 find_file(name, path,
3490 known_pdftex_graphics_formats);
3491 if (!dvips_name.empty()) {
3492 if (!pdftex_name.empty()) {
3493 cerr << "This file contains the "
3495 "\"\\includegraphics{"
3497 "However, files\n\""
3498 << dvips_name << "\" and\n\""
3499 << pdftex_name << "\"\n"
3500 "both exist, so I had to make a "
3501 "choice and took the first one.\n"
3502 "Please move the unwanted one "
3503 "someplace else and try again\n"
3504 "if my choice was wrong."
3508 } else if (!pdftex_name.empty()) {
3514 FileName const absname = makeAbsPath(name, path);
3515 if (absname.exists()) {
3516 fix_child_filename(name);
3517 copy_file(absname, name);
3519 cerr << "Warning: Could not find graphics file '"
3520 << name << "'." << endl;
3522 context.check_layout(os);
3523 begin_inset(os, "Graphics ");
3524 os << "\n\tfilename " << name << '\n';
3525 if (opts.find("width") != opts.end())
3527 << translate_len(opts["width"]) << '\n';
3528 if (opts.find("height") != opts.end())
3530 << translate_len(opts["height"]) << '\n';
3531 if (opts.find("scale") != opts.end()) {
3532 istringstream iss(opts["scale"]);
3536 os << "\tscale " << val << '\n';
3538 if (opts.find("angle") != opts.end()) {
3539 os << "\trotateAngle "
3540 << opts["angle"] << '\n';
3541 vector<string>::const_iterator a =
3542 find(keys.begin(), keys.end(), "angle");
3543 vector<string>::const_iterator s =
3544 find(keys.begin(), keys.end(), "width");
3545 if (s == keys.end())
3546 s = find(keys.begin(), keys.end(), "height");
3547 if (s == keys.end())
3548 s = find(keys.begin(), keys.end(), "scale");
3549 if (s != keys.end() && distance(s, a) > 0)
3550 os << "\tscaleBeforeRotation\n";
3552 if (opts.find("origin") != opts.end()) {
3554 string const opt = opts["origin"];
3555 if (opt.find('l') != string::npos) ss << "left";
3556 if (opt.find('r') != string::npos) ss << "right";
3557 if (opt.find('c') != string::npos) ss << "center";
3558 if (opt.find('t') != string::npos) ss << "Top";
3559 if (opt.find('b') != string::npos) ss << "Bottom";
3560 if (opt.find('B') != string::npos) ss << "Baseline";
3561 if (!ss.str().empty())
3562 os << "\trotateOrigin " << ss.str() << '\n';
3564 cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
3566 if (opts.find("keepaspectratio") != opts.end())
3567 os << "\tkeepAspectRatio\n";
3568 if (opts.find("clip") != opts.end())
3570 if (opts.find("draft") != opts.end())
3572 if (opts.find("bb") != opts.end())
3573 os << "\tBoundingBox "
3574 << opts["bb"] << '\n';
3575 int numberOfbbOptions = 0;
3576 if (opts.find("bbllx") != opts.end())
3577 numberOfbbOptions++;
3578 if (opts.find("bblly") != opts.end())
3579 numberOfbbOptions++;
3580 if (opts.find("bburx") != opts.end())
3581 numberOfbbOptions++;
3582 if (opts.find("bbury") != opts.end())
3583 numberOfbbOptions++;
3584 if (numberOfbbOptions == 4)
3585 os << "\tBoundingBox "
3586 << opts["bbllx"] << " " << opts["bblly"] << " "
3587 << opts["bburx"] << " " << opts["bbury"] << '\n';
3588 else if (numberOfbbOptions > 0)
3589 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
3590 numberOfbbOptions = 0;
3591 if (opts.find("natwidth") != opts.end())
3592 numberOfbbOptions++;
3593 if (opts.find("natheight") != opts.end())
3594 numberOfbbOptions++;
3595 if (numberOfbbOptions == 2)
3596 os << "\tBoundingBox 0bp 0bp "
3597 << opts["natwidth"] << " " << opts["natheight"] << '\n';
3598 else if (numberOfbbOptions > 0)
3599 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
3600 ostringstream special;
3601 if (opts.find("hiresbb") != opts.end())
3602 special << "hiresbb,";
3603 if (opts.find("trim") != opts.end())
3605 if (opts.find("viewport") != opts.end())
3606 special << "viewport=" << opts["viewport"] << ',';
3607 if (opts.find("totalheight") != opts.end())
3608 special << "totalheight=" << opts["totalheight"] << ',';
3609 if (opts.find("type") != opts.end())
3610 special << "type=" << opts["type"] << ',';
3611 if (opts.find("ext") != opts.end())
3612 special << "ext=" << opts["ext"] << ',';
3613 if (opts.find("read") != opts.end())
3614 special << "read=" << opts["read"] << ',';
3615 if (opts.find("command") != opts.end())
3616 special << "command=" << opts["command"] << ',';
3617 string s_special = special.str();
3618 if (!s_special.empty()) {
3619 // We had special arguments. Remove the trailing ','.
3620 os << "\tspecial " << s_special.substr(0, s_special.size() - 1) << '\n';
3622 // TODO: Handle the unknown settings better.
3623 // Warn about invalid options.
3624 // Check whether some option was given twice.
3626 preamble.registerAutomaticallyLoadedPackage("graphicx");
3630 if (t.cs() == "footnote" ||
3631 (t.cs() == "thanks" && context.layout->intitle)) {
3633 context.check_layout(os);
3634 begin_inset(os, "Foot\n");
3635 os << "status collapsed\n\n";
3636 parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3641 if (t.cs() == "marginpar") {
3643 context.check_layout(os);
3644 begin_inset(os, "Marginal\n");
3645 os << "status collapsed\n\n";
3646 parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3651 if (t.cs() == "lstinline" || t.cs() == "mintinline") {
3652 bool const use_minted = t.cs() == "mintinline";
3654 parse_listings(p, os, context, true, use_minted);
3658 if (t.cs() == "ensuremath") {
3660 context.check_layout(os);
3661 string const s = p.verbatim_item();
3662 //FIXME: this never triggers in UTF8
3663 if (s == "\xb1" || s == "\xb3" || s == "\xb2" || s == "\xb5")
3666 output_ert_inset(os, "\\ensuremath{" + s + "}",
3671 else if (t.cs() == "makeindex"
3672 || ((t.cs() == "maketitle" || t.cs() == context.textclass.titlename())
3673 && context.textclass.titletype() == TITLE_COMMAND_AFTER)) {
3674 if (preamble.titleLayoutFound()) {
3676 skip_spaces_braces(p);
3678 output_ert_inset(os, t.asInput(), context);
3682 if (t.cs() == "tableofcontents"
3683 || t.cs() == "lstlistoflistings"
3684 || t.cs() == "listoflistings") {
3685 string name = t.cs();
3686 if (preamble.minted() && name == "listoflistings")
3687 name.insert(0, "lst");
3688 context.check_layout(os);
3689 begin_command_inset(os, "toc", name);
3691 skip_spaces_braces(p);
3692 if (name == "lstlistoflistings") {
3693 if (preamble.minted())
3694 preamble.registerAutomaticallyLoadedPackage("minted");
3696 preamble.registerAutomaticallyLoadedPackage("listings");
3701 if (t.cs() == "listoffigures" || t.cs() == "listoftables") {
3702 context.check_layout(os);
3703 if (t.cs() == "listoffigures")
3704 begin_inset(os, "FloatList figure\n");
3706 begin_inset(os, "FloatList table\n");
3708 skip_spaces_braces(p);
3712 if (t.cs() == "listof") {
3713 p.skip_spaces(true);
3714 string const name = p.get_token().cs();
3715 if (context.textclass.floats().typeExist(name)) {
3716 context.check_layout(os);
3717 begin_inset(os, "FloatList ");
3720 p.get_token(); // swallow second arg
3722 output_ert_inset(os, "\\listof{" + name + "}", context);
3726 if ((where = is_known(t.cs(), known_text_font_families))) {
3727 parse_text_attributes(p, os, FLAG_ITEM, outer,
3728 context, "\\family", context.font.family,
3729 known_coded_font_families[where - known_text_font_families]);
3733 // beamer has a \textbf<overlay>{} inset
3734 if (!p.hasOpt("<") && (where = is_known(t.cs(), known_text_font_series))) {
3735 parse_text_attributes(p, os, FLAG_ITEM, outer,
3736 context, "\\series", context.font.series,
3737 known_coded_font_series[where - known_text_font_series]);
3741 // beamer has a \textit<overlay>{} inset
3742 if (!p.hasOpt("<") && (where = is_known(t.cs(), known_text_font_shapes))) {
3743 parse_text_attributes(p, os, FLAG_ITEM, outer,
3744 context, "\\shape", context.font.shape,
3745 known_coded_font_shapes[where - known_text_font_shapes]);
3749 if (t.cs() == "textnormal" || t.cs() == "normalfont") {
3750 context.check_layout(os);
3751 TeXFont oldFont = context.font;
3752 context.font.init();
3753 context.font.size = oldFont.size;
3754 os << "\n\\family " << context.font.family << "\n";
3755 os << "\n\\series " << context.font.series << "\n";
3756 os << "\n\\shape " << context.font.shape << "\n";
3757 if (t.cs() == "textnormal") {
3758 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3759 output_font_change(os, context.font, oldFont);
3760 context.font = oldFont;
3762 eat_whitespace(p, os, context, false);
3766 if (t.cs() == "textcolor") {
3767 // scheme is \textcolor{color name}{text}
3768 string const color = p.verbatim_item();
3769 // we support the predefined colors of the color and the xcolor package
3770 if (color == "black" || color == "blue" || color == "cyan"
3771 || color == "green" || color == "magenta" || color == "red"
3772 || color == "white" || color == "yellow") {
3773 context.check_layout(os);
3774 os << "\n\\color " << color << "\n";
3775 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3776 context.check_layout(os);
3777 os << "\n\\color inherit\n";
3778 preamble.registerAutomaticallyLoadedPackage("color");
3779 } else if (color == "brown" || color == "darkgray" || color == "gray"
3780 || color == "lightgray" || color == "lime" || color == "olive"
3781 || color == "orange" || color == "pink" || color == "purple"
3782 || color == "teal" || color == "violet") {
3783 context.check_layout(os);
3784 os << "\n\\color " << color << "\n";
3785 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3786 context.check_layout(os);
3787 os << "\n\\color inherit\n";
3788 preamble.registerAutomaticallyLoadedPackage("xcolor");
3790 // for custom defined colors
3791 output_ert_inset(os, t.asInput() + "{" + color + "}", context);
3795 if (t.cs() == "underbar" || t.cs() == "uline") {
3796 // \underbar is not 100% correct (LyX outputs \uline
3797 // of ulem.sty). The difference is that \ulem allows
3798 // line breaks, and \underbar does not.
3799 // Do NOT handle \underline.
3800 // \underbar cuts through y, g, q, p etc.,
3801 // \underline does not.
3802 context.check_layout(os);
3803 os << "\n\\bar under\n";
3804 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3805 context.check_layout(os);
3806 os << "\n\\bar default\n";
3807 preamble.registerAutomaticallyLoadedPackage("ulem");
3811 if (t.cs() == "sout") {
3812 context.check_layout(os);
3813 os << "\n\\strikeout on\n";
3814 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3815 context.check_layout(os);
3816 os << "\n\\strikeout default\n";
3817 preamble.registerAutomaticallyLoadedPackage("ulem");
3821 // beamer has an \emph<overlay>{} inset
3822 if ((t.cs() == "uuline" || t.cs() == "uwave"
3823 || t.cs() == "emph" || t.cs() == "noun"
3824 || t.cs() == "xout") && !p.hasOpt("<")) {
3825 context.check_layout(os);
3826 os << "\n\\" << t.cs() << " on\n";
3827 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3828 context.check_layout(os);
3829 os << "\n\\" << t.cs() << " default\n";
3830 if (t.cs() == "uuline" || t.cs() == "uwave" || t.cs() == "xout")
3831 preamble.registerAutomaticallyLoadedPackage("ulem");
3835 if (t.cs() == "lyxadded" || t.cs() == "lyxdeleted") {
3836 context.check_layout(os);
3837 string name = p.getArg('{', '}');
3838 string localtime = p.getArg('{', '}');
3839 preamble.registerAuthor(name);
3840 Author const & author = preamble.getAuthor(name);
3841 // from_asctime_utc() will fail if LyX decides to output the
3842 // time in the text language.
3843 time_t ptime = from_asctime_utc(localtime);
3844 if (ptime == static_cast<time_t>(-1)) {
3845 cerr << "Warning: Could not parse time `" << localtime
3846 << "´ for change tracking, using current time instead.\n";
3847 ptime = current_time();
3849 if (t.cs() == "lyxadded")
3850 os << "\n\\change_inserted ";
3852 os << "\n\\change_deleted ";
3853 os << author.bufferId() << ' ' << ptime << '\n';
3854 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3855 bool dvipost = LaTeXPackages::isAvailable("dvipost");
3856 bool xcolorulem = LaTeXPackages::isAvailable("ulem") &&
3857 LaTeXPackages::isAvailable("xcolor");
3858 // No need to test for luatex, since luatex comes in
3859 // two flavours (dvi and pdf), like latex, and those
3860 // are detected by pdflatex.
3861 if (pdflatex || xetex) {
3863 preamble.registerAutomaticallyLoadedPackage("ulem");
3864 preamble.registerAutomaticallyLoadedPackage("xcolor");
3865 preamble.registerAutomaticallyLoadedPackage("pdfcolmk");
3869 preamble.registerAutomaticallyLoadedPackage("dvipost");
3870 } else if (xcolorulem) {
3871 preamble.registerAutomaticallyLoadedPackage("ulem");
3872 preamble.registerAutomaticallyLoadedPackage("xcolor");
3878 if (t.cs() == "textipa") {
3879 context.check_layout(os);
3880 begin_inset(os, "IPA\n");
3881 bool merging_hyphens_allowed = context.merging_hyphens_allowed;
3882 context.merging_hyphens_allowed = false;
3883 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3884 context.merging_hyphens_allowed = merging_hyphens_allowed;
3886 preamble.registerAutomaticallyLoadedPackage("tipa");
3887 preamble.registerAutomaticallyLoadedPackage("tipx");
3891 if ((preamble.isPackageUsed("tipa") && t.cs() == "t" && p.next_token().asInput() == "*")
3892 || t.cs() == "texttoptiebar" || t.cs() == "textbottomtiebar") {
3893 context.check_layout(os);
3897 string const type = (t.cs() == "t") ? "bottomtiebar" : t.cs().substr(4);
3898 begin_inset(os, "IPADeco " + type + "\n");
3899 os << "status open\n";
3900 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3906 if (t.cs() == "textvertline") {
3907 // FIXME: This is not correct, \textvertline is higher than |
3913 if (t.cs() == "tone" ) {
3914 context.check_layout(os);
3915 // register the tone package
3916 preamble.registerAutomaticallyLoadedPackage("tone");
3917 string content = trimSpaceAndEol(p.verbatim_item());
3918 string command = t.asInput() + "{" + content + "}";
3919 // some tones can be detected by unicodesymbols, some need special code
3920 if (is_known(content, known_tones)) {
3921 os << "\\IPAChar " << command << "\n";
3924 // try to see whether the string is in unicodesymbols
3928 docstring s = encodings.fromLaTeXCommand(from_utf8(command),
3929 Encodings::TEXT_CMD | Encodings::MATH_CMD,
3930 termination, rem, &req);
3934 output_ert_inset(os, to_utf8(rem), context);
3935 for (set<string>::const_iterator it = req.begin();
3936 it != req.end(); ++it)
3937 preamble.registerAutomaticallyLoadedPackage(*it);
3939 // we did not find a non-ert version
3940 output_ert_inset(os, command, context);
3944 if (t.cs() == "phantom" || t.cs() == "hphantom" ||
3945 t.cs() == "vphantom") {
3946 context.check_layout(os);
3947 if (t.cs() == "phantom")
3948 begin_inset(os, "Phantom Phantom\n");
3949 if (t.cs() == "hphantom")
3950 begin_inset(os, "Phantom HPhantom\n");
3951 if (t.cs() == "vphantom")
3952 begin_inset(os, "Phantom VPhantom\n");
3953 os << "status open\n";
3954 parse_text_in_inset(p, os, FLAG_ITEM, outer, context,
3960 if (t.cs() == "href") {
3961 context.check_layout(os);
3962 string target = convert_literate_command_inset_arg(p.verbatim_item());
3963 string name = p.verbatim_item();
3964 pair<bool, string> nm = convert_latexed_command_inset_arg(name);
3965 bool const literal = !nm.first;
3966 name = literal ? subst(name, "\n", " ") : nm.second;
3967 string lit = literal ? "\"true\"" : "\"false\"";
3969 size_t i = target.find(':');
3970 if (i != string::npos) {
3971 type = target.substr(0, i + 1);
3972 if (type == "mailto:" || type == "file:")
3973 target = target.substr(i + 1);
3974 // handle the case that name is equal to target, except of "http(s)://"
3975 else if (target.substr(i + 3) == name && (type == "http:" || type == "https:"))
3978 begin_command_inset(os, "href", "href");
3980 os << "name \"" << name << "\"\n";
3981 os << "target \"" << target << "\"\n";
3982 if (type == "mailto:" || type == "file:")
3983 os << "type \"" << type << "\"\n";
3984 os << "literal " << lit << "\n";
3986 skip_spaces_braces(p);
3990 if (t.cs() == "lyxline") {
3991 // swallow size argument (it is not used anyway)
3993 if (!context.atParagraphStart()) {
3994 // so our line is in the middle of a paragraph
3995 // we need to add a new line, lest this line
3996 // follow the other content on that line and
3997 // run off the side of the page
3998 // FIXME: This may create an empty paragraph,
3999 // but without that it would not be
4000 // possible to set noindent below.
4001 // Fortunately LaTeX does not care
4002 // about the empty paragraph.
4003 context.new_paragraph(os);
4005 if (preamble.indentParagraphs()) {
4006 // we need to unindent, lest the line be too long
4007 context.add_par_extra_stuff("\\noindent\n");
4009 context.check_layout(os);
4010 begin_command_inset(os, "line", "rule");
4011 os << "offset \"0.5ex\"\n"
4012 "width \"100line%\"\n"
4018 if (t.cs() == "rule") {
4019 string const offset = (p.hasOpt() ? p.getArg('[', ']') : string());
4020 string const width = p.getArg('{', '}');
4021 string const thickness = p.getArg('{', '}');
4022 context.check_layout(os);
4023 begin_command_inset(os, "line", "rule");
4024 if (!offset.empty())
4025 os << "offset \"" << translate_len(offset) << "\"\n";
4026 os << "width \"" << translate_len(width) << "\"\n"
4027 "height \"" << translate_len(thickness) << "\"\n";
4032 // handle refstyle first to catch \eqref which can also occur
4033 // without refstyle. Only recognize these commands if
4034 // refstyle.sty was found in the preamble (otherwise \eqref
4035 // and user defined ref commands could be misdetected).
4036 if ((where = is_known(t.cs(), known_refstyle_commands))
4037 && preamble.refstyle()) {
4038 context.check_layout(os);
4039 begin_command_inset(os, "ref", "formatted");
4040 os << "reference \"";
4041 os << known_refstyle_prefixes[where - known_refstyle_commands]
4043 os << convert_literate_command_inset_arg(p.verbatim_item())
4045 os << "plural \"false\"\n";
4046 os << "caps \"false\"\n";
4047 os << "noprefix \"false\"\n";
4049 preamble.registerAutomaticallyLoadedPackage("refstyle");
4053 // if refstyle is used, we must not convert \prettyref to a
4054 // formatted reference, since that would result in a refstyle command.
4055 if ((where = is_known(t.cs(), known_ref_commands)) &&
4056 (t.cs() != "prettyref" || !preamble.refstyle())) {
4057 string const opt = p.getOpt();
4059 context.check_layout(os);
4060 begin_command_inset(os, "ref",
4061 known_coded_ref_commands[where - known_ref_commands]);
4062 os << "reference \""
4063 << convert_literate_command_inset_arg(p.verbatim_item())
4065 os << "plural \"false\"\n";
4066 os << "caps \"false\"\n";
4067 os << "noprefix \"false\"\n";
4069 if (t.cs() == "vref" || t.cs() == "vpageref")
4070 preamble.registerAutomaticallyLoadedPackage("varioref");
4071 else if (t.cs() == "prettyref")
4072 preamble.registerAutomaticallyLoadedPackage("prettyref");
4074 // LyX does not yet support optional arguments of ref commands
4075 output_ert_inset(os, t.asInput() + '[' + opt + "]{" +
4076 p.verbatim_item() + '}', context);
4082 is_known(t.cs(), known_natbib_commands) &&
4083 ((t.cs() != "citefullauthor" &&
4084 t.cs() != "citeyear" &&
4085 t.cs() != "citeyearpar") ||
4086 p.next_token().asInput() != "*")) {
4087 context.check_layout(os);
4088 string command = t.cs();
4089 if (p.next_token().asInput() == "*") {
4093 if (command == "citefullauthor")
4094 // alternative name for "\\citeauthor*"
4095 command = "citeauthor*";
4097 // text before the citation
4099 // text after the citation
4101 get_cite_arguments(p, true, before, after);
4103 if (command == "cite") {
4104 // \cite without optional argument means
4105 // \citet, \cite with at least one optional
4106 // argument means \citep.
4107 if (before.empty() && after.empty())
4112 if (before.empty() && after == "[]")
4113 // avoid \citet[]{a}
4115 else if (before == "[]" && after == "[]") {
4116 // avoid \citet[][]{a}
4120 bool literal = false;
4121 pair<bool, string> aft;
4122 pair<bool, string> bef;
4123 // remove the brackets around after and before
4124 if (!after.empty()) {
4126 after.erase(after.length() - 1, 1);
4127 aft = convert_latexed_command_inset_arg(after);
4128 literal = !aft.first;
4129 after = literal ? subst(after, "\n", " ") : aft.second;
4131 if (!before.empty()) {
4133 before.erase(before.length() - 1, 1);
4134 bef = convert_latexed_command_inset_arg(before);
4135 literal |= !bef.first;
4136 before = literal ? subst(before, "\n", " ") : bef.second;
4137 if (literal && !after.empty())
4138 after = subst(after, "\n", " ");
4140 string lit = literal ? "\"true\"" : "\"false\"";
4141 begin_command_inset(os, "citation", command);
4142 os << "after " << '"' << after << '"' << "\n";
4143 os << "before " << '"' << before << '"' << "\n";
4145 << convert_literate_command_inset_arg(p.verbatim_item())
4147 << "literal " << lit << "\n";
4149 // Need to set the cite engine if natbib is loaded by
4150 // the document class directly
4151 if (preamble.citeEngine() == "basic")
4152 preamble.citeEngine("natbib");
4157 && is_known(t.cs(), known_biblatex_commands)
4158 && ((t.cs() == "cite"
4159 || t.cs() == "citeauthor"
4160 || t.cs() == "Citeauthor"
4161 || t.cs() == "parencite"
4162 || t.cs() == "citetitle")
4163 || p.next_token().asInput() != "*"))
4164 || (use_biblatex_natbib
4165 && (is_known(t.cs(), known_biblatex_commands)
4166 || is_known(t.cs(), known_natbib_commands))
4167 && ((t.cs() == "cite" || t.cs() == "citet" || t.cs() == "Citet"
4168 || t.cs() == "citep" || t.cs() == "Citep" || t.cs() == "citealt"
4169 || t.cs() == "Citealt" || t.cs() == "citealp" || t.cs() == "Citealp"
4170 || t.cs() == "citeauthor" || t.cs() == "Citeauthor"
4171 || t.cs() == "parencite" || t.cs() == "citetitle")
4172 || p.next_token().asInput() != "*"))){
4173 context.check_layout(os);
4174 string command = t.cs();
4175 if (p.next_token().asInput() == "*") {
4180 bool const qualified = suffixIs(command, "s");
4182 command = rtrim(command, "s");
4184 // text before the citation
4186 // text after the citation
4188 get_cite_arguments(p, true, before, after, qualified);
4190 // These use natbib cmd names in LyX
4191 // for inter-citeengine compativility
4192 if (command == "citeyear")
4193 command = "citebyear";
4194 else if (command == "cite*")
4195 command = "citeyear";
4196 else if (command == "textcite")
4198 else if (command == "Textcite")
4200 else if (command == "parencite")
4202 else if (command == "Parencite")
4204 else if (command == "parencite*")
4205 command = "citeyearpar";
4206 else if (command == "smartcite")
4207 command = "footcite";
4208 else if (command == "Smartcite")
4209 command = "Footcite";
4211 string const emptyarg = qualified ? "()" : "[]";
4212 if (before.empty() && after == emptyarg)
4215 else if (before == emptyarg && after == emptyarg) {
4216 // avoid \cite[][]{a}
4220 bool literal = false;
4221 pair<bool, string> aft;
4222 pair<bool, string> bef;
4223 // remove the brackets around after and before
4224 if (!after.empty()) {
4226 after.erase(after.length() - 1, 1);
4227 aft = convert_latexed_command_inset_arg(after);
4228 literal = !aft.first;
4229 after = literal ? subst(after, "\n", " ") : aft.second;
4231 if (!before.empty()) {
4233 before.erase(before.length() - 1, 1);
4234 bef = convert_latexed_command_inset_arg(before);
4235 literal |= !bef.first;
4236 before = literal ? subst(before, "\n", " ") : bef.second;
4238 string keys, pretextlist, posttextlist;
4240 map<string, string> pres, posts, preslit, postslit;
4241 vector<string> lkeys;
4242 // text before the citation
4243 string lbefore, lbeforelit;
4244 // text after the citation
4245 string lafter, lafterlit;
4247 pair<bool, string> laft, lbef;
4249 get_cite_arguments(p, true, lbefore, lafter);
4250 // remove the brackets around after and before
4251 if (!lafter.empty()) {
4253 lafter.erase(lafter.length() - 1, 1);
4254 laft = convert_latexed_command_inset_arg(lafter);
4255 literal |= !laft.first;
4256 lafter = laft.second;
4257 lafterlit = subst(lbefore, "\n", " ");
4259 if (!lbefore.empty()) {
4260 lbefore.erase(0, 1);
4261 lbefore.erase(lbefore.length() - 1, 1);
4262 lbef = convert_latexed_command_inset_arg(lbefore);
4263 literal |= !lbef.first;
4264 lbefore = lbef.second;
4265 lbeforelit = subst(lbefore, "\n", " ");
4267 if (lbefore.empty() && lafter == "[]") {
4272 else if (lbefore == "[]" && lafter == "[]") {
4273 // avoid \cite[][]{a}
4279 lkey = p.getArg('{', '}');
4282 if (!lbefore.empty()) {
4283 pres.insert(make_pair(lkey, lbefore));
4284 preslit.insert(make_pair(lkey, lbeforelit));
4286 if (!lafter.empty()) {
4287 posts.insert(make_pair(lkey, lafter));
4288 postslit.insert(make_pair(lkey, lafterlit));
4290 lkeys.push_back(lkey);
4292 keys = convert_literate_command_inset_arg(getStringFromVector(lkeys));
4297 for (auto const & ptl : pres) {
4298 if (!pretextlist.empty())
4299 pretextlist += '\t';
4300 pretextlist += ptl.first + " " + ptl.second;
4302 for (auto const & potl : posts) {
4303 if (!posttextlist.empty())
4304 posttextlist += '\t';
4305 posttextlist += potl.first + " " + potl.second;
4308 keys = convert_literate_command_inset_arg(p.verbatim_item());
4311 after = subst(after, "\n", " ");
4312 if (!before.empty())
4313 before = subst(after, "\n", " ");
4315 string lit = literal ? "\"true\"" : "\"false\"";
4316 begin_command_inset(os, "citation", command);
4317 os << "after " << '"' << after << '"' << "\n";
4318 os << "before " << '"' << before << '"' << "\n";
4322 if (!pretextlist.empty())
4323 os << "pretextlist " << '"' << pretextlist << '"' << "\n";
4324 if (!posttextlist.empty())
4325 os << "posttextlist " << '"' << posttextlist << '"' << "\n";
4326 os << "literal " << lit << "\n";
4328 // Need to set the cite engine if biblatex is loaded by
4329 // the document class directly
4330 if (preamble.citeEngine() == "basic")
4331 use_biblatex_natbib ?
4332 preamble.citeEngine("biblatex-natbib")
4333 : preamble.citeEngine("biblatex");
4338 is_known(t.cs(), known_jurabib_commands) &&
4339 (t.cs() == "cite" || p.next_token().asInput() != "*")) {
4340 context.check_layout(os);
4341 string command = t.cs();
4342 if (p.next_token().asInput() == "*") {
4346 char argumentOrder = '\0';
4347 vector<string> const options =
4348 preamble.getPackageOptions("jurabib");
4349 if (find(options.begin(), options.end(),
4350 "natbiborder") != options.end())
4351 argumentOrder = 'n';
4352 else if (find(options.begin(), options.end(),
4353 "jurabiborder") != options.end())
4354 argumentOrder = 'j';
4356 // text before the citation
4358 // text after the citation
4360 get_cite_arguments(p, argumentOrder != 'j', before, after);
4362 string const citation = p.verbatim_item();
4363 if (!before.empty() && argumentOrder == '\0') {
4364 cerr << "Warning: Assuming argument order "
4365 "of jurabib version 0.6 for\n'"
4366 << command << before << after << '{'
4367 << citation << "}'.\n"
4368 "Add 'jurabiborder' to the jurabib "
4369 "package options if you used an\n"
4370 "earlier jurabib version." << endl;
4372 bool literal = false;
4373 pair<bool, string> aft;
4374 pair<bool, string> bef;
4375 // remove the brackets around after and before
4376 if (!after.empty()) {
4378 after.erase(after.length() - 1, 1);
4379 aft = convert_latexed_command_inset_arg(after);
4380 literal = !aft.first;
4381 after = literal ? subst(after, "\n", " ") : aft.second;
4383 if (!before.empty()) {
4385 before.erase(before.length() - 1, 1);
4386 bef = convert_latexed_command_inset_arg(before);
4387 literal |= !bef.first;
4388 before = literal ? subst(before, "\n", " ") : bef.second;
4389 if (literal && !after.empty())
4390 after = subst(after, "\n", " ");
4392 string lit = literal ? "\"true\"" : "\"false\"";
4393 begin_command_inset(os, "citation", command);
4394 os << "after " << '"' << after << "\"\n"
4395 << "before " << '"' << before << "\"\n"
4396 << "key " << '"' << citation << "\"\n"
4397 << "literal " << lit << "\n";
4399 // Need to set the cite engine if jurabib is loaded by
4400 // the document class directly
4401 if (preamble.citeEngine() == "basic")
4402 preamble.citeEngine("jurabib");
4406 if (t.cs() == "cite"
4407 || t.cs() == "nocite") {
4408 context.check_layout(os);
4409 string after = p.getArg('[', ']');
4410 pair<bool, string> aft = convert_latexed_command_inset_arg(after);
4411 bool const literal = !aft.first;
4412 after = literal ? subst(after, "\n", " ") : aft.second;
4413 string lit = literal ? "\"true\"" : "\"false\"";
4414 string key = convert_literate_command_inset_arg(p.verbatim_item());
4415 // store the case that it is "\nocite{*}" to use it later for
4418 begin_command_inset(os, "citation", t.cs());
4419 os << "after " << '"' << after << "\"\n"
4420 << "key " << '"' << key << "\"\n"
4421 << "literal " << lit << "\n";
4423 } else if (t.cs() == "nocite")
4428 if (t.cs() == "index" ||
4429 (t.cs() == "sindex" && preamble.use_indices() == "true")) {
4430 context.check_layout(os);
4431 string const arg = (t.cs() == "sindex" && p.hasOpt()) ?
4432 p.getArg('[', ']') : "";
4433 string const kind = arg.empty() ? "idx" : arg;
4434 begin_inset(os, "Index ");
4435 os << kind << "\nstatus collapsed\n";
4436 parse_text_in_inset(p, os, FLAG_ITEM, false, context, "Index");
4439 preamble.registerAutomaticallyLoadedPackage("splitidx");
4443 if (t.cs() == "nomenclature") {
4444 context.check_layout(os);
4445 begin_command_inset(os, "nomenclature", "nomenclature");
4446 string prefix = convert_literate_command_inset_arg(p.getArg('[', ']'));
4447 if (!prefix.empty())
4448 os << "prefix " << '"' << prefix << '"' << "\n";
4449 string symbol = p.verbatim_item();
4450 pair<bool, string> sym = convert_latexed_command_inset_arg(symbol);
4451 bool literal = !sym.first;
4452 string description = p.verbatim_item();
4453 pair<bool, string> desc = convert_latexed_command_inset_arg(description);
4454 literal |= !desc.first;
4456 symbol = subst(symbol, "\n", " ");
4457 description = subst(description, "\n", " ");
4459 symbol = sym.second;
4460 description = desc.second;
4462 string lit = literal ? "\"true\"" : "\"false\"";
4463 os << "symbol " << '"' << symbol;
4464 os << "\"\ndescription \""
4465 << description << "\"\n"
4466 << "literal " << lit << "\n";
4468 preamble.registerAutomaticallyLoadedPackage("nomencl");
4472 if (t.cs() == "label") {
4473 context.check_layout(os);
4474 begin_command_inset(os, "label", "label");
4476 << convert_literate_command_inset_arg(p.verbatim_item())
4482 if (t.cs() == "lyxmintcaption") {
4483 string const pos = p.getArg('[', ']');
4485 string const caption =
4486 parse_text_snippet(p, FLAG_ITEM, false,
4488 minted_nonfloat_caption = "[t]" + caption;
4490 // We already got the caption at the bottom,
4491 // so simply skip it.
4492 parse_text_snippet(p, FLAG_ITEM, false, context);
4494 eat_whitespace(p, os, context, true);
4498 if (t.cs() == "printindex" || t.cs() == "printsubindex") {
4499 context.check_layout(os);
4500 string commandname = t.cs();
4502 if (p.next_token().asInput() == "*") {
4507 begin_command_inset(os, "index_print", commandname);
4508 string const indexname = p.getArg('[', ']');
4510 if (indexname.empty())
4511 os << "type \"idx\"\n";
4513 os << "type \"" << indexname << "\"\n";
4514 os << "literal \"true\"\n";
4517 skip_spaces_braces(p);
4518 preamble.registerAutomaticallyLoadedPackage("makeidx");
4519 if (preamble.use_indices() == "true")
4520 preamble.registerAutomaticallyLoadedPackage("splitidx");
4524 if (t.cs() == "printnomenclature") {
4526 string width_type = "";
4527 context.check_layout(os);
4528 begin_command_inset(os, "nomencl_print", "printnomenclature");
4529 // case of a custom width
4531 width = p.getArg('[', ']');
4532 width = translate_len(width);
4533 width_type = "custom";
4535 // case of no custom width
4536 // the case of no custom width but the width set
4537 // via \settowidth{\nomlabelwidth}{***} cannot be supported
4538 // because the user could have set anything, not only the width
4539 // of the longest label (which would be width_type = "auto")
4540 string label = convert_literate_command_inset_arg(p.getArg('{', '}'));
4541 if (label.empty() && width_type.empty())
4542 width_type = "none";
4543 os << "set_width \"" << width_type << "\"\n";
4544 if (width_type == "custom")
4545 os << "width \"" << width << '\"';
4547 skip_spaces_braces(p);
4548 preamble.registerAutomaticallyLoadedPackage("nomencl");
4552 if ((t.cs() == "textsuperscript" || t.cs() == "textsubscript")) {
4553 context.check_layout(os);
4554 begin_inset(os, "script ");
4555 os << t.cs().substr(4) << '\n';
4556 newinsetlayout = findInsetLayout(context.textclass, t.cs(), true);
4557 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
4559 if (t.cs() == "textsubscript")
4560 preamble.registerAutomaticallyLoadedPackage("subscript");
4564 if ((where = is_known(t.cs(), known_quotes))) {
4565 context.check_layout(os);
4566 begin_inset(os, "Quotes ");
4567 string quotetype = known_coded_quotes[where - known_quotes];
4568 // try to make a smart guess about the side
4569 Token const prev = p.prev_token();
4570 bool const opening = (prev.cat() != catSpace && prev.character() != 0
4571 && prev.character() != '\n' && prev.character() != '~');
4572 quotetype = guessQuoteStyle(quotetype, opening);
4575 // LyX adds {} after the quote, so we have to eat
4576 // spaces here if there are any before a possible
4578 eat_whitespace(p, os, context, false);
4583 if ((where = is_known(t.cs(), known_sizes)) &&
4584 context.new_layout_allowed) {
4585 context.check_layout(os);
4586 TeXFont const oldFont = context.font;
4587 context.font.size = known_coded_sizes[where - known_sizes];
4588 output_font_change(os, oldFont, context.font);
4589 eat_whitespace(p, os, context, false);
4593 if ((where = is_known(t.cs(), known_font_families)) &&
4594 context.new_layout_allowed) {
4595 context.check_layout(os);
4596 TeXFont const oldFont = context.font;
4597 context.font.family =
4598 known_coded_font_families[where - known_font_families];
4599 output_font_change(os, oldFont, context.font);
4600 eat_whitespace(p, os, context, false);
4604 if ((where = is_known(t.cs(), known_font_series)) &&
4605 context.new_layout_allowed) {
4606 context.check_layout(os);
4607 TeXFont const oldFont = context.font;
4608 context.font.series =
4609 known_coded_font_series[where - known_font_series];
4610 output_font_change(os, oldFont, context.font);
4611 eat_whitespace(p, os, context, false);
4615 if ((where = is_known(t.cs(), known_font_shapes)) &&
4616 context.new_layout_allowed) {
4617 context.check_layout(os);
4618 TeXFont const oldFont = context.font;
4619 context.font.shape =
4620 known_coded_font_shapes[where - known_font_shapes];
4621 output_font_change(os, oldFont, context.font);
4622 eat_whitespace(p, os, context, false);
4625 if ((where = is_known(t.cs(), known_old_font_families)) &&
4626 context.new_layout_allowed) {
4627 context.check_layout(os);
4628 TeXFont const oldFont = context.font;
4629 context.font.init();
4630 context.font.size = oldFont.size;
4631 context.font.family =
4632 known_coded_font_families[where - known_old_font_families];
4633 output_font_change(os, oldFont, context.font);
4634 eat_whitespace(p, os, context, false);
4638 if ((where = is_known(t.cs(), known_old_font_series)) &&
4639 context.new_layout_allowed) {
4640 context.check_layout(os);
4641 TeXFont const oldFont = context.font;
4642 context.font.init();
4643 context.font.size = oldFont.size;
4644 context.font.series =
4645 known_coded_font_series[where - known_old_font_series];
4646 output_font_change(os, oldFont, context.font);
4647 eat_whitespace(p, os, context, false);
4651 if ((where = is_known(t.cs(), known_old_font_shapes)) &&
4652 context.new_layout_allowed) {
4653 context.check_layout(os);
4654 TeXFont const oldFont = context.font;
4655 context.font.init();
4656 context.font.size = oldFont.size;
4657 context.font.shape =
4658 known_coded_font_shapes[where - known_old_font_shapes];
4659 output_font_change(os, oldFont, context.font);
4660 eat_whitespace(p, os, context, false);
4664 if (t.cs() == "selectlanguage") {
4665 context.check_layout(os);
4666 // save the language for the case that a
4667 // \foreignlanguage is used
4668 context.font.language = babel2lyx(p.verbatim_item());
4669 os << "\n\\lang " << context.font.language << "\n";
4673 if (t.cs() == "foreignlanguage") {
4674 string const lang = babel2lyx(p.verbatim_item());
4675 parse_text_attributes(p, os, FLAG_ITEM, outer,
4677 context.font.language, lang);
4681 if (prefixIs(t.cs(), "text") && preamble.usePolyglossia()
4682 && is_known(t.cs().substr(4), preamble.polyglossia_languages)) {
4683 // scheme is \textLANGUAGE{text} where LANGUAGE is in polyglossia_languages[]
4685 // We have to output the whole command if it has an option
4686 // because LyX doesn't support this yet, see bug #8214,
4687 // only if there is a single option specifying a variant, we can handle it.
4689 string langopts = p.getOpt();
4690 // check if the option contains a variant, if yes, extract it
4691 string::size_type pos_var = langopts.find("variant");
4692 string::size_type i = langopts.find(',');
4693 string::size_type k = langopts.find('=', pos_var);
4694 if (pos_var != string::npos && i == string::npos) {
4696 variant = langopts.substr(k + 1, langopts.length() - k - 2);
4697 lang = preamble.polyglossia2lyx(variant);
4698 parse_text_attributes(p, os, FLAG_ITEM, outer,
4700 context.font.language, lang);
4702 output_ert_inset(os, t.asInput() + langopts, context);
4704 lang = preamble.polyglossia2lyx(t.cs().substr(4, string::npos));
4705 parse_text_attributes(p, os, FLAG_ITEM, outer,
4707 context.font.language, lang);
4712 if (t.cs() == "inputencoding") {
4713 // nothing to write here
4714 string const enc = subst(p.verbatim_item(), "\n", " ");
4715 p.setEncoding(enc, Encoding::inputenc);
4719 if (is_known(t.cs(), known_special_chars) ||
4720 (t.cs() == "protect" &&
4721 p.next_token().cat() == catEscape &&
4722 is_known(p.next_token().cs(), known_special_protect_chars))) {
4723 // LyX sometimes puts a \protect in front, so we have to ignore it
4725 t.cs() == "protect" ? p.get_token().cs() : t.cs(),
4726 known_special_chars);
4727 context.check_layout(os);
4728 os << known_coded_special_chars[where - known_special_chars];
4729 skip_spaces_braces(p);
4733 if ((t.cs() == "nobreakdash" && p.next_token().asInput() == "-") ||
4734 (t.cs() == "protect" && p.next_token().asInput() == "\\nobreakdash" &&
4735 p.next_next_token().asInput() == "-") ||
4736 (t.cs() == "@" && p.next_token().asInput() == ".")) {
4737 // LyX sometimes puts a \protect in front, so we have to ignore it
4738 if (t.cs() == "protect")
4740 context.check_layout(os);
4741 if (t.cs() == "nobreakdash")
4742 os << "\\SpecialChar nobreakdash\n";
4744 os << "\\SpecialChar endofsentence\n";
4749 if (t.cs() == "_" || t.cs() == "&" || t.cs() == "#"
4750 || t.cs() == "$" || t.cs() == "{" || t.cs() == "}"
4751 || t.cs() == "%" || t.cs() == "-") {
4752 context.check_layout(os);
4754 os << "\\SpecialChar softhyphen\n";
4760 if (t.cs() == "char") {
4761 context.check_layout(os);
4762 if (p.next_token().character() == '`') {
4764 if (p.next_token().cs() == "\"") {
4769 output_ert_inset(os, "\\char`", context);
4772 output_ert_inset(os, "\\char", context);
4777 if (t.cs() == "verb") {
4778 context.check_layout(os);
4779 // set catcodes to verbatim early, just in case.
4780 p.setCatcodes(VERBATIM_CATCODES);
4781 string delim = p.get_token().asInput();
4782 Parser::Arg arg = p.verbatimStuff(delim);
4784 output_ert_inset(os, "\\verb" + delim
4785 + arg.second + delim, context);
4787 cerr << "invalid \\verb command. Skipping" << endl;
4791 // Problem: \= creates a tabstop inside the tabbing environment
4792 // and else an accent. In the latter case we really would want
4793 // \={o} instead of \= o.
4794 if (t.cs() == "=" && (flags & FLAG_TABBING)) {
4795 output_ert_inset(os, t.asInput(), context);
4799 if (t.cs() == "\\") {
4800 context.check_layout(os);
4802 output_ert_inset(os, "\\\\" + p.getOpt(), context);
4803 else if (p.next_token().asInput() == "*") {
4805 // getOpt() eats the following space if there
4806 // is no optional argument, but that is OK
4807 // here since it has no effect in the output.
4808 output_ert_inset(os, "\\\\*" + p.getOpt(), context);
4811 begin_inset(os, "Newline newline");
4817 if (t.cs() == "newline" ||
4818 (t.cs() == "linebreak" && !p.hasOpt())) {
4819 context.check_layout(os);
4820 begin_inset(os, "Newline ");
4823 skip_spaces_braces(p);
4827 if (t.cs() == "input" || t.cs() == "include"
4828 || t.cs() == "verbatiminput"
4829 || t.cs() == "lstinputlisting"
4830 || t.cs() == "inputminted") {
4831 string name = t.cs();
4832 if (name == "verbatiminput"
4833 && p.next_token().asInput() == "*")
4834 name += p.get_token().asInput();
4835 context.check_layout(os);
4837 bool literal = false;
4838 if (name == "lstinputlisting" && p.hasOpt()) {
4839 lstparams = p.getArg('[', ']');
4840 pair<bool, string> oa = convert_latexed_command_inset_arg(lstparams);
4841 literal = !oa.first;
4843 lstparams = subst(lstparams, "\n", " ");
4845 lstparams = oa.second;
4846 } else if (name == "inputminted") {
4847 name = "lstinputlisting";
4848 string const lang = p.getArg('{', '}');
4849 if (lang != "tex") {
4850 string cmd = "\\inputminted{" + lang + "}{";
4851 cmd += p.getArg('{', '}') + "}";
4852 output_ert_inset(os, cmd, context);
4855 if (prefixIs(minted_nonfloat_caption, "[t]")) {
4856 minted_nonfloat_caption.erase(0,3);
4857 // extract label and caption from the already produced LyX code
4858 vector<string> nfc = getVectorFromString(minted_nonfloat_caption, "\n");
4859 string const caption = nfc.front();
4861 vector<string>::iterator it =
4862 find(nfc.begin(), nfc.end(), "LatexCommand label");
4863 if (it != nfc.end()) {
4865 if (it != nfc.end())
4867 label = support::split(label, '"');
4870 minted_nonfloat_caption.clear();
4871 lstparams = "caption=" + caption;
4873 lstparams += ",label=" + label;
4874 pair<bool, string> oa = convert_latexed_command_inset_arg(lstparams);
4875 literal = !oa.first;
4877 lstparams = subst(lstparams, "\n", " ");
4879 lstparams = oa.second;
4882 string lit = literal ? "\"true\"" : "\"false\"";
4883 string filename(normalize_filename(p.getArg('{', '}')));
4884 string const path = getMasterFilePath(true);
4885 // We want to preserve relative / absolute filenames,
4886 // therefore path is only used for testing
4887 if ((t.cs() == "include" || t.cs() == "input") &&
4888 !makeAbsPath(filename, path).exists()) {
4889 // The file extension is probably missing.
4890 // Now try to find it out.
4891 string const tex_name =
4892 find_file(filename, path,
4893 known_tex_extensions);
4894 if (!tex_name.empty())
4895 filename = tex_name;
4897 bool external = false;
4899 if (makeAbsPath(filename, path).exists()) {
4900 string const abstexname =
4901 makeAbsPath(filename, path).absFileName();
4902 string const absfigname =
4903 changeExtension(abstexname, ".fig");
4904 fix_child_filename(filename);
4905 string const lyxname = changeExtension(filename,
4906 roundtripMode() ? ".lyx.lyx" : ".lyx");
4907 string const abslyxname = makeAbsPath(
4908 lyxname, getParentFilePath(false)).absFileName();
4910 if (!skipChildren())
4911 external = FileName(absfigname).exists();
4912 if (t.cs() == "input" && !skipChildren()) {
4913 string const ext = getExtension(abstexname);
4915 // Combined PS/LaTeX:
4916 // x.eps, x.pstex_t (old xfig)
4917 // x.pstex, x.pstex_t (new xfig, e.g. 3.2.5)
4918 FileName const absepsname(
4919 changeExtension(abstexname, ".eps"));
4920 FileName const abspstexname(
4921 changeExtension(abstexname, ".pstex"));
4922 bool const xfigeps =
4923 (absepsname.exists() ||
4924 abspstexname.exists()) &&
4927 // Combined PDF/LaTeX:
4928 // x.pdf, x.pdftex_t (old xfig)
4929 // x.pdf, x.pdf_t (new xfig, e.g. 3.2.5)
4930 FileName const abspdfname(
4931 changeExtension(abstexname, ".pdf"));
4932 bool const xfigpdf =
4933 abspdfname.exists() &&
4934 (ext == "pdftex_t" || ext == "pdf_t");
4938 // Combined PS/PDF/LaTeX:
4939 // x_pspdftex.eps, x_pspdftex.pdf, x.pspdftex
4940 string const absbase2(
4941 removeExtension(abstexname) + "_pspdftex");
4942 FileName const abseps2name(
4943 addExtension(absbase2, ".eps"));
4944 FileName const abspdf2name(
4945 addExtension(absbase2, ".pdf"));
4946 bool const xfigboth =
4947 abspdf2name.exists() &&
4948 abseps2name.exists() && ext == "pspdftex";
4950 xfig = xfigpdf || xfigeps || xfigboth;
4951 external = external && xfig;
4954 outname = changeExtension(filename, ".fig");
4955 FileName abssrc(changeExtension(abstexname, ".fig"));
4956 copy_file(abssrc, outname);
4958 // Don't try to convert, the result
4959 // would be full of ERT.
4961 FileName abssrc(abstexname);
4962 copy_file(abssrc, outname);
4963 } else if (t.cs() != "verbatiminput" &&
4965 tex2lyx(abstexname, FileName(abslyxname),
4968 // no need to call copy_file
4969 // tex2lyx creates the file
4972 FileName abssrc(abstexname);
4973 copy_file(abssrc, outname);
4976 cerr << "Warning: Could not find included file '"
4977 << filename << "'." << endl;
4981 begin_inset(os, "External\n");
4982 os << "\ttemplate XFig\n"
4983 << "\tfilename " << outname << '\n';
4984 registerExternalTemplatePackages("XFig");
4986 begin_command_inset(os, "include", name);
4987 outname = subst(outname, "\"", "\\\"");
4988 os << "preview false\n"
4989 "filename \"" << outname << "\"\n";
4990 if (!lstparams.empty())
4991 os << "lstparams \"" << lstparams << "\"\n";
4992 os << "literal " << lit << "\n";
4993 if (t.cs() == "verbatiminput")
4994 preamble.registerAutomaticallyLoadedPackage("verbatim");
5000 if (t.cs() == "bibliographystyle") {
5001 // store new bibliographystyle
5002 bibliographystyle = p.verbatim_item();
5003 // If any other command than \bibliography, \addcontentsline
5004 // and \nocite{*} follows, we need to output the style
5005 // (because it might be used by that command).
5006 // Otherwise, it will automatically be output by LyX.
5009 for (Token t2 = p.get_token(); p.good(); t2 = p.get_token()) {
5010 if (t2.cat() == catBegin)
5012 if (t2.cat() != catEscape)
5014 if (t2.cs() == "nocite") {
5015 if (p.getArg('{', '}') == "*")
5017 } else if (t2.cs() == "bibliography")
5019 else if (t2.cs() == "phantomsection") {
5023 else if (t2.cs() == "addcontentsline") {
5024 // get the 3 arguments of \addcontentsline
5027 contentslineContent = p.getArg('{', '}');
5028 // if the last argument is not \refname we must output
5029 if (contentslineContent == "\\refname")
5036 output_ert_inset(os,
5037 "\\bibliographystyle{" + bibliographystyle + '}',
5043 if (t.cs() == "phantomsection") {
5044 // we only support this if it occurs between
5045 // \bibliographystyle and \bibliography
5046 if (bibliographystyle.empty())
5047 output_ert_inset(os, "\\phantomsection", context);
5051 if (t.cs() == "addcontentsline") {
5052 context.check_layout(os);
5053 // get the 3 arguments of \addcontentsline
5054 string const one = p.getArg('{', '}');
5055 string const two = p.getArg('{', '}');
5056 string const three = p.getArg('{', '}');
5057 // only if it is a \refname, we support if for the bibtex inset
5058 if (contentslineContent != "\\refname") {
5059 output_ert_inset(os,
5060 "\\addcontentsline{" + one + "}{" + two + "}{"+ three + '}',
5066 else if (t.cs() == "bibliography") {
5067 context.check_layout(os);
5069 begin_command_inset(os, "bibtex", "bibtex");
5070 if (!btprint.empty()) {
5071 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
5072 // clear the string because the next BibTeX inset can be without the
5073 // \nocite{*} option
5076 os << "bibfiles " << '"' << normalize_filename(p.verbatim_item()) << '"' << "\n";
5077 // Do we have addcontentsline?
5078 if (contentslineContent == "\\refname") {
5079 BibOpts = "bibtotoc";
5080 // clear string because next BibTeX inset can be without addcontentsline
5081 contentslineContent.clear();
5083 // Do we have a bibliographystyle set?
5084 if (!bibliographystyle.empty()) {
5085 if (BibOpts.empty())
5086 BibOpts = normalize_filename(bibliographystyle);
5088 BibOpts = BibOpts + ',' + normalize_filename(bibliographystyle);
5089 // clear it because each bibtex entry has its style
5090 // and we need an empty string to handle \phantomsection
5091 bibliographystyle.clear();
5093 os << "options " << '"' << BibOpts << '"' << "\n";
5094 if (p.getEncoding() != preamble.docencoding) {
5095 Encoding const * const enc = encodings.fromIconvName(
5096 p.getEncoding(), Encoding::inputenc, true);
5098 cerr << "Unknown bib encoding " << p.getEncoding()
5099 << ". Ignoring." << std::endl;
5101 os << "encoding " << '"' << enc->name() << '"' << "\n";
5107 if (t.cs() == "printbibliography") {
5108 context.check_layout(os);
5110 string bbloptions = p.hasOpt() ? p.getArg('[', ']') : string();
5111 vector<string> opts = getVectorFromString(bbloptions);
5112 vector<string>::iterator it =
5113 find(opts.begin(), opts.end(), "heading=bibintoc");
5114 if (it != opts.end()) {
5116 BibOpts = "bibtotoc";
5118 bbloptions = getStringFromVector(opts);
5119 begin_command_inset(os, "bibtex", "bibtex");
5120 if (!btprint.empty()) {
5121 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
5122 // clear the string because the next BibTeX inset can be without the
5123 // \nocite{*} option
5127 for (auto const & bf : preamble.biblatex_bibliographies) {
5128 if (!bibfiles.empty())
5130 bibfiles += normalize_filename(bf);
5132 if (!bibfiles.empty())
5133 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
5134 // Do we have addcontentsline?
5135 if (contentslineContent == "\\refname") {
5136 BibOpts = "bibtotoc";
5137 // clear string because next BibTeX inset can be without addcontentsline
5138 contentslineContent.clear();
5140 os << "options " << '"' << BibOpts << '"' << "\n";
5141 if (!bbloptions.empty())
5142 os << "biblatexopts " << '"' << bbloptions << '"' << "\n";
5143 if (!preamble.bibencoding.empty()) {
5144 Encoding const * const enc = encodings.fromLaTeXName(
5145 preamble.bibencoding, Encoding::inputenc, true);
5147 cerr << "Unknown bib encoding " << preamble.bibencoding
5148 << ". Ignoring." << std::endl;
5150 os << "encoding " << '"' << enc->name() << '"' << "\n";
5153 need_commentbib = false;
5157 if (t.cs() == "bibbysection") {
5158 context.check_layout(os);
5160 string bbloptions = p.hasOpt() ? p.getArg('[', ']') : string();
5161 vector<string> opts = getVectorFromString(bbloptions);
5162 vector<string>::iterator it =
5163 find(opts.begin(), opts.end(), "heading=bibintoc");
5164 if (it != opts.end()) {
5166 BibOpts = "bibtotoc";
5168 bbloptions = getStringFromVector(opts);
5169 begin_command_inset(os, "bibtex", "bibtex");
5170 os << "btprint " << '"' << "bibbysection" << '"' << "\n";
5172 for (auto const & bf : preamble.biblatex_bibliographies) {
5173 if (!bibfiles.empty())
5175 bibfiles += normalize_filename(bf);
5177 if (!bibfiles.empty())
5178 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
5179 os << "options " << '"' << BibOpts << '"' << "\n";
5180 if (!bbloptions.empty())
5181 os << "biblatexopts " << '"' << bbloptions << '"' << "\n";
5183 need_commentbib = false;
5187 if (t.cs() == "parbox") {
5188 // Test whether this is an outer box of a shaded box
5190 // swallow arguments
5191 while (p.hasOpt()) {
5193 p.skip_spaces(true);
5196 p.skip_spaces(true);
5198 if (p.next_token().cat() == catBegin)
5200 p.skip_spaces(true);
5201 Token to = p.get_token();
5202 bool shaded = false;
5203 if (to.asInput() == "\\begin") {
5204 p.skip_spaces(true);
5205 if (p.getArg('{', '}') == "shaded")
5210 parse_outer_box(p, os, FLAG_ITEM, outer,
5211 context, "parbox", "shaded");
5213 parse_box(p, os, 0, FLAG_ITEM, outer, context,
5214 "", "", t.cs(), "", "");
5218 if (t.cs() == "fbox" || t.cs() == "mbox" ||
5219 t.cs() == "ovalbox" || t.cs() == "Ovalbox" ||
5220 t.cs() == "shadowbox" || t.cs() == "doublebox") {
5221 parse_outer_box(p, os, FLAG_ITEM, outer, context, t.cs(), "");
5225 if (t.cs() == "fcolorbox" || t.cs() == "colorbox") {
5226 string backgroundcolor;
5227 preamble.registerAutomaticallyLoadedPackage("xcolor");
5228 if (t.cs() == "fcolorbox") {
5229 string const framecolor = p.getArg('{', '}');
5230 backgroundcolor = p.getArg('{', '}');
5231 parse_box(p, os, 0, 0, outer, context, "", "", "", framecolor, backgroundcolor);
5233 backgroundcolor = p.getArg('{', '}');
5234 parse_box(p, os, 0, 0, outer, context, "", "", "", "", backgroundcolor);
5239 // FIXME: due to the compiler limit of "if" nestings
5240 // the code for the alignment was put here
5241 // put them in their own if if this is fixed
5242 if (t.cs() == "fboxrule" || t.cs() == "fboxsep"
5243 || t.cs() == "shadowsize"
5244 || t.cs() == "raggedleft" || t.cs() == "centering"
5245 || t.cs() == "raggedright") {
5246 if (t.cs() == "fboxrule")
5248 if (t.cs() == "fboxsep")
5250 if (t.cs() == "shadowsize")
5252 if (t.cs() != "raggedleft" && t.cs() != "centering"
5253 && t.cs() != "raggedright") {
5254 p.skip_spaces(true);
5255 while (p.good() && p.next_token().cat() != catSpace
5256 && p.next_token().cat() != catNewline
5257 && p.next_token().cat() != catEscape) {
5258 if (t.cs() == "fboxrule")
5259 fboxrule = fboxrule + p.get_token().asInput();
5260 if (t.cs() == "fboxsep")
5261 fboxsep = fboxsep + p.get_token().asInput();
5262 if (t.cs() == "shadowsize")
5263 shadow_size = shadow_size + p.get_token().asInput();
5266 output_ert_inset(os, t.asInput(), context);
5271 //\framebox() is part of the picture environment and different from \framebox{}
5272 //\framebox{} will be parsed by parse_outer_box
5273 if (t.cs() == "framebox") {
5274 if (p.next_token().character() == '(') {
5275 //the syntax is: \framebox(x,y)[position]{content}
5276 string arg = t.asInput();
5277 arg += p.getFullParentheseArg();
5278 arg += p.getFullOpt();
5279 eat_whitespace(p, os, context, false);
5280 output_ert_inset(os, arg + '{', context);
5281 parse_text(p, os, FLAG_ITEM, outer, context);
5282 output_ert_inset(os, "}", context);
5284 //the syntax is: \framebox[width][position]{content}
5285 string special = p.getFullOpt();
5286 special += p.getOpt();
5287 parse_outer_box(p, os, FLAG_ITEM, outer,
5288 context, t.cs(), special);
5293 //\makebox() is part of the picture environment and different from \makebox{}
5294 //\makebox{} will be parsed by parse_box
5295 if (t.cs() == "makebox") {
5296 if (p.next_token().character() == '(') {
5297 //the syntax is: \makebox(x,y)[position]{content}
5298 string arg = t.asInput();
5299 arg += p.getFullParentheseArg();
5300 arg += p.getFullOpt();
5301 eat_whitespace(p, os, context, false);
5302 output_ert_inset(os, arg + '{', context);
5303 parse_text(p, os, FLAG_ITEM, outer, context);
5304 output_ert_inset(os, "}", context);
5306 //the syntax is: \makebox[width][position]{content}
5307 parse_box(p, os, 0, FLAG_ITEM, outer, context,
5308 "", "", t.cs(), "", "");
5312 if (t.cs() == "smallskip" ||
5313 t.cs() == "medskip" ||
5314 t.cs() == "bigskip" ||
5315 t.cs() == "vfill") {
5316 context.check_layout(os);
5317 begin_inset(os, "VSpace ");
5320 skip_spaces_braces(p);
5324 if ((where = is_known(t.cs(), known_spaces))) {
5325 context.check_layout(os);
5326 begin_inset(os, "space ");
5327 os << '\\' << known_coded_spaces[where - known_spaces]
5330 // LaTeX swallows whitespace after all spaces except
5331 // "\\,". We have to do that here, too, because LyX
5332 // adds "{}" which would make the spaces significant.
5334 eat_whitespace(p, os, context, false);
5335 // LyX adds "{}" after all spaces except "\\ " and
5336 // "\\,", so we have to remove "{}".
5337 // "\\,{}" is equivalent to "\\," in LaTeX, so we
5338 // remove the braces after "\\,", too.
5344 if (t.cs() == "newpage" ||
5345 (t.cs() == "pagebreak" && !p.hasOpt()) ||
5346 t.cs() == "clearpage" ||
5347 t.cs() == "cleardoublepage") {
5348 context.check_layout(os);
5349 begin_inset(os, "Newpage ");
5352 skip_spaces_braces(p);
5356 if (t.cs() == "DeclareRobustCommand" ||
5357 t.cs() == "DeclareRobustCommandx" ||
5358 t.cs() == "newcommand" ||
5359 t.cs() == "newcommandx" ||
5360 t.cs() == "providecommand" ||
5361 t.cs() == "providecommandx" ||
5362 t.cs() == "renewcommand" ||
5363 t.cs() == "renewcommandx") {
5364 // DeclareRobustCommand, DeclareRobustCommandx,
5365 // providecommand and providecommandx could be handled
5366 // by parse_command(), but we need to call
5367 // add_known_command() here.
5368 string name = t.asInput();
5369 if (p.next_token().asInput() == "*") {
5370 // Starred form. Eat '*'
5374 string const command = p.verbatim_item();
5375 string const opt1 = p.getFullOpt();
5376 string const opt2 = p.getFullOpt();
5377 add_known_command(command, opt1, !opt2.empty());
5378 string const ert = name + '{' + command + '}' +
5380 '{' + p.verbatim_item() + '}';
5382 if (t.cs() == "DeclareRobustCommand" ||
5383 t.cs() == "DeclareRobustCommandx" ||
5384 t.cs() == "providecommand" ||
5385 t.cs() == "providecommandx" ||
5386 name[name.length()-1] == '*')
5387 output_ert_inset(os, ert, context);
5389 context.check_layout(os);
5390 begin_inset(os, "FormulaMacro");
5397 if (t.cs() == "let" && p.next_token().asInput() != "*") {
5398 // let could be handled by parse_command(),
5399 // but we need to call add_known_command() here.
5400 string ert = t.asInput();
5403 if (p.next_token().cat() == catBegin) {
5404 name = p.verbatim_item();
5405 ert += '{' + name + '}';
5407 name = p.verbatim_item();
5412 if (p.next_token().cat() == catBegin) {
5413 command = p.verbatim_item();
5414 ert += '{' + command + '}';
5416 command = p.verbatim_item();
5419 // If command is known, make name known too, to parse
5420 // its arguments correctly. For this reason we also
5421 // have commands in syntax.default that are hardcoded.
5422 CommandMap::iterator it = known_commands.find(command);
5423 if (it != known_commands.end())
5424 known_commands[t.asInput()] = it->second;
5425 output_ert_inset(os, ert, context);
5429 if (t.cs() == "hspace" || t.cs() == "vspace") {
5432 string name = t.asInput();
5433 string const length = p.verbatim_item();
5436 bool valid = splitLatexLength(length, valstring, unit);
5437 bool known_hspace = false;
5438 bool known_vspace = false;
5439 bool known_unit = false;
5442 istringstream iss(valstring);
5445 if (t.cs()[0] == 'h') {
5446 if (unit == "\\fill") {
5451 known_hspace = true;
5454 if (unit == "\\smallskipamount") {
5456 known_vspace = true;
5457 } else if (unit == "\\medskipamount") {
5459 known_vspace = true;
5460 } else if (unit == "\\bigskipamount") {
5462 known_vspace = true;
5463 } else if (unit == "\\fill") {
5465 known_vspace = true;
5469 if (!known_hspace && !known_vspace) {
5470 switch (unitFromString(unit)) {
5486 //unitFromString(unit) fails for relative units like Length::PCW
5487 // therefore handle them separately
5488 if (unit == "\\paperwidth" || unit == "\\columnwidth"
5489 || unit == "\\textwidth" || unit == "\\linewidth"
5490 || unit == "\\textheight" || unit == "\\paperheight"
5491 || unit == "\\baselineskip")
5499 // check for glue lengths
5500 bool is_gluelength = false;
5501 string gluelength = length;
5502 string::size_type i = length.find(" minus");
5503 if (i == string::npos) {
5504 i = length.find(" plus");
5505 if (i != string::npos)
5506 is_gluelength = true;
5508 is_gluelength = true;
5509 // if yes transform "9xx minus 8yy plus 7zz"
5511 if (is_gluelength) {
5512 i = gluelength.find(" minus");
5513 if (i != string::npos)
5514 gluelength.replace(i, 7, "-");
5515 i = gluelength.find(" plus");
5516 if (i != string::npos)
5517 gluelength.replace(i, 6, "+");
5520 if (t.cs()[0] == 'h' && (known_unit || known_hspace || is_gluelength)) {
5521 // Literal horizontal length or known variable
5522 context.check_layout(os);
5523 begin_inset(os, "space ");
5531 if (known_unit && !known_hspace)
5532 os << "\n\\length " << translate_len(length);
5534 os << "\n\\length " << gluelength;
5536 } else if (known_unit || known_vspace || is_gluelength) {
5537 // Literal vertical length or known variable
5538 context.check_layout(os);
5539 begin_inset(os, "VSpace ");
5542 if (known_unit && !known_vspace)
5543 os << translate_len(length);
5550 // LyX can't handle other length variables in Inset VSpace/space
5555 output_ert_inset(os, name + '{' + unit + '}', context);
5556 else if (value == -1.0)
5557 output_ert_inset(os, name + "{-" + unit + '}', context);
5559 output_ert_inset(os, name + '{' + valstring + unit + '}', context);
5561 output_ert_inset(os, name + '{' + length + '}', context);
5566 // Before we look for the layout name alone below, we check the layouts including the LateXParam, which
5567 // might be one or several options or a star.
5568 // The single '=' is meant here.
5569 if ((newinsetlayout = findInsetLayout(context.textclass, starredname, true, p.getCommandLatexParam()))) {
5573 context.check_layout(os);
5574 // store the latexparam here. This is eaten in parse_text_in_inset
5575 context.latexparam = newinsetlayout->latexparam();
5576 docstring name = newinsetlayout->name();
5577 bool const caption = name.find(from_ascii("Caption:")) == 0;
5579 // Already done for floating minted listings.
5580 if (minted_float.empty()) {
5581 begin_inset(os, "Caption ");
5582 os << to_utf8(name.substr(8)) << '\n';
5585 // FIXME: what do we do if the prefix is not Flex: ?
5586 if (prefixIs(name, from_ascii("Flex:")))
5588 begin_inset(os, "Flex ");
5589 os << to_utf8(name) << '\n'
5590 << "status collapsed\n";
5592 if (!minted_float.empty()) {
5593 parse_text_snippet(p, os, FLAG_ITEM, false, context);
5594 } else if (newinsetlayout->isPassThru()) {
5595 // set catcodes to verbatim early, just in case.
5596 p.setCatcodes(VERBATIM_CATCODES);
5597 string delim = p.get_token().asInput();
5599 cerr << "Warning: bad delimiter for command " << t.asInput() << endl;
5600 //FIXME: handle error condition
5601 string const arg = p.verbatimStuff("}").second;
5602 Context newcontext(true, context.textclass);
5603 if (newinsetlayout->forcePlainLayout())
5604 newcontext.layout = &context.textclass.plainLayout();
5605 output_ert(os, arg, newcontext);
5607 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
5608 context.latexparam.clear();
5611 // Minted caption insets are not closed here because
5612 // we collect everything into the caption.
5613 if (minted_float.empty())
5618 // The single '=' is meant here.
5619 if ((newinsetlayout = findInsetLayout(context.textclass, starredname, true))) {
5623 context.check_layout(os);
5624 docstring name = newinsetlayout->name();
5625 bool const caption = name.find(from_ascii("Caption:")) == 0;
5627 // Already done for floating minted listings.
5628 if (minted_float.empty()) {
5629 begin_inset(os, "Caption ");
5630 os << to_utf8(name.substr(8)) << '\n';
5633 // FIXME: what do we do if the prefix is not Flex: ?
5634 if (prefixIs(name, from_ascii("Flex:")))
5636 begin_inset(os, "Flex ");
5637 os << to_utf8(name) << '\n'
5638 << "status collapsed\n";
5640 if (!minted_float.empty()) {
5641 parse_text_snippet(p, os, FLAG_ITEM, false, context);
5642 } else if (newinsetlayout->isPassThru()) {
5643 // set catcodes to verbatim early, just in case.
5644 p.setCatcodes(VERBATIM_CATCODES);
5645 string delim = p.get_token().asInput();
5647 cerr << "Warning: bad delimiter for command " << t.asInput() << endl;
5648 //FIXME: handle error condition
5649 string const arg = p.verbatimStuff("}").second;
5650 Context newcontext(true, context.textclass);
5651 if (newinsetlayout->forcePlainLayout())
5652 newcontext.layout = &context.textclass.plainLayout();
5653 output_ert(os, arg, newcontext);
5655 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
5658 // Minted caption insets are not closed here because
5659 // we collect everything into the caption.
5660 if (minted_float.empty())
5665 if (t.cs() == "includepdf") {
5667 string const arg = p.getArg('[', ']');
5668 map<string, string> opts;
5669 vector<string> keys;
5670 split_map(arg, opts, keys);
5671 string name = normalize_filename(p.verbatim_item());
5672 string const path = getMasterFilePath(true);
5673 // We want to preserve relative / absolute filenames,
5674 // therefore path is only used for testing
5675 if (!makeAbsPath(name, path).exists()) {
5676 // The file extension is probably missing.
5677 // Now try to find it out.
5678 char const * const pdfpages_format[] = {"pdf", 0};
5679 string const pdftex_name =
5680 find_file(name, path, pdfpages_format);
5681 if (!pdftex_name.empty()) {
5686 FileName const absname = makeAbsPath(name, path);
5687 if (absname.exists())
5689 fix_child_filename(name);
5690 copy_file(absname, name);
5692 cerr << "Warning: Could not find file '"
5693 << name << "'." << endl;
5695 context.check_layout(os);
5696 begin_inset(os, "External\n\ttemplate ");
5697 os << "PDFPages\n\tfilename "
5699 // parse the options
5700 if (opts.find("pages") != opts.end())
5701 os << "\textra LaTeX \"pages="
5702 << opts["pages"] << "\"\n";
5703 if (opts.find("angle") != opts.end())
5704 os << "\trotateAngle "
5705 << opts["angle"] << '\n';
5706 if (opts.find("origin") != opts.end()) {
5708 string const opt = opts["origin"];
5709 if (opt == "tl") ss << "topleft";
5710 if (opt == "bl") ss << "bottomleft";
5711 if (opt == "Bl") ss << "baselineleft";
5712 if (opt == "c") ss << "center";
5713 if (opt == "tc") ss << "topcenter";
5714 if (opt == "bc") ss << "bottomcenter";
5715 if (opt == "Bc") ss << "baselinecenter";
5716 if (opt == "tr") ss << "topright";
5717 if (opt == "br") ss << "bottomright";
5718 if (opt == "Br") ss << "baselineright";
5719 if (!ss.str().empty())
5720 os << "\trotateOrigin " << ss.str() << '\n';
5722 cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
5724 if (opts.find("width") != opts.end())
5726 << translate_len(opts["width"]) << '\n';
5727 if (opts.find("height") != opts.end())
5729 << translate_len(opts["height"]) << '\n';
5730 if (opts.find("keepaspectratio") != opts.end())
5731 os << "\tkeepAspectRatio\n";
5733 context.check_layout(os);
5734 registerExternalTemplatePackages("PDFPages");
5738 if (t.cs() == "loadgame") {
5740 string name = normalize_filename(p.verbatim_item());
5741 string const path = getMasterFilePath(true);
5742 // We want to preserve relative / absolute filenames,
5743 // therefore path is only used for testing
5744 if (!makeAbsPath(name, path).exists()) {
5745 // The file extension is probably missing.
5746 // Now try to find it out.
5747 char const * const lyxskak_format[] = {"fen", 0};
5748 string const lyxskak_name =
5749 find_file(name, path, lyxskak_format);
5750 if (!lyxskak_name.empty())
5751 name = lyxskak_name;
5753 FileName const absname = makeAbsPath(name, path);
5754 if (absname.exists())
5756 fix_child_filename(name);
5757 copy_file(absname, name);
5759 cerr << "Warning: Could not find file '"
5760 << name << "'." << endl;
5761 context.check_layout(os);
5762 begin_inset(os, "External\n\ttemplate ");
5763 os << "ChessDiagram\n\tfilename "
5766 context.check_layout(os);
5767 // after a \loadgame follows a \showboard
5768 if (p.get_token().asInput() == "showboard")
5770 registerExternalTemplatePackages("ChessDiagram");
5774 // try to see whether the string is in unicodesymbols
5775 // Only use text mode commands, since we are in text mode here,
5776 // and math commands may be invalid (bug 6797)
5777 string name = t.asInput();
5778 // handle the dingbats, cyrillic and greek
5779 if (name == "\\textcyr")
5780 name = "\\textcyrillic";
5781 if (name == "\\ding" || name == "\\textcyrillic" ||
5782 (name == "\\textgreek" && !preamble.usePolyglossia()))
5783 name = name + '{' + p.getArg('{', '}') + '}';
5784 // handle the ifsym characters
5785 else if (name == "\\textifsymbol") {
5786 string const optif = p.getFullOpt();
5787 string const argif = p.getArg('{', '}');
5788 name = name + optif + '{' + argif + '}';
5790 // handle the \ascii characters
5791 // the case of \ascii within braces, as LyX outputs it, is already
5792 // handled for t.cat() == catBegin
5793 else if (name == "\\ascii") {
5794 // the code is "\asci\xxx"
5795 name = "{" + name + p.get_token().asInput() + "}";
5798 // handle some TIPA special characters
5799 else if (preamble.isPackageUsed("tipa")) {
5800 if (name == "\\s") {
5801 // fromLaTeXCommand() does not yet
5802 // recognize tipa short cuts
5803 name = "\\textsyllabic";
5804 } else if (name == "\\=" &&
5805 p.next_token().asInput() == "*") {
5806 // fromLaTeXCommand() does not yet
5807 // recognize tipa short cuts
5809 name = "\\textsubbar";
5810 } else if (name == "\\textdoublevertline") {
5811 // FIXME: This is not correct,
5812 // \textvertline is higher than \textbardbl
5813 name = "\\textbardbl";
5815 } else if (name == "\\!" ) {
5816 if (p.next_token().asInput() == "b") {
5817 p.get_token(); // eat 'b'
5820 } else if (p.next_token().asInput() == "d") {
5824 } else if (p.next_token().asInput() == "g") {
5828 } else if (p.next_token().asInput() == "G") {
5830 name = "\\texthtscg";
5832 } else if (p.next_token().asInput() == "j") {
5834 name = "\\texthtbardotlessj";
5836 } else if (p.next_token().asInput() == "o") {
5838 name = "\\textbullseye";
5841 } else if (name == "\\*" ) {
5842 if (p.next_token().asInput() == "k") {
5844 name = "\\textturnk";
5846 } else if (p.next_token().asInput() == "r") {
5847 p.get_token(); // eat 'b'
5848 name = "\\textturnr";
5850 } else if (p.next_token().asInput() == "t") {
5852 name = "\\textturnt";
5854 } else if (p.next_token().asInput() == "w") {
5856 name = "\\textturnw";
5861 if ((name.size() == 2 &&
5862 contains("\"'.=^`bcdHkrtuv~", name[1]) &&
5863 p.next_token().asInput() != "*") ||
5864 is_known(name.substr(1), known_tipa_marks)) {
5865 // name is a command that corresponds to a
5866 // combining character in unicodesymbols.
5867 // Append the argument, fromLaTeXCommand()
5868 // will either convert it to a single
5869 // character or a combining sequence.
5870 name += '{' + p.verbatim_item() + '}';
5872 // now get the character from unicodesymbols
5876 docstring s = normalize_c(encodings.fromLaTeXCommand(from_utf8(name),
5877 Encodings::TEXT_CMD, termination, rem, &req));
5879 context.check_layout(os);
5882 output_ert_inset(os, to_utf8(rem), context);
5884 skip_spaces_braces(p);
5885 for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
5886 preamble.registerAutomaticallyLoadedPackage(*it);
5888 //cerr << "#: " << t << " mode: " << mode << endl;
5889 // heuristic: read up to next non-nested space
5891 string s = t.asInput();
5892 string z = p.verbatim_item();
5893 while (p.good() && z != " " && !z.empty()) {
5894 //cerr << "read: " << z << endl;
5896 z = p.verbatim_item();
5898 cerr << "found ERT: " << s << endl;
5899 output_ert_inset(os, s + ' ', context);
5902 if (t.asInput() == name &&
5903 p.next_token().asInput() == "*") {
5904 // Starred commands like \vspace*{}
5905 p.get_token(); // Eat '*'
5908 if (!parse_command(name, p, os, outer, context))
5909 output_ert_inset(os, name, context);
5915 string guessLanguage(Parser & p, string const & lang)
5917 typedef std::map<std::string, size_t> LangMap;
5918 // map from language names to number of characters
5921 for (char const * const * i = supported_CJK_languages; *i; i++)
5922 used[string(*i)] = 0;
5925 Token const t = p.get_token();
5926 // comments are not counted for any language
5927 if (t.cat() == catComment)
5929 // commands are not counted as well, but we need to detect
5930 // \begin{CJK} and switch encoding if needed
5931 if (t.cat() == catEscape) {
5932 if (t.cs() == "inputencoding") {
5933 string const enc = subst(p.verbatim_item(), "\n", " ");
5934 p.setEncoding(enc, Encoding::inputenc);
5937 if (t.cs() != "begin")
5940 // Non-CJK content is counted for lang.
5941 // We do not care about the real language here:
5942 // If we have more non-CJK contents than CJK contents,
5943 // we simply use the language that was specified as
5944 // babel main language.
5945 used[lang] += t.asInput().length();
5948 // Now we are starting an environment
5950 string const name = p.getArg('{', '}');
5951 if (name != "CJK") {
5955 // It is a CJK environment
5957 /* name = */ p.getArg('{', '}');
5958 string const encoding = p.getArg('{', '}');
5959 /* mapping = */ p.getArg('{', '}');
5960 string const encoding_old = p.getEncoding();
5961 char const * const * const where =
5962 is_known(encoding, supported_CJK_encodings);
5964 p.setEncoding(encoding, Encoding::CJK);
5966 p.setEncoding("UTF-8");
5967 string const text = p.ertEnvironment("CJK");
5968 p.setEncoding(encoding_old);
5971 // ignore contents in unknown CJK encoding
5974 // the language of the text
5976 supported_CJK_languages[where - supported_CJK_encodings];
5977 used[cjk] += text.length();
5979 LangMap::const_iterator use = used.begin();
5980 for (LangMap::const_iterator it = used.begin(); it != used.end(); ++it) {
5981 if (it->second > use->second)
5988 void check_comment_bib(ostream & os, Context & context)
5990 if (!need_commentbib)
5992 // We have a bibliography database, but no bibliography with biblatex
5993 // which is completely valid. Insert a bibtex inset in a note.
5994 context.check_layout(os);
5995 begin_inset(os, "Note Note\n");
5996 os << "status open\n";
5997 os << "\\begin_layout Plain Layout\n";
5998 begin_command_inset(os, "bibtex", "bibtex");
6000 for (auto const & bf : preamble.biblatex_bibliographies) {
6001 if (!bibfiles.empty())
6003 bibfiles += normalize_filename(bf);
6005 if (!bibfiles.empty())
6006 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
6007 end_inset(os);// Bibtex
6008 os << "\\end_layout\n";
6009 end_inset(os);// Note