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
9 * Full author contact details are available in file CREDITS.
18 #include "FloatList.h"
19 #include "lengthcommon.h"
20 #include "support/lstrings.h"
21 #include "support/convert.h"
22 #include "support/filetools.h"
24 #include <boost/filesystem/operations.hpp>
25 #include <boost/tuple/tuple.hpp>
32 using lyx::support::ChangeExtension;
33 using lyx::support::MakeAbsPath;
34 using lyx::support::MakeRelPath;
35 using lyx::support::rtrim;
36 using lyx::support::suffixIs;
37 using lyx::support::contains;
38 using lyx::support::subst;
45 using std::ostringstream;
46 using std::istringstream;
50 namespace fs = boost::filesystem;
53 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
54 Context const & context)
56 Context newcontext(true, context.textclass);
57 newcontext.font = context.font;
58 parse_text(p, os, flags, outer, newcontext);
59 newcontext.check_end_layout(os);
65 /// parses a paragraph snippet, useful for example for \\emph{...}
66 void parse_text_snippet(Parser & p, ostream & os, unsigned flags, bool outer,
69 Context newcontext(context);
70 // Don't inherit the extra stuff
71 newcontext.extra_stuff.clear();
72 parse_text(p, os, flags, outer, newcontext);
73 // Make sure that we don't create invalid .lyx files
74 context.need_layout = newcontext.need_layout;
75 context.need_end_layout = newcontext.need_end_layout;
80 * Thin wrapper around parse_text_snippet() using a string.
82 * We completely ignore \c context.need_layout and \c context.need_end_layout,
83 * because our return value is not used directly (otherwise the stream version
84 * of parse_text_snippet() could be used). That means that the caller needs
85 * to do layout management manually.
86 * This is intended to parse text that does not create any layout changes.
88 string parse_text_snippet(Parser & p, unsigned flags, const bool outer,
91 Context newcontext(context);
92 newcontext.need_layout = false;
93 newcontext.need_end_layout = false;
94 newcontext.new_layout_allowed = false;
95 // Avoid warning by Context::~Context()
96 newcontext.extra_stuff.clear();
98 parse_text_snippet(p, os, flags, outer, newcontext);
103 char const * const known_latex_commands[] = { "ref", "cite", "label", "index",
104 "printindex", "pageref", "url", "vref", "vpageref", "prettyref", "eqref", 0 };
108 * We can't put these into known_latex_commands because the argument order
109 * is reversed in lyx if there are 2 arguments.
110 * The starred forms are also known.
112 char const * const known_natbib_commands[] = { "cite", "citet", "citep",
113 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
114 "citefullauthor", "Citet", "Citep", "Citealt", "Citealp", "Citeauthor", 0 };
118 * We can't put these into known_latex_commands because the argument order
119 * is reversed in lyx if there are 2 arguments.
120 * No starred form other than "cite*" known.
122 char const * const known_jurabib_commands[] = { "cite", "citet", "citep",
123 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar", "fullcite",
124 // jurabib commands not (yet) supported by LyX:
125 // "footcite", "footcitet", "footcitep", "footcitealt", "footcitealp",
126 // "footciteauthor", "footciteyear", "footciteyearpar",
127 "citefield", "citetitle", "cite*", 0 };
129 /// LaTeX names for quotes
130 char const * const known_quotes[] = { "glqq", "grqq", "quotedblbase",
131 "textquotedblleft", "quotesinglbase", "guilsinglleft", "guilsinglright", 0};
133 /// the same as known_quotes with .lyx names
134 char const * const known_coded_quotes[] = { "gld", "grd", "gld",
135 "grd", "gls", "fls", "frd", 0};
137 /// LaTeX names for font sizes
138 char const * const known_sizes[] = { "tiny", "scriptsize", "footnotesize",
139 "small", "normalsize", "large", "Large", "LARGE", "huge", "Huge", 0};
141 /// the same as known_sizes with .lyx names
142 char const * const known_coded_sizes[] = { "tiny", "scriptsize", "footnotesize",
143 "small", "normal", "large", "larger", "largest", "huge", "giant", 0};
145 /// LaTeX 2.09 names for font families
146 char const * const known_old_font_families[] = { "rm", "sf", "tt", 0};
148 /// LaTeX names for font families
149 char const * const known_font_families[] = { "rmfamily", "sffamily",
152 /// the same as known_old_font_families and known_font_families with .lyx names
153 char const * const known_coded_font_families[] = { "roman", "sans",
156 /// LaTeX 2.09 names for font series
157 char const * const known_old_font_series[] = { "bf", 0};
159 /// LaTeX names for font series
160 char const * const known_font_series[] = { "bfseries", "mdseries", 0};
162 /// the same as known_old_font_series and known_font_series with .lyx names
163 char const * const known_coded_font_series[] = { "bold", "medium", 0};
165 /// LaTeX 2.09 names for font shapes
166 char const * const known_old_font_shapes[] = { "it", "sl", "sc", 0};
168 /// LaTeX names for font shapes
169 char const * const known_font_shapes[] = { "itshape", "slshape", "scshape",
172 /// the same as known_old_font_shapes and known_font_shapes with .lyx names
173 char const * const known_coded_font_shapes[] = { "italic", "slanted",
174 "smallcaps", "up", 0};
177 * Graphics file extensions known by the dvips driver of the graphics package.
178 * These extensions are used to complete the filename of an included
179 * graphics file if it does not contain an extension.
180 * The order must be the same that latex uses to find a file, because we
181 * will use the first extension that matches.
182 * This is only an approximation for the common cases. If we would want to
183 * do it right in all cases, we would need to know which graphics driver is
184 * used and know the extensions of every driver of the graphics package.
186 char const * const known_dvips_graphics_formats[] = {"eps", "ps", "eps.gz",
187 "ps.gz", "eps.Z", "ps.Z", 0};
190 * Graphics file extensions known by the pdftex driver of the graphics package.
191 * \sa known_dvips_graphics_formats
193 char const * const known_pdftex_graphics_formats[] = {"png", "pdf", "jpg",
197 * Known file extensions for TeX files as used by \\include.
199 char const * const known_tex_extensions[] = {"tex", 0};
202 /// splits "x=z, y=b" into a map
203 map<string, string> split_map(string const & s)
205 map<string, string> res;
208 for (size_t i = 0; i < v.size(); ++i) {
209 size_t const pos = v[i].find('=');
210 string const index = v[i].substr(0, pos);
211 string const value = v[i].substr(pos + 1, string::npos);
212 res[trim(index)] = trim(value);
219 * Split a LaTeX length into value and unit.
220 * The latter can be a real unit like "pt", or a latex length variable
221 * like "\textwidth". The unit may contain additional stuff like glue
222 * lengths, but we don't care, because such lengths are ERT anyway.
223 * \returns true if \p value and \p unit are valid.
225 bool splitLatexLength(string const & len, string & value, string & unit)
229 const string::size_type i = len.find_first_not_of(" -+0123456789.,");
230 //'4,5' is a valid LaTeX length number. Change it to '4.5'
231 string const length = subst(len, ',', '.');
232 if (i == string::npos)
235 if (len[0] == '\\') {
236 // We had something like \textwidth without a factor
242 value = trim(string(length, 0, i));
246 // 'cM' is a valid LaTeX length unit. Change it to 'cm'
247 if (contains(len, '\\'))
248 unit = trim(string(len, i));
250 unit = lyx::support::lowercase(trim(string(len, i)));
255 /// A simple function to translate a latex length to something lyx can
256 /// understand. Not perfect, but rather best-effort.
257 bool translate_len(string const & length, string & valstring, string & unit)
259 if (!splitLatexLength(length, valstring, unit))
261 // LyX uses percent values
263 istringstream iss(valstring);
268 string const percentval = oss.str();
270 if (unit.empty() || unit[0] != '\\')
272 string::size_type const i = unit.find(' ');
273 string const endlen = (i == string::npos) ? string() : string(unit, i);
274 if (unit == "\\textwidth") {
275 valstring = percentval;
276 unit = "text%" + endlen;
277 } else if (unit == "\\columnwidth") {
278 valstring = percentval;
279 unit = "col%" + endlen;
280 } else if (unit == "\\paperwidth") {
281 valstring = percentval;
282 unit = "page%" + endlen;
283 } else if (unit == "\\linewidth") {
284 valstring = percentval;
285 unit = "line%" + endlen;
286 } else if (unit == "\\paperheight") {
287 valstring = percentval;
288 unit = "pheight%" + endlen;
289 } else if (unit == "\\textheight") {
290 valstring = percentval;
291 unit = "theight%" + endlen;
299 string translate_len(string const & length)
303 if (translate_len(length, value, unit))
305 // If the input is invalid, return what we have.
313 * Translates a LaTeX length into \p value, \p unit and
314 * \p special parts suitable for a box inset.
315 * The difference from translate_len() is that a box inset knows about
316 * some special "units" that are stored in \p special.
318 void translate_box_len(string const & length, string & value, string & unit, string & special)
320 if (translate_len(length, value, unit)) {
321 if (unit == "\\height" || unit == "\\depth" ||
322 unit == "\\totalheight" || unit == "\\width") {
323 special = unit.substr(1);
324 // The unit is not used, but LyX requires a dummy setting
337 * Find a file with basename \p name in path \p path and an extension
340 string find_file(string const & name, string const & path,
341 char const * const * extensions)
343 for (char const * const * what = extensions; *what; ++what) {
344 // We don't use ChangeExtension() because it does the wrong
345 // thing if name contains a dot.
346 string const trial = name + '.' + (*what);
347 if (fs::exists(MakeAbsPath(trial, path)))
354 void begin_inset(ostream & os, string const & name)
356 os << "\n\\begin_inset " << name;
360 void end_inset(ostream & os)
362 os << "\n\\end_inset\n\n";
366 void skip_braces(Parser & p)
368 if (p.next_token().cat() != catBegin)
371 if (p.next_token().cat() == catEnd) {
379 void handle_ert(ostream & os, string const & s, Context & context)
381 // We must have a valid layout before outputting the ERT inset.
382 context.check_layout(os);
383 Context newcontext(true, context.textclass);
384 begin_inset(os, "ERT");
385 os << "\nstatus collapsed\n";
386 newcontext.check_layout(os);
387 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
389 os << "\n\\backslash\n";
390 else if (*it == '\n') {
391 newcontext.new_paragraph(os);
392 newcontext.check_layout(os);
396 newcontext.check_end_layout(os);
401 void handle_comment(ostream & os, string const & s, Context & context)
403 // TODO: Handle this better
404 Context newcontext(true, context.textclass);
405 begin_inset(os, "ERT");
406 os << "\nstatus collapsed\n";
407 newcontext.check_layout(os);
408 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
410 os << "\n\\backslash\n";
414 // make sure that our comment is the last thing on the line
415 newcontext.new_paragraph(os);
416 newcontext.check_layout(os);
417 newcontext.check_end_layout(os);
422 class isLayout : public std::unary_function<LyXLayout_ptr, bool> {
424 isLayout(string const name) : name_(name) {}
425 bool operator()(LyXLayout_ptr const & ptr) const {
426 return ptr->latexname() == name_;
433 LyXLayout_ptr findLayout(LyXTextClass const & textclass,
436 LyXTextClass::const_iterator beg = textclass.begin();
437 LyXTextClass::const_iterator end = textclass.end();
439 LyXTextClass::const_iterator
440 it = std::find_if(beg, end, isLayout(name));
442 return (it == end) ? LyXLayout_ptr() : *it;
446 void eat_whitespace(Parser &, ostream &, Context &, bool);
449 void output_command_layout(ostream & os, Parser & p, bool outer,
450 Context & parent_context,
451 LyXLayout_ptr newlayout)
453 parent_context.check_end_layout(os);
454 Context context(true, parent_context.textclass, newlayout,
455 parent_context.layout, parent_context.font);
456 if (parent_context.deeper_paragraph) {
457 // We are beginning a nested environment after a
458 // deeper paragraph inside the outer list environment.
459 // Therefore we don't need to output a "begin deeper".
460 context.need_end_deeper = true;
462 context.check_deeper(os);
463 context.check_layout(os);
464 if (context.layout->optionalargs > 0) {
465 eat_whitespace(p, os, context, false);
466 if (p.next_token().character() == '[') {
467 p.get_token(); // eat '['
468 begin_inset(os, "OptArg\n");
469 os << "status collapsed\n\n";
470 parse_text_in_inset(p, os, FLAG_BRACK_LAST, outer, context);
472 eat_whitespace(p, os, context, false);
475 parse_text(p, os, FLAG_ITEM, outer, context);
476 context.check_end_layout(os);
477 if (parent_context.deeper_paragraph) {
478 // We must suppress the "end deeper" because we
479 // suppressed the "begin deeper" above.
480 context.need_end_deeper = false;
482 context.check_end_deeper(os);
483 // We don't need really a new paragraph, but
484 // we must make sure that the next item gets a \begin_layout.
485 parent_context.new_paragraph(os);
490 * Output a space if necessary.
491 * This function gets called for every whitespace token.
493 * We have three cases here:
494 * 1. A space must be suppressed. Example: The lyxcode case below
495 * 2. A space may be suppressed. Example: Spaces before "\par"
496 * 3. A space must not be suppressed. Example: A space between two words
498 * We currently handle only 1. and 3 and from 2. only the case of
499 * spaces before newlines as a side effect.
501 * 2. could be used to suppress as many spaces as possible. This has two effects:
502 * - Reimporting LyX generated LaTeX files changes almost no whitespace
503 * - Superflous whitespace from non LyX generated LaTeX files is removed.
504 * The drawback is that the logic inside the function becomes
505 * complicated, and that is the reason why it is not implemented.
507 void check_space(Parser const & p, ostream & os, Context & context)
509 Token const next = p.next_token();
510 Token const curr = p.curr_token();
511 // A space before a single newline and vice versa must be ignored
512 // LyX emits a newline before \end{lyxcode}.
513 // This newline must be ignored,
514 // otherwise LyX will add an additional protected space.
515 if (next.cat() == catSpace ||
516 next.cat() == catNewline ||
517 (next.cs() == "end" && context.layout->free_spacing && curr.cat() == catNewline)) {
520 context.check_layout(os);
526 * Parse all arguments of \p command
528 void parse_arguments(string const & command,
529 vector<ArgumentType> const & template_arguments,
530 Parser & p, ostream & os, bool outer, Context & context)
532 string ert = command;
533 size_t no_arguments = template_arguments.size();
534 for (size_t i = 0; i < no_arguments; ++i) {
535 switch (template_arguments[i]) {
537 // This argument contains regular LaTeX
538 handle_ert(os, ert + '{', context);
539 parse_text(p, os, FLAG_ITEM, outer, context);
543 // This argument may contain special characters
544 ert += '{' + p.verbatim_item() + '}';
551 handle_ert(os, ert, context);
556 * Check whether \p command is a known command. If yes,
557 * handle the command with all arguments.
558 * \return true if the command was parsed, false otherwise.
560 bool parse_command(string const & command, Parser & p, ostream & os,
561 bool outer, Context & context)
563 if (known_commands.find(command) != known_commands.end()) {
564 parse_arguments(command, known_commands[command], p, os,
572 /// Parses a minipage or parbox
573 void parse_box(Parser & p, ostream & os, unsigned flags, bool outer,
574 Context & parent_context, bool use_parbox)
578 string height_value = "0";
579 string height_unit = "pt";
580 string height_special = "none";
582 if (p.next_token().asInput() == "[") {
583 position = p.getArg('[', ']');
584 if (position != "t" && position != "c" && position != "b") {
586 cerr << "invalid position for minipage/parbox" << endl;
588 if (p.next_token().asInput() == "[") {
589 latex_height = p.getArg('[', ']');
590 translate_box_len(latex_height, height_value, height_unit, height_special);
592 if (p.next_token().asInput() == "[") {
593 inner_pos = p.getArg('[', ']');
594 if (inner_pos != "c" && inner_pos != "t" &&
595 inner_pos != "b" && inner_pos != "s") {
596 inner_pos = position;
597 cerr << "invalid inner_pos for minipage/parbox"
605 string const latex_width = p.verbatim_item();
606 translate_len(latex_width, width_value, width_unit);
607 if (contains(width_unit, '\\') || contains(height_unit, '\\')) {
608 // LyX can't handle length variables
613 ss << "\\begin{minipage}";
614 if (!position.empty())
615 ss << '[' << position << ']';
616 if (!latex_height.empty())
617 ss << '[' << latex_height << ']';
618 if (!inner_pos.empty())
619 ss << '[' << inner_pos << ']';
620 ss << "{" << latex_width << "}";
623 handle_ert(os, ss.str(), parent_context);
624 parent_context.new_paragraph(os);
625 parse_text_in_inset(p, os, flags, outer, parent_context);
627 handle_ert(os, "}", parent_context);
629 handle_ert(os, "\\end{minipage}", parent_context);
631 // LyX does not like empty positions, so we have
632 // to set them to the LaTeX default values here.
633 if (position.empty())
635 if (inner_pos.empty())
636 inner_pos = position;
637 parent_context.check_layout(os);
638 begin_inset(os, "Box Frameless\n");
639 os << "position \"" << position << "\"\n";
640 os << "hor_pos \"c\"\n";
641 os << "has_inner_box 1\n";
642 os << "inner_pos \"" << inner_pos << "\"\n";
643 os << "use_parbox " << use_parbox << "\n";
644 os << "width \"" << width_value << width_unit << "\"\n";
645 os << "special \"none\"\n";
646 os << "height \"" << height_value << height_unit << "\"\n";
647 os << "height_special \"" << height_special << "\"\n";
648 os << "status open\n\n";
649 parse_text_in_inset(p, os, flags, outer, parent_context);
651 #ifdef PRESERVE_LAYOUT
652 // lyx puts a % after the end of the minipage
653 if (p.next_token().cat() == catNewline && p.next_token().cs().size() > 1) {
655 //handle_comment(os, "%dummy", parent_context);
658 parent_context.new_paragraph(os);
660 else if (p.next_token().cat() == catSpace || p.next_token().cat() == catNewline) {
661 //handle_comment(os, "%dummy", parent_context);
664 // We add a protected space if something real follows
665 if (p.good() && p.next_token().cat() != catComment) {
666 os << "\\InsetSpace ~\n";
674 /// parse an unknown environment
675 void parse_unknown_environment(Parser & p, string const & name, ostream & os,
676 unsigned flags, bool outer,
677 Context & parent_context)
679 if (name == "tabbing")
680 // We need to remember that we have to handle '\=' specially
681 flags |= FLAG_TABBING;
683 // We need to translate font changes and paragraphs inside the
684 // environment to ERT if we have a non standard font.
685 // Otherwise things like
686 // \large\begin{foo}\huge bar\end{foo}
688 bool const specialfont =
689 (parent_context.font != parent_context.normalfont);
690 bool const new_layout_allowed = parent_context.new_layout_allowed;
692 parent_context.new_layout_allowed = false;
693 handle_ert(os, "\\begin{" + name + "}", parent_context);
694 parse_text_snippet(p, os, flags, outer, parent_context);
695 handle_ert(os, "\\end{" + name + "}", parent_context);
697 parent_context.new_layout_allowed = new_layout_allowed;
701 void parse_environment(Parser & p, ostream & os, bool outer,
702 Context & parent_context)
704 LyXLayout_ptr newlayout;
705 string const name = p.getArg('{', '}');
706 const bool is_starred = suffixIs(name, '*');
707 string const unstarred_name = rtrim(name, "*");
708 active_environments.push_back(name);
710 if (is_math_env(name)) {
711 parent_context.check_layout(os);
712 begin_inset(os, "Formula ");
713 os << "\\begin{" << name << "}";
714 parse_math(p, os, FLAG_END, MATH_MODE);
715 os << "\\end{" << name << "}";
719 else if (name == "tabular" || name == "longtable") {
720 eat_whitespace(p, os, parent_context, false);
721 parent_context.check_layout(os);
722 begin_inset(os, "Tabular ");
723 handle_tabular(p, os, name == "longtable", parent_context);
728 else if (parent_context.textclass.floats().typeExist(unstarred_name)) {
729 eat_whitespace(p, os, parent_context, false);
730 parent_context.check_layout(os);
731 begin_inset(os, "Float " + unstarred_name + "\n");
732 if (p.next_token().asInput() == "[") {
733 os << "placement " << p.getArg('[', ']') << '\n';
735 os << "wide " << convert<string>(is_starred)
736 << "\nsideways false"
737 << "\nstatus open\n\n";
738 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
740 // We don't need really a new paragraph, but
741 // we must make sure that the next item gets a \begin_layout.
742 parent_context.new_paragraph(os);
746 else if (name == "minipage") {
747 eat_whitespace(p, os, parent_context, false);
748 parse_box(p, os, FLAG_END, outer, parent_context, false);
752 else if (name == "comment") {
753 eat_whitespace(p, os, parent_context, false);
754 parent_context.check_layout(os);
755 begin_inset(os, "Note Comment\n");
756 os << "status open\n";
757 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
762 else if (name == "lyxgreyedout") {
763 eat_whitespace(p, os, parent_context, false);
764 parent_context.check_layout(os);
765 begin_inset(os, "Note Greyedout\n");
766 os << "status open\n";
767 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
772 else if (!parent_context.new_layout_allowed)
773 parse_unknown_environment(p, name, os, FLAG_END, outer,
776 // Alignment settings
777 else if (name == "center" || name == "flushleft" || name == "flushright" ||
778 name == "centering" || name == "raggedright" || name == "raggedleft") {
779 eat_whitespace(p, os, parent_context, false);
780 // We must begin a new paragraph if not already done
781 if (! parent_context.atParagraphStart()) {
782 parent_context.check_end_layout(os);
783 parent_context.new_paragraph(os);
785 if (name == "flushleft" || name == "raggedright")
786 parent_context.add_extra_stuff("\\align left\n");
787 else if (name == "flushright" || name == "raggedleft")
788 parent_context.add_extra_stuff("\\align right\n");
790 parent_context.add_extra_stuff("\\align center\n");
791 parse_text(p, os, FLAG_END, outer, parent_context);
792 // Just in case the environment is empty ..
793 parent_context.extra_stuff.erase();
794 // We must begin a new paragraph to reset the alignment
795 parent_context.new_paragraph(os);
799 // The single '=' is meant here.
800 else if ((newlayout = findLayout(parent_context.textclass, name)).get() &&
801 newlayout->isEnvironment()) {
802 eat_whitespace(p, os, parent_context, false);
803 Context context(true, parent_context.textclass, newlayout,
804 parent_context.layout, parent_context.font);
805 if (parent_context.deeper_paragraph) {
806 // We are beginning a nested environment after a
807 // deeper paragraph inside the outer list environment.
808 // Therefore we don't need to output a "begin deeper".
809 context.need_end_deeper = true;
811 parent_context.check_end_layout(os);
812 switch (context.layout->latextype) {
813 case LATEX_LIST_ENVIRONMENT:
814 context.extra_stuff = "\\labelwidthstring "
815 + p.verbatim_item() + '\n';
818 case LATEX_BIB_ENVIRONMENT:
819 p.verbatim_item(); // swallow next arg
825 context.check_deeper(os);
826 parse_text(p, os, FLAG_END, outer, context);
827 context.check_end_layout(os);
828 if (parent_context.deeper_paragraph) {
829 // We must suppress the "end deeper" because we
830 // suppressed the "begin deeper" above.
831 context.need_end_deeper = false;
833 context.check_end_deeper(os);
834 parent_context.new_paragraph(os);
838 else if (name == "appendix") {
839 // This is no good latex style, but it works and is used in some documents...
840 eat_whitespace(p, os, parent_context, false);
841 parent_context.check_end_layout(os);
842 Context context(true, parent_context.textclass, parent_context.layout,
843 parent_context.layout, parent_context.font);
844 context.check_layout(os);
845 os << "\\start_of_appendix\n";
846 parse_text(p, os, FLAG_END, outer, context);
847 context.check_end_layout(os);
851 else if (known_environments.find(name) != known_environments.end()) {
852 vector<ArgumentType> arguments = known_environments[name];
853 // The last "argument" denotes wether we may translate the
854 // environment contents to LyX
855 // The default required if no argument is given makes us
856 // compatible with the reLyXre environment.
857 ArgumentType contents = arguments.empty() ?
860 if (!arguments.empty())
861 arguments.pop_back();
862 // See comment in parse_unknown_environment()
863 bool const specialfont =
864 (parent_context.font != parent_context.normalfont);
865 bool const new_layout_allowed =
866 parent_context.new_layout_allowed;
868 parent_context.new_layout_allowed = false;
869 parse_arguments("\\begin{" + name + "}", arguments, p, os,
870 outer, parent_context);
871 if (contents == verbatim)
872 handle_ert(os, p.verbatimEnvironment(name),
875 parse_text_snippet(p, os, FLAG_END, outer,
877 handle_ert(os, "\\end{" + name + "}", parent_context);
879 parent_context.new_layout_allowed = new_layout_allowed;
883 parse_unknown_environment(p, name, os, FLAG_END, outer,
886 active_environments.pop_back();
890 /// parses a comment and outputs it to \p os.
891 void parse_comment(Parser & p, ostream & os, Token const & t, Context & context)
893 BOOST_ASSERT(t.cat() == catComment);
894 if (!t.cs().empty()) {
895 context.check_layout(os);
896 handle_comment(os, '%' + t.cs(), context);
897 if (p.next_token().cat() == catNewline) {
898 // A newline after a comment line starts a new
900 if (context.new_layout_allowed) {
901 if(!context.atParagraphStart())
902 // Only start a new paragraph if not already
903 // done (we might get called recursively)
904 context.new_paragraph(os);
906 handle_ert(os, "\n", context);
907 eat_whitespace(p, os, context, true);
917 * Reads spaces and comments until the first non-space, non-comment token.
918 * New paragraphs (double newlines or \\par) are handled like simple spaces
919 * if \p eatParagraph is true.
920 * Spaces are skipped, but comments are written to \p os.
922 void eat_whitespace(Parser & p, ostream & os, Context & context,
926 Token const & t = p.get_token();
927 if (t.cat() == catComment)
928 parse_comment(p, os, t, context);
929 else if ((! eatParagraph && p.isParagraph()) ||
930 (t.cat() != catSpace && t.cat() != catNewline)) {
939 * Set a font attribute, parse text and reset the font attribute.
940 * \param attribute Attribute name (e.g. \\family, \\shape etc.)
941 * \param currentvalue Current value of the attribute. Is set to the new
942 * value during parsing.
943 * \param newvalue New value of the attribute
945 void parse_text_attributes(Parser & p, ostream & os, unsigned flags, bool outer,
946 Context & context, string const & attribute,
947 string & currentvalue, string const & newvalue)
949 context.check_layout(os);
950 string const oldvalue = currentvalue;
951 currentvalue = newvalue;
952 os << '\n' << attribute << ' ' << newvalue << "\n";
953 parse_text_snippet(p, os, flags, outer, context);
954 context.check_layout(os);
955 os << '\n' << attribute << ' ' << oldvalue << "\n";
956 currentvalue = oldvalue;
960 /// get the arguments of a natbib or jurabib citation command
961 std::pair<string, string> getCiteArguments(Parser & p, bool natbibOrder)
963 // We need to distinguish "" and "[]", so we can't use p.getOpt().
965 // text before the citation
967 // text after the citation
968 string after = p.getFullOpt();
970 if (!after.empty()) {
971 before = p.getFullOpt();
972 if (natbibOrder && !before.empty())
973 std::swap(before, after);
975 return std::make_pair(before, after);
979 /// Convert filenames with TeX macros and/or quotes to something LyX can understand
980 string const normalize_filename(string const & name)
982 Parser p(trim(name, "\""));
985 Token const & t = p.get_token();
986 if (t.cat() != catEscape)
988 else if (t.cs() == "lyxdot") {
989 // This is used by LyX for simple dots in relative
993 } else if (t.cs() == "space") {
1003 /// Convert \p name from TeX convention (relative to master file) to LyX
1004 /// convention (relative to .lyx file) if it is relative
1005 void fix_relative_filename(string & name)
1007 if (lyx::support::AbsolutePath(name))
1009 name = MakeRelPath(MakeAbsPath(name, getMasterFilePath()),
1010 getParentFilePath());
1013 } // anonymous namespace
1016 void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
1019 LyXLayout_ptr newlayout;
1020 // Store the latest bibliographystyle (needed for bibtex inset)
1021 string bibliographystyle;
1022 bool const use_natbib = used_packages.find("natbib") != used_packages.end();
1023 bool const use_jurabib = used_packages.find("jurabib") != used_packages.end();
1025 Token const & t = p.get_token();
1028 cerr << "t: " << t << " flags: " << flags << "\n";
1031 if (flags & FLAG_ITEM) {
1032 if (t.cat() == catSpace)
1035 flags &= ~FLAG_ITEM;
1036 if (t.cat() == catBegin) {
1037 // skip the brace and collect everything to the next matching
1039 flags |= FLAG_BRACE_LAST;
1043 // handle only this single token, leave the loop if done
1044 flags |= FLAG_LEAVE;
1047 if (t.character() == ']' && (flags & FLAG_BRACK_LAST))
1053 if (t.cat() == catMath) {
1054 // we are inside some text mode thingy, so opening new math is allowed
1055 context.check_layout(os);
1056 begin_inset(os, "Formula ");
1057 Token const & n = p.get_token();
1058 if (n.cat() == catMath && outer) {
1059 // TeX's $$...$$ syntax for displayed math
1061 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
1063 p.get_token(); // skip the second '$' token
1065 // simple $...$ stuff
1068 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
1074 else if (t.cat() == catSuper || t.cat() == catSub)
1075 cerr << "catcode " << t << " illegal in text mode\n";
1077 // Basic support for english quotes. This should be
1078 // extended to other quotes, but is not so easy (a
1079 // left english quote is the same as a right german
1081 else if (t.asInput() == "`"
1082 && p.next_token().asInput() == "`") {
1083 context.check_layout(os);
1084 begin_inset(os, "Quotes ");
1090 else if (t.asInput() == "'"
1091 && p.next_token().asInput() == "'") {
1092 context.check_layout(os);
1093 begin_inset(os, "Quotes ");
1100 else if (t.cat() == catSpace || (t.cat() == catNewline && ! p.isParagraph()))
1101 check_space(p, os, context);
1103 else if (t.cat() == catLetter ||
1104 t.cat() == catOther ||
1105 t.cat() == catAlign ||
1106 t.cat() == catParameter) {
1107 // This translates "&" to "\\&" which may be wrong...
1108 context.check_layout(os);
1109 os << t.character();
1112 else if (p.isParagraph()) {
1113 if (context.new_layout_allowed)
1114 context.new_paragraph(os);
1116 handle_ert(os, "\\par ", context);
1117 eat_whitespace(p, os, context, true);
1120 else if (t.cat() == catActive) {
1121 context.check_layout(os);
1122 if (t.character() == '~') {
1123 if (context.layout->free_spacing)
1126 os << "\\InsetSpace ~\n";
1128 os << t.character();
1131 else if (t.cat() == catBegin &&
1132 p.next_token().cat() == catEnd) {
1134 Token const prev = p.prev_token();
1136 if (p.next_token().character() == '`' ||
1137 (prev.character() == '-' &&
1138 p.next_token().character() == '-'))
1139 ; // ignore it in {}`` or -{}-
1141 handle_ert(os, "{}", context);
1145 else if (t.cat() == catBegin) {
1146 context.check_layout(os);
1147 // special handling of font attribute changes
1148 Token const prev = p.prev_token();
1149 Token const next = p.next_token();
1150 Font const oldFont = context.font;
1151 if (next.character() == '[' ||
1152 next.character() == ']' ||
1153 next.character() == '*') {
1155 if (p.next_token().cat() == catEnd) {
1156 os << next.character();
1160 handle_ert(os, "{", context);
1161 parse_text_snippet(p, os,
1164 handle_ert(os, "}", context);
1166 } else if (! context.new_layout_allowed) {
1167 handle_ert(os, "{", context);
1168 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1170 handle_ert(os, "}", context);
1171 } else if (is_known(next.cs(), known_sizes)) {
1172 // next will change the size, so we must
1174 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1176 if (!context.atParagraphStart())
1178 << context.font.size << "\n";
1179 } else if (is_known(next.cs(), known_font_families)) {
1180 // next will change the font family, so we
1181 // must reset it here
1182 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1184 if (!context.atParagraphStart())
1186 << context.font.family << "\n";
1187 } else if (is_known(next.cs(), known_font_series)) {
1188 // next will change the font series, so we
1189 // must reset it here
1190 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1192 if (!context.atParagraphStart())
1194 << context.font.series << "\n";
1195 } else if (is_known(next.cs(), known_font_shapes)) {
1196 // next will change the font shape, so we
1197 // must reset it here
1198 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1200 if (!context.atParagraphStart())
1202 << context.font.shape << "\n";
1203 } else if (is_known(next.cs(), known_old_font_families) ||
1204 is_known(next.cs(), known_old_font_series) ||
1205 is_known(next.cs(), known_old_font_shapes)) {
1206 // next will change the font family, series
1207 // and shape, so we must reset it here
1208 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1210 if (!context.atParagraphStart())
1212 << context.font.family
1214 << context.font.series
1216 << context.font.shape << "\n";
1218 handle_ert(os, "{", context);
1219 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1221 handle_ert(os, "}", context);
1225 else if (t.cat() == catEnd) {
1226 if (flags & FLAG_BRACE_LAST) {
1229 cerr << "stray '}' in text\n";
1230 handle_ert(os, "}", context);
1233 else if (t.cat() == catComment)
1234 parse_comment(p, os, t, context);
1237 // control sequences
1240 else if (t.cs() == "(") {
1241 context.check_layout(os);
1242 begin_inset(os, "Formula");
1244 parse_math(p, os, FLAG_SIMPLE2, MATH_MODE);
1249 else if (t.cs() == "[") {
1250 context.check_layout(os);
1251 begin_inset(os, "Formula");
1253 parse_math(p, os, FLAG_EQUATION, MATH_MODE);
1258 else if (t.cs() == "begin")
1259 parse_environment(p, os, outer, context);
1261 else if (t.cs() == "end") {
1262 if (flags & FLAG_END) {
1263 // eat environment name
1264 string const name = p.getArg('{', '}');
1265 if (name != active_environment())
1266 cerr << "\\end{" + name + "} does not match \\begin{"
1267 + active_environment() + "}\n";
1270 p.error("found 'end' unexpectedly");
1273 else if (t.cs() == "item") {
1276 bool optarg = false;
1277 if (p.next_token().character() == '[') {
1278 p.get_token(); // eat '['
1279 s = parse_text_snippet(p, FLAG_BRACK_LAST,
1284 context.check_layout(os);
1285 if (context.has_item) {
1286 // An item in an unknown list-like environment
1287 // FIXME: Do this in check_layout()!
1288 context.has_item = false;
1290 handle_ert(os, "\\item", context);
1292 handle_ert(os, "\\item ", context);
1295 if (context.layout->labeltype != LABEL_MANUAL) {
1296 // lyx does not support \item[\mybullet]
1297 // in itemize environments
1298 handle_ert(os, "[", context);
1300 handle_ert(os, "]", context);
1301 } else if (!s.empty()) {
1302 // The space is needed to separate the
1303 // item from the rest of the sentence.
1305 eat_whitespace(p, os, context, false);
1310 else if (t.cs() == "bibitem") {
1312 context.check_layout(os);
1315 os << '{' << p.verbatim_item() << '}' << "\n";
1318 else if (t.cs() == "def") {
1319 context.check_layout(os);
1320 eat_whitespace(p, os, context, false);
1321 string name = p.get_token().cs();
1322 while (p.next_token().cat() != catBegin)
1323 name += p.get_token().asString();
1324 handle_ert(os, "\\def\\" + name + '{' + p.verbatim_item() + '}', context);
1327 else if (t.cs() == "noindent") {
1329 context.add_extra_stuff("\\noindent\n");
1332 else if (t.cs() == "appendix") {
1333 context.add_extra_stuff("\\start_of_appendix\n");
1334 // We need to start a new paragraph. Otherwise the
1335 // appendix in 'bla\appendix\chapter{' would start
1337 context.new_paragraph(os);
1338 // We need to make sure that the paragraph is
1339 // generated even if it is empty. Otherwise the
1340 // appendix in '\par\appendix\par\chapter{' would
1342 context.check_layout(os);
1343 // FIXME: This is a hack to prevent paragraph
1344 // deletion if it is empty. Handle this better!
1346 "%dummy comment inserted by tex2lyx to "
1347 "ensure that this paragraph is not empty",
1349 // Both measures above may generate an additional
1350 // empty paragraph, but that does not hurt, because
1351 // whitespace does not matter here.
1352 eat_whitespace(p, os, context, true);
1355 // Must attempt to parse "Section*" before "Section".
1356 else if ((p.next_token().asInput() == "*") &&
1357 context.new_layout_allowed &&
1358 // The single '=' is meant here.
1359 (newlayout = findLayout(context.textclass,
1360 t.cs() + '*')).get() &&
1361 newlayout->isCommand()) {
1363 output_command_layout(os, p, outer, context, newlayout);
1367 // The single '=' is meant here.
1368 else if (context.new_layout_allowed &&
1369 (newlayout = findLayout(context.textclass, t.cs())).get() &&
1370 newlayout->isCommand()) {
1371 output_command_layout(os, p, outer, context, newlayout);
1375 else if (t.cs() == "includegraphics") {
1376 bool const clip = p.next_token().asInput() == "*";
1379 map<string, string> opts = split_map(p.getArg('[', ']'));
1381 opts["clip"] = string();
1382 string name = normalize_filename(p.verbatim_item());
1384 string const path = getMasterFilePath();
1385 // We want to preserve relative / absolute filenames,
1386 // therefore path is only used for testing
1387 if (!fs::exists(MakeAbsPath(name, path))) {
1388 // The file extension is probably missing.
1389 // Now try to find it out.
1390 string const dvips_name =
1391 find_file(name, path,
1392 known_dvips_graphics_formats);
1393 string const pdftex_name =
1394 find_file(name, path,
1395 known_pdftex_graphics_formats);
1396 if (!dvips_name.empty()) {
1397 if (!pdftex_name.empty()) {
1398 cerr << "This file contains the "
1400 "\"\\includegraphics{"
1402 "However, files\n\""
1403 << dvips_name << "\" and\n\""
1404 << pdftex_name << "\"\n"
1405 "both exist, so I had to make a "
1406 "choice and took the first one.\n"
1407 "Please move the unwanted one "
1408 "someplace else and try again\n"
1409 "if my choice was wrong."
1413 } else if (!pdftex_name.empty())
1417 if (fs::exists(MakeAbsPath(name, path)))
1418 fix_relative_filename(name);
1420 cerr << "Warning: Could not find graphics file '"
1421 << name << "'." << endl;
1423 context.check_layout(os);
1424 begin_inset(os, "Graphics ");
1425 os << "\n\tfilename " << name << '\n';
1426 if (opts.find("width") != opts.end())
1428 << translate_len(opts["width"]) << '\n';
1429 if (opts.find("height") != opts.end())
1431 << translate_len(opts["height"]) << '\n';
1432 if (opts.find("scale") != opts.end()) {
1433 istringstream iss(opts["scale"]);
1437 os << "\tscale " << val << '\n';
1439 if (opts.find("angle") != opts.end())
1440 os << "\trotateAngle "
1441 << opts["angle"] << '\n';
1442 if (opts.find("origin") != opts.end()) {
1444 string const opt = opts["origin"];
1445 if (opt.find('l') != string::npos) ss << "left";
1446 if (opt.find('r') != string::npos) ss << "right";
1447 if (opt.find('c') != string::npos) ss << "center";
1448 if (opt.find('t') != string::npos) ss << "Top";
1449 if (opt.find('b') != string::npos) ss << "Bottom";
1450 if (opt.find('B') != string::npos) ss << "Baseline";
1451 if (!ss.str().empty())
1452 os << "\trotateOrigin " << ss.str() << '\n';
1454 cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
1456 if (opts.find("keepaspectratio") != opts.end())
1457 os << "\tkeepAspectRatio\n";
1458 if (opts.find("clip") != opts.end())
1460 if (opts.find("draft") != opts.end())
1462 if (opts.find("bb") != opts.end())
1463 os << "\tBoundingBox "
1464 << opts["bb"] << '\n';
1465 int numberOfbbOptions = 0;
1466 if (opts.find("bbllx") != opts.end())
1467 numberOfbbOptions++;
1468 if (opts.find("bblly") != opts.end())
1469 numberOfbbOptions++;
1470 if (opts.find("bburx") != opts.end())
1471 numberOfbbOptions++;
1472 if (opts.find("bbury") != opts.end())
1473 numberOfbbOptions++;
1474 if (numberOfbbOptions == 4)
1475 os << "\tBoundingBox "
1476 << opts["bbllx"] << opts["bblly"]
1477 << opts["bburx"] << opts["bbury"] << '\n';
1478 else if (numberOfbbOptions > 0)
1479 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
1480 numberOfbbOptions = 0;
1481 if (opts.find("natwidth") != opts.end())
1482 numberOfbbOptions++;
1483 if (opts.find("natheight") != opts.end())
1484 numberOfbbOptions++;
1485 if (numberOfbbOptions == 2)
1486 os << "\tBoundingBox 0bp 0bp "
1487 << opts["natwidth"] << opts["natheight"] << '\n';
1488 else if (numberOfbbOptions > 0)
1489 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
1490 ostringstream special;
1491 if (opts.find("hiresbb") != opts.end())
1492 special << "hiresbb,";
1493 if (opts.find("trim") != opts.end())
1495 if (opts.find("viewport") != opts.end())
1496 special << "viewport=" << opts["viewport"] << ',';
1497 if (opts.find("totalheight") != opts.end())
1498 special << "totalheight=" << opts["totalheight"] << ',';
1499 if (opts.find("type") != opts.end())
1500 special << "type=" << opts["type"] << ',';
1501 if (opts.find("ext") != opts.end())
1502 special << "ext=" << opts["ext"] << ',';
1503 if (opts.find("read") != opts.end())
1504 special << "read=" << opts["read"] << ',';
1505 if (opts.find("command") != opts.end())
1506 special << "command=" << opts["command"] << ',';
1507 string s_special = special.str();
1508 if (!s_special.empty()) {
1509 // We had special arguments. Remove the trailing ','.
1510 os << "\tspecial " << s_special.substr(0, s_special.size() - 1) << '\n';
1512 // TODO: Handle the unknown settings better.
1513 // Warn about invalid options.
1514 // Check whether some option was given twice.
1518 else if (t.cs() == "footnote" ||
1519 (t.cs() == "thanks" && context.layout->intitle)) {
1521 context.check_layout(os);
1522 begin_inset(os, "Foot\n");
1523 os << "status collapsed\n\n";
1524 parse_text_in_inset(p, os, FLAG_ITEM, false, context);
1528 else if (t.cs() == "marginpar") {
1530 context.check_layout(os);
1531 begin_inset(os, "Marginal\n");
1532 os << "status collapsed\n\n";
1533 parse_text_in_inset(p, os, FLAG_ITEM, false, context);
1537 else if (t.cs() == "ensuremath") {
1539 context.check_layout(os);
1540 string const s = p.verbatim_item();
1541 if (s == "±" || s == "³" || s == "²" || s == "µ")
1544 handle_ert(os, "\\ensuremath{" + s + "}",
1548 else if (t.cs() == "hfill") {
1549 context.check_layout(os);
1550 os << "\n\\hfill\n";
1555 else if (t.cs() == "makeindex" || t.cs() == "maketitle") {
1556 // FIXME: Somehow prevent title layouts if
1557 // "maketitle" was not found
1559 skip_braces(p); // swallow this
1562 else if (t.cs() == "tableofcontents") {
1564 context.check_layout(os);
1565 begin_inset(os, "LatexCommand \\tableofcontents\n");
1567 skip_braces(p); // swallow this
1570 else if (t.cs() == "listoffigures") {
1572 context.check_layout(os);
1573 begin_inset(os, "FloatList figure\n");
1575 skip_braces(p); // swallow this
1578 else if (t.cs() == "listoftables") {
1580 context.check_layout(os);
1581 begin_inset(os, "FloatList table\n");
1583 skip_braces(p); // swallow this
1586 else if (t.cs() == "listof") {
1587 p.skip_spaces(true);
1588 string const name = p.get_token().asString();
1589 if (context.textclass.floats().typeExist(name)) {
1590 context.check_layout(os);
1591 begin_inset(os, "FloatList ");
1594 p.get_token(); // swallow second arg
1596 handle_ert(os, "\\listof{" + name + "}", context);
1599 else if (t.cs() == "textrm")
1600 parse_text_attributes(p, os, FLAG_ITEM, outer,
1601 context, "\\family",
1602 context.font.family, "roman");
1604 else if (t.cs() == "textsf")
1605 parse_text_attributes(p, os, FLAG_ITEM, outer,
1606 context, "\\family",
1607 context.font.family, "sans");
1609 else if (t.cs() == "texttt")
1610 parse_text_attributes(p, os, FLAG_ITEM, outer,
1611 context, "\\family",
1612 context.font.family, "typewriter");
1614 else if (t.cs() == "textmd")
1615 parse_text_attributes(p, os, FLAG_ITEM, outer,
1616 context, "\\series",
1617 context.font.series, "medium");
1619 else if (t.cs() == "textbf")
1620 parse_text_attributes(p, os, FLAG_ITEM, outer,
1621 context, "\\series",
1622 context.font.series, "bold");
1624 else if (t.cs() == "textup")
1625 parse_text_attributes(p, os, FLAG_ITEM, outer,
1627 context.font.shape, "up");
1629 else if (t.cs() == "textit")
1630 parse_text_attributes(p, os, FLAG_ITEM, outer,
1632 context.font.shape, "italic");
1634 else if (t.cs() == "textsl")
1635 parse_text_attributes(p, os, FLAG_ITEM, outer,
1637 context.font.shape, "slanted");
1639 else if (t.cs() == "textsc")
1640 parse_text_attributes(p, os, FLAG_ITEM, outer,
1642 context.font.shape, "smallcaps");
1644 else if (t.cs() == "textnormal" || t.cs() == "normalfont") {
1645 context.check_layout(os);
1646 Font oldFont = context.font;
1647 context.font.init();
1648 context.font.size = oldFont.size;
1649 os << "\n\\family " << context.font.family << "\n";
1650 os << "\n\\series " << context.font.series << "\n";
1651 os << "\n\\shape " << context.font.shape << "\n";
1652 if (t.cs() == "textnormal") {
1653 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
1654 output_font_change(os, context.font, oldFont);
1655 context.font = oldFont;
1657 eat_whitespace(p, os, context, false);
1660 else if (t.cs() == "underbar") {
1661 // Do NOT handle \underline.
1662 // \underbar cuts through y, g, q, p etc.,
1663 // \underline does not.
1664 context.check_layout(os);
1665 os << "\n\\bar under\n";
1666 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
1667 context.check_layout(os);
1668 os << "\n\\bar default\n";
1671 else if (t.cs() == "emph" || t.cs() == "noun") {
1672 context.check_layout(os);
1673 os << "\n\\" << t.cs() << " on\n";
1674 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
1675 context.check_layout(os);
1676 os << "\n\\" << t.cs() << " default\n";
1679 else if (use_natbib &&
1680 is_known(t.cs(), known_natbib_commands) &&
1681 ((t.cs() != "citefullauthor" &&
1682 t.cs() != "citeyear" &&
1683 t.cs() != "citeyearpar") ||
1684 p.next_token().asInput() != "*")) {
1685 context.check_layout(os);
1687 // \citet[before][after]{a} \citet[after][before]{a}
1688 // \citet[before][]{a} \citet[][before]{a}
1689 // \citet[after]{a} \citet[after]{a}
1690 // \citet{a} \citet{a}
1691 string command = '\\' + t.cs();
1692 if (p.next_token().asInput() == "*") {
1696 if (command == "\\citefullauthor")
1697 // alternative name for "\\citeauthor*"
1698 command = "\\citeauthor*";
1700 // text before the citation
1702 // text after the citation
1705 boost::tie(before, after) = getCiteArguments(p, true);
1706 if (command == "\\cite") {
1707 // \cite without optional argument means
1708 // \citet, \cite with at least one optional
1709 // argument means \citep.
1710 if (before.empty() && after.empty())
1711 command = "\\citet";
1713 command = "\\citep";
1715 if (before.empty() && after == "[]")
1716 // avoid \citet[]{a}
1718 else if (before == "[]" && after == "[]") {
1719 // avoid \citet[][]{a}
1723 begin_inset(os, "LatexCommand ");
1724 os << command << after << before
1725 << '{' << p.verbatim_item() << "}\n";
1729 else if (use_jurabib &&
1730 is_known(t.cs(), known_jurabib_commands)) {
1731 context.check_layout(os);
1732 string const command = '\\' + t.cs();
1733 char argumentOrder = '\0';
1734 vector<string> const & options = used_packages["jurabib"];
1735 if (std::find(options.begin(), options.end(),
1736 "natbiborder") != options.end())
1737 argumentOrder = 'n';
1738 else if (std::find(options.begin(), options.end(),
1739 "jurabiborder") != options.end())
1740 argumentOrder = 'j';
1742 // text before the citation
1744 // text after the citation
1747 boost::tie(before, after) =
1748 getCiteArguments(p, argumentOrder != 'j');
1749 string const citation = p.verbatim_item();
1750 if (!before.empty() && argumentOrder == '\0') {
1751 cerr << "Warning: Assuming argument order "
1752 "of jurabib version 0.6 for\n'"
1753 << command << before << after << '{'
1754 << citation << "}'.\n"
1755 "Add 'jurabiborder' to the jurabib "
1756 "package options if you used an\n"
1757 "earlier jurabib version." << endl;
1759 begin_inset(os, "LatexCommand ");
1760 os << command << after << before
1761 << '{' << citation << "}\n";
1765 else if (is_known(t.cs(), known_latex_commands)) {
1766 // This needs to be after the check for natbib and
1767 // jurabib commands, because "cite" has different
1768 // arguments with natbib and jurabib.
1769 context.check_layout(os);
1770 begin_inset(os, "LatexCommand ");
1771 os << '\\' << t.cs();
1772 // lyx cannot handle newlines in a latex command
1773 // FIXME: Move the substitution into parser::getOpt()?
1774 os << subst(p.getOpt(), "\n", " ");
1775 os << subst(p.getOpt(), "\n", " ");
1776 os << '{' << subst(p.verbatim_item(), "\n", " ") << "}\n";
1780 else if (is_known(t.cs(), known_quotes)) {
1781 char const * const * where = is_known(t.cs(), known_quotes);
1782 context.check_layout(os);
1783 begin_inset(os, "Quotes ");
1784 os << known_coded_quotes[where - known_quotes];
1786 // LyX adds {} after the quote, so we have to eat
1787 // spaces here if there are any before a possible
1789 eat_whitespace(p, os, context, false);
1793 else if (is_known(t.cs(), known_sizes) &&
1794 context.new_layout_allowed) {
1795 char const * const * where = is_known(t.cs(), known_sizes);
1796 context.check_layout(os);
1797 Font const oldFont = context.font;
1798 context.font.size = known_coded_sizes[where - known_sizes];
1799 output_font_change(os, oldFont, context.font);
1800 eat_whitespace(p, os, context, false);
1803 else if (is_known(t.cs(), known_font_families) &&
1804 context.new_layout_allowed) {
1805 char const * const * where =
1806 is_known(t.cs(), known_font_families);
1807 context.check_layout(os);
1808 Font const oldFont = context.font;
1809 context.font.family =
1810 known_coded_font_families[where - known_font_families];
1811 output_font_change(os, oldFont, context.font);
1812 eat_whitespace(p, os, context, false);
1815 else if (is_known(t.cs(), known_font_series) &&
1816 context.new_layout_allowed) {
1817 char const * const * where =
1818 is_known(t.cs(), known_font_series);
1819 context.check_layout(os);
1820 Font const oldFont = context.font;
1821 context.font.series =
1822 known_coded_font_series[where - known_font_series];
1823 output_font_change(os, oldFont, context.font);
1824 eat_whitespace(p, os, context, false);
1827 else if (is_known(t.cs(), known_font_shapes) &&
1828 context.new_layout_allowed) {
1829 char const * const * where =
1830 is_known(t.cs(), known_font_shapes);
1831 context.check_layout(os);
1832 Font const oldFont = context.font;
1833 context.font.shape =
1834 known_coded_font_shapes[where - known_font_shapes];
1835 output_font_change(os, oldFont, context.font);
1836 eat_whitespace(p, os, context, false);
1838 else if (is_known(t.cs(), known_old_font_families) &&
1839 context.new_layout_allowed) {
1840 char const * const * where =
1841 is_known(t.cs(), known_old_font_families);
1842 context.check_layout(os);
1843 Font const oldFont = context.font;
1844 context.font.init();
1845 context.font.size = oldFont.size;
1846 context.font.family =
1847 known_coded_font_families[where - known_old_font_families];
1848 output_font_change(os, oldFont, context.font);
1849 eat_whitespace(p, os, context, false);
1852 else if (is_known(t.cs(), known_old_font_series) &&
1853 context.new_layout_allowed) {
1854 char const * const * where =
1855 is_known(t.cs(), known_old_font_series);
1856 context.check_layout(os);
1857 Font const oldFont = context.font;
1858 context.font.init();
1859 context.font.size = oldFont.size;
1860 context.font.series =
1861 known_coded_font_series[where - known_old_font_series];
1862 output_font_change(os, oldFont, context.font);
1863 eat_whitespace(p, os, context, false);
1866 else if (is_known(t.cs(), known_old_font_shapes) &&
1867 context.new_layout_allowed) {
1868 char const * const * where =
1869 is_known(t.cs(), known_old_font_shapes);
1870 context.check_layout(os);
1871 Font const oldFont = context.font;
1872 context.font.init();
1873 context.font.size = oldFont.size;
1874 context.font.shape =
1875 known_coded_font_shapes[where - known_old_font_shapes];
1876 output_font_change(os, oldFont, context.font);
1877 eat_whitespace(p, os, context, false);
1880 else if (t.cs() == "LyX" || t.cs() == "TeX"
1881 || t.cs() == "LaTeX") {
1882 context.check_layout(os);
1884 skip_braces(p); // eat {}
1887 else if (t.cs() == "LaTeXe") {
1888 context.check_layout(os);
1890 skip_braces(p); // eat {}
1893 else if (t.cs() == "ldots") {
1894 context.check_layout(os);
1896 os << "\\SpecialChar \\ldots{}\n";
1899 else if (t.cs() == "lyxarrow") {
1900 context.check_layout(os);
1901 os << "\\SpecialChar \\menuseparator\n";
1905 else if (t.cs() == "textcompwordmark") {
1906 context.check_layout(os);
1907 os << "\\SpecialChar \\textcompwordmark{}\n";
1911 else if (t.cs() == "@" && p.next_token().asInput() == ".") {
1912 context.check_layout(os);
1913 os << "\\SpecialChar \\@.\n";
1917 else if (t.cs() == "-") {
1918 context.check_layout(os);
1919 os << "\\SpecialChar \\-\n";
1922 else if (t.cs() == "textasciitilde") {
1923 context.check_layout(os);
1928 else if (t.cs() == "textasciicircum") {
1929 context.check_layout(os);
1934 else if (t.cs() == "textbackslash") {
1935 context.check_layout(os);
1936 os << "\n\\backslash\n";
1940 else if (t.cs() == "_" || t.cs() == "&" || t.cs() == "#"
1941 || t.cs() == "$" || t.cs() == "{" || t.cs() == "}"
1943 context.check_layout(os);
1947 else if (t.cs() == "char") {
1948 context.check_layout(os);
1949 if (p.next_token().character() == '`') {
1951 if (p.next_token().cs() == "\"") {
1956 handle_ert(os, "\\char`", context);
1959 handle_ert(os, "\\char", context);
1963 else if (t.cs() == "verb") {
1964 context.check_layout(os);
1965 char const delimiter = p.next_token().character();
1966 string const arg = p.getArg(delimiter, delimiter);
1968 oss << "\\verb" << delimiter << arg << delimiter;
1969 handle_ert(os, oss.str(), context);
1972 else if (t.cs() == "\"") {
1973 context.check_layout(os);
1974 string const name = p.verbatim_item();
1975 if (name == "a") os << 'ä';
1976 else if (name == "o") os << 'ö';
1977 else if (name == "u") os << 'ü';
1978 else if (name == "A") os << 'Ä';
1979 else if (name == "O") os << 'Ö';
1980 else if (name == "U") os << 'Ü';
1981 else handle_ert(os, "\"{" + name + "}", context);
1984 // Problem: \= creates a tabstop inside the tabbing environment
1985 // and else an accent. In the latter case we really would want
1986 // \={o} instead of \= o.
1987 else if (t.cs() == "=" && (flags & FLAG_TABBING))
1988 handle_ert(os, t.asInput(), context);
1990 else if (t.cs() == "H" || t.cs() == "c" || t.cs() == "^"
1991 || t.cs() == "'" || t.cs() == "`"
1992 || t.cs() == "~" || t.cs() == "." || t.cs() == "=") {
1993 // we need the trim as the LyX parser chokes on such spaces
1994 context.check_layout(os);
1995 os << "\n\\i \\" << t.cs() << "{"
1996 << trim(parse_text_snippet(p, FLAG_ITEM, outer, context), " ")
2000 else if (t.cs() == "ss") {
2001 context.check_layout(os);
2003 skip_braces(p); // eat {}
2006 else if (t.cs() == "i" || t.cs() == "j") {
2007 context.check_layout(os);
2008 os << "\\" << t.cs() << ' ';
2009 skip_braces(p); // eat {}
2012 else if (t.cs() == "\\") {
2013 context.check_layout(os);
2014 string const next = p.next_token().asInput();
2016 handle_ert(os, "\\\\" + p.getOpt(), context);
2017 else if (next == "*") {
2019 handle_ert(os, "\\\\*" + p.getOpt(), context);
2022 os << "\n\\newline\n";
2026 else if (t.cs() == "input" || t.cs() == "include"
2027 || t.cs() == "verbatiminput") {
2028 string name = '\\' + t.cs();
2029 if (t.cs() == "verbatiminput"
2030 && p.next_token().asInput() == "*")
2031 name += p.get_token().asInput();
2032 context.check_layout(os);
2033 begin_inset(os, "Include ");
2034 string filename(normalize_filename(p.getArg('{', '}')));
2035 string const path = getMasterFilePath();
2036 // We want to preserve relative / absolute filenames,
2037 // therefore path is only used for testing
2038 if (t.cs() == "include" &&
2039 !fs::exists(MakeAbsPath(filename, path))) {
2040 // The file extension is probably missing.
2041 // Now try to find it out.
2042 string const tex_name =
2043 find_file(filename, path,
2044 known_tex_extensions);
2045 if (!tex_name.empty())
2046 filename = tex_name;
2048 if (fs::exists(MakeAbsPath(filename, path))) {
2049 string const abstexname =
2050 MakeAbsPath(filename, path);
2051 string const abslyxname =
2052 ChangeExtension(abstexname, ".lyx");
2053 fix_relative_filename(filename);
2054 string const lyxname =
2055 ChangeExtension(filename, ".lyx");
2056 if (t.cs() != "verbatiminput" &&
2057 tex2lyx(abstexname, abslyxname)) {
2058 os << name << '{' << lyxname << "}\n";
2060 os << name << '{' << filename << "}\n";
2063 cerr << "Warning: Could not find included file '"
2064 << filename << "'." << endl;
2065 os << name << '{' << filename << "}\n";
2067 os << "preview false\n";
2071 else if (t.cs() == "bibliographystyle") {
2072 // store new bibliographystyle
2073 bibliographystyle = p.verbatim_item();
2074 // output new bibliographystyle.
2075 // This is only necessary if used in some other macro than \bibliography.
2076 handle_ert(os, "\\bibliographystyle{" + bibliographystyle + "}", context);
2079 else if (t.cs() == "bibliography") {
2080 context.check_layout(os);
2081 begin_inset(os, "LatexCommand ");
2083 // Do we have a bibliographystyle set?
2084 if (!bibliographystyle.empty()) {
2085 os << '[' << bibliographystyle << ']';
2087 os << '{' << p.verbatim_item() << "}\n";
2091 else if (t.cs() == "parbox")
2092 parse_box(p, os, FLAG_ITEM, outer, context, true);
2094 else if (t.cs() == "smallskip" ||
2095 t.cs() == "medskip" ||
2096 t.cs() == "bigskip" ||
2097 t.cs() == "vfill") {
2098 context.check_layout(os);
2099 begin_inset(os, "VSpace ");
2105 else if (t.cs() == "newpage") {
2106 context.check_layout(os);
2107 // FIXME: what about \\clearpage and \\pagebreak?
2108 os << "\n\\newpage\n";
2109 skip_braces(p); // eat {}
2112 else if (t.cs() == "newcommand" ||
2113 t.cs() == "providecommand" ||
2114 t.cs() == "renewcommand") {
2115 // these could be handled by parse_command(), but
2116 // we need to call add_known_command() here.
2117 string name = t.asInput();
2118 if (p.next_token().asInput() == "*") {
2119 // Starred form. Eat '*'
2123 string const command = p.verbatim_item();
2124 string const opt1 = p.getOpt();
2125 string const opt2 = p.getFullOpt();
2126 add_known_command(command, opt1, !opt2.empty());
2127 string const ert = name + '{' + command + '}' +
2129 '{' + p.verbatim_item() + '}';
2130 handle_ert(os, ert, context);
2133 else if (t.cs() == "vspace") {
2134 bool starred = false;
2135 if (p.next_token().asInput() == "*") {
2139 string const length = p.verbatim_item();
2142 bool valid = splitLatexLength(length, valstring, unit);
2143 bool known_vspace = false;
2144 bool known_unit = false;
2147 istringstream iss(valstring);
2150 if (unit == "\\smallskipamount") {
2152 known_vspace = true;
2153 } else if (unit == "\\medskipamount") {
2155 known_vspace = true;
2156 } else if (unit == "\\bigskipamount") {
2158 known_vspace = true;
2159 } else if (unit == "\\fill") {
2161 known_vspace = true;
2164 if (!known_vspace) {
2165 switch (unitFromString(unit)) {
2186 if (known_unit || known_vspace) {
2187 // Literal length or known variable
2188 context.check_layout(os);
2189 begin_inset(os, "VSpace ");
2197 // LyX can't handle other length variables in Inset VSpace
2198 string name = t.asInput();
2203 handle_ert(os, name + '{' + unit + '}', context);
2204 else if (value == -1.0)
2205 handle_ert(os, name + "{-" + unit + '}', context);
2207 handle_ert(os, name + '{' + valstring + unit + '}', context);
2209 handle_ert(os, name + '{' + length + '}', context);
2214 //cerr << "#: " << t << " mode: " << mode << endl;
2215 // heuristic: read up to next non-nested space
2217 string s = t.asInput();
2218 string z = p.verbatim_item();
2219 while (p.good() && z != " " && z.size()) {
2220 //cerr << "read: " << z << endl;
2222 z = p.verbatim_item();
2224 cerr << "found ERT: " << s << endl;
2225 handle_ert(os, s + ' ', context);
2227 string name = t.asInput();
2228 if (p.next_token().asInput() == "*") {
2229 // Starred commands like \vspace*{}
2230 p.get_token(); // Eat '*'
2233 if (! parse_command(name, p, os, outer, context))
2234 handle_ert(os, name, context);
2237 if (flags & FLAG_LEAVE) {
2238 flags &= ~FLAG_LEAVE;