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 namespace {
  49
  50 void output_arguments(ostream &, Parser &, bool, bool, string, Context &,
  51                       Layout::LaTeXArgMap const &);
  52
  53 }
  54
  55
  56 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
  57                 Context const & context, InsetLayout const * layout,
  58                 string const rdelim)
  59 {
  60         bool const forcePlainLayout =
  61                 layout ? layout->forcePlainLayout() : false;
  62         Context newcontext(true, context.textclass);
  63         if (forcePlainLayout)
  64                 newcontext.layout = &context.textclass.plainLayout();
  65         else
  66                 newcontext.font = context.font;
  67         if (layout)
  68                 output_arguments(os, p, outer, false, string(), newcontext,
  69                                  layout->latexargs());
  70         // If we have a latex param, we eat it here.
  71         if (!context.latexparam.empty()) {
  72                 ostringstream oss;
  73                 Context dummy(true, context.textclass);
  74                 parse_text(p, oss, FLAG_RDELIM, outer, dummy,
  75                            string(1, context.latexparam.back()));
  76         }
  77         parse_text(p, os, flags, outer, newcontext, rdelim);
  78         if (layout)
  79                 output_arguments(os, p, outer, false, "post", newcontext,
  80                                  layout->postcommandargs());
  81         newcontext.check_end_layout(os);
  82 }
  83
  84
  85 namespace {
  86
  87 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
  88                 Context const & context, string const & name,
  89                 string const rdelim = string())
  90 {
  91         InsetLayout const * layout = 0;
  92         DocumentClass::InsetLayouts::const_iterator it =
  93                 context.textclass.insetLayouts().find(from_ascii(name));
  94         if (it != context.textclass.insetLayouts().end())
  95                 layout = &(it->second);
  96         parse_text_in_inset(p, os, flags, outer, context, layout, rdelim);
  97 }
  98
  99 /// parses a paragraph snippet, useful for example for \\emph{...}
 100 void parse_text_snippet(Parser & p, ostream & os, unsigned flags, bool outer,
 101                 Context & context)
 102 {
 103         Context newcontext(context);
 104         // Don't inherit the paragraph-level extra stuff
 105         newcontext.par_extra_stuff.clear();
 106         parse_text(p, os, flags, outer, newcontext);
 107         // Make sure that we don't create invalid .lyx files
 108         context.need_layout = newcontext.need_layout;
 109         context.need_end_layout = newcontext.need_end_layout;
 110 }
 111
 112
 113 /*!
 114  * Thin wrapper around parse_text_snippet() using a string.
 115  *
 116  * We completely ignore \c context.need_layout and \c context.need_end_layout,
 117  * because our return value is not used directly (otherwise the stream version
 118  * of parse_text_snippet() could be used). That means that the caller needs
 119  * to do layout management manually.
 120  * This is intended to parse text that does not create any layout changes.
 121  */
 122 string parse_text_snippet(Parser & p, unsigned flags, const bool outer,
 123                   Context & context)
 124 {
 125         Context newcontext(context);
 126         newcontext.need_layout = false;
 127         newcontext.need_end_layout = false;
 128         newcontext.new_layout_allowed = false;
 129         // Avoid warning by Context::~Context()
 130         newcontext.par_extra_stuff.clear();
 131         ostringstream os;
 132         parse_text_snippet(p, os, flags, outer, newcontext);
 133         return os.str();
 134 }
 135
 136 string fboxrule = "";
 137 string fboxsep = "";
 138 string shadow_size = "";
 139
 140 char const * const known_ref_commands[] = { "ref", "pageref", "vref",
 141  "vpageref", "prettyref", "nameref", "eqref", 0 };
 142
 143 char const * const known_coded_ref_commands[] = { "ref", "pageref", "vref",
 144  "vpageref", "formatted", "nameref", "eqref", 0 };
 145
 146 char const * const known_refstyle_commands[] = { "algref", "chapref", "corref",
 147  "eqref", "enuref", "figref", "fnref", "lemref", "parref", "partref", "propref",
 148  "secref", "subsecref", "tabref", "thmref", 0 };
 149
 150 char const * const known_refstyle_prefixes[] = { "alg", "chap", "cor",
 151  "eq", "enu", "fig", "fn", "lem", "par", "part", "prop",
 152  "sec", "subsec", "tab", "thm", 0 };
 153
 154
 155 /**
 156  * supported CJK encodings
 157  * JIS does not work with LyX's encoding conversion
 158  */
 159 const char * const supported_CJK_encodings[] = {
 160 "EUC-JP", "KS", "GB", "UTF8",
 161 "Bg5", /*"JIS",*/ "SJIS", 0};
 162
 163 /**
 164  * the same as supported_CJK_encodings with their corresponding LyX language name
 165  * FIXME: The mapping "UTF8" => "chinese-traditional" is only correct for files
 166  *        created by LyX.
 167  * NOTE: "Bg5", "JIS" and "SJIS" are not supported by LyX, on re-export the
 168  *       encodings "UTF8", "EUC-JP" and "EUC-JP" will be used.
 169  * please keep this in sync with supported_CJK_encodings line by line!
 170  */
 171 const char * const supported_CJK_languages[] = {
 172 "japanese-cjk", "korean", "chinese-simplified", "chinese-traditional",
 173 "chinese-traditional", /*"japanese-cjk",*/ "japanese-cjk", 0};
 174
 175 /*!
 176  * natbib commands.
 177  * The starred forms are also known except for "citefullauthor",
 178  * "citeyear" and "citeyearpar".
 179  */
 180 char const * const known_natbib_commands[] = { "cite", "citet", "citep",
 181 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
 182 "citefullauthor", "Citet", "Citep", "Citealt", "Citealp", "Citeauthor", 0 };
 183
 184 /*!
 185  * jurabib commands.
 186  * No starred form other than "cite*" known.
 187  */
 188 char const * const known_jurabib_commands[] = { "cite", "citet", "citep",
 189 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
 190 // jurabib commands not (yet) supported by LyX:
 191 // "fullcite",
 192 // "footcite", "footcitet", "footcitep", "footcitealt", "footcitealp",
 193 // "footciteauthor", "footciteyear", "footciteyearpar",
 194 "citefield", "citetitle", 0 };
 195
 196 /*!
 197  * biblatex commands.
 198  * Known starred forms: \cite*, \citeauthor*, \Citeauthor*, \parencite*, \citetitle*.
 199  */
 200 char const * const known_biblatex_commands[] = { "cite", "Cite", "textcite", "Textcite",
 201 "parencite", "Parencite", "citeauthor", "Citeauthor", "citeyear", "smartcite", "Smartcite",
 202  "footcite", "Footcite", "autocite", "Autocite", "citetitle", "fullcite", "footfullcite",
 203 "supercite", "cites", "Cites", "textcites", "Textcites", "parencites", "Parencites",
 204 "smartcites", "Smartcites", "autocites", "Autocites", 0 };
 205
 206 // Whether we need to insert a bibtex inset in a comment
 207 bool need_commentbib = false;
 208
 209 /// LaTeX names for quotes
 210 char const * const known_quotes[] = { "dq", "guillemotleft", "flqq", "og",
 211 "guillemotright", "frqq", "fg", "glq", "glqq", "textquoteleft", "grq", "grqq",
 212 "quotedblbase", "textquotedblleft", "quotesinglbase", "textquoteright", "flq",
 213 "guilsinglleft", "frq", "guilsinglright", "textquotedblright", "textquotesingle",
 214 "textquotedbl", 0};
 215
 216 /// the same as known_quotes with .lyx names
 217 char const * const known_coded_quotes[] = { "qrd", "ard", "ard", "ard",
 218 "ald", "ald", "ald", "gls", "gld", "els", "els", "eld",
 219 "gld", "eld", "gls", "ers", "ars",
 220 "ars", "als", "als", "erd", "qrs", "qrd", 0};
 221
 222 /// LaTeX names for font sizes
 223 char const * const known_sizes[] = { "tiny", "scriptsize", "footnotesize",
 224 "small", "normalsize", "large", "Large", "LARGE", "huge", "Huge", 0};
 225
 226 /// the same as known_sizes with .lyx names
 227 char const * const known_coded_sizes[] = { "tiny", "scriptsize", "footnotesize",
 228 "small", "normal", "large", "larger", "largest", "huge", "giant", 0};
 229
 230 /// LaTeX 2.09 names for font families
 231 char const * const known_old_font_families[] = { "rm", "sf", "tt", 0};
 232
 233 /// LaTeX names for font families
 234 char const * const known_font_families[] = { "rmfamily", "sffamily",
 235 "ttfamily", 0};
 236
 237 /// LaTeX names for font family changing commands
 238 char const * const known_text_font_families[] = { "textrm", "textsf",
 239 "texttt", 0};
 240
 241 /// The same as known_old_font_families, known_font_families and
 242 /// known_text_font_families with .lyx names
 243 char const * const known_coded_font_families[] = { "roman", "sans",
 244 "typewriter", 0};
 245
 246 /// LaTeX 2.09 names for font series
 247 char const * const known_old_font_series[] = { "bf", 0};
 248
 249 /// LaTeX names for font series
 250 char const * const known_font_series[] = { "bfseries", "mdseries", 0};
 251
 252 /// LaTeX names for font series changing commands
 253 char const * const known_text_font_series[] = { "textbf", "textmd", 0};
 254
 255 /// The same as known_old_font_series, known_font_series and
 256 /// known_text_font_series with .lyx names
 257 char const * const known_coded_font_series[] = { "bold", "medium", 0};
 258
 259 /// LaTeX 2.09 names for font shapes
 260 char const * const known_old_font_shapes[] = { "it", "sl", "sc", 0};
 261
 262 /// LaTeX names for font shapes
 263 char const * const known_font_shapes[] = { "itshape", "slshape", "scshape",
 264 "upshape", 0};
 265
 266 /// LaTeX names for font shape changing commands
 267 char const * const known_text_font_shapes[] = { "textit", "textsl", "textsc",
 268 "textup", 0};
 269
 270 /// The same as known_old_font_shapes, known_font_shapes and
 271 /// known_text_font_shapes with .lyx names
 272 char const * const known_coded_font_shapes[] = { "italic", "slanted",
 273 "smallcaps", "up", 0};
 274
 275 /// Known special characters which need skip_spaces_braces() afterwards
 276 char const * const known_special_chars[] = {"ldots",
 277 "lyxarrow", "textcompwordmark",
 278 "slash", "textasciitilde", "textasciicircum", "textbackslash",
 279 "LyX", "TeX", "LaTeXe",
 280 "LaTeX", 0};
 281
 282 /// special characters from known_special_chars which may have a \\protect before
 283 char const * const known_special_protect_chars[] = {"LyX", "TeX",
 284 "LaTeXe", "LaTeX", 0};
 285
 286 /// the same as known_special_chars with .lyx names
 287 char const * const known_coded_special_chars[] = {"\\SpecialChar ldots\n",
 288 "\\SpecialChar menuseparator\n", "\\SpecialChar ligaturebreak\n",
 289 "\\SpecialChar breakableslash\n", "~", "^", "\n\\backslash\n",
 290 "\\SpecialChar LyX\n", "\\SpecialChar TeX\n", "\\SpecialChar LaTeX2e\n",
 291 "\\SpecialChar LaTeX\n", 0};
 292
 293 /*!
 294  * Graphics file extensions known by the dvips driver of the graphics package.
 295  * These extensions are used to complete the filename of an included
 296  * graphics file if it does not contain an extension.
 297  * The order must be the same that latex uses to find a file, because we
 298  * will use the first extension that matches.
 299  * This is only an approximation for the common cases. If we would want to
 300  * do it right in all cases, we would need to know which graphics driver is
 301  * used and know the extensions of every driver of the graphics package.
 302  */
 303 char const * const known_dvips_graphics_formats[] = {"eps", "ps", "eps.gz",
 304 "ps.gz", "eps.Z", "ps.Z", 0};
 305
 306 /*!
 307  * Graphics file extensions known by the pdftex driver of the graphics package.
 308  * \sa known_dvips_graphics_formats
 309  */
 310 char const * const known_pdftex_graphics_formats[] = {"png", "pdf", "jpg",
 311 "mps", "tif", 0};
 312
 313 /*!
 314  * Known file extensions for TeX files as used by \\include.
 315  */
 316 char const * const known_tex_extensions[] = {"tex", 0};
 317
 318 /// spaces known by InsetSpace
 319 char const * const known_spaces[] = { " ", "space", ",",
 320 "thinspace", "quad", "qquad", "enspace", "enskip",
 321 "negthinspace", "negmedspace", "negthickspace", "textvisiblespace",
 322 "hfill", "dotfill", "hrulefill", "leftarrowfill", "rightarrowfill",
 323 "upbracefill", "downbracefill", 0};
 324
 325 /// the same as known_spaces with .lyx names
 326 char const * const known_coded_spaces[] = { "space{}", "space{}",
 327 "thinspace{}", "thinspace{}", "quad{}", "qquad{}", "enspace{}", "enskip{}",
 328 "negthinspace{}", "negmedspace{}", "negthickspace{}", "textvisiblespace{}",
 329 "hfill{}", "dotfill{}", "hrulefill{}", "leftarrowfill{}", "rightarrowfill{}",
 330 "upbracefill{}", "downbracefill{}", 0};
 331
 332 /// known TIPA combining diacritical marks
 333 char const * const known_tipa_marks[] = {"textsubwedge", "textsubumlaut",
 334 "textsubtilde", "textseagull", "textsubbridge", "textinvsubbridge",
 335 "textsubsquare", "textsubrhalfring", "textsublhalfring", "textsubplus",
 336 "textovercross", "textsubarch", "textsuperimposetilde", "textraising",
 337 "textlowering", "textadvancing", "textretracting", "textdoublegrave",
 338 "texthighrise", "textlowrise", "textrisefall", "textsyllabic",
 339 "textsubring", "textsubbar", 0};
 340
 341 /// TIPA tones that need special handling
 342 char const * const known_tones[] = {"15", "51", "45", "12", "454", 0};
 343
 344 // string to store the float type to be able to determine the type of subfloats
 345 string float_type = "";
 346
 347 // string to store the float status of minted listings
 348 string minted_float = "";
 349
 350 // whether a caption has been parsed for a floating minted listing
 351 bool minted_float_has_caption = false;
 352
 353 // The caption for non-floating minted listings
 354 string minted_nonfloat_caption = "";
 355
 356 // Characters that have to be escaped by \\ in LaTeX
 357 char const * const known_escaped_chars[] = {
 358                 "&", "_", "$", "%", "#", "^", "{", "}", 0};
 359
 360
 361 /// splits "x=z, y=b" into a map and an ordered keyword vector
 362 void split_map(string const & s, map<string, string> & res, vector<string> & keys)
 363 {
 364         vector<string> v;
 365         split(s, v);
 366         res.clear();
 367         keys.resize(v.size());
 368         for (size_t i = 0; i < v.size(); ++i) {
 369                 size_t const pos   = v[i].find('=');
 370                 string const index = trimSpaceAndEol(v[i].substr(0, pos));
 371                 string const value = trimSpaceAndEol(v[i].substr(pos + 1, string::npos));
 372                 res[index] = value;
 373                 keys[i] = index;
 374         }
 375 }
 376
 377
 378 /*!
 379  * Split a LaTeX length into value and unit.
 380  * The latter can be a real unit like "pt", or a latex length variable
 381  * like "\textwidth". The unit may contain additional stuff like glue
 382  * lengths, but we don't care, because such lengths are ERT anyway.
 383  * \returns true if \p value and \p unit are valid.
 384  */
 385 bool splitLatexLength(string const & len, string & value, string & unit)
 386 {
 387         if (len.empty())
 388                 return false;
 389         const string::size_type i = len.find_first_not_of(" -+0123456789.,");
 390         //'4,5' is a valid LaTeX length number. Change it to '4.5'
 391         string const length = subst(len, ',', '.');
 392         if (i == string::npos)
 393                 return false;
 394         if (i == 0) {
 395                 if (len[0] == '\\') {
 396                         // We had something like \textwidth without a factor
 397                         value = "1.0";
 398                 } else {
 399                         return false;
 400                 }
 401         } else {
 402                 value = trimSpaceAndEol(string(length, 0, i));
 403         }
 404         if (value == "-")
 405                 value = "-1.0";
 406         // 'cM' is a valid LaTeX length unit. Change it to 'cm'
 407         if (contains(len, '\\'))
 408                 unit = trimSpaceAndEol(string(len, i));
 409         else
 410                 unit = ascii_lowercase(trimSpaceAndEol(string(len, i)));
 411         return true;
 412 }
 413
 414
 415 /// A simple function to translate a latex length to something LyX can
 416 /// understand. Not perfect, but rather best-effort.
 417 bool translate_len(string const & length, string & valstring, string & unit)
 418 {
 419         if (!splitLatexLength(length, valstring, unit))
 420                 return false;
 421         // LyX uses percent values
 422         double value;
 423         istringstream iss(valstring);
 424         iss >> value;
 425         value *= 100;
 426         ostringstream oss;
 427         oss << value;
 428         string const percentval = oss.str();
 429         // a normal length
 430         if (unit.empty() || unit[0] != '\\')
 431                 return true;
 432         string::size_type const i = unit.find(' ');
 433         string const endlen = (i == string::npos) ? string() : string(unit, i);
 434         if (unit == "\\textwidth") {
 435                 valstring = percentval;
 436                 unit = "text%" + endlen;
 437         } else if (unit == "\\columnwidth") {
 438                 valstring = percentval;
 439                 unit = "col%" + endlen;
 440         } else if (unit == "\\paperwidth") {
 441                 valstring = percentval;
 442                 unit = "page%" + endlen;
 443         } else if (unit == "\\linewidth") {
 444                 valstring = percentval;
 445                 unit = "line%" + endlen;
 446         } else if (unit == "\\paperheight") {
 447                 valstring = percentval;
 448                 unit = "pheight%" + endlen;
 449         } else if (unit == "\\textheight") {
 450                 valstring = percentval;
 451                 unit = "theight%" + endlen;
 452         } else if (unit == "\\baselineskip") {
 453                 valstring = percentval;
 454                 unit = "baselineskip%" + endlen;
 455         }
 456         return true;
 457 }
 458
 459
 460 /// If we have ambiguous quotation marks, make a smart guess
 461 /// based on main quote style
 462 string guessQuoteStyle(string in, bool const opening)
 463 {
 464         string res = in;
 465         if (prefixIs(in, "qr")) {// straight quote
 466                 if (!opening)
 467                         res = subst(res, "r", "l");
 468         } else if (in == "eld") {// ``
 469                 if (preamble.quotesStyle() == "german")
 470                         res = "grd";
 471                 else if (preamble.quotesStyle() == "british")
 472                         res = "bls";
 473                 else if (preamble.quotesStyle() == "french")
 474                         res = "fls";
 475                 else if (preamble.quotesStyle() == "russian")
 476                         res = "rrs";
 477         } else if (in == "erd") {// ''
 478                 if (preamble.quotesStyle() == "polish")
 479                         res = "prd";
 480                 else if (preamble.quotesStyle() == "british")
 481                         res = "brs";
 482                 else if (preamble.quotesStyle() == "french")
 483                         res = "frs";
 484                 else if (preamble.quotesStyle() == "swedish")
 485                         res = opening ? "sld" : "srd";
 486         } else if (in == "els") {// `
 487                 if (preamble.quotesStyle() == "german")
 488                         res = "grs";
 489                 else if (preamble.quotesStyle() == "british")
 490                         res = "bld";
 491         } else if (in == "ers") {// '
 492                 if (preamble.quotesStyle() == "polish")
 493                         res = "prs";
 494                 else if (preamble.quotesStyle() == "british")
 495                         res = "brd";
 496                 else if (preamble.quotesStyle() == "swedish")
 497                         res = opening ? "sls" : "srs";
 498         } else if (in == "ard") {// >>
 499                 if (preamble.quotesStyle() == "swiss")
 500                         res = "cld";
 501                 else if (preamble.quotesStyle() == "french")
 502                         res = "fld";
 503                 else if (preamble.quotesStyle() == "russian")
 504                         res = "rld";
 505         } else if (in == "ald") {// <<
 506                 if (preamble.quotesStyle() == "swiss")
 507                         res = "crd";
 508                 else if (preamble.quotesStyle() == "french")
 509                         res = "frd";
 510                 else if (preamble.quotesStyle() == "russian")
 511                         res = "rrd";
 512         } else if (in == "ars") {// >
 513                 if (preamble.quotesStyle() == "swiss")
 514                         res = "cls";
 515         } else if (in == "als") {// <
 516                 if (preamble.quotesStyle() == "swiss")
 517                         res = "crs";
 518         } else if (in == "gld") {// ,,
 519                 if (preamble.quotesStyle() == "polish")
 520                         res = "pld";
 521                 else if (preamble.quotesStyle() == "russian")
 522                         res = "rls";
 523         } else if (in == "gls") {// ,
 524                 if (preamble.quotesStyle() == "polish")
 525                         res = "pls";
 526         }
 527         return res;
 528 }
 529
 530
 531 } // namespace
 532
 533
 534 string translate_len(string const & length)
 535 {
 536         string unit;
 537         string value;
 538         if (translate_len(length, value, unit))
 539                 return value + unit;
 540         // If the input is invalid, return what we have.
 541         return length;
 542 }
 543
 544
 545 namespace {
 546
 547 /*!
 548  * Translates a LaTeX length into \p value, \p unit and
 549  * \p special parts suitable for a box inset.
 550  * The difference from translate_len() is that a box inset knows about
 551  * some special "units" that are stored in \p special.
 552  */
 553 void translate_box_len(string const & length, string & value, string & unit, string & special)
 554 {
 555         if (translate_len(length, value, unit)) {
 556                 if (unit == "\\height" || unit == "\\depth" ||
 557                     unit == "\\totalheight" || unit == "\\width") {
 558                         special = unit.substr(1);
 559                         // The unit is not used, but LyX requires a dummy setting
 560                         unit = "in";
 561                 } else
 562                         special = "none";
 563         } else {
 564                 value.clear();
 565                 unit = length;
 566                 special = "none";
 567         }
 568 }
 569
 570
 571 void begin_inset(ostream & os, string const & name)
 572 {
 573         os << "\n\\begin_inset " << name;
 574 }
 575
 576
 577 void begin_command_inset(ostream & os, string const & name,
 578                          string const & latexname)
 579 {
 580         begin_inset(os, "CommandInset ");
 581         os << name << "\nLatexCommand " << latexname << '\n';
 582 }
 583
 584
 585 void end_inset(ostream & os)
 586 {
 587         os << "\n\\end_inset\n\n";
 588 }
 589
 590
 591 bool skip_braces(Parser & p)
 592 {
 593         if (p.next_token().cat() != catBegin)
 594                 return false;
 595         p.get_token();
 596         if (p.next_token().cat() == catEnd) {
 597                 p.get_token();
 598                 return true;
 599         }
 600         p.putback();
 601         return false;
 602 }
 603
 604
 605 /// replace LaTeX commands in \p s from the unicodesymbols file with their
 606 /// unicode points
 607 pair<bool, docstring> convert_unicodesymbols(docstring s)
 608 {
 609         bool res = true;
 610         odocstringstream os;
 611         for (size_t i = 0; i < s.size();) {
 612                 if (s[i] != '\\') {
 613                         os.put(s[i++]);
 614                         continue;
 615                 }
 616                 s = s.substr(i);
 617                 bool termination;
 618                 docstring rem;
 619                 set<string> req;
 620                 docstring parsed = normalize_c(encodings.fromLaTeXCommand(s,
 621                                 Encodings::TEXT_CMD, termination, rem, &req));
 622                 set<string>::const_iterator it = req.begin();
 623                 set<string>::const_iterator en = req.end();
 624                 for (; it != en; ++it)
 625                         preamble.registerAutomaticallyLoadedPackage(*it);
 626                 os << parsed;
 627                 s = rem;
 628                 if (s.empty() || s[0] != '\\')
 629                         i = 0;
 630                 else {
 631                         res = false;
 632                         for (auto const & c : known_escaped_chars)
 633                                 if (c != 0 && prefixIs(s, from_ascii("\\") + c))
 634                                         res = true;
 635                         i = 1;
 636                 }
 637         }
 638         return make_pair(res, os.str());
 639 }
 640
 641
 642 /// try to convert \p s to a valid InsetCommand argument
 643 /// return whether this succeeded. If not, these command insets
 644 /// get the "literate" flag.
 645 pair<bool, string> convert_latexed_command_inset_arg(string s)
 646 {
 647         bool success = false;
 648         if (isAscii(s)) {
 649                 // since we don't know the input encoding we can't use from_utf8
 650                 pair<bool, docstring> res = convert_unicodesymbols(from_ascii(s));
 651                 success = res.first;
 652                 s = to_utf8(res.second);
 653         }
 654         // LyX cannot handle newlines in a latex command
 655         return make_pair(success, subst(s, "\n", " "));
 656 }
 657
 658 /// try to convert \p s to a valid InsetCommand argument
 659 /// without trying to recode macros.
 660 string convert_literate_command_inset_arg(string s)
 661 {
 662         // LyX cannot handle newlines in a latex command
 663         return subst(s, "\n", " ");
 664 }
 665
 666 void output_ert(ostream & os, string const & s, Context & context)
 667 {
 668         context.check_layout(os);
 669         for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
 670                 if (*it == '\\')
 671                         os << "\n\\backslash\n";
 672                 else if (*it == '\n') {
 673                         context.new_paragraph(os);
 674                         context.check_layout(os);
 675                 } else
 676                         os << *it;
 677         }
 678         context.check_end_layout(os);
 679 }
 680
 681
 682 void output_ert_inset(ostream & os, string const & s, Context & context)
 683 {
 684         // We must have a valid layout before outputting the ERT inset.
 685         context.check_layout(os);
 686         Context newcontext(true, context.textclass);
 687         InsetLayout const & layout = context.textclass.insetLayout(from_ascii("ERT"));
 688         if (layout.forcePlainLayout())
 689                 newcontext.layout = &context.textclass.plainLayout();
 690         begin_inset(os, "ERT");
 691         os << "\nstatus collapsed\n";
 692         output_ert(os, s, newcontext);
 693         end_inset(os);
 694 }
 695
 696
 697 void output_comment(Parser & p, ostream & os, string const & s,
 698                     Context & context)
 699 {
 700         if (p.next_token().cat() == catNewline)
 701                 output_ert_inset(os, '%' + s, context);
 702         else
 703                 output_ert_inset(os, '%' + s + '\n', context);
 704 }
 705
 706
 707 Layout const * findLayout(TextClass const & textclass, string const & name, bool command,
 708                           string const & latexparam = string())
 709 {
 710         Layout const * layout = findLayoutWithoutModule(textclass, name, command, latexparam);
 711         if (layout)
 712                 return layout;
 713         if (checkModule(name, command))
 714                 return findLayoutWithoutModule(textclass, name, command, latexparam);
 715         return layout;
 716 }
 717
 718
 719 InsetLayout const * findInsetLayout(TextClass const & textclass, string const & name, bool command,
 720                                     string const & latexparam = string())
 721 {
 722         InsetLayout const * insetlayout =
 723                 findInsetLayoutWithoutModule(textclass, name, command, latexparam);
 724         if (insetlayout)
 725                 return insetlayout;
 726         if (checkModule(name, command))
 727                 return findInsetLayoutWithoutModule(textclass, name, command, latexparam);
 728         return insetlayout;
 729 }
 730
 731
 732 void eat_whitespace(Parser &, ostream &, Context &, bool);
 733
 734
 735 /*!
 736  * Skips whitespace and braces.
 737  * This should be called after a command has been parsed that is not put into
 738  * ERT, and where LyX adds "{}" if needed.
 739  */
 740 void skip_spaces_braces(Parser & p, bool keepws = false)
 741 {
 742         /* The following four examples produce the same typeset output and
 743            should be handled by this function:
 744            - abc \j{} xyz
 745            - abc \j {} xyz
 746            - abc \j
 747              {} xyz
 748            - abc \j %comment
 749              {} xyz
 750          */
 751         // Unfortunately we need to skip comments, too.
 752         // We can't use eat_whitespace since writing them after the {}
 753         // results in different output in some cases.
 754         bool const skipped_spaces = p.skip_spaces(true);
 755         bool const skipped_braces = skip_braces(p);
 756         if (keepws && skipped_spaces && !skipped_braces)
 757                 // put back the space (it is better handled by check_space)
 758                 p.unskip_spaces(true);
 759 }
 760
 761
 762 void output_arguments(ostream & os, Parser & p, bool outer, bool need_layout, string const prefix,
 763                       Context & context, Layout::LaTeXArgMap const & latexargs)
 764 {
 765         if (context.layout->latextype != LATEX_ITEM_ENVIRONMENT || !prefix.empty()) {
 766                 if (need_layout) {
 767                         context.check_layout(os);
 768                         need_layout = false;
 769                 } else
 770                         need_layout = true;
 771         }
 772         int i = 0;
 773         Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
 774         Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
 775         for (; lait != laend; ++lait) {
 776                 ++i;
 777                 eat_whitespace(p, os, context, false);
 778                 if (lait->second.mandatory) {
 779                         if (p.next_token().cat() != catBegin)
 780                                 break;
 781                         string ldelim = to_utf8(lait->second.ldelim);
 782                         string rdelim = to_utf8(lait->second.rdelim);
 783                         if (ldelim.empty())
 784                                 ldelim = "{";
 785                         if (rdelim.empty())
 786                                 rdelim = "}";
 787                         p.get_token(); // eat ldelim
 788                         if (ldelim.size() > 1)
 789                                 p.get_token(); // eat ldelim
 790                         if (need_layout) {
 791                                 context.check_layout(os);
 792                                 need_layout = false;
 793                         }
 794                         begin_inset(os, "Argument ");
 795                         if (!prefix.empty())
 796                                 os << prefix << ':';
 797                         os << i << "\nstatus collapsed\n\n";
 798                         parse_text_in_inset(p, os, FLAG_RDELIM, outer, context, 0, rdelim);
 799                         end_inset(os);
 800                 } else {
 801                         string ldelim = to_utf8(lait->second.ldelim);
 802                         string rdelim = to_utf8(lait->second.rdelim);
 803                         if (ldelim.empty())
 804                                 ldelim = "[";
 805                         if (rdelim.empty())
 806                                 rdelim = "]";
 807                         string tok = p.next_token().asInput();
 808                         // we only support delimiters with max 2 chars for now.
 809                         if (ldelim.size() > 1)
 810                                 tok += p.next_next_token().asInput();
 811                         if (p.next_token().cat() == catEscape || tok != ldelim)
 812                                 continue;
 813                         p.get_token(); // eat ldelim
 814                         if (ldelim.size() > 1)
 815                                 p.get_token(); // eat ldelim
 816                         if (need_layout) {
 817                                 context.check_layout(os);
 818                                 need_layout = false;
 819                         }
 820                         begin_inset(os, "Argument ");
 821                         if (!prefix.empty())
 822                                 os << prefix << ':';
 823                         os << i << "\nstatus collapsed\n\n";
 824                         parse_text_in_inset(p, os, FLAG_RDELIM, outer, context, 0, rdelim);
 825                         end_inset(os);
 826                 }
 827                 eat_whitespace(p, os, context, false);
 828         }
 829 }
 830
 831
 832 void output_command_layout(ostream & os, Parser & p, bool outer,
 833                            Context & parent_context,
 834                            Layout const * newlayout)
 835 {
 836         TeXFont const oldFont = parent_context.font;
 837         // save the current font size
 838         string const size = oldFont.size;
 839         // reset the font size to default, because the font size switches
 840         // don't affect section headings and the like
 841         parent_context.font.size = Context::normalfont.size;
 842         // we only need to write the font change if we have an open layout
 843         if (!parent_context.atParagraphStart())
 844                 output_font_change(os, oldFont, parent_context.font);
 845         parent_context.check_end_layout(os);
 846         Context context(true, parent_context.textclass, newlayout,
 847                         parent_context.layout, parent_context.font);
 848         if (parent_context.deeper_paragraph) {
 849                 // We are beginning a nested environment after a
 850                 // deeper paragraph inside the outer list environment.
 851                 // Therefore we don't need to output a "begin deeper".
 852                 context.need_end_deeper = true;
 853         }
 854         context.check_deeper(os);
 855         output_arguments(os, p, outer, true, string(), context,
 856                          context.layout->latexargs());
 857         // If we have a latex param, we eat it here.
 858         if (!parent_context.latexparam.empty()) {
 859                 ostringstream oss;
 860                 Context dummy(true, parent_context.textclass);
 861                 parse_text(p, oss, FLAG_RDELIM, outer, dummy,
 862                            string(1, parent_context.latexparam.back()));
 863         }
 864         parse_text(p, os, FLAG_ITEM, outer, context);
 865         output_arguments(os, p, outer, false, "post", context,
 866                          context.layout->postcommandargs());
 867         context.check_end_layout(os);
 868         if (parent_context.deeper_paragraph) {
 869                 // We must suppress the "end deeper" because we
 870                 // suppressed the "begin deeper" above.
 871                 context.need_end_deeper = false;
 872         }
 873         context.check_end_deeper(os);
 874         // We don't need really a new paragraph, but
 875         // we must make sure that the next item gets a \begin_layout.
 876         parent_context.new_paragraph(os);
 877         // Set the font size to the original value. No need to output it here
 878         // (Context::begin_layout() will do that if needed)
 879         parent_context.font.size = size;
 880 }
 881
 882
 883 /*!
 884  * Output a space if necessary.
 885  * This function gets called for every whitespace token.
 886  *
 887  * We have three cases here:
 888  * 1. A space must be suppressed. Example: The lyxcode case below
 889  * 2. A space may be suppressed. Example: Spaces before "\par"
 890  * 3. A space must not be suppressed. Example: A space between two words
 891  *
 892  * We currently handle only 1. and 3 and from 2. only the case of
 893  * spaces before newlines as a side effect.
 894  *
 895  * 2. could be used to suppress as many spaces as possible. This has two effects:
 896  * - Reimporting LyX generated LaTeX files changes almost no whitespace
 897  * - Superflous whitespace from non LyX generated LaTeX files is removed.
 898  * The drawback is that the logic inside the function becomes
 899  * complicated, and that is the reason why it is not implemented.
 900  */
 901 void check_space(Parser & p, ostream & os, Context & context)
 902 {
 903         Token const next = p.next_token();
 904         Token const curr = p.curr_token();
 905         // A space before a single newline and vice versa must be ignored
 906         // LyX emits a newline before \end{lyxcode}.
 907         // This newline must be ignored,
 908         // otherwise LyX will add an additional protected space.
 909         if (next.cat() == catSpace ||
 910             next.cat() == catNewline ||
 911             (next.cs() == "end" && context.layout->free_spacing && curr.cat() == catNewline)) {
 912                 return;
 913         }
 914         context.check_layout(os);
 915         os << ' ';
 916 }
 917
 918
 919 /*!
 920  * Parse all arguments of \p command
 921  */
 922 void parse_arguments(string const & command,
 923                      vector<ArgumentType> const & template_arguments,
 924                      Parser & p, ostream & os, bool outer, Context & context)
 925 {
 926         string ert = command;
 927         size_t no_arguments = template_arguments.size();
 928         for (size_t i = 0; i < no_arguments; ++i) {
 929                 switch (template_arguments[i]) {
 930                 case required:
 931                 case req_group:
 932                         // This argument contains regular LaTeX
 933                         output_ert_inset(os, ert + '{', context);
 934                         eat_whitespace(p, os, context, false);
 935                         if (template_arguments[i] == required)
 936                                 parse_text(p, os, FLAG_ITEM, outer, context);
 937                         else
 938                                 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
 939                         ert = "}";
 940                         break;
 941                 case item:
 942                         // This argument consists only of a single item.
 943                         // The presence of '{' or not must be preserved.
 944                         p.skip_spaces();
 945                         if (p.next_token().cat() == catBegin)
 946                                 ert += '{' + p.verbatim_item() + '}';
 947                         else
 948                                 ert += p.verbatim_item();
 949                         break;
 950                 case displaymath:
 951                 case verbatim:
 952                         // This argument may contain special characters
 953                         ert += '{' + p.verbatim_item() + '}';
 954                         break;
 955                 case optional:
 956                 case opt_group:
 957                         // true because we must not eat whitespace
 958                         // if an optional arg follows we must not strip the
 959                         // brackets from this one
 960                         if (i < no_arguments - 1 &&
 961                             template_arguments[i+1] == optional)
 962                                 ert += p.getFullOpt(true);
 963                         else
 964                                 ert += p.getOpt(true);
 965                         break;
 966                 }
 967         }
 968         output_ert_inset(os, ert, context);
 969 }
 970
 971
 972 /*!
 973  * Check whether \p command is a known command. If yes,
 974  * handle the command with all arguments.
 975  * \return true if the command was parsed, false otherwise.
 976  */
 977 bool parse_command(string const & command, Parser & p, ostream & os,
 978                    bool outer, Context & context)
 979 {
 980         if (known_commands.find(command) != known_commands.end()) {
 981                 parse_arguments(command, known_commands[command], p, os,
 982                                 outer, context);
 983                 return true;
 984         }
 985         return false;
 986 }
 987
 988
 989 /// Parses a minipage or parbox
 990 void parse_box(Parser & p, ostream & os, unsigned outer_flags,
 991                unsigned inner_flags, bool outer, Context & parent_context,
 992                string const & outer_type, string const & special,
 993                string inner_type, string const & frame_color,
 994                string const & background_color)
 995 {
 996         string position;
 997         string inner_pos;
 998         string hor_pos = "l";
 999         // We need to set the height to the LaTeX default of 1\\totalheight
1000         // for the case when no height argument is given
1001         string height_value = "1";
1002         string height_unit = "in";
1003         string height_special = "totalheight";
1004         string latex_height;
1005         string width_value;
1006         string width_unit;
1007         string latex_width;
1008         string width_special = "none";
1009         string thickness = "0.4pt";
1010         if (!fboxrule.empty())
1011                 thickness = fboxrule;
1012         else
1013                 thickness = "0.4pt";
1014         string separation;
1015         if (!fboxsep.empty())
1016                 separation = fboxsep;
1017         else
1018                 separation = "3pt";
1019         string shadowsize;
1020         if (!shadow_size.empty())
1021                 shadowsize = shadow_size;
1022         else
1023                 shadowsize = "4pt";
1024         string framecolor = "black";
1025         string backgroundcolor = "none";
1026         if (!frame_color.empty())
1027                 framecolor = frame_color;
1028         if (!background_color.empty())
1029                 backgroundcolor = background_color;
1030         // if there is a color box around the \begin statements have not yet been parsed
1031         // so do this now
1032         if (!frame_color.empty() || !background_color.empty()) {
1033                 eat_whitespace(p, os, parent_context, false);
1034                 p.get_token().asInput(); // the '{'
1035                 // parse minipage
1036                 if (p.next_token().asInput() == "\\begin") {
1037                         p.get_token().asInput();
1038                         p.getArg('{', '}');
1039                         inner_type = "minipage";
1040                         inner_flags = FLAG_END;
1041                         active_environments.push_back("minipage");
1042                 }
1043                 // parse parbox
1044                 else if (p.next_token().asInput() == "\\parbox") {
1045                         p.get_token().asInput();
1046                         inner_type = "parbox";
1047                         inner_flags = FLAG_ITEM;
1048                 }
1049                 // parse makebox
1050                 else if (p.next_token().asInput() == "\\makebox") {
1051                         p.get_token().asInput();
1052                         inner_type = "makebox";
1053                         inner_flags = FLAG_ITEM;
1054                 }
1055                 // in case there is just \colorbox{color}{text}
1056                 else {
1057                         latex_width = "";
1058                         inner_type = "makebox";
1059                         inner_flags = FLAG_BRACE_LAST;
1060                         position = "t";
1061                         inner_pos = "t";
1062                 }
1063         }
1064         if (!p.hasOpt() && (inner_type == "makebox" || outer_type == "mbox"))
1065                 hor_pos = "c";
1066         if (!inner_type.empty() && p.hasOpt()) {
1067                 if (inner_type != "makebox")
1068                         position = p.getArg('[', ']');
1069                 else {
1070                         latex_width = p.getArg('[', ']');
1071                         translate_box_len(latex_width, width_value, width_unit, width_special);
1072                         position = "t";
1073                 }
1074                 if (position != "t" && position != "c" && position != "b") {
1075                         cerr << "invalid position " << position << " for "
1076                              << inner_type << endl;
1077                         position = "c";
1078                 }
1079                 if (p.hasOpt()) {
1080                         if (inner_type != "makebox") {
1081                                 latex_height = p.getArg('[', ']');
1082                                 translate_box_len(latex_height, height_value, height_unit, height_special);
1083                         } else {
1084                                 string const opt = p.getArg('[', ']');
1085                                 if (!opt.empty()) {
1086                                         hor_pos = opt;
1087                                         if (hor_pos != "l" && hor_pos != "c" &&
1088                                             hor_pos != "r" && hor_pos != "s") {
1089                                                 cerr << "invalid hor_pos " << hor_pos
1090                                                      << " for " << inner_type << endl;
1091                                                 hor_pos = "c";
1092                                         }
1093                                 }
1094                         }
1095
1096                         if (p.hasOpt()) {
1097                                 inner_pos = p.getArg('[', ']');
1098                                 if (inner_pos != "c" && inner_pos != "t" &&
1099                                     inner_pos != "b" && inner_pos != "s") {
1100                                         cerr << "invalid inner_pos "
1101                                              << inner_pos << " for "
1102                                              << inner_type << endl;
1103                                         inner_pos = position;
1104                                 }
1105                         }
1106                 } else {
1107                         if (inner_type == "makebox")
1108                                 hor_pos = "c";
1109                 }
1110         }
1111         if (inner_type.empty()) {
1112                 if (special.empty() && outer_type != "framebox")
1113                         latex_width = "1\\columnwidth";
1114                 else {
1115                         Parser p2(special);
1116                         latex_width = p2.getArg('[', ']');
1117                         string const opt = p2.getArg('[', ']');
1118                         if (!opt.empty()) {
1119                                 hor_pos = opt;
1120                                 if (hor_pos != "l" && hor_pos != "c" &&
1121                                     hor_pos != "r" && hor_pos != "s") {
1122                                         cerr << "invalid hor_pos " << hor_pos
1123                                              << " for " << outer_type << endl;
1124                                         hor_pos = "c";
1125                                 }
1126                         } else {
1127                                 if (outer_type == "framebox")
1128                                         hor_pos = "c";
1129                         }
1130                 }
1131         } else if (inner_type != "makebox")
1132                 latex_width = p.verbatim_item();
1133         // if e.g. only \ovalbox{content} was used, set the width to 1\columnwidth
1134         // as this is LyX's standard for such cases (except for makebox)
1135         // \framebox is more special and handled below
1136         if (latex_width.empty() && inner_type != "makebox"
1137                 && outer_type != "framebox")
1138                 latex_width = "1\\columnwidth";
1139
1140         translate_len(latex_width, width_value, width_unit);
1141
1142         bool shadedparbox = false;
1143         if (inner_type == "shaded") {
1144                 eat_whitespace(p, os, parent_context, false);
1145                 if (outer_type == "parbox") {
1146                         // Eat '{'
1147                         if (p.next_token().cat() == catBegin)
1148                                 p.get_token();
1149                         eat_whitespace(p, os, parent_context, false);
1150                         shadedparbox = true;
1151                 }
1152                 p.get_token();
1153                 p.getArg('{', '}');
1154         }
1155         // If we already read the inner box we have to push the inner env
1156         if (!outer_type.empty() && !inner_type.empty() &&
1157             (inner_flags & FLAG_END))
1158                 active_environments.push_back(inner_type);
1159         bool use_ert = false;
1160         if (!outer_type.empty() && !inner_type.empty()) {
1161                 // Look whether there is some content after the end of the
1162                 // inner box, but before the end of the outer box.
1163                 // If yes, we need to output ERT.
1164                 p.pushPosition();
1165                 if (inner_flags & FLAG_END)
1166                         p.ertEnvironment(inner_type);
1167                 else
1168                         p.verbatim_item();
1169                 p.skip_spaces(true);
1170                 bool const outer_env(outer_type == "framed" || outer_type == "minipage");
1171                 if ((outer_env && p.next_token().asInput() != "\\end") ||
1172                     (!outer_env && p.next_token().cat() != catEnd)) {
1173                         // something is between the end of the inner box and
1174                         // the end of the outer box, so we need to use ERT.
1175                         use_ert = true;
1176                 }
1177                 p.popPosition();
1178         }
1179
1180         if (use_ert) {
1181                 ostringstream ss;
1182                 if (!outer_type.empty()) {
1183                         if (outer_flags & FLAG_END)
1184                                 ss << "\\begin{" << outer_type << '}';
1185                         else {
1186                                 ss << '\\' << outer_type << '{';
1187                                 if (!special.empty())
1188                                         ss << special;
1189                         }
1190                 }
1191                 if (!inner_type.empty()) {
1192                         if (inner_type != "shaded") {
1193                                 if (inner_flags & FLAG_END)
1194                                         ss << "\\begin{" << inner_type << '}';
1195                                 else
1196                                         ss << '\\' << inner_type;
1197                         }
1198                         if (!position.empty())
1199                                 ss << '[' << position << ']';
1200                         if (!latex_height.empty())
1201                                 ss << '[' << latex_height << ']';
1202                         if (!inner_pos.empty())
1203                                 ss << '[' << inner_pos << ']';
1204                         ss << '{' << latex_width << '}';
1205                         if (!(inner_flags & FLAG_END))
1206                                 ss << '{';
1207                 }
1208                 if (inner_type == "shaded")
1209                         ss << "\\begin{shaded}";
1210                 output_ert_inset(os, ss.str(), parent_context);
1211                 if (!inner_type.empty()) {
1212                         parse_text(p, os, inner_flags, outer, parent_context);
1213                         if (inner_flags & FLAG_END)
1214                                 output_ert_inset(os, "\\end{" + inner_type + '}',
1215                                            parent_context);
1216                         else
1217                                 output_ert_inset(os, "}", parent_context);
1218                 }
1219                 if (!outer_type.empty()) {
1220                         // If we already read the inner box we have to pop
1221                         // the inner env
1222                         if (!inner_type.empty() && (inner_flags & FLAG_END))
1223                                 active_environments.pop_back();
1224
1225                         // Ensure that the end of the outer box is parsed correctly:
1226                         // The opening brace has been eaten by parse_outer_box()
1227                         if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1228                                 outer_flags &= ~FLAG_ITEM;
1229                                 outer_flags |= FLAG_BRACE_LAST;
1230                         }
1231                         parse_text(p, os, outer_flags, outer, parent_context);
1232                         if (outer_flags & FLAG_END)
1233                                 output_ert_inset(os, "\\end{" + outer_type + '}',
1234                                            parent_context);
1235                         else
1236                                 output_ert_inset(os, "}", parent_context);
1237                 }
1238         } else {
1239                 // LyX does not like empty positions, so we have
1240                 // to set them to the LaTeX default values here.
1241                 if (position.empty())
1242                         position = "c";
1243                 if (inner_pos.empty())
1244                         inner_pos = position;
1245                 parent_context.check_layout(os);
1246                 begin_inset(os, "Box ");
1247                 if (outer_type == "framed")
1248                         os << "Framed\n";
1249                 else if (outer_type == "framebox" || outer_type == "fbox" || !frame_color.empty())
1250                         os << "Boxed\n";
1251                 else if (outer_type == "shadowbox")
1252                         os << "Shadowbox\n";
1253                 else if ((outer_type == "shaded" && inner_type.empty()) ||
1254                              (outer_type == "minipage" && inner_type == "shaded") ||
1255                              (outer_type == "parbox" && inner_type == "shaded")) {
1256                         os << "Shaded\n";
1257                         preamble.registerAutomaticallyLoadedPackage("color");
1258                 } else if (outer_type == "doublebox")
1259                         os << "Doublebox\n";
1260                 else if (outer_type.empty() || outer_type == "mbox")
1261                         os << "Frameless\n";
1262                 else
1263                         os << outer_type << '\n';
1264                 os << "position \"" << position << "\"\n";
1265                 os << "hor_pos \"" << hor_pos << "\"\n";
1266                 if (outer_type == "mbox")
1267                         os << "has_inner_box 1\n";
1268                 else if (!frame_color.empty() && inner_type == "makebox")
1269                         os << "has_inner_box 0\n";
1270                 else
1271                         os << "has_inner_box " << !inner_type.empty() << "\n";
1272                 os << "inner_pos \"" << inner_pos << "\"\n";
1273                 os << "use_parbox " << (inner_type == "parbox" || shadedparbox)
1274                    << '\n';
1275                 if (outer_type == "mbox")
1276                         os << "use_makebox 1\n";
1277                 else if (!frame_color.empty())
1278                         os << "use_makebox 0\n";
1279                 else
1280                         os << "use_makebox " << (inner_type == "makebox") << '\n';
1281                 if (outer_type == "mbox" || (outer_type == "fbox" && inner_type.empty()))
1282                         os << "width \"\"\n";
1283                 // for values like "1.5\width" LyX uses "1.5in" as width ad sets "width" as sepecial
1284                 else if (contains(width_unit, '\\'))
1285                         os << "width \"" << width_value << "in" << "\"\n";
1286                 else
1287                         os << "width \"" << width_value << width_unit << "\"\n";
1288                 if (contains(width_unit, '\\')) {
1289                         width_unit.erase (0,1); // remove the leading '\'
1290                         os << "special \"" << width_unit << "\"\n";
1291                 } else
1292                         os << "special \"" << width_special << "\"\n";
1293                 if (contains(height_unit, '\\'))
1294                         os << "height \"" << height_value << "in" << "\"\n";
1295                 else
1296                         os << "height \"" << height_value << height_unit << "\"\n";
1297                 os << "height_special \"" << height_special << "\"\n";
1298                 os << "thickness \"" << thickness << "\"\n";
1299                 os << "separation \"" << separation << "\"\n";
1300                 os << "shadowsize \"" << shadowsize << "\"\n";
1301                 os << "framecolor \"" << framecolor << "\"\n";
1302                 os << "backgroundcolor \"" << backgroundcolor << "\"\n";
1303                 os << "status open\n\n";
1304
1305                 // Unfortunately we can't use parse_text_in_inset:
1306                 // InsetBox::forcePlainLayout() is hard coded and does not
1307                 // use the inset layout. Apart from that do we call parse_text
1308                 // up to two times, but need only one check_end_layout.
1309                 bool const forcePlainLayout =
1310                         (!inner_type.empty() || inner_type == "makebox") &&
1311                         outer_type != "shaded" && outer_type != "framed";
1312                 Context context(true, parent_context.textclass);
1313                 if (forcePlainLayout)
1314                         context.layout = &context.textclass.plainLayout();
1315                 else
1316                         context.font = parent_context.font;
1317
1318                 // If we have no inner box the contents will be read with the outer box
1319                 if (!inner_type.empty())
1320                         parse_text(p, os, inner_flags, outer, context);
1321
1322                 // Ensure that the end of the outer box is parsed correctly:
1323                 // The opening brace has been eaten by parse_outer_box()
1324                 if (!outer_type.empty() && (outer_flags & FLAG_ITEM)) {
1325                         outer_flags &= ~FLAG_ITEM;
1326                         outer_flags |= FLAG_BRACE_LAST;
1327                 }
1328
1329                 // Find end of outer box, output contents if inner_type is
1330                 // empty and output possible comments
1331                 if (!outer_type.empty()) {
1332                         // If we already read the inner box we have to pop
1333                         // the inner env
1334                         if (!inner_type.empty() && (inner_flags & FLAG_END))
1335                                 active_environments.pop_back();
1336                         // This does not output anything but comments if
1337                         // inner_type is not empty (see use_ert)
1338                         parse_text(p, os, outer_flags, outer, context);
1339                 }
1340
1341                 context.check_end_layout(os);
1342                 end_inset(os);
1343 #ifdef PRESERVE_LAYOUT
1344                 // LyX puts a % after the end of the minipage
1345                 if (p.next_token().cat() == catNewline && p.next_token().cs().size() > 1) {
1346                         // new paragraph
1347                         //output_comment(p, os, "dummy", parent_context);
1348                         p.get_token();
1349                         p.skip_spaces();
1350                         parent_context.new_paragraph(os);
1351                 }
1352                 else if (p.next_token().cat() == catSpace || p.next_token().cat() == catNewline) {
1353                         //output_comment(p, os, "dummy", parent_context);
1354                         p.get_token();
1355                         p.skip_spaces();
1356                         // We add a protected space if something real follows
1357                         if (p.good() && p.next_token().cat() != catComment) {
1358                                 begin_inset(os, "space ~\n");
1359                                 end_inset(os);
1360                         }
1361                 }
1362 #endif
1363         }
1364         if (inner_type == "minipage" && (!frame_color.empty() || !background_color.empty()))
1365                 active_environments.pop_back();
1366         if (inner_flags != FLAG_BRACE_LAST && (!frame_color.empty() || !background_color.empty())) {
1367                 // in this case we have to eat the the closing brace of the color box
1368                 p.get_token().asInput(); // the '}'
1369         }
1370         if (p.next_token().asInput() == "}") {
1371                 // in this case we assume that the closing brace is from the box settings
1372                 // therefore reset these values for the next box
1373                 fboxrule = "";
1374                 fboxsep = "";
1375                 shadow_size = "";
1376         }
1377
1378         // all boxes except of Frameless and Shaded require calc
1379         if (!(outer_type.empty() || outer_type == "mbox") &&
1380                 !((outer_type == "shaded" && inner_type.empty()) ||
1381                              (outer_type == "minipage" && inner_type == "shaded") ||
1382                              (outer_type == "parbox" && inner_type == "shaded")))
1383                 preamble.registerAutomaticallyLoadedPackage("calc");
1384 }
1385
1386
1387 void parse_outer_box(Parser & p, ostream & os, unsigned flags, bool outer,
1388                      Context & parent_context, string const & outer_type,
1389                      string const & special)
1390 {
1391         eat_whitespace(p, os, parent_context, false);
1392         if (flags & FLAG_ITEM) {
1393                 // Eat '{'
1394                 if (p.next_token().cat() == catBegin)
1395                         p.get_token();
1396                 else
1397                         cerr << "Warning: Ignoring missing '{' after \\"
1398                              << outer_type << '.' << endl;
1399                 eat_whitespace(p, os, parent_context, false);
1400         }
1401         string inner;
1402         unsigned int inner_flags = 0;
1403         p.pushPosition();
1404         if (outer_type == "minipage" || outer_type == "parbox") {
1405                 p.skip_spaces(true);
1406                 while (p.hasOpt()) {
1407                         p.getArg('[', ']');
1408                         p.skip_spaces(true);
1409                 }
1410                 p.getArg('{', '}');
1411                 p.skip_spaces(true);
1412                 if (outer_type == "parbox") {
1413                         // Eat '{'
1414                         if (p.next_token().cat() == catBegin)
1415                                 p.get_token();
1416                         p.skip_spaces(true);
1417                 }
1418         }
1419         if (outer_type == "shaded" || outer_type == "mbox") {
1420                 // These boxes never have an inner box
1421                 ;
1422         } else if (p.next_token().asInput() == "\\parbox") {
1423                 inner = p.get_token().cs();
1424                 inner_flags = FLAG_ITEM;
1425         } else if (p.next_token().asInput() == "\\begin") {
1426                 // Is this a minipage or shaded box?
1427                 p.pushPosition();
1428                 p.get_token();
1429                 inner = p.getArg('{', '}');
1430                 p.popPosition();
1431                 if (inner == "minipage" || inner == "shaded")
1432                         inner_flags = FLAG_END;
1433                 else
1434                         inner = "";
1435         }
1436         p.popPosition();
1437         if (inner_flags == FLAG_END) {
1438                 if (inner != "shaded")
1439                 {
1440                         p.get_token();
1441                         p.getArg('{', '}');
1442                         eat_whitespace(p, os, parent_context, false);
1443                 }
1444                 parse_box(p, os, flags, FLAG_END, outer, parent_context,
1445                           outer_type, special, inner, "", "");
1446         } else {
1447                 if (inner_flags == FLAG_ITEM) {
1448                         p.get_token();
1449                         eat_whitespace(p, os, parent_context, false);
1450                 }
1451                 parse_box(p, os, flags, inner_flags, outer, parent_context,
1452                           outer_type, special, inner, "", "");
1453         }
1454 }
1455
1456
1457 void parse_listings(Parser & p, ostream & os, Context & parent_context,
1458                     bool in_line, bool use_minted)
1459 {
1460         parent_context.check_layout(os);
1461         begin_inset(os, "listings\n");
1462         string arg = p.hasOpt() ? subst(p.verbatimOption(), "\n", "") : string();
1463         size_t i;
1464         while ((i = arg.find(", ")) != string::npos
1465                         || (i = arg.find(",\t")) != string::npos)
1466                 arg.erase(i + 1, 1);
1467
1468         if (use_minted) {
1469                 string const language = p.getArg('{', '}');
1470                 p.skip_spaces(true);
1471                 arg += string(arg.empty() ? "" : ",") + "language=" + language;
1472                 if (!minted_float.empty()) {
1473                         arg += string(arg.empty() ? "" : ",") + minted_float;
1474                         minted_nonfloat_caption.clear();
1475                 }
1476         }
1477         if (!arg.empty()) {
1478                 os << "lstparams " << '"' << arg << '"' << '\n';
1479                 if (arg.find("\\color") != string::npos)
1480                         preamble.registerAutomaticallyLoadedPackage("color");
1481         }
1482         if (in_line)
1483                 os << "inline true\n";
1484         else
1485                 os << "inline false\n";
1486         os << "status collapsed\n";
1487         Context context(true, parent_context.textclass);
1488         context.layout = &parent_context.textclass.plainLayout();
1489         if (use_minted && prefixIs(minted_nonfloat_caption, "[t]")) {
1490                 minted_nonfloat_caption.erase(0,3);
1491                 os << "\n\\begin_layout Plain Layout\n";
1492                 begin_inset(os, "Caption Standard\n");
1493                 Context newcontext(true, context.textclass,
1494                                    context.layout, 0, context.font);
1495                 newcontext.check_layout(os);
1496                 os << minted_nonfloat_caption << "\n";
1497                 newcontext.check_end_layout(os);
1498                 end_inset(os);
1499                 os << "\n\\end_layout\n";
1500                 minted_nonfloat_caption.clear();
1501         }
1502         string s;
1503         if (in_line) {
1504                 // set catcodes to verbatim early, just in case.
1505                 p.setCatcodes(VERBATIM_CATCODES);
1506                 string delim = p.get_token().asInput();
1507                 //FIXME: handler error condition
1508                 s = p.verbatimStuff(delim).second;
1509 //              context.new_paragraph(os);
1510         } else if (use_minted) {
1511                 s = p.verbatimEnvironment("minted");
1512         } else {
1513                 s = p.verbatimEnvironment("lstlisting");
1514         }
1515         output_ert(os, s, context);
1516         if (use_minted && prefixIs(minted_nonfloat_caption, "[b]")) {
1517                 minted_nonfloat_caption.erase(0,3);
1518                 os << "\n\\begin_layout Plain Layout\n";
1519                 begin_inset(os, "Caption Standard\n");
1520                 Context newcontext(true, context.textclass,
1521                                    context.layout, 0, context.font);
1522                 newcontext.check_layout(os);
1523                 os << minted_nonfloat_caption << "\n";
1524                 newcontext.check_end_layout(os);
1525                 end_inset(os);
1526                 os << "\n\\end_layout\n";
1527                 minted_nonfloat_caption.clear();
1528         }
1529         // Don't close the inset here for floating minted listings.
1530         // It will be closed at the end of the listing environment.
1531         if (!use_minted || minted_float.empty())
1532                 end_inset(os);
1533         else {
1534                 eat_whitespace(p, os, parent_context, true);
1535                 Token t = p.get_token();
1536                 if (t.asInput() != "\\end") {
1537                         // If anything follows, collect it into a caption.
1538                         minted_float_has_caption = true;
1539                         os << "\n\\begin_layout Plain Layout\n"; // outer layout
1540                         begin_inset(os, "Caption Standard\n");
1541                         os << "\n\\begin_layout Plain Layout\n"; // inner layout
1542                 }
1543                 p.putback();
1544         }
1545 }
1546
1547
1548 /// parse an unknown environment
1549 void parse_unknown_environment(Parser & p, string const & name, ostream & os,
1550                                unsigned flags, bool outer,
1551                                Context & parent_context)
1552 {
1553         if (name == "tabbing")
1554                 // We need to remember that we have to handle '\=' specially
1555                 flags |= FLAG_TABBING;
1556
1557         // We need to translate font changes and paragraphs inside the
1558         // environment to ERT if we have a non standard font.
1559         // Otherwise things like
1560         // \large\begin{foo}\huge bar\end{foo}
1561         // will not work.
1562         bool const specialfont =
1563                 (parent_context.font != parent_context.normalfont);
1564         bool const new_layout_allowed = parent_context.new_layout_allowed;
1565         if (specialfont)
1566                 parent_context.new_layout_allowed = false;
1567         output_ert_inset(os, "\\begin{" + name + "}", parent_context);
1568         parse_text_snippet(p, os, flags, outer, parent_context);
1569         output_ert_inset(os, "\\end{" + name + "}", parent_context);
1570         if (specialfont)
1571                 parent_context.new_layout_allowed = new_layout_allowed;
1572 }
1573
1574
1575 void parse_environment(Parser & p, ostream & os, bool outer,
1576                        string & last_env, Context & parent_context)
1577 {
1578         Layout const * newlayout;
1579         InsetLayout const * newinsetlayout = 0;
1580         string const name = p.getArg('{', '}');
1581         const bool is_starred = suffixIs(name, '*');
1582         string const unstarred_name = rtrim(name, "*");
1583         active_environments.push_back(name);
1584
1585         if (is_math_env(name)) {
1586                 parent_context.check_layout(os);
1587                 begin_inset(os, "Formula ");
1588                 os << "\\begin{" << name << "}";
1589                 parse_math(p, os, FLAG_END, MATH_MODE);
1590                 os << "\\end{" << name << "}";
1591                 end_inset(os);
1592                 if (is_display_math_env(name)) {
1593                         // Prevent the conversion of a line break to a space
1594                         // (bug 7668). This does not change the output, but
1595                         // looks ugly in LyX.
1596                         eat_whitespace(p, os, parent_context, false);
1597                 }
1598         }
1599
1600         else if (is_known(name, preamble.polyglossia_languages)) {
1601                 // We must begin a new paragraph if not already done
1602                 if (! parent_context.atParagraphStart()) {
1603                         parent_context.check_end_layout(os);
1604                         parent_context.new_paragraph(os);
1605                 }
1606                 // save the language in the context so that it is
1607                 // handled by parse_text
1608                 parent_context.font.language = preamble.polyglossia2lyx(name);
1609                 parse_text(p, os, FLAG_END, outer, parent_context);
1610                 // Just in case the environment is empty
1611                 parent_context.extra_stuff.erase();
1612                 // We must begin a new paragraph to reset the language
1613                 parent_context.new_paragraph(os);
1614                 p.skip_spaces();
1615         }
1616
1617         else if (unstarred_name == "tabular" || name == "longtable") {
1618                 eat_whitespace(p, os, parent_context, false);
1619                 string width = "0pt";
1620                 if (name == "tabular*") {
1621                         width = lyx::translate_len(p.getArg('{', '}'));
1622                         eat_whitespace(p, os, parent_context, false);
1623                 }
1624                 parent_context.check_layout(os);
1625                 begin_inset(os, "Tabular ");
1626                 handle_tabular(p, os, name, width, parent_context);
1627                 end_inset(os);
1628                 p.skip_spaces();
1629         }
1630
1631         else if (parent_context.textclass.floats().typeExist(unstarred_name)) {
1632                 eat_whitespace(p, os, parent_context, false);
1633                 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1634                 eat_whitespace(p, os, parent_context, false);
1635                 parent_context.check_layout(os);
1636                 begin_inset(os, "Float " + unstarred_name + "\n");
1637                 // store the float type for subfloats
1638                 // subfloats only work with figures and tables
1639                 if (unstarred_name == "figure")
1640                         float_type = unstarred_name;
1641                 else if (unstarred_name == "table")
1642                         float_type = unstarred_name;
1643                 else
1644                         float_type = "";
1645                 if (!opt.empty())
1646                         os << "placement " << opt << '\n';
1647                 if (contains(opt, "H"))
1648                         preamble.registerAutomaticallyLoadedPackage("float");
1649                 else {
1650                         Floating const & fl = parent_context.textclass.floats()
1651                                               .getType(unstarred_name);
1652                         if (!fl.floattype().empty() && fl.usesFloatPkg())
1653                                 preamble.registerAutomaticallyLoadedPackage("float");
1654                 }
1655
1656                 os << "wide " << convert<string>(is_starred)
1657                    << "\nsideways false"
1658                    << "\nstatus open\n\n";
1659                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1660                 end_inset(os);
1661                 // We don't need really a new paragraph, but
1662                 // we must make sure that the next item gets a \begin_layout.
1663                 parent_context.new_paragraph(os);
1664                 p.skip_spaces();
1665                 // the float is parsed thus delete the type
1666                 float_type = "";
1667         }
1668
1669         else if (unstarred_name == "sidewaysfigure"
1670                 || unstarred_name == "sidewaystable"
1671                 || unstarred_name == "sidewaysalgorithm") {
1672                 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1673                 eat_whitespace(p, os, parent_context, false);
1674                 parent_context.check_layout(os);
1675                 if (unstarred_name == "sidewaysfigure")
1676                         begin_inset(os, "Float figure\n");
1677                 else if (unstarred_name == "sidewaystable")
1678                         begin_inset(os, "Float table\n");
1679                 else if (unstarred_name == "sidewaysalgorithm")
1680                         begin_inset(os, "Float algorithm\n");
1681                 if (!opt.empty())
1682                         os << "placement " << opt << '\n';
1683                 if (contains(opt, "H"))
1684                         preamble.registerAutomaticallyLoadedPackage("float");
1685                 os << "wide " << convert<string>(is_starred)
1686                    << "\nsideways true"
1687                    << "\nstatus open\n\n";
1688                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1689                 end_inset(os);
1690                 // We don't need really a new paragraph, but
1691                 // we must make sure that the next item gets a \begin_layout.
1692                 parent_context.new_paragraph(os);
1693                 p.skip_spaces();
1694                 preamble.registerAutomaticallyLoadedPackage("rotfloat");
1695         }
1696
1697         else if (name == "wrapfigure" || name == "wraptable") {
1698                 // syntax is \begin{wrapfigure}[lines]{placement}[overhang]{width}
1699                 eat_whitespace(p, os, parent_context, false);
1700                 parent_context.check_layout(os);
1701                 // default values
1702                 string lines = "0";
1703                 string overhang = "0col%";
1704                 // parse
1705                 if (p.hasOpt())
1706                         lines = p.getArg('[', ']');
1707                 string const placement = p.getArg('{', '}');
1708                 if (p.hasOpt())
1709                         overhang = p.getArg('[', ']');
1710                 string const width = p.getArg('{', '}');
1711                 // write
1712                 if (name == "wrapfigure")
1713                         begin_inset(os, "Wrap figure\n");
1714                 else
1715                         begin_inset(os, "Wrap table\n");
1716                 os << "lines " << lines
1717                    << "\nplacement " << placement
1718                    << "\noverhang " << lyx::translate_len(overhang)
1719                    << "\nwidth " << lyx::translate_len(width)
1720                    << "\nstatus open\n\n";
1721                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1722                 end_inset(os);
1723                 // We don't need really a new paragraph, but
1724                 // we must make sure that the next item gets a \begin_layout.
1725                 parent_context.new_paragraph(os);
1726                 p.skip_spaces();
1727                 preamble.registerAutomaticallyLoadedPackage("wrapfig");
1728         }
1729
1730         else if (name == "minipage") {
1731                 eat_whitespace(p, os, parent_context, false);
1732                 // Test whether this is an outer box of a shaded box
1733                 p.pushPosition();
1734                 // swallow arguments
1735                 while (p.hasOpt()) {
1736                         p.getArg('[', ']');
1737                         p.skip_spaces(true);
1738                 }
1739                 p.getArg('{', '}');
1740                 p.skip_spaces(true);
1741                 Token t = p.get_token();
1742                 bool shaded = false;
1743                 if (t.asInput() == "\\begin") {
1744                         p.skip_spaces(true);
1745                         if (p.getArg('{', '}') == "shaded")
1746                                 shaded = true;
1747                 }
1748                 p.popPosition();
1749                 if (shaded)
1750                         parse_outer_box(p, os, FLAG_END, outer,
1751                                         parent_context, name, "shaded");
1752                 else
1753                         parse_box(p, os, 0, FLAG_END, outer, parent_context,
1754                                   "", "", name, "", "");
1755                 p.skip_spaces();
1756         }
1757
1758         else if (name == "comment") {
1759                 eat_whitespace(p, os, parent_context, false);
1760                 parent_context.check_layout(os);
1761                 begin_inset(os, "Note Comment\n");
1762                 os << "status open\n";
1763                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1764                 end_inset(os);
1765                 p.skip_spaces();
1766                 skip_braces(p); // eat {} that might by set by LyX behind comments
1767                 preamble.registerAutomaticallyLoadedPackage("verbatim");
1768         }
1769
1770         else if (unstarred_name == "verbatim") {
1771                 // FIXME: this should go in the generic code that
1772                 // handles environments defined in layout file that
1773                 // have "PassThru 1". However, the code over there is
1774                 // already too complicated for my taste.
1775                 string const ascii_name =
1776                         (name == "verbatim*") ? "Verbatim*" : "Verbatim";
1777                 parent_context.new_paragraph(os);
1778                 Context context(true, parent_context.textclass,
1779                                 &parent_context.textclass[from_ascii(ascii_name)]);
1780                 string s = p.verbatimEnvironment(name);
1781                 output_ert(os, s, context);
1782                 p.skip_spaces();
1783         }
1784
1785         else if (name == "IPA") {
1786                 eat_whitespace(p, os, parent_context, false);
1787                 parent_context.check_layout(os);
1788                 begin_inset(os, "IPA\n");
1789                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1790                 end_inset(os);
1791                 p.skip_spaces();
1792                 preamble.registerAutomaticallyLoadedPackage("tipa");
1793                 preamble.registerAutomaticallyLoadedPackage("tipx");
1794         }
1795
1796         else if (name == "CJK") {
1797                 // the scheme is \begin{CJK}{encoding}{mapping}text\end{CJK}
1798                 // It is impossible to decide if a CJK environment was in its own paragraph or within
1799                 // a line. We therefore always assume a paragraph since the latter is a rare case.
1800                 eat_whitespace(p, os, parent_context, false);
1801                 parent_context.check_end_layout(os);
1802                 // store the encoding to be able to reset it
1803                 string const encoding_old = p.getEncoding();
1804                 string const encoding = p.getArg('{', '}');
1805                 // FIXME: For some reason JIS does not work. Although the text
1806                 // in tests/CJK.tex is identical with the SJIS version if you
1807                 // convert both snippets using the recode command line utility,
1808                 // the resulting .lyx file contains some extra characters if
1809                 // you set buggy_encoding to false for JIS.
1810                 bool const buggy_encoding = encoding == "JIS";
1811                 if (!buggy_encoding)
1812                         p.setEncoding(encoding, Encoding::CJK);
1813                 else {
1814                         // FIXME: This will read garbage, since the data is not encoded in utf8.
1815                         p.setEncoding("UTF-8");
1816                 }
1817                 // LyX only supports the same mapping for all CJK
1818                 // environments, so we might need to output everything as ERT
1819                 string const mapping = trim(p.getArg('{', '}'));
1820                 char const * const * const where =
1821                         is_known(encoding, supported_CJK_encodings);
1822                 if (!buggy_encoding && !preamble.fontCJKSet())
1823                         preamble.fontCJK(mapping);
1824                 bool knownMapping = mapping == preamble.fontCJK();
1825                 if (buggy_encoding || !knownMapping || !where) {
1826                         parent_context.check_layout(os);
1827                         output_ert_inset(os, "\\begin{" + name + "}{" + encoding + "}{" + mapping + "}",
1828                                        parent_context);
1829                         // we must parse the content as verbatim because e.g. JIS can contain
1830                         // normally invalid characters
1831                         // FIXME: This works only for the most simple cases.
1832                         //        Since TeX control characters are not parsed,
1833                         //        things like comments are completely wrong.
1834                         string const s = p.plainEnvironment("CJK");
1835                         for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
1836                                 string snip;
1837                                 snip += *it;
1838                                 if (snip == "\\" || is_known(snip, known_escaped_chars))
1839                                         output_ert_inset(os, snip, parent_context);
1840                                 else if (*it == '\n' && it + 1 != et && s.begin() + 1 != it)
1841                                         os << "\n ";
1842                                 else
1843                                         os << *it;
1844                         }
1845                         output_ert_inset(os, "\\end{" + name + "}",
1846                                        parent_context);
1847                 } else {
1848                         string const lang =
1849                                 supported_CJK_languages[where - supported_CJK_encodings];
1850                         // store the language because we must reset it at the end
1851                         string const lang_old = parent_context.font.language;
1852                         parent_context.font.language = lang;
1853                         parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1854                         parent_context.font.language = lang_old;
1855                         parent_context.new_paragraph(os);
1856                 }
1857                 p.setEncoding(encoding_old);
1858                 p.skip_spaces();
1859         }
1860
1861         else if (name == "lyxgreyedout") {
1862                 eat_whitespace(p, os, parent_context, false);
1863                 parent_context.check_layout(os);
1864                 begin_inset(os, "Note Greyedout\n");
1865                 os << "status open\n";
1866                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1867                 end_inset(os);
1868                 p.skip_spaces();
1869                 if (!preamble.notefontcolor().empty())
1870                         preamble.registerAutomaticallyLoadedPackage("color");
1871         }
1872
1873         else if (name == "btSect") {
1874                 eat_whitespace(p, os, parent_context, false);
1875                 parent_context.check_layout(os);
1876                 begin_command_inset(os, "bibtex", "bibtex");
1877                 string bibstyle = "plain";
1878                 if (p.hasOpt()) {
1879                         bibstyle = p.getArg('[', ']');
1880                         p.skip_spaces(true);
1881                 }
1882                 string const bibfile = p.getArg('{', '}');
1883                 eat_whitespace(p, os, parent_context, false);
1884                 Token t = p.get_token();
1885                 if (t.asInput() == "\\btPrintCited") {
1886                         p.skip_spaces(true);
1887                         os << "btprint " << '"' << "btPrintCited" << '"' << "\n";
1888                 }
1889                 if (t.asInput() == "\\btPrintNotCited") {
1890                         p.skip_spaces(true);
1891                         os << "btprint " << '"' << "btPrintNotCited" << '"' << "\n";
1892                 }
1893                 if (t.asInput() == "\\btPrintAll") {
1894                         p.skip_spaces(true);
1895                         os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
1896                 }
1897                 os << "bibfiles " << '"' << bibfile << "\"\n"
1898                    << "options " << '"' << bibstyle << "\"\n";
1899                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
1900                 end_inset(os);
1901                 p.skip_spaces();
1902         }
1903
1904         else if (name == "framed" || name == "shaded") {
1905                 eat_whitespace(p, os, parent_context, false);
1906                 parse_outer_box(p, os, FLAG_END, outer, parent_context, name, "");
1907                 p.skip_spaces();
1908                 preamble.registerAutomaticallyLoadedPackage("framed");
1909         }
1910
1911         else if (name == "listing") {
1912                 minted_float = "float";
1913                 eat_whitespace(p, os, parent_context, false);
1914                 string const opt = p.hasOpt() ? p.getArg('[', ']') : string();
1915                 if (!opt.empty())
1916                         minted_float += "=" + opt;
1917                 // If something precedes \begin{minted}, we output it at the end
1918                 // as a caption, in order to keep it inside the listings inset.
1919                 eat_whitespace(p, os, parent_context, true);
1920                 p.pushPosition();
1921                 Token const & t = p.get_token();
1922                 p.skip_spaces(true);
1923                 string const envname = p.next_token().cat() == catBegin
1924                                                 ? p.getArg('{', '}') : string();
1925                 bool prologue = t.asInput() != "\\begin" || envname != "minted";
1926                 p.popPosition();
1927                 minted_float_has_caption = false;
1928                 string content = parse_text_snippet(p, FLAG_END, outer,
1929                                                     parent_context);
1930                 size_t i = content.find("\\begin_inset listings");
1931                 bool minted_env = i != string::npos;
1932                 string caption;
1933                 if (prologue) {
1934                         caption = content.substr(0, i);
1935                         content.erase(0, i);
1936                 }
1937                 parent_context.check_layout(os);
1938                 if (minted_env && minted_float_has_caption) {
1939                         eat_whitespace(p, os, parent_context, true);
1940                         os << content << "\n";
1941                         if (!caption.empty())
1942                                 os << caption << "\n";
1943                         os << "\n\\end_layout\n"; // close inner layout
1944                         end_inset(os);            // close caption inset
1945                         os << "\n\\end_layout\n"; // close outer layout
1946                 } else if (!caption.empty()) {
1947                         if (!minted_env) {
1948                                 begin_inset(os, "listings\n");
1949                                 os << "lstparams " << '"' << minted_float << '"' << '\n';
1950                                 os << "inline false\n";
1951                                 os << "status collapsed\n";
1952                         }
1953                         os << "\n\\begin_layout Plain Layout\n";
1954                         begin_inset(os, "Caption Standard\n");
1955                         Context newcontext(true, parent_context.textclass,
1956                                            0, 0, parent_context.font);
1957                         newcontext.check_layout(os);
1958                         os << caption << "\n";
1959                         newcontext.check_end_layout(os);
1960                         end_inset(os);
1961                         os << "\n\\end_layout\n";
1962                 } else if (content.empty()) {
1963                         begin_inset(os, "listings\n");
1964                         os << "lstparams " << '"' << minted_float << '"' << '\n';
1965                         os << "inline false\n";
1966                         os << "status collapsed\n";
1967                 } else {
1968                         os << content << "\n";
1969                 }
1970                 end_inset(os); // close listings inset
1971                 parent_context.check_end_layout(os);
1972                 parent_context.new_paragraph(os);
1973                 p.skip_spaces();
1974                 minted_float.clear();
1975                 minted_float_has_caption = false;
1976         }
1977
1978         else if (name == "lstlisting" || name == "minted") {
1979                 bool use_minted = name == "minted";
1980                 eat_whitespace(p, os, parent_context, false);
1981                 if (use_minted && minted_float.empty()) {
1982                         // look ahead for a bottom caption
1983                         p.pushPosition();
1984                         bool found_end_minted = false;
1985                         while (!found_end_minted && p.good()) {
1986                                 Token const & t = p.get_token();
1987                                 p.skip_spaces();
1988                                 string const envname =
1989                                         p.next_token().cat() == catBegin
1990                                                 ? p.getArg('{', '}') : string();
1991                                 found_end_minted = t.asInput() == "\\end"
1992                                                         && envname == "minted";
1993                         }
1994                         eat_whitespace(p, os, parent_context, true);
1995                         Token const & t = p.get_token();
1996                         p.skip_spaces(true);
1997                         if (t.asInput() == "\\lyxmintcaption") {
1998                                 string const pos = p.getArg('[', ']');
1999                                 if (pos == "b") {
2000                                         string const caption =
2001                                                 parse_text_snippet(p, FLAG_ITEM,
2002                                                         false, parent_context);
2003                                         minted_nonfloat_caption = "[b]" + caption;
2004                                 }
2005                         }
2006                         p.popPosition();
2007                 }
2008                 parse_listings(p, os, parent_context, false, use_minted);
2009                 p.skip_spaces();
2010         }
2011
2012         else if (!parent_context.new_layout_allowed)
2013                 parse_unknown_environment(p, name, os, FLAG_END, outer,
2014                                           parent_context);
2015
2016         // Alignment and spacing settings
2017         // FIXME (bug xxxx): These settings can span multiple paragraphs and
2018         //                                       therefore are totally broken!
2019         // Note that \centering, \raggedright, and \raggedleft cannot be handled, as
2020         // they are commands not environments. They are furthermore switches that
2021         // can be ended by another switches, but also by commands like \footnote or
2022         // \parbox. So the only safe way is to leave them untouched.
2023         // However, we support the pseudo-environments
2024         // \begin{centering} ... \end{centering}
2025         // \begin{raggedright} ... \end{raggedright}
2026         // \begin{raggedleft} ... \end{raggedleft}
2027         // since they are used by LyX in floats (for spacing reasons)
2028         else if (name == "center" || name == "centering" ||
2029                  name == "flushleft" || name == "raggedright" ||
2030                  name == "flushright" || name == "raggedleft" ||
2031                  name == "singlespace" || name == "onehalfspace" ||
2032                  name == "doublespace" || name == "spacing") {
2033                 eat_whitespace(p, os, parent_context, false);
2034                 // We must begin a new paragraph if not already done
2035                 if (! parent_context.atParagraphStart()) {
2036                         parent_context.check_end_layout(os);
2037                         parent_context.new_paragraph(os);
2038                 }
2039                 if (name == "flushleft" || name == "raggedright")
2040                         parent_context.add_extra_stuff("\\align left\n");
2041                 else if (name == "flushright" || name == "raggedleft")
2042                         parent_context.add_extra_stuff("\\align right\n");
2043                 else if (name == "center" || name == "centering")
2044                         parent_context.add_extra_stuff("\\align center\n");
2045                 else if (name == "singlespace")
2046                         parent_context.add_extra_stuff("\\paragraph_spacing single\n");
2047                 else if (name == "onehalfspace") {
2048                         parent_context.add_extra_stuff("\\paragraph_spacing onehalf\n");
2049                         preamble.registerAutomaticallyLoadedPackage("setspace");
2050                 } else if (name == "doublespace") {
2051                         parent_context.add_extra_stuff("\\paragraph_spacing double\n");
2052                         preamble.registerAutomaticallyLoadedPackage("setspace");
2053                 } else if (name == "spacing") {
2054                         parent_context.add_extra_stuff("\\paragraph_spacing other " + p.verbatim_item() + "\n");
2055                         preamble.registerAutomaticallyLoadedPackage("setspace");
2056                 }
2057                 parse_text(p, os, FLAG_END, outer, parent_context);
2058                 // Just in case the environment is empty
2059                 parent_context.extra_stuff.erase();
2060                 // We must begin a new paragraph to reset the alignment
2061                 parent_context.new_paragraph(os);
2062                 p.skip_spaces();
2063         }
2064
2065         // The single '=' is meant here.
2066         else if ((newlayout = findLayout(parent_context.textclass, name, false))) {
2067                 eat_whitespace(p, os, parent_context, false);
2068                 Context context(true, parent_context.textclass, newlayout,
2069                                 parent_context.layout, parent_context.font);
2070                 if (parent_context.deeper_paragraph) {
2071                         // We are beginning a nested environment after a
2072                         // deeper paragraph inside the outer list environment.
2073                         // Therefore we don't need to output a "begin deeper".
2074                         context.need_end_deeper = true;
2075                 }
2076                 parent_context.check_end_layout(os);
2077                 if (last_env == name) {
2078                         // we need to output a separator since LyX would export
2079                         // the two environments as one otherwise (bug 5716)
2080                         TeX2LyXDocClass const & textclass(parent_context.textclass);
2081                         Context newcontext(true, textclass,
2082                                         &(textclass.defaultLayout()));
2083                         newcontext.check_layout(os);
2084                         begin_inset(os, "Separator plain\n");
2085                         end_inset(os);
2086                         newcontext.check_end_layout(os);
2087                 }
2088                 switch (context.layout->latextype) {
2089                 case  LATEX_LIST_ENVIRONMENT:
2090                         context.add_par_extra_stuff("\\labelwidthstring "
2091                                                     + p.verbatim_item() + '\n');
2092                         p.skip_spaces();
2093                         break;
2094                 case  LATEX_BIB_ENVIRONMENT:
2095                         p.verbatim_item(); // swallow next arg
2096                         p.skip_spaces();
2097                         break;
2098                 default:
2099                         break;
2100                 }
2101                 context.check_deeper(os);
2102                 // handle known optional and required arguments
2103                 if (context.layout->latextype == LATEX_ENVIRONMENT)
2104                         output_arguments(os, p, outer, false, string(), context,
2105                                          context.layout->latexargs());
2106                 else if (context.layout->latextype == LATEX_ITEM_ENVIRONMENT) {
2107                         ostringstream oss;
2108                         output_arguments(oss, p, outer, false, string(), context,
2109                                          context.layout->latexargs());
2110                         context.list_extra_stuff = oss.str();
2111                 }
2112                 parse_text(p, os, FLAG_END, outer, context);
2113                 if (context.layout->latextype == LATEX_ENVIRONMENT)
2114                         output_arguments(os, p, outer, false, "post", context,
2115                                          context.layout->postcommandargs());
2116                 context.check_end_layout(os);
2117                 if (parent_context.deeper_paragraph) {
2118                         // We must suppress the "end deeper" because we
2119                         // suppressed the "begin deeper" above.
2120                         context.need_end_deeper = false;
2121                 }
2122                 context.check_end_deeper(os);
2123                 parent_context.new_paragraph(os);
2124                 p.skip_spaces();
2125                 if (!preamble.titleLayoutFound())
2126                         preamble.titleLayoutFound(newlayout->intitle);
2127                 set<string> const & req = newlayout->requires();
2128                 set<string>::const_iterator it = req.begin();
2129                 set<string>::const_iterator en = req.end();
2130                 for (; it != en; ++it)
2131                         preamble.registerAutomaticallyLoadedPackage(*it);
2132         }
2133
2134         // The single '=' is meant here.
2135         else if ((newinsetlayout = findInsetLayout(parent_context.textclass, name, false))) {
2136                 eat_whitespace(p, os, parent_context, false);
2137                 parent_context.check_layout(os);
2138                 begin_inset(os, "Flex ");
2139                 docstring flex_name = newinsetlayout->name();
2140                 // FIXME: what do we do if the prefix is not Flex: ?
2141                 if (prefixIs(flex_name, from_ascii("Flex:")))
2142                         flex_name.erase(0, 5);
2143                 os << to_utf8(flex_name) << '\n'
2144                    << "status collapsed\n";
2145                 if (newinsetlayout->isPassThru()) {
2146                         string const arg = p.verbatimEnvironment(name);
2147                         Context context(true, parent_context.textclass,
2148                                         &parent_context.textclass.plainLayout(),
2149                                         parent_context.layout);
2150                         output_ert(os, arg, parent_context);
2151                 } else
2152                         parse_text_in_inset(p, os, FLAG_END, false, parent_context, newinsetlayout);
2153                 end_inset(os);
2154         }
2155
2156         else if (name == "appendix") {
2157                 // This is no good latex style, but it works and is used in some documents...
2158                 eat_whitespace(p, os, parent_context, false);
2159                 parent_context.check_end_layout(os);
2160                 Context context(true, parent_context.textclass, parent_context.layout,
2161                                 parent_context.layout, parent_context.font);
2162                 context.check_layout(os);
2163                 os << "\\start_of_appendix\n";
2164                 parse_text(p, os, FLAG_END, outer, context);
2165                 context.check_end_layout(os);
2166                 p.skip_spaces();
2167         }
2168
2169         else if (known_environments.find(name) != known_environments.end()) {
2170                 vector<ArgumentType> arguments = known_environments[name];
2171                 // The last "argument" denotes wether we may translate the
2172                 // environment contents to LyX
2173                 // The default required if no argument is given makes us
2174                 // compatible with the reLyXre environment.
2175                 ArgumentType contents = arguments.empty() ?
2176                         required :
2177                         arguments.back();
2178                 if (!arguments.empty())
2179                         arguments.pop_back();
2180                 // See comment in parse_unknown_environment()
2181                 bool const specialfont =
2182                         (parent_context.font != parent_context.normalfont);
2183                 bool const new_layout_allowed =
2184                         parent_context.new_layout_allowed;
2185                 if (specialfont)
2186                         parent_context.new_layout_allowed = false;
2187                 parse_arguments("\\begin{" + name + "}", arguments, p, os,
2188                                 outer, parent_context);
2189                 if (contents == verbatim)
2190                         output_ert_inset(os, p.ertEnvironment(name),
2191                                    parent_context);
2192                 else
2193                         parse_text_snippet(p, os, FLAG_END, outer,
2194                                            parent_context);
2195                 output_ert_inset(os, "\\end{" + name + "}", parent_context);
2196                 if (specialfont)
2197                         parent_context.new_layout_allowed = new_layout_allowed;
2198         }
2199
2200         else
2201                 parse_unknown_environment(p, name, os, FLAG_END, outer,
2202                                           parent_context);
2203
2204         last_env = name;
2205         active_environments.pop_back();
2206 }
2207
2208
2209 /// parses a comment and outputs it to \p os.
2210 void parse_comment(Parser & p, ostream & os, Token const & t, Context & context)
2211 {
2212         LASSERT(t.cat() == catComment, return);
2213         if (!t.cs().empty()) {
2214                 context.check_layout(os);
2215                 output_comment(p, os, t.cs(), context);
2216                 if (p.next_token().cat() == catNewline) {
2217                         // A newline after a comment line starts a new
2218                         // paragraph
2219                         if (context.new_layout_allowed) {
2220                                 if(!context.atParagraphStart())
2221                                         // Only start a new paragraph if not already
2222                                         // done (we might get called recursively)
2223                                         context.new_paragraph(os);
2224                         } else
2225                                 output_ert_inset(os, "\n", context);
2226                         eat_whitespace(p, os, context, true);
2227                 }
2228         } else {
2229                 // "%\n" combination
2230                 p.skip_spaces();
2231         }
2232 }
2233
2234
2235 /*!
2236  * Reads spaces and comments until the first non-space, non-comment token.
2237  * New paragraphs (double newlines or \\par) are handled like simple spaces
2238  * if \p eatParagraph is true.
2239  * Spaces are skipped, but comments are written to \p os.
2240  */
2241 void eat_whitespace(Parser & p, ostream & os, Context & context,
2242                     bool eatParagraph)
2243 {
2244         while (p.good()) {
2245                 Token const & t = p.get_token();
2246                 if (t.cat() == catComment)
2247                         parse_comment(p, os, t, context);
2248                 else if ((! eatParagraph && p.isParagraph()) ||
2249                          (t.cat() != catSpace && t.cat() != catNewline)) {
2250                         p.putback();
2251                         return;
2252                 }
2253         }
2254 }
2255
2256
2257 /*!
2258  * Set a font attribute, parse text and reset the font attribute.
2259  * \param attribute Attribute name (e.g. \\family, \\shape etc.)
2260  * \param currentvalue Current value of the attribute. Is set to the new
2261  * value during parsing.
2262  * \param newvalue New value of the attribute
2263  */
2264 void parse_text_attributes(Parser & p, ostream & os, unsigned flags, bool outer,
2265                            Context & context, string const & attribute,
2266                            string & currentvalue, string const & newvalue)
2267 {
2268         context.check_layout(os);
2269         string const oldvalue = currentvalue;
2270         currentvalue = newvalue;
2271         os << '\n' << attribute << ' ' << newvalue << "\n";
2272         parse_text_snippet(p, os, flags, outer, context);
2273         context.check_layout(os);
2274         os << '\n' << attribute << ' ' << oldvalue << "\n";
2275         currentvalue = oldvalue;
2276 }
2277
2278
2279 /// get the arguments of a natbib or jurabib citation command
2280 void get_cite_arguments(Parser & p, bool natbibOrder,
2281         string & before, string & after, bool const qualified = false)
2282 {
2283         // We need to distinguish "" and "[]", so we can't use p.getOpt().
2284
2285         // text before the citation
2286         before.clear();
2287         // text after the citation
2288         after = qualified ? p.getFullOpt(false, '(', ')') : p.getFullOpt();
2289
2290         if (!after.empty()) {
2291                 before = qualified ? p.getFullOpt(false, '(', ')') : p.getFullOpt();
2292                 if (natbibOrder && !before.empty())
2293                         swap(before, after);
2294         }
2295 }
2296
2297
2298 void copy_file(FileName const & src, string dstname)
2299 {
2300         if (!copyFiles())
2301                 return;
2302         string const absParent = getParentFilePath(false);
2303         FileName dst;
2304         if (FileName::isAbsolute(dstname))
2305                 dst = FileName(dstname);
2306         else
2307                 dst = makeAbsPath(dstname, absParent);
2308         FileName const srcpath = src.onlyPath();
2309         FileName const dstpath = dst.onlyPath();
2310         if (equivalent(srcpath, dstpath))
2311                 return;
2312         if (!dstpath.isDirectory()) {
2313                 if (!dstpath.createPath()) {
2314                         cerr << "Warning: Could not create directory for file `"
2315                              << dst.absFileName() << "´." << endl;
2316                         return;
2317                 }
2318         }
2319         if (dst.isReadableFile()) {
2320                 if (overwriteFiles())
2321                         cerr << "Warning: Overwriting existing file `"
2322                              << dst.absFileName() << "´." << endl;
2323                 else {
2324                         cerr << "Warning: Not overwriting existing file `"
2325                              << dst.absFileName() << "´." << endl;
2326                         return;
2327                 }
2328         }
2329         if (!src.copyTo(dst))
2330                 cerr << "Warning: Could not copy file `" << src.absFileName()
2331                      << "´ to `" << dst.absFileName() << "´." << endl;
2332 }
2333
2334
2335 /// Parse a literate Chunk section. The initial "<<" is already parsed.
2336 bool parse_chunk(Parser & p, ostream & os, Context & context)
2337 {
2338         // check whether a chunk is possible here.
2339         if (!context.textclass.hasInsetLayout(from_ascii("Flex:Chunk"))) {
2340                 return false;
2341         }
2342
2343         p.pushPosition();
2344
2345         // read the parameters
2346         Parser::Arg const params = p.verbatimStuff(">>=\n", false);
2347         if (!params.first) {
2348                 p.popPosition();
2349                 return false;
2350         }
2351
2352         Parser::Arg const code = p.verbatimStuff("\n@");
2353         if (!code.first) {
2354                 p.popPosition();
2355                 return false;
2356         }
2357         string const post_chunk = p.verbatimStuff("\n").second + '\n';
2358         if (post_chunk[0] != ' ' && post_chunk[0] != '\n') {
2359                 p.popPosition();
2360                 return false;
2361         }
2362         // The last newline read is important for paragraph handling
2363         p.putback();
2364         p.deparse();
2365
2366         //cerr << "params=[" << params.second << "], code=[" << code.second << "]" <<endl;
2367         // We must have a valid layout before outputting the Chunk inset.
2368         context.check_layout(os);
2369         Context chunkcontext(true, context.textclass);
2370         chunkcontext.layout = &context.textclass.plainLayout();
2371         begin_inset(os, "Flex Chunk");
2372         os << "\nstatus open\n";
2373         if (!params.second.empty()) {
2374                 chunkcontext.check_layout(os);
2375                 Context paramscontext(true, context.textclass);
2376                 paramscontext.layout = &context.textclass.plainLayout();
2377                 begin_inset(os, "Argument 1");
2378                 os << "\nstatus open\n";
2379                 output_ert(os, params.second, paramscontext);
2380                 end_inset(os);
2381         }
2382         output_ert(os, code.second, chunkcontext);
2383         end_inset(os);
2384
2385         p.dropPosition();
2386         return true;
2387 }
2388
2389
2390 /// detects \\def, \\long\\def and \\global\\long\\def with ws and comments
2391 bool is_macro(Parser & p)
2392 {
2393         Token first = p.curr_token();
2394         if (first.cat() != catEscape || !p.good())
2395                 return false;
2396         if (first.cs() == "def")
2397                 return true;
2398         if (first.cs() != "global" && first.cs() != "long")
2399                 return false;
2400         Token second = p.get_token();
2401         int pos = 1;
2402         while (p.good() && !p.isParagraph() && (second.cat() == catSpace ||
2403                second.cat() == catNewline || second.cat() == catComment)) {
2404                 second = p.get_token();
2405                 pos++;
2406         }
2407         bool secondvalid = second.cat() == catEscape;
2408         Token third;
2409         bool thirdvalid = false;
2410         if (p.good() && first.cs() == "global" && secondvalid &&
2411             second.cs() == "long") {
2412                 third = p.get_token();
2413                 pos++;
2414                 while (p.good() && !p.isParagraph() &&
2415                        (third.cat() == catSpace ||
2416                         third.cat() == catNewline ||
2417                         third.cat() == catComment)) {
2418                         third = p.get_token();
2419                         pos++;
2420                 }
2421                 thirdvalid = third.cat() == catEscape;
2422         }
2423         for (int i = 0; i < pos; ++i)
2424                 p.putback();
2425         if (!secondvalid)
2426                 return false;
2427         if (!thirdvalid)
2428                 return (first.cs() == "global" || first.cs() == "long") &&
2429                        second.cs() == "def";
2430         return first.cs() == "global" && second.cs() == "long" &&
2431                third.cs() == "def";
2432 }
2433
2434
2435 /// Parse a macro definition (assumes that is_macro() returned true)
2436 void parse_macro(Parser & p, ostream & os, Context & context)
2437 {
2438         context.check_layout(os);
2439         Token first = p.curr_token();
2440         Token second;
2441         Token third;
2442         string command = first.asInput();
2443         if (first.cs() != "def") {
2444                 p.get_token();
2445                 eat_whitespace(p, os, context, false);
2446                 second = p.curr_token();
2447                 command += second.asInput();
2448                 if (second.cs() != "def") {
2449                         p.get_token();
2450                         eat_whitespace(p, os, context, false);
2451                         third = p.curr_token();
2452                         command += third.asInput();
2453                 }
2454         }
2455         eat_whitespace(p, os, context, false);
2456         string const name = p.get_token().cs();
2457         eat_whitespace(p, os, context, false);
2458
2459         // parameter text
2460         bool simple = true;
2461         string paramtext;
2462         int arity = 0;
2463         while (p.next_token().cat() != catBegin) {
2464                 if (p.next_token().cat() == catParameter) {
2465                         // # found
2466                         p.get_token();
2467                         paramtext += "#";
2468
2469                         // followed by number?
2470                         if (p.next_token().cat() == catOther) {
2471                                 string s = p.get_token().asInput();
2472                                 paramtext += s;
2473                                 // number = current arity + 1?
2474                                 if (s.size() == 1 && s[0] == arity + '0' + 1)
2475                                         ++arity;
2476                                 else
2477                                         simple = false;
2478                         } else
2479                                 paramtext += p.get_token().cs();
2480                 } else {
2481                         paramtext += p.get_token().cs();
2482                         simple = false;
2483                 }
2484         }
2485
2486         // only output simple (i.e. compatible) macro as FormulaMacros
2487         string ert = '\\' + name + ' ' + paramtext + '{' + p.verbatim_item() + '}';
2488         if (simple) {
2489                 context.check_layout(os);
2490                 begin_inset(os, "FormulaMacro");
2491                 os << "\n\\def" << ert;
2492                 end_inset(os);
2493         } else
2494                 output_ert_inset(os, command + ert, context);
2495 }
2496
2497
2498 void registerExternalTemplatePackages(string const & name)
2499 {
2500         external::TemplateManager const & etm = external::TemplateManager::get();
2501         external::Template const * const et = etm.getTemplateByName(name);
2502         if (!et)
2503                 return;
2504         external::Template::Formats::const_iterator cit = et->formats.end();
2505         if (pdflatex)
2506                 cit = et->formats.find("PDFLaTeX");
2507         if (cit == et->formats.end())
2508                 // If the template has not specified a PDFLaTeX output,
2509                 // we try the LaTeX format.
2510                 cit = et->formats.find("LaTeX");
2511         if (cit == et->formats.end())
2512                 return;
2513         vector<string>::const_iterator qit = cit->second.requirements.begin();
2514         vector<string>::const_iterator qend = cit->second.requirements.end();
2515         for (; qit != qend; ++qit)
2516                 preamble.registerAutomaticallyLoadedPackage(*qit);
2517 }
2518
2519 } // anonymous namespace
2520
2521
2522 /*!
2523  * Find a file with basename \p name in path \p path and an extension
2524  * in \p extensions.
2525  */
2526 string find_file(string const & name, string const & path,
2527                  char const * const * extensions)
2528 {
2529         for (char const * const * what = extensions; *what; ++what) {
2530                 string const trial = addExtension(name, *what);
2531                 if (makeAbsPath(trial, path).exists())
2532                         return trial;
2533         }
2534         return string();
2535 }
2536
2537
2538 /// Convert filenames with TeX macros and/or quotes to something LyX
2539 /// can understand
2540 string const normalize_filename(string const & name)
2541 {
2542         Parser p(name);
2543         ostringstream os;
2544         while (p.good()) {
2545                 Token const & t = p.get_token();
2546                 if (t.cat() != catEscape)
2547                         os << t.asInput();
2548                 else if (t.cs() == "lyxdot") {
2549                         // This is used by LyX for simple dots in relative
2550                         // names
2551                         os << '.';
2552                         p.skip_spaces();
2553                 } else if (t.cs() == "space") {
2554                         os << ' ';
2555                         p.skip_spaces();
2556                 } else if (t.cs() == "string") {
2557                         // Convert \string" to " and \string~ to ~
2558                         Token const & n = p.next_token();
2559                         if (n.asInput() != "\"" && n.asInput() != "~")
2560                                 os << t.asInput();
2561                 } else
2562                         os << t.asInput();
2563         }
2564         // Strip quotes. This is a bit complicated (see latex_path()).
2565         string full = os.str();
2566         if (!full.empty() && full[0] == '"') {
2567                 string base = removeExtension(full);
2568                 string ext = getExtension(full);
2569                 if (!base.empty() && base[base.length()-1] == '"')
2570                         // "a b"
2571                         // "a b".tex
2572                         return addExtension(trim(base, "\""), ext);
2573                 if (full[full.length()-1] == '"')
2574                         // "a b.c"
2575                         // "a b.c".tex
2576                         return trim(full, "\"");
2577         }
2578         return full;
2579 }
2580
2581
2582 /// Convert \p name from TeX convention (relative to master file) to LyX
2583 /// convention (relative to .lyx file) if it is relative
2584 void fix_child_filename(string & name)
2585 {
2586         string const absMasterTeX = getMasterFilePath(true);
2587         bool const isabs = FileName::isAbsolute(name);
2588         // convert from "relative to .tex master" to absolute original path
2589         if (!isabs)
2590                 name = makeAbsPath(name, absMasterTeX).absFileName();
2591         bool copyfile = copyFiles();
2592         string const absParentLyX = getParentFilePath(false);
2593         string abs = name;
2594         if (copyfile) {
2595                 // convert from absolute original path to "relative to master file"
2596                 string const rel = to_utf8(makeRelPath(from_utf8(name),
2597                                                        from_utf8(absMasterTeX)));
2598                 // re-interpret "relative to .tex file" as "relative to .lyx file"
2599                 // (is different if the master .lyx file resides in a
2600                 // different path than the master .tex file)
2601                 string const absMasterLyX = getMasterFilePath(false);
2602                 abs = makeAbsPath(rel, absMasterLyX).absFileName();
2603                 // Do not copy if the new path is impossible to create. Example:
2604                 // absMasterTeX = "/foo/bar/"
2605                 // absMasterLyX = "/bar/"
2606                 // name = "/baz.eps" => new absolute name would be "/../baz.eps"
2607                 if (contains(name, "/../"))
2608                         copyfile = false;
2609         }
2610         if (copyfile) {
2611                 if (isabs)
2612                         name = abs;
2613                 else {
2614                         // convert from absolute original path to
2615                         // "relative to .lyx file"
2616                         name = to_utf8(makeRelPath(from_utf8(abs),
2617                                                    from_utf8(absParentLyX)));
2618                 }
2619         }
2620         else if (!isabs) {
2621                 // convert from absolute original path to "relative to .lyx file"
2622                 name = to_utf8(makeRelPath(from_utf8(name),
2623                                            from_utf8(absParentLyX)));
2624         }
2625 }
2626
2627
2628 void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
2629                 Context & context, string const rdelim)
2630 {
2631         Layout const * newlayout = 0;
2632         InsetLayout const * newinsetlayout = 0;
2633         char const * const * where = 0;
2634         // Store the latest bibliographystyle, addcontentslineContent and
2635         // nocite{*} option (needed for bibtex inset)
2636         string btprint;
2637         string contentslineContent;
2638         // Some classes provide a \bibliographystyle, so do not output
2639         // any if none is explicitly set.
2640         string bibliographystyle;
2641         bool const use_natbib = isProvided("natbib");
2642         bool const use_jurabib = isProvided("jurabib");
2643         bool const use_biblatex = isProvided("biblatex")
2644                         && preamble.citeEngine() != "biblatex-natbib";
2645         bool const use_biblatex_natbib = isProvided("biblatex-natbib")
2646                         || (isProvided("biblatex") && preamble.citeEngine() == "biblatex-natbib");
2647         need_commentbib = use_biblatex || use_biblatex_natbib;
2648         string last_env;
2649
2650         // it is impossible to determine the correct encoding for non-CJK Japanese.
2651         // Therefore write a note at the beginning of the document
2652         if (is_nonCJKJapanese) {
2653                 context.check_layout(os);
2654                 begin_inset(os, "Note Note\n");
2655                 os << "status open\n\\begin_layout Plain Layout\n"
2656                    << "\\series bold\n"
2657                    << "Important information:\n"
2658                    << "\\end_layout\n\n"
2659                    << "\\begin_layout Plain Layout\n"
2660                    << "The original LaTeX source for this document is in Japanese (pLaTeX).\n"
2661                    << " It was therefore impossible for tex2lyx to determine the correct encoding.\n"
2662                    << " The iconv encoding " << p.getEncoding() << " was used.\n"
2663                    << " If this is incorrect, you must run the tex2lyx program on the command line\n"
2664                    << " and specify the encoding using the -e command-line switch.\n"
2665                    << " In addition, you might want to double check that the desired output encoding\n"
2666                    << " is correctly selected in Document > Settings > Language.\n"
2667                    << "\\end_layout\n";
2668                 end_inset(os);
2669                 is_nonCJKJapanese = false;
2670         }
2671
2672         bool have_cycled = false;
2673         while (p.good()) {
2674                 // Leave here only after at least one cycle
2675                 if (have_cycled && flags & FLAG_LEAVE) {
2676                         flags &= ~FLAG_LEAVE;
2677                         break;
2678                 }
2679
2680                 Token const & t = p.get_token();
2681 #ifdef FILEDEBUG
2682                 debugToken(cerr, t, flags);
2683 #endif
2684
2685                 if (flags & FLAG_ITEM) {
2686                         if (t.cat() == catSpace)
2687                                 continue;
2688
2689                         flags &= ~FLAG_ITEM;
2690                         if (t.cat() == catBegin) {
2691                                 // skip the brace and collect everything to the next matching
2692                                 // closing brace
2693                                 flags |= FLAG_BRACE_LAST;
2694                                 continue;
2695                         }
2696
2697                         // handle only this single token, leave the loop if done
2698                         flags |= FLAG_LEAVE;
2699                 }
2700
2701                 if (t.cat() != catEscape && t.character() == ']' &&
2702                     (flags & FLAG_BRACK_LAST))
2703                         return;
2704                 if (t.cat() == catEnd && (flags & FLAG_BRACE_LAST))
2705                         return;
2706                 string tok = t.asInput();
2707                 // we only support delimiters with max 2 chars for now.
2708                 if (rdelim.size() > 1)
2709                         tok += p.next_token().asInput();
2710                 if (t.cat() != catEscape && !rdelim.empty()
2711                     && tok == rdelim && (flags & FLAG_RDELIM)) {
2712                         if (rdelim.size() > 1)
2713                                 p.get_token(); // eat rdelim
2714                         return;
2715                 }
2716
2717                 // If there is anything between \end{env} and \begin{env} we
2718                 // don't need to output a separator.
2719                 if (t.cat() != catSpace && t.cat() != catNewline &&
2720                     t.asInput() != "\\begin")
2721                         last_env = "";
2722
2723                 //
2724                 // cat codes
2725                 //
2726                 have_cycled = true;
2727                 bool const starred = p.next_token().asInput() == "*";
2728                 string const starredname(starred ? (t.cs() + '*') : t.cs());
2729                 if (t.cat() == catMath) {
2730                         // we are inside some text mode thingy, so opening new math is allowed
2731                         context.check_layout(os);
2732                         begin_inset(os, "Formula ");
2733                         Token const & n = p.get_token();
2734                         bool const display(n.cat() == catMath && outer);
2735                         if (display) {
2736                                 // TeX's $$...$$ syntax for displayed math
2737                                 os << "\\[";
2738                                 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2739                                 os << "\\]";
2740                                 p.get_token(); // skip the second '$' token
2741                         } else {
2742                                 // simple $...$  stuff
2743                                 p.putback();
2744                                 os << '$';
2745                                 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
2746                                 os << '$';
2747                         }
2748                         end_inset(os);
2749                         if (display) {
2750                                 // Prevent the conversion of a line break to a
2751                                 // space (bug 7668). This does not change the
2752                                 // output, but looks ugly in LyX.
2753                                 eat_whitespace(p, os, context, false);
2754                         }
2755                         continue;
2756                 }
2757
2758                 if (t.cat() == catSuper || t.cat() == catSub) {
2759                         cerr << "catcode " << t << " illegal in text mode\n";
2760                         continue;
2761                 }
2762
2763                 // Basic support for quotes. We try to disambiguate
2764                 // quotes from the context (e.g., a left english quote is
2765                 // the same as a right german quote...).
2766                 // Try to make a smart guess about the side
2767                 Token const prev = p.prev_token();
2768                 bool const opening = (prev.cat() != catSpace && prev.character() != 0
2769                                 && prev.character() != '\n' && prev.character() != '~');
2770                 if (t.asInput() == "`" && p.next_token().asInput() == "`") {
2771                         context.check_layout(os);
2772                         begin_inset(os, "Quotes ");
2773                         os << guessQuoteStyle("eld", opening);
2774                         end_inset(os);
2775                         p.get_token();
2776                         skip_braces(p);
2777                         continue;
2778                 }
2779                 if (t.asInput() == "'" && p.next_token().asInput() == "'") {
2780                         context.check_layout(os);
2781                         begin_inset(os, "Quotes ");
2782                         os << guessQuoteStyle("erd", opening);
2783                         end_inset(os);
2784                         p.get_token();
2785                         skip_braces(p);
2786                         continue;
2787                 }
2788
2789                 if (t.asInput() == ">" && p.next_token().asInput() == ">") {
2790                         context.check_layout(os);
2791                         begin_inset(os, "Quotes ");
2792                         os << guessQuoteStyle("ald", opening);
2793                         end_inset(os);
2794                         p.get_token();
2795                         skip_braces(p);
2796                         continue;
2797                 }
2798
2799                 if (t.asInput() == "<"
2800                          && p.next_token().asInput() == "<") {
2801                         bool has_chunk = false;
2802                         if (noweb_mode) {
2803                                 p.pushPosition();
2804                                 p.get_token();
2805                                 has_chunk = parse_chunk(p, os, context);
2806                                 if (!has_chunk)
2807                                         p.popPosition();
2808                         }
2809
2810                         if (!has_chunk) {
2811                                 context.check_layout(os);
2812                                 begin_inset(os, "Quotes ");
2813                                 os << guessQuoteStyle("ard", opening);
2814                                 end_inset(os);
2815                                 p.get_token();
2816                                 skip_braces(p);
2817                         }
2818                         continue;
2819                 }
2820
2821                 if (t.cat() == catSpace || (t.cat() == catNewline && ! p.isParagraph())) {
2822                         check_space(p, os, context);
2823                         continue;
2824                 }
2825
2826                 // babel shorthands (also used by polyglossia)
2827                 // Since these can have different meanings for different languages
2828                 // we import them as ERT (but they must be put in ERT to get output
2829                 // verbatim).
2830                 if (t.asInput() == "\"") {
2831                         string s = "\"";
2832                         // These are known pairs. We put them together in
2833                         // one ERT inset. In other cases (such as "a), only
2834                         // the quotation mark is ERTed.
2835                         if (p.next_token().asInput() == "\""
2836                             || p.next_token().asInput() == "|"
2837                             || p.next_token().asInput() == "-"
2838                             || p.next_token().asInput() == "~"
2839                             || p.next_token().asInput() == "="
2840                             || p.next_token().asInput() == "/"
2841                             || p.next_token().asInput() == "~"
2842                             || p.next_token().asInput() == "'"
2843                             || p.next_token().asInput() == "`"
2844                             || p.next_token().asInput() == "<"
2845                             || p.next_token().asInput() == ">") {
2846                                 s += p.next_token().asInput();
2847                                 p.get_token();
2848                         }
2849                         output_ert_inset(os, s, context);
2850                         continue;
2851                 }
2852
2853                 if (t.character() == '[' && noweb_mode &&
2854                          p.next_token().character() == '[') {
2855                         // These can contain underscores
2856                         p.putback();
2857                         string const s = p.getFullOpt() + ']';
2858                         if (p.next_token().character() == ']')
2859                                 p.get_token();
2860                         else
2861                                 cerr << "Warning: Inserting missing ']' in '"
2862                                      << s << "'." << endl;
2863                         output_ert_inset(os, s, context);
2864                         continue;
2865                 }
2866
2867                 if (t.cat() == catLetter) {
2868                         context.check_layout(os);
2869                         os << t.cs();
2870                         continue;
2871                 }
2872
2873                 if (t.cat() == catOther ||
2874                                t.cat() == catAlign ||
2875                                t.cat() == catParameter) {
2876                         context.check_layout(os);
2877                         if (t.asInput() == "-" && p.next_token().asInput() == "-" &&
2878                             context.merging_hyphens_allowed &&
2879                             context.font.family != "ttfamily" &&
2880                             !context.layout->pass_thru) {
2881                                 if (p.next_next_token().asInput() == "-") {
2882                                         // --- is emdash
2883                                         os << to_utf8(docstring(1, 0x2014));
2884                                         p.get_token();
2885                                 } else
2886                                         // -- is endash
2887                                         os << to_utf8(docstring(1, 0x2013));
2888                                 p.get_token();
2889                         } else
2890                                 // This translates "&" to "\\&" which may be wrong...
2891                                 os << t.cs();
2892                         continue;
2893                 }
2894
2895                 if (p.isParagraph()) {
2896                         // In minted floating listings we will collect
2897                         // everything into the caption, where multiple
2898                         // paragraphs are forbidden.
2899                         if (minted_float.empty()) {
2900                                 if (context.new_layout_allowed)
2901                                         context.new_paragraph(os);
2902                                 else
2903                                         output_ert_inset(os, "\\par ", context);
2904                         } else
2905                                 os << ' ';
2906                         eat_whitespace(p, os, context, true);
2907                         continue;
2908                 }
2909
2910                 if (t.cat() == catActive) {
2911                         context.check_layout(os);
2912                         if (t.character() == '~') {
2913                                 if (context.layout->free_spacing)
2914                                         os << ' ';
2915                                 else {
2916                                         begin_inset(os, "space ~\n");
2917                                         end_inset(os);
2918                                 }
2919                         } else
2920                                 os << t.cs();
2921                         continue;
2922                 }
2923
2924                 if (t.cat() == catBegin) {
2925                         Token const next = p.next_token();
2926                         Token const end = p.next_next_token();
2927                         if (next.cat() == catEnd) {
2928                                 // {}
2929                                 Token const prev = p.prev_token();
2930                                 p.get_token();
2931                                 if (p.next_token().character() == '`')
2932                                         ; // ignore it in {}``
2933                                 else
2934                                         output_ert_inset(os, "{}", context);
2935                         } else if (next.cat() == catEscape &&
2936                                    is_known(next.cs(), known_quotes) &&
2937                                    end.cat() == catEnd) {
2938                                 // Something like {\textquoteright} (e.g.
2939                                 // from writer2latex). We may skip the
2940                                 // braces here for better readability.
2941                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2942                                                    outer, context);
2943                         } else if (p.next_token().asInput() == "\\ascii") {
2944                                 // handle the \ascii characters
2945                                 // (the case without braces is handled later)
2946                                 // the code is "{\ascii\xxx}"
2947                                 p.get_token(); // eat \ascii
2948                                 string name2 = p.get_token().asInput();
2949                                 p.get_token(); // eat the final '}'
2950                                 string const name = "{\\ascii" + name2 + "}";
2951                                 bool termination;
2952                                 docstring rem;
2953                                 set<string> req;
2954                                 // get the character from unicodesymbols
2955                                 docstring s = encodings.fromLaTeXCommand(from_utf8(name),
2956                                         Encodings::TEXT_CMD, termination, rem, &req);
2957                                 if (!s.empty()) {
2958                                         context.check_layout(os);
2959                                         os << to_utf8(s);
2960                                         if (!rem.empty())
2961                                                 output_ert_inset(os,
2962                                                         to_utf8(rem), context);
2963                                         for (set<string>::const_iterator it = req.begin();
2964                                              it != req.end(); ++it)
2965                                                 preamble.registerAutomaticallyLoadedPackage(*it);
2966                                 } else
2967                                         // we did not find a non-ert version
2968                                         output_ert_inset(os, name, context);
2969                         } else {
2970                         context.check_layout(os);
2971                         // special handling of font attribute changes
2972                         Token const prev = p.prev_token();
2973                         TeXFont const oldFont = context.font;
2974                         if (next.character() == '[' ||
2975                             next.character() == ']' ||
2976                             next.character() == '*') {
2977                                 p.get_token();
2978                                 if (p.next_token().cat() == catEnd) {
2979                                         os << next.cs();
2980                                         p.get_token();
2981                                 } else {
2982                                         p.putback();
2983                                         output_ert_inset(os, "{", context);
2984                                         parse_text_snippet(p, os,
2985                                                         FLAG_BRACE_LAST,
2986                                                         outer, context);
2987                                         output_ert_inset(os, "}", context);
2988                                 }
2989                         } else if (! context.new_layout_allowed) {
2990                                 output_ert_inset(os, "{", context);
2991                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2992                                                    outer, context);
2993                                 output_ert_inset(os, "}", context);
2994                         } else if (is_known(next.cs(), known_sizes)) {
2995                                 // next will change the size, so we must
2996                                 // reset it here
2997                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
2998                                                    outer, context);
2999                                 if (!context.atParagraphStart())
3000                                         os << "\n\\size "
3001                                            << context.font.size << "\n";
3002                         } else if (is_known(next.cs(), known_font_families)) {
3003                                 // next will change the font family, so we
3004                                 // must reset it here
3005                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3006                                                    outer, context);
3007                                 if (!context.atParagraphStart())
3008                                         os << "\n\\family "
3009                                            << context.font.family << "\n";
3010                         } else if (is_known(next.cs(), known_font_series)) {
3011                                 // next will change the font series, so we
3012                                 // must reset it here
3013                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3014                                                    outer, context);
3015                                 if (!context.atParagraphStart())
3016                                         os << "\n\\series "
3017                                            << context.font.series << "\n";
3018                         } else if (is_known(next.cs(), known_font_shapes)) {
3019                                 // next will change the font shape, so we
3020                                 // must reset it here
3021                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3022                                                    outer, context);
3023                                 if (!context.atParagraphStart())
3024                                         os << "\n\\shape "
3025                                            << context.font.shape << "\n";
3026                         } else if (is_known(next.cs(), known_old_font_families) ||
3027                                    is_known(next.cs(), known_old_font_series) ||
3028                                    is_known(next.cs(), known_old_font_shapes)) {
3029                                 // next will change the font family, series
3030                                 // and shape, so we must reset it here
3031                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3032                                                    outer, context);
3033                                 if (!context.atParagraphStart())
3034                                         os <<  "\n\\family "
3035                                            << context.font.family
3036                                            << "\n\\series "
3037                                            << context.font.series
3038                                            << "\n\\shape "
3039                                            << context.font.shape << "\n";
3040                         } else {
3041                                 output_ert_inset(os, "{", context);
3042                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
3043                                                    outer, context);
3044                                 output_ert_inset(os, "}", context);
3045                                 }
3046                         }
3047                         continue;
3048                 }
3049
3050                 if (t.cat() == catEnd) {
3051                         if (flags & FLAG_BRACE_LAST) {
3052                                 return;
3053                         }
3054                         cerr << "stray '}' in text\n";
3055                         output_ert_inset(os, "}", context);
3056                         continue;
3057                 }
3058
3059                 if (t.cat() == catComment) {
3060                         parse_comment(p, os, t, context);
3061                         continue;
3062                 }
3063
3064                 //
3065                 // control sequences
3066                 //
3067
3068                 if (t.cs() == "(" || t.cs() == "[") {
3069                         bool const simple = t.cs() == "(";
3070                         context.check_layout(os);
3071                         begin_inset(os, "Formula");
3072                         os << " \\" << t.cs();
3073                         parse_math(p, os, simple ? FLAG_SIMPLE2 : FLAG_EQUATION, MATH_MODE);
3074                         os << '\\' << (simple ? ')' : ']');
3075                         end_inset(os);
3076                         if (!simple) {
3077                                 // Prevent the conversion of a line break to a
3078                                 // space (bug 7668). This does not change the
3079                                 // output, but looks ugly in LyX.
3080                                 eat_whitespace(p, os, context, false);
3081                         }
3082                         continue;
3083                 }
3084
3085                 if (t.cs() == "begin") {
3086                         parse_environment(p, os, outer, last_env,
3087                                           context);
3088                         continue;
3089                 }
3090
3091                 if (t.cs() == "end") {
3092                         if (flags & FLAG_END) {
3093                                 // eat environment name
3094                                 string const name = p.getArg('{', '}');
3095                                 if (name != active_environment())
3096                                         cerr << "\\end{" + name + "} does not match \\begin{"
3097                                                 + active_environment() + "}\n";
3098                                 return;
3099                         }
3100                         p.error("found 'end' unexpectedly");
3101                         continue;
3102                 }
3103
3104                 // "item" by default, but could be something else
3105                 if (t.cs() == context.layout->itemcommand()) {
3106                         string s;
3107                         if (context.layout->labeltype == LABEL_MANUAL) {
3108                                 // FIXME: This swallows comments, but we cannot use
3109                                 //        eat_whitespace() since we must not output
3110                                 //        anything before the item.
3111                                 p.skip_spaces(true);
3112                                 s = p.verbatimOption();
3113                         } else
3114                                 p.skip_spaces(false);
3115                         context.set_item();
3116                         context.check_layout(os);
3117                         if (context.has_item) {
3118                                 // An item in an unknown list-like environment
3119                                 // FIXME: Do this in check_layout()!
3120                                 context.has_item = false;
3121                                 string item = "\\" + context.layout->itemcommand();
3122                                 if (!p.hasOpt())
3123                                         item += " ";
3124                                 output_ert_inset(os, item, context);
3125                         }
3126                         if (context.layout->labeltype != LABEL_MANUAL)
3127                                 output_arguments(os, p, outer, false, "item", context,
3128                                                  context.layout->itemargs());
3129                         if (!context.list_extra_stuff.empty()) {
3130                                 os << context.list_extra_stuff;
3131                                 context.list_extra_stuff.clear();
3132                         }
3133                         else if (!s.empty()) {
3134                                         // LyX adds braces around the argument,
3135                                         // so we need to remove them here.
3136                                         if (s.size() > 2 && s[0] == '{' &&
3137                                             s[s.size()-1] == '}')
3138                                                 s = s.substr(1, s.size()-2);
3139                                         // If the argument contains a space we
3140                                         // must put it into ERT: Otherwise LyX
3141                                         // would misinterpret the space as
3142                                         // item delimiter (bug 7663)
3143                                         if (contains(s, ' ')) {
3144                                                 output_ert_inset(os, s, context);
3145                                         } else {
3146                                                 Parser p2(s + ']');
3147                                                 os << parse_text_snippet(p2,
3148                                                         FLAG_BRACK_LAST, outer, context);
3149                                         }
3150                                         // The space is needed to separate the
3151                                         // item from the rest of the sentence.
3152                                         os << ' ';
3153                                         eat_whitespace(p, os, context, false);
3154                                 }
3155                         continue;
3156                 }
3157
3158                 if (t.cs() == "bibitem") {
3159                         context.set_item();
3160                         context.check_layout(os);
3161                         eat_whitespace(p, os, context, false);
3162                         string label = p.verbatimOption();
3163                         pair<bool, string> lbl = convert_latexed_command_inset_arg(label);
3164                         bool const literal = !lbl.first;
3165                         label = literal ? subst(label, "\n", " ") : lbl.second;
3166                         string lit = literal ? "\"true\"" : "\"false\"";
3167                         string key = convert_literate_command_inset_arg(p.verbatim_item());
3168                         begin_command_inset(os, "bibitem", "bibitem");
3169                         os << "label \"" << label << "\"\n"
3170                            << "key \"" << key << "\"\n"
3171                            << "literal " << lit << "\n";
3172                         end_inset(os);
3173                         continue;
3174                 }
3175
3176                 if (is_macro(p)) {
3177                         // catch the case of \def\inputGnumericTable
3178                         bool macro = true;
3179                         if (t.cs() == "def") {
3180                                 Token second = p.next_token();
3181                                 if (second.cs() == "inputGnumericTable") {
3182                                         p.pushPosition();
3183                                         p.get_token();
3184                                         skip_braces(p);
3185                                         Token third = p.get_token();
3186                                         p.popPosition();
3187                                         if (third.cs() == "input") {
3188                                                 p.get_token();
3189                                                 skip_braces(p);
3190                                                 p.get_token();
3191                                                 string name = normalize_filename(p.verbatim_item());
3192                                                 string const path = getMasterFilePath(true);
3193                                                 // We want to preserve relative / absolute filenames,
3194                                                 // therefore path is only used for testing
3195                                                 // The file extension is in every case ".tex".
3196                                                 // So we need to remove this extension and check for
3197                                                 // the original one.
3198                                                 name = removeExtension(name);
3199                                                 if (!makeAbsPath(name, path).exists()) {
3200                                                         char const * const Gnumeric_formats[] = {"gnumeric",
3201                                                                 "ods", "xls", 0};
3202                                                         string const Gnumeric_name =
3203                                                                 find_file(name, path, Gnumeric_formats);
3204                                                         if (!Gnumeric_name.empty())
3205                                                                 name = Gnumeric_name;
3206                                                 }
3207                                                 FileName const absname = makeAbsPath(name, path);
3208                                                 if (absname.exists()) {
3209                                                         fix_child_filename(name);
3210                                                         copy_file(absname, name);
3211                                                 } else
3212                                                         cerr << "Warning: Could not find file '"
3213                                                              << name << "'." << endl;
3214                                                 context.check_layout(os);
3215                                                 begin_inset(os, "External\n\ttemplate ");
3216                                                 os << "GnumericSpreadsheet\n\tfilename "
3217                                                    << name << "\n";
3218                                                 end_inset(os);
3219                                                 context.check_layout(os);
3220                                                 macro = false;
3221                                                 // register the packages that are automatically loaded
3222                                                 // by the Gnumeric template
3223                                                 registerExternalTemplatePackages("GnumericSpreadsheet");
3224                                         }
3225                                 }
3226                         }
3227                         if (macro)
3228                                 parse_macro(p, os, context);
3229                         continue;
3230                 }
3231
3232                 if (t.cs() == "noindent") {
3233                         p.skip_spaces();
3234                         context.add_par_extra_stuff("\\noindent\n");
3235                         continue;
3236                 }
3237
3238                 if (t.cs() == "appendix") {
3239                         context.add_par_extra_stuff("\\start_of_appendix\n");
3240                         // We need to start a new paragraph. Otherwise the
3241                         // appendix in 'bla\appendix\chapter{' would start
3242                         // too late.
3243                         context.new_paragraph(os);
3244                         // We need to make sure that the paragraph is
3245                         // generated even if it is empty. Otherwise the
3246                         // appendix in '\par\appendix\par\chapter{' would
3247                         // start too late.
3248                         context.check_layout(os);
3249                         // FIXME: This is a hack to prevent paragraph
3250                         // deletion if it is empty. Handle this better!
3251                         output_comment(p, os,
3252                                 "dummy comment inserted by tex2lyx to "
3253                                 "ensure that this paragraph is not empty",
3254                                 context);
3255                         // Both measures above may generate an additional
3256                         // empty paragraph, but that does not hurt, because
3257                         // whitespace does not matter here.
3258                         eat_whitespace(p, os, context, true);
3259                         continue;
3260                 }
3261
3262                 // Must catch empty dates before findLayout is called below
3263                 if (t.cs() == "date") {
3264                         eat_whitespace(p, os, context, false);
3265                         p.pushPosition();
3266                         string const date = p.verbatim_item();
3267                         p.popPosition();
3268                         if (date.empty()) {
3269                                 preamble.suppressDate(true);
3270                                 p.verbatim_item();
3271                         } else {
3272                                 preamble.suppressDate(false);
3273                                 if (context.new_layout_allowed &&
3274                                     (newlayout = findLayout(context.textclass,
3275                                                             t.cs(), true))) {
3276                                         // write the layout
3277                                         output_command_layout(os, p, outer,
3278                                                         context, newlayout);
3279                                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3280                                         if (!preamble.titleLayoutFound())
3281                                                 preamble.titleLayoutFound(newlayout->intitle);
3282                                         set<string> const & req = newlayout->requires();
3283                                         set<string>::const_iterator it = req.begin();
3284                                         set<string>::const_iterator en = req.end();
3285                                         for (; it != en; ++it)
3286                                                 preamble.registerAutomaticallyLoadedPackage(*it);
3287                                 } else
3288                                         output_ert_inset(os,
3289                                                 "\\date{" + p.verbatim_item() + '}',
3290                                                 context);
3291                         }
3292                         continue;
3293                 }
3294
3295                 // Before we look for the layout name with star and alone below, we check the layouts including
3296                 // the LateXParam, which might be one or several options or a star.
3297                 // The single '=' is meant here.
3298                 if (context.new_layout_allowed &&
3299                    (newlayout = findLayout(context.textclass, t.cs(), true, p.getCommandLatexParam()))) {
3300                         // store the latexparam here. This is eaten in output_command_layout
3301                         context.latexparam = newlayout->latexparam();
3302                         // write the layout
3303                         output_command_layout(os, p, outer, context, newlayout);
3304                         p.skip_spaces();
3305                         if (!preamble.titleLayoutFound())
3306                                 preamble.titleLayoutFound(newlayout->intitle);
3307                         set<string> const & req = newlayout->requires();
3308                         for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3309                                 preamble.registerAutomaticallyLoadedPackage(*it);
3310                         continue;
3311                 }
3312
3313
3314                 // Starred section headings
3315                 // Must attempt to parse "Section*" before "Section".
3316                 if ((p.next_token().asInput() == "*") &&
3317                          context.new_layout_allowed &&
3318                          (newlayout = findLayout(context.textclass, t.cs() + '*', true))) {
3319                         // write the layout
3320                         p.get_token();
3321                         output_command_layout(os, p, outer, context, newlayout);
3322                         p.skip_spaces();
3323                         if (!preamble.titleLayoutFound())
3324                                 preamble.titleLayoutFound(newlayout->intitle);
3325                         set<string> const & req = newlayout->requires();
3326                         for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3327                                 preamble.registerAutomaticallyLoadedPackage(*it);
3328                         continue;
3329                 }
3330
3331                 // Section headings and the like
3332                 if (context.new_layout_allowed &&
3333                          (newlayout = findLayout(context.textclass, t.cs(), true))) {
3334                         // write the layout
3335                         output_command_layout(os, p, outer, context, newlayout);
3336                         p.skip_spaces();
3337                         if (!preamble.titleLayoutFound())
3338                                 preamble.titleLayoutFound(newlayout->intitle);
3339                         set<string> const & req = newlayout->requires();
3340                         for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
3341                                 preamble.registerAutomaticallyLoadedPackage(*it);
3342                         continue;
3343                 }
3344
3345                 if (t.cs() == "subfloat") {
3346                         // the syntax is \subfloat[list entry][sub caption]{content}
3347                         // if it is a table of figure depends on the surrounding float
3348                         p.skip_spaces();
3349                         // do nothing if there is no outer float
3350                         if (!float_type.empty()) {
3351                                 context.check_layout(os);
3352                                 p.skip_spaces();
3353                                 begin_inset(os, "Float " + float_type + "\n");
3354                                 os << "wide false"
3355                                    << "\nsideways false"
3356                                    << "\nstatus collapsed\n\n";
3357                                 // test for caption
3358                                 string caption;
3359                                 bool has_caption = false;
3360                                 if (p.next_token().cat() != catEscape &&
3361                                                 p.next_token().character() == '[') {
3362                                                         p.get_token(); // eat '['
3363                                                         caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
3364                                                         has_caption = true;
3365                                 }
3366                                 // In case we have two optional args, the second is the caption.
3367                                 if (p.next_token().cat() != catEscape &&
3368                                                 p.next_token().character() == '[') {
3369                                                         p.get_token(); // eat '['
3370                                                         caption = parse_text_snippet(p, FLAG_BRACK_LAST, outer, context);
3371                                 }
3372                                 // the content
3373                                 parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3374                                 // the caption comes always as the last
3375                                 if (has_caption) {
3376                                         // we must make sure that the caption gets a \begin_layout
3377                                         os << "\n\\begin_layout Plain Layout";
3378                                         p.skip_spaces();
3379                                         begin_inset(os, "Caption Standard\n");
3380                                         Context newcontext(true, context.textclass,
3381                                                            0, 0, context.font);
3382                                         newcontext.check_layout(os);
3383                                         os << caption << "\n";
3384                                         newcontext.check_end_layout(os);
3385                                         end_inset(os);
3386                                         p.skip_spaces();
3387                                         // close the layout we opened
3388                                         os << "\n\\end_layout";
3389                                 }
3390                                 end_inset(os);
3391                                 p.skip_spaces();
3392                         } else {
3393                                 // if the float type is not supported or there is no surrounding float
3394                                 // output it as ERT
3395                                 string opt_arg1;
3396                                 string opt_arg2;
3397                                 if (p.hasOpt()) {
3398                                         opt_arg1 = convert_literate_command_inset_arg(p.getFullOpt());
3399                                         if (p.hasOpt())
3400                                                 opt_arg2 = convert_literate_command_inset_arg(p.getFullOpt());
3401                                 }
3402                                 output_ert_inset(os, t.asInput() + opt_arg1 + opt_arg2
3403                                                  + "{" + p.verbatim_item() + '}', context);
3404                         }
3405                         continue;
3406                 }
3407
3408                 if (t.cs() == "xymatrix") {
3409                         // we must open a new math because LyX's xy support is in math
3410                         context.check_layout(os);
3411                         begin_inset(os, "Formula ");
3412                         os << '$';
3413                         os << "\\" << t.cs() << '{';
3414                         parse_math(p, os, FLAG_ITEM, MATH_MODE);
3415                         os << '}' << '$';
3416                         end_inset(os);
3417                         preamble.registerAutomaticallyLoadedPackage("xy");
3418                         continue;
3419                 }
3420
3421                 if (t.cs() == "includegraphics") {
3422                         bool const clip = p.next_token().asInput() == "*";
3423                         if (clip)
3424                                 p.get_token();
3425                         string const arg = p.getArg('[', ']');
3426                         map<string, string> opts;
3427                         vector<string> keys;
3428                         split_map(arg, opts, keys);
3429                         if (clip)
3430                                 opts["clip"] = string();
3431                         string name = normalize_filename(p.verbatim_item());
3432
3433                         string const path = getMasterFilePath(true);
3434                         // We want to preserve relative / absolute filenames,
3435                         // therefore path is only used for testing
3436                         if (!makeAbsPath(name, path).exists()) {
3437                                 // The file extension is probably missing.
3438                                 // Now try to find it out.
3439                                 string const dvips_name =
3440                                         find_file(name, path,
3441                                                   known_dvips_graphics_formats);
3442                                 string const pdftex_name =
3443                                         find_file(name, path,
3444                                                   known_pdftex_graphics_formats);
3445                                 if (!dvips_name.empty()) {
3446                                         if (!pdftex_name.empty()) {
3447                                                 cerr << "This file contains the "
3448                                                         "latex snippet\n"
3449                                                         "\"\\includegraphics{"
3450                                                      << name << "}\".\n"
3451                                                         "However, files\n\""
3452                                                      << dvips_name << "\" and\n\""
3453                                                      << pdftex_name << "\"\n"
3454                                                         "both exist, so I had to make a "
3455                                                         "choice and took the first one.\n"
3456                                                         "Please move the unwanted one "
3457                                                         "someplace else and try again\n"
3458                                                         "if my choice was wrong."
3459                                                      << endl;
3460                                         }
3461                                         name = dvips_name;
3462                                 } else if (!pdftex_name.empty()) {
3463                                         name = pdftex_name;
3464                                         pdflatex = true;
3465                                 }
3466                         }
3467
3468                         FileName const absname = makeAbsPath(name, path);
3469                         if (absname.exists()) {
3470                                 fix_child_filename(name);
3471                                 copy_file(absname, name);
3472                         } else
3473                                 cerr << "Warning: Could not find graphics file '"
3474                                      << name << "'." << endl;
3475
3476                         context.check_layout(os);
3477                         begin_inset(os, "Graphics ");
3478                         os << "\n\tfilename " << name << '\n';
3479                         if (opts.find("width") != opts.end())
3480                                 os << "\twidth "
3481                                    << translate_len(opts["width"]) << '\n';
3482                         if (opts.find("height") != opts.end())
3483                                 os << "\theight "
3484                                    << translate_len(opts["height"]) << '\n';
3485                         if (opts.find("scale") != opts.end()) {
3486                                 istringstream iss(opts["scale"]);
3487                                 double val;
3488                                 iss >> val;
3489                                 val = val*100;
3490                                 os << "\tscale " << val << '\n';
3491                         }
3492                         if (opts.find("angle") != opts.end()) {
3493                                 os << "\trotateAngle "
3494                                    << opts["angle"] << '\n';
3495                                 vector<string>::const_iterator a =
3496                                         find(keys.begin(), keys.end(), "angle");
3497                                 vector<string>::const_iterator s =
3498                                         find(keys.begin(), keys.end(), "width");
3499                                 if (s == keys.end())
3500                                         s = find(keys.begin(), keys.end(), "height");
3501                                 if (s == keys.end())
3502                                         s = find(keys.begin(), keys.end(), "scale");
3503                                 if (s != keys.end() && distance(s, a) > 0)
3504                                         os << "\tscaleBeforeRotation\n";
3505                         }
3506                         if (opts.find("origin") != opts.end()) {
3507                                 ostringstream ss;
3508                                 string const opt = opts["origin"];
3509                                 if (opt.find('l') != string::npos) ss << "left";
3510                                 if (opt.find('r') != string::npos) ss << "right";
3511                                 if (opt.find('c') != string::npos) ss << "center";
3512                                 if (opt.find('t') != string::npos) ss << "Top";
3513                                 if (opt.find('b') != string::npos) ss << "Bottom";
3514                                 if (opt.find('B') != string::npos) ss << "Baseline";
3515                                 if (!ss.str().empty())
3516                                         os << "\trotateOrigin " << ss.str() << '\n';
3517                                 else
3518                                         cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
3519                         }
3520                         if (opts.find("keepaspectratio") != opts.end())
3521                                 os << "\tkeepAspectRatio\n";
3522                         if (opts.find("clip") != opts.end())
3523                                 os << "\tclip\n";
3524                         if (opts.find("draft") != opts.end())
3525                                 os << "\tdraft\n";
3526                         if (opts.find("bb") != opts.end())
3527                                 os << "\tBoundingBox "
3528                                    << opts["bb"] << '\n';
3529                         int numberOfbbOptions = 0;
3530                         if (opts.find("bbllx") != opts.end())
3531                                 numberOfbbOptions++;
3532                         if (opts.find("bblly") != opts.end())
3533                                 numberOfbbOptions++;
3534                         if (opts.find("bburx") != opts.end())
3535                                 numberOfbbOptions++;
3536                         if (opts.find("bbury") != opts.end())
3537                                 numberOfbbOptions++;
3538                         if (numberOfbbOptions == 4)
3539                                 os << "\tBoundingBox "
3540                                    << opts["bbllx"] << " " << opts["bblly"] << " "
3541                                    << opts["bburx"] << " " << opts["bbury"] << '\n';
3542                         else if (numberOfbbOptions > 0)
3543                                 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
3544                         numberOfbbOptions = 0;
3545                         if (opts.find("natwidth") != opts.end())
3546                                 numberOfbbOptions++;
3547                         if (opts.find("natheight") != opts.end())
3548                                 numberOfbbOptions++;
3549                         if (numberOfbbOptions == 2)
3550                                 os << "\tBoundingBox 0bp 0bp "
3551                                    << opts["natwidth"] << " " << opts["natheight"] << '\n';
3552                         else if (numberOfbbOptions > 0)
3553                                 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
3554                         ostringstream special;
3555                         if (opts.find("hiresbb") != opts.end())
3556                                 special << "hiresbb,";
3557                         if (opts.find("trim") != opts.end())
3558                                 special << "trim,";
3559                         if (opts.find("viewport") != opts.end())
3560                                 special << "viewport=" << opts["viewport"] << ',';
3561                         if (opts.find("totalheight") != opts.end())
3562                                 special << "totalheight=" << opts["totalheight"] << ',';
3563                         if (opts.find("type") != opts.end())
3564                                 special << "type=" << opts["type"] << ',';
3565                         if (opts.find("ext") != opts.end())
3566                                 special << "ext=" << opts["ext"] << ',';
3567                         if (opts.find("read") != opts.end())
3568                                 special << "read=" << opts["read"] << ',';
3569                         if (opts.find("command") != opts.end())
3570                                 special << "command=" << opts["command"] << ',';
3571                         string s_special = special.str();
3572                         if (!s_special.empty()) {
3573                                 // We had special arguments. Remove the trailing ','.
3574                                 os << "\tspecial " << s_special.substr(0, s_special.size() - 1) << '\n';
3575                         }
3576                         // TODO: Handle the unknown settings better.
3577                         // Warn about invalid options.
3578                         // Check whether some option was given twice.
3579                         end_inset(os);
3580                         preamble.registerAutomaticallyLoadedPackage("graphicx");
3581                         continue;
3582                 }
3583
3584                 if (t.cs() == "footnote" ||
3585                          (t.cs() == "thanks" && context.layout->intitle)) {
3586                         p.skip_spaces();
3587                         context.check_layout(os);
3588                         begin_inset(os, "Foot\n");
3589                         os << "status collapsed\n\n";
3590                         parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3591                         end_inset(os);
3592                         continue;
3593                 }
3594
3595                 if (t.cs() == "marginpar") {
3596                         p.skip_spaces();
3597                         context.check_layout(os);
3598                         begin_inset(os, "Marginal\n");
3599                         os << "status collapsed\n\n";
3600                         parse_text_in_inset(p, os, FLAG_ITEM, false, context);
3601                         end_inset(os);
3602                         continue;
3603                 }
3604
3605                 if (t.cs() == "lstinline" || t.cs() == "mintinline") {
3606                         bool const use_minted = t.cs() == "mintinline";
3607                         p.skip_spaces();
3608                         parse_listings(p, os, context, true, use_minted);
3609                         continue;
3610                 }
3611
3612                 if (t.cs() == "ensuremath") {
3613                         p.skip_spaces();
3614                         context.check_layout(os);
3615                         string const s = p.verbatim_item();
3616                         //FIXME: this never triggers in UTF8
3617                         if (s == "\xb1" || s == "\xb3" || s == "\xb2" || s == "\xb5")
3618                                 os << s;
3619                         else
3620                                 output_ert_inset(os, "\\ensuremath{" + s + "}",
3621                                            context);
3622                         continue;
3623                 }
3624
3625                 else if (t.cs() == "makeindex" || t.cs() == "maketitle") {
3626                         if (preamble.titleLayoutFound()) {
3627                                 // swallow this
3628                                 skip_spaces_braces(p);
3629                         } else
3630                                 output_ert_inset(os, t.asInput(), context);
3631                         continue;
3632                 }
3633
3634                 if (t.cs() == "tableofcontents"
3635                                 || t.cs() == "lstlistoflistings"
3636                                 || t.cs() == "listoflistings") {
3637                         string name = t.cs();
3638                         if (preamble.minted() && name == "listoflistings")
3639                                 name.insert(0, "lst");
3640                         context.check_layout(os);
3641                         begin_command_inset(os, "toc", name);
3642                         end_inset(os);
3643                         skip_spaces_braces(p);
3644                         if (name == "lstlistoflistings") {
3645                                 if (preamble.minted())
3646                                         preamble.registerAutomaticallyLoadedPackage("minted");
3647                                 else
3648                                         preamble.registerAutomaticallyLoadedPackage("listings");
3649                         }
3650                         continue;
3651                 }
3652
3653                 if (t.cs() == "listoffigures" || t.cs() == "listoftables") {
3654                         context.check_layout(os);
3655                         if (t.cs() == "listoffigures")
3656                                 begin_inset(os, "FloatList figure\n");
3657                         else
3658                                 begin_inset(os, "FloatList table\n");
3659                         end_inset(os);
3660                         skip_spaces_braces(p);
3661                         continue;
3662                 }
3663
3664                 if (t.cs() == "listof") {
3665                         p.skip_spaces(true);
3666                         string const name = p.get_token().cs();
3667                         if (context.textclass.floats().typeExist(name)) {
3668                                 context.check_layout(os);
3669                                 begin_inset(os, "FloatList ");
3670                                 os << name << "\n";
3671                                 end_inset(os);
3672                                 p.get_token(); // swallow second arg
3673                         } else
3674                                 output_ert_inset(os, "\\listof{" + name + "}", context);
3675                         continue;
3676                 }
3677
3678                 if ((where = is_known(t.cs(), known_text_font_families))) {
3679                         parse_text_attributes(p, os, FLAG_ITEM, outer,
3680                                 context, "\\family", context.font.family,
3681                                 known_coded_font_families[where - known_text_font_families]);
3682                         continue;
3683                 }
3684
3685                 // beamer has a \textbf<overlay>{} inset
3686                 if (!p.hasOpt("<") && (where = is_known(t.cs(), known_text_font_series))) {
3687                         parse_text_attributes(p, os, FLAG_ITEM, outer,
3688                                 context, "\\series", context.font.series,
3689                                 known_coded_font_series[where - known_text_font_series]);
3690                         continue;
3691                 }
3692
3693                 // beamer has a \textit<overlay>{} inset
3694                 if (!p.hasOpt("<") && (where = is_known(t.cs(), known_text_font_shapes))) {
3695                         parse_text_attributes(p, os, FLAG_ITEM, outer,
3696                                 context, "\\shape", context.font.shape,
3697                                 known_coded_font_shapes[where - known_text_font_shapes]);
3698                         continue;
3699                 }
3700
3701                 if (t.cs() == "textnormal" || t.cs() == "normalfont") {
3702                         context.check_layout(os);
3703                         TeXFont oldFont = context.font;
3704                         context.font.init();
3705                         context.font.size = oldFont.size;
3706                         os << "\n\\family " << context.font.family << "\n";
3707                         os << "\n\\series " << context.font.series << "\n";
3708                         os << "\n\\shape " << context.font.shape << "\n";
3709                         if (t.cs() == "textnormal") {
3710                                 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3711                                 output_font_change(os, context.font, oldFont);
3712                                 context.font = oldFont;
3713                         } else
3714                                 eat_whitespace(p, os, context, false);
3715                         continue;
3716                 }
3717
3718                 if (t.cs() == "textcolor") {
3719                         // scheme is \textcolor{color name}{text}
3720                         string const color = p.verbatim_item();
3721                         // we support the predefined colors of the color  and the xcolor package
3722                         if (color == "black" || color == "blue" || color == "cyan"
3723                                 || color == "green" || color == "magenta" || color == "red"
3724                                 || color == "white" || color == "yellow") {
3725                                         context.check_layout(os);
3726                                         os << "\n\\color " << color << "\n";
3727                                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3728                                         context.check_layout(os);
3729                                         os << "\n\\color inherit\n";
3730                                         preamble.registerAutomaticallyLoadedPackage("color");
3731                         } else if (color == "brown" || color == "darkgray" || color == "gray"
3732                                 || color == "lightgray" || color == "lime" || color == "olive"
3733                                 || color == "orange" || color == "pink" || color == "purple"
3734                                 || color == "teal" || color == "violet") {
3735                                         context.check_layout(os);
3736                                         os << "\n\\color " << color << "\n";
3737                                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3738                                         context.check_layout(os);
3739                                         os << "\n\\color inherit\n";
3740                                         preamble.registerAutomaticallyLoadedPackage("xcolor");
3741                         } else
3742                                 // for custom defined colors
3743                                 output_ert_inset(os, t.asInput() + "{" + color + "}", context);
3744                         continue;
3745                 }
3746
3747                 if (t.cs() == "underbar" || t.cs() == "uline") {
3748                         // \underbar is not 100% correct (LyX outputs \uline
3749                         // of ulem.sty). The difference is that \ulem allows
3750                         // line breaks, and \underbar does not.
3751                         // Do NOT handle \underline.
3752                         // \underbar cuts through y, g, q, p etc.,
3753                         // \underline does not.
3754                         context.check_layout(os);
3755                         os << "\n\\bar under\n";
3756                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3757                         context.check_layout(os);
3758                         os << "\n\\bar default\n";
3759                         preamble.registerAutomaticallyLoadedPackage("ulem");
3760                         continue;
3761                 }
3762
3763                 if (t.cs() == "sout") {
3764                         context.check_layout(os);
3765                         os << "\n\\strikeout on\n";
3766                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3767                         context.check_layout(os);
3768                         os << "\n\\strikeout default\n";
3769                         preamble.registerAutomaticallyLoadedPackage("ulem");
3770                         continue;
3771                 }
3772
3773                 // beamer has an \emph<overlay>{} inset
3774                 if ((t.cs() == "uuline" || t.cs() == "uwave"
3775                         || t.cs() == "emph" || t.cs() == "noun"
3776                         || t.cs() == "xout") && !p.hasOpt("<")) {
3777                         context.check_layout(os);
3778                         os << "\n\\" << t.cs() << " on\n";
3779                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3780                         context.check_layout(os);
3781                         os << "\n\\" << t.cs() << " default\n";
3782                         if (t.cs() == "uuline" || t.cs() == "uwave" || t.cs() == "xout")
3783                                 preamble.registerAutomaticallyLoadedPackage("ulem");
3784                         continue;
3785                 }
3786
3787                 if (t.cs() == "lyxadded" || t.cs() == "lyxdeleted") {
3788                         context.check_layout(os);
3789                         string name = p.getArg('{', '}');
3790                         string localtime = p.getArg('{', '}');
3791                         preamble.registerAuthor(name);
3792                         Author const & author = preamble.getAuthor(name);
3793                         // from_asctime_utc() will fail if LyX decides to output the
3794                         // time in the text language.
3795                         time_t ptime = from_asctime_utc(localtime);
3796                         if (ptime == static_cast<time_t>(-1)) {
3797                                 cerr << "Warning: Could not parse time `" << localtime
3798                                      << "´ for change tracking, using current time instead.\n";
3799                                 ptime = current_time();
3800                         }
3801                         if (t.cs() == "lyxadded")
3802                                 os << "\n\\change_inserted ";
3803                         else
3804                                 os << "\n\\change_deleted ";
3805                         os << author.bufferId() << ' ' << ptime << '\n';
3806                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
3807                         bool dvipost    = LaTeXPackages::isAvailable("dvipost");
3808                         bool xcolorulem = LaTeXPackages::isAvailable("ulem") &&
3809                                           LaTeXPackages::isAvailable("xcolor");
3810                         // No need to test for luatex, since luatex comes in
3811                         // two flavours (dvi and pdf), like latex, and those
3812                         // are detected by pdflatex.
3813                         if (pdflatex || xetex) {
3814                                 if (xcolorulem) {
3815                                         preamble.registerAutomaticallyLoadedPackage("ulem");
3816                                         preamble.registerAutomaticallyLoadedPackage("xcolor");
3817                                         preamble.registerAutomaticallyLoadedPackage("pdfcolmk");
3818                                 }
3819                         } else {
3820                                 if (dvipost) {
3821                                         preamble.registerAutomaticallyLoadedPackage("dvipost");
3822                                 } else if (xcolorulem) {
3823                                         preamble.registerAutomaticallyLoadedPackage("ulem");
3824                                         preamble.registerAutomaticallyLoadedPackage("xcolor");
3825                                 }
3826                         }
3827                         continue;
3828                 }
3829
3830                 if (t.cs() == "textipa") {
3831                         context.check_layout(os);
3832                         begin_inset(os, "IPA\n");
3833                         bool merging_hyphens_allowed = context.merging_hyphens_allowed;
3834                         context.merging_hyphens_allowed = false;
3835                         parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3836                         context.merging_hyphens_allowed = merging_hyphens_allowed;
3837                         end_inset(os);
3838                         preamble.registerAutomaticallyLoadedPackage("tipa");
3839                         preamble.registerAutomaticallyLoadedPackage("tipx");
3840                         continue;
3841                 }
3842
3843                 if ((preamble.isPackageUsed("tipa") && t.cs() == "t" && p.next_token().asInput() == "*")
3844                     || t.cs() == "texttoptiebar" || t.cs() == "textbottomtiebar") {
3845                         context.check_layout(os);
3846                         if (t.cs() == "t")
3847                                 // swallow star
3848                                 p.get_token();
3849                         string const type = (t.cs() == "t") ? "bottomtiebar" : t.cs().substr(4);
3850                         begin_inset(os, "IPADeco " + type + "\n");
3851                         os << "status open\n";
3852                         parse_text_in_inset(p, os, FLAG_ITEM, outer, context);
3853                         end_inset(os);
3854                         p.skip_spaces();
3855                         continue;
3856                 }
3857
3858                 if (t.cs() == "textvertline") {
3859                         // FIXME: This is not correct, \textvertline is higher than |
3860                         os << "|";
3861                         skip_braces(p);
3862                         continue;
3863                 }
3864
3865                 if (t.cs() == "tone" ) {
3866                         context.check_layout(os);
3867                         // register the tone package
3868                         preamble.registerAutomaticallyLoadedPackage("tone");
3869                         string content = trimSpaceAndEol(p.verbatim_item());
3870                         string command = t.asInput() + "{" + content + "}";
3871                         // some tones can be detected by unicodesymbols, some need special code
3872                         if (is_known(content, known_tones)) {
3873                                 os << "\\IPAChar " << command << "\n";
3874                                 continue;
3875                         }
3876                         // try to see whether the string is in unicodesymbols
3877                         bool termination;
3878                         docstring rem;
3879                         set<string> req;
3880                         docstring s = encodings.fromLaTeXCommand(from_utf8(command),
3881                                 Encodings::TEXT_CMD | Encodings::MATH_CMD,
3882                                 termination, rem, &req);
3883                         if (!s.empty()) {
3884                                 os << to_utf8(s);
3885                                 if (!rem.empty())
3886                                         output_ert_inset(os, to_utf8(rem), context);
3887                                 for (set<string>::const_iterator it = req.begin();
3888                                      it != req.end(); ++it)
3889                                         preamble.registerAutomaticallyLoadedPackage(*it);
3890                         } else
3891                                 // we did not find a non-ert version
3892                                 output_ert_inset(os, command, context);
3893                         continue;
3894                 }
3895
3896                 if (t.cs() == "phantom" || t.cs() == "hphantom" ||
3897                              t.cs() == "vphantom") {
3898                         context.check_layout(os);
3899                         if (t.cs() == "phantom")
3900                                 begin_inset(os, "Phantom Phantom\n");
3901                         if (t.cs() == "hphantom")
3902                                 begin_inset(os, "Phantom HPhantom\n");
3903                         if (t.cs() == "vphantom")
3904                                 begin_inset(os, "Phantom VPhantom\n");
3905                         os << "status open\n";
3906                         parse_text_in_inset(p, os, FLAG_ITEM, outer, context,
3907                                             "Phantom");
3908                         end_inset(os);
3909                         continue;
3910                 }
3911
3912                 if (t.cs() == "href") {
3913                         context.check_layout(os);
3914                         string target = convert_literate_command_inset_arg(p.verbatim_item());
3915                         string name = p.verbatim_item();
3916                         pair<bool, string> nm = convert_latexed_command_inset_arg(name);
3917                         bool const literal = !nm.first;
3918                         name = literal ? subst(name, "\n", " ") : nm.second;
3919                         string lit = literal ? "\"true\"" : "\"false\"";
3920                         string type;
3921                         size_t i = target.find(':');
3922                         if (i != string::npos) {
3923                                 type = target.substr(0, i + 1);
3924                                 if (type == "mailto:" || type == "file:")
3925                                         target = target.substr(i + 1);
3926                                 // handle the case that name is equal to target, except of "http(s)://"
3927                                 else if (target.substr(i + 3) == name && (type == "http:" || type == "https:"))
3928                                         target = name;
3929                         }
3930                         begin_command_inset(os, "href", "href");
3931                         if (name != target)
3932                                 os << "name \"" << name << "\"\n";
3933                         os << "target \"" << target << "\"\n";
3934                         if (type == "mailto:" || type == "file:")
3935                                 os << "type \"" << type << "\"\n";
3936                         os << "literal " << lit << "\n";
3937                         end_inset(os);
3938                         skip_spaces_braces(p);
3939                         continue;
3940                 }
3941
3942                 if (t.cs() == "lyxline") {
3943                         // swallow size argument (it is not used anyway)
3944                         p.getArg('{', '}');
3945                         if (!context.atParagraphStart()) {
3946                                 // so our line is in the middle of a paragraph
3947                                 // we need to add a new line, lest this line
3948                                 // follow the other content on that line and
3949                                 // run off the side of the page
3950                                 // FIXME: This may create an empty paragraph,
3951                                 //        but without that it would not be
3952                                 //        possible to set noindent below.
3953                                 //        Fortunately LaTeX does not care
3954                                 //        about the empty paragraph.
3955                                 context.new_paragraph(os);
3956                         }
3957                         if (preamble.indentParagraphs()) {
3958                                 // we need to unindent, lest the line be too long
3959                                 context.add_par_extra_stuff("\\noindent\n");
3960                         }
3961                         context.check_layout(os);
3962                         begin_command_inset(os, "line", "rule");
3963                         os << "offset \"0.5ex\"\n"
3964                               "width \"100line%\"\n"
3965                               "height \"1pt\"\n";
3966                         end_inset(os);
3967                         continue;
3968                 }
3969
3970                 if (t.cs() == "rule") {
3971                         string const offset = (p.hasOpt() ? p.getArg('[', ']') : string());
3972                         string const width = p.getArg('{', '}');
3973                         string const thickness = p.getArg('{', '}');
3974                         context.check_layout(os);
3975                         begin_command_inset(os, "line", "rule");
3976                         if (!offset.empty())
3977                                 os << "offset \"" << translate_len(offset) << "\"\n";
3978                         os << "width \"" << translate_len(width) << "\"\n"
3979                                   "height \"" << translate_len(thickness) << "\"\n";
3980                         end_inset(os);
3981                         continue;
3982                 }
3983
3984                 // handle refstyle first to catch \eqref which can also occur
3985                 // without refstyle. Only recognize these commands if
3986                 // refstyle.sty was found in the preamble (otherwise \eqref
3987                 // and user defined ref commands could be misdetected).
3988                 if ((where = is_known(t.cs(), known_refstyle_commands))
3989                      && preamble.refstyle()) {
3990                         context.check_layout(os);
3991                         begin_command_inset(os, "ref", "formatted");
3992                         os << "reference \"";
3993                         os << known_refstyle_prefixes[where - known_refstyle_commands]
3994                            << ":";
3995                         os << convert_literate_command_inset_arg(p.verbatim_item())
3996                            << "\"\n";
3997                         os << "plural \"false\"\n";
3998                         os << "caps \"false\"\n";
3999                         os << "noprefix \"false\"\n";
4000                         end_inset(os);
4001                         preamble.registerAutomaticallyLoadedPackage("refstyle");
4002                         continue;
4003                 }
4004
4005                 // if refstyle is used, we must not convert \prettyref to a
4006                 // formatted reference, since that would result in a refstyle command.
4007                 if ((where = is_known(t.cs(), known_ref_commands)) &&
4008                          (t.cs() != "prettyref" || !preamble.refstyle())) {
4009                         string const opt = p.getOpt();
4010                         if (opt.empty()) {
4011                                 context.check_layout(os);
4012                                 begin_command_inset(os, "ref",
4013                                         known_coded_ref_commands[where - known_ref_commands]);
4014                                 os << "reference \""
4015                                    << convert_literate_command_inset_arg(p.verbatim_item())
4016                                    << "\"\n";
4017                                 os << "plural \"false\"\n";
4018                                 os << "caps \"false\"\n";
4019                                 os << "noprefix \"false\"\n";
4020                                 end_inset(os);
4021                                 if (t.cs() == "vref" || t.cs() == "vpageref")
4022                                         preamble.registerAutomaticallyLoadedPackage("varioref");
4023                                 else if (t.cs() == "prettyref")
4024                                         preamble.registerAutomaticallyLoadedPackage("prettyref");
4025                         } else {
4026                                 // LyX does not yet support optional arguments of ref commands
4027                                 output_ert_inset(os, t.asInput() + '[' + opt + "]{" +
4028                                        p.verbatim_item() + '}', context);
4029                         }
4030                         continue;
4031                 }
4032
4033                 if (use_natbib &&
4034                          is_known(t.cs(), known_natbib_commands) &&
4035                          ((t.cs() != "citefullauthor" &&
4036                            t.cs() != "citeyear" &&
4037                            t.cs() != "citeyearpar") ||
4038                           p.next_token().asInput() != "*")) {
4039                         context.check_layout(os);
4040                         string command = t.cs();
4041                         if (p.next_token().asInput() == "*") {
4042                                 command += '*';
4043                                 p.get_token();
4044                         }
4045                         if (command == "citefullauthor")
4046                                 // alternative name for "\\citeauthor*"
4047                                 command = "citeauthor*";
4048
4049                         // text before the citation
4050                         string before;
4051                         // text after the citation
4052                         string after;
4053                         get_cite_arguments(p, true, before, after);
4054
4055                         if (command == "cite") {
4056                                 // \cite without optional argument means
4057                                 // \citet, \cite with at least one optional
4058                                 // argument means \citep.
4059                                 if (before.empty() && after.empty())
4060                                         command = "citet";
4061                                 else
4062                                         command = "citep";
4063                         }
4064                         if (before.empty() && after == "[]")
4065                                 // avoid \citet[]{a}
4066                                 after.erase();
4067                         else if (before == "[]" && after == "[]") {
4068                                 // avoid \citet[][]{a}
4069                                 before.erase();
4070                                 after.erase();
4071                         }
4072                         bool literal = false;
4073                         pair<bool, string> aft;
4074                         pair<bool, string> bef;
4075                         // remove the brackets around after and before
4076                         if (!after.empty()) {
4077                                 after.erase(0, 1);
4078                                 after.erase(after.length() - 1, 1);
4079                                 aft = convert_latexed_command_inset_arg(after);
4080                                 literal = !aft.first;
4081                                 after = literal ? subst(after, "\n", " ") : aft.second;
4082                         }
4083                         if (!before.empty()) {
4084                                 before.erase(0, 1);
4085                                 before.erase(before.length() - 1, 1);
4086                                 bef = convert_latexed_command_inset_arg(before);
4087                                 literal |= !bef.first;
4088                                 before = literal ? subst(before, "\n", " ") : bef.second;
4089                                 if (literal && !after.empty())
4090                                         after = subst(after, "\n", " ");
4091                         }
4092                         string lit = literal ? "\"true\"" : "\"false\"";
4093                         begin_command_inset(os, "citation", command);
4094                         os << "after " << '"' << after << '"' << "\n";
4095                         os << "before " << '"' << before << '"' << "\n";
4096                         os << "key \""
4097                            << convert_literate_command_inset_arg(p.verbatim_item())
4098                            << "\"\n"
4099                            << "literal " << lit << "\n";
4100                         end_inset(os);
4101                         // Need to set the cite engine if natbib is loaded by
4102                         // the document class directly
4103                         if (preamble.citeEngine() == "basic")
4104                                 preamble.citeEngine("natbib");
4105                         continue;
4106                 }
4107
4108                 if ((use_biblatex
4109                          && is_known(t.cs(), known_biblatex_commands)
4110                          && ((t.cs() == "cite"
4111                              || t.cs() == "citeauthor"
4112                              || t.cs() == "Citeauthor"
4113                              || t.cs() == "parencite"
4114                              || t.cs() == "citetitle")
4115                          || p.next_token().asInput() != "*"))
4116                         || (use_biblatex_natbib
4117                             && (is_known(t.cs(), known_biblatex_commands)
4118                               || is_known(t.cs(), known_natbib_commands))
4119                             && ((t.cs() == "cite" || t.cs() == "citet" || t.cs() == "Citet"
4120                                || t.cs() == "citep" || t.cs() == "Citep" || t.cs() == "citealt"
4121                                || t.cs() == "Citealt" || t.cs() == "citealp" || t.cs() == "Citealp"
4122                                || t.cs() == "citeauthor" || t.cs() == "Citeauthor"
4123                                || t.cs() == "parencite" || t.cs() == "citetitle")
4124                                || p.next_token().asInput() != "*"))){
4125                         context.check_layout(os);
4126                         string command = t.cs();
4127                         if (p.next_token().asInput() == "*") {
4128                                 command += '*';
4129                                 p.get_token();
4130                         }
4131
4132                         bool const qualified = suffixIs(command, "s");
4133                         if (qualified)
4134                                 command = rtrim(command, "s");
4135
4136                         // text before the citation
4137                         string before;
4138                         // text after the citation
4139                         string after;
4140                         get_cite_arguments(p, true, before, after, qualified);
4141
4142                         // These use natbib cmd names in LyX
4143                         // for inter-citeengine compativility
4144                         if (command == "citeyear")
4145                                 command = "citebyear";
4146                         else if (command == "cite*")
4147                                 command = "citeyear";
4148                         else if (command == "textcite")
4149                                 command = "citet";
4150                         else if (command == "Textcite")
4151                                 command = "Citet";
4152                         else if (command == "parencite")
4153                                 command = "citep";
4154                         else if (command == "Parencite")
4155                                 command = "Citep";
4156                         else if (command == "parencite*")
4157                                 command = "citeyearpar";
4158                         else if (command == "smartcite")
4159                                 command = "footcite";
4160                         else if (command == "Smartcite")
4161                                 command = "Footcite";
4162
4163                         string const emptyarg = qualified ? "()" : "[]";
4164                         if (before.empty() && after == emptyarg)
4165                                 // avoid \cite[]{a}
4166                                 after.erase();
4167                         else if (before == emptyarg && after == emptyarg) {
4168                                 // avoid \cite[][]{a}
4169                                 before.erase();
4170                                 after.erase();
4171                         }
4172                         bool literal = false;
4173                         pair<bool, string> aft;
4174                         pair<bool, string> bef;
4175                         // remove the brackets around after and before
4176                         if (!after.empty()) {
4177                                 after.erase(0, 1);
4178                                 after.erase(after.length() - 1, 1);
4179                                 aft = convert_latexed_command_inset_arg(after);
4180                                 literal = !aft.first;
4181                                 after = literal ? subst(after, "\n", " ") : aft.second;
4182                         }
4183                         if (!before.empty()) {
4184                                 before.erase(0, 1);
4185                                 before.erase(before.length() - 1, 1);
4186                                 bef = convert_latexed_command_inset_arg(before);
4187                                 literal |= !bef.first;
4188                                 before = literal ? subst(before, "\n", " ") : bef.second;
4189                         }
4190                         string keys, pretextlist, posttextlist;
4191                         if (qualified) {
4192                                 map<string, string> pres, posts, preslit, postslit;
4193                                 vector<string> lkeys;
4194                                 // text before the citation
4195                                 string lbefore, lbeforelit;
4196                                 // text after the citation
4197                                 string lafter, lafterlit;
4198                                 string lkey;
4199                                 pair<bool, string> laft, lbef;
4200                                 while (true) {
4201                                         get_cite_arguments(p, true, lbefore, lafter);
4202                                         // remove the brackets around after and before
4203                                         if (!lafter.empty()) {
4204                                                 lafter.erase(0, 1);
4205                                                 lafter.erase(lafter.length() - 1, 1);
4206                                                 laft = convert_latexed_command_inset_arg(lafter);
4207                                                 literal |= !laft.first;
4208                                                 lafter = laft.second;
4209                                                 lafterlit = subst(lbefore, "\n", " ");
4210                                         }
4211                                         if (!lbefore.empty()) {
4212                                                 lbefore.erase(0, 1);
4213                                                 lbefore.erase(lbefore.length() - 1, 1);
4214                                                 lbef = convert_latexed_command_inset_arg(lbefore);
4215                                                 literal |= !lbef.first;
4216                                                 lbefore = lbef.second;
4217                                                 lbeforelit = subst(lbefore, "\n", " ");
4218                                         }
4219                                         if (lbefore.empty() && lafter == "[]") {
4220                                                 // avoid \cite[]{a}
4221                                                 lafter.erase();
4222                                                 lafterlit.erase();
4223                                         }
4224                                         else if (lbefore == "[]" && lafter == "[]") {
4225                                                 // avoid \cite[][]{a}
4226                                                 lbefore.erase();
4227                                                 lafter.erase();
4228                                                 lbeforelit.erase();
4229                                                 lafterlit.erase();
4230                                         }
4231                                         lkey = p.getArg('{', '}');
4232                                         if (lkey.empty())
4233                                                 break;
4234                                         if (!lbefore.empty()) {
4235                                                 pres.insert(make_pair(lkey, lbefore));
4236                                                 preslit.insert(make_pair(lkey, lbeforelit));
4237                                         }
4238                                         if (!lafter.empty()) {
4239                                                 posts.insert(make_pair(lkey, lafter));
4240                                                 postslit.insert(make_pair(lkey, lafterlit));
4241                                         }
4242                                         lkeys.push_back(lkey);
4243                                 }
4244                                 keys = convert_literate_command_inset_arg(getStringFromVector(lkeys));
4245                                 if (literal) {
4246                                         pres = preslit;
4247                                         posts = postslit;
4248                                 }
4249                                 for (auto const & ptl : pres) {
4250                                         if (!pretextlist.empty())
4251                                                 pretextlist += '\t';
4252                                         pretextlist += ptl.first + " " + ptl.second;
4253                                 }
4254                                 for (auto const & potl : posts) {
4255                                         if (!posttextlist.empty())
4256                                                 posttextlist += '\t';
4257                                         posttextlist += potl.first + " " + potl.second;
4258                                 }
4259                         } else
4260                                 keys = convert_literate_command_inset_arg(p.verbatim_item());
4261                         if (literal) {
4262                                 if (!after.empty())
4263                                         after = subst(after, "\n", " ");
4264                                 if (!before.empty())
4265                                         before = subst(after, "\n", " ");
4266                         }
4267                         string lit = literal ? "\"true\"" : "\"false\"";
4268                         begin_command_inset(os, "citation", command);
4269                         os << "after " << '"' << after << '"' << "\n";
4270                         os << "before " << '"' << before << '"' << "\n";
4271                         os << "key \""
4272                            << keys
4273                            << "\"\n";
4274                         if (!pretextlist.empty())
4275                                 os << "pretextlist " << '"'  << pretextlist << '"' << "\n";
4276                         if (!posttextlist.empty())
4277                                 os << "posttextlist " << '"'  << posttextlist << '"' << "\n";
4278                         os << "literal " << lit << "\n";
4279                         end_inset(os);
4280                         // Need to set the cite engine if biblatex is loaded by
4281                         // the document class directly
4282                         if (preamble.citeEngine() == "basic")
4283                                 use_biblatex_natbib ?
4284                                           preamble.citeEngine("biblatex-natbib")
4285                                         : preamble.citeEngine("biblatex");
4286                         continue;
4287                 }
4288
4289                 if (use_jurabib &&
4290                          is_known(t.cs(), known_jurabib_commands) &&
4291                          (t.cs() == "cite" || p.next_token().asInput() != "*")) {
4292                         context.check_layout(os);
4293                         string command = t.cs();
4294                         if (p.next_token().asInput() == "*") {
4295                                 command += '*';
4296                                 p.get_token();
4297                         }
4298                         char argumentOrder = '\0';
4299                         vector<string> const options =
4300                                 preamble.getPackageOptions("jurabib");
4301                         if (find(options.begin(), options.end(),
4302                                       "natbiborder") != options.end())
4303                                 argumentOrder = 'n';
4304                         else if (find(options.begin(), options.end(),
4305                                            "jurabiborder") != options.end())
4306                                 argumentOrder = 'j';
4307
4308                         // text before the citation
4309                         string before;
4310                         // text after the citation
4311                         string after;
4312                         get_cite_arguments(p, argumentOrder != 'j', before, after);
4313
4314                         string const citation = p.verbatim_item();
4315                         if (!before.empty() && argumentOrder == '\0') {
4316                                 cerr << "Warning: Assuming argument order "
4317                                         "of jurabib version 0.6 for\n'"
4318                                      << command << before << after << '{'
4319                                      << citation << "}'.\n"
4320                                         "Add 'jurabiborder' to the jurabib "
4321                                         "package options if you used an\n"
4322                                         "earlier jurabib version." << endl;
4323                         }
4324                         bool literal = false;
4325                         pair<bool, string> aft;
4326                         pair<bool, string> bef;
4327                         // remove the brackets around after and before
4328                         if (!after.empty()) {
4329                                 after.erase(0, 1);
4330                                 after.erase(after.length() - 1, 1);
4331                                 aft = convert_latexed_command_inset_arg(after);
4332                                 literal = !aft.first;
4333                                 after = literal ? subst(after, "\n", " ") : aft.second;
4334                         }
4335                         if (!before.empty()) {
4336                                 before.erase(0, 1);
4337                                 before.erase(before.length() - 1, 1);
4338                                 bef = convert_latexed_command_inset_arg(before);
4339                                 literal |= !bef.first;
4340                                 before = literal ? subst(before, "\n", " ") : bef.second;
4341                                 if (literal && !after.empty())
4342                                         after = subst(after, "\n", " ");
4343                         }
4344                         string lit = literal ? "\"true\"" : "\"false\"";
4345                         begin_command_inset(os, "citation", command);
4346                         os << "after " << '"' << after << "\"\n"
4347                            << "before " << '"' << before << "\"\n"
4348                            << "key " << '"' << citation << "\"\n"
4349                            << "literal " << lit << "\n";
4350                         end_inset(os);
4351                         // Need to set the cite engine if jurabib is loaded by
4352                         // the document class directly
4353                         if (preamble.citeEngine() == "basic")
4354                                 preamble.citeEngine("jurabib");
4355                         continue;
4356                 }
4357
4358                 if (t.cs() == "cite"
4359                         || t.cs() == "nocite") {
4360                         context.check_layout(os);
4361                         string after = p.getArg('[', ']');
4362                         pair<bool, string> aft = convert_latexed_command_inset_arg(after);
4363                         bool const literal = !aft.first;
4364                         after = literal ? subst(after, "\n", " ") : aft.second;
4365                         string lit = literal ? "\"true\"" : "\"false\"";
4366                         string key = convert_literate_command_inset_arg(p.verbatim_item());
4367                         // store the case that it is "\nocite{*}" to use it later for
4368                         // the BibTeX inset
4369                         if (key != "*") {
4370                                 begin_command_inset(os, "citation", t.cs());
4371                                 os << "after " << '"' << after << "\"\n"
4372                                    << "key " << '"' << key << "\"\n"
4373                                    << "literal " << lit << "\n";
4374                                 end_inset(os);
4375                         } else if (t.cs() == "nocite")
4376                                 btprint = key;
4377                         continue;
4378                 }
4379
4380                 if (t.cs() == "index" ||
4381                     (t.cs() == "sindex" && preamble.use_indices() == "true")) {
4382                         context.check_layout(os);
4383                         string const arg = (t.cs() == "sindex" && p.hasOpt()) ?
4384                                 p.getArg('[', ']') : "";
4385                         string const kind = arg.empty() ? "idx" : arg;
4386                         begin_inset(os, "Index ");
4387                         os << kind << "\nstatus collapsed\n";
4388                         parse_text_in_inset(p, os, FLAG_ITEM, false, context, "Index");
4389                         end_inset(os);
4390                         if (kind != "idx")
4391                                 preamble.registerAutomaticallyLoadedPackage("splitidx");
4392                         continue;
4393                 }
4394
4395                 if (t.cs() == "nomenclature") {
4396                         context.check_layout(os);
4397                         begin_command_inset(os, "nomenclature", "nomenclature");
4398                         string prefix = convert_literate_command_inset_arg(p.getArg('[', ']'));
4399                         if (!prefix.empty())
4400                                 os << "prefix " << '"' << prefix << '"' << "\n";
4401                         string symbol = p.verbatim_item();
4402                         pair<bool, string> sym = convert_latexed_command_inset_arg(symbol);
4403                         bool literal = !sym.first;
4404                         string description = p.verbatim_item();
4405                         pair<bool, string> desc = convert_latexed_command_inset_arg(description);
4406                         literal |= !desc.first;
4407                         if (literal) {
4408                                 symbol = subst(symbol, "\n", " ");
4409                                 description = subst(description, "\n", " ");
4410                         } else {
4411                                 symbol = sym.second;
4412                                 description = desc.second;
4413                         }
4414                         string lit = literal ? "\"true\"" : "\"false\"";
4415                         os << "symbol " << '"' << symbol;
4416                         os << "\"\ndescription \""
4417                            << description << "\"\n"
4418                            << "literal " << lit << "\n";
4419                         end_inset(os);
4420                         preamble.registerAutomaticallyLoadedPackage("nomencl");
4421                         continue;
4422                 }
4423
4424                 if (t.cs() == "label") {
4425                         context.check_layout(os);
4426                         begin_command_inset(os, "label", "label");
4427                         os << "name \""
4428                            << convert_literate_command_inset_arg(p.verbatim_item())
4429                            << "\"\n";
4430                         end_inset(os);
4431                         continue;
4432                 }
4433
4434                 if (t.cs() == "lyxmintcaption") {
4435                         string const pos = p.getArg('[', ']');
4436                         if (pos == "t") {
4437                                 string const caption =
4438                                         parse_text_snippet(p, FLAG_ITEM, false,
4439                                                            context);
4440                                 minted_nonfloat_caption = "[t]" + caption;
4441                         } else {
4442                                 // We already got the caption at the bottom,
4443                                 // so simply skip it.
4444                                 parse_text_snippet(p, FLAG_ITEM, false, context);
4445                         }
4446                         continue;
4447                 }
4448
4449                 if (t.cs() == "printindex" || t.cs() == "printsubindex") {
4450                         context.check_layout(os);
4451                         string commandname = t.cs();
4452                         bool star = false;
4453                         if (p.next_token().asInput() == "*") {
4454                                 commandname += "*";
4455                                 star = true;
4456                                 p.get_token();
4457                         }
4458                         begin_command_inset(os, "index_print", commandname);
4459                         string const indexname = p.getArg('[', ']');
4460                         if (!star) {
4461                                 if (indexname.empty())
4462                                         os << "type \"idx\"\n";
4463                                 else
4464                                         os << "type \"" << indexname << "\"\n";
4465                                 os << "literal \"true\"\n";
4466                         }
4467                         end_inset(os);
4468                         skip_spaces_braces(p);
4469                         preamble.registerAutomaticallyLoadedPackage("makeidx");
4470                         if (preamble.use_indices() == "true")
4471                                 preamble.registerAutomaticallyLoadedPackage("splitidx");
4472                         continue;
4473                 }
4474
4475                 if (t.cs() == "printnomenclature") {
4476                         string width = "";
4477                         string width_type = "";
4478                         context.check_layout(os);
4479                         begin_command_inset(os, "nomencl_print", "printnomenclature");
4480                         // case of a custom width
4481                         if (p.hasOpt()) {
4482                                 width = p.getArg('[', ']');
4483                                 width = translate_len(width);
4484                                 width_type = "custom";
4485                         }
4486                         // case of no custom width
4487                         // the case of no custom width but the width set
4488                         // via \settowidth{\nomlabelwidth}{***} cannot be supported
4489                         // because the user could have set anything, not only the width
4490                         // of the longest label (which would be width_type = "auto")
4491                         string label = convert_literate_command_inset_arg(p.getArg('{', '}'));
4492                         if (label.empty() && width_type.empty())
4493                                 width_type = "none";
4494                         os << "set_width \"" << width_type << "\"\n";
4495                         if (width_type == "custom")
4496                                 os << "width \"" << width << '\"';
4497                         end_inset(os);
4498                         skip_spaces_braces(p);
4499                         preamble.registerAutomaticallyLoadedPackage("nomencl");
4500                         continue;
4501                 }
4502
4503                 if ((t.cs() == "textsuperscript" || t.cs() == "textsubscript")) {
4504                         context.check_layout(os);
4505                         begin_inset(os, "script ");
4506                         os << t.cs().substr(4) << '\n';
4507                         newinsetlayout = findInsetLayout(context.textclass, t.cs(), true);
4508                         parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
4509                         end_inset(os);
4510                         if (t.cs() == "textsubscript")
4511                                 preamble.registerAutomaticallyLoadedPackage("subscript");
4512                         continue;
4513                 }
4514
4515                 if ((where = is_known(t.cs(), known_quotes))) {
4516                         context.check_layout(os);
4517                         begin_inset(os, "Quotes ");
4518                         string quotetype = known_coded_quotes[where - known_quotes];
4519                         // try to make a smart guess about the side
4520                         Token const prev = p.prev_token();
4521                         bool const opening = (prev.cat() != catSpace && prev.character() != 0
4522                                         && prev.character() != '\n' && prev.character() != '~');
4523                         quotetype = guessQuoteStyle(quotetype, opening);
4524                         os << quotetype;
4525                         end_inset(os);
4526                         // LyX adds {} after the quote, so we have to eat
4527                         // spaces here if there are any before a possible
4528                         // {} pair.
4529                         eat_whitespace(p, os, context, false);
4530                         skip_braces(p);
4531                         continue;
4532                 }
4533
4534                 if ((where = is_known(t.cs(), known_sizes)) &&
4535                         context.new_layout_allowed) {
4536                         context.check_layout(os);
4537                         TeXFont const oldFont = context.font;
4538                         context.font.size = known_coded_sizes[where - known_sizes];
4539                         output_font_change(os, oldFont, context.font);
4540                         eat_whitespace(p, os, context, false);
4541                         continue;
4542                 }
4543
4544                 if ((where = is_known(t.cs(), known_font_families)) &&
4545                          context.new_layout_allowed) {
4546                         context.check_layout(os);
4547                         TeXFont const oldFont = context.font;
4548                         context.font.family =
4549                                 known_coded_font_families[where - known_font_families];
4550                         output_font_change(os, oldFont, context.font);
4551                         eat_whitespace(p, os, context, false);
4552                         continue;
4553                 }
4554
4555                 if ((where = is_known(t.cs(), known_font_series)) &&
4556                          context.new_layout_allowed) {
4557                         context.check_layout(os);
4558                         TeXFont const oldFont = context.font;
4559                         context.font.series =
4560                                 known_coded_font_series[where - known_font_series];
4561                         output_font_change(os, oldFont, context.font);
4562                         eat_whitespace(p, os, context, false);
4563                         continue;
4564                 }
4565
4566                 if ((where = is_known(t.cs(), known_font_shapes)) &&
4567                          context.new_layout_allowed) {
4568                         context.check_layout(os);
4569                         TeXFont const oldFont = context.font;
4570                         context.font.shape =
4571                                 known_coded_font_shapes[where - known_font_shapes];
4572                         output_font_change(os, oldFont, context.font);
4573                         eat_whitespace(p, os, context, false);
4574                         continue;
4575                 }
4576                 if ((where = is_known(t.cs(), known_old_font_families)) &&
4577                          context.new_layout_allowed) {
4578                         context.check_layout(os);
4579                         TeXFont const oldFont = context.font;
4580                         context.font.init();
4581                         context.font.size = oldFont.size;
4582                         context.font.family =
4583                                 known_coded_font_families[where - known_old_font_families];
4584                         output_font_change(os, oldFont, context.font);
4585                         eat_whitespace(p, os, context, false);
4586                         continue;
4587                 }
4588
4589                 if ((where = is_known(t.cs(), known_old_font_series)) &&
4590                          context.new_layout_allowed) {
4591                         context.check_layout(os);
4592                         TeXFont const oldFont = context.font;
4593                         context.font.init();
4594                         context.font.size = oldFont.size;
4595                         context.font.series =
4596                                 known_coded_font_series[where - known_old_font_series];
4597                         output_font_change(os, oldFont, context.font);
4598                         eat_whitespace(p, os, context, false);
4599                         continue;
4600                 }
4601
4602                 if ((where = is_known(t.cs(), known_old_font_shapes)) &&
4603                          context.new_layout_allowed) {
4604                         context.check_layout(os);
4605                         TeXFont const oldFont = context.font;
4606                         context.font.init();
4607                         context.font.size = oldFont.size;
4608                         context.font.shape =
4609                                 known_coded_font_shapes[where - known_old_font_shapes];
4610                         output_font_change(os, oldFont, context.font);
4611                         eat_whitespace(p, os, context, false);
4612                         continue;
4613                 }
4614
4615                 if (t.cs() == "selectlanguage") {
4616                         context.check_layout(os);
4617                         // save the language for the case that a
4618                         // \foreignlanguage is used
4619                         context.font.language = babel2lyx(p.verbatim_item());
4620                         os << "\n\\lang " << context.font.language << "\n";
4621                         continue;
4622                 }
4623
4624                 if (t.cs() == "foreignlanguage") {
4625                         string const lang = babel2lyx(p.verbatim_item());
4626                         parse_text_attributes(p, os, FLAG_ITEM, outer,
4627                                               context, "\\lang",
4628                                               context.font.language, lang);
4629                         continue;
4630                 }
4631
4632                 if (prefixIs(t.cs(), "text") && preamble.usePolyglossia()
4633                          && is_known(t.cs().substr(4), preamble.polyglossia_languages)) {
4634                         // scheme is \textLANGUAGE{text} where LANGUAGE is in polyglossia_languages[]
4635                         string lang;
4636                         // We have to output the whole command if it has an option
4637                         // because LyX doesn't support this yet, see bug #8214,
4638                         // only if there is a single option specifying a variant, we can handle it.
4639                         if (p.hasOpt()) {
4640                                 string langopts = p.getOpt();
4641                                 // check if the option contains a variant, if yes, extract it
4642                                 string::size_type pos_var = langopts.find("variant");
4643                                 string::size_type i = langopts.find(',');
4644                                 string::size_type k = langopts.find('=', pos_var);
4645                                 if (pos_var != string::npos && i == string::npos) {
4646                                         string variant;
4647                                         variant = langopts.substr(k + 1, langopts.length() - k - 2);
4648                                         lang = preamble.polyglossia2lyx(variant);
4649                                         parse_text_attributes(p, os, FLAG_ITEM, outer,
4650                                                                   context, "\\lang",
4651                                                                   context.font.language, lang);
4652                                 } else
4653                                         output_ert_inset(os, t.asInput() + langopts, context);
4654                         } else {
4655                                 lang = preamble.polyglossia2lyx(t.cs().substr(4, string::npos));
4656                                 parse_text_attributes(p, os, FLAG_ITEM, outer,
4657                                                           context, "\\lang",
4658                                                           context.font.language, lang);
4659                         }
4660                         continue;
4661                 }
4662
4663                 if (t.cs() == "inputencoding") {
4664                         // nothing to write here
4665                         string const enc = subst(p.verbatim_item(), "\n", " ");
4666                         p.setEncoding(enc, Encoding::inputenc);
4667                         continue;
4668                 }
4669
4670                 if (is_known(t.cs(), known_special_chars) ||
4671                     (t.cs() == "protect" &&
4672                      p.next_token().cat() == catEscape &&
4673                      is_known(p.next_token().cs(), known_special_protect_chars))) {
4674                         // LyX sometimes puts a \protect in front, so we have to ignore it
4675                         where = is_known(
4676                                 t.cs() == "protect" ? p.get_token().cs() : t.cs(),
4677                                 known_special_chars);
4678                         context.check_layout(os);
4679                         os << known_coded_special_chars[where - known_special_chars];
4680                         skip_spaces_braces(p);
4681                         continue;
4682                 }
4683
4684                 if ((t.cs() == "nobreakdash" && p.next_token().asInput() == "-") ||
4685                          (t.cs() == "protect" && p.next_token().asInput() == "\\nobreakdash" &&
4686                           p.next_next_token().asInput() == "-") ||
4687                          (t.cs() == "@" && p.next_token().asInput() == ".")) {
4688                         // LyX sometimes puts a \protect in front, so we have to ignore it
4689                         if (t.cs() == "protect")
4690                                 p.get_token();
4691                         context.check_layout(os);
4692                         if (t.cs() == "nobreakdash")
4693                                 os << "\\SpecialChar nobreakdash\n";
4694                         else
4695                                 os << "\\SpecialChar endofsentence\n";
4696                         p.get_token();
4697                         continue;
4698                 }
4699
4700                 if (t.cs() == "_" || t.cs() == "&" || t.cs() == "#"
4701                             || t.cs() == "$" || t.cs() == "{" || t.cs() == "}"
4702                             || t.cs() == "%" || t.cs() == "-") {
4703                         context.check_layout(os);
4704                         if (t.cs() == "-")
4705                                 os << "\\SpecialChar softhyphen\n";
4706                         else
4707                                 os << t.cs();
4708                         continue;
4709                 }
4710
4711                 if (t.cs() == "char") {
4712                         context.check_layout(os);
4713                         if (p.next_token().character() == '`') {
4714                                 p.get_token();
4715                                 if (p.next_token().cs() == "\"") {
4716                                         p.get_token();
4717                                         os << '"';
4718                                         skip_braces(p);
4719                                 } else {
4720                                         output_ert_inset(os, "\\char`", context);
4721                                 }
4722                         } else {
4723                                 output_ert_inset(os, "\\char", context);
4724                         }
4725                         continue;
4726                 }
4727
4728                 if (t.cs() == "verb") {
4729                         context.check_layout(os);
4730                         // set catcodes to verbatim early, just in case.
4731                         p.setCatcodes(VERBATIM_CATCODES);
4732                         string delim = p.get_token().asInput();
4733                         Parser::Arg arg = p.verbatimStuff(delim);
4734                         if (arg.first)
4735                                 output_ert_inset(os, "\\verb" + delim
4736                                                  + arg.second + delim, context);
4737                         else
4738                                 cerr << "invalid \\verb command. Skipping" << endl;
4739                         continue;
4740                 }
4741
4742                 // Problem: \= creates a tabstop inside the tabbing environment
4743                 // and else an accent. In the latter case we really would want
4744                 // \={o} instead of \= o.
4745                 if (t.cs() == "=" && (flags & FLAG_TABBING)) {
4746                         output_ert_inset(os, t.asInput(), context);
4747                         continue;
4748                 }
4749
4750                 if (t.cs() == "\\") {
4751                         context.check_layout(os);
4752                         if (p.hasOpt())
4753                                 output_ert_inset(os, "\\\\" + p.getOpt(), context);
4754                         else if (p.next_token().asInput() == "*") {
4755                                 p.get_token();
4756                                 // getOpt() eats the following space if there
4757                                 // is no optional argument, but that is OK
4758                                 // here since it has no effect in the output.
4759                                 output_ert_inset(os, "\\\\*" + p.getOpt(), context);
4760                         }
4761                         else {
4762                                 begin_inset(os, "Newline newline");
4763                                 end_inset(os);
4764                         }
4765                         continue;
4766                 }
4767
4768                 if (t.cs() == "newline" ||
4769                     (t.cs() == "linebreak" && !p.hasOpt())) {
4770                         context.check_layout(os);
4771                         begin_inset(os, "Newline ");
4772                         os << t.cs();
4773                         end_inset(os);
4774                         skip_spaces_braces(p);
4775                         continue;
4776                 }
4777
4778                 if (t.cs() == "input" || t.cs() == "include"
4779                     || t.cs() == "verbatiminput"
4780                     || t.cs() == "lstinputlisting") {
4781                         string name = t.cs();
4782                         if (name == "verbatiminput"
4783                             && p.next_token().asInput() == "*")
4784                                 name += p.get_token().asInput();
4785                         context.check_layout(os);
4786                         string lstparams;
4787                         bool literal = false;
4788                         if (name == "lstinputlisting" && p.hasOpt()) {
4789                                 lstparams = p.getArg('[', ']');
4790                                 pair<bool, string> oa = convert_latexed_command_inset_arg(lstparams);
4791                                 literal = !oa.first;
4792                                 if (literal)
4793                                         lstparams = subst(lstparams, "\n", " ");
4794                         }
4795                         string lit = literal ? "\"true\"" : "\"false\"";
4796                         string filename(normalize_filename(p.getArg('{', '}')));
4797                         string const path = getMasterFilePath(true);
4798                         // We want to preserve relative / absolute filenames,
4799                         // therefore path is only used for testing
4800                         if ((t.cs() == "include" || t.cs() == "input") &&
4801                             !makeAbsPath(filename, path).exists()) {
4802                                 // The file extension is probably missing.
4803                                 // Now try to find it out.
4804                                 string const tex_name =
4805                                         find_file(filename, path,
4806                                                   known_tex_extensions);
4807                                 if (!tex_name.empty())
4808                                         filename = tex_name;
4809                         }
4810                         bool external = false;
4811                         string outname;
4812                         if (makeAbsPath(filename, path).exists()) {
4813                                 string const abstexname =
4814                                         makeAbsPath(filename, path).absFileName();
4815                                 string const absfigname =
4816                                         changeExtension(abstexname, ".fig");
4817                                 fix_child_filename(filename);
4818                                 string const lyxname = changeExtension(filename,
4819                                         roundtripMode() ? ".lyx.lyx" : ".lyx");
4820                                 string const abslyxname = makeAbsPath(
4821                                         lyxname, getParentFilePath(false)).absFileName();
4822                                 bool xfig = false;
4823                                 if (!skipChildren())
4824                                         external = FileName(absfigname).exists();
4825                                 if (t.cs() == "input" && !skipChildren()) {
4826                                         string const ext = getExtension(abstexname);
4827
4828                                         // Combined PS/LaTeX:
4829                                         // x.eps, x.pstex_t (old xfig)
4830                                         // x.pstex, x.pstex_t (new xfig, e.g. 3.2.5)
4831                                         FileName const absepsname(
4832                                                 changeExtension(abstexname, ".eps"));
4833                                         FileName const abspstexname(
4834                                                 changeExtension(abstexname, ".pstex"));
4835                                         bool const xfigeps =
4836                                                 (absepsname.exists() ||
4837                                                  abspstexname.exists()) &&
4838                                                 ext == "pstex_t";
4839
4840                                         // Combined PDF/LaTeX:
4841                                         // x.pdf, x.pdftex_t (old xfig)
4842                                         // x.pdf, x.pdf_t (new xfig, e.g. 3.2.5)
4843                                         FileName const abspdfname(
4844                                                 changeExtension(abstexname, ".pdf"));
4845                                         bool const xfigpdf =
4846                                                 abspdfname.exists() &&
4847                                                 (ext == "pdftex_t" || ext == "pdf_t");
4848                                         if (xfigpdf)
4849                                                 pdflatex = true;
4850
4851                                         // Combined PS/PDF/LaTeX:
4852                                         // x_pspdftex.eps, x_pspdftex.pdf, x.pspdftex
4853                                         string const absbase2(
4854                                                 removeExtension(abstexname) + "_pspdftex");
4855                                         FileName const abseps2name(
4856                                                 addExtension(absbase2, ".eps"));
4857                                         FileName const abspdf2name(
4858                                                 addExtension(absbase2, ".pdf"));
4859                                         bool const xfigboth =
4860                                                 abspdf2name.exists() &&
4861                                                 abseps2name.exists() && ext == "pspdftex";
4862
4863                                         xfig = xfigpdf || xfigeps || xfigboth;
4864                                         external = external && xfig;
4865                                 }
4866                                 if (external) {
4867                                         outname = changeExtension(filename, ".fig");
4868                                         FileName abssrc(changeExtension(abstexname, ".fig"));
4869                                         copy_file(abssrc, outname);
4870                                 } else if (xfig) {
4871                                         // Don't try to convert, the result
4872                                         // would be full of ERT.
4873                                         outname = filename;
4874                                         FileName abssrc(abstexname);
4875                                         copy_file(abssrc, outname);
4876                                 } else if (t.cs() != "verbatiminput" &&
4877                                            !skipChildren() &&
4878                                     tex2lyx(abstexname, FileName(abslyxname),
4879                                             p.getEncoding())) {
4880                                         outname = lyxname;
4881                                         // no need to call copy_file
4882                                         // tex2lyx creates the file
4883                                 } else {
4884                                         outname = filename;
4885                                         FileName abssrc(abstexname);
4886                                         copy_file(abssrc, outname);
4887                                 }
4888                         } else {
4889                                 cerr << "Warning: Could not find included file '"
4890                                      << filename << "'." << endl;
4891                                 outname = filename;
4892                         }
4893                         if (external) {
4894                                 begin_inset(os, "External\n");
4895                                 os << "\ttemplate XFig\n"
4896                                    << "\tfilename " << outname << '\n';
4897                                 registerExternalTemplatePackages("XFig");
4898                         } else {
4899                                 begin_command_inset(os, "include", name);
4900                                 outname = subst(outname, "\"", "\\\"");
4901                                 os << "preview false\n"
4902                                       "filename \"" << outname << "\"\n";
4903                                 if (!lstparams.empty())
4904                                         os << "lstparams \"" << lstparams << "\"\n";
4905                                 os << "literal " << lit << "\n";
4906                                 if (t.cs() == "verbatiminput")
4907                                         preamble.registerAutomaticallyLoadedPackage("verbatim");
4908                         }
4909                         end_inset(os);
4910                         continue;
4911                 }
4912
4913                 if (t.cs() == "bibliographystyle") {
4914                         // store new bibliographystyle
4915                         bibliographystyle = p.verbatim_item();
4916                         // If any other command than \bibliography, \addcontentsline
4917                         // and \nocite{*} follows, we need to output the style
4918                         // (because it might be used by that command).
4919                         // Otherwise, it will automatically be output by LyX.
4920                         p.pushPosition();
4921                         bool output = true;
4922                         for (Token t2 = p.get_token(); p.good(); t2 = p.get_token()) {
4923                                 if (t2.cat() == catBegin)
4924                                         break;
4925                                 if (t2.cat() != catEscape)
4926                                         continue;
4927                                 if (t2.cs() == "nocite") {
4928                                         if (p.getArg('{', '}') == "*")
4929                                                 continue;
4930                                 } else if (t2.cs() == "bibliography")
4931                                         output = false;
4932                                 else if (t2.cs() == "phantomsection") {
4933                                         output = false;
4934                                         continue;
4935                                 }
4936                                 else if (t2.cs() == "addcontentsline") {
4937                                         // get the 3 arguments of \addcontentsline
4938                                         p.getArg('{', '}');
4939                                         p.getArg('{', '}');
4940                                         contentslineContent = p.getArg('{', '}');
4941                                         // if the last argument is not \refname we must output
4942                                         if (contentslineContent == "\\refname")
4943                                                 output = false;
4944                                 }
4945                                 break;
4946                         }
4947                         p.popPosition();
4948                         if (output) {
4949                                 output_ert_inset(os,
4950                                         "\\bibliographystyle{" + bibliographystyle + '}',
4951                                         context);
4952                         }
4953                         continue;
4954                 }
4955
4956                 if (t.cs() == "phantomsection") {
4957                         // we only support this if it occurs between
4958                         // \bibliographystyle and \bibliography
4959                         if (bibliographystyle.empty())
4960                                 output_ert_inset(os, "\\phantomsection", context);
4961                         continue;
4962                 }
4963
4964                 if (t.cs() == "addcontentsline") {
4965                         context.check_layout(os);
4966                         // get the 3 arguments of \addcontentsline
4967                         string const one = p.getArg('{', '}');
4968                         string const two = p.getArg('{', '}');
4969                         string const three = p.getArg('{', '}');
4970                         // only if it is a \refname, we support if for the bibtex inset
4971                         if (contentslineContent != "\\refname") {
4972                                 output_ert_inset(os,
4973                                         "\\addcontentsline{" + one + "}{" + two + "}{"+ three + '}',
4974                                         context);
4975                         }
4976                         continue;
4977                 }
4978
4979                 else if (t.cs() == "bibliography") {
4980                         context.check_layout(os);
4981                         string BibOpts;
4982                         begin_command_inset(os, "bibtex", "bibtex");
4983                         if (!btprint.empty()) {
4984                                 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
4985                                 // clear the string because the next BibTeX inset can be without the
4986                                 // \nocite{*} option
4987                                 btprint.clear();
4988                         }
4989                         os << "bibfiles " << '"' << normalize_filename(p.verbatim_item()) << '"' << "\n";
4990                         // Do we have addcontentsline?
4991                         if (contentslineContent == "\\refname") {
4992                                 BibOpts = "bibtotoc";
4993                                 // clear string because next BibTeX inset can be without addcontentsline
4994                                 contentslineContent.clear();
4995                         }
4996                         // Do we have a bibliographystyle set?
4997                         if (!bibliographystyle.empty()) {
4998                                 if (BibOpts.empty())
4999                                         BibOpts = normalize_filename(bibliographystyle);
5000                                 else
5001                                         BibOpts = BibOpts + ',' + normalize_filename(bibliographystyle);
5002                                 // clear it because each bibtex entry has its style
5003                                 // and we need an empty string to handle \phantomsection
5004                                 bibliographystyle.clear();
5005                         }
5006                         os << "options " << '"' << BibOpts << '"' << "\n";
5007                         end_inset(os);
5008                         continue;
5009                 }
5010
5011                 if (t.cs() == "printbibliography") {
5012                         context.check_layout(os);
5013                         string BibOpts;
5014                         string bbloptions = p.hasOpt() ? p.getArg('[', ']') : string();
5015                         vector<string> opts = getVectorFromString(bbloptions);
5016                         vector<string>::iterator it =
5017                                 find(opts.begin(), opts.end(), "heading=bibintoc");
5018                         if (it != opts.end()) {
5019                                 opts.erase(it);
5020                                 BibOpts = "bibtotoc";
5021                         }
5022                         bbloptions = getStringFromVector(opts);
5023                         begin_command_inset(os, "bibtex", "bibtex");
5024                         if (!btprint.empty()) {
5025                                 os << "btprint " << '"' << "btPrintAll" << '"' << "\n";
5026                                 // clear the string because the next BibTeX inset can be without the
5027                                 // \nocite{*} option
5028                                 btprint.clear();
5029                         }
5030                         string bibfiles;
5031                         for (auto const & bf : preamble.biblatex_bibliographies) {
5032                                 if (!bibfiles.empty())
5033                                         bibfiles += ",";
5034                                 bibfiles += normalize_filename(bf);
5035                         }
5036                         if (!bibfiles.empty())
5037                                 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
5038                         // Do we have addcontentsline?
5039                         if (contentslineContent == "\\refname") {
5040                                 BibOpts = "bibtotoc";
5041                                 // clear string because next BibTeX inset can be without addcontentsline
5042                                 contentslineContent.clear();
5043                         }
5044                         os << "options " << '"' << BibOpts << '"' << "\n";
5045                         if (!bbloptions.empty())
5046                                 os << "biblatexopts " << '"' << bbloptions << '"' << "\n";
5047                         end_inset(os);
5048                         need_commentbib = false;
5049                         continue;
5050                 }
5051
5052                 if (t.cs() == "bibbysection") {
5053                         context.check_layout(os);
5054                         string BibOpts;
5055                         string bbloptions = p.hasOpt() ? p.getArg('[', ']') : string();
5056                         vector<string> opts = getVectorFromString(bbloptions);
5057                         vector<string>::iterator it =
5058                                 find(opts.begin(), opts.end(), "heading=bibintoc");
5059                         if (it != opts.end()) {
5060                                 opts.erase(it);
5061                                 BibOpts = "bibtotoc";
5062                         }
5063                         bbloptions = getStringFromVector(opts);
5064                         begin_command_inset(os, "bibtex", "bibtex");
5065                         os << "btprint " << '"' << "bibbysection" << '"' << "\n";
5066                         string bibfiles;
5067                         for (auto const & bf : preamble.biblatex_bibliographies) {
5068                                 if (!bibfiles.empty())
5069                                         bibfiles += ",";
5070                                 bibfiles += normalize_filename(bf);
5071                         }
5072                         if (!bibfiles.empty())
5073                                 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
5074                         os << "options " << '"' << BibOpts << '"' << "\n";
5075                         if (!bbloptions.empty())
5076                                 os << "biblatexopts " << '"' << bbloptions << '"' << "\n";
5077                         end_inset(os);
5078                         need_commentbib = false;
5079                         continue;
5080                 }
5081
5082                 if (t.cs() == "parbox") {
5083                         // Test whether this is an outer box of a shaded box
5084                         p.pushPosition();
5085                         // swallow arguments
5086                         while (p.hasOpt()) {
5087                                 p.getArg('[', ']');
5088                                 p.skip_spaces(true);
5089                         }
5090                         p.getArg('{', '}');
5091                         p.skip_spaces(true);
5092                         // eat the '{'
5093                         if (p.next_token().cat() == catBegin)
5094                                 p.get_token();
5095                         p.skip_spaces(true);
5096                         Token to = p.get_token();
5097                         bool shaded = false;
5098                         if (to.asInput() == "\\begin") {
5099                                 p.skip_spaces(true);
5100                                 if (p.getArg('{', '}') == "shaded")
5101                                         shaded = true;
5102                         }
5103                         p.popPosition();
5104                         if (shaded) {
5105                                 parse_outer_box(p, os, FLAG_ITEM, outer,
5106                                                 context, "parbox", "shaded");
5107                         } else
5108                                 parse_box(p, os, 0, FLAG_ITEM, outer, context,
5109                                           "", "", t.cs(), "", "");
5110                         continue;
5111                 }
5112
5113                 if (t.cs() == "fbox" || t.cs() == "mbox" ||
5114                     t.cs() == "ovalbox" || t.cs() == "Ovalbox" ||
5115                     t.cs() == "shadowbox" || t.cs() == "doublebox") {
5116                         parse_outer_box(p, os, FLAG_ITEM, outer, context, t.cs(), "");
5117                         continue;
5118                 }
5119
5120                 if (t.cs() == "fcolorbox" || t.cs() == "colorbox") {
5121                         string backgroundcolor;
5122                         preamble.registerAutomaticallyLoadedPackage("xcolor");
5123                         if (t.cs() == "fcolorbox") {
5124                                 string const framecolor = p.getArg('{', '}');
5125                                 backgroundcolor = p.getArg('{', '}');
5126                                 parse_box(p, os, 0, 0, outer, context, "", "", "", framecolor, backgroundcolor);
5127                         } else {
5128                                 backgroundcolor = p.getArg('{', '}');
5129                                 parse_box(p, os, 0, 0, outer, context, "", "", "", "", backgroundcolor);
5130                         }
5131                         continue;
5132                 }
5133
5134                 // FIXME: due to the compiler limit of "if" nestings
5135                 // the code for the alignment was put here
5136                 // put them in their own if if this is fixed
5137                 if (t.cs() == "fboxrule" || t.cs() == "fboxsep"
5138                     || t.cs() == "shadowsize"
5139                     || t.cs() == "raggedleft" || t.cs() == "centering"
5140                     || t.cs() == "raggedright") {
5141                         if (t.cs() == "fboxrule")
5142                                 fboxrule = "";
5143                         if (t.cs() == "fboxsep")
5144                                 fboxsep = "";
5145                         if (t.cs() == "shadowsize")
5146                                 shadow_size = "";
5147                         if (t.cs() != "raggedleft" && t.cs() != "centering"
5148                          && t.cs() != "raggedright") {
5149                                 p.skip_spaces(true);
5150                                 while (p.good() && p.next_token().cat() != catSpace
5151                                        && p.next_token().cat() != catNewline
5152                                        && p.next_token().cat() != catEscape) {
5153                                         if (t.cs() == "fboxrule")
5154                                                 fboxrule = fboxrule + p.get_token().asInput();
5155                                         if (t.cs() == "fboxsep")
5156                                                 fboxsep = fboxsep + p.get_token().asInput();
5157                                         if (t.cs() == "shadowsize")
5158                                                 shadow_size = shadow_size + p.get_token().asInput();
5159                                 }
5160                         } else {
5161                                 output_ert_inset(os, t.asInput(), context);
5162                         }
5163                         continue;
5164                 }
5165
5166                 //\framebox() is part of the picture environment and different from \framebox{}
5167                 //\framebox{} will be parsed by parse_outer_box
5168                 if (t.cs() == "framebox") {
5169                         if (p.next_token().character() == '(') {
5170                                 //the syntax is: \framebox(x,y)[position]{content}
5171                                 string arg = t.asInput();
5172                                 arg += p.getFullParentheseArg();
5173                                 arg += p.getFullOpt();
5174                                 eat_whitespace(p, os, context, false);
5175                                 output_ert_inset(os, arg + '{', context);
5176                                 parse_text(p, os, FLAG_ITEM, outer, context);
5177                                 output_ert_inset(os, "}", context);
5178                         } else {
5179                                 //the syntax is: \framebox[width][position]{content}
5180                                 string special = p.getFullOpt();
5181                                 special += p.getOpt();
5182                                 parse_outer_box(p, os, FLAG_ITEM, outer,
5183                                                     context, t.cs(), special);
5184                         }
5185                         continue;
5186                 }
5187
5188                 //\makebox() is part of the picture environment and different from \makebox{}
5189                 //\makebox{} will be parsed by parse_box
5190                 if (t.cs() == "makebox") {
5191                         if (p.next_token().character() == '(') {
5192                                 //the syntax is: \makebox(x,y)[position]{content}
5193                                 string arg = t.asInput();
5194                                 arg += p.getFullParentheseArg();
5195                                 arg += p.getFullOpt();
5196                                 eat_whitespace(p, os, context, false);
5197                                 output_ert_inset(os, arg + '{', context);
5198                                 parse_text(p, os, FLAG_ITEM, outer, context);
5199                                 output_ert_inset(os, "}", context);
5200                         } else
5201                                 //the syntax is: \makebox[width][position]{content}
5202                                 parse_box(p, os, 0, FLAG_ITEM, outer, context,
5203                                           "", "", t.cs(), "", "");
5204                         continue;
5205                 }
5206
5207                 if (t.cs() == "smallskip" ||
5208                     t.cs() == "medskip" ||
5209                     t.cs() == "bigskip" ||
5210                     t.cs() == "vfill") {
5211                         context.check_layout(os);
5212                         begin_inset(os, "VSpace ");
5213                         os << t.cs();
5214                         end_inset(os);
5215                         skip_spaces_braces(p);
5216                         continue;
5217                 }
5218
5219                 if ((where = is_known(t.cs(), known_spaces))) {
5220                         context.check_layout(os);
5221                         begin_inset(os, "space ");
5222                         os << '\\' << known_coded_spaces[where - known_spaces]
5223                            << '\n';
5224                         end_inset(os);
5225                         // LaTeX swallows whitespace after all spaces except
5226                         // "\\,". We have to do that here, too, because LyX
5227                         // adds "{}" which would make the spaces significant.
5228                         if (t.cs() !=  ",")
5229                                 eat_whitespace(p, os, context, false);
5230                         // LyX adds "{}" after all spaces except "\\ " and
5231                         // "\\,", so we have to remove "{}".
5232                         // "\\,{}" is equivalent to "\\," in LaTeX, so we
5233                         // remove the braces after "\\,", too.
5234                         if (t.cs() != " ")
5235                                 skip_braces(p);
5236                         continue;
5237                 }
5238
5239                 if (t.cs() == "newpage" ||
5240                     (t.cs() == "pagebreak" && !p.hasOpt()) ||
5241                     t.cs() == "clearpage" ||
5242                     t.cs() == "cleardoublepage") {
5243                         context.check_layout(os);
5244                         begin_inset(os, "Newpage ");
5245                         os << t.cs();
5246                         end_inset(os);
5247                         skip_spaces_braces(p);
5248                         continue;
5249                 }
5250
5251                 if (t.cs() == "DeclareRobustCommand" ||
5252                          t.cs() == "DeclareRobustCommandx" ||
5253                          t.cs() == "newcommand" ||
5254                          t.cs() == "newcommandx" ||
5255                          t.cs() == "providecommand" ||
5256                          t.cs() == "providecommandx" ||
5257                          t.cs() == "renewcommand" ||
5258                          t.cs() == "renewcommandx") {
5259                         // DeclareRobustCommand, DeclareRobustCommandx,
5260                         // providecommand and providecommandx could be handled
5261                         // by parse_command(), but we need to call
5262                         // add_known_command() here.
5263                         string name = t.asInput();
5264                         if (p.next_token().asInput() == "*") {
5265                                 // Starred form. Eat '*'
5266                                 p.get_token();
5267                                 name += '*';
5268                         }
5269                         string const command = p.verbatim_item();
5270                         string const opt1 = p.getFullOpt();
5271                         string const opt2 = p.getFullOpt();
5272                         add_known_command(command, opt1, !opt2.empty());
5273                         string const ert = name + '{' + command + '}' +
5274                                            opt1 + opt2 +
5275                                            '{' + p.verbatim_item() + '}';
5276
5277                         if (t.cs() == "DeclareRobustCommand" ||
5278                             t.cs() == "DeclareRobustCommandx" ||
5279                             t.cs() == "providecommand" ||
5280                             t.cs() == "providecommandx" ||
5281                             name[name.length()-1] == '*')
5282                                 output_ert_inset(os, ert, context);
5283                         else {
5284                                 context.check_layout(os);
5285                                 begin_inset(os, "FormulaMacro");
5286                                 os << "\n" << ert;
5287                                 end_inset(os);
5288                         }
5289                         continue;
5290                 }
5291
5292                 if (t.cs() == "let" && p.next_token().asInput() != "*") {
5293                         // let could be handled by parse_command(),
5294                         // but we need to call add_known_command() here.
5295                         string ert = t.asInput();
5296                         string name;
5297                         p.skip_spaces();
5298                         if (p.next_token().cat() == catBegin) {
5299                                 name = p.verbatim_item();
5300                                 ert += '{' + name + '}';
5301                         } else {
5302                                 name = p.verbatim_item();
5303                                 ert += name;
5304                         }
5305                         string command;
5306                         p.skip_spaces();
5307                         if (p.next_token().cat() == catBegin) {
5308                                 command = p.verbatim_item();
5309                                 ert += '{' + command + '}';
5310                         } else {
5311                                 command = p.verbatim_item();
5312                                 ert += command;
5313                         }
5314                         // If command is known, make name known too, to parse
5315                         // its arguments correctly. For this reason we also
5316                         // have commands in syntax.default that are hardcoded.
5317                         CommandMap::iterator it = known_commands.find(command);
5318                         if (it != known_commands.end())
5319                                 known_commands[t.asInput()] = it->second;
5320                         output_ert_inset(os, ert, context);
5321                         continue;
5322                 }
5323
5324                 if (t.cs() == "hspace" || t.cs() == "vspace") {
5325                         if (starred)
5326                                 p.get_token();
5327                         string name = t.asInput();
5328                         string const length = p.verbatim_item();
5329                         string unit;
5330                         string valstring;
5331                         bool valid = splitLatexLength(length, valstring, unit);
5332                         bool known_hspace = false;
5333                         bool known_vspace = false;
5334                         bool known_unit = false;
5335                         double value = 0.0;
5336                         if (valid) {
5337                                 istringstream iss(valstring);
5338                                 iss >> value;
5339                                 if (value == 1.0) {
5340                                         if (t.cs()[0] == 'h') {
5341                                                 if (unit == "\\fill") {
5342                                                         if (!starred) {
5343                                                                 unit = "";
5344                                                                 name = "\\hfill";
5345                                                         }
5346                                                         known_hspace = true;
5347                                                 }
5348                                         } else {
5349                                                 if (unit == "\\smallskipamount") {
5350                                                         unit = "smallskip";
5351                                                         known_vspace = true;
5352                                                 } else if (unit == "\\medskipamount") {
5353                                                         unit = "medskip";
5354                                                         known_vspace = true;
5355                                                 } else if (unit == "\\bigskipamount") {
5356                                                         unit = "bigskip";
5357                                                         known_vspace = true;
5358                                                 } else if (unit == "\\fill") {
5359                                                         unit = "vfill";
5360                                                         known_vspace = true;
5361                                                 }
5362                                         }
5363                                 }
5364                                 if (!known_hspace && !known_vspace) {
5365                                         switch (unitFromString(unit)) {
5366                                         case Length::SP:
5367                                         case Length::PT:
5368                                         case Length::BP:
5369                                         case Length::DD:
5370                                         case Length::MM:
5371                                         case Length::PC:
5372                                         case Length::CC:
5373                                         case Length::CM:
5374                                         case Length::IN:
5375                                         case Length::EX:
5376                                         case Length::EM:
5377                                         case Length::MU:
5378                                                 known_unit = true;
5379                                                 break;
5380                                         default: {
5381                                                 //unitFromString(unit) fails for relative units like Length::PCW
5382                                                 // therefore handle them separately
5383                                                 if (unit == "\\paperwidth" || unit == "\\columnwidth"
5384                                                         || unit == "\\textwidth" || unit == "\\linewidth"
5385                                                         || unit == "\\textheight" || unit == "\\paperheight"
5386                                                         || unit == "\\baselineskip")
5387                                                         known_unit = true;
5388                                                 break;
5389                                                          }
5390                                         }
5391                                 }
5392                         }
5393
5394                         // check for glue lengths
5395                         bool is_gluelength = false;
5396                         string gluelength = length;
5397                         string::size_type i = length.find(" minus");
5398                         if (i == string::npos) {
5399                                 i = length.find(" plus");
5400                                 if (i != string::npos)
5401                                         is_gluelength = true;
5402                         } else
5403                                 is_gluelength = true;
5404                         // if yes transform "9xx minus 8yy plus 7zz"
5405                         // to "9xx-8yy+7zz"
5406                         if (is_gluelength) {
5407                                 i = gluelength.find(" minus");
5408                                 if (i != string::npos)
5409                                         gluelength.replace(i, 7, "-");
5410                                 i = gluelength.find(" plus");
5411                                 if (i != string::npos)
5412                                         gluelength.replace(i, 6, "+");
5413                         }
5414
5415                         if (t.cs()[0] == 'h' && (known_unit || known_hspace || is_gluelength)) {
5416                                 // Literal horizontal length or known variable
5417                                 context.check_layout(os);
5418                                 begin_inset(os, "space ");
5419                                 os << name;
5420                                 if (starred)
5421                                         os << '*';
5422                                 os << '{';
5423                                 if (known_hspace)
5424                                         os << unit;
5425                                 os << "}";
5426                                 if (known_unit && !known_hspace)
5427                                         os << "\n\\length " << translate_len(length);
5428                                 if (is_gluelength)
5429                                         os << "\n\\length " << gluelength;
5430                                 end_inset(os);
5431                         } else if (known_unit || known_vspace || is_gluelength) {
5432                                 // Literal vertical length or known variable
5433                                 context.check_layout(os);
5434                                 begin_inset(os, "VSpace ");
5435                                 if (known_vspace)
5436                                         os << unit;
5437                                 if (known_unit && !known_vspace)
5438                                         os << translate_len(length);
5439                                 if (is_gluelength)
5440                                         os << gluelength;
5441                                 if (starred)
5442                                         os << '*';
5443                                 end_inset(os);
5444                         } else {
5445                                 // LyX can't handle other length variables in Inset VSpace/space
5446                                 if (starred)
5447                                         name += '*';
5448                                 if (valid) {
5449                                         if (value == 1.0)
5450                                                 output_ert_inset(os, name + '{' + unit + '}', context);
5451                                         else if (value == -1.0)
5452                                                 output_ert_inset(os, name + "{-" + unit + '}', context);
5453                                         else
5454                                                 output_ert_inset(os, name + '{' + valstring + unit + '}', context);
5455                                 } else
5456                                         output_ert_inset(os, name + '{' + length + '}', context);
5457                         }
5458                         continue;
5459                 }
5460
5461                 // Before we look for the layout name alone below, we check the layouts including the LateXParam, which
5462                 // might be one or several options or a star.
5463                 // The single '=' is meant here.
5464                 if ((newinsetlayout = findInsetLayout(context.textclass, starredname, true, p.getCommandLatexParam()))) {
5465                         if (starred)
5466                                 p.get_token();
5467                         p.skip_spaces();
5468                         context.check_layout(os);
5469                         // store the latexparam here. This is eaten in parse_text_in_inset
5470                         context.latexparam = newinsetlayout->latexparam();
5471                         docstring name = newinsetlayout->name();
5472                         bool const caption = name.find(from_ascii("Caption:")) == 0;
5473                         if (caption) {
5474                                 // Already done for floating minted listings.
5475                                 if (minted_float.empty()) {
5476                                         begin_inset(os, "Caption ");
5477                                         os << to_utf8(name.substr(8)) << '\n';
5478                                 }
5479                         } else {
5480                                 // FIXME: what do we do if the prefix is not Flex: ?
5481                                 if (prefixIs(name, from_ascii("Flex:")))
5482                                         name.erase(0, 5);
5483                                 begin_inset(os, "Flex ");
5484                                 os << to_utf8(name) << '\n'
5485                                    << "status collapsed\n";
5486                         }
5487                         if (!minted_float.empty()) {
5488                                 parse_text_snippet(p, os, FLAG_ITEM, false, context);
5489                         } else if (newinsetlayout->isPassThru()) {
5490                                 // set catcodes to verbatim early, just in case.
5491                                 p.setCatcodes(VERBATIM_CATCODES);
5492                                 string delim = p.get_token().asInput();
5493                                 if (delim != "{")
5494                                         cerr << "Warning: bad delimiter for command " << t.asInput() << endl;
5495                                 //FIXME: handle error condition
5496                                 string const arg = p.verbatimStuff("}").second;
5497                                 Context newcontext(true, context.textclass);
5498                                 if (newinsetlayout->forcePlainLayout())
5499                                         newcontext.layout = &context.textclass.plainLayout();
5500                                 output_ert(os, arg, newcontext);
5501                         } else
5502                                 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
5503                         if (caption)
5504                                 p.skip_spaces();
5505                         // Minted caption insets are not closed here because
5506                         // we collect everything into the caption.
5507                         if (minted_float.empty())
5508                                 end_inset(os);
5509                         continue;
5510                 }
5511
5512                 // The single '=' is meant here.
5513                 if ((newinsetlayout = findInsetLayout(context.textclass, starredname, true))) {
5514                         if (starred)
5515                                 p.get_token();
5516                         p.skip_spaces();
5517                         context.check_layout(os);
5518                         docstring name = newinsetlayout->name();
5519                         bool const caption = name.find(from_ascii("Caption:")) == 0;
5520                         if (caption) {
5521                                 // Already done for floating minted listings.
5522                                 if (minted_float.empty()) {
5523                                         begin_inset(os, "Caption ");
5524                                         os << to_utf8(name.substr(8)) << '\n';
5525                                 }
5526                         } else {
5527                                 // FIXME: what do we do if the prefix is not Flex: ?
5528                                 if (prefixIs(name, from_ascii("Flex:")))
5529                                         name.erase(0, 5);
5530                                 begin_inset(os, "Flex ");
5531                                 os << to_utf8(name) << '\n'
5532                                    << "status collapsed\n";
5533                         }
5534                         if (!minted_float.empty()) {
5535                                 parse_text_snippet(p, os, FLAG_ITEM, false, context);
5536                         } else if (newinsetlayout->isPassThru()) {
5537                                 // set catcodes to verbatim early, just in case.
5538                                 p.setCatcodes(VERBATIM_CATCODES);
5539                                 string delim = p.get_token().asInput();
5540                                 if (delim != "{")
5541                                         cerr << "Warning: bad delimiter for command " << t.asInput() << endl;
5542                                 //FIXME: handle error condition
5543                                 string const arg = p.verbatimStuff("}").second;
5544                                 Context newcontext(true, context.textclass);
5545                                 if (newinsetlayout->forcePlainLayout())
5546                                         newcontext.layout = &context.textclass.plainLayout();
5547                                 output_ert(os, arg, newcontext);
5548                         } else
5549                                 parse_text_in_inset(p, os, FLAG_ITEM, false, context, newinsetlayout);
5550                         if (caption)
5551                                 p.skip_spaces();
5552                         // Minted caption insets are not closed here because
5553                         // we collect everything into the caption.
5554                         if (minted_float.empty())
5555                                 end_inset(os);
5556                         continue;
5557                 }
5558
5559                 if (t.cs() == "includepdf") {
5560                         p.skip_spaces();
5561                         string const arg = p.getArg('[', ']');
5562                         map<string, string> opts;
5563                         vector<string> keys;
5564                         split_map(arg, opts, keys);
5565                         string name = normalize_filename(p.verbatim_item());
5566                         string const path = getMasterFilePath(true);
5567                         // We want to preserve relative / absolute filenames,
5568                         // therefore path is only used for testing
5569                         if (!makeAbsPath(name, path).exists()) {
5570                                 // The file extension is probably missing.
5571                                 // Now try to find it out.
5572                                 char const * const pdfpages_format[] = {"pdf", 0};
5573                                 string const pdftex_name =
5574                                         find_file(name, path, pdfpages_format);
5575                                 if (!pdftex_name.empty()) {
5576                                         name = pdftex_name;
5577                                         pdflatex = true;
5578                                 }
5579                         }
5580                         FileName const absname = makeAbsPath(name, path);
5581                         if (absname.exists())
5582                         {
5583                                 fix_child_filename(name);
5584                                 copy_file(absname, name);
5585                         } else
5586                                 cerr << "Warning: Could not find file '"
5587                                      << name << "'." << endl;
5588                         // write output
5589                         context.check_layout(os);
5590                         begin_inset(os, "External\n\ttemplate ");
5591                         os << "PDFPages\n\tfilename "
5592                            << name << "\n";
5593                         // parse the options
5594                         if (opts.find("pages") != opts.end())
5595                                 os << "\textra LaTeX \"pages="
5596                                    << opts["pages"] << "\"\n";
5597                         if (opts.find("angle") != opts.end())
5598                                 os << "\trotateAngle "
5599                                    << opts["angle"] << '\n';
5600                         if (opts.find("origin") != opts.end()) {
5601                                 ostringstream ss;
5602                                 string const opt = opts["origin"];
5603                                 if (opt == "tl") ss << "topleft";
5604                                 if (opt == "bl") ss << "bottomleft";
5605                                 if (opt == "Bl") ss << "baselineleft";
5606                                 if (opt == "c") ss << "center";
5607                                 if (opt == "tc") ss << "topcenter";
5608                                 if (opt == "bc") ss << "bottomcenter";
5609                                 if (opt == "Bc") ss << "baselinecenter";
5610                                 if (opt == "tr") ss << "topright";
5611                                 if (opt == "br") ss << "bottomright";
5612                                 if (opt == "Br") ss << "baselineright";
5613                                 if (!ss.str().empty())
5614                                         os << "\trotateOrigin " << ss.str() << '\n';
5615                                 else
5616                                         cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
5617                         }
5618                         if (opts.find("width") != opts.end())
5619                                 os << "\twidth "
5620                                    << translate_len(opts["width"]) << '\n';
5621                         if (opts.find("height") != opts.end())
5622                                 os << "\theight "
5623                                    << translate_len(opts["height"]) << '\n';
5624                         if (opts.find("keepaspectratio") != opts.end())
5625                                 os << "\tkeepAspectRatio\n";
5626                         end_inset(os);
5627                         context.check_layout(os);
5628                         registerExternalTemplatePackages("PDFPages");
5629                         continue;
5630                 }
5631
5632                 if (t.cs() == "loadgame") {
5633                         p.skip_spaces();
5634                         string name = normalize_filename(p.verbatim_item());
5635                         string const path = getMasterFilePath(true);
5636                         // We want to preserve relative / absolute filenames,
5637                         // therefore path is only used for testing
5638                         if (!makeAbsPath(name, path).exists()) {
5639                                 // The file extension is probably missing.
5640                                 // Now try to find it out.
5641                                 char const * const lyxskak_format[] = {"fen", 0};
5642                                 string const lyxskak_name =
5643                                         find_file(name, path, lyxskak_format);
5644                                 if (!lyxskak_name.empty())
5645                                         name = lyxskak_name;
5646                         }
5647                         FileName const absname = makeAbsPath(name, path);
5648                         if (absname.exists())
5649                         {
5650                                 fix_child_filename(name);
5651                                 copy_file(absname, name);
5652                         } else
5653                                 cerr << "Warning: Could not find file '"
5654                                      << name << "'." << endl;
5655                         context.check_layout(os);
5656                         begin_inset(os, "External\n\ttemplate ");
5657                         os << "ChessDiagram\n\tfilename "
5658                            << name << "\n";
5659                         end_inset(os);
5660                         context.check_layout(os);
5661                         // after a \loadgame follows a \showboard
5662                         if (p.get_token().asInput() == "showboard")
5663                                 p.get_token();
5664                         registerExternalTemplatePackages("ChessDiagram");
5665                         continue;
5666                 }
5667
5668                 // try to see whether the string is in unicodesymbols
5669                 // Only use text mode commands, since we are in text mode here,
5670                 // and math commands may be invalid (bug 6797)
5671                 string name = t.asInput();
5672                 // handle the dingbats, cyrillic and greek
5673                 if (name == "\\ding" || name == "\\textcyr" ||
5674                     (name == "\\textgreek" && !preamble.usePolyglossia()))
5675                         name = name + '{' + p.getArg('{', '}') + '}';
5676                 // handle the ifsym characters
5677                 else if (name == "\\textifsymbol") {
5678                         string const optif = p.getFullOpt();
5679                         string const argif = p.getArg('{', '}');
5680                         name = name + optif + '{' + argif + '}';
5681                 }
5682                 // handle the \ascii characters
5683                 // the case of \ascii within braces, as LyX outputs it, is already
5684                 // handled for t.cat() == catBegin
5685                 else if (name == "\\ascii") {
5686                         // the code is "\asci\xxx"
5687                         name = "{" + name + p.get_token().asInput() + "}";
5688                         skip_braces(p);
5689                 }
5690                 // handle some TIPA special characters
5691                 else if (preamble.isPackageUsed("tipa")) {
5692                         if (name == "\\s") {
5693                                 // fromLaTeXCommand() does not yet
5694                                 // recognize tipa short cuts
5695                                 name = "\\textsyllabic";
5696                         } else if (name == "\\=" &&
5697                                    p.next_token().asInput() == "*") {
5698                                 // fromLaTeXCommand() does not yet
5699                                 // recognize tipa short cuts
5700                                 p.get_token();
5701                                 name = "\\textsubbar";
5702                         } else if (name == "\\textdoublevertline") {
5703                                 // FIXME: This is not correct,
5704                                 // \textvertline is higher than \textbardbl
5705                                 name = "\\textbardbl";
5706                                 skip_braces(p);
5707                         } else if (name == "\\!" ) {
5708                                 if (p.next_token().asInput() == "b") {
5709                                         p.get_token();  // eat 'b'
5710                                         name = "\\texthtb";
5711                                         skip_braces(p);
5712                                 } else if (p.next_token().asInput() == "d") {
5713                                         p.get_token();
5714                                         name = "\\texthtd";
5715                                         skip_braces(p);
5716                                 } else if (p.next_token().asInput() == "g") {
5717                                         p.get_token();
5718                                         name = "\\texthtg";
5719                                         skip_braces(p);
5720                                 } else if (p.next_token().asInput() == "G") {
5721                                         p.get_token();
5722                                         name = "\\texthtscg";
5723                                         skip_braces(p);
5724                                 } else if (p.next_token().asInput() == "j") {
5725                                         p.get_token();
5726                                         name = "\\texthtbardotlessj";
5727                                         skip_braces(p);
5728                                 } else if (p.next_token().asInput() == "o") {
5729                                         p.get_token();
5730                                         name = "\\textbullseye";
5731                                         skip_braces(p);
5732                                 }
5733                         } else if (name == "\\*" ) {
5734                                 if (p.next_token().asInput() == "k") {
5735                                         p.get_token();
5736                                         name = "\\textturnk";
5737                                         skip_braces(p);
5738                                 } else if (p.next_token().asInput() == "r") {
5739                                         p.get_token();  // eat 'b'
5740                                         name = "\\textturnr";
5741                                         skip_braces(p);
5742                                 } else if (p.next_token().asInput() == "t") {
5743                                         p.get_token();
5744                                         name = "\\textturnt";
5745                                         skip_braces(p);
5746                                 } else if (p.next_token().asInput() == "w") {
5747                                         p.get_token();
5748                                         name = "\\textturnw";
5749                                         skip_braces(p);
5750                                 }
5751                         }
5752                 }
5753                 if ((name.size() == 2 &&
5754                      contains("\"'.=^`bcdHkrtuv~", name[1]) &&
5755                      p.next_token().asInput() != "*") ||
5756                     is_known(name.substr(1), known_tipa_marks)) {
5757                         // name is a command that corresponds to a
5758                         // combining character in unicodesymbols.
5759                         // Append the argument, fromLaTeXCommand()
5760                         // will either convert it to a single
5761                         // character or a combining sequence.
5762                         name += '{' + p.verbatim_item() + '}';
5763                 }
5764                 // now get the character from unicodesymbols
5765                 bool termination;
5766                 docstring rem;
5767                 set<string> req;
5768                 docstring s = normalize_c(encodings.fromLaTeXCommand(from_utf8(name),
5769                                 Encodings::TEXT_CMD, termination, rem, &req));
5770                 if (!s.empty()) {
5771                         context.check_layout(os);
5772                         os << to_utf8(s);
5773                         if (!rem.empty())
5774                                 output_ert_inset(os, to_utf8(rem), context);
5775                         if (termination)
5776                                 skip_spaces_braces(p);
5777                         for (set<string>::const_iterator it = req.begin(); it != req.end(); ++it)
5778                                 preamble.registerAutomaticallyLoadedPackage(*it);
5779                 }
5780                 //cerr << "#: " << t << " mode: " << mode << endl;
5781                 // heuristic: read up to next non-nested space
5782                 /*
5783                 string s = t.asInput();
5784                 string z = p.verbatim_item();
5785                 while (p.good() && z != " " && !z.empty()) {
5786                         //cerr << "read: " << z << endl;
5787                         s += z;
5788                         z = p.verbatim_item();
5789                 }
5790                 cerr << "found ERT: " << s << endl;
5791                 output_ert_inset(os, s + ' ', context);
5792                 */
5793                 else {
5794                         if (t.asInput() == name &&
5795                             p.next_token().asInput() == "*") {
5796                                 // Starred commands like \vspace*{}
5797                                 p.get_token();  // Eat '*'
5798                                 name += '*';
5799                         }
5800                         if (!parse_command(name, p, os, outer, context))
5801                                 output_ert_inset(os, name, context);
5802                 }
5803         }
5804 }
5805
5806
5807 string guessLanguage(Parser & p, string const & lang)
5808 {
5809         typedef std::map<std::string, size_t> LangMap;
5810         // map from language names to number of characters
5811         LangMap used;
5812         used[lang] = 0;
5813         for (char const * const * i = supported_CJK_languages; *i; i++)
5814                 used[string(*i)] = 0;
5815
5816         while (p.good()) {
5817                 Token const t = p.get_token();
5818                 // comments are not counted for any language
5819                 if (t.cat() == catComment)
5820                         continue;
5821                 // commands are not counted as well, but we need to detect
5822                 // \begin{CJK} and switch encoding if needed
5823                 if (t.cat() == catEscape) {
5824                         if (t.cs() == "inputencoding") {
5825                                 string const enc = subst(p.verbatim_item(), "\n", " ");
5826                                 p.setEncoding(enc, Encoding::inputenc);
5827                                 continue;
5828                         }
5829                         if (t.cs() != "begin")
5830                                 continue;
5831                 } else {
5832                         // Non-CJK content is counted for lang.
5833                         // We do not care about the real language here:
5834                         // If we have more non-CJK contents than CJK contents,
5835                         // we simply use the language that was specified as
5836                         // babel main language.
5837                         used[lang] += t.asInput().length();
5838                         continue;
5839                 }
5840                 // Now we are starting an environment
5841                 p.pushPosition();
5842                 string const name = p.getArg('{', '}');
5843                 if (name != "CJK") {
5844                         p.popPosition();
5845                         continue;
5846                 }
5847                 // It is a CJK environment
5848                 p.popPosition();
5849                 /* name = */ p.getArg('{', '}');
5850                 string const encoding = p.getArg('{', '}');
5851                 /* mapping = */ p.getArg('{', '}');
5852                 string const encoding_old = p.getEncoding();
5853                 char const * const * const where =
5854                         is_known(encoding, supported_CJK_encodings);
5855                 if (where)
5856                         p.setEncoding(encoding, Encoding::CJK);
5857                 else
5858                         p.setEncoding("UTF-8");
5859                 string const text = p.ertEnvironment("CJK");
5860                 p.setEncoding(encoding_old);
5861                 p.skip_spaces();
5862                 if (!where) {
5863                         // ignore contents in unknown CJK encoding
5864                         continue;
5865                 }
5866                 // the language of the text
5867                 string const cjk =
5868                         supported_CJK_languages[where - supported_CJK_encodings];
5869                 used[cjk] += text.length();
5870         }
5871         LangMap::const_iterator use = used.begin();
5872         for (LangMap::const_iterator it = used.begin(); it != used.end(); ++it) {
5873                 if (it->second > use->second)
5874                         use = it;
5875         }
5876         return use->first;
5877 }
5878
5879
5880 void check_comment_bib(ostream & os, Context & context)
5881 {
5882         if (!need_commentbib)
5883                 return;
5884         // We have a bibliography database, but no bibliography with biblatex
5885         // which is completely valid. Insert a bibtex inset in a note.
5886         context.check_layout(os);
5887         begin_inset(os, "Note Note\n");
5888         os << "status open\n";
5889         os << "\\begin_layout Plain Layout\n";
5890         begin_command_inset(os, "bibtex", "bibtex");
5891         string bibfiles;
5892         for (auto const & bf : preamble.biblatex_bibliographies) {
5893                 if (!bibfiles.empty())
5894                         bibfiles += ",";
5895                 bibfiles += normalize_filename(bf);
5896         }
5897         if (!bibfiles.empty())
5898                 os << "bibfiles " << '"' << bibfiles << '"' << "\n";
5899         end_inset(os);// Bibtex
5900         os << "\\end_layout\n";
5901         end_inset(os);// Note
5902 }
5903
5904 // }])
5905
5906
5907 } // namespace lyx