]> git.lyx.org Git - lyx.git/blob - src/tex2lyx/text.cpp
e57784fc0782f7963716993b14b0be2076528ef1
[lyx.git] / src / tex2lyx / text.cpp
1 /**
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.
5  *
6  * \author André Pönitz
7  * \author Jean-Marc Lasgouttes
8  * \author Uwe Stöhr
9  *
10  * Full author contact details are available in file CREDITS.
11  */
12
13 // {[(
14
15 #include <config.h>
16
17 #include "tex2lyx.h"
18
19 #include "Context.h"
20 #include "Encoding.h"
21 #include "FloatList.h"
22 #include "LaTeXPackages.h"
23 #include "Layout.h"
24 #include "Length.h"
25 #include "Preamble.h"
26
27 #include "insets/ExternalTemplate.h"
28
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"
35
36 #include <algorithm>
37 #include <iostream>
38 #include <map>
39 #include <sstream>
40 #include <vector>
41
42 using namespace std;
43 using namespace lyx::support;
44
45 namespace lyx {
46
47
48 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
49                 Context const & context, InsetLayout const * layout)
50 {
51         bool const forcePlainLayout =
52                 layout ? layout->forcePlainLayout() : false;
53         Context newcontext(true, context.textclass);
54         if (forcePlainLayout)
55                 newcontext.layout = &context.textclass.plainLayout();
56         else
57                 newcontext.font = context.font;
58         parse_text(p, os, flags, outer, newcontext);
59         newcontext.check_end_layout(os);
60 }
61
62
63 namespace {
64
65 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
66                 Context const & context, string const & name)
67 {
68         InsetLayout const * layout = 0;
69         DocumentClass::InsetLayouts::const_iterator it =
70                 context.textclass.insetLayouts().find(from_ascii(name));
71         if (it != context.textclass.insetLayouts().end())
72                 layout = &(it->second);
73         parse_text_in_inset(p, os, flags, outer, context, layout);
74 }
75
76 /// parses a paragraph snippet, useful for example for \\emph{...}
77 void parse_text_snippet(Parser & p, ostream & os, unsigned flags, bool outer,
78                 Context & context)
79 {
80         Context newcontext(context);
81         // Don't inherit the paragraph-level extra stuff
82         newcontext.par_extra_stuff.clear();
83         parse_text(p, os, flags, outer, newcontext);
84         // Make sure that we don't create invalid .lyx files
85         context.need_layout = newcontext.need_layout;
86         context.need_end_layout = newcontext.need_end_layout;
87 }
88
89
90 /*!
91  * Thin wrapper around parse_text_snippet() using a string.
92  *
93  * We completely ignore \c context.need_layout and \c context.need_end_layout,
94  * because our return value is not used directly (otherwise the stream version
95  * of parse_text_snippet() could be used). That means that the caller needs
96  * to do layout management manually.
97  * This is intended to parse text that does not create any layout changes.
98  */
99 string parse_text_snippet(Parser & p, unsigned flags, const bool outer,
100                   Context & context)
101 {
102         Context newcontext(context);
103         newcontext.need_layout = false;
104         newcontext.need_end_layout = false;
105         newcontext.new_layout_allowed = false;
106         // Avoid warning by Context::~Context()
107         newcontext.par_extra_stuff.clear();
108         ostringstream os;
109         parse_text_snippet(p, os, flags, outer, newcontext);
110         return os.str();
111 }
112
113
114 char const * const known_ref_commands[] = { "ref", "pageref", "vref",
115  "vpageref", "prettyref", "eqref", 0 };
116
117 char const * const known_coded_ref_commands[] = { "ref", "pageref", "vref",
118  "vpageref", "formatted", "eqref", 0 };
119
120 /*!
121  * natbib commands.
122  * The starred forms are also known except for "citefullauthor",
123  * "citeyear" and "citeyearpar".
124  */
125 char const * const known_natbib_commands[] = { "cite", "citet", "citep",
126 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
127 "citefullauthor", "Citet", "Citep", "Citealt", "Citealp", "Citeauthor", 0 };
128
129 /*!
130  * jurabib commands.
131  * No starred form other than "cite*" known.
132  */
133 char const * const known_jurabib_commands[] = { "cite", "citet", "citep",
134 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
135 // jurabib commands not (yet) supported by LyX:
136 // "fullcite",
137 // "footcite", "footcitet", "footcitep", "footcitealt", "footcitealp",
138 // "footciteauthor", "footciteyear", "footciteyearpar",
139 "citefield", "citetitle", 0 };
140
141 /// LaTeX names for quotes
142 char const * const known_quotes[] = { "dq", "guillemotleft", "flqq", "og",
143 "guillemotright", "frqq", "fg", "glq", "glqq", "textquoteleft", "grq", "grqq",
144 "quotedblbase", "textquotedblleft", "quotesinglbase", "textquoteright", "flq",
145 "guilsinglleft", "frq", "guilsinglright", 0};
146
147 /// the same as known_quotes with .lyx names
148 char const * const known_coded_quotes[] = { "prd", "ard", "ard", "ard",
149 "ald", "ald", "ald", "gls", "gld", "els", "els", "grd",
150 "gld", "grd", "gls", "ers", "fls",
151 "fls", "frs", "frs", 0};
152
153 /// LaTeX names for font sizes
154 char const * const known_sizes[] = { "tiny", "scriptsize", "footnotesize",
155 "small", "normalsize", "large", "Large", "LARGE", "huge", "Huge", 0};
156
157 /// the same as known_sizes with .lyx names
158 char const * const known_coded_sizes[] = { "tiny", "scriptsize", "footnotesize",
159 "small", "normal", "large", "larger", "largest", "huge", "giant", 0};
160
161 /// LaTeX 2.09 names for font families
162 char const * const known_old_font_families[] = { "rm", "sf", "tt", 0};
163
164 /// LaTeX names for font families
165 char const * const known_font_families[] = { "rmfamily", "sffamily",
166 "ttfamily", 0};
167
168 /// LaTeX names for font family changing commands
169 char const * const known_text_font_families[] = { "textrm", "textsf",
170 "texttt", 0};
171
172 /// The same as known_old_font_families, known_font_families and
173 /// known_text_font_families with .lyx names
174 char const * const known_coded_font_families[] = { "roman", "sans",
175 "typewriter", 0};
176
177 /// LaTeX 2.09 names for font series
178 char const * const known_old_font_series[] = { "bf", 0};
179
180 /// LaTeX names for font series
181 char const * const known_font_series[] = { "bfseries", "mdseries", 0};
182
183 /// LaTeX names for font series changing commands
184 char const * const known_text_font_series[] = { "textbf", "textmd", 0};
185
186 /// The same as known_old_font_series, known_font_series and
187 /// known_text_font_series with .lyx names
188 char const * const known_coded_font_series[] = { "bold", "medium", 0};
189
190 /// LaTeX 2.09 names for font shapes
191 char const * const known_old_font_shapes[] = { "it", "sl", "sc", 0};
192
193 /// LaTeX names for font shapes
194 char const * const known_font_shapes[] = { "itshape", "slshape", "scshape",
195 "upshape", 0};
196
197 /// LaTeX names for font shape changing commands
198 char const * const known_text_font_shapes[] = { "textit", "textsl", "textsc",
199 "textup", 0};
200
201 /// The same as known_old_font_shapes, known_font_shapes and
202 /// known_text_font_shapes with .lyx names
203 char const * const known_coded_font_shapes[] = { "italic", "slanted",
204 "smallcaps", "up", 0};
205
206 /// Known special characters which need skip_spaces_braces() afterwards
207 char const * const known_special_chars[] = {"ldots", "lyxarrow",
208 "textcompwordmark", "slash", 0};
209
210 /// the same as known_special_chars with .lyx names
211 char const * const known_coded_special_chars[] = {"ldots{}", "menuseparator",
212 "textcompwordmark{}", "slash{}", 0};
213
214 /*!
215  * Graphics file extensions known by the dvips driver of the graphics package.
216  * These extensions are used to complete the filename of an included
217  * graphics file if it does not contain an extension.
218  * The order must be the same that latex uses to find a file, because we
219  * will use the first extension that matches.
220  * This is only an approximation for the common cases. If we would want to
221  * do it right in all cases, we would need to know which graphics driver is
222  * used and know the extensions of every driver of the graphics package.
223  */
224 char const * const known_dvips_graphics_formats[] = {"eps", "ps", "eps.gz",
225 "ps.gz", "eps.Z", "ps.Z", 0};
226
227 /*!
228  * Graphics file extensions known by the pdftex driver of the graphics package.
229  * \sa known_dvips_graphics_formats
230  */
231 char const * const known_pdftex_graphics_formats[] = {"png", "pdf", "jpg",
232 "mps", "tif", 0};
233
234 /*!
235  * Known file extensions for TeX files as used by \\include.
236  */
237 char const * const known_tex_extensions[] = {"tex", 0};
238
239 /// spaces known by InsetSpace
240 char const * const known_spaces[] = { " ", "space", ",",
241 "thinspace", "quad", "qquad", "enspace", "enskip",
242 "negthinspace", "negmedspace", "negthickspace", "textvisiblespace",
243 "hfill", "dotfill", "hrulefill", "leftarrowfill", "rightarrowfill",
244 "upbracefill", "downbracefill", 0};
245
246 /// the same as known_spaces with .lyx names
247 char const * const known_coded_spaces[] = { "space{}", "space{}",
248 "thinspace{}", "thinspace{}", "quad{}", "qquad{}", "enspace{}", "enskip{}",
249 "negthinspace{}", "negmedspace{}", "negthickspace{}", "textvisiblespace{}",
250 "hfill{}", "dotfill{}", "hrulefill{}", "leftarrowfill{}", "rightarrowfill{}",
251 "upbracefill{}", "downbracefill{}", 0};
252
253 /// These are translated by LyX to commands like "\\LyX{}", so we have to put
254 /// them in ERT. "LaTeXe" must come before "LaTeX"!
255 char const * const known_phrases[] = {"LyX", "TeX", "LaTeXe", "LaTeX", 0};
256 char const * const known_coded_phrases[] = {"LyX", "TeX", "LaTeX2e", "LaTeX", 0};
257 int const known_phrase_lengths[] = {3, 5, 7, 0};
258
259 // string to store the float type to be able to determine the type of subfloats
260 string float_type = "";
261
262
263 /// splits "x=z, y=b" into a map and an ordered keyword vector
264 void split_map(string const & s, map<string, string> & res, vector<string> & keys)
265 {
266         vector<string> v;
267         split(s, v);
268         res.clear();
269         keys.resize(v.size());
270         for (size_t i = 0; i < v.size(); ++i) {
271                 size_t const pos   = v[i].find('=');
272                 string const index = trimSpaceAndEol(v[i].substr(0, pos));
273                 string const value = trimSpaceAndEol(v[i].substr(pos + 1, string::npos));
274                 res[index] = value;
275                 keys[i] = index;
276         }
277 }
278
279
280 /*!
281  * Split a LaTeX length into value and unit.
282  * The latter can be a real unit like "pt", or a latex length variable
283  * like "\textwidth". The unit may contain additional stuff like glue
284  * lengths, but we don't care, because such lengths are ERT anyway.
285  * \returns true if \p value and \p unit are valid.
286  */
287 bool splitLatexLength(string const & len, string & value, string & unit)
288 {
289         if (len.empty())
290                 return false;
291         const string::size_type i = len.find_first_not_of(" -+0123456789.,");
292         //'4,5' is a valid LaTeX length number. Change it to '4.5'
293         string const length = subst(len, ',', '.');
294         if (i == string::npos)
295                 return false;
296         if (i == 0) {
297                 if (len[0] == '\\') {
298                         // We had something like \textwidth without a factor
299                         value = "1.0";
300                 } else {
301                         return false;
302                 }
303         } else {
304                 value = trimSpaceAndEol(string(length, 0, i));
305         }
306         if (value == "-")
307                 value = "-1.0";
308         // 'cM' is a valid LaTeX length unit. Change it to 'cm'
309         if (contains(len, '\\'))
310                 unit = trimSpaceAndEol(string(len, i));
311         else
312                 unit = ascii_lowercase(trimSpaceAndEol(string(len, i)));
313         return true;
314 }
315
316
317 /// A simple function to translate a latex length to something LyX can
318 /// understand. Not perfect, but rather best-effort.
319 bool translate_len(string const & length, string & valstring, string & unit)
320 {
321         if (!splitLatexLength(length, valstring, unit))
322                 return false;
323         // LyX uses percent values
324         double value;
325         istringstream iss(valstring);
326         iss >> value;
327         value *= 100;
328         ostringstream oss;
329         oss << value;
330         string const percentval = oss.str();
331         // a normal length
332         if (unit.empty() || unit[0] != '\\')
333                 return true;
334         string::size_type const i = unit.find(' ');
335         string const endlen = (i == string::npos) ? string() : string(unit, i);
336         if (unit == "\\textwidth") {
337                 valstring = percentval;
338                 unit = "text%" + endlen;
339         } else if (unit == "\\columnwidth") {
340                 valstring = percentval;
341                 unit = "col%" + endlen;
342         } else if (unit == "\\paperwidth") {
343                 valstring = percentval;
344                 unit = "page%" + endlen;
345         } else if (unit == "\\linewidth") {
346                 valstring = percentval;
347                 unit = "line%" + endlen;
348         } else if (unit == "\\paperheight") {
349                 valstring = percentval;
350                 unit = "pheight%" + endlen;
351         } else if (unit == "\\textheight") {
352                 valstring = percentval;
353                 unit = "theight%" + endlen;
354         }
355         return true;
356 }
357
358 }
359
360
361 string translate_len(string const & length)
362 {
363         string unit;
364         string value;
365         if (translate_len(length, value, unit))
366                 return value + unit;
367         // If the input is invalid, return what we have.
368         return length;
369 }
370
371
372 namespace {
373
374 /*!
375  * Translates a LaTeX length into \p value, \p unit and
376  * \p special parts suitable for a box inset.
377  * The difference from translate_len() is that a box inset knows about
378  * some special "units" that are stored in \p special.
379  */
380 void translate_box_len(string const & length, string & value, string & unit, string & special)
381 {
382         if (translate_len(length, value, unit)) {
383                 if (unit == "\\height" || unit == "\\depth" ||
384                     unit == "\\totalheight" || unit == "\\width") {
385                         special = unit.substr(1);
386                         // The unit is not used, but LyX requires a dummy setting
387                         unit = "in";
388                 } else
389                         special = "none";
390         } else {
391                 value.clear();
392                 unit = length;
393                 special = "none";
394         }
395 }
396
397
398 /*!
399  * Find a file with basename \p name in path \p path and an extension
400  * in \p extensions.
401  */
402 string find_file(string const & name, string const & path,
403                  char const * const * extensions)
404 {
405         for (char const * const * what = extensions; *what; ++what) {
406                 string const trial = addExtension(name, *what);
407                 if (makeAbsPath(trial, path).exists())
408                         return trial;
409         }
410         return string();
411 }
412
413
414 void begin_inset(ostream & os, string const & name)
415 {
416         os << "\n\\begin_inset " << name;
417 }
418
419
420 void begin_command_inset(ostream & os, string const & name,
421                          string const & latexname)
422 {
423         begin_inset(os, "CommandInset ");
424         os << name << "\nLatexCommand " << latexname << '\n';
425 }
426
427
428 void end_inset(ostream & os)
429 {
430         os << "\n\\end_inset\n\n";
431 }
432
433
434 bool skip_braces(Parser & p)
435 {
436         if (p.next_token().cat() != catBegin)
437                 return false;
438         p.get_token();
439         if (p.next_token().cat() == catEnd) {
440                 p.get_token();
441                 return true;
442         }
443         p.putback();
444         return false;
445 }
446
447
448 /// replace LaTeX commands in \p s from the unicodesymbols file with their
449 /// unicode points
450 docstring convert_unicodesymbols(docstring s)
451 {
452         odocstringstream os;
453         for (size_t i = 0; i < s.size();) {
454                 if (s[i] != '\\') {
455                         os.put(s[i++]);
456                         continue;
457                 }
458                 s = s.substr(i);
459                 docstring rem;
460                 set<string> req;
461                 docstring parsed = encodings.fromLaTeXCommand(s,
462                                 Encodings::TEXT_CMD, rem, &req);
463                 for (set<string>::const_iterator it = req.begin(); it != req.end(); it++)
464                         preamble.registerAutomaticallyLoadedPackage(*it);
465                 os << parsed;
466                 s = rem;
467                 if (s.empty() || s[0] != '\\')
468                         i = 0;
469                 else
470                         i = 1;
471         }
472         return os.str();
473 }
474
475
476 /// try to convert \p s to a valid InsetCommand argument
477 string convert_command_inset_arg(string s)
478 {
479         if (isAscii(s))
480                 // since we don't know the input encoding we can't use from_utf8
481                 s = to_utf8(convert_unicodesymbols(from_ascii(s)));
482         // LyX cannot handle newlines in a latex command
483         return subst(s, "\n", " ");
484 }
485
486
487 void handle_backslash(ostream & os, string const & s)
488 {
489         for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
490                 if (*it == '\\')
491                         os << "\n\\backslash\n";
492                 else
493                         os << *it;
494         }
495 }
496
497
498 void handle_ert(ostream & os, string const & s, Context & context)
499 {
500         // We must have a valid layout before outputting the ERT inset.
501         context.check_layout(os);
502         Context newcontext(true, context.textclass);
503         begin_inset(os, "ERT");
504         os << "\nstatus collapsed\n";
505         newcontext.check_layout(os);
506         for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
507                 if (*it == '\\')
508                         os << "\n\\backslash\n";
509                 else if (*it == '\n') {
510                         newcontext.new_paragraph(os);
511                         newcontext.check_layout(os);
512                 } else
513                         os << *it;
514         }
515         newcontext.check_end_layout(os);
516         end_inset(os);
517 }
518
519
520 void handle_comment(ostream & os, string const & s, Context & context)
521 {
522         // TODO: Handle this better
523         Context newcontext(true, context.textclass);
524         begin_inset(os, "ERT");
525         os << "\nstatus collapsed\n";
526         newcontext.check_layout(os);
527         handle_backslash(os, s);
528         // make sure that our comment is the last thing on the line
529         newcontext.new_paragraph(os);
530         newcontext.check_layout(os);
531         newcontext.check_end_layout(os);
532         end_inset(os);
533 }
534
535
536 Layout const * findLayout(TextClass const & textclass, string const & name, bool command)
537 {
538         Layout const * layout = findLayoutWithoutModule(textclass, name, command);
539         if (layout)
540                 return layout;
541         if (checkModule(name, command))
542                 return findLayoutWithoutModule(textclass, name, command);
543         return layout;
544 }
545
546
547 InsetLayout const * findInsetLayout(TextClass const & textclass, string const & name, bool command)
548 {
549         InsetLayout const * insetlayout = findInsetLayoutWithoutModule(textclass, name, command);
550         if (insetlayout)
551                 return insetlayout;
552         if (checkModule(name, command))
553                 return findInsetLayoutWithoutModule(textclass, name, command);
554         return insetlayout;
555 }
556
557
558 void eat_whitespace(Parser &, ostream &, Context &, bool);
559
560
561 /*!
562  * Skips whitespace and braces.
563  * This should be called after a command has been parsed that is not put into
564  * ERT, and where LyX adds "{}" if needed.
565  */
566 void skip_spaces_braces(Parser & p, bool keepws = false)
567 {
568         /* The following four examples produce the same typeset output and
569            should be handled by this function:
570            - abc \j{} xyz
571            - abc \j {} xyz
572            - abc \j
573              {} xyz
574            - abc \j %comment
575              {} xyz
576          */
577         // Unfortunately we need to skip comments, too.
578         // We can't use eat_whitespace since writing them after the {}
579         // results in different output in some cases.
580         bool const skipped_spaces = p.skip_spaces(true);
581         bool const skipped_braces = skip_braces(p);
582         if (keepws && skipped_spaces && !skipped_braces)
583                 // put back the space (it is better handled by check_space)
584                 p.unskip_spaces(true);
585 }
586
587
588 void output_command_layout(ostream & os, Parser & p, bool outer,
589                            Context & parent_context,
590                            Layout const * newlayout)
591 {
592         TeXFont const oldFont = parent_context.font;
593         // save the current font size
594         string const size = oldFont.size;
595         // reset the font size to default, because the font size switches
596         // don't affect section headings and the like
597         parent_context.font.size = Context::normalfont.size;
598         // we only need to write the font change if we have an open layout
599         if (!parent_context.atParagraphStart())
600                 output_font_change(os, oldFont, parent_context.font);
601         parent_context.check_end_layout(os);
602         Context context(true, parent_context.textclass, newlayout,
603                         parent_context.layout, parent_context.font);
604         if (parent_context.deeper_paragraph) {
605                 // We are beginning a nested environment after a
606                 // deeper paragraph inside the outer list environment.
607                 // Therefore we don't need to output a "begin deeper".
608                 context.need_end_deeper = true;
609         }
610         context.check_deeper(os);
611         context.check_layout(os);
612         unsigned int optargs = 0;
613         while (optargs < context.layout->optargs) {
614                 eat_whitespace(p, os, context, false);
615                 if (p.next_token().cat() == catEscape ||
616                     p.next_token().character() != '[')
617                         break;
618                 p.get_token(); // eat '['
619                 begin_inset(os, "Argument\n");
620                 os << "status collapsed\n\n";
621                 parse_text_in_inset(p, os, FLAG_BRACK_LAST, outer, context);
622                 end_inset(os);
623                 eat_whitespace(p, os, context, false);
624                 ++optargs;
625         }
626         unsigned int reqargs = 0;
627         while (reqargs < context.layout->reqargs) {
628                 eat_whitespace(p, os, context, false);
629                 if (p.next_token().cat() != catBegin)
630                         break;
631                 p.get_token(); // eat '{'
632                 begin_inset(os, "Argument\n");
633                 os << "status collapsed\n\n";
634                 parse_text_in_inset(p, os, FLAG_BRACE_LAST, outer, context);
635                 end_inset(os);
636                 eat_whitespace(p, os, context, false);
637                 ++reqargs;
638         }
639         parse_text(p, os, FLAG_ITEM, outer, context);
640         context.check_end_layout(os);
641         if (parent_context.deeper_paragraph) {
642                 // We must suppress the "end deeper" because we
643                 // suppressed the "begin deeper" above.
644                 context.need_end_deeper = false;
645         }
646         context.check_end_deeper(os);
647         // We don't need really a new paragraph, but
648         // we must make sure that the next item gets a \begin_layout.
649         parent_context.new_paragraph(os);
650         // Set the font size to the original value. No need to output it here
651         // (Context::begin_layout() will do that if needed)
652         parent_context.font.size = size;
653 }
654
655
656 /*!
657  * Output a space if necessary.
658  * This function gets called for every whitespace token.
659  *
660  * We have three cases here:
661  * 1. A space must be suppressed. Example: The lyxcode case below
662  * 2. A space may be suppressed. Example: Spaces before "\par"
663  * 3. A space must not be suppressed. Example: A space between two words
664  *
665  * We currently handle only 1. and 3 and from 2. only the case of
666  * spaces before newlines as a side effect.
667  *
668  * 2. could be used to suppress as many spaces as possible. This has two effects:
669  * - Reimporting LyX generated LaTeX files changes almost no whitespace
670  * - Superflous whitespace from non LyX generated LaTeX files is removed.
671  * The drawback is that the logic inside the function becomes
672  * complicated, and that is the reason why it is not implemented.
673  */
674 void check_space(Parser & p, ostream & os, Context & context)
675 {
676         Token const next = p.next_token();
677         Token const curr = p.curr_token();
678         // A space before a single newline and vice versa must be ignored
679         // LyX emits a newline before \end{lyxcode}.
680         // This newline must be ignored,
681         // otherwise LyX will add an additional protected space.
682         if (next.cat() == catSpace ||
683             next.cat() == catNewline ||
684             (next.cs() == "end" && context.layout->free_spacing && curr.cat() == catNewline)) {
685                 return;
686         }
687         context.check_layout(os);
688         os << ' ';
689 }
690
691
692 /*!
693  * Parse all arguments of \p command
694  */
695 void parse_arguments(string const & command,
696                      vector<ArgumentType> const & template_arguments,
697                      Parser & p, ostream & os, bool outer, Context & context)
698 {
699         string ert = command;
700         size_t no_arguments = template_arguments.size();
701         for (size_t i = 0; i < no_arguments; ++i) {
702                 switch (template_arguments[i]) {
703                 case required:
704                 case req_group:
705                         // This argument contains regular LaTeX
706                         handle_ert(os, ert + '{', context);
707                         eat_whitespace(p, os, context, false);
708                         if (template_arguments[i] == required)
709                                 parse_text(p, os, FLAG_ITEM, outer, context);
710                         else
711                                 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
712                         ert = "}";
713                         break;
714                 case item:
715                         // This argument consists only of a single item.
716                         // The presence of '{' or not must be preserved.
717                         p.skip_spaces();
718                         if (p.next_token().cat() == catBegin)
719                                 ert += '{' + p.verbatim_item() + '}';
720                         else
721                                 ert += p.verbatim_item();
722                         break;
723                 case displaymath:
724                 case verbatim:
725                         // This argument may contain special characters
726                         ert += '{' + p.verbatim_item() + '}';
727                         break;
728                 case optional:
729                 case opt_group:
730                         // true because we must not eat whitespace
731                         // if an optional arg follows we must not strip the
732                         // brackets from this one
733                         if (i < no_arguments - 1 &&
734                             template_arguments[i+1] == optional)
735                                 ert += p.getFullOpt(true);
736                         else
737                                 ert += p.getOpt(true);
738                         break;
739                 }
740         }
741         handle_ert(os, ert, context);
742 }
743
744
745 /*!
746  * Check whether \p command is a known command. If yes,
747  * handle the command with all arguments.
748  * \return true if the command was parsed, false otherwise.
749  */
750 bool parse_command(string const & command, Parser & p, ostream & os,
751                    bool outer, Context & context)
752 {
753         if (known_commands.find(command) != known_commands.end()) {
754                 parse_arguments(command, known_commands[command], p, os,
755                                 outer, context);
756                 return true;
757         }
758         return false;
759 }
760
761
762 /// Parses a minipage or parbox
763 void parse_box(Parser & p, ostream & os, unsigned outer_flags,
764                unsigned inner_flags, bool outer, Context & parent_context,
765                string const & outer_type, string const & special,
766                string const & inner_type)
767 {
768         string position;
769         string inner_pos;
770         string hor_pos = "c";
771         // We need to set the height to the LaTeX default of 1\\totalheight
772         // for the case when no height argument is given
773         string height_value = "1";
774         string height_unit = "in";
775         string height_special = "totalheight";
776         string latex_height;
777         string width_value;
778         string width_unit;
779         string latex_width;
780         string width_special = "none";
781         if (!inner_type.empty() && p.hasOpt()) {
782                 if (inner_type != "makebox")
783                         position = p.getArg('[', ']');
784                 else {
785                         latex_width = p.getArg('[', ']');
786                         translate_box_len(latex_width, width_value, width_unit, width_special);
787                         position = "t";
788                 }
789                 if (position != "t" && position != "c" && position != "b") {
790                         cerr << "invalid position " << position << " for "
791                              << inner_type << endl;
792                         position = "c";
793                 }
794                 if (p.hasOpt()) {
795                         if (inner_type != "makebox") {
796                                 latex_height = p.getArg('[', ']');
797                                 translate_box_len(latex_height, height_value, height_unit, height_special);
798                         } else
799                                 hor_pos = p.getArg('[', ']');
800
801                         if (p.hasOpt()) {
802                                 inner_pos = p.getArg('[', ']');
803                                 if (inner_pos != "c" && inner_pos != "t" &&
804                                     inner_pos != "b" && inner_pos != "s") {
805                                         cerr << "invalid inner_pos "
806                                              << inner_pos << " for "
807                                              << inner_type << endl;
808                                         inner_pos = position;
809                                 }
810                         }
811                 }
812         }
813         if (inner_type.empty()) {
814                 if (special.empty() && outer_type != "framebox")
815                         latex_width = "1\\columnwidth";
816                 else {
817                         Parser p2(special);
818                         latex_width = p2.getArg('[', ']');
819                         string const opt = p2.getArg('[', ']');
820                         if (!opt.empty()) {
821                                 hor_pos = opt;
822                                 if (hor_pos != "l" && hor_pos != "c" &&
823                                     hor_pos != "r") {
824                                         cerr << "invalid hor_pos " << hor_pos
825                                              << " for " << outer_type << endl;
826                                         hor_pos = "c";
827                                 }
828                         }
829                 }
830         } else if (inner_type != "makebox")
831                 latex_width = p.verbatim_item();
832         // if e.g. only \ovalbox{content} was used, set the width to 1\columnwidth
833         // as this is LyX's standard for such cases (except for makebox)
834         // \framebox is more special and handled below
835         if (latex_width.empty() && inner_type != "makebox"
836                 && outer_type != "framebox")
837                 latex_width = "1\\columnwidth";
838
839         translate_len(latex_width, width_value, width_unit);
840
841         bool shadedparbox = false;
842         if (inner_type == "shaded") {
843                 eat_whitespace(p, os, parent_context, false);
844                 if (outer_type == "parbox") {
845                         // Eat '{'
846                         if (p.next_token().cat() == catBegin)
847                                 p.get_token();
848                         eat_whitespace(p, os, parent_context, false);
849                         shadedparbox = true;
850                 }
851                 p.get_token();
852                 p.getArg('{', '}');
853         }
854         // If we already read the inner box we have to push the inner env
855         if (!outer_type.empty() && !inner_type.empty() &&
856             (inner_flags & FLAG_END))
857                 active_environments.push_back(inner_type);
858         // LyX can't handle length variables
859         bool use_ert = contains(width_unit, '\\') || contains(height_unit, '\\');
860         if (!use_ert && !outer_type.empty() && !inner_type.empty()) {
861                 // Look whether there is some content after the end of the
862                 // inner box, but before the end of the outer box.
863                 // If yes, we need to output ERT.
864                 p.pushPosition();
865                 if (inner_flags & FLAG_END)
866                         p.verbatimEnvironment(inner_type);
867                 else
868                         p.verbatim_item();
869                 p.skip_spaces(true);
870                 bool const outer_env(outer_type == "framed" || outer_type == "minipage");
871                 if ((outer_env && p.next_token().asInput() != "\\end") ||
872                     (!outer_env && p.next_token().cat() != catEnd)) {
873                         // something is between the end of the inner box and
874                         // the end of the outer box, so we need to use ERT.
875                         use_ert = true;
876                 }
877                 p.popPosition();
878         }
879         // if only \makebox{content} was used we can set its width to 1\width
880         // because this identic and also identic to \mbox
881         // this doesn't work for \framebox{content}, thus we have to use ERT for this
882         if (latex_width.empty() && inner_type == "makebox") {
883                 width_value = "1";
884                 width_unit = "in";
885                 width_special = "width";
886         } else if (latex_width.empty() && outer_type == "framebox") {
887                 use_ert = true;
888         }
889         if (use_ert) {
890                 ostringstream ss;
891                 if (!outer_type.empty()) {
892                         if (outer_flags & FLAG_END)
893                                 ss << "\\begin{" << outer_type << '}';
894                         else {
895                                 ss << '\\' << outer_type << '{';
896                                 if (!special.empty())
897                                         ss << special;
898                         }
899                 }
900                 if (!inner_type.empty()) {
901                         if (inner_type != "shaded") {
902                                 if (inner_flags & FLAG_END)
903                                         ss << "\\begin{" << inner_type << '}';
904                                 else
905                                         ss << '\\' << inner_type;
906                         }
907                         if (!position.empty())
908                                 ss << '[' << position << ']';
909                         if (!latex_height.empty())
910                                 ss << '[' << latex_height << ']';
911                         if (!inner_pos.empty())
912                                 ss << '[' << inner_pos << ']';
913                         ss << '{' << latex_width << '}';
914                         if (!(inner_flags & FLAG_END))
915                                 ss << '{';
916                 }
917                 if (inner_type == "shaded")
918                         ss << "\\begin{shaded}";
919                 handle_ert(os, ss.str(), parent_context);
920                 if (!inner_type.empty()) {
921                         parse_text(p, os, inner_flags, outer, parent_context);
922                         if (inner_flags & FLAG_END)
923                                 handle_ert(os, "\\end{" + inner_type + '}',
924                                            parent_context);
925                         else
926                                 handle_ert(os, "}", parent_context);
927                 }
928                 if (!outer_type.empty()) {
929                         // If we already read the inner box we have to pop
930                         // the inner env
931                         if (!inner_type.empty() && (inner_flags & FLAG_END))
932                                 active_environments.pop_back();
933
934                         // Ensure that the end of the outer box is parsed correctly:
935                         // The opening brace has been eaten by parse_outer_box()
936                         if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
937                                 outer_flags &= ~FLAG_ITEM;
938                                 outer_flags |= FLAG_BRACE_LAST;
939                         }
940                         parse_text(p, os, outer_flags, outer, parent_context);
941                         if (outer_flags & FLAG_END)
942                                 handle_ert(os, "\\end{" + outer_type + '}',
943                                            parent_context);
944                         else if (inner_type.empty() && outer_type == "framebox")
945                                 // in this case it is already closed later
946                                 ;
947                         else
948                                 handle_ert(os, "}", parent_context);
949                 }
950         } else {
951                 // LyX does not like empty positions, so we have
952                 // to set them to the LaTeX default values here.
953                 if (position.empty())
954                         position = "c";
955                 if (inner_pos.empty())
956                         inner_pos = position;
957                 parent_context.check_layout(os);
958                 begin_inset(os, "Box ");
959                 if (outer_type == "framed")
960                         os << "Framed\n";
961                 else if (outer_type == "framebox")
962                         os << "Boxed\n";
963                 else if (outer_type == "shadowbox")
964                         os << "Shadowbox\n";
965                 else if ((outer_type == "shaded" && inner_type.empty()) ||
966                              (outer_type == "minipage" && inner_type == "shaded") ||
967                              (outer_type == "parbox" && inner_type == "shaded")) {
968                         os << "Shaded\n";
969                         preamble.registerAutomaticallyLoadedPackage("color");
970                 } else if (outer_type == "doublebox")
971                         os << "Doublebox\n";
972                 else if (outer_type.empty())
973                         os << "Frameless\n";
974                 else
975                         os << outer_type << '\n';
976                 os << "position \"" << position << "\"\n";
977                 os << "hor_pos \"" << hor_pos << "\"\n";
978                 os << "has_inner_box " << !inner_type.empty() << "\n";
979                 os << "inner_pos \"" << inner_pos << "\"\n";
980                 os << "use_parbox " << (inner_type == "parbox" || shadedparbox)
981                    << '\n';
982                 os << "use_makebox " << (inner_type == "makebox") << '\n';
983                 os << "width \"" << width_value << width_unit << "\"\n";
984                 os << "special \"" << width_special << "\"\n";
985                 os << "height \"" << height_value << height_unit << "\"\n";
986                 os << "height_special \"" << height_special << "\"\n";
987                 os << "status open\n\n";
988
989                 // Unfortunately we can't use parse_text_in_inset:
990                 // InsetBox::forcePlainLayout() is hard coded and does not
991                 // use the inset layout. Apart from that do we call parse_text
992                 // up to two times, but need only one check_end_layout.
993                 bool const forcePlainLayout =
994                         (!inner_type.empty() || inner_type == "makebox") &&
995                         outer_type != "shaded" && outer_type != "framed";
996                 Context context(true, parent_context.textclass);
997                 if (forcePlainLayout)
998                         context.layout = &context.textclass.plainLayout();
999                 else
1000                         context.font = parent_context.font;
1001
1002                 // If we have no inner box the contents will be read with the outer box
1003                 if (!inner_type.empty())
1004                         parse_text(p, os, inner_flags, outer, context);
1005
1006                 // Ensure that the end of the outer box is parsed correctly:
1007                 // The opening brace has been eaten by parse_outer_box()
1008                 if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1009                         outer_flags &= ~FLAG_ITEM;
1010                         outer_flags |= FLAG_BRACE_LAST;
1011                 }
1012
1013                 // Find end of outer box, output contents if inner_type is
1014                 // empty and output possible comments
1015                 if (!outer_type.empty()) {
1016                         // If we already read the inner box we have to pop
1017                         // the inner env
1018                         if (!inner_type.empty() && (inner_flags & FLAG_END))
1019                                 active_environments.pop_back();
1020                         // This does not output anything but comments if
1021                         // inner_type is not empty (see use_ert)
1022                         parse_text(p, os, outer_flags, outer, context);
1023                 }
1024
1025                 context.check_end_layout(os);
1026                 end_inset(os);
1027 #ifdef PRESERVE_LAYOUT
1028                 // LyX puts a % after the end of the minipage
1029                 if (p.next_token().cat() == catNewline && p.next_token().cs().size() > 1) {
1030                         // new paragraph
1031                         //handle_comment(os, "%dummy", parent_context);
1032                         p.get_token();
1033                         p.skip_spaces();
1034                         parent_context.new_paragraph(os);
1035                 }
1036                 else if (p.next_token().cat() == catSpace || p.next_token().cat() == catNewline) {
1037                         //handle_comment(os, "%dummy", parent_context);
1038                         p.get_token();
1039                         p.skip_spaces();
1040                         // We add a protected space if something real follows
1041                         if (p.good() && p.next_token().cat() != catComment) {
1042                                 begin_inset(os, "space ~\n");
1043                                 end_inset(os);
1044                         }
1045                 }
1046 #endif
1047         }
1048 }
1049
1050
1051 void parse_outer_box(Parser & p, ostream & os, unsigned flags, bool outer,
1052                      Context & parent_context, string const & outer_type,
1053                      string const & special)
1054 {
1055         eat_whitespace(p, os, parent_context, false);
1056         if (flags & FLAG_ITEM) {
1057                 // Eat '{'
1058                 if (p.next_token().cat() == catBegin)
1059                         p.get_token();
1060                 else
1061                         cerr << "Warning: Ignoring missing '{' after \\"
1062                              << outer_type << '.' << endl;
1063                 eat_whitespace(p, os, parent_context, false);
1064         }
1065         string inner;
1066         unsigned int inner_flags = 0;
1067         p.pushPosition();
1068         if (outer_type == "minipage" || outer_type == "parbox") {
1069                 p.skip_spaces(true);
1070                 while (p.hasOpt()) {
1071                         p.getArg('[', ']');
1072                         p.skip_spaces(true);
1073                 }
1074                 p.getArg('{', '}');
1075                 p.skip_spaces(true);
1076                 if (outer_type == "parbox") {
1077                         // Eat '{'
1078                         if (p.next_token().cat() == catBegin)
1079                                 p.get_token();
1080                         p.skip_spaces(true);
1081                 }
1082         }
1083         if (outer_type == "shaded") {
1084                 // These boxes never have an inner box
1085                 ;
1086         } else if (p.next_token().asInput() == "\\parbox") {
1087                 inner = p.get_token().cs();
1088                 inner_flags = FLAG_ITEM;
1089         } else if (p.next_token().asInput() == "\\begin") {
1090                 // Is this a minipage or shaded box?
1091                 p.pushPosition();
1092                 p.get_token();
1093                 inner = p.getArg('{', '}');
1094                 p.popPosition();
1095                 if (inner == "minipage" || inner == "shaded")
1096                         inner_flags = FLAG_END;
1097                 else
1098                         inner = "";
1099         }
1100         p.popPosition();
1101         if (inner_flags == FLAG_END) {
1102                 if (inner != "shaded")
1103                 {
1104                         p.get_token();
1105                         p.getArg('{', '}');
1106                         eat_whitespace(p, os, parent_context, false);
1107                 }
1108                 parse_box(p, os, flags, FLAG_END, outer, parent_context,
1109                           outer_type, special, inner);
1110         } else {
1111                 if (inner_flags == FLAG_ITEM) {
1112                         p.get_token();
1113                         eat_whitespace(p, os, parent_context, false);
1114                 }
1115                 parse_box(p, os, flags, inner_flags, outer, parent_context,
1116                           outer_type, special, inner);
1117         }
1118 }
1119
1120
1121 void parse_listings(Parser & p, ostream & os, Context & parent_context)
1122 {
1123         parent_context.check_layout(os);
1124         begin_inset(os, "listings\n");
1125         os << "inline false\n"
1126            << "status collapsed\n";
1127         Context context(true, parent_context.textclass);
1128         context.layout = &parent_context.textclass.plainLayout();
1129         context.check_layout(os);
1130         string const s = p.verbatimEnvironment("lstlisting");
1131         for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
1132                 if (*it == '\\')
1133                         os << "\n\\backslash\n";
1134                 else if (*it == '\n') {
1135                         // avoid adding an empty paragraph at the end
1136                         if (it + 1 != et) {
1137                                 context.new_paragraph(os);
1138                                 context.check_layout(os);
1139                         }
1140                 } else
1141                         os << *it;
1142         }
1143         context.check_end_layout(os);
1144         end_inset(os);
1145 }
1146
1147
1148 /// parse an unknown environment
1149 void parse_unknown_environment(Parser & p, string const & name, ostream & os,
1150                                unsigned flags, bool outer,
1151                                Context & parent_context)
1152 {
1153         if (name == "tabbing")
1154                 // We need to remember that we have to handle '\=' specially
1155                 flags |= FLAG_TABBING;
1156
1157         // We need to translate font changes and paragraphs inside the
1158         // environment to ERT if we have a non standard font.
1159         // Otherwise things like
1160         // \large\begin{foo}\huge bar\end{foo}
1161         // will not work.
1162         bool const specialfont =
1163                 (parent_context.font != parent_context.normalfont);
1164         bool const new_layout_allowed = parent_context.new_layout_allowed;
1165         if (specialfont)
1166                 parent_context.new_layout_allowed = false;
1167         handle_ert(os, "\\begin{" + name + "}", parent_context);
1168         parse_text_snippet(p, os, flags, outer, parent_context);
1169         handle_ert(os, "\\end{" + name + "}", parent_context);
1170         if (specialfont)
1171                 parent_context.new_layout_allowed = new_layout_allowed;
1172 }
1173
1174
1175 void parse_environment(Parser & p, ostream & os, bool outer,
1176                        string & last_env, bool & title_layout_found,
1177                        Context & parent_context)
1178 {
1179         Layout const * newlayout;
1180         InsetLayout const * newinsetlayout = 0;
1181         string const name = p.getArg('{', '}');
1182         const bool is_starred = suffixIs(name, '*');
1183         string const unstarred_name = rtrim(name, "*");
1184         active_environments.push_back(name);
1185
1186         if (is_math_env(name)) {
1187                 parent_context.check_layout(os);
1188                 begin_inset(os, "Formula ");
1189                 os << "\\begin{" << name << "}";
1190                 parse_math(p, os, FLAG_END, MATH_MODE);
1191                 os << "\\end{" << name << "}";
1192                 end_inset(os);
1193                 if (is_display_math_env(name)) {
1194                         // Prevent the conversion of a line break to a space
1195                         // (bug 7668). This does not change the output, but
1196                         // looks ugly in LyX.
1197                         eat_whitespace(p, os, parent_context, false);
1198                 }
1199         }
1200
1201         else if (unstarred_name == "tabular" || name == "longtable") {
1202                 eat_whitespace(p, os, parent_context, false);
1203                 string width = "0pt";
1204                 if (name == "tabular*") {
1205                         width = lyx::translate_len(p.getArg('{', '}'));
1206                         eat_whitespace(p, os, parent_context, false);
1207                 }
1208                 parent_context.check_layout(os);
1209                 begin_inset(os, "Tabular ");
1210                 handle_tabular(p, os, name, width, parent_context);
1211                 end_inset(os);
1212                 p.skip_spaces();
1213         }
1214
1215         else if (parent_context.textclass.floats().typeExist(unstarred_name)) {
1216                 eat_whitespace(p, os, parent_context, false);
1217                 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1218                 eat_whitespace(p, os, parent_context, false);
1219                 parent_context.check_layout(os);
1220                 begin_inset(os, "Float " + unstarred_name + "\n");
1221                 // store the float type for subfloats
1222                 // subfloats only work with figures and tables
1223                 if (unstarred_name == "figure")
1224                         float_type = unstarred_name;
1225                 else if (unstarred_name == "table")
1226                         float_type = unstarred_name;
1227                 else
1228                         float_type = "";
1229                 if (!opt.empty())
1230                         os << "placement " << opt << '\n';
1231                 if (contains(opt, "H"))
1232                         preamble.registerAutomaticallyLoadedPackage("float");
1233                 else {
1234                         Floating const & fl = parent_context.textclass.floats()
1235                                 .getType(unstarred_name);
1236                         if (!fl.floattype().empty() && fl.usesFloatPkg())
1237                                 preamble.registerAutomaticallyLoadedPackage("float");
1238                 }
1239
1240                 os << "wide " << convert<string>(is_starred)
1241                    << "\nsideways false"
1242                    << "\nstatus open\n\n";
1243                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1244                 end_inset(os);
1245                 // We don't need really a new paragraph, but
1246                 // we must make sure that the next item gets a \begin_layout.
1247                 parent_context.new_paragraph(os);
1248                 p.skip_spaces();
1249                 // the float is parsed thus delete the type
1250                 float_type = "";
1251         }
1252
1253         else if (unstarred_name == "sidewaysfigure"
1254                 || unstarred_name == "sidewaystable") {
1255                 eat_whitespace(p, os, parent_context, false);
1256                 parent_context.check_layout(os);
1257                 if (unstarred_name == "sidewaysfigure")
1258                         begin_inset(os, "Float figure\n");
1259                 else
1260                         begin_inset(os, "Float table\n");
1261                 os << "wide " << convert<string>(is_starred)
1262                    << "\nsideways true"
1263                    << "\nstatus open\n\n";
1264                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1265                 end_inset(os);
1266                 // We don't need really a new paragraph, but
1267                 // we must make sure that the next item gets a \begin_layout.
1268                 parent_context.new_paragraph(os);
1269                 p.skip_spaces();
1270                 preamble.registerAutomaticallyLoadedPackage("rotfloat");
1271         }
1272
1273         else if (name == "wrapfigure" || name == "wraptable") {
1274                 // syntax is \begin{wrapfigure}[lines]{placement}[overhang]{width}
1275                 eat_whitespace(p, os, parent_context, false);
1276                 parent_context.check_layout(os);
1277                 // default values
1278                 string lines = "0";
1279                 string overhang = "0col%";
1280                 // parse
1281                 if (p.hasOpt())
1282                         lines = p.getArg('[', ']');
1283                 string const placement = p.getArg('{', '}');
1284                 if (p.hasOpt())
1285                         overhang = p.getArg('[', ']');
1286                 string const width = p.getArg('{', '}');
1287                 // write
1288                 if (name == "wrapfigure")
1289                         begin_inset(os, "Wrap figure\n");
1290                 else
1291                         begin_inset(os, "Wrap table\n");
1292                 os << "lines " << lines
1293                    << "\nplacement " << placement
1294                    << "\noverhang " << lyx::translate_len(overhang)
1295                    << "\nwidth " << lyx::translate_len(width)
1296                    << "\nstatus open\n\n";
1297                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1298                 end_inset(os);
1299                 // We don't need really a new paragraph, but
1300                 // we must make sure that the next item gets a \begin_layout.
1301                 parent_context.new_paragraph(os);
1302                 p.skip_spaces();
1303                 preamble.registerAutomaticallyLoadedPackage("wrapfig");
1304         }
1305
1306         else if (name == "minipage") {
1307                 eat_whitespace(p, os, parent_context, false);
1308                 // Test whether this is an outer box of a shaded box
1309                 p.pushPosition();
1310                 // swallow arguments
1311                 while (p.hasOpt()) {
1312                         p.getArg('[', ']');
1313                         p.skip_spaces(true);
1314                 }
1315                 p.getArg('{', '}');
1316                 p.skip_spaces(true);
1317                 Token t = p.get_token();
1318                 bool shaded = false;
1319                 if (t.asInput() == "\\begin") {
1320                         p.skip_spaces(true);
1321                         if (p.getArg('{', '}') == "shaded")
1322                                 shaded = true;
1323                 }
1324                 p.popPosition();
1325                 if (shaded)
1326                         parse_outer_box(p, os, FLAG_END, outer,
1327                                         parent_context, name, "shaded");
1328                 else
1329                         parse_box(p, os, 0, FLAG_END, outer, parent_context,
1330                                   "", "", name);
1331                 p.skip_spaces();
1332         }
1333
1334         else if (name == "comment") {
1335                 eat_whitespace(p, os, parent_context, false);
1336                 parent_context.check_layout(os);
1337                 begin_inset(os, "Note Comment\n");
1338                 os << "status open\n";
1339                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1340                 end_inset(os);
1341                 p.skip_spaces();
1342                 skip_braces(p); // eat {} that might by set by LyX behind comments
1343                 preamble.registerAutomaticallyLoadedPackage("verbatim");
1344         }
1345
1346         else if (name == "verbatim") {
1347                 eat_whitespace(p, os, parent_context, false);
1348                 os << "\n\\begin_layout Verbatim\n";
1349                 string const s = p.verbatimEnvironment("verbatim");
1350                 string::const_iterator it2 = s.begin();
1351                 for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
1352                         if (*it == '\n') {
1353                                 it2 = it + 1;
1354                                 // avoid adding an empty paragraph at the end
1355                                 // if there are 2 consecutive spaces at the end ignore it
1356                                 // because LyX will re-add a \n
1357                                 if ((it + 1 != et) && (it + 2 != et || *it2 != '\n'))
1358                                         os << "\n\\end_layout\n\\begin_layout Verbatim\n";
1359                         } else
1360                                 os << *it;
1361                 }
1362                 os << "\n\\end_layout\n\n";
1363                 p.skip_spaces();
1364                 skip_braces(p); // eat {} that might by set by LyX behind comments
1365                 // reset to Standard layout
1366                 os << "\n\\begin_layout Standard\n";
1367         }
1368
1369         else if (name == "lyxgreyedout") {
1370                 eat_whitespace(p, os, parent_context, false);
1371                 parent_context.check_layout(os);
1372                 begin_inset(os, "Note Greyedout\n");
1373                 os << "status open\n";
1374                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1375                 end_inset(os);
1376                 p.skip_spaces();
1377                 if (!preamble.notefontcolor().empty())
1378                         preamble.registerAutomaticallyLoadedPackage("color");
1379         }
1380
1381         else if (name == "framed" || name == "shaded") {
1382                 eat_whitespace(p, os, parent_context, false);
1383                 parse_outer_box(p, os, FLAG_END, outer, parent_context, name, "");
1384                 p.skip_spaces();
1385         }
1386
1387         else if (name == "lstlisting") {
1388                 eat_whitespace(p, os, parent_context, false);
1389                 // FIXME handle listings with parameters
1390                 //       If this is added, don't forgot to handle the
1391                 //       automatic color package loading
1392                 if (p.hasOpt())
1393                         parse_unknown_environment(p, name, os, FLAG_END,
1394                                                   outer, parent_context);
1395                 else
1396                         parse_listings(p, os, parent_context);
1397                 p.skip_spaces();
1398         }
1399
1400         else if (!parent_context.new_layout_allowed)
1401                 parse_unknown_environment(p, name, os, FLAG_END, outer,
1402                                           parent_context);
1403
1404         // Alignment and spacing settings
1405         // FIXME (bug xxxx): These settings can span multiple paragraphs and
1406         //                                       therefore are totally broken!
1407         // Note that \centering, raggedright, and raggedleft cannot be handled, as
1408         // they are commands not environments. They are furthermore switches that
1409         // can be ended by another switches, but also by commands like \footnote or
1410         // \parbox. So the only safe way is to leave them untouched.
1411         else if (name == "center" || name == "centering" ||
1412                  name == "flushleft" || name == "flushright" ||
1413                  name == "singlespace" || name == "onehalfspace" ||
1414                  name == "doublespace" || name == "spacing") {
1415                 eat_whitespace(p, os, parent_context, false);
1416                 // We must begin a new paragraph if not already done
1417                 if (! parent_context.atParagraphStart()) {
1418                         parent_context.check_end_layout(os);
1419                         parent_context.new_paragraph(os);
1420                 }
1421                 if (name == "flushleft")
1422                         parent_context.add_extra_stuff("\\align left\n");
1423                 else if (name == "flushright")
1424                         parent_context.add_extra_stuff("\\align right\n");
1425                 else if (name == "center" || name == "centering")
1426                         parent_context.add_extra_stuff("\\align center\n");
1427                 else if (name == "singlespace")
1428                         parent_context.add_extra_stuff("\\paragraph_spacing single\n");
1429                 else if (name == "onehalfspace") {
1430                         parent_context.add_extra_stuff("\\paragraph_spacing onehalf\n");
1431                         preamble.registerAutomaticallyLoadedPackage("setspace");
1432                 } else if (name == "doublespace") {
1433                         parent_context.add_extra_stuff("\\paragraph_spacing double\n");
1434                         preamble.registerAutomaticallyLoadedPackage("setspace");
1435                 } else if (name == "spacing") {
1436                         parent_context.add_extra_stuff("\\paragraph_spacing other " + p.verbatim_item() + "\n");
1437                         preamble.registerAutomaticallyLoadedPackage("setspace");
1438                 }
1439                 parse_text(p, os, FLAG_END, outer, parent_context);
1440                 // Just in case the environment is empty
1441                 parent_context.extra_stuff.erase();
1442                 // We must begin a new paragraph to reset the alignment
1443                 parent_context.new_paragraph(os);
1444                 p.skip_spaces();
1445         }
1446
1447         // The single '=' is meant here.
1448         else if ((newlayout = findLayout(parent_context.textclass, name, false))) {
1449                 eat_whitespace(p, os, parent_context, false);
1450                 Context context(true, parent_context.textclass, newlayout,
1451                                 parent_context.layout, parent_context.font);
1452                 if (parent_context.deeper_paragraph) {
1453                         // We are beginning a nested environment after a
1454                         // deeper paragraph inside the outer list environment.
1455                         // Therefore we don't need to output a "begin deeper".
1456                         context.need_end_deeper = true;
1457                 }
1458                 parent_context.check_end_layout(os);
1459                 if (last_env == name) {
1460                         // we need to output a separator since LyX would export
1461                         // the two environments as one otherwise (bug 5716)
1462                         docstring const sep = from_ascii("--Separator--");
1463                         TeX2LyXDocClass const & textclass(parent_context.textclass);
1464                         if (textclass.hasLayout(sep)) {
1465                                 Context newcontext(parent_context);
1466                                 newcontext.layout = &(textclass[sep]);
1467                                 newcontext.check_layout(os);
1468                                 newcontext.check_end_layout(os);
1469                         } else {
1470                                 parent_context.check_layout(os);
1471                                 begin_inset(os, "Note Note\n");
1472                                 os << "status closed\n";
1473                                 Context newcontext(true, textclass,
1474                                                 &(textclass.defaultLayout()));
1475                                 newcontext.check_layout(os);
1476                                 newcontext.check_end_layout(os);
1477                                 end_inset(os);
1478                                 parent_context.check_end_layout(os);
1479                         }
1480                 }
1481                 switch (context.layout->latextype) {
1482                 case  LATEX_LIST_ENVIRONMENT:
1483                         context.add_par_extra_stuff("\\labelwidthstring "
1484                                                     + p.verbatim_item() + '\n');
1485                         p.skip_spaces();
1486                         break;
1487                 case  LATEX_BIB_ENVIRONMENT:
1488                         p.verbatim_item(); // swallow next arg
1489                         p.skip_spaces();
1490                         break;
1491                 default:
1492                         break;
1493                 }
1494                 context.check_deeper(os);
1495                 // handle known optional and required arguments
1496                 // layouts require all optional arguments before the required ones
1497                 // Unfortunately LyX can't handle arguments of list arguments (bug 7468):
1498                 // It is impossible to place anything after the environment name,
1499                 // but before the first \\item.
1500                 if (context.layout->latextype == LATEX_ENVIRONMENT) {
1501                         bool need_layout = true;
1502                         unsigned int optargs = 0;
1503                         while (optargs < context.layout->optargs) {
1504                                 eat_whitespace(p, os, context, false);
1505                                 if (p.next_token().cat() == catEscape ||
1506                                     p.next_token().character() != '[')
1507                                         break;
1508                                 p.get_token(); // eat '['
1509                                 if (need_layout) {
1510                                         context.check_layout(os);
1511                                         need_layout = false;
1512                                 }
1513                                 begin_inset(os, "Argument\n");
1514                                 os << "status collapsed\n\n";
1515                                 parse_text_in_inset(p, os, FLAG_BRACK_LAST, outer, context);
1516                                 end_inset(os);
1517                                 eat_whitespace(p, os, context, false);
1518                                 ++optargs;
1519                         }
1520                         unsigned int reqargs = 0;
1521                         while (reqargs < context.layout->reqargs) {
1522                                 eat_whitespace(p, os, context, false);
1523                                 if (p.next_token().cat() != catBegin)
1524                                         break;
1525                                 p.get_token(); // eat '{'
1526                                 if (need_layout) {
1527                                         context.check_layout(os);
1528                                         need_layout = false;
1529                                 }
1530                                 begin_inset(os, "Argument\n");
1531                                 os << "status collapsed\n\n";
1532                                 parse_text_in_inset(p, os, FLAG_BRACE_LAST, outer, context);
1533                                 end_inset(os);
1534                                 eat_whitespace(p, os, context, false);
1535                                 ++reqargs;
1536                         }
1537                 }
1538                 parse_text(p, os, FLAG_END, outer, context);
1539                 context.check_end_layout(os);
1540                 if (parent_context.deeper_paragraph) {
1541                         // We must suppress the "end deeper" because we
1542                         // suppressed the "begin deeper" above.
1543                         context.need_end_deeper = false;
1544                 }
1545                 context.check_end_deeper(os);
1546                 parent_context.new_paragraph(os);
1547                 p.skip_spaces();
1548                 if (!title_layout_found)
1549                         title_layout_found = newlayout->intitle;
1550                 set<string> const & req = newlayout->requires();
1551                 for (set<string>::const_iterator it = req.begin(); it != req.end(); it++)
1552                         preamble.registerAutomaticallyLoadedPackage(*it);
1553         }
1554
1555         // The single '=' is meant here.
1556         else if ((newinsetlayout = findInsetLayout(parent_context.textclass, name, false))) {
1557                 eat_whitespace(p, os, parent_context, false);
1558                 parent_context.check_layout(os);
1559                 begin_inset(os, "Flex ");
1560                 os << to_utf8(newinsetlayout->name()) << '\n'
1561                    << "status collapsed\n";
1562                 parse_text_in_inset(p, os, FLAG_END, false, parent_context, newinsetlayout);
1563                 end_inset(os);
1564         }
1565
1566         else if (name == "appendix") {
1567                 // This is no good latex style, but it works and is used in some documents...
1568                 eat_whitespace(p, os, parent_context, false);
1569                 parent_context.check_end_layout(os);
1570                 Context context(true, parent_context.textclass, parent_context.layout,
1571                                 parent_context.layout, parent_context.font);
1572                 context.check_layout(os);
1573                 os << "\\start_of_appendix\n";
1574                 parse_text(p, os, FLAG_END, outer, context);
1575                 context.check_end_layout(os);
1576                 p.skip_spaces();
1577         }
1578
1579         else if (known_environments.find(name) != known_environments.end()) {
1580                 vector<ArgumentType> arguments = known_environments[name];
1581                 // The last "argument" denotes wether we may translate the
1582                 // environment contents to LyX
1583                 // The default required if no argument is given makes us
1584                 // compatible with the reLyXre environment.
1585                 ArgumentType contents = arguments.empty() ?
1586                         required :
1587                         arguments.back();
1588                 if (!arguments.empty())
1589                         arguments.pop_back();
1590                 // See comment in parse_unknown_environment()
1591                 bool const specialfont =
1592                         (parent_context.font != parent_context.normalfont);
1593                 bool const new_layout_allowed =
1594                         parent_context.new_layout_allowed;
1595                 if (specialfont)
1596                         parent_context.new_layout_allowed = false;
1597                 parse_arguments("\\begin{" + name + "}", arguments, p, os,
1598                                 outer, parent_context);
1599                 if (contents == verbatim)
1600                         handle_ert(os, p.verbatimEnvironment(name),
1601                                    parent_context);
1602                 else
1603                         parse_text_snippet(p, os, FLAG_END, outer,
1604                                            parent_context);
1605                 handle_ert(os, "\\end{" + name + "}", parent_context);
1606                 if (specialfont)
1607                         parent_context.new_layout_allowed = new_layout_allowed;
1608         }
1609
1610         else
1611                 parse_unknown_environment(p, name, os, FLAG_END, outer,
1612                                           parent_context);
1613
1614         last_env = name;
1615         active_environments.pop_back();
1616 }
1617
1618
1619 /// parses a comment and outputs it to \p os.
1620 void parse_comment(Parser & p, ostream & os, Token const & t, Context & context)
1621 {
1622         LASSERT(t.cat() == catComment, return);
1623         if (!t.cs().empty()) {
1624                 context.check_layout(os);
1625                 handle_comment(os, '%' + t.cs(), context);
1626                 if (p.next_token().cat() == catNewline) {
1627                         // A newline after a comment line starts a new
1628                         // paragraph
1629                         if (context.new_layout_allowed) {
1630                                 if(!context.atParagraphStart())
1631                                         // Only start a new paragraph if not already
1632                                         // done (we might get called recursively)
1633                                         context.new_paragraph(os);
1634                         } else
1635                                 handle_ert(os, "\n", context);
1636                         eat_whitespace(p, os, context, true);
1637                 }
1638         } else {
1639                 // "%\n" combination
1640                 p.skip_spaces();
1641         }
1642 }
1643
1644
1645 /*!
1646  * Reads spaces and comments until the first non-space, non-comment token.
1647  * New paragraphs (double newlines or \\par) are handled like simple spaces
1648  * if \p eatParagraph is true.
1649  * Spaces are skipped, but comments are written to \p os.
1650  */
1651 void eat_whitespace(Parser & p, ostream & os, Context & context,
1652                     bool eatParagraph)
1653 {
1654         while (p.good()) {
1655                 Token const & t = p.get_token();
1656                 if (t.cat() == catComment)
1657                         parse_comment(p, os, t, context);
1658                 else if ((! eatParagraph && p.isParagraph()) ||
1659                          (t.cat() != catSpace && t.cat() != catNewline)) {
1660                         p.putback();
1661                         return;
1662                 }
1663         }
1664 }
1665
1666
1667 /*!
1668  * Set a font attribute, parse text and reset the font attribute.
1669  * \param attribute Attribute name (e.g. \\family, \\shape etc.)
1670  * \param currentvalue Current value of the attribute. Is set to the new
1671  * value during parsing.
1672  * \param newvalue New value of the attribute
1673  */
1674 void parse_text_attributes(Parser & p, ostream & os, unsigned flags, bool outer,
1675                            Context & context, string const & attribute,
1676                            string & currentvalue, string const & newvalue)
1677 {
1678         context.check_layout(os);
1679         string const oldvalue = currentvalue;
1680         currentvalue = newvalue;
1681         os << '\n' << attribute << ' ' << newvalue << "\n";
1682         parse_text_snippet(p, os, flags, outer, context);
1683         context.check_layout(os);
1684         os << '\n' << attribute << ' ' << oldvalue << "\n";
1685         currentvalue = oldvalue;
1686 }
1687
1688
1689 /// get the arguments of a natbib or jurabib citation command
1690 void get_cite_arguments(Parser & p, bool natbibOrder,
1691         string & before, string & after)
1692 {
1693         // We need to distinguish "" and "[]", so we can't use p.getOpt().
1694
1695         // text before the citation
1696         before.clear();
1697         // text after the citation
1698         after = p.getFullOpt();
1699
1700         if (!after.empty()) {
1701                 before = p.getFullOpt();
1702                 if (natbibOrder && !before.empty())
1703                         swap(before, after);
1704         }
1705 }
1706
1707
1708 /// Convert filenames with TeX macros and/or quotes to something LyX
1709 /// can understand
1710 string const normalize_filename(string const & name)
1711 {
1712         Parser p(trim(name, "\""));
1713         ostringstream os;
1714         while (p.good()) {
1715                 Token const & t = p.get_token();
1716                 if (t.cat() != catEscape)
1717                         os << t.asInput();
1718                 else if (t.cs() == "lyxdot") {
1719                         // This is used by LyX for simple dots in relative
1720                         // names
1721                         os << '.';
1722                         p.skip_spaces();
1723                 } else if (t.cs() == "space") {
1724                         os << ' ';
1725                         p.skip_spaces();
1726                 } else
1727                         os << t.asInput();
1728         }
1729         return os.str();
1730 }
1731
1732
1733 /// Convert \p name from TeX convention (relative to master file) to LyX
1734 /// convention (relative to .lyx file) if it is relative
1735 void fix_relative_filename(string & name)
1736 {
1737         if (FileName::isAbsolute(name))
1738                 return;
1739
1740         name = to_utf8(makeRelPath(from_utf8(makeAbsPath(name, getMasterFilePath()).absFileName()),
1741                                    from_utf8(getParentFilePath())));
1742 }
1743
1744
1745 /// Parse a NoWeb Scrap section. The initial "<<" is already parsed.
1746 void parse_noweb(Parser & p, ostream & os, Context & context)
1747 {
1748         // assemble the rest of the keyword
1749         string name("<<");
1750         bool scrap = false;
1751         while (p.good()) {
1752                 Token const & t = p.get_token();
1753                 if (t.asInput() == ">" && p.next_token().asInput() == ">") {
1754                         name += ">>";
1755                         p.get_token();
1756                         scrap = (p.good() && p.next_token().asInput() == "=");
1757                         if (scrap)
1758                                 name += p.get_token().asInput();
1759                         break;
1760                 }
1761                 name += t.asInput();
1762         }
1763
1764         if (!scrap || !context.new_layout_allowed ||
1765             !context.textclass.hasLayout(from_ascii("Scrap"))) {
1766                 cerr << "Warning: Could not interpret '" << name
1767                      << "'. Ignoring it." << endl;
1768                 return;
1769         }
1770
1771         // We use new_paragraph instead of check_end_layout because the stuff
1772         // following the noweb chunk needs to start with a \begin_layout.
1773         // This may create a new paragraph even if there was none in the
1774         // noweb file, but the alternative is an invalid LyX file. Since
1775         // noweb code chunks are implemented with a layout style in LyX they
1776         // always must be in an own paragraph.
1777         context.new_paragraph(os);
1778         Context newcontext(true, context.textclass,
1779                 &context.textclass[from_ascii("Scrap")]);
1780         newcontext.check_layout(os);
1781         os << name;
1782         while (p.good()) {
1783                 Token const & t = p.get_token();
1784                 // We abuse the parser a bit, because this is no TeX syntax
1785                 // at all.
1786                 if (t.cat() == catEscape)
1787                         os << subst(t.asInput(), "\\", "\n\\backslash\n");
1788                 else {
1789                         ostringstream oss;
1790                         Context tmp(false, context.textclass,
1791                                     &context.textclass[from_ascii("Scrap")]);
1792                         tmp.need_end_layout = true;
1793                         tmp.check_layout(oss);
1794                         os << subst(t.asInput(), "\n", oss.str());
1795                 }
1796                 // The scrap chunk is ended by an @ at the beginning of a line.
1797                 // After the @ the line may contain a comment and/or
1798                 // whitespace, but nothing else.
1799                 if (t.asInput() == "@" && p.prev_token().cat() == catNewline &&
1800                     (p.next_token().cat() == catSpace ||
1801                      p.next_token().cat() == catNewline ||
1802                      p.next_token().cat() == catComment)) {
1803                         while (p.good() && p.next_token().cat() == catSpace)
1804                                 os << p.get_token().asInput();
1805                         if (p.next_token().cat() == catComment)
1806                                 // The comment includes a final '\n'
1807                                 os << p.get_token().asInput();
1808                         else {
1809                                 if (p.next_token().cat() == catNewline)
1810                                         p.get_token();
1811                                 os << '\n';
1812                         }
1813                         break;
1814                 }
1815         }
1816         newcontext.check_end_layout(os);
1817 }
1818
1819
1820 /// detects \\def, \\long\\def and \\global\\long\\def with ws and comments
1821 bool is_macro(Parser & p)
1822 {
1823         Token first = p.curr_token();
1824         if (first.cat() != catEscape || !p.good())
1825                 return false;
1826         if (first.cs() == "def")
1827                 return true;
1828         if (first.cs() != "global" && first.cs() != "long")
1829                 return false;
1830         Token second = p.get_token();
1831         int pos = 1;
1832         while (p.good() && !p.isParagraph() && (second.cat() == catSpace ||
1833                second.cat() == catNewline || second.cat() == catComment)) {
1834                 second = p.get_token();
1835                 pos++;
1836         }
1837         bool secondvalid = second.cat() == catEscape;
1838         Token third;
1839         bool thirdvalid = false;
1840         if (p.good() && first.cs() == "global" && secondvalid &&
1841             second.cs() == "long") {
1842                 third = p.get_token();
1843                 pos++;
1844                 while (p.good() && !p.isParagraph() &&
1845                        (third.cat() == catSpace ||
1846                         third.cat() == catNewline ||
1847                         third.cat() == catComment)) {
1848                         third = p.get_token();
1849                         pos++;
1850                 }
1851                 thirdvalid = third.cat() == catEscape;
1852         }
1853         for (int i = 0; i < pos; ++i)
1854                 p.putback();
1855         if (!secondvalid)
1856                 return false;
1857         if (!thirdvalid)
1858                 return (first.cs() == "global" || first.cs() == "long") &&
1859                        second.cs() == "def";
1860         return first.cs() == "global" && second.cs() == "long" &&
1861                third.cs() == "def";
1862 }
1863
1864
1865 /// Parse a macro definition (assumes that is_macro() returned true)
1866 void parse_macro(Parser & p, ostream & os, Context & context)
1867 {
1868         context.check_layout(os);
1869         Token first = p.curr_token();
1870         Token second;
1871         Token third;
1872         string command = first.asInput();
1873         if (first.cs() != "def") {
1874                 p.get_token();
1875                 eat_whitespace(p, os, context, false);
1876                 second = p.curr_token();
1877                 command += second.asInput();
1878                 if (second.cs() != "def") {
1879                         p.get_token();
1880                         eat_whitespace(p, os, context, false);
1881                         third = p.curr_token();
1882                         command += third.asInput();
1883                 }
1884         }
1885         eat_whitespace(p, os, context, false);
1886         string const name = p.get_token().cs();
1887         eat_whitespace(p, os, context, false);
1888
1889         // parameter text
1890         bool simple = true;
1891         string paramtext;
1892         int arity = 0;
1893         while (p.next_token().cat() != catBegin) {
1894                 if (p.next_token().cat() == catParameter) {
1895                         // # found
1896                         p.get_token();
1897                         paramtext += "#";
1898
1899                         // followed by number?
1900                         if (p.next_token().cat() == catOther) {
1901                                 char c = p.getChar();
1902                                 paramtext += c;
1903                                 // number = current arity + 1?
1904                                 if (c == arity + '0' + 1)
1905                                         ++arity;
1906                                 else
1907                                         simple = false;
1908                         } else
1909                                 paramtext += p.get_token().cs();
1910                 } else {
1911                         paramtext += p.get_token().cs();
1912                         simple = false;
1913                 }
1914         }
1915
1916         // only output simple (i.e. compatible) macro as FormulaMacros
1917         string ert = '\\' + name + ' ' + paramtext + '{' + p.verbatim_item() + '}';
1918         if (simple) {
1919                 context.check_layout(os);
1920                 begin_inset(os, "FormulaMacro");
1921                 os << "\n\\def" << ert;
1922                 end_inset(os);
1923         } else
1924                 handle_ert(os, command + ert, context);
1925 }
1926
1927
1928 void registerExternalTemplatePackages(string const & name)
1929 {
1930         external::TemplateManager const & etm = external::TemplateManager::get();
1931         external::Template const * const et = etm.getTemplateByName(name);
1932         if (!et)
1933                 return;
1934         external::Template::Formats::const_iterator cit = et->formats.end();
1935         if (pdflatex)
1936                 cit = et->formats.find("PDFLaTeX");
1937         if (cit == et->formats.end())
1938                 // If the template has not specified a PDFLaTeX output,
1939                 // we try the LaTeX format.
1940                 cit = et->formats.find("LaTeX");
1941         if (cit == et->formats.end())
1942                 return;
1943         vector<string>::const_iterator qit = cit->second.requirements.begin();
1944         vector<string>::const_iterator qend = cit->second.requirements.end();
1945         for (; qit != qend; ++qit)
1946                 preamble.registerAutomaticallyLoadedPackage(*qit);
1947 }
1948
1949 } // anonymous namespace
1950
1951
1952 void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
1953                 Context & context)
1954 {
1955         Layout const * newlayout = 0;
1956         InsetLayout const * newinsetlayout = 0;
1957         char const * const * where = 0;
1958         // Store the latest bibliographystyle and nocite{*} option
1959         // (needed for bibtex inset)
1960         string btprint;
1961         string bibliographystyle = "default";
1962         bool const use_natbib = preamble.isPackageUsed("natbib");
1963         bool const use_jurabib = preamble.isPackageUsed("jurabib");
1964         string last_env;
1965         bool title_layout_found = false;
1966         while (p.good()) {
1967                 Token const & t = p.get_token();
1968
1969 #ifdef FILEDEBUG
1970                 debugToken(cerr, t, flags);
1971 #endif
1972
1973                 if (flags & FLAG_ITEM) {
1974                         if (t.cat() == catSpace)
1975                                 continue;
1976
1977                         flags &= ~FLAG_ITEM;
1978                         if (t.cat() == catBegin) {
1979                                 // skip the brace and collect everything to the next matching
1980                                 // closing brace
1981                                 flags |= FLAG_BRACE_LAST;
1982                                 continue;
1983                         }
1984
1985                         // handle only this single token, leave the loop if done
1986                         flags |= FLAG_LEAVE;
1987                 }
1988
1989                 if (t.cat() != catEscape && t.character() == ']' &&
1990                     (flags & FLAG_BRACK_LAST))
1991                         return;
1992                 if (t.cat() == catEnd && (flags & FLAG_BRACE_LAST))
1993                         return;
1994
1995                 // If there is anything between \end{env} and \begin{env} we
1996                 // don't need to output a separator.
1997                 if (t.cat() != catSpace && t.cat() != catNewline &&
1998                     t.asInput() != "\\begin")
1999                         last_env = "";
2000
2001                 //
2002                 // cat codes
2003                 //
2004                 if (t.cat() == catMath) {
2005                         // we are inside some text mode thingy, so opening new math is allowed
2006                         context.check_layout(os);
2007                         begin_inset(os, "Formula ");
2008                         Token const & n = p.get_token();
2009                         bool const display(n.cat() == catMath && outer);
2010                         if (display) {
2011                                 // TeX's $$...$$ syntax for displayed math
2012                                 os << "\\[";
2013                                 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2014                                 os << "\\]";
2015                                 p.get_token(); // skip the second '$' token
2016                         } else {
2017                                 // simple $...$  stuff
2018                                 p.putback();
2019                                 os << '$';
2020                                 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2021                                 os << '$';
2022                         }
2023                         end_inset(os);
2024                         if (display) {
2025                                 // Prevent the conversion of a line break to a
2026                                 // space (bug 7668). This does not change the
2027                                 // output, but looks ugly in LyX.
2028                                 eat_whitespace(p, os, context, false);
2029                         }
2030                 }
2031
2032                 else if (t.cat() == catSuper || t.cat() == catSub)
2033                         cerr << "catcode " << t << " illegal in text mode\n";
2034
2035                 // Basic support for english quotes. This should be
2036                 // extended to other quotes, but is not so easy (a
2037                 // left english quote is the same as a right german
2038                 // quote...)
2039                 else if (t.asInput() == "`" && p.next_token().asInput() == "`") {
2040                         context.check_layout(os);
2041                         begin_inset(os, "Quotes ");
2042                         os << "eld";
2043                         end_inset(os);
2044                         p.get_token();
2045                         skip_braces(p);
2046                 }
2047                 else if (t.asInput() == "'" && p.next_token().asInput() == "'") {
2048                         context.check_layout(os);
2049                         begin_inset(os, "Quotes ");
2050                         os << "erd";
2051                         end_inset(os);
2052                         p.get_token();
2053                         skip_braces(p);
2054                 }
2055
2056                 else if (t.asInput() == ">" && p.next_token().asInput() == ">") {
2057                         context.check_layout(os);
2058                         begin_inset(os, "Quotes ");
2059                         os << "ald";
2060                         end_inset(os);
2061                         p.get_token();
2062                         skip_braces(p);
2063                 }
2064
2065                 else if (t.asInput() == "<" && p.next_token().asInput() == "<") {
2066                         context.check_layout(os);
2067                         begin_inset(os, "Quotes ");
2068                         os << "ard";
2069                         end_inset(os);
2070                         p.get_token();
2071                         skip_braces(p);
2072                 }
2073
2074                 else if (t.asInput() == "<"
2075                          && p.next_token().asInput() == "<" && noweb_mode) {
2076                         p.get_token();
2077                         parse_noweb(p, os, context);
2078                 }
2079
2080                 else if (t.cat() == catSpace || (t.cat() == catNewline && ! p.isParagraph()))
2081                         check_space(p, os, context);
2082
2083                 else if (t.character() == '[' && noweb_mode &&
2084                          p.next_token().character() == '[') {
2085                         // These can contain underscores
2086                         p.putback();
2087                         string const s = p.getFullOpt() + ']';
2088                         if (p.next_token().character() == ']')
2089                                 p.get_token();
2090                         else
2091                                 cerr << "Warning: Inserting missing ']' in '"
2092                                      << s << "'." << endl;
2093                         handle_ert(os, s, context);
2094                 }
2095
2096                 else if (t.cat() == catLetter) {
2097                         context.check_layout(os);
2098                         // Workaround for bug 4752.
2099                         // FIXME: This whole code block needs to be removed
2100                         //        when the bug is fixed and tex2lyx produces
2101                         //        the updated file format.
2102                         // The replacement algorithm in LyX is so stupid that
2103                         // it even translates a phrase if it is part of a word.
2104                         bool handled = false;
2105                         for (int const * l = known_phrase_lengths; *l; ++l) {
2106                                 string phrase = t.cs();
2107                                 for (int i = 1; i < *l && p.next_token().isAlnumASCII(); ++i)
2108                                         phrase += p.get_token().cs();
2109                                 if (is_known(phrase, known_coded_phrases)) {
2110                                         handle_ert(os, phrase, context);
2111                                         handled = true;
2112                                         break;
2113                                 } else {
2114                                         for (size_t i = 1; i < phrase.length(); ++i)
2115                                                 p.putback();
2116                                 }
2117                         }
2118                         if (!handled)
2119                                 os << t.cs();
2120                 }
2121
2122                 else if (t.cat() == catOther ||
2123                                t.cat() == catAlign ||
2124                                t.cat() == catParameter) {
2125                         // This translates "&" to "\\&" which may be wrong...
2126                         context.check_layout(os);
2127                         os << t.cs();
2128                 }
2129
2130                 else if (p.isParagraph()) {
2131                         if (context.new_layout_allowed)
2132                                 context.new_paragraph(os);
2133                         else
2134                                 handle_ert(os, "\\par ", context);
2135                         eat_whitespace(p, os, context, true);
2136                 }
2137
2138                 else if (t.cat() == catActive) {
2139                         context.check_layout(os);
2140                         if (t.character() == '~') {
2141                                 if (context.layout->free_spacing)
2142                                         os << ' ';
2143                                 else {
2144                                         begin_inset(os, "space ~\n");
2145                                         end_inset(os);
2146                                 }
2147                         } else
2148                                 os << t.cs();
2149                 }
2150
2151                 else if (t.cat() == catBegin) {
2152                         Token const next = p.next_token();
2153                         Token const end = p.next_next_token();
2154                         if (next.cat() == catEnd) {
2155                         // {}
2156                         Token const prev = p.prev_token();
2157                         p.get_token();
2158                         if (p.next_token().character() == '`' ||
2159                             (prev.character() == '-' &&
2160                              p.next_token().character() == '-'))
2161                                 ; // ignore it in {}`` or -{}-
2162                         else
2163                                 handle_ert(os, "{}", context);
2164                         } else if (next.cat() == catEscape &&
2165                                    is_known(next.cs(), known_quotes) &&
2166                                    end.cat() == catEnd) {
2167                                 // Something like {\textquoteright} (e.g.
2168                                 // from writer2latex). LyX writes
2169                                 // \textquoteright{}, so we may skip the
2170                                 // braces here for better readability.
2171                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2172                                                    outer, context);
2173                         } else {
2174                         context.check_layout(os);
2175                         // special handling of font attribute changes
2176                         Token const prev = p.prev_token();
2177                         TeXFont const oldFont = context.font;
2178                         if (next.character() == '[' ||
2179                             next.character() == ']' ||
2180                             next.character() == '*') {
2181                                 p.get_token();
2182                                 if (p.next_token().cat() == catEnd) {
2183                                         os << next.cs();
2184                                         p.get_token();
2185                                 } else {
2186                                         p.putback();
2187                                         handle_ert(os, "{", context);
2188                                         parse_text_snippet(p, os,
2189                                                         FLAG_BRACE_LAST,
2190                                                         outer, context);
2191                                         handle_ert(os, "}", context);
2192                                 }
2193                         } else if (! context.new_layout_allowed) {
2194                                 handle_ert(os, "{", context);
2195                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2196                                                    outer, context);
2197                                 handle_ert(os, "}", context);
2198                         } else if (is_known(next.cs(), known_sizes)) {
2199                                 // next will change the size, so we must
2200                                 // reset it here
2201                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2202                                                    outer, context);
2203                                 if (!context.atParagraphStart())
2204                                         os << "\n\\size "
2205                                            << context.font.size << "\n";
2206                         } else if (is_known(next.cs(), known_font_families)) {
2207                                 // next will change the font family, so we
2208                                 // must reset it here
2209                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2210                                                    outer, context);
2211                                 if (!context.atParagraphStart())
2212                                         os << "\n\\family "
2213                                            << context.font.family << "\n";
2214                         } else if (is_known(next.cs(), known_font_series)) {
2215                                 // next will change the font series, so we
2216                                 // must reset it here
2217                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2218                                                    outer, context);
2219                                 if (!context.atParagraphStart())
2220                                         os << "\n\\series "
2221                                            << context.font.series << "\n";
2222                         } else if (is_known(next.cs(), known_font_shapes)) {
2223                                 // next will change the font shape, so we
2224                                 // must reset it here
2225                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2226                                                    outer, context);
2227                                 if (!context.atParagraphStart())
2228                                         os << "\n\\shape "
2229                                            << context.font.shape << "\n";
2230                         } else if (is_known(next.cs(), known_old_font_families) ||
2231                                    is_known(next.cs(), known_old_font_series) ||
2232                                    is_known(next.cs(), known_old_font_shapes)) {
2233                                 // next will change the font family, series
2234                                 // and shape, so we must reset it here
2235                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2236                                                    outer, context);
2237                                 if (!context.atParagraphStart())
2238                                         os <<  "\n\\family "
2239                                            << context.font.family
2240                                            << "\n\\series "
2241                                            << context.font.series
2242                                            << "\n\\shape "
2243                                            << context.font.shape << "\n";
2244                         } else {
2245                                 handle_ert(os, "{", context);
2246                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2247                                                    outer, context);
2248                                 handle_ert(os, "}", context);
2249                                 }
2250                         }
2251                 }
2252
2253                 else if (t.cat() == catEnd) {
2254                         if (flags & FLAG_BRACE_LAST) {
2255                                 return;
2256                         }
2257                         cerr << "stray '}' in text\n";
2258                         handle_ert(os, "}", context);
2259                 }
2260
2261                 else if (t.cat() == catComment)
2262                         parse_comment(p, os, t, context);
2263
2264                 //
2265                 // control sequences
2266                 //
2267
2268                 else if (t.cs() == "(") {
2269                         context.check_layout(os);
2270                         begin_inset(os, "Formula");
2271                         os << " \\(";
2272                         parse_math(p, os, FLAG_SIMPLE2, MATH_MODE);
2273                         os << "\\)";
2274                         end_inset(os);
2275                 }
2276
2277                 else if (t.cs() == "[") {
2278                         context.check_layout(os);
2279                         begin_inset(os, "Formula");
2280                         os << " \\[";
2281                         parse_math(p, os, FLAG_EQUATION, MATH_MODE);
2282                         os << "\\]";
2283                         end_inset(os);
2284                         // Prevent the conversion of a line break to a space
2285                         // (bug 7668). This does not change the output, but
2286                         // looks ugly in LyX.
2287                         eat_whitespace(p, os, context, false);
2288                 }
2289
2290                 else if (t.cs() == "begin")
2291                         parse_environment(p, os, outer, last_env,
2292                                           title_layout_found, context);
2293
2294                 else if (t.cs() == "end") {
2295                         if (flags & FLAG_END) {
2296                                 // eat environment name
2297                                 string const name = p.getArg('{', '}');
2298                                 if (name != active_environment())
2299                                         cerr << "\\end{" + name + "} does not match \\begin{"
2300                                                 + active_environment() + "}\n";
2301                                 return;
2302                         }
2303                         p.error("found 'end' unexpectedly");
2304                 }
2305
2306                 else if (t.cs() == "item") {
2307                         string s;
2308                         bool const optarg = p.hasOpt();
2309                         if (optarg) {
2310                                 // FIXME: This swallows comments, but we cannot use
2311                                 //        eat_whitespace() since we must not output
2312                                 //        anything before the item.
2313                                 p.skip_spaces(true);
2314                                 s = p.verbatimOption();
2315                         } else
2316                                 p.skip_spaces(false);
2317                         context.set_item();
2318                         context.check_layout(os);
2319                         if (context.has_item) {
2320                                 // An item in an unknown list-like environment
2321                                 // FIXME: Do this in check_layout()!
2322                                 context.has_item = false;
2323                                 if (optarg)
2324                                         handle_ert(os, "\\item", context);
2325                                 else
2326                                         handle_ert(os, "\\item ", context);
2327                         }
2328                         if (optarg) {
2329                                 if (context.layout->labeltype != LABEL_MANUAL) {
2330                                         // LyX does not support \item[\mybullet]
2331                                         // in itemize environments
2332                                         Parser p2(s + ']');
2333                                         os << parse_text_snippet(p2,
2334                                                 FLAG_BRACK_LAST, outer, context);
2335                                 } else if (!s.empty()) {
2336                                         // LyX adds braces around the argument,
2337                                         // so we need to remove them here.
2338                                         if (s.size() > 2 && s[0] == '{' &&
2339                                             s[s.size()-1] == '}')
2340                                                 s = s.substr(1, s.size()-2);
2341                                         // If the argument contains a space we
2342                                         // must put it into ERT: Otherwise LyX
2343                                         // would misinterpret the space as
2344                                         // item delimiter (bug 7663)
2345                                         if (contains(s, ' ')) {
2346                                                 handle_ert(os, s, context);
2347                                         } else {
2348                                                 Parser p2(s + ']');
2349                                                 os << parse_text_snippet(p2,
2350                                                         FLAG_BRACK_LAST,
2351                                                         outer, context);
2352                                         }
2353                                         // The space is needed to separate the
2354                                         // item from the rest of the sentence.
2355                                         os << ' ';
2356                                         eat_whitespace(p, os, context, false);
2357                                 }
2358                         }
2359                 }
2360
2361                 else if (t.cs() == "bibitem") {
2362                         context.set_item();
2363                         context.check_layout(os);
2364                         eat_whitespace(p, os, context, false);
2365                         string label = convert_command_inset_arg(p.verbatimOption());
2366                         string key = convert_command_inset_arg(p.verbatim_item());
2367                         if (contains(label, '\\') || contains(key, '\\')) {
2368                                 // LyX can't handle LaTeX commands in labels or keys
2369                                 handle_ert(os, t.asInput() + '[' + label +
2370                                                "]{" + p.verbatim_item() + '}',
2371                                            context);
2372                         } else {
2373                                 begin_command_inset(os, "bibitem", "bibitem");
2374                                 os << "label \"" << label << "\"\n"
2375                                       "key \"" << key << "\"\n";
2376                                 end_inset(os);
2377                         }
2378                 }
2379
2380                 else if (is_macro(p)) {
2381                         // catch the case of \def\inputGnumericTable
2382                         bool macro = true;
2383                         if (t.cs() == "def") {
2384                                 Token second = p.next_token();
2385                                 if (second.cs() == "inputGnumericTable") {
2386                                         p.pushPosition();
2387                                         p.get_token();
2388                                         skip_braces(p);
2389                                         Token third = p.get_token();
2390                                         p.popPosition();
2391                                         if (third.cs() == "input") {
2392                                                 p.get_token();
2393                                                 skip_braces(p);
2394                                                 p.get_token();
2395                                                 string name = normalize_filename(p.verbatim_item());
2396                                                 string const path = getMasterFilePath();
2397                                                 // We want to preserve relative / absolute filenames,
2398                                                 // therefore path is only used for testing
2399                                                 // The file extension is in every case ".tex".
2400                                                 // So we need to remove this extension and check for
2401                                                 // the original one.
2402                                                 name = removeExtension(name);
2403                                                 if (!makeAbsPath(name, path).exists()) {
2404                                                         char const * const Gnumeric_formats[] = {"gnumeric",
2405                                                                 "ods", "xls", 0};
2406                                                         string const Gnumeric_name =
2407                                                                 find_file(name, path, Gnumeric_formats);
2408                                                         if (!Gnumeric_name.empty())
2409                                                                 name = Gnumeric_name;
2410                                                 }
2411                                                 if (makeAbsPath(name, path).exists())
2412                                                         fix_relative_filename(name);
2413                                                 else
2414                                                         cerr << "Warning: Could not find file '"
2415                                                              << name << "'." << endl;
2416                                                 context.check_layout(os);
2417                                                 begin_inset(os, "External\n\ttemplate ");
2418                                                 os << "GnumericSpreadsheet\n\tfilename "
2419                                                    << name << "\n";
2420                                                 end_inset(os);
2421                                                 context.check_layout(os);
2422                                                 macro = false;
2423                                                 // register the packages that are automatically reloaded
2424                                                 // by the Gnumeric template
2425                                                 registerExternalTemplatePackages("GnumericSpreadsheet");
2426                                         }
2427                                 }
2428                         }
2429                         if (macro)
2430                                 parse_macro(p, os, context);
2431                 }
2432
2433                 else if (t.cs() == "noindent") {
2434                         p.skip_spaces();
2435                         context.add_par_extra_stuff("\\noindent\n");
2436                 }
2437
2438                 else if (t.cs() == "appendix") {
2439                         context.add_par_extra_stuff("\\start_of_appendix\n");
2440                         // We need to start a new paragraph. Otherwise the
2441                         // appendix in 'bla\appendix\chapter{' would start
2442                         // too late.
2443                         context.new_paragraph(os);
2444                         // We need to make sure that the paragraph is
2445                         // generated even if it is empty. Otherwise the
2446                         // appendix in '\par\appendix\par\chapter{' would
2447                         // start too late.
2448                         context.check_layout(os);
2449                         // FIXME: This is a hack to prevent paragraph
2450                         // deletion if it is empty. Handle this better!
2451                         handle_comment(os,
2452                                 "%dummy comment inserted by tex2lyx to "
2453                                 "ensure that this paragraph is not empty",
2454                                 context);
2455                         // Both measures above may generate an additional
2456                         // empty paragraph, but that does not hurt, because
2457                         // whitespace does not matter here.
2458                         eat_whitespace(p, os, context, true);
2459                 }
2460
2461                 // Must catch empty dates before findLayout is called below
2462                 else if (t.cs() == "date") {
2463                         string const date = p.verbatim_item();
2464                         if (date.empty())
2465                                 preamble.suppressDate(true);
2466                         else {
2467                                 preamble.suppressDate(false);
2468                                 if (context.new_layout_allowed &&
2469                                     (newlayout = findLayout(context.textclass,
2470                                                             t.cs(), true))) {
2471                                         // write the layout
2472                                         output_command_layout(os, p, outer,
2473                                                         context, newlayout);
2474                                         p.skip_spaces();
2475                                         if (!title_layout_found)
2476                                                 title_layout_found = newlayout->intitle;
2477                                         set<string> const & req = newlayout->requires();
2478                                         for (set<string>::const_iterator it = req.begin();
2479                                              it != req.end(); it++)
2480                                                 preamble.registerAutomaticallyLoadedPackage(*it);
2481                                 } else
2482                                         handle_ert(os, "\\date{" + date + '}',
2483                                                         context);
2484                         }
2485                 }
2486
2487                 // Starred section headings
2488                 // Must attempt to parse "Section*" before "Section".
2489                 else if ((p.next_token().asInput() == "*") &&
2490                          context.new_layout_allowed &&
2491                          (newlayout = findLayout(context.textclass, t.cs() + '*', true))) {
2492                         // write the layout
2493                         p.get_token();
2494                         output_command_layout(os, p, outer, context, newlayout);
2495                         p.skip_spaces();
2496                         if (!title_layout_found)
2497                                 title_layout_found = newlayout->intitle;
2498                         set<string> const & req = newlayout->requires();
2499                         for (set<string>::const_iterator it = req.begin(); it != req.end(); it++)
2500                                 preamble.registerAutomaticallyLoadedPackage(*it);
2501                 }
2502
2503                 // Section headings and the like
2504                 else if (context.new_layout_allowed &&
2505                          (newlayout = findLayout(context.textclass, t.cs(), true))) {
2506                         // write the layout
2507                         output_command_layout(os, p, outer, context, newlayout);
2508                         p.skip_spaces();
2509                         if (!title_layout_found)
2510                                 title_layout_found = newlayout->intitle;
2511                         set<string> const & req = newlayout->requires();
2512                         for (set<string>::const_iterator it = req.begin(); it != req.end(); it++)
2513                                 preamble.registerAutomaticallyLoadedPackage(*it);
2514                 }
2515
2516                 else if (t.cs() == "caption") {
2517                         p.skip_spaces();
2518                         context.check_layout(os);
2519                         p.skip_spaces();
2520                         begin_inset(os, "Caption\n");
2521                         Context newcontext(true, context.textclass);
2522                         newcontext.font = context.font;
2523                         newcontext.check_layout(os);
2524                         if (p.next_token().cat() != catEscape &&
2525                             p.next_token().character() == '[') {
2526                                 p.get_token(); // eat '['
2527                                 begin_inset(os, "Argument\n");
2528                                 os << "status collapsed\n";
2529                                 parse_text_in_inset(p, os, FLAG_BRACK_LAST, outer, context);
2530                                 end_inset(os);
2531                                 eat_whitespace(p, os, context, false);
2532                         }
2533                         parse_text(p, os, FLAG_ITEM, outer, context);
2534                         context.check_end_layout(os);
2535                         // We don't need really a new paragraph, but
2536                         // we must make sure that the next item gets a \begin_layout.
2537                         context.new_paragraph(os);
2538                         end_inset(os);
2539                         p.skip_spaces();
2540                         newcontext.check_end_layout(os);
2541                 }
2542
2543                 else if (t.cs() == "subfloat") {
2544                         // the syntax is \subfloat[caption]{content}
2545                         // if it is a table of figure depends on the surrounding float
2546                         bool has_caption = false;
2547                         p.skip_spaces();
2548                         // do nothing if there is no outer float
2549                         if (!float_type.empty()) {
2550                                 context.check_layout(os);
2551                                 p.skip_spaces();
2552                                 begin_inset(os, "Float " + float_type + "\n");
2553                                 os << "wide false"
2554                                    << "\nsideways false"
2555                                    << "\nstatus collapsed\n\n";
2556                                 // test for caption
2557                                 string caption;
2558                                 if (p.next_token().cat() != catEscape &&
2559                                                 p.next_token().character() == '[') {
2560                                                         p.get_token(); // eat '['
2561                                                         caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
2562                                                         has_caption = true;
2563                                 }
2564                                 // the content
2565                                 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
2566                                 // the caption comes always as the last
2567                                 if (has_caption) {
2568                                         // we must make sure that the caption gets a \begin_layout
2569                                         os << "\n\\begin_layout Plain Layout";
2570                                         p.skip_spaces();
2571                                         begin_inset(os, "Caption\n");
2572                                         Context newcontext(true, context.textclass);
2573                                         newcontext.font = context.font;
2574                                         newcontext.check_layout(os);
2575                                         os << caption << "\n";
2576                                         newcontext.check_end_layout(os);
2577                                         // We don't need really a new paragraph, but
2578                                         // we must make sure that the next item gets a \begin_layout.
2579                                         //newcontext.new_paragraph(os);
2580                                         end_inset(os);
2581                                         p.skip_spaces();
2582                                 }
2583                                 // We don't need really a new paragraph, but
2584                                 // we must make sure that the next item gets a \begin_layout.
2585                                 if (has_caption)
2586                                         context.new_paragraph(os);
2587                                 end_inset(os);
2588                                 p.skip_spaces();
2589                                 context.check_end_layout(os);
2590                                 // close the layout we opened
2591                                 if (has_caption)
2592                                         os << "\n\\end_layout\n";
2593                         } else {
2594                                 // if the float type is not supported or there is no surrounding float
2595                                 // output it as ERT
2596                                 if (p.hasOpt()) {
2597                                         string opt_arg = convert_command_inset_arg(p.getArg('[', ']'));
2598                                         handle_ert(os, t.asInput() + '[' + opt_arg +
2599                                                "]{" + p.verbatim_item() + '}', context);
2600                                 } else
2601                                         handle_ert(os, t.asInput() + "{" + p.verbatim_item() + '}', context);
2602                         }
2603                 }
2604
2605                 else if (t.cs() == "includegraphics") {
2606                         bool const clip = p.next_token().asInput() == "*";
2607                         if (clip)
2608                                 p.get_token();
2609                         string const arg = p.getArg('[', ']');
2610                         map<string, string> opts;
2611                         vector<string> keys;
2612                         split_map(arg, opts, keys);
2613                         if (clip)
2614                                 opts["clip"] = string();
2615                         string name = normalize_filename(p.verbatim_item());
2616
2617                         string const path = getMasterFilePath();
2618                         // We want to preserve relative / absolute filenames,
2619                         // therefore path is only used for testing
2620                         if (!makeAbsPath(name, path).exists()) {
2621                                 // The file extension is probably missing.
2622                                 // Now try to find it out.
2623                                 string const dvips_name =
2624                                         find_file(name, path,
2625                                                   known_dvips_graphics_formats);
2626                                 string const pdftex_name =
2627                                         find_file(name, path,
2628                                                   known_pdftex_graphics_formats);
2629                                 if (!dvips_name.empty()) {
2630                                         if (!pdftex_name.empty()) {
2631                                                 cerr << "This file contains the "
2632                                                         "latex snippet\n"
2633                                                         "\"\\includegraphics{"
2634                                                      << name << "}\".\n"
2635                                                         "However, files\n\""
2636                                                      << dvips_name << "\" and\n\""
2637                                                      << pdftex_name << "\"\n"
2638                                                         "both exist, so I had to make a "
2639                                                         "choice and took the first one.\n"
2640                                                         "Please move the unwanted one "
2641                                                         "someplace else and try again\n"
2642                                                         "if my choice was wrong."
2643                                                      << endl;
2644                                         }
2645                                         name = dvips_name;
2646                                 } else if (!pdftex_name.empty()) {
2647                                         name = pdftex_name;
2648                                         pdflatex = true;
2649                                 }
2650                         }
2651
2652                         if (makeAbsPath(name, path).exists())
2653                                 fix_relative_filename(name);
2654                         else
2655                                 cerr << "Warning: Could not find graphics file '"
2656                                      << name << "'." << endl;
2657
2658                         context.check_layout(os);
2659                         begin_inset(os, "Graphics ");
2660                         os << "\n\tfilename " << name << '\n';
2661                         if (opts.find("width") != opts.end())
2662                                 os << "\twidth "
2663                                    << translate_len(opts["width"]) << '\n';
2664                         if (opts.find("height") != opts.end())
2665                                 os << "\theight "
2666                                    << translate_len(opts["height"]) << '\n';
2667                         if (opts.find("scale") != opts.end()) {
2668                                 istringstream iss(opts["scale"]);
2669                                 double val;
2670                                 iss >> val;
2671                                 val = val*100;
2672                                 os << "\tscale " << val << '\n';
2673                         }
2674                         if (opts.find("angle") != opts.end()) {
2675                                 os << "\trotateAngle "
2676                                    << opts["angle"] << '\n';
2677                                 vector<string>::const_iterator a =
2678                                         find(keys.begin(), keys.end(), "angle");
2679                                 vector<string>::const_iterator s =
2680                                         find(keys.begin(), keys.end(), "width");
2681                                 if (s == keys.end())
2682                                         s = find(keys.begin(), keys.end(), "height");
2683                                 if (s == keys.end())
2684                                         s = find(keys.begin(), keys.end(), "scale");
2685                                 if (s != keys.end() && distance(s, a) > 0)
2686                                         os << "\tscaleBeforeRotation\n";
2687                         }
2688                         if (opts.find("origin") != opts.end()) {
2689                                 ostringstream ss;
2690                                 string const opt = opts["origin"];
2691                                 if (opt.find('l') != string::npos) ss << "left";
2692                                 if (opt.find('r') != string::npos) ss << "right";
2693                                 if (opt.find('c') != string::npos) ss << "center";
2694                                 if (opt.find('t') != string::npos) ss << "Top";
2695                                 if (opt.find('b') != string::npos) ss << "Bottom";
2696                                 if (opt.find('B') != string::npos) ss << "Baseline";
2697                                 if (!ss.str().empty())
2698                                         os << "\trotateOrigin " << ss.str() << '\n';
2699                                 else
2700                                         cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
2701                         }
2702                         if (opts.find("keepaspectratio") != opts.end())
2703                                 os << "\tkeepAspectRatio\n";
2704                         if (opts.find("clip") != opts.end())
2705                                 os << "\tclip\n";
2706                         if (opts.find("draft") != opts.end())
2707                                 os << "\tdraft\n";
2708                         if (opts.find("bb") != opts.end())
2709                                 os << "\tBoundingBox "
2710                                    << opts["bb"] << '\n';
2711                         int numberOfbbOptions = 0;
2712                         if (opts.find("bbllx") != opts.end())
2713                                 numberOfbbOptions++;
2714                         if (opts.find("bblly") != opts.end())
2715                                 numberOfbbOptions++;
2716                         if (opts.find("bburx") != opts.end())
2717                                 numberOfbbOptions++;
2718                         if (opts.find("bbury") != opts.end())
2719                                 numberOfbbOptions++;
2720                         if (numberOfbbOptions == 4)
2721                                 os << "\tBoundingBox "
2722                                    << opts["bbllx"] << " " << opts["bblly"] << " "
2723                                    << opts["bburx"] << " " << opts["bbury"] << '\n';
2724                         else if (numberOfbbOptions > 0)
2725                                 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
2726                         numberOfbbOptions = 0;
2727                         if (opts.find("natwidth") != opts.end())
2728                                 numberOfbbOptions++;
2729                         if (opts.find("natheight") != opts.end())
2730                                 numberOfbbOptions++;
2731                         if (numberOfbbOptions == 2)
2732                                 os << "\tBoundingBox 0bp 0bp "
2733                                    << opts["natwidth"] << " " << opts["natheight"] << '\n';
2734                         else if (numberOfbbOptions > 0)
2735                                 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
2736                         ostringstream special;
2737                         if (opts.find("hiresbb") != opts.end())
2738                                 special << "hiresbb,";
2739                         if (opts.find("trim") != opts.end())
2740                                 special << "trim,";
2741                         if (opts.find("viewport") != opts.end())
2742                                 special << "viewport=" << opts["viewport"] << ',';
2743                         if (opts.find("totalheight") != opts.end())
2744                                 special << "totalheight=" << opts["totalheight"] << ',';
2745                         if (opts.find("type") != opts.end())
2746                                 special << "type=" << opts["type"] << ',';
2747                         if (opts.find("ext") != opts.end())
2748                                 special << "ext=" << opts["ext"] << ',';
2749                         if (opts.find("read") != opts.end())
2750                                 special << "read=" << opts["read"] << ',';
2751                         if (opts.find("command") != opts.end())
2752                                 special << "command=" << opts["command"] << ',';
2753                         string s_special = special.str();
2754                         if (!s_special.empty()) {
2755                                 // We had special arguments. Remove the trailing ','.
2756                                 os << "\tspecial " << s_special.substr(0, s_special.size() - 1) << '\n';
2757                         }
2758                         // TODO: Handle the unknown settings better.
2759                         // Warn about invalid options.
2760                         // Check whether some option was given twice.
2761                         end_inset(os);
2762                         preamble.registerAutomaticallyLoadedPackage("graphicx");
2763                 }
2764
2765                 else if (t.cs() == "footnote" ||
2766                          (t.cs() == "thanks" && context.layout->intitle)) {
2767                         p.skip_spaces();
2768                         context.check_layout(os);
2769                         begin_inset(os, "Foot\n");
2770                         os << "status collapsed\n\n";
2771                         parse_text_in_inset(p, os, FLAG_ITEM, false, context);
2772                         end_inset(os);
2773                 }
2774
2775                 else if (t.cs() == "marginpar") {
2776                         p.skip_spaces();
2777                         context.check_layout(os);
2778                         begin_inset(os, "Marginal\n");
2779                         os << "status collapsed\n\n";
2780                         parse_text_in_inset(p, os, FLAG_ITEM, false, context);
2781                         end_inset(os);
2782                 }
2783
2784                 else if (t.cs() == "ensuremath") {
2785                         p.skip_spaces();
2786                         context.check_layout(os);
2787                         string const s = p.verbatim_item();
2788                         //FIXME: this never triggers in UTF8
2789                         if (s == "\xb1" || s == "\xb3" || s == "\xb2" || s == "\xb5")
2790                                 os << s;
2791                         else
2792                                 handle_ert(os, "\\ensuremath{" + s + "}",
2793                                            context);
2794                 }
2795
2796                 else if (t.cs() == "makeindex" || t.cs() == "maketitle") {
2797                         if (title_layout_found) {
2798                                 // swallow this
2799                                 skip_spaces_braces(p);
2800                         } else
2801                                 handle_ert(os, t.asInput(), context);
2802                 }
2803
2804                 else if (t.cs() == "tableofcontents") {
2805                         context.check_layout(os);
2806                         begin_command_inset(os, "toc", "tableofcontents");
2807                         end_inset(os);
2808                         skip_spaces_braces(p);
2809                 }
2810
2811                 else if (t.cs() == "listoffigures") {
2812                         context.check_layout(os);
2813                         begin_inset(os, "FloatList figure\n");
2814                         end_inset(os);
2815                         skip_spaces_braces(p);
2816                 }
2817
2818                 else if (t.cs() == "listoftables") {
2819                         context.check_layout(os);
2820                         begin_inset(os, "FloatList table\n");
2821                         end_inset(os);
2822                         skip_spaces_braces(p);
2823                 }
2824
2825                 else if (t.cs() == "listof") {
2826                         p.skip_spaces(true);
2827                         string const name = p.get_token().cs();
2828                         if (context.textclass.floats().typeExist(name)) {
2829                                 context.check_layout(os);
2830                                 begin_inset(os, "FloatList ");
2831                                 os << name << "\n";
2832                                 end_inset(os);
2833                                 p.get_token(); // swallow second arg
2834                         } else
2835                                 handle_ert(os, "\\listof{" + name + "}", context);
2836                 }
2837
2838                 else if ((where = is_known(t.cs(), known_text_font_families)))
2839                         parse_text_attributes(p, os, FLAG_ITEM, outer,
2840                                 context, "\\family", context.font.family,
2841                                 known_coded_font_families[where - known_text_font_families]);
2842
2843                 else if ((where = is_known(t.cs(), known_text_font_series)))
2844                         parse_text_attributes(p, os, FLAG_ITEM, outer,
2845                                 context, "\\series", context.font.series,
2846                                 known_coded_font_series[where - known_text_font_series]);
2847
2848                 else if ((where = is_known(t.cs(), known_text_font_shapes)))
2849                         parse_text_attributes(p, os, FLAG_ITEM, outer,
2850                                 context, "\\shape", context.font.shape,
2851                                 known_coded_font_shapes[where - known_text_font_shapes]);
2852
2853                 else if (t.cs() == "textnormal" || t.cs() == "normalfont") {
2854                         context.check_layout(os);
2855                         TeXFont oldFont = context.font;
2856                         context.font.init();
2857                         context.font.size = oldFont.size;
2858                         os << "\n\\family " << context.font.family << "\n";
2859                         os << "\n\\series " << context.font.series << "\n";
2860                         os << "\n\\shape " << context.font.shape << "\n";
2861                         if (t.cs() == "textnormal") {
2862                                 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
2863                                 output_font_change(os, context.font, oldFont);
2864                                 context.font = oldFont;
2865                         } else
2866                                 eat_whitespace(p, os, context, false);
2867                 }
2868
2869                 else if (t.cs() == "textcolor") {
2870                         // scheme is \textcolor{color name}{text}
2871                         string const color = p.verbatim_item();
2872                         // we only support the predefined colors of the color package
2873                         if (color == "black" || color == "blue" || color == "cyan"
2874                                 || color == "green" || color == "magenta" || color == "red"
2875                                 || color == "white" || color == "yellow") {
2876                                         context.check_layout(os);
2877                                         os << "\n\\color " << color << "\n";
2878                                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
2879                                         context.check_layout(os);
2880                                         os << "\n\\color inherit\n";
2881                                         preamble.registerAutomaticallyLoadedPackage("color");
2882                         } else
2883                                 // for custom defined colors
2884                                 handle_ert(os, t.asInput() + "{" + color + "}", context);
2885                 }
2886
2887                 else if (t.cs() == "underbar" || t.cs() == "uline") {
2888                         // \underbar is not 100% correct (LyX outputs \uline
2889                         // of ulem.sty). The difference is that \ulem allows
2890                         // line breaks, and \underbar does not.
2891                         // Do NOT handle \underline.
2892                         // \underbar cuts through y, g, q, p etc.,
2893                         // \underline does not.
2894                         context.check_layout(os);
2895                         os << "\n\\bar under\n";
2896                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
2897                         context.check_layout(os);
2898                         os << "\n\\bar default\n";
2899                         preamble.registerAutomaticallyLoadedPackage("ulem");
2900                 }
2901
2902                 else if (t.cs() == "sout") {
2903                         context.check_layout(os);
2904                         os << "\n\\strikeout on\n";
2905                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
2906                         context.check_layout(os);
2907                         os << "\n\\strikeout default\n";
2908                         preamble.registerAutomaticallyLoadedPackage("ulem");
2909                 }
2910
2911                 else if (t.cs() == "uuline" || t.cs() == "uwave" ||
2912                          t.cs() == "emph" || t.cs() == "noun") {
2913                         context.check_layout(os);
2914                         os << "\n\\" << t.cs() << " on\n";
2915                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
2916                         context.check_layout(os);
2917                         os << "\n\\" << t.cs() << " default\n";
2918                         if (t.cs() == "uuline" || t.cs() == "uwave")
2919                                 preamble.registerAutomaticallyLoadedPackage("ulem");
2920                 }
2921
2922                 else if (t.cs() == "lyxadded" || t.cs() == "lyxdeleted") {
2923                         context.check_layout(os);
2924                         string name = p.getArg('{', '}');
2925                         string localtime = p.getArg('{', '}');
2926                         preamble.registerAuthor(name);
2927                         Author const & author = preamble.getAuthor(name);
2928                         // from_ctime() will fail if LyX decides to output the
2929                         // time in the text language. It might also use a wrong
2930                         // time zone (if the original LyX document was exported
2931                         // with a different time zone).
2932                         time_t ptime = from_ctime(localtime);
2933                         if (ptime == static_cast<time_t>(-1)) {
2934                                 cerr << "Warning: Could not parse time `" << localtime
2935                                      << "´ for change tracking, using current time instead.\n";
2936                                 ptime = current_time();
2937                         }
2938                         if (t.cs() == "lyxadded")
2939                                 os << "\n\\change_inserted ";
2940                         else
2941                                 os << "\n\\change_deleted ";
2942                         os << author.bufferId() << ' ' << ptime << '\n';
2943                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
2944                         bool dvipost    = LaTeXPackages::isAvailable("dvipost");
2945                         bool xcolorulem = LaTeXPackages::isAvailable("ulem") &&
2946                                           LaTeXPackages::isAvailable("xcolor");
2947                         // No need to test for luatex, since luatex comes in
2948                         // two flavours (dvi and pdf), like latex, and those
2949                         // are detected by pdflatex.
2950                         if (pdflatex || xetex) {
2951                                 if (xcolorulem) {
2952                                         preamble.registerAutomaticallyLoadedPackage("ulem");
2953                                         preamble.registerAutomaticallyLoadedPackage("xcolor");
2954                                         preamble.registerAutomaticallyLoadedPackage("pdfcolmk");
2955                                 }
2956                         } else {
2957                                 if (dvipost) {
2958                                         preamble.registerAutomaticallyLoadedPackage("dvipost");
2959                                 } else if (xcolorulem) {
2960                                         preamble.registerAutomaticallyLoadedPackage("ulem");
2961                                         preamble.registerAutomaticallyLoadedPackage("xcolor");
2962                                 }
2963                         }
2964                 }
2965
2966                 else if (t.cs() == "phantom" || t.cs() == "hphantom" ||
2967                              t.cs() == "vphantom") {
2968                         context.check_layout(os);
2969                         if (t.cs() == "phantom")
2970                                 begin_inset(os, "Phantom Phantom\n");
2971                         if (t.cs() == "hphantom")
2972                                 begin_inset(os, "Phantom HPhantom\n");
2973                         if (t.cs() == "vphantom")
2974                                 begin_inset(os, "Phantom VPhantom\n");
2975                         os << "status open\n";
2976                         parse_text_in_inset(p, os, FLAG_ITEM, outer, context,
2977                                             "Phantom");
2978                         end_inset(os);
2979                 }
2980
2981                 else if (t.cs() == "href") {
2982                         context.check_layout(os);
2983                         string target = p.getArg('{', '}');
2984                         string name = p.getArg('{', '}');
2985                         string type;
2986                         size_t i = target.find(':');
2987                         if (i != string::npos) {
2988                                 type = target.substr(0, i + 1);
2989                                 if (type == "mailto:" || type == "file:")
2990                                         target = target.substr(i + 1);
2991                                 // handle the case that name is equal to target, except of "http://"
2992                                 else if (target.substr(i + 3) == name && type == "http:")
2993                                         target = name;
2994                         }
2995                         begin_command_inset(os, "href", "href");
2996                         if (name != target)
2997                                 os << "name \"" << name << "\"\n";
2998                         os << "target \"" << target << "\"\n";
2999                         if (type == "mailto:" || type == "file:")
3000                                 os << "type \"" << type << "\"\n";
3001                         end_inset(os);
3002                         skip_spaces_braces(p);
3003                 }
3004
3005                 else if (t.cs() == "lyxline") {
3006                         // swallow size argument (it is not used anyway)
3007                         p.getArg('{', '}');
3008                         if (!context.atParagraphStart()) {
3009                                 // so our line is in the middle of a paragraph
3010                                 // we need to add a new line, lest this line
3011                                 // follow the other content on that line and
3012                                 // run off the side of the page
3013                                 // FIXME: This may create an empty paragraph,
3014                                 //        but without that it would not be
3015                                 //        possible to set noindent below.
3016                                 //        Fortunately LaTeX does not care
3017                                 //        about the empty paragraph.
3018                                 context.new_paragraph(os);
3019                         }
3020                         if (preamble.indentParagraphs()) {
3021                                 // we need to unindent, lest the line be too long
3022                                 context.add_par_extra_stuff("\\noindent\n");
3023                         }
3024                         context.check_layout(os);
3025                         begin_command_inset(os, "line", "rule");
3026                         os << "offset \"0.5ex\"\n"
3027                               "width \"100line%\"\n"
3028                               "height \"1pt\"\n";
3029                         end_inset(os);
3030                 }
3031
3032                 else if (t.cs() == "rule") {
3033                         string const offset = (p.hasOpt() ? p.getArg('[', ']') : string());
3034                         string const width = p.getArg('{', '}');
3035                         string const thickness = p.getArg('{', '}');
3036                         context.check_layout(os);
3037                         begin_command_inset(os, "line", "rule");
3038                         if (!offset.empty())
3039                                 os << "offset \"" << translate_len(offset) << "\"\n";
3040                         os << "width \"" << translate_len(width) << "\"\n"
3041                                   "height \"" << translate_len(thickness) << "\"\n";
3042                         end_inset(os);
3043                 }
3044
3045                 else if (is_known(t.cs(), known_phrases) ||
3046                          (t.cs() == "protect" &&
3047                           p.next_token().cat() == catEscape &&
3048                           is_known(p.next_token().cs(), known_phrases))) {
3049                         // LyX sometimes puts a \protect in front, so we have to ignore it
3050                         // FIXME: This needs to be changed when bug 4752 is fixed.
3051                         where = is_known(
3052                                 t.cs() == "protect" ? p.get_token().cs() : t.cs(),
3053                                 known_phrases);
3054                         context.check_layout(os);
3055                         os << known_coded_phrases[where - known_phrases];
3056                         skip_spaces_braces(p);
3057                 }
3058
3059                 else if ((where = is_known(t.cs(), known_ref_commands))) {
3060                         string const opt = p.getOpt();
3061                         if (opt.empty()) {
3062                                 context.check_layout(os);
3063                                 begin_command_inset(os, "ref",
3064                                         known_coded_ref_commands[where - known_ref_commands]);
3065                                 os << "reference \""
3066                                    << convert_command_inset_arg(p.verbatim_item())
3067                                    << "\"\n";
3068                                 end_inset(os);
3069                                 if (t.cs() == "vref" || t.cs() == "vpageref")
3070                                         preamble.registerAutomaticallyLoadedPackage("varioref");
3071
3072                         } else {
3073                                 // LyX does not support optional arguments of ref commands
3074                                 handle_ert(os, t.asInput() + '[' + opt + "]{" +
3075                                                p.verbatim_item() + "}", context);
3076                         }
3077                 }
3078
3079                 else if (use_natbib &&
3080                          is_known(t.cs(), known_natbib_commands) &&
3081                          ((t.cs() != "citefullauthor" &&
3082                            t.cs() != "citeyear" &&
3083                            t.cs() != "citeyearpar") ||
3084                           p.next_token().asInput() != "*")) {
3085                         context.check_layout(os);
3086                         string command = t.cs();
3087                         if (p.next_token().asInput() == "*") {
3088                                 command += '*';
3089                                 p.get_token();
3090                         }
3091                         if (command == "citefullauthor")
3092                                 // alternative name for "\\citeauthor*"
3093                                 command = "citeauthor*";
3094
3095                         // text before the citation
3096                         string before;
3097                         // text after the citation
3098                         string after;
3099                         get_cite_arguments(p, true, before, after);
3100
3101                         if (command == "cite") {
3102                                 // \cite without optional argument means
3103                                 // \citet, \cite with at least one optional
3104                                 // argument means \citep.
3105                                 if (before.empty() && after.empty())
3106                                         command = "citet";
3107                                 else
3108                                         command = "citep";
3109                         }
3110                         if (before.empty() && after == "[]")
3111                                 // avoid \citet[]{a}
3112                                 after.erase();
3113                         else if (before == "[]" && after == "[]") {
3114                                 // avoid \citet[][]{a}
3115                                 before.erase();
3116                                 after.erase();
3117                         }
3118                         // remove the brackets around after and before
3119                         if (!after.empty()) {
3120                                 after.erase(0, 1);
3121                                 after.erase(after.length() - 1, 1);
3122                                 after = convert_command_inset_arg(after);
3123                         }
3124                         if (!before.empty()) {
3125                                 before.erase(0, 1);
3126                                 before.erase(before.length() - 1, 1);
3127                                 before = convert_command_inset_arg(before);
3128                         }
3129                         begin_command_inset(os, "citation", command);
3130                         os << "after " << '"' << after << '"' << "\n";
3131                         os << "before " << '"' << before << '"' << "\n";
3132                         os << "key \""
3133                            << convert_command_inset_arg(p.verbatim_item())
3134                            << "\"\n";
3135                         end_inset(os);
3136                 }
3137
3138                 else if (use_jurabib &&
3139                          is_known(t.cs(), known_jurabib_commands) &&
3140                          (t.cs() == "cite" || p.next_token().asInput() != "*")) {
3141                         context.check_layout(os);
3142                         string command = t.cs();
3143                         if (p.next_token().asInput() == "*") {
3144                                 command += '*';
3145                                 p.get_token();
3146                         }
3147                         char argumentOrder = '\0';
3148                         vector<string> const options =
3149                                 preamble.getPackageOptions("jurabib");
3150                         if (find(options.begin(), options.end(),
3151                                       "natbiborder") != options.end())
3152                                 argumentOrder = 'n';
3153                         else if (find(options.begin(), options.end(),
3154                                            "jurabiborder") != options.end())
3155                                 argumentOrder = 'j';
3156
3157                         // text before the citation
3158                         string before;
3159                         // text after the citation
3160                         string after;
3161                         get_cite_arguments(p, argumentOrder != 'j', before, after);
3162
3163                         string const citation = p.verbatim_item();
3164                         if (!before.empty() && argumentOrder == '\0') {
3165                                 cerr << "Warning: Assuming argument order "
3166                                         "of jurabib version 0.6 for\n'"
3167                                      << command << before << after << '{'
3168                                      << citation << "}'.\n"
3169                                         "Add 'jurabiborder' to the jurabib "
3170                                         "package options if you used an\n"
3171                                         "earlier jurabib version." << endl;
3172                         }
3173                         if (!after.empty()) {
3174                                 after.erase(0, 1);
3175                                 after.erase(after.length() - 1, 1);
3176                         }
3177                         if (!before.empty()) {
3178                                 before.erase(0, 1);
3179                                 before.erase(before.length() - 1, 1);
3180                         }
3181                         begin_command_inset(os, "citation", command);
3182                         os << "after " << '"' << after << '"' << "\n";
3183                         os << "before " << '"' << before << '"' << "\n";
3184                         os << "key " << '"' << citation << '"' << "\n";
3185                         end_inset(os);
3186                 }
3187
3188                 else if (t.cs() == "cite"
3189                         || t.cs() == "nocite") {
3190                         context.check_layout(os);
3191                         string after = convert_command_inset_arg(p.getArg('[', ']'));
3192                         string key = convert_command_inset_arg(p.verbatim_item());
3193                         // store the case that it is "\nocite{*}" to use it later for
3194                         // the BibTeX inset
3195                         if (key != "*") {
3196                                 begin_command_inset(os, "citation", t.cs());
3197                                 os << "after " << '"' << after << '"' << "\n";
3198                                 os << "key " << '"' << key << '"' << "\n";
3199                                 end_inset(os);
3200                         } else if (t.cs() == "nocite")
3201                                 btprint = key;
3202                 }
3203
3204                 else if (t.cs() == "index") {
3205                         context.check_layout(os);
3206                         begin_inset(os, "Index idx\n");
3207                         os << "status collapsed\n";
3208                         parse_text_in_inset(p, os, FLAG_ITEM, false, context, "Index");
3209                         end_inset(os);
3210                 }
3211
3212                 else if (t.cs() == "nomenclature") {
3213                         context.check_layout(os);
3214                         begin_command_inset(os, "nomenclature", "nomenclature");
3215                         string prefix = convert_command_inset_arg(p.getArg('[', ']'));
3216                         if (!prefix.empty())
3217                                 os << "prefix " << '"' << prefix << '"' << "\n";
3218                         os << "symbol " << '"'
3219                            << convert_command_inset_arg(p.verbatim_item());
3220                         os << "\"\ndescription \""
3221                            << convert_command_inset_arg(p.verbatim_item())
3222                            << "\"\n";
3223                         end_inset(os);
3224                         preamble.registerAutomaticallyLoadedPackage("nomencl");
3225                 }
3226
3227                 else if (t.cs() == "label") {
3228                         context.check_layout(os);
3229                         begin_command_inset(os, "label", "label");
3230                         os << "name \""
3231                            << convert_command_inset_arg(p.verbatim_item())
3232                            << "\"\n";
3233                         end_inset(os);
3234                 }
3235
3236                 else if (t.cs() == "printindex") {
3237                         context.check_layout(os);
3238                         begin_command_inset(os, "index_print", "printindex");
3239                         os << "type \"idx\"\n";
3240                         end_inset(os);
3241                         skip_spaces_braces(p);
3242                         preamble.registerAutomaticallyLoadedPackage("makeidx");
3243                         if (preamble.use_indices() == "true")
3244                                 preamble.registerAutomaticallyLoadedPackage("splitidx");
3245                 }
3246
3247                 else if (t.cs() == "printnomenclature") {
3248                         string width = "";
3249                         string width_type = "";
3250                         context.check_layout(os);
3251                         begin_command_inset(os, "nomencl_print", "printnomenclature");
3252                         // case of a custom width
3253                         if (p.hasOpt()) {
3254                                 width = p.getArg('[', ']');
3255                                 width = translate_len(width);
3256                                 width_type = "custom";
3257                         }
3258                         // case of no custom width
3259                         // the case of no custom width but the width set
3260                         // via \settowidth{\nomlabelwidth}{***} cannot be supported
3261                         // because the user could have set anything, not only the width
3262                         // of the longest label (which would be width_type = "auto")
3263                         string label = convert_command_inset_arg(p.getArg('{', '}'));
3264                         if (label.empty() && width_type.empty())
3265                                 width_type = "none";
3266                         os << "set_width \"" << width_type << "\"\n";
3267                         if (width_type == "custom")
3268                                 os << "width \"" << width << '\"';
3269                         end_inset(os);
3270                         skip_spaces_braces(p);
3271                         preamble.registerAutomaticallyLoadedPackage("nomencl");
3272                 }
3273
3274                 else if ((t.cs() == "textsuperscript" || t.cs() == "textsubscript")) {
3275                         context.check_layout(os);
3276                         begin_inset(os, "script ");
3277                         os << t.cs().substr(4) << '\n';
3278                         parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3279                         end_inset(os);
3280                         if (t.cs() == "textsubscript")
3281                                 preamble.registerAutomaticallyLoadedPackage("subscript");
3282                 }
3283
3284                 else if ((where = is_known(t.cs(), known_quotes))) {
3285                         context.check_layout(os);
3286                         begin_inset(os, "Quotes ");
3287                         os << known_coded_quotes[where - known_quotes];
3288                         end_inset(os);
3289                         // LyX adds {} after the quote, so we have to eat
3290                         // spaces here if there are any before a possible
3291                         // {} pair.
3292                         eat_whitespace(p, os, context, false);
3293                         skip_braces(p);
3294                 }
3295
3296                 else if ((where = is_known(t.cs(), known_sizes)) &&
3297                          context.new_layout_allowed) {
3298                         context.check_layout(os);
3299                         TeXFont const oldFont = context.font;
3300                         context.font.size = known_coded_sizes[where - known_sizes];
3301                         output_font_change(os, oldFont, context.font);
3302                         eat_whitespace(p, os, context, false);
3303                 }
3304
3305                 else if ((where = is_known(t.cs(), known_font_families)) &&
3306                          context.new_layout_allowed) {
3307                         context.check_layout(os);
3308                         TeXFont const oldFont = context.font;
3309                         context.font.family =
3310                                 known_coded_font_families[where - known_font_families];
3311                         output_font_change(os, oldFont, context.font);
3312                         eat_whitespace(p, os, context, false);
3313                 }
3314
3315                 else if ((where = is_known(t.cs(), known_font_series)) &&
3316                          context.new_layout_allowed) {
3317                         context.check_layout(os);
3318                         TeXFont const oldFont = context.font;
3319                         context.font.series =
3320                                 known_coded_font_series[where - known_font_series];
3321                         output_font_change(os, oldFont, context.font);
3322                         eat_whitespace(p, os, context, false);
3323                 }
3324
3325                 else if ((where = is_known(t.cs(), known_font_shapes)) &&
3326                          context.new_layout_allowed) {
3327                         context.check_layout(os);
3328                         TeXFont const oldFont = context.font;
3329                         context.font.shape =
3330                                 known_coded_font_shapes[where - known_font_shapes];
3331                         output_font_change(os, oldFont, context.font);
3332                         eat_whitespace(p, os, context, false);
3333                 }
3334                 else if ((where = is_known(t.cs(), known_old_font_families)) &&
3335                          context.new_layout_allowed) {
3336                         context.check_layout(os);
3337                         TeXFont const oldFont = context.font;
3338                         context.font.init();
3339                         context.font.size = oldFont.size;
3340                         context.font.family =
3341                                 known_coded_font_families[where - known_old_font_families];
3342                         output_font_change(os, oldFont, context.font);
3343                         eat_whitespace(p, os, context, false);
3344                 }
3345
3346                 else if ((where = is_known(t.cs(), known_old_font_series)) &&
3347                          context.new_layout_allowed) {
3348                         context.check_layout(os);
3349                         TeXFont const oldFont = context.font;
3350                         context.font.init();
3351                         context.font.size = oldFont.size;
3352                         context.font.series =
3353                                 known_coded_font_series[where - known_old_font_series];
3354                         output_font_change(os, oldFont, context.font);
3355                         eat_whitespace(p, os, context, false);
3356                 }
3357
3358                 else if ((where = is_known(t.cs(), known_old_font_shapes)) &&
3359                          context.new_layout_allowed) {
3360                         context.check_layout(os);
3361                         TeXFont const oldFont = context.font;
3362                         context.font.init();
3363                         context.font.size = oldFont.size;
3364                         context.font.shape =
3365                                 known_coded_font_shapes[where - known_old_font_shapes];
3366                         output_font_change(os, oldFont, context.font);
3367                         eat_whitespace(p, os, context, false);
3368                 }
3369
3370                 else if (t.cs() == "selectlanguage") {
3371                         context.check_layout(os);
3372                         // save the language for the case that a
3373                         // \foreignlanguage is used
3374
3375                         context.font.language = babel2lyx(p.verbatim_item());
3376                         os << "\n\\lang " << context.font.language << "\n";
3377                 }
3378
3379                 else if (t.cs() == "foreignlanguage") {
3380                         string const lang = babel2lyx(p.verbatim_item());
3381                         parse_text_attributes(p, os, FLAG_ITEM, outer,
3382                                               context, "\\lang",
3383                                               context.font.language, lang);
3384                 }
3385
3386                 else if (t.cs() == "inputencoding") {
3387                         // nothing to write here
3388                         string const enc = subst(p.verbatim_item(), "\n", " ");
3389                         p.setEncoding(enc);
3390                 }
3391
3392                 else if ((where = is_known(t.cs(), known_special_chars))) {
3393                         context.check_layout(os);
3394                         os << "\\SpecialChar \\"
3395                            << known_coded_special_chars[where - known_special_chars]
3396                            << '\n';
3397                         skip_spaces_braces(p);
3398                 }
3399
3400                 else if (t.cs() == "nobreakdash" && p.next_token().asInput() == "-") {
3401                         context.check_layout(os);
3402                         os << "\\SpecialChar \\nobreakdash-\n";
3403                         p.get_token();
3404                 }
3405
3406                 else if (t.cs() == "textquotedbl") {
3407                         context.check_layout(os);
3408                         os << "\"";
3409                         skip_braces(p);
3410                 }
3411
3412                 else if (t.cs() == "@" && p.next_token().asInput() == ".") {
3413                         context.check_layout(os);
3414                         os << "\\SpecialChar \\@.\n";
3415                         p.get_token();
3416                 }
3417
3418                 else if (t.cs() == "-") {
3419                         context.check_layout(os);
3420                         os << "\\SpecialChar \\-\n";
3421                 }
3422
3423                 else if (t.cs() == "textasciitilde") {
3424                         context.check_layout(os);
3425                         os << '~';
3426                         skip_spaces_braces(p);
3427                 }
3428
3429                 else if (t.cs() == "textasciicircum") {
3430                         context.check_layout(os);
3431                         os << '^';
3432                         skip_spaces_braces(p);
3433                 }
3434
3435                 else if (t.cs() == "textbackslash") {
3436                         context.check_layout(os);
3437                         os << "\n\\backslash\n";
3438                         skip_spaces_braces(p);
3439                 }
3440
3441                 else if (t.cs() == "_" || t.cs() == "&" || t.cs() == "#"
3442                             || t.cs() == "$" || t.cs() == "{" || t.cs() == "}"
3443                             || t.cs() == "%") {
3444                         context.check_layout(os);
3445                         os << t.cs();
3446                 }
3447
3448                 else if (t.cs() == "char") {
3449                         context.check_layout(os);
3450                         if (p.next_token().character() == '`') {
3451                                 p.get_token();
3452                                 if (p.next_token().cs() == "\"") {
3453                                         p.get_token();
3454                                         os << '"';
3455                                         skip_braces(p);
3456                                 } else {
3457                                         handle_ert(os, "\\char`", context);
3458                                 }
3459                         } else {
3460                                 handle_ert(os, "\\char", context);
3461                         }
3462                 }
3463
3464                 else if (t.cs() == "verb") {
3465                         context.check_layout(os);
3466                         char const delimiter = p.next_token().character();
3467                         string const arg = p.getArg(delimiter, delimiter);
3468                         ostringstream oss;
3469                         oss << "\\verb" << delimiter << arg << delimiter;
3470                         handle_ert(os, oss.str(), context);
3471                 }
3472
3473                 // Problem: \= creates a tabstop inside the tabbing environment
3474                 // and else an accent. In the latter case we really would want
3475                 // \={o} instead of \= o.
3476                 else if (t.cs() == "=" && (flags & FLAG_TABBING))
3477                         handle_ert(os, t.asInput(), context);
3478
3479                 // accents (see Table 6 in Comprehensive LaTeX Symbol List)
3480                 else if (t.cs().size() == 1
3481                          && contains("\"'.=^`bcdHkrtuv~", t.cs())) {
3482                         context.check_layout(os);
3483                         // try to see whether the string is in unicodesymbols
3484                         docstring rem;
3485                         string command = t.asInput() + "{"
3486                                 + trimSpaceAndEol(p.verbatim_item())
3487                                 + "}";
3488                         set<string> req;
3489                         docstring s = encodings.fromLaTeXCommand(from_utf8(command),
3490                                 Encodings::TEXT_CMD | Encodings::MATH_CMD, rem, &req);
3491                         if (!s.empty()) {
3492                                 if (!rem.empty())
3493                                         cerr << "When parsing " << command
3494                                              << ", result is " << to_utf8(s)
3495                                              << "+" << to_utf8(rem) << endl;
3496                                 os << to_utf8(s);
3497                                 for (set<string>::const_iterator it = req.begin(); it != req.end(); it++)
3498                                         preamble.registerAutomaticallyLoadedPackage(*it);
3499                         } else
3500                                 // we did not find a non-ert version
3501                                 handle_ert(os, command, context);
3502                 }
3503
3504                 else if (t.cs() == "\\") {
3505                         context.check_layout(os);
3506                         if (p.hasOpt())
3507                                 handle_ert(os, "\\\\" + p.getOpt(), context);
3508                         else if (p.next_token().asInput() == "*") {
3509                                 p.get_token();
3510                                 // getOpt() eats the following space if there
3511                                 // is no optional argument, but that is OK
3512                                 // here since it has no effect in the output.
3513                                 handle_ert(os, "\\\\*" + p.getOpt(), context);
3514                         }
3515                         else {
3516                                 begin_inset(os, "Newline newline");
3517                                 end_inset(os);
3518                         }
3519                 }
3520
3521                 else if (t.cs() == "newline" ||
3522                          (t.cs() == "linebreak" && !p.hasOpt())) {
3523                         context.check_layout(os);
3524                         begin_inset(os, "Newline ");
3525                         os << t.cs();
3526                         end_inset(os);
3527                         skip_spaces_braces(p);
3528                 }
3529
3530                 else if (t.cs() == "input" || t.cs() == "include"
3531                          || t.cs() == "verbatiminput") {
3532                         string name = t.cs();
3533                         if (t.cs() == "verbatiminput"
3534                             && p.next_token().asInput() == "*")
3535                                 name += p.get_token().asInput();
3536                         context.check_layout(os);
3537                         string filename(normalize_filename(p.getArg('{', '}')));
3538                         string const path = getMasterFilePath();
3539                         // We want to preserve relative / absolute filenames,
3540                         // therefore path is only used for testing
3541                         if ((t.cs() == "include" || t.cs() == "input") &&
3542                             !makeAbsPath(filename, path).exists()) {
3543                                 // The file extension is probably missing.
3544                                 // Now try to find it out.
3545                                 string const tex_name =
3546                                         find_file(filename, path,
3547                                                   known_tex_extensions);
3548                                 if (!tex_name.empty())
3549                                         filename = tex_name;
3550                         }
3551                         bool external = false;
3552                         string outname;
3553                         if (makeAbsPath(filename, path).exists()) {
3554                                 string const abstexname =
3555                                         makeAbsPath(filename, path).absFileName();
3556                                 string const abslyxname =
3557                                         changeExtension(abstexname, ".lyx");
3558                                 string const absfigname =
3559                                         changeExtension(abstexname, ".fig");
3560                                 fix_relative_filename(filename);
3561                                 string const lyxname =
3562                                         changeExtension(filename, ".lyx");
3563                                 bool xfig = false;
3564                                 external = FileName(absfigname).exists();
3565                                 if (t.cs() == "input") {
3566                                         string const ext = getExtension(abstexname);
3567
3568                                         // Combined PS/LaTeX:
3569                                         // x.eps, x.pstex_t (old xfig)
3570                                         // x.pstex, x.pstex_t (new xfig, e.g. 3.2.5)
3571                                         FileName const absepsname(
3572                                                 changeExtension(abstexname, ".eps"));
3573                                         FileName const abspstexname(
3574                                                 changeExtension(abstexname, ".pstex"));
3575                                         bool const xfigeps =
3576                                                 (absepsname.exists() ||
3577                                                  abspstexname.exists()) &&
3578                                                 ext == "pstex_t";
3579
3580                                         // Combined PDF/LaTeX:
3581                                         // x.pdf, x.pdftex_t (old xfig)
3582                                         // x.pdf, x.pdf_t (new xfig, e.g. 3.2.5)
3583                                         FileName const abspdfname(
3584                                                 changeExtension(abstexname, ".pdf"));
3585                                         bool const xfigpdf =
3586                                                 abspdfname.exists() &&
3587                                                 (ext == "pdftex_t" || ext == "pdf_t");
3588                                         if (xfigpdf)
3589                                                 pdflatex = true;
3590
3591                                         // Combined PS/PDF/LaTeX:
3592                                         // x_pspdftex.eps, x_pspdftex.pdf, x.pspdftex
3593                                         string const absbase2(
3594                                                 removeExtension(abstexname) + "_pspdftex");
3595                                         FileName const abseps2name(
3596                                                 addExtension(absbase2, ".eps"));
3597                                         FileName const abspdf2name(
3598                                                 addExtension(absbase2, ".pdf"));
3599                                         bool const xfigboth =
3600                                                 abspdf2name.exists() &&
3601                                                 abseps2name.exists() && ext == "pspdftex";
3602
3603                                         xfig = xfigpdf || xfigeps || xfigboth;
3604                                         external = external && xfig;
3605                                 }
3606                                 if (external) {
3607                                         outname = changeExtension(filename, ".fig");
3608                                 } else if (xfig) {
3609                                         // Don't try to convert, the result
3610                                         // would be full of ERT.
3611                                         outname = filename;
3612                                 } else if (t.cs() != "verbatiminput" &&
3613                                     tex2lyx(abstexname, FileName(abslyxname),
3614                                             p.getEncoding())) {
3615                                         outname = lyxname;
3616                                 } else {
3617                                         outname = filename;
3618                                 }
3619                         } else {
3620                                 cerr << "Warning: Could not find included file '"
3621                                      << filename << "'." << endl;
3622                                 outname = filename;
3623                         }
3624                         if (external) {
3625                                 begin_inset(os, "External\n");
3626                                 os << "\ttemplate XFig\n"
3627                                    << "\tfilename " << outname << '\n';
3628                                 registerExternalTemplatePackages("XFig");
3629                         } else {
3630                                 begin_command_inset(os, "include", name);
3631                                 os << "preview false\n"
3632                                       "filename \"" << outname << "\"\n";
3633                                 if (t.cs() == "verbatiminput")
3634                                         preamble.registerAutomaticallyLoadedPackage("verbatim");
3635                         }
3636                         end_inset(os);
3637                 }
3638
3639                 else if (t.cs() == "bibliographystyle") {
3640                         // store new bibliographystyle
3641                         bibliographystyle = p.verbatim_item();
3642                         // If any other command than \bibliography and
3643                         // \nocite{*} follows, we need to output the style
3644                         // (because it might be used by that command).
3645                         // Otherwise, it will automatically be output by LyX.
3646                         p.pushPosition();
3647                         bool output = true;
3648                         for (Token t2 = p.get_token(); p.good(); t2 = p.get_token()) {
3649                                 if (t2.cat() == catBegin)
3650                                         break;
3651                                 if (t2.cat() != catEscape)
3652                                         continue;
3653                                 if (t2.cs() == "nocite") {
3654                                         if (p.getArg('{', '}') == "*")
3655                                                 continue;
3656                                 } else if (t2.cs() == "bibliography")
3657                                         output = false;
3658                                 break;
3659                         }
3660                         p.popPosition();
3661                         if (output) {
3662                                 handle_ert(os,
3663                                         "\\bibliographystyle{" + bibliographystyle + '}',
3664                                         context);
3665                         }
3666                 }
3667
3668                 else if (t.cs() == "bibliography") {
3669                         context.check_layout(os);
3670                         begin_command_inset(os, "bibtex", "bibtex");
3671                         if (!btprint.empty()) {
3672                                 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
3673                                 // clear the string because the next BibTeX inset can be without the
3674                                 // \nocite{*} option
3675                                 btprint.clear();
3676                         }
3677                         os << "bibfiles " << '"' << p.verbatim_item() << '"' << "\n";
3678                         // Do we have a bibliographystyle set?
3679                         if (!bibliographystyle.empty())
3680                                 os << "options " << '"' << bibliographystyle << '"' << "\n";
3681                         end_inset(os);
3682                 }
3683
3684                 else if (t.cs() == "parbox") {
3685                         // Test whether this is an outer box of a shaded box
3686                         p.pushPosition();
3687                         // swallow arguments
3688                         while (p.hasOpt()) {
3689                                 p.getArg('[', ']');
3690                                 p.skip_spaces(true);
3691                         }
3692                         p.getArg('{', '}');
3693                         p.skip_spaces(true);
3694                         // eat the '{'
3695                         if (p.next_token().cat() == catBegin)
3696                                 p.get_token();
3697                         p.skip_spaces(true);
3698                         Token to = p.get_token();
3699                         bool shaded = false;
3700                         if (to.asInput() == "\\begin") {
3701                                 p.skip_spaces(true);
3702                                 if (p.getArg('{', '}') == "shaded")
3703                                         shaded = true;
3704                         }
3705                         p.popPosition();
3706                         if (shaded) {
3707                                 parse_outer_box(p, os, FLAG_ITEM, outer,
3708                                                 context, "parbox", "shaded");
3709                         } else
3710                                 parse_box(p, os, 0, FLAG_ITEM, outer, context,
3711                                           "", "", t.cs());
3712                 }
3713
3714                 else if (t.cs() == "ovalbox" || t.cs() == "Ovalbox" ||
3715                          t.cs() == "shadowbox" || t.cs() == "doublebox")
3716                         parse_outer_box(p, os, FLAG_ITEM, outer, context, t.cs(), "");
3717
3718                 else if (t.cs() == "framebox") {
3719                         if (p.next_token().character() == '(') {
3720                                 //the syntax is: \framebox(x,y)[position]{content}
3721                                 string arg = t.asInput();
3722                                 arg += p.getFullParentheseArg();
3723                                 arg += p.getFullOpt();
3724                                 eat_whitespace(p, os, context, false);
3725                                 handle_ert(os, arg + '{', context);
3726                                 eat_whitespace(p, os, context, false);
3727                                 parse_text(p, os, FLAG_ITEM, outer, context);
3728                                 handle_ert(os, "}", context);
3729                         } else {
3730                                 string special = p.getFullOpt();
3731                                 special += p.getOpt();
3732                                 parse_outer_box(p, os, FLAG_ITEM, outer,
3733                                                 context, t.cs(), special);
3734                         }
3735                 }
3736
3737                 //\makebox() is part of the picture environment and different from \makebox{}
3738                 //\makebox{} will be parsed by parse_box
3739                 else if (t.cs() == "makebox") {
3740                         if (p.next_token().character() == '(') {
3741                                 //the syntax is: \makebox(x,y)[position]{content}
3742                                 string arg = t.asInput();
3743                                 arg += p.getFullParentheseArg();
3744                                 arg += p.getFullOpt();
3745                                 eat_whitespace(p, os, context, false);
3746                                 handle_ert(os, arg + '{', context);
3747                                 eat_whitespace(p, os, context, false);
3748                                 parse_text(p, os, FLAG_ITEM, outer, context);
3749                                 handle_ert(os, "}", context);
3750                         } else
3751                                 //the syntax is: \makebox[width][position]{content}
3752                                 parse_box(p, os, 0, FLAG_ITEM, outer, context,
3753                                           "", "", t.cs());
3754                 }
3755
3756                 else if (t.cs() == "smallskip" ||
3757                          t.cs() == "medskip" ||
3758                          t.cs() == "bigskip" ||
3759                          t.cs() == "vfill") {
3760                         context.check_layout(os);
3761                         begin_inset(os, "VSpace ");
3762                         os << t.cs();
3763                         end_inset(os);
3764                         skip_spaces_braces(p);
3765                 }
3766
3767                 else if ((where = is_known(t.cs(), known_spaces))) {
3768                         context.check_layout(os);
3769                         begin_inset(os, "space ");
3770                         os << '\\' << known_coded_spaces[where - known_spaces]
3771                            << '\n';
3772                         end_inset(os);
3773                         // LaTeX swallows whitespace after all spaces except
3774                         // "\\,". We have to do that here, too, because LyX
3775                         // adds "{}" which would make the spaces significant.
3776                         if (t.cs() !=  ",")
3777                                 eat_whitespace(p, os, context, false);
3778                         // LyX adds "{}" after all spaces except "\\ " and
3779                         // "\\,", so we have to remove "{}".
3780                         // "\\,{}" is equivalent to "\\," in LaTeX, so we
3781                         // remove the braces after "\\,", too.
3782                         if (t.cs() != " ")
3783                                 skip_braces(p);
3784                 }
3785
3786                 else if (t.cs() == "newpage" ||
3787                          (t.cs() == "pagebreak" && !p.hasOpt()) ||
3788                          t.cs() == "clearpage" ||
3789                          t.cs() == "cleardoublepage") {
3790                         context.check_layout(os);
3791                         begin_inset(os, "Newpage ");
3792                         os << t.cs();
3793                         end_inset(os);
3794                         skip_spaces_braces(p);
3795                 }
3796
3797                 else if (t.cs() == "DeclareRobustCommand" ||
3798                          t.cs() == "DeclareRobustCommandx" ||
3799                          t.cs() == "newcommand" ||
3800                          t.cs() == "newcommandx" ||
3801                          t.cs() == "providecommand" ||
3802                          t.cs() == "providecommandx" ||
3803                          t.cs() == "renewcommand" ||
3804                          t.cs() == "renewcommandx") {
3805                         // DeclareRobustCommand, DeclareRobustCommandx,
3806                         // providecommand and providecommandx could be handled
3807                         // by parse_command(), but we need to call
3808                         // add_known_command() here.
3809                         string name = t.asInput();
3810                         if (p.next_token().asInput() == "*") {
3811                                 // Starred form. Eat '*'
3812                                 p.get_token();
3813                                 name += '*';
3814                         }
3815                         string const command = p.verbatim_item();
3816                         string const opt1 = p.getFullOpt();
3817                         string const opt2 = p.getFullOpt();
3818                         add_known_command(command, opt1, !opt2.empty());
3819                         string const ert = name + '{' + command + '}' +
3820                                            opt1 + opt2 +
3821                                            '{' + p.verbatim_item() + '}';
3822
3823                         if (t.cs() == "DeclareRobustCommand" ||
3824                             t.cs() == "DeclareRobustCommandx" ||
3825                             t.cs() == "providecommand" ||
3826                             t.cs() == "providecommandx" ||
3827                             name[name.length()-1] == '*')
3828                                 handle_ert(os, ert, context);
3829                         else {
3830                                 context.check_layout(os);
3831                                 begin_inset(os, "FormulaMacro");
3832                                 os << "\n" << ert;
3833                                 end_inset(os);
3834                         }
3835                 }
3836
3837                 else if (t.cs() == "let" && p.next_token().asInput() != "*") {
3838                         // let could be handled by parse_command(),
3839                         // but we need to call add_known_command() here.
3840                         string ert = t.asInput();
3841                         string name;
3842                         p.skip_spaces();
3843                         if (p.next_token().cat() == catBegin) {
3844                                 name = p.verbatim_item();
3845                                 ert += '{' + name + '}';
3846                         } else {
3847                                 name = p.verbatim_item();
3848                                 ert += name;
3849                         }
3850                         string command;
3851                         p.skip_spaces();
3852                         if (p.next_token().cat() == catBegin) {
3853                                 command = p.verbatim_item();
3854                                 ert += '{' + command + '}';
3855                         } else {
3856                                 command = p.verbatim_item();
3857                                 ert += command;
3858                         }
3859                         // If command is known, make name known too, to parse
3860                         // its arguments correctly. For this reason we also
3861                         // have commands in syntax.default that are hardcoded.
3862                         CommandMap::iterator it = known_commands.find(command);
3863                         if (it != known_commands.end())
3864                                 known_commands[t.asInput()] = it->second;
3865                         handle_ert(os, ert, context);
3866                 }
3867
3868                 else if (t.cs() == "hspace" || t.cs() == "vspace") {
3869                         bool starred = false;
3870                         if (p.next_token().asInput() == "*") {
3871                                 p.get_token();
3872                                 starred = true;
3873                         }
3874                         string name = t.asInput();
3875                         string const length = p.verbatim_item();
3876                         string unit;
3877                         string valstring;
3878                         bool valid = splitLatexLength(length, valstring, unit);
3879                         bool known_hspace = false;
3880                         bool known_vspace = false;
3881                         bool known_unit = false;
3882                         double value;
3883                         if (valid) {
3884                                 istringstream iss(valstring);
3885                                 iss >> value;
3886                                 if (value == 1.0) {
3887                                         if (t.cs()[0] == 'h') {
3888                                                 if (unit == "\\fill") {
3889                                                         if (!starred) {
3890                                                                 unit = "";
3891                                                                 name = "\\hfill";
3892                                                         }
3893                                                         known_hspace = true;
3894                                                 }
3895                                         } else {
3896                                                 if (unit == "\\smallskipamount") {
3897                                                         unit = "smallskip";
3898                                                         known_vspace = true;
3899                                                 } else if (unit == "\\medskipamount") {
3900                                                         unit = "medskip";
3901                                                         known_vspace = true;
3902                                                 } else if (unit == "\\bigskipamount") {
3903                                                         unit = "bigskip";
3904                                                         known_vspace = true;
3905                                                 } else if (unit == "\\fill") {
3906                                                         unit = "vfill";
3907                                                         known_vspace = true;
3908                                                 }
3909                                         }
3910                                 }
3911                                 if (!known_hspace && !known_vspace) {
3912                                         switch (unitFromString(unit)) {
3913                                         case Length::SP:
3914                                         case Length::PT:
3915                                         case Length::BP:
3916                                         case Length::DD:
3917                                         case Length::MM:
3918                                         case Length::PC:
3919                                         case Length::CC:
3920                                         case Length::CM:
3921                                         case Length::IN:
3922                                         case Length::EX:
3923                                         case Length::EM:
3924                                         case Length::MU:
3925                                                 known_unit = true;
3926                                                 break;
3927                                         default:
3928                                                 break;
3929                                         }
3930                                 }
3931                         }
3932
3933                         if (t.cs()[0] == 'h' && (known_unit || known_hspace)) {
3934                                 // Literal horizontal length or known variable
3935                                 context.check_layout(os);
3936                                 begin_inset(os, "space ");
3937                                 os << name;
3938                                 if (starred)
3939                                         os << '*';
3940                                 os << '{';
3941                                 if (known_hspace)
3942                                         os << unit;
3943                                 os << "}";
3944                                 if (known_unit && !known_hspace)
3945                                         os << "\n\\length "
3946                                            << translate_len(length);
3947                                 end_inset(os);
3948                         } else if (known_unit || known_vspace) {
3949                                 // Literal vertical length or known variable
3950                                 context.check_layout(os);
3951                                 begin_inset(os, "VSpace ");
3952                                 if (known_unit)
3953                                         os << value;
3954                                 os << unit;
3955                                 if (starred)
3956                                         os << '*';
3957                                 end_inset(os);
3958                         } else {
3959                                 // LyX can't handle other length variables in Inset VSpace/space
3960                                 if (starred)
3961                                         name += '*';
3962                                 if (valid) {
3963                                         if (value == 1.0)
3964                                                 handle_ert(os, name + '{' + unit + '}', context);
3965                                         else if (value == -1.0)
3966                                                 handle_ert(os, name + "{-" + unit + '}', context);
3967                                         else
3968                                                 handle_ert(os, name + '{' + valstring + unit + '}', context);
3969                                 } else
3970                                         handle_ert(os, name + '{' + length + '}', context);
3971                         }
3972                 }
3973
3974                 // The single '=' is meant here.
3975                 else if ((newinsetlayout = findInsetLayout(context.textclass, t.cs(), true))) {
3976                         p.skip_spaces();
3977                         context.check_layout(os);
3978                         begin_inset(os, "Flex ");
3979                         os << to_utf8(newinsetlayout->name()) << '\n'
3980                            << "status collapsed\n";
3981                         parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
3982                         end_inset(os);
3983                 }
3984
3985                 else if (t.cs() == "includepdf") {
3986                         p.skip_spaces();
3987                         string const arg = p.getArg('[', ']');
3988                         map<string, string> opts;
3989                         vector<string> keys;
3990                         split_map(arg, opts, keys);
3991                         string name = normalize_filename(p.verbatim_item());
3992                         string const path = getMasterFilePath();
3993                         // We want to preserve relative / absolute filenames,
3994                         // therefore path is only used for testing
3995                         if (!makeAbsPath(name, path).exists()) {
3996                                 // The file extension is probably missing.
3997                                 // Now try to find it out.
3998                                 char const * const pdfpages_format[] = {"pdf", 0};
3999                                 string const pdftex_name =
4000                                         find_file(name, path, pdfpages_format);
4001                                 if (!pdftex_name.empty()) {
4002                                         name = pdftex_name;
4003                                         pdflatex = true;
4004                                 }
4005                         }
4006                         if (makeAbsPath(name, path).exists())
4007                                 fix_relative_filename(name);
4008                         else
4009                                 cerr << "Warning: Could not find file '"
4010                                      << name << "'." << endl;
4011                         // write output
4012                         context.check_layout(os);
4013                         begin_inset(os, "External\n\ttemplate ");
4014                         os << "PDFPages\n\tfilename "
4015                            << name << "\n";
4016                         // parse the options
4017                         if (opts.find("pages") != opts.end())
4018                                 os << "\textra LaTeX \"pages="
4019                                    << opts["pages"] << "\"\n";
4020                         if (opts.find("angle") != opts.end())
4021                                 os << "\trotateAngle "
4022                                    << opts["angle"] << '\n';
4023                         if (opts.find("origin") != opts.end()) {
4024                                 ostringstream ss;
4025                                 string const opt = opts["origin"];
4026                                 if (opt == "tl") ss << "topleft";
4027                                 if (opt == "bl") ss << "bottomleft";
4028                                 if (opt == "Bl") ss << "baselineleft";
4029                                 if (opt == "c") ss << "center";
4030                                 if (opt == "tc") ss << "topcenter";
4031                                 if (opt == "bc") ss << "bottomcenter";
4032                                 if (opt == "Bc") ss << "baselinecenter";
4033                                 if (opt == "tr") ss << "topright";
4034                                 if (opt == "br") ss << "bottomright";
4035                                 if (opt == "Br") ss << "baselineright";
4036                                 if (!ss.str().empty())
4037                                         os << "\trotateOrigin " << ss.str() << '\n';
4038                                 else
4039                                         cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
4040                         }
4041                         if (opts.find("width") != opts.end())
4042                                 os << "\twidth "
4043                                    << translate_len(opts["width"]) << '\n';
4044                         if (opts.find("height") != opts.end())
4045                                 os << "\theight "
4046                                    << translate_len(opts["height"]) << '\n';
4047                         if (opts.find("keepaspectratio") != opts.end())
4048                                 os << "\tkeepAspectRatio\n";
4049                         end_inset(os);
4050                         context.check_layout(os);
4051                         registerExternalTemplatePackages("PDFPages");
4052                 }
4053
4054                 else if (t.cs() == "loadgame") {
4055                         p.skip_spaces();
4056                         string name = normalize_filename(p.verbatim_item());
4057                         string const path = getMasterFilePath();
4058                         // We want to preserve relative / absolute filenames,
4059                         // therefore path is only used for testing
4060                         if (!makeAbsPath(name, path).exists()) {
4061                                 // The file extension is probably missing.
4062                                 // Now try to find it out.
4063                                 char const * const lyxskak_format[] = {"fen", 0};
4064                                 string const lyxskak_name =
4065                                         find_file(name, path, lyxskak_format);
4066                                 if (!lyxskak_name.empty())
4067                                         name = lyxskak_name;
4068                         }
4069                         if (makeAbsPath(name, path).exists())
4070                                 fix_relative_filename(name);
4071                         else
4072                                 cerr << "Warning: Could not find file '"
4073                                      << name << "'." << endl;
4074                         context.check_layout(os);
4075                         begin_inset(os, "External\n\ttemplate ");
4076                         os << "ChessDiagram\n\tfilename "
4077                            << name << "\n";
4078                         end_inset(os);
4079                         context.check_layout(os);
4080                         // after a \loadgame follows a \showboard
4081                         if (p.get_token().asInput() == "showboard")
4082                                 p.get_token();
4083                         registerExternalTemplatePackages("ChessDiagram");
4084                 }
4085
4086                 else {
4087                         // try to see whether the string is in unicodesymbols
4088                         // Only use text mode commands, since we are in text mode here,
4089                         // and math commands may be invalid (bug 6797)
4090                         docstring rem;
4091                         set<string> req;
4092                         docstring s = encodings.fromLaTeXCommand(from_utf8(t.asInput()),
4093                                                                  Encodings::TEXT_CMD, rem, &req);
4094                         if (!s.empty()) {
4095                                 if (!rem.empty())
4096                                         cerr << "When parsing " << t.cs()
4097                                              << ", result is " << to_utf8(s)
4098                                              << "+" << to_utf8(rem) << endl;
4099                                 context.check_layout(os);
4100                                 os << to_utf8(s);
4101                                 skip_spaces_braces(p);
4102                                 for (set<string>::const_iterator it = req.begin(); it != req.end(); it++)
4103                                         preamble.registerAutomaticallyLoadedPackage(*it);
4104                         }
4105                         //cerr << "#: " << t << " mode: " << mode << endl;
4106                         // heuristic: read up to next non-nested space
4107                         /*
4108                         string s = t.asInput();
4109                         string z = p.verbatim_item();
4110                         while (p.good() && z != " " && z.size()) {
4111                                 //cerr << "read: " << z << endl;
4112                                 s += z;
4113                                 z = p.verbatim_item();
4114                         }
4115                         cerr << "found ERT: " << s << endl;
4116                         handle_ert(os, s + ' ', context);
4117                         */
4118                         else {
4119                                 string name = t.asInput();
4120                                 if (p.next_token().asInput() == "*") {
4121                                         // Starred commands like \vspace*{}
4122                                         p.get_token();  // Eat '*'
4123                                         name += '*';
4124                                 }
4125                                 if (!parse_command(name, p, os, outer, context))
4126                                         handle_ert(os, name, context);
4127                         }
4128                 }
4129
4130                 if (flags & FLAG_LEAVE) {
4131                         flags &= ~FLAG_LEAVE;
4132                         break;
4133                 }
4134         }
4135 }
4136
4137 // }])
4138
4139
4140 } // namespace lyx