src/tex2lyx/text.C

   1 /**
   2  * \file tex2lyx/text.C
   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  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 // {[(
  13
  14 #include <config.h>
  15
  16 #include "tex2lyx.h"
  17 #include "context.h"
  18 #include "FloatList.h"
  19 #include "lengthcommon.h"
  20 #include "support/lstrings.h"
  21 #include "support/convert.h"
  22 #include "support/filetools.h"
  23
  24 #include <boost/filesystem/operations.hpp>
  25 #include <boost/tuple/tuple.hpp>
  26
  27 #include <iostream>
  28 #include <map>
  29 #include <sstream>
  30 #include <vector>
  31
  32 using lyx::support::changeExtension;
  33 using lyx::support::makeAbsPath;
  34 using lyx::support::makeRelPath;
  35 using lyx::support::rtrim;
  36 using lyx::support::suffixIs;
  37 using lyx::support::contains;
  38 using lyx::support::subst;
  39
  40 using std::cerr;
  41 using std::endl;
  42
  43 using std::map;
  44 using std::ostream;
  45 using std::ostringstream;
  46 using std::istringstream;
  47 using std::string;
  48 using std::vector;
  49
  50 namespace fs = boost::filesystem;
  51
  52
  53 void parse_text_in_inset(Parser & p, ostream & os, unsigned flags, bool outer,
  54                 Context const & context)
  55 {
  56         Context newcontext(true, context.textclass);
  57         newcontext.font = context.font;
  58         parse_text(p, os, flags, outer, newcontext);
  59         newcontext.check_end_layout(os);
  60 }
  61
  62
  63 namespace {
  64
  65 /// parses a paragraph snippet, useful for example for \\emph{...}
  66 void parse_text_snippet(Parser & p, ostream & os, unsigned flags, bool outer,
  67                 Context & context)
  68 {
  69         Context newcontext(context);
  70         // Don't inherit the extra stuff
  71         newcontext.extra_stuff.clear();
  72         parse_text(p, os, flags, outer, newcontext);
  73         // Make sure that we don't create invalid .lyx files
  74         context.need_layout = newcontext.need_layout;
  75         context.need_end_layout = newcontext.need_end_layout;
  76 }
  77
  78
  79 /*!
  80  * Thin wrapper around parse_text_snippet() using a string.
  81  *
  82  * We completely ignore \c context.need_layout and \c context.need_end_layout,
  83  * because our return value is not used directly (otherwise the stream version
  84  * of parse_text_snippet() could be used). That means that the caller needs
  85  * to do layout management manually.
  86  * This is intended to parse text that does not create any layout changes.
  87  */
  88 string parse_text_snippet(Parser & p, unsigned flags, const bool outer,
  89                   Context & context)
  90 {
  91         Context newcontext(context);
  92         newcontext.need_layout = false;
  93         newcontext.need_end_layout = false;
  94         newcontext.new_layout_allowed = false;
  95         // Avoid warning by Context::~Context()
  96         newcontext.extra_stuff.clear();
  97         ostringstream os;
  98         parse_text_snippet(p, os, flags, outer, newcontext);
  99         return os.str();
 100 }
 101
 102
 103 char const * const known_latex_commands[] = { "ref", "cite", "label", "index",
 104 "printindex", "pageref", "url", "vref", "vpageref", "prettyref", "eqref", 0 };
 105
 106 /*!
 107  * natbib commands.
 108  * We can't put these into known_latex_commands because the argument order
 109  * is reversed in lyx if there are 2 arguments.
 110  * The starred forms are also known.
 111  */
 112 char const * const known_natbib_commands[] = { "cite", "citet", "citep",
 113 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar",
 114 "citefullauthor", "Citet", "Citep", "Citealt", "Citealp", "Citeauthor", 0 };
 115
 116 /*!
 117  * jurabib commands.
 118  * We can't put these into known_latex_commands because the argument order
 119  * is reversed in lyx if there are 2 arguments.
 120  * No starred form other than "cite*" known.
 121  */
 122 char const * const known_jurabib_commands[] = { "cite", "citet", "citep",
 123 "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar", "fullcite",
 124 // jurabib commands not (yet) supported by LyX:
 125 // "footcite", "footcitet", "footcitep", "footcitealt", "footcitealp",
 126 // "footciteauthor", "footciteyear", "footciteyearpar",
 127 "citefield", "citetitle", "cite*", 0 };
 128
 129 /// LaTeX names for quotes
 130 char const * const known_quotes[] = { "glqq", "grqq", "quotedblbase",
 131 "textquotedblleft", "quotesinglbase", "guilsinglleft", "guilsinglright", 0};
 132
 133 /// the same as known_quotes with .lyx names
 134 char const * const known_coded_quotes[] = { "gld", "grd", "gld",
 135 "grd", "gls", "fls", "frd", 0};
 136
 137 /// LaTeX names for font sizes
 138 char const * const known_sizes[] = { "tiny", "scriptsize", "footnotesize",
 139 "small", "normalsize", "large", "Large", "LARGE", "huge", "Huge", 0};
 140
 141 /// the same as known_sizes with .lyx names
 142 char const * const known_coded_sizes[] = { "tiny", "scriptsize", "footnotesize",
 143 "small", "normal", "large", "larger", "largest",  "huge", "giant", 0};
 144
 145 /// LaTeX 2.09 names for font families
 146 char const * const known_old_font_families[] = { "rm", "sf", "tt", 0};
 147
 148 /// LaTeX names for font families
 149 char const * const known_font_families[] = { "rmfamily", "sffamily",
 150 "ttfamily", 0};
 151
 152 /// the same as known_old_font_families and known_font_families with .lyx names
 153 char const * const known_coded_font_families[] = { "roman", "sans",
 154 "typewriter", 0};
 155
 156 /// LaTeX 2.09 names for font series
 157 char const * const known_old_font_series[] = { "bf", 0};
 158
 159 /// LaTeX names for font series
 160 char const * const known_font_series[] = { "bfseries", "mdseries", 0};
 161
 162 /// the same as known_old_font_series and known_font_series with .lyx names
 163 char const * const known_coded_font_series[] = { "bold", "medium", 0};
 164
 165 /// LaTeX 2.09 names for font shapes
 166 char const * const known_old_font_shapes[] = { "it", "sl", "sc", 0};
 167
 168 /// LaTeX names for font shapes
 169 char const * const known_font_shapes[] = { "itshape", "slshape", "scshape",
 170 "upshape", 0};
 171
 172 /// the same as known_old_font_shapes and known_font_shapes with .lyx names
 173 char const * const known_coded_font_shapes[] = { "italic", "slanted",
 174 "smallcaps", "up", 0};
 175
 176 /*!
 177  * Graphics file extensions known by the dvips driver of the graphics package.
 178  * These extensions are used to complete the filename of an included
 179  * graphics file if it does not contain an extension.
 180  * The order must be the same that latex uses to find a file, because we
 181  * will use the first extension that matches.
 182  * This is only an approximation for the common cases. If we would want to
 183  * do it right in all cases, we would need to know which graphics driver is
 184  * used and know the extensions of every driver of the graphics package.
 185  */
 186 char const * const known_dvips_graphics_formats[] = {"eps", "ps", "eps.gz",
 187 "ps.gz", "eps.Z", "ps.Z", 0};
 188
 189 /*!
 190  * Graphics file extensions known by the pdftex driver of the graphics package.
 191  * \sa known_dvips_graphics_formats
 192  */
 193 char const * const known_pdftex_graphics_formats[] = {"png", "pdf", "jpg",
 194 "mps", "tif", 0};
 195
 196 /*!
 197  * Known file extensions for TeX files as used by \\include.
 198  */
 199 char const * const known_tex_extensions[] = {"tex", 0};
 200
 201
 202 /// splits "x=z, y=b" into a map
 203 map<string, string> split_map(string const & s)
 204 {
 205         map<string, string> res;
 206         vector<string> v;
 207         split(s, v);
 208         for (size_t i = 0; i < v.size(); ++i) {
 209                 size_t const pos   = v[i].find('=');
 210                 string const index = v[i].substr(0, pos);
 211                 string const value = v[i].substr(pos + 1, string::npos);
 212                 res[trim(index)] = trim(value);
 213         }
 214         return res;
 215 }
 216
 217
 218 /*!
 219  * Split a LaTeX length into value and unit.
 220  * The latter can be a real unit like "pt", or a latex length variable
 221  * like "\textwidth". The unit may contain additional stuff like glue
 222  * lengths, but we don't care, because such lengths are ERT anyway.
 223  * \returns true if \p value and \p unit are valid.
 224  */
 225 bool splitLatexLength(string const & len, string & value, string & unit)
 226 {
 227         if (len.empty())
 228                 return false;
 229         const string::size_type i = len.find_first_not_of(" -+0123456789.,");
 230         //'4,5' is a valid LaTeX length number. Change it to '4.5'
 231         string const length = subst(len, ',', '.');
 232         if (i == string::npos)
 233                 return false;
 234         if (i == 0) {
 235                 if (len[0] == '\\') {
 236                         // We had something like \textwidth without a factor
 237                         value = "1.0";
 238                 } else {
 239                         return false;
 240                 }
 241         } else {
 242                 value = trim(string(length, 0, i));
 243         }
 244         if (value == "-")
 245                 value = "-1.0";
 246         // 'cM' is a valid LaTeX length unit. Change it to 'cm'
 247         if (contains(len, '\\'))
 248                 unit = trim(string(len, i));
 249         else
 250                 unit = lyx::support::lowercase(trim(string(len, i)));
 251         return true;
 252 }
 253
 254
 255 /// A simple function to translate a latex length to something lyx can
 256 /// understand. Not perfect, but rather best-effort.
 257 bool translate_len(string const & length, string & valstring, string & unit)
 258 {
 259         if (!splitLatexLength(length, valstring, unit))
 260                 return false;
 261         // LyX uses percent values
 262         double value;
 263         istringstream iss(valstring);
 264         iss >> value;
 265         value *= 100;
 266         ostringstream oss;
 267         oss << value;
 268         string const percentval = oss.str();
 269         // a normal length
 270         if (unit.empty() || unit[0] != '\\')
 271                 return true;
 272         string::size_type const i = unit.find(' ');
 273         string const endlen = (i == string::npos) ? string() : string(unit, i);
 274         if (unit == "\\textwidth") {
 275                 valstring = percentval;
 276                 unit = "text%" + endlen;
 277         } else if (unit == "\\columnwidth") {
 278                 valstring = percentval;
 279                 unit = "col%" + endlen;
 280         } else if (unit == "\\paperwidth") {
 281                 valstring = percentval;
 282                 unit = "page%" + endlen;
 283         } else if (unit == "\\linewidth") {
 284                 valstring = percentval;
 285                 unit = "line%" + endlen;
 286         } else if (unit == "\\paperheight") {
 287                 valstring = percentval;
 288                 unit = "pheight%" + endlen;
 289         } else if (unit == "\\textheight") {
 290                 valstring = percentval;
 291                 unit = "theight%" + endlen;
 292         }
 293         return true;
 294 }
 295
 296 }
 297
 298
 299 string translate_len(string const & length)
 300 {
 301         string unit;
 302         string value;
 303         if (translate_len(length, value, unit))
 304                 return value + unit;
 305         // If the input is invalid, return what we have.
 306         return length;
 307 }
 308
 309
 310 namespace {
 311
 312 /*!
 313  * Translates a LaTeX length into \p value, \p unit and
 314  * \p special parts suitable for a box inset.
 315  * The difference from translate_len() is that a box inset knows about
 316  * some special "units" that are stored in \p special.
 317  */
 318 void translate_box_len(string const & length, string & value, string & unit, string & special)
 319 {
 320         if (translate_len(length, value, unit)) {
 321                 if (unit == "\\height" || unit == "\\depth" ||
 322                     unit == "\\totalheight" || unit == "\\width") {
 323                         special = unit.substr(1);
 324                         // The unit is not used, but LyX requires a dummy setting
 325                         unit = "in";
 326                 } else
 327                         special = "none";
 328         } else {
 329                 value.clear();
 330                 unit = length;
 331                 special = "none";
 332         }
 333 }
 334
 335
 336 /*!
 337  * Find a file with basename \p name in path \p path and an extension
 338  * in \p extensions.
 339  */
 340 string find_file(string const & name, string const & path,
 341                  char const * const * extensions)
 342 {
 343         for (char const * const * what = extensions; *what; ++what) {
 344                 // We don't use ChangeExtension() because it does the wrong
 345                 // thing if name contains a dot.
 346                 string const trial = name + '.' + (*what);
 347                 if (fs::exists(makeAbsPath(trial, path)))
 348                         return trial;
 349         }
 350         return string();
 351 }
 352
 353
 354 void begin_inset(ostream & os, string const & name)
 355 {
 356         os << "\n\\begin_inset " << name;
 357 }
 358
 359
 360 void end_inset(ostream & os)
 361 {
 362         os << "\n\\end_inset\n\n";
 363 }
 364
 365
 366 void skip_braces(Parser & p)
 367 {
 368         if (p.next_token().cat() != catBegin)
 369                 return;
 370         p.get_token();
 371         if (p.next_token().cat() == catEnd) {
 372                 p.get_token();
 373                 return;
 374         }
 375         p.putback();
 376 }
 377
 378
 379 void handle_ert(ostream & os, string const & s, Context & context)
 380 {
 381         // We must have a valid layout before outputting the ERT inset.
 382         context.check_layout(os);
 383         Context newcontext(true, context.textclass);
 384         begin_inset(os, "ERT");
 385         os << "\nstatus collapsed\n";
 386         newcontext.check_layout(os);
 387         for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
 388                 if (*it == '\\')
 389                         os << "\n\\backslash\n";
 390                 else if (*it == '\n') {
 391                         newcontext.new_paragraph(os);
 392                         newcontext.check_layout(os);
 393                 } else
 394                         os << *it;
 395         }
 396         newcontext.check_end_layout(os);
 397         end_inset(os);
 398 }
 399
 400
 401 void handle_comment(ostream & os, string const & s, Context & context)
 402 {
 403         // TODO: Handle this better
 404         Context newcontext(true, context.textclass);
 405         begin_inset(os, "ERT");
 406         os << "\nstatus collapsed\n";
 407         newcontext.check_layout(os);
 408         for (string::const_iterator it = s.begin(), et = s.end(); it != et; ++it) {
 409                 if (*it == '\\')
 410                         os << "\n\\backslash\n";
 411                 else
 412                         os << *it;
 413         }
 414         // make sure that our comment is the last thing on the line
 415         newcontext.new_paragraph(os);
 416         newcontext.check_layout(os);
 417         newcontext.check_end_layout(os);
 418         end_inset(os);
 419 }
 420
 421
 422 class isLayout : public std::unary_function<LyXLayout_ptr, bool> {
 423 public:
 424         isLayout(string const name) : name_(name) {}
 425         bool operator()(LyXLayout_ptr const & ptr) const {
 426                 return ptr->latexname() == name_;
 427         }
 428 private:
 429         string const name_;
 430 };
 431
 432
 433 LyXLayout_ptr findLayout(LyXTextClass const & textclass,
 434                          string const & name)
 435 {
 436         LyXTextClass::const_iterator beg = textclass.begin();
 437         LyXTextClass::const_iterator end = textclass.end();
 438
 439         LyXTextClass::const_iterator
 440                 it = std::find_if(beg, end, isLayout(name));
 441
 442         return (it == end) ? LyXLayout_ptr() : *it;
 443 }
 444
 445
 446 void eat_whitespace(Parser &, ostream &, Context &, bool);
 447
 448
 449 void output_command_layout(ostream & os, Parser & p, bool outer,
 450                            Context & parent_context,
 451                            LyXLayout_ptr newlayout)
 452 {
 453         parent_context.check_end_layout(os);
 454         Context context(true, parent_context.textclass, newlayout,
 455                         parent_context.layout, parent_context.font);
 456         if (parent_context.deeper_paragraph) {
 457                 // We are beginning a nested environment after a
 458                 // deeper paragraph inside the outer list environment.
 459                 // Therefore we don't need to output a "begin deeper".
 460                 context.need_end_deeper = true;
 461         }
 462         context.check_deeper(os);
 463         context.check_layout(os);
 464         if (context.layout->optionalargs > 0) {
 465                 eat_whitespace(p, os, context, false);
 466                 if (p.next_token().character() == '[') {
 467                         p.get_token(); // eat '['
 468                         begin_inset(os, "OptArg\n");
 469                         os << "status collapsed\n\n";
 470                         parse_text_in_inset(p, os, FLAG_BRACK_LAST, outer, context);
 471                         end_inset(os);
 472                         eat_whitespace(p, os, context, false);
 473                 }
 474         }
 475         parse_text(p, os, FLAG_ITEM, outer, context);
 476         context.check_end_layout(os);
 477         if (parent_context.deeper_paragraph) {
 478                 // We must suppress the "end deeper" because we
 479                 // suppressed the "begin deeper" above.
 480                 context.need_end_deeper = false;
 481         }
 482         context.check_end_deeper(os);
 483         // We don't need really a new paragraph, but
 484         // we must make sure that the next item gets a \begin_layout.
 485         parent_context.new_paragraph(os);
 486 }
 487
 488
 489 /*!
 490  * Output a space if necessary.
 491  * This function gets called for every whitespace token.
 492  *
 493  * We have three cases here:
 494  * 1. A space must be suppressed. Example: The lyxcode case below
 495  * 2. A space may be suppressed. Example: Spaces before "\par"
 496  * 3. A space must not be suppressed. Example: A space between two words
 497  *
 498  * We currently handle only 1. and 3 and from 2. only the case of
 499  * spaces before newlines as a side effect.
 500  *
 501  * 2. could be used to suppress as many spaces as possible. This has two effects:
 502  * - Reimporting LyX generated LaTeX files changes almost no whitespace
 503  * - Superflous whitespace from non LyX generated LaTeX files is removed.
 504  * The drawback is that the logic inside the function becomes
 505  * complicated, and that is the reason why it is not implemented.
 506  */
 507 void check_space(Parser const & p, ostream & os, Context & context)
 508 {
 509         Token const next = p.next_token();
 510         Token const curr = p.curr_token();
 511         // A space before a single newline and vice versa must be ignored
 512         // LyX emits a newline before \end{lyxcode}.
 513         // This newline must be ignored,
 514         // otherwise LyX will add an additional protected space.
 515         if (next.cat() == catSpace ||
 516             next.cat() == catNewline ||
 517             (next.cs() == "end" && context.layout->free_spacing && curr.cat() == catNewline)) {
 518                 return;
 519         }
 520         context.check_layout(os);
 521         os << ' ';
 522 }
 523
 524
 525 /*!
 526  * Parse all arguments of \p command
 527  */
 528 void parse_arguments(string const & command,
 529                      vector<ArgumentType> const & template_arguments,
 530                      Parser & p, ostream & os, bool outer, Context & context)
 531 {
 532         string ert = command;
 533         size_t no_arguments = template_arguments.size();
 534         for (size_t i = 0; i < no_arguments; ++i) {
 535                 switch (template_arguments[i]) {
 536                 case required:
 537                         // This argument contains regular LaTeX
 538                         handle_ert(os, ert + '{', context);
 539                         eat_whitespace(p, os, context, false);
 540                         parse_text(p, os, FLAG_ITEM, outer, context);
 541                         ert = "}";
 542                         break;
 543                 case verbatim:
 544                         // This argument may contain special characters
 545                         ert += '{' + p.verbatim_item() + '}';
 546                         break;
 547                 case optional:
 548                         ert += p.getOpt();
 549                         break;
 550                 }
 551         }
 552         handle_ert(os, ert, context);
 553 }
 554
 555
 556 /*!
 557  * Check whether \p command is a known command. If yes,
 558  * handle the command with all arguments.
 559  * \return true if the command was parsed, false otherwise.
 560  */
 561 bool parse_command(string const & command, Parser & p, ostream & os,
 562                    bool outer, Context & context)
 563 {
 564         if (known_commands.find(command) != known_commands.end()) {
 565                 parse_arguments(command, known_commands[command], p, os,
 566                                 outer, context);
 567                 return true;
 568         }
 569         return false;
 570 }
 571
 572
 573 /// Parses a minipage or parbox
 574 void parse_box(Parser & p, ostream & os, unsigned flags, bool outer,
 575                Context & parent_context, bool use_parbox)
 576 {
 577         string position;
 578         string inner_pos;
 579         string height_value = "0";
 580         string height_unit = "pt";
 581         string height_special = "none";
 582         string latex_height;
 583         if (p.next_token().asInput() == "[") {
 584                 position = p.getArg('[', ']');
 585                 if (position != "t" && position != "c" && position != "b") {
 586                         position = "c";
 587                         cerr << "invalid position for minipage/parbox" << endl;
 588                 }
 589                 if (p.next_token().asInput() == "[") {
 590                         latex_height = p.getArg('[', ']');
 591                         translate_box_len(latex_height, height_value, height_unit, height_special);
 592
 593                         if (p.next_token().asInput() == "[") {
 594                                 inner_pos = p.getArg('[', ']');
 595                                 if (inner_pos != "c" && inner_pos != "t" &&
 596                                     inner_pos != "b" && inner_pos != "s") {
 597                                         inner_pos = position;
 598                                         cerr << "invalid inner_pos for minipage/parbox"
 599                                              << endl;
 600                                 }
 601                         }
 602                 }
 603         }
 604         string width_value;
 605         string width_unit;
 606         string const latex_width = p.verbatim_item();
 607         translate_len(latex_width, width_value, width_unit);
 608         if (contains(width_unit, '\\') || contains(height_unit, '\\')) {
 609                 // LyX can't handle length variables
 610                 ostringstream ss;
 611                 if (use_parbox)
 612                         ss << "\\parbox";
 613                 else
 614                         ss << "\\begin{minipage}";
 615                 if (!position.empty())
 616                         ss << '[' << position << ']';
 617                 if (!latex_height.empty())
 618                         ss << '[' << latex_height << ']';
 619                 if (!inner_pos.empty())
 620                         ss << '[' << inner_pos << ']';
 621                 ss << "{" << latex_width << "}";
 622                 if (use_parbox)
 623                         ss << '{';
 624                 handle_ert(os, ss.str(), parent_context);
 625                 parent_context.new_paragraph(os);
 626                 parse_text_in_inset(p, os, flags, outer, parent_context);
 627                 if (use_parbox)
 628                         handle_ert(os, "}", parent_context);
 629                 else
 630                         handle_ert(os, "\\end{minipage}", parent_context);
 631         } else {
 632                 // LyX does not like empty positions, so we have
 633                 // to set them to the LaTeX default values here.
 634                 if (position.empty())
 635                         position = "c";
 636                 if (inner_pos.empty())
 637                         inner_pos = position;
 638                 parent_context.check_layout(os);
 639                 begin_inset(os, "Box Frameless\n");
 640                 os << "position \"" << position << "\"\n";
 641                 os << "hor_pos \"c\"\n";
 642                 os << "has_inner_box 1\n";
 643                 os << "inner_pos \"" << inner_pos << "\"\n";
 644                 os << "use_parbox " << use_parbox << "\n";
 645                 os << "width \"" << width_value << width_unit << "\"\n";
 646                 os << "special \"none\"\n";
 647                 os << "height \"" << height_value << height_unit << "\"\n";
 648                 os << "height_special \"" << height_special << "\"\n";
 649                 os << "status open\n\n";
 650                 parse_text_in_inset(p, os, flags, outer, parent_context);
 651                 end_inset(os);
 652 #ifdef PRESERVE_LAYOUT
 653                 // lyx puts a % after the end of the minipage
 654                 if (p.next_token().cat() == catNewline && p.next_token().cs().size() > 1) {
 655                         // new paragraph
 656                         //handle_comment(os, "%dummy", parent_context);
 657                         p.get_token();
 658                         p.skip_spaces();
 659                         parent_context.new_paragraph(os);
 660                 }
 661                 else if (p.next_token().cat() == catSpace || p.next_token().cat() == catNewline) {
 662                         //handle_comment(os, "%dummy", parent_context);
 663                         p.get_token();
 664                         p.skip_spaces();
 665                         // We add a protected space if something real follows
 666                         if (p.good() && p.next_token().cat() != catComment) {
 667                                 os << "\\InsetSpace ~\n";
 668                         }
 669                 }
 670 #endif
 671         }
 672 }
 673
 674
 675 /// parse an unknown environment
 676 void parse_unknown_environment(Parser & p, string const & name, ostream & os,
 677                                unsigned flags, bool outer,
 678                                Context & parent_context)
 679 {
 680         if (name == "tabbing")
 681                 // We need to remember that we have to handle '\=' specially
 682                 flags |= FLAG_TABBING;
 683
 684         // We need to translate font changes and paragraphs inside the
 685         // environment to ERT if we have a non standard font.
 686         // Otherwise things like
 687         // \large\begin{foo}\huge bar\end{foo}
 688         // will not work.
 689         bool const specialfont =
 690                 (parent_context.font != parent_context.normalfont);
 691         bool const new_layout_allowed = parent_context.new_layout_allowed;
 692         if (specialfont)
 693                 parent_context.new_layout_allowed = false;
 694         handle_ert(os, "\\begin{" + name + "}", parent_context);
 695         parse_text_snippet(p, os, flags, outer, parent_context);
 696         handle_ert(os, "\\end{" + name + "}", parent_context);
 697         if (specialfont)
 698                 parent_context.new_layout_allowed = new_layout_allowed;
 699 }
 700
 701
 702 void parse_environment(Parser & p, ostream & os, bool outer,
 703                        Context & parent_context)
 704 {
 705         LyXLayout_ptr newlayout;
 706         string const name = p.getArg('{', '}');
 707         const bool is_starred = suffixIs(name, '*');
 708         string const unstarred_name = rtrim(name, "*");
 709         active_environments.push_back(name);
 710
 711         if (is_math_env(name)) {
 712                 parent_context.check_layout(os);
 713                 begin_inset(os, "Formula ");
 714                 os << "\\begin{" << name << "}";
 715                 parse_math(p, os, FLAG_END, MATH_MODE);
 716                 os << "\\end{" << name << "}";
 717                 end_inset(os);
 718         }
 719
 720         else if (name == "tabular" || name == "longtable") {
 721                 eat_whitespace(p, os, parent_context, false);
 722                 parent_context.check_layout(os);
 723                 begin_inset(os, "Tabular ");
 724                 handle_tabular(p, os, name == "longtable", parent_context);
 725                 end_inset(os);
 726                 p.skip_spaces();
 727         }
 728
 729         else if (parent_context.textclass.floats().typeExist(unstarred_name)) {
 730                 eat_whitespace(p, os, parent_context, false);
 731                 parent_context.check_layout(os);
 732                 begin_inset(os, "Float " + unstarred_name + "\n");
 733                 if (p.next_token().asInput() == "[") {
 734                         os << "placement " << p.getArg('[', ']') << '\n';
 735                 }
 736                 os << "wide " << convert<string>(is_starred)
 737                    << "\nsideways false"
 738                    << "\nstatus open\n\n";
 739                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
 740                 end_inset(os);
 741                 // We don't need really a new paragraph, but
 742                 // we must make sure that the next item gets a \begin_layout.
 743                 parent_context.new_paragraph(os);
 744                 p.skip_spaces();
 745         }
 746
 747         else if (name == "minipage") {
 748                 eat_whitespace(p, os, parent_context, false);
 749                 parse_box(p, os, FLAG_END, outer, parent_context, false);
 750                 p.skip_spaces();
 751         }
 752
 753         else if (name == "comment") {
 754                 eat_whitespace(p, os, parent_context, false);
 755                 parent_context.check_layout(os);
 756                 begin_inset(os, "Note Comment\n");
 757                 os << "status open\n";
 758                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
 759                 end_inset(os);
 760                 p.skip_spaces();
 761         }
 762
 763         else if (name == "lyxgreyedout") {
 764                 eat_whitespace(p, os, parent_context, false);
 765                 parent_context.check_layout(os);
 766                 begin_inset(os, "Note Greyedout\n");
 767                 os << "status open\n";
 768                 parse_text_in_inset(p, os, FLAG_END, outer, parent_context);
 769                 end_inset(os);
 770                 p.skip_spaces();
 771         }
 772
 773         else if (!parent_context.new_layout_allowed)
 774                 parse_unknown_environment(p, name, os, FLAG_END, outer,
 775                                           parent_context);
 776
 777         // Alignment settings
 778         else if (name == "center" || name == "flushleft" || name == "flushright" ||
 779                  name == "centering" || name == "raggedright" || name == "raggedleft") {
 780                 eat_whitespace(p, os, parent_context, false);
 781                 // We must begin a new paragraph if not already done
 782                 if (! parent_context.atParagraphStart()) {
 783                         parent_context.check_end_layout(os);
 784                         parent_context.new_paragraph(os);
 785                 }
 786                 if (name == "flushleft" || name == "raggedright")
 787                         parent_context.add_extra_stuff("\\align left\n");
 788                 else if (name == "flushright" || name == "raggedleft")
 789                         parent_context.add_extra_stuff("\\align right\n");
 790                 else
 791                         parent_context.add_extra_stuff("\\align center\n");
 792                 parse_text(p, os, FLAG_END, outer, parent_context);
 793                 // Just in case the environment is empty ..
 794                 parent_context.extra_stuff.erase();
 795                 // We must begin a new paragraph to reset the alignment
 796                 parent_context.new_paragraph(os);
 797                 p.skip_spaces();
 798         }
 799
 800         // The single '=' is meant here.
 801         else if ((newlayout = findLayout(parent_context.textclass, name)).get() &&
 802                   newlayout->isEnvironment()) {
 803                 eat_whitespace(p, os, parent_context, false);
 804                 Context context(true, parent_context.textclass, newlayout,
 805                                 parent_context.layout, parent_context.font);
 806                 if (parent_context.deeper_paragraph) {
 807                         // We are beginning a nested environment after a
 808                         // deeper paragraph inside the outer list environment.
 809                         // Therefore we don't need to output a "begin deeper".
 810                         context.need_end_deeper = true;
 811                 }
 812                 parent_context.check_end_layout(os);
 813                 switch (context.layout->latextype) {
 814                 case  LATEX_LIST_ENVIRONMENT:
 815                         context.extra_stuff = "\\labelwidthstring "
 816                                 + p.verbatim_item() + '\n';
 817                         p.skip_spaces();
 818                         break;
 819                 case  LATEX_BIB_ENVIRONMENT:
 820                         p.verbatim_item(); // swallow next arg
 821                         p.skip_spaces();
 822                         break;
 823                 default:
 824                         break;
 825                 }
 826                 context.check_deeper(os);
 827                 parse_text(p, os, FLAG_END, outer, context);
 828                 context.check_end_layout(os);
 829                 if (parent_context.deeper_paragraph) {
 830                         // We must suppress the "end deeper" because we
 831                         // suppressed the "begin deeper" above.
 832                         context.need_end_deeper = false;
 833                 }
 834                 context.check_end_deeper(os);
 835                 parent_context.new_paragraph(os);
 836                 p.skip_spaces();
 837         }
 838
 839         else if (name == "appendix") {
 840                 // This is no good latex style, but it works and is used in some documents...
 841                 eat_whitespace(p, os, parent_context, false);
 842                 parent_context.check_end_layout(os);
 843                 Context context(true, parent_context.textclass, parent_context.layout,
 844                                 parent_context.layout, parent_context.font);
 845                 context.check_layout(os);
 846                 os << "\\start_of_appendix\n";
 847                 parse_text(p, os, FLAG_END, outer, context);
 848                 context.check_end_layout(os);
 849                 p.skip_spaces();
 850         }
 851
 852         else if (known_environments.find(name) != known_environments.end()) {
 853                 vector<ArgumentType> arguments = known_environments[name];
 854                 // The last "argument" denotes wether we may translate the
 855                 // environment contents to LyX
 856                 // The default required if no argument is given makes us
 857                 // compatible with the reLyXre environment.
 858                 ArgumentType contents = arguments.empty() ?
 859                         required :
 860                         arguments.back();
 861                 if (!arguments.empty())
 862                         arguments.pop_back();
 863                 // See comment in parse_unknown_environment()
 864                 bool const specialfont =
 865                         (parent_context.font != parent_context.normalfont);
 866                 bool const new_layout_allowed =
 867                         parent_context.new_layout_allowed;
 868                 if (specialfont)
 869                         parent_context.new_layout_allowed = false;
 870                 parse_arguments("\\begin{" + name + "}", arguments, p, os,
 871                                 outer, parent_context);
 872                 if (contents == verbatim)
 873                         handle_ert(os, p.verbatimEnvironment(name),
 874                                    parent_context);
 875                 else
 876                         parse_text_snippet(p, os, FLAG_END, outer,
 877                                            parent_context);
 878                 handle_ert(os, "\\end{" + name + "}", parent_context);
 879                 if (specialfont)
 880                         parent_context.new_layout_allowed = new_layout_allowed;
 881         }
 882
 883         else
 884                 parse_unknown_environment(p, name, os, FLAG_END, outer,
 885                                           parent_context);
 886
 887         active_environments.pop_back();
 888 }
 889
 890
 891 /// parses a comment and outputs it to \p os.
 892 void parse_comment(Parser & p, ostream & os, Token const & t, Context & context)
 893 {
 894         BOOST_ASSERT(t.cat() == catComment);
 895         if (!t.cs().empty()) {
 896                 context.check_layout(os);
 897                 handle_comment(os, '%' + t.cs(), context);
 898                 if (p.next_token().cat() == catNewline) {
 899                         // A newline after a comment line starts a new
 900                         // paragraph
 901                         if (context.new_layout_allowed) {
 902                                 if(!context.atParagraphStart())
 903                                         // Only start a new paragraph if not already
 904                                         // done (we might get called recursively)
 905                                         context.new_paragraph(os);
 906                         } else
 907                                 handle_ert(os, "\n", context);
 908                         eat_whitespace(p, os, context, true);
 909                 }
 910         } else {
 911                 // "%\n" combination
 912                 p.skip_spaces();
 913         }
 914 }
 915
 916
 917 /*!
 918  * Reads spaces and comments until the first non-space, non-comment token.
 919  * New paragraphs (double newlines or \\par) are handled like simple spaces
 920  * if \p eatParagraph is true.
 921  * Spaces are skipped, but comments are written to \p os.
 922  */
 923 void eat_whitespace(Parser & p, ostream & os, Context & context,
 924                     bool eatParagraph)
 925 {
 926         while (p.good()) {
 927                 Token const & t = p.get_token();
 928                 if (t.cat() == catComment)
 929                         parse_comment(p, os, t, context);
 930                 else if ((! eatParagraph && p.isParagraph()) ||
 931                          (t.cat() != catSpace && t.cat() != catNewline)) {
 932                         p.putback();
 933                         return;
 934                 }
 935         }
 936 }
 937
 938
 939 /*!
 940  * Set a font attribute, parse text and reset the font attribute.
 941  * \param attribute Attribute name (e.g. \\family, \\shape etc.)
 942  * \param currentvalue Current value of the attribute. Is set to the new
 943  * value during parsing.
 944  * \param newvalue New value of the attribute
 945  */
 946 void parse_text_attributes(Parser & p, ostream & os, unsigned flags, bool outer,
 947                            Context & context, string const & attribute,
 948                            string & currentvalue, string const & newvalue)
 949 {
 950         context.check_layout(os);
 951         string const oldvalue = currentvalue;
 952         currentvalue = newvalue;
 953         os << '\n' << attribute << ' ' << newvalue << "\n";
 954         parse_text_snippet(p, os, flags, outer, context);
 955         context.check_layout(os);
 956         os << '\n' << attribute << ' ' << oldvalue << "\n";
 957         currentvalue = oldvalue;
 958 }
 959
 960
 961 /// get the arguments of a natbib or jurabib citation command
 962 std::pair<string, string> getCiteArguments(Parser & p, bool natbibOrder)
 963 {
 964         // We need to distinguish "" and "[]", so we can't use p.getOpt().
 965
 966         // text before the citation
 967         string before;
 968         // text after the citation
 969         string after = p.getFullOpt();
 970
 971         if (!after.empty()) {
 972                 before = p.getFullOpt();
 973                 if (natbibOrder && !before.empty())
 974                         std::swap(before, after);
 975         }
 976         return std::make_pair(before, after);
 977 }
 978
 979
 980 /// Convert filenames with TeX macros and/or quotes to something LyX can understand
 981 string const normalize_filename(string const & name)
 982 {
 983         Parser p(trim(name, "\""));
 984         ostringstream os;
 985         while (p.good()) {
 986                 Token const & t = p.get_token();
 987                 if (t.cat() != catEscape)
 988                         os << t.asInput();
 989                 else if (t.cs() == "lyxdot") {
 990                         // This is used by LyX for simple dots in relative
 991                         // names
 992                         os << '.';
 993                         p.skip_spaces();
 994                 } else if (t.cs() == "space") {
 995                         os << ' ';
 996                         p.skip_spaces();
 997                 } else
 998                         os << t.asInput();
 999         }
1000         return os.str();
1001 }
1002
1003
1004 /// Convert \p name from TeX convention (relative to master file) to LyX
1005 /// convention (relative to .lyx file) if it is relative
1006 void fix_relative_filename(string & name)
1007 {
1008         if (lyx::support::absolutePath(name))
1009                 return;
1010         name = makeRelPath(makeAbsPath(name, getMasterFilePath()),
1011                            getParentFilePath());
1012 }
1013
1014
1015 /// Parse a NoWeb Scrap section. The initial "<<" is already parsed.
1016 void parse_noweb(Parser & p, ostream & os, Context & context)
1017 {
1018         // assemble the rest of the keyword
1019         string name("<<");
1020         bool scrap = false;
1021         while (p.good()) {
1022                 Token const & t = p.get_token();
1023                 if (t.asInput() == ">" && p.next_token().asInput() == ">") {
1024                         name += ">>";
1025                         p.get_token();
1026                         scrap = (p.good() && p.next_token().asInput() == "=");
1027                         if (scrap)
1028                                 name += p.get_token().asInput();
1029                         break;
1030                 }
1031                 name += t.asInput();
1032         }
1033
1034         if (!scrap || !context.new_layout_allowed ||
1035             !context.textclass.hasLayout("Scrap")) {
1036                 cerr << "Warning: Could not interpret '" << name
1037                      << "'. Ignoring it." << endl;
1038                 return;
1039         }
1040
1041         context.check_end_layout(os);
1042         Context newcontext(true, context.textclass, context.textclass["Scrap"]);
1043         newcontext.check_layout(os);
1044         os << name;
1045         while (p.good()) {
1046                 Token const & t = p.get_token();
1047                 // We abuse the parser a bit, because this is no TeX syntax
1048                 // at all.
1049                 if (t.cat() == catEscape)
1050                         os << subst(t.asInput(), "\\", "\n\\backslash\n");
1051                 else
1052                         os << subst(t.asInput(), "\n", "\n\\newline\n");
1053                 // The scrap chunk is ended by an @ at the beginning of a line.
1054                 // After the @ the line may contain a comment and/or
1055                 // whitespace, but nothing else.
1056                 if (t.asInput() == "@" && p.prev_token().cat() == catNewline &&
1057                     (p.next_token().cat() == catSpace ||
1058                      p.next_token().cat() == catNewline ||
1059                      p.next_token().cat() == catComment)) {
1060                         while (p.good() && p.next_token().cat() == catSpace)
1061                                 os << p.get_token().asInput();
1062                         if (p.next_token().cat() == catComment)
1063                                 // The comment includes a final '\n'
1064                                 os << p.get_token().asInput();
1065                         else {
1066                                 if (p.next_token().cat() == catNewline)
1067                                         p.get_token();
1068                                 os << '\n';
1069                         }
1070                         break;
1071                 }
1072         }
1073         newcontext.check_end_layout(os);
1074 }
1075
1076 } // anonymous namespace
1077
1078
1079 void parse_text(Parser & p, ostream & os, unsigned flags, bool outer,
1080                 Context & context)
1081 {
1082         LyXLayout_ptr newlayout;
1083         // Store the latest bibliographystyle (needed for bibtex inset)
1084         string bibliographystyle;
1085         bool const use_natbib = used_packages.find("natbib") != used_packages.end();
1086         bool const use_jurabib = used_packages.find("jurabib") != used_packages.end();
1087         while (p.good()) {
1088                 Token const & t = p.get_token();
1089
1090 #ifdef FILEDEBUG
1091                 cerr << "t: " << t << " flags: " << flags << "\n";
1092 #endif
1093
1094                 if (flags & FLAG_ITEM) {
1095                         if (t.cat() == catSpace)
1096                                 continue;
1097
1098                         flags &= ~FLAG_ITEM;
1099                         if (t.cat() == catBegin) {
1100                                 // skip the brace and collect everything to the next matching
1101                                 // closing brace
1102                                 flags |= FLAG_BRACE_LAST;
1103                                 continue;
1104                         }
1105
1106                         // handle only this single token, leave the loop if done
1107                         flags |= FLAG_LEAVE;
1108                 }
1109
1110                 if (t.character() == ']' && (flags & FLAG_BRACK_LAST))
1111                         return;
1112
1113                 //
1114                 // cat codes
1115                 //
1116                 if (t.cat() == catMath) {
1117                         // we are inside some text mode thingy, so opening new math is allowed
1118                         context.check_layout(os);
1119                         begin_inset(os, "Formula ");
1120                         Token const & n = p.get_token();
1121                         if (n.cat() == catMath && outer) {
1122                                 // TeX's $$...$$ syntax for displayed math
1123                                 os << "\\[";
1124                                 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
1125                                 os << "\\]";
1126                                 p.get_token(); // skip the second '$' token
1127                         } else {
1128                                 // simple $...$  stuff
1129                                 p.putback();
1130                                 os << '$';
1131                                 parse_math(p, os, FLAG_SIMPLE, MATH_MODE);
1132                                 os << '$';
1133                         }
1134                         end_inset(os);
1135                 }
1136
1137                 else if (t.cat() == catSuper || t.cat() == catSub)
1138                         cerr << "catcode " << t << " illegal in text mode\n";
1139
1140                 // Basic support for english quotes. This should be
1141                 // extended to other quotes, but is not so easy (a
1142                 // left english quote is the same as a right german
1143                 // quote...)
1144                 else if (t.asInput() == "`"
1145                          && p.next_token().asInput() == "`") {
1146                         context.check_layout(os);
1147                         begin_inset(os, "Quotes ");
1148                         os << "eld";
1149                         end_inset(os);
1150                         p.get_token();
1151                         skip_braces(p);
1152                 }
1153                 else if (t.asInput() == "'"
1154                          && p.next_token().asInput() == "'") {
1155                         context.check_layout(os);
1156                         begin_inset(os, "Quotes ");
1157                         os << "erd";
1158                         end_inset(os);
1159                         p.get_token();
1160                         skip_braces(p);
1161                 }
1162
1163                 else if (t.asInput() == "<"
1164                          && p.next_token().asInput() == "<" && noweb_mode) {
1165                         p.get_token();
1166                         parse_noweb(p, os, context);
1167                 }
1168
1169                 else if (t.cat() == catSpace || (t.cat() == catNewline && ! p.isParagraph()))
1170                         check_space(p, os, context);
1171
1172                 else if (t.character() == '[' && noweb_mode &&
1173                          p.next_token().character() == '[') {
1174                         // These can contain underscores
1175                         p.putback();
1176                         string const s = p.getFullOpt() + ']';
1177                         if (p.next_token().character() == ']')
1178                                 p.get_token();
1179                         else
1180                                 cerr << "Warning: Inserting missing ']' in '"
1181                                      << s << "'." << endl;
1182                         handle_ert(os, s, context);
1183                 }
1184
1185                 else if (t.cat() == catLetter ||
1186                                t.cat() == catOther ||
1187                                t.cat() == catAlign ||
1188                                t.cat() == catParameter) {
1189                         // This translates "&" to "\\&" which may be wrong...
1190                         context.check_layout(os);
1191                         os << t.character();
1192                 }
1193
1194                 else if (p.isParagraph()) {
1195                         if (context.new_layout_allowed)
1196                                 context.new_paragraph(os);
1197                         else
1198                                 handle_ert(os, "\\par ", context);
1199                         eat_whitespace(p, os, context, true);
1200                 }
1201
1202                 else if (t.cat() == catActive) {
1203                         context.check_layout(os);
1204                         if (t.character() == '~') {
1205                                 if (context.layout->free_spacing)
1206                                         os << ' ';
1207                                 else
1208                                         os << "\\InsetSpace ~\n";
1209                         } else
1210                                 os << t.character();
1211                 }
1212
1213                 else if (t.cat() == catBegin &&
1214                          p.next_token().cat() == catEnd) {
1215                         // {}
1216                         Token const prev = p.prev_token();
1217                         p.get_token();
1218                         if (p.next_token().character() == '`' ||
1219                             (prev.character() == '-' &&
1220                              p.next_token().character() == '-'))
1221                                 ; // ignore it in {}`` or -{}-
1222                         else
1223                                 handle_ert(os, "{}", context);
1224
1225                 }
1226
1227                 else if (t.cat() == catBegin) {
1228                         context.check_layout(os);
1229                         // special handling of font attribute changes
1230                         Token const prev = p.prev_token();
1231                         Token const next = p.next_token();
1232                         Font const oldFont = context.font;
1233                         if (next.character() == '[' ||
1234                             next.character() == ']' ||
1235                             next.character() == '*') {
1236                                 p.get_token();
1237                                 if (p.next_token().cat() == catEnd) {
1238                                         os << next.character();
1239                                         p.get_token();
1240                                 } else {
1241                                         p.putback();
1242                                         handle_ert(os, "{", context);
1243                                         parse_text_snippet(p, os,
1244                                                         FLAG_BRACE_LAST,
1245                                                         outer, context);
1246                                         handle_ert(os, "}", context);
1247                                 }
1248                         } else if (! context.new_layout_allowed) {
1249                                 handle_ert(os, "{", context);
1250                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1251                                                    outer, context);
1252                                 handle_ert(os, "}", context);
1253                         } else if (is_known(next.cs(), known_sizes)) {
1254                                 // next will change the size, so we must
1255                                 // reset it here
1256                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1257                                                    outer, context);
1258                                 if (!context.atParagraphStart())
1259                                         os << "\n\\size "
1260                                            << context.font.size << "\n";
1261                         } else if (is_known(next.cs(), known_font_families)) {
1262                                 // next will change the font family, so we
1263                                 // must reset it here
1264                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1265                                                    outer, context);
1266                                 if (!context.atParagraphStart())
1267                                         os << "\n\\family "
1268                                            << context.font.family << "\n";
1269                         } else if (is_known(next.cs(), known_font_series)) {
1270                                 // next will change the font series, so we
1271                                 // must reset it here
1272                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1273                                                    outer, context);
1274                                 if (!context.atParagraphStart())
1275                                         os << "\n\\series "
1276                                            << context.font.series << "\n";
1277                         } else if (is_known(next.cs(), known_font_shapes)) {
1278                                 // next will change the font shape, so we
1279                                 // must reset it here
1280                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1281                                                    outer, context);
1282                                 if (!context.atParagraphStart())
1283                                         os << "\n\\shape "
1284                                            << context.font.shape << "\n";
1285                         } else if (is_known(next.cs(), known_old_font_families) ||
1286                                    is_known(next.cs(), known_old_font_series) ||
1287                                    is_known(next.cs(), known_old_font_shapes)) {
1288                                 // next will change the font family, series
1289                                 // and shape, so we must reset it here
1290                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1291                                                    outer, context);
1292                                 if (!context.atParagraphStart())
1293                                         os <<  "\n\\family "
1294                                            << context.font.family
1295                                            << "\n\\series "
1296                                            << context.font.series
1297                                            << "\n\\shape "
1298                                            << context.font.shape << "\n";
1299                         } else {
1300                                 handle_ert(os, "{", context);
1301                                 parse_text_snippet(p, os, FLAG_BRACE_LAST,
1302                                                    outer, context);
1303                                 handle_ert(os, "}", context);
1304                         }
1305                 }
1306
1307                 else if (t.cat() == catEnd) {
1308                         if (flags & FLAG_BRACE_LAST) {
1309                                 return;
1310                         }
1311                         cerr << "stray '}' in text\n";
1312                         handle_ert(os, "}", context);
1313                 }
1314
1315                 else if (t.cat() == catComment)
1316                         parse_comment(p, os, t, context);
1317
1318                 //
1319                 // control sequences
1320                 //
1321
1322                 else if (t.cs() == "(") {
1323                         context.check_layout(os);
1324                         begin_inset(os, "Formula");
1325                         os << " \\(";
1326                         parse_math(p, os, FLAG_SIMPLE2, MATH_MODE);
1327                         os << "\\)";
1328                         end_inset(os);
1329                 }
1330
1331                 else if (t.cs() == "[") {
1332                         context.check_layout(os);
1333                         begin_inset(os, "Formula");
1334                         os << " \\[";
1335                         parse_math(p, os, FLAG_EQUATION, MATH_MODE);
1336                         os << "\\]";
1337                         end_inset(os);
1338                 }
1339
1340                 else if (t.cs() == "begin")
1341                         parse_environment(p, os, outer, context);
1342
1343                 else if (t.cs() == "end") {
1344                         if (flags & FLAG_END) {
1345                                 // eat environment name
1346                                 string const name = p.getArg('{', '}');
1347                                 if (name != active_environment())
1348                                         cerr << "\\end{" + name + "} does not match \\begin{"
1349                                                 + active_environment() + "}\n";
1350                                 return;
1351                         }
1352                         p.error("found 'end' unexpectedly");
1353                 }
1354
1355                 else if (t.cs() == "item") {
1356                         p.skip_spaces();
1357                         string s;
1358                         bool optarg = false;
1359                         if (p.next_token().character() == '[') {
1360                                 p.get_token(); // eat '['
1361                                 s = parse_text_snippet(p, FLAG_BRACK_LAST,
1362                                                        outer, context);
1363                                 optarg = true;
1364                         }
1365                         context.set_item();
1366                         context.check_layout(os);
1367                         if (context.has_item) {
1368                                 // An item in an unknown list-like environment
1369                                 // FIXME: Do this in check_layout()!
1370                                 context.has_item = false;
1371                                 if (optarg)
1372                                         handle_ert(os, "\\item", context);
1373                                 else
1374                                         handle_ert(os, "\\item ", context);
1375                         }
1376                         if (optarg) {
1377                                 if (context.layout->labeltype != LABEL_MANUAL) {
1378                                         // lyx does not support \item[\mybullet]
1379                                         // in itemize environments
1380                                         handle_ert(os, "[", context);
1381                                         os << s;
1382                                         handle_ert(os, "]", context);
1383                                 } else if (!s.empty()) {
1384                                         // The space is needed to separate the
1385                                         // item from the rest of the sentence.
1386                                         os << s << ' ';
1387                                         eat_whitespace(p, os, context, false);
1388                                 }
1389                         }
1390                 }
1391
1392                 else if (t.cs() == "bibitem") {
1393                         context.set_item();
1394                         context.check_layout(os);
1395                         os << "\\bibitem ";
1396                         os << p.getOpt();
1397                         os << '{' << p.verbatim_item() << '}' << "\n";
1398                 }
1399
1400                 else if (t.cs() == "def") {
1401                         context.check_layout(os);
1402                         eat_whitespace(p, os, context, false);
1403                         string name = p.get_token().cs();
1404                         while (p.next_token().cat() != catBegin)
1405                                 name += p.get_token().asString();
1406                         handle_ert(os, "\\def\\" + name + '{' + p.verbatim_item() + '}', context);
1407                 }
1408
1409                 else if (t.cs() == "noindent") {
1410                         p.skip_spaces();
1411                         context.add_extra_stuff("\\noindent\n");
1412                 }
1413
1414                 else if (t.cs() == "appendix") {
1415                         context.add_extra_stuff("\\start_of_appendix\n");
1416                         // We need to start a new paragraph. Otherwise the
1417                         // appendix in 'bla\appendix\chapter{' would start
1418                         // too late.
1419                         context.new_paragraph(os);
1420                         // We need to make sure that the paragraph is
1421                         // generated even if it is empty. Otherwise the
1422                         // appendix in '\par\appendix\par\chapter{' would
1423                         // start too late.
1424                         context.check_layout(os);
1425                         // FIXME: This is a hack to prevent paragraph
1426                         // deletion if it is empty. Handle this better!
1427                         handle_comment(os,
1428                                 "%dummy comment inserted by tex2lyx to "
1429                                 "ensure that this paragraph is not empty",
1430                                 context);
1431                         // Both measures above may generate an additional
1432                         // empty paragraph, but that does not hurt, because
1433                         // whitespace does not matter here.
1434                         eat_whitespace(p, os, context, true);
1435                 }
1436
1437                 // Must attempt to parse "Section*" before "Section".
1438                 else if ((p.next_token().asInput() == "*") &&
1439                          context.new_layout_allowed &&
1440                          // The single '=' is meant here.
1441                          (newlayout = findLayout(context.textclass,
1442                                                  t.cs() + '*')).get() &&
1443                          newlayout->isCommand()) {
1444                         p.get_token();
1445                         output_command_layout(os, p, outer, context, newlayout);
1446                         p.skip_spaces();
1447                 }
1448
1449                 // The single '=' is meant here.
1450                 else if (context.new_layout_allowed &&
1451                          (newlayout = findLayout(context.textclass, t.cs())).get() &&
1452                          newlayout->isCommand()) {
1453                         output_command_layout(os, p, outer, context, newlayout);
1454                         p.skip_spaces();
1455                 }
1456
1457                 else if (t.cs() == "includegraphics") {
1458                         bool const clip = p.next_token().asInput() == "*";
1459                         if (clip)
1460                                 p.get_token();
1461                         map<string, string> opts = split_map(p.getArg('[', ']'));
1462                         if (clip)
1463                                 opts["clip"] = string();
1464                         string name = normalize_filename(p.verbatim_item());
1465
1466                         string const path = getMasterFilePath();
1467                         // We want to preserve relative / absolute filenames,
1468                         // therefore path is only used for testing
1469                         if (!fs::exists(makeAbsPath(name, path))) {
1470                                 // The file extension is probably missing.
1471                                 // Now try to find it out.
1472                                 string const dvips_name =
1473                                         find_file(name, path,
1474                                                   known_dvips_graphics_formats);
1475                                 string const pdftex_name =
1476                                         find_file(name, path,
1477                                                   known_pdftex_graphics_formats);
1478                                 if (!dvips_name.empty()) {
1479                                         if (!pdftex_name.empty()) {
1480                                                 cerr << "This file contains the "
1481                                                         "latex snippet\n"
1482                                                         "\"\\includegraphics{"
1483                                                      << name << "}\".\n"
1484                                                         "However, files\n\""
1485                                                      << dvips_name << "\" and\n\""
1486                                                      << pdftex_name << "\"\n"
1487                                                         "both exist, so I had to make a "
1488                                                         "choice and took the first one.\n"
1489                                                         "Please move the unwanted one "
1490                                                         "someplace else and try again\n"
1491                                                         "if my choice was wrong."
1492                                                      << endl;
1493                                         }
1494                                         name = dvips_name;
1495                                 } else if (!pdftex_name.empty())
1496                                         name = pdftex_name;
1497                         }
1498
1499                         if (fs::exists(makeAbsPath(name, path)))
1500                                 fix_relative_filename(name);
1501                         else
1502                                 cerr << "Warning: Could not find graphics file '"
1503                                      << name << "'." << endl;
1504
1505                         context.check_layout(os);
1506                         begin_inset(os, "Graphics ");
1507                         os << "\n\tfilename " << name << '\n';
1508                         if (opts.find("width") != opts.end())
1509                                 os << "\twidth "
1510                                    << translate_len(opts["width"]) << '\n';
1511                         if (opts.find("height") != opts.end())
1512                                 os << "\theight "
1513                                    << translate_len(opts["height"]) << '\n';
1514                         if (opts.find("scale") != opts.end()) {
1515                                 istringstream iss(opts["scale"]);
1516                                 double val;
1517                                 iss >> val;
1518                                 val = val*100;
1519                                 os << "\tscale " << val << '\n';
1520                         }
1521                         if (opts.find("angle") != opts.end())
1522                                 os << "\trotateAngle "
1523                                    << opts["angle"] << '\n';
1524                         if (opts.find("origin") != opts.end()) {
1525                                 ostringstream ss;
1526                                 string const opt = opts["origin"];
1527                                 if (opt.find('l') != string::npos) ss << "left";
1528                                 if (opt.find('r') != string::npos) ss << "right";
1529                                 if (opt.find('c') != string::npos) ss << "center";
1530                                 if (opt.find('t') != string::npos) ss << "Top";
1531                                 if (opt.find('b') != string::npos) ss << "Bottom";
1532                                 if (opt.find('B') != string::npos) ss << "Baseline";
1533                                 if (!ss.str().empty())
1534                                         os << "\trotateOrigin " << ss.str() << '\n';
1535                                 else
1536                                         cerr << "Warning: Ignoring unknown includegraphics origin argument '" << opt << "'\n";
1537                         }
1538                         if (opts.find("keepaspectratio") != opts.end())
1539                                 os << "\tkeepAspectRatio\n";
1540                         if (opts.find("clip") != opts.end())
1541                                 os << "\tclip\n";
1542                         if (opts.find("draft") != opts.end())
1543                                 os << "\tdraft\n";
1544                         if (opts.find("bb") != opts.end())
1545                                 os << "\tBoundingBox "
1546                                    << opts["bb"] << '\n';
1547                         int numberOfbbOptions = 0;
1548                         if (opts.find("bbllx") != opts.end())
1549                                 numberOfbbOptions++;
1550                         if (opts.find("bblly") != opts.end())
1551                                 numberOfbbOptions++;
1552                         if (opts.find("bburx") != opts.end())
1553                                 numberOfbbOptions++;
1554                         if (opts.find("bbury") != opts.end())
1555                                 numberOfbbOptions++;
1556                         if (numberOfbbOptions == 4)
1557                                 os << "\tBoundingBox "
1558                                    << opts["bbllx"] << opts["bblly"]
1559                                    << opts["bburx"] << opts["bbury"] << '\n';
1560                         else if (numberOfbbOptions > 0)
1561                                 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
1562                         numberOfbbOptions = 0;
1563                         if (opts.find("natwidth") != opts.end())
1564                                 numberOfbbOptions++;
1565                         if (opts.find("natheight") != opts.end())
1566                                 numberOfbbOptions++;
1567                         if (numberOfbbOptions == 2)
1568                                 os << "\tBoundingBox 0bp 0bp "
1569                                    << opts["natwidth"] << opts["natheight"] << '\n';
1570                         else if (numberOfbbOptions > 0)
1571                                 cerr << "Warning: Ignoring incomplete includegraphics boundingbox arguments.\n";
1572                         ostringstream special;
1573                         if (opts.find("hiresbb") != opts.end())
1574                                 special << "hiresbb,";
1575                         if (opts.find("trim") != opts.end())
1576                                 special << "trim,";
1577                         if (opts.find("viewport") != opts.end())
1578                                 special << "viewport=" << opts["viewport"] << ',';
1579                         if (opts.find("totalheight") != opts.end())
1580                                 special << "totalheight=" << opts["totalheight"] << ',';
1581                         if (opts.find("type") != opts.end())
1582                                 special << "type=" << opts["type"] << ',';
1583                         if (opts.find("ext") != opts.end())
1584                                 special << "ext=" << opts["ext"] << ',';
1585                         if (opts.find("read") != opts.end())
1586                                 special << "read=" << opts["read"] << ',';
1587                         if (opts.find("command") != opts.end())
1588                                 special << "command=" << opts["command"] << ',';
1589                         string s_special = special.str();
1590                         if (!s_special.empty()) {
1591                                 // We had special arguments. Remove the trailing ','.
1592                                 os << "\tspecial " << s_special.substr(0, s_special.size() - 1) << '\n';
1593                         }
1594                         // TODO: Handle the unknown settings better.
1595                         // Warn about invalid options.
1596                         // Check whether some option was given twice.
1597                         end_inset(os);
1598                 }
1599
1600                 else if (t.cs() == "footnote" ||
1601                          (t.cs() == "thanks" && context.layout->intitle)) {
1602                         p.skip_spaces();
1603                         context.check_layout(os);
1604                         begin_inset(os, "Foot\n");
1605                         os << "status collapsed\n\n";
1606                         parse_text_in_inset(p, os, FLAG_ITEM, false, context);
1607                         end_inset(os);
1608                 }
1609
1610                 else if (t.cs() == "marginpar") {
1611                         p.skip_spaces();
1612                         context.check_layout(os);
1613                         begin_inset(os, "Marginal\n");
1614                         os << "status collapsed\n\n";
1615                         parse_text_in_inset(p, os, FLAG_ITEM, false, context);
1616                         end_inset(os);
1617                 }
1618
1619                 else if (t.cs() == "ensuremath") {
1620                         p.skip_spaces();
1621                         context.check_layout(os);
1622                         string const s = p.verbatim_item();
1623                         if (s == "±" || s == "³" || s == "²" || s == "µ")
1624                                 os << s;
1625                         else
1626                                 handle_ert(os, "\\ensuremath{" + s + "}",
1627                                            context);
1628                 }
1629
1630                 else if (t.cs() == "hfill") {
1631                         context.check_layout(os);
1632                         os << "\n\\hfill\n";
1633                         skip_braces(p);
1634                         p.skip_spaces();
1635                 }
1636
1637                 else if (t.cs() == "makeindex" || t.cs() == "maketitle") {
1638                         // FIXME: Somehow prevent title layouts if
1639                         // "maketitle" was not found
1640                         p.skip_spaces();
1641                         skip_braces(p); // swallow this
1642                 }
1643
1644                 else if (t.cs() == "tableofcontents") {
1645                         p.skip_spaces();
1646                         context.check_layout(os);
1647                         begin_inset(os, "LatexCommand \\tableofcontents\n");
1648                         end_inset(os);
1649                         skip_braces(p); // swallow this
1650                 }
1651
1652                 else if (t.cs() == "listoffigures") {
1653                         p.skip_spaces();
1654                         context.check_layout(os);
1655                         begin_inset(os, "FloatList figure\n");
1656                         end_inset(os);
1657                         skip_braces(p); // swallow this
1658                 }
1659
1660                 else if (t.cs() == "listoftables") {
1661                         p.skip_spaces();
1662                         context.check_layout(os);
1663                         begin_inset(os, "FloatList table\n");
1664                         end_inset(os);
1665                         skip_braces(p); // swallow this
1666                 }
1667
1668                 else if (t.cs() == "listof") {
1669                         p.skip_spaces(true);
1670                         string const name = p.get_token().asString();
1671                         if (context.textclass.floats().typeExist(name)) {
1672                                 context.check_layout(os);
1673                                 begin_inset(os, "FloatList ");
1674                                 os << name << "\n";
1675                                 end_inset(os);
1676                                 p.get_token(); // swallow second arg
1677                         } else
1678                                 handle_ert(os, "\\listof{" + name + "}", context);
1679                 }
1680
1681                 else if (t.cs() == "textrm")
1682                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1683                                               context, "\\family",
1684                                               context.font.family, "roman");
1685
1686                 else if (t.cs() == "textsf")
1687                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1688                                               context, "\\family",
1689                                               context.font.family, "sans");
1690
1691                 else if (t.cs() == "texttt")
1692                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1693                                               context, "\\family",
1694                                               context.font.family, "typewriter");
1695
1696                 else if (t.cs() == "textmd")
1697                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1698                                               context, "\\series",
1699                                               context.font.series, "medium");
1700
1701                 else if (t.cs() == "textbf")
1702                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1703                                               context, "\\series",
1704                                               context.font.series, "bold");
1705
1706                 else if (t.cs() == "textup")
1707                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1708                                               context, "\\shape",
1709                                               context.font.shape, "up");
1710
1711                 else if (t.cs() == "textit")
1712                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1713                                               context, "\\shape",
1714                                               context.font.shape, "italic");
1715
1716                 else if (t.cs() == "textsl")
1717                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1718                                               context, "\\shape",
1719                                               context.font.shape, "slanted");
1720
1721                 else if (t.cs() == "textsc")
1722                         parse_text_attributes(p, os, FLAG_ITEM, outer,
1723                                               context, "\\shape",
1724                                               context.font.shape, "smallcaps");
1725
1726                 else if (t.cs() == "textnormal" || t.cs() == "normalfont") {
1727                         context.check_layout(os);
1728                         Font oldFont = context.font;
1729                         context.font.init();
1730                         context.font.size = oldFont.size;
1731                         os << "\n\\family " << context.font.family << "\n";
1732                         os << "\n\\series " << context.font.series << "\n";
1733                         os << "\n\\shape " << context.font.shape << "\n";
1734                         if (t.cs() == "textnormal") {
1735                                 parse_text_snippet(p, os, FLAG_ITEM, outer, context);
1736                                 output_font_change(os, context.font, oldFont);
1737                                 context.font = oldFont;
1738                         } else
1739                                 eat_whitespace(p, os, context, false);
1740                 }
1741
1742                 else if (t.cs() == "underbar") {
1743                         // Do NOT handle \underline.
1744                         // \underbar cuts through y, g, q, p etc.,
1745                         // \underline does not.
1746                         context.check_layout(os);
1747                         os << "\n\\bar under\n";
1748                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
1749                         context.check_layout(os);
1750                         os << "\n\\bar default\n";
1751                 }
1752
1753                 else if (t.cs() == "emph" || t.cs() == "noun") {
1754                         context.check_layout(os);
1755                         os << "\n\\" << t.cs() << " on\n";
1756                         parse_text_snippet(p, os, FLAG_ITEM, outer, context);
1757                         context.check_layout(os);
1758                         os << "\n\\" << t.cs() << " default\n";
1759                 }
1760
1761                 else if (use_natbib &&
1762                          is_known(t.cs(), known_natbib_commands) &&
1763                          ((t.cs() != "citefullauthor" &&
1764                            t.cs() != "citeyear" &&
1765                            t.cs() != "citeyearpar") ||
1766                           p.next_token().asInput() != "*")) {
1767                         context.check_layout(os);
1768                         // tex                       lyx
1769                         // \citet[before][after]{a}  \citet[after][before]{a}
1770                         // \citet[before][]{a}       \citet[][before]{a}
1771                         // \citet[after]{a}          \citet[after]{a}
1772                         // \citet{a}                 \citet{a}
1773                         string command = '\\' + t.cs();
1774                         if (p.next_token().asInput() == "*") {
1775                                 command += '*';
1776                                 p.get_token();
1777                         }
1778                         if (command == "\\citefullauthor")
1779                                 // alternative name for "\\citeauthor*"
1780                                 command = "\\citeauthor*";
1781
1782                         // text before the citation
1783                         string before;
1784                         // text after the citation
1785                         string after;
1786
1787                         boost::tie(before, after) = getCiteArguments(p, true);
1788                         if (command == "\\cite") {
1789                                 // \cite without optional argument means
1790                                 // \citet, \cite with at least one optional
1791                                 // argument means \citep.
1792                                 if (before.empty() && after.empty())
1793                                         command = "\\citet";
1794                                 else
1795                                         command = "\\citep";
1796                         }
1797                         if (before.empty() && after == "[]")
1798                                 // avoid \citet[]{a}
1799                                 after.erase();
1800                         else if (before == "[]" && after == "[]") {
1801                                 // avoid \citet[][]{a}
1802                                 before.erase();
1803                                 after.erase();
1804                         }
1805                         begin_inset(os, "LatexCommand ");
1806                         os << command << after << before
1807                            << '{' << p.verbatim_item() << "}\n";
1808                         end_inset(os);
1809                 }
1810
1811                 else if (use_jurabib &&
1812                          is_known(t.cs(), known_jurabib_commands)) {
1813                         context.check_layout(os);
1814                         string const command = '\\' + t.cs();
1815                         char argumentOrder = '\0';
1816                         vector<string> const & options = used_packages["jurabib"];
1817                         if (std::find(options.begin(), options.end(),
1818                                       "natbiborder") != options.end())
1819                                 argumentOrder = 'n';
1820                         else if (std::find(options.begin(), options.end(),
1821                                            "jurabiborder") != options.end())
1822                                 argumentOrder = 'j';
1823
1824                         // text before the citation
1825                         string before;
1826                         // text after the citation
1827                         string after;
1828
1829                         boost::tie(before, after) =
1830                                 getCiteArguments(p, argumentOrder != 'j');
1831                         string const citation = p.verbatim_item();
1832                         if (!before.empty() && argumentOrder == '\0') {
1833                                 cerr << "Warning: Assuming argument order "
1834                                         "of jurabib version 0.6 for\n'"
1835                                      << command << before << after << '{'
1836                                      << citation << "}'.\n"
1837                                         "Add 'jurabiborder' to the jurabib "
1838                                         "package options if you used an\n"
1839                                         "earlier jurabib version." << endl;
1840                         }
1841                         begin_inset(os, "LatexCommand ");
1842                         os << command << after << before
1843                            << '{' << citation << "}\n";
1844                         end_inset(os);
1845                 }
1846
1847                 else if (is_known(t.cs(), known_latex_commands)) {
1848                         // This needs to be after the check for natbib and
1849                         // jurabib commands, because "cite" has different
1850                         // arguments with natbib and jurabib.
1851                         context.check_layout(os);
1852                         begin_inset(os, "LatexCommand ");
1853                         os << '\\' << t.cs();
1854                         // lyx cannot handle newlines in a latex command
1855                         // FIXME: Move the substitution into parser::getOpt()?
1856                         os << subst(p.getOpt(), "\n", " ");
1857                         os << subst(p.getOpt(), "\n", " ");
1858                         os << '{' << subst(p.verbatim_item(), "\n", " ") << "}\n";
1859                         end_inset(os);
1860                 }
1861
1862                 else if (is_known(t.cs(), known_quotes)) {
1863                         char const * const * where = is_known(t.cs(), known_quotes);
1864                         context.check_layout(os);
1865                         begin_inset(os, "Quotes ");
1866                         os << known_coded_quotes[where - known_quotes];
1867                         end_inset(os);
1868                         // LyX adds {} after the quote, so we have to eat
1869                         // spaces here if there are any before a possible
1870                         // {} pair.
1871                         eat_whitespace(p, os, context, false);
1872                         skip_braces(p);
1873                 }
1874
1875                 else if (is_known(t.cs(), known_sizes) &&
1876                          context.new_layout_allowed) {
1877                         char const * const * where = is_known(t.cs(), known_sizes);
1878                         context.check_layout(os);
1879                         Font const oldFont = context.font;
1880                         context.font.size = known_coded_sizes[where - known_sizes];
1881                         output_font_change(os, oldFont, context.font);
1882                         eat_whitespace(p, os, context, false);
1883                 }
1884
1885                 else if (is_known(t.cs(), known_font_families) &&
1886                          context.new_layout_allowed) {
1887                         char const * const * where =
1888                                 is_known(t.cs(), known_font_families);
1889                         context.check_layout(os);
1890                         Font const oldFont = context.font;
1891                         context.font.family =
1892                                 known_coded_font_families[where - known_font_families];
1893                         output_font_change(os, oldFont, context.font);
1894                         eat_whitespace(p, os, context, false);
1895                 }
1896
1897                 else if (is_known(t.cs(), known_font_series) &&
1898                          context.new_layout_allowed) {
1899                         char const * const * where =
1900                                 is_known(t.cs(), known_font_series);
1901                         context.check_layout(os);
1902                         Font const oldFont = context.font;
1903                         context.font.series =
1904                                 known_coded_font_series[where - known_font_series];
1905                         output_font_change(os, oldFont, context.font);
1906                         eat_whitespace(p, os, context, false);
1907                 }
1908
1909                 else if (is_known(t.cs(), known_font_shapes) &&
1910                          context.new_layout_allowed) {
1911                         char const * const * where =
1912                                 is_known(t.cs(), known_font_shapes);
1913                         context.check_layout(os);
1914                         Font const oldFont = context.font;
1915                         context.font.shape =
1916                                 known_coded_font_shapes[where - known_font_shapes];
1917                         output_font_change(os, oldFont, context.font);
1918                         eat_whitespace(p, os, context, false);
1919                 }
1920                 else if (is_known(t.cs(), known_old_font_families) &&
1921                          context.new_layout_allowed) {
1922                         char const * const * where =
1923                                 is_known(t.cs(), known_old_font_families);
1924                         context.check_layout(os);
1925                         Font const oldFont = context.font;
1926                         context.font.init();
1927                         context.font.size = oldFont.size;
1928                         context.font.family =
1929                                 known_coded_font_families[where - known_old_font_families];
1930                         output_font_change(os, oldFont, context.font);
1931                         eat_whitespace(p, os, context, false);
1932                 }
1933
1934                 else if (is_known(t.cs(), known_old_font_series) &&
1935                          context.new_layout_allowed) {
1936                         char const * const * where =
1937                                 is_known(t.cs(), known_old_font_series);
1938                         context.check_layout(os);
1939                         Font const oldFont = context.font;
1940                         context.font.init();
1941                         context.font.size = oldFont.size;
1942                         context.font.series =
1943                                 known_coded_font_series[where - known_old_font_series];
1944                         output_font_change(os, oldFont, context.font);
1945                         eat_whitespace(p, os, context, false);
1946                 }
1947
1948                 else if (is_known(t.cs(), known_old_font_shapes) &&
1949                          context.new_layout_allowed) {
1950                         char const * const * where =
1951                                 is_known(t.cs(), known_old_font_shapes);
1952                         context.check_layout(os);
1953                         Font const oldFont = context.font;
1954                         context.font.init();
1955                         context.font.size = oldFont.size;
1956                         context.font.shape =
1957                                 known_coded_font_shapes[where - known_old_font_shapes];
1958                         output_font_change(os, oldFont, context.font);
1959                         eat_whitespace(p, os, context, false);
1960                 }
1961
1962                 else if (t.cs() == "LyX" || t.cs() == "TeX"
1963                          || t.cs() == "LaTeX") {
1964                         context.check_layout(os);
1965                         os << t.cs();
1966                         skip_braces(p); // eat {}
1967                 }
1968
1969                 else if (t.cs() == "LaTeXe") {
1970                         context.check_layout(os);
1971                         os << "LaTeX2e";
1972                         skip_braces(p); // eat {}
1973                 }
1974
1975                 else if (t.cs() == "ldots") {
1976                         context.check_layout(os);
1977                         skip_braces(p);
1978                         os << "\\SpecialChar \\ldots{}\n";
1979                 }
1980
1981                 else if (t.cs() == "lyxarrow") {
1982                         context.check_layout(os);
1983                         os << "\\SpecialChar \\menuseparator\n";
1984                         skip_braces(p);
1985                 }
1986
1987                 else if (t.cs() == "textcompwordmark") {
1988                         context.check_layout(os);
1989                         os << "\\SpecialChar \\textcompwordmark{}\n";
1990                         skip_braces(p);
1991                 }
1992
1993                 else if (t.cs() == "@" && p.next_token().asInput() == ".") {
1994                         context.check_layout(os);
1995                         os << "\\SpecialChar \\@.\n";
1996                         p.get_token();
1997                 }
1998
1999                 else if (t.cs() == "-") {
2000                         context.check_layout(os);
2001                         os << "\\SpecialChar \\-\n";
2002                 }
2003
2004                 else if (t.cs() == "textasciitilde") {
2005                         context.check_layout(os);
2006                         os << '~';
2007                         skip_braces(p);
2008                 }
2009
2010                 else if (t.cs() == "textasciicircum") {
2011                         context.check_layout(os);
2012                         os << '^';
2013                         skip_braces(p);
2014                 }
2015
2016                 else if (t.cs() == "textbackslash") {
2017                         context.check_layout(os);
2018                         os << "\n\\backslash\n";
2019                         skip_braces(p);
2020                 }
2021
2022                 else if (t.cs() == "_" || t.cs() == "&" || t.cs() == "#"
2023                             || t.cs() == "$" || t.cs() == "{" || t.cs() == "}"
2024                             || t.cs() == "%") {
2025                         context.check_layout(os);
2026                         os << t.cs();
2027                 }
2028
2029                 else if (t.cs() == "char") {
2030                         context.check_layout(os);
2031                         if (p.next_token().character() == '`') {
2032                                 p.get_token();
2033                                 if (p.next_token().cs() == "\"") {
2034                                         p.get_token();
2035                                         os << '"';
2036                                         skip_braces(p);
2037                                 } else {
2038                                         handle_ert(os, "\\char`", context);
2039                                 }
2040                         } else {
2041                                 handle_ert(os, "\\char", context);
2042                         }
2043                 }
2044
2045                 else if (t.cs() == "verb") {
2046                         context.check_layout(os);
2047                         char const delimiter = p.next_token().character();
2048                         string const arg = p.getArg(delimiter, delimiter);
2049                         ostringstream oss;
2050                         oss << "\\verb" << delimiter << arg << delimiter;
2051                         handle_ert(os, oss.str(), context);
2052                 }
2053
2054                 else if (t.cs() == "\"") {
2055                         context.check_layout(os);
2056                         string const name = p.verbatim_item();
2057                              if (name == "a") os << 'ä';
2058                         else if (name == "o") os << 'ö';
2059                         else if (name == "u") os << 'ü';
2060                         else if (name == "A") os << 'Ä';
2061                         else if (name == "O") os << 'Ö';
2062                         else if (name == "U") os << 'Ü';
2063                         else handle_ert(os, "\"{" + name + "}", context);
2064                 }
2065
2066                 // Problem: \= creates a tabstop inside the tabbing environment
2067                 // and else an accent. In the latter case we really would want
2068                 // \={o} instead of \= o.
2069                 else if (t.cs() == "=" && (flags & FLAG_TABBING))
2070                         handle_ert(os, t.asInput(), context);
2071
2072                 else if (t.cs() == "H" || t.cs() == "c" || t.cs() == "^"
2073                          || t.cs() == "'" || t.cs() == "`"
2074                          || t.cs() == "~" || t.cs() == "." || t.cs() == "=") {
2075                         // we need the trim as the LyX parser chokes on such spaces
2076                         context.check_layout(os);
2077                         os << "\n\\i \\" << t.cs() << "{"
2078                            << trim(parse_text_snippet(p, FLAG_ITEM, outer, context), " ")
2079                            << "}\n";
2080                 }
2081
2082                 else if (t.cs() == "ss") {
2083                         context.check_layout(os);
2084                         os << "ß";
2085                         skip_braces(p); // eat {}
2086                 }
2087
2088                 else if (t.cs() == "i" || t.cs() == "j") {
2089                         context.check_layout(os);
2090                         os << "\\" << t.cs() << ' ';
2091                         skip_braces(p); // eat {}
2092                 }
2093
2094                 else if (t.cs() == "\\") {
2095                         context.check_layout(os);
2096                         string const next = p.next_token().asInput();
2097                         if (next == "[")
2098                                 handle_ert(os, "\\\\" + p.getOpt(), context);
2099                         else if (next == "*") {
2100                                 p.get_token();
2101                                 handle_ert(os, "\\\\*" + p.getOpt(), context);
2102                         }
2103                         else {
2104                                 os << "\n\\newline\n";
2105                         }
2106                 }
2107
2108                 else if (t.cs() == "input" || t.cs() == "include"
2109                          || t.cs() == "verbatiminput") {
2110                         string name = '\\' + t.cs();
2111                         if (t.cs() == "verbatiminput"
2112                             && p.next_token().asInput() == "*")
2113                                 name += p.get_token().asInput();
2114                         context.check_layout(os);
2115                         begin_inset(os, "Include ");
2116                         string filename(normalize_filename(p.getArg('{', '}')));
2117                         string const path = getMasterFilePath();
2118                         // We want to preserve relative / absolute filenames,
2119                         // therefore path is only used for testing
2120                         if (t.cs() == "include" &&
2121                             !fs::exists(makeAbsPath(filename, path))) {
2122                                 // The file extension is probably missing.
2123                                 // Now try to find it out.
2124                                 string const tex_name =
2125                                         find_file(filename, path,
2126                                                   known_tex_extensions);
2127                                 if (!tex_name.empty())
2128                                         filename = tex_name;
2129                         }
2130                         if (fs::exists(makeAbsPath(filename, path))) {
2131                                 string const abstexname =
2132                                         makeAbsPath(filename, path);
2133                                 string const abslyxname =
2134                                         changeExtension(abstexname, ".lyx");
2135                                 fix_relative_filename(filename);
2136                                 string const lyxname =
2137                                         changeExtension(filename, ".lyx");
2138                                 if (t.cs() != "verbatiminput" &&
2139                                     tex2lyx(abstexname, abslyxname)) {
2140                                         os << name << '{' << lyxname << "}\n";
2141                                 } else {
2142                                         os << name << '{' << filename << "}\n";
2143                                 }
2144                         } else {
2145                                 cerr << "Warning: Could not find included file '"
2146                                      << filename << "'." << endl;
2147                                 os << name << '{' << filename << "}\n";
2148                         }
2149                         os << "preview false\n";
2150                         end_inset(os);
2151                 }
2152
2153                 else if (t.cs() == "bibliographystyle") {
2154                         // store new bibliographystyle
2155                         bibliographystyle = p.verbatim_item();
2156                         // output new bibliographystyle.
2157                         // This is only necessary if used in some other macro than \bibliography.
2158                         handle_ert(os, "\\bibliographystyle{" + bibliographystyle + "}", context);
2159                 }
2160
2161                 else if (t.cs() == "bibliography") {
2162                         context.check_layout(os);
2163                         begin_inset(os, "LatexCommand ");
2164                         os << "\\bibtex";
2165                         // Do we have a bibliographystyle set?
2166                         if (!bibliographystyle.empty()) {
2167                                 os << '[' << bibliographystyle << ']';
2168                         }
2169                         os << '{' << p.verbatim_item() << "}\n";
2170                         end_inset(os);
2171                 }
2172
2173                 else if (t.cs() == "parbox")
2174                         parse_box(p, os, FLAG_ITEM, outer, context, true);
2175
2176                 else if (t.cs() == "smallskip" ||
2177                          t.cs() == "medskip" ||
2178                          t.cs() == "bigskip" ||
2179                          t.cs() == "vfill") {
2180                         context.check_layout(os);
2181                         begin_inset(os, "VSpace ");
2182                         os << t.cs();
2183                         end_inset(os);
2184                         skip_braces(p);
2185                 }
2186
2187                 else if (t.cs() == "newpage") {
2188                         context.check_layout(os);
2189                         // FIXME: what about \\clearpage and \\pagebreak?
2190                         os << "\n\\newpage\n";
2191                         skip_braces(p); // eat {}
2192                 }
2193
2194                 else if (t.cs() == "newcommand" ||
2195                          t.cs() == "providecommand" ||
2196                          t.cs() == "renewcommand") {
2197                         // these could be handled by parse_command(), but
2198                         // we need to call add_known_command() here.
2199                         string name = t.asInput();
2200                         if (p.next_token().asInput() == "*") {
2201                                 // Starred form. Eat '*'
2202                                 p.get_token();
2203                                 name += '*';
2204                         }
2205                         string const command = p.verbatim_item();
2206                         string const opt1 = p.getOpt();
2207                         string const opt2 = p.getFullOpt();
2208                         add_known_command(command, opt1, !opt2.empty());
2209                         string const ert = name + '{' + command + '}' +
2210                                            opt1 + opt2 +
2211                                            '{' + p.verbatim_item() + '}';
2212                         handle_ert(os, ert, context);
2213                 }
2214
2215                 else if (t.cs() == "vspace") {
2216                         bool starred = false;
2217                         if (p.next_token().asInput() == "*") {
2218                                 p.get_token();
2219                                 starred = true;
2220                         }
2221                         string const length = p.verbatim_item();
2222                         string unit;
2223                         string valstring;
2224                         bool valid = splitLatexLength(length, valstring, unit);
2225                         bool known_vspace = false;
2226                         bool known_unit = false;
2227                         double value;
2228                         if (valid) {
2229                                 istringstream iss(valstring);
2230                                 iss >> value;
2231                                 if (value == 1.0) {
2232                                         if (unit == "\\smallskipamount") {
2233                                                 unit = "smallskip";
2234                                                 known_vspace = true;
2235                                         } else if (unit == "\\medskipamount") {
2236                                                 unit = "medskip";
2237                                                 known_vspace = true;
2238                                         } else if (unit == "\\bigskipamount") {
2239                                                 unit = "bigskip";
2240                                                 known_vspace = true;
2241                                         } else if (unit == "\\fill") {
2242                                                 unit = "vfill";
2243                                                 known_vspace = true;
2244                                         }
2245                                 }
2246                                 if (!known_vspace) {
2247                                         switch (unitFromString(unit)) {
2248                                         case LyXLength::SP:
2249                                         case LyXLength::PT:
2250                                         case LyXLength::BP:
2251                                         case LyXLength::DD:
2252                                         case LyXLength::MM:
2253                                         case LyXLength::PC:
2254                                         case LyXLength::CC:
2255                                         case LyXLength::CM:
2256                                         case LyXLength::IN:
2257                                         case LyXLength::EX:
2258                                         case LyXLength::EM:
2259                                         case LyXLength::MU:
2260                                                 known_unit = true;
2261                                                 break;
2262                                         default:
2263                                                 break;
2264                                         }
2265                                 }
2266                         }
2267
2268                         if (known_unit || known_vspace) {
2269                                 // Literal length or known variable
2270                                 context.check_layout(os);
2271                                 begin_inset(os, "VSpace ");
2272                                 if (known_unit)
2273                                         os << value;
2274                                 os << unit;
2275                                 if (starred)
2276                                         os << '*';
2277                                 end_inset(os);
2278                         } else {
2279                                 // LyX can't handle other length variables in Inset VSpace
2280                                 string name = t.asInput();
2281                                 if (starred)
2282                                         name += '*';
2283                                 if (valid) {
2284                                         if (value == 1.0)
2285                                                 handle_ert(os, name + '{' + unit + '}', context);
2286                                         else if (value == -1.0)
2287                                                 handle_ert(os, name + "{-" + unit + '}', context);
2288                                         else
2289                                                 handle_ert(os, name + '{' + valstring + unit + '}', context);
2290                                 } else
2291                                         handle_ert(os, name + '{' + length + '}', context);
2292                         }
2293                 }
2294
2295                 else {
2296                         //cerr << "#: " << t << " mode: " << mode << endl;
2297                         // heuristic: read up to next non-nested space
2298                         /*
2299                         string s = t.asInput();
2300                         string z = p.verbatim_item();
2301                         while (p.good() && z != " " && z.size()) {
2302                                 //cerr << "read: " << z << endl;
2303                                 s += z;
2304                                 z = p.verbatim_item();
2305                         }
2306                         cerr << "found ERT: " << s << endl;
2307                         handle_ert(os, s + ' ', context);
2308                         */
2309                         string name = t.asInput();
2310                         if (p.next_token().asInput() == "*") {
2311                                 // Starred commands like \vspace*{}
2312                                 p.get_token();                          // Eat '*'
2313                                 name += '*';
2314                         }
2315                         if (! parse_command(name, p, os, outer, context))
2316                                 handle_ert(os, name, context);
2317                 }
2318
2319                 if (flags & FLAG_LEAVE) {
2320                         flags &= ~FLAG_LEAVE;
2321                         break;
2322                 }
2323         }
2324 }
2325
2326 // }])