src/tex2lyx/Preamble.cpp

   1 /**
   2  * \file Preamble.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  * \author Uwe Stöhr
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 // {[(
  13
  14 #include <config.h>
  15
  16 #include "Preamble.h"
  17 #include "tex2lyx.h"
  18
  19 #include "LayoutFile.h"
  20 #include "Layout.h"
  21 #include "Lexer.h"
  22 #include "TextClass.h"
  23
  24 #include "support/convert.h"
  25 #include "support/FileName.h"
  26 #include "support/filetools.h"
  27 #include "support/lstrings.h"
  28
  29 #include "support/regex.h"
  30
  31 #include <algorithm>
  32 #include <iostream>
  33
  34 using namespace std;
  35 using namespace lyx::support;
  36
  37
  38 namespace lyx {
  39
  40 // special columntypes
  41 extern map<char, int> special_columns;
  42
  43 Preamble preamble;
  44
  45 namespace {
  46
  47 //add this to known_languages when updating to lyxformat 266:
  48 // "armenian" (needs special handling since not supported by standard babel)
  49 //add these to known_languages when updating to lyxformat 268:
  50 //"chinese-simplified", "chinese-traditional", "japanese", "korean"
  51 // Both changes require first that support for non-babel languages (CJK,
  52 // armtex) is added.
  53 /**
  54  * known babel language names (including synonyms)
  55  * not in standard babel: arabic, arabtex, armenian, belarusian, serbian-latin, thai
  56  * not yet supported by LyX: kurmanji
  57  * please keep this in sync with known_coded_languages line by line!
  58  */
  59 const char * const known_languages[] = {"acadian", "afrikaans", "albanian",
  60 "american", "arabic", "arabtex", "austrian", "bahasa", "bahasai", "bahasam",
  61 "basque", "belarusian", "brazil", "brazilian", "breton", "british", "bulgarian",
  62 "canadian", "canadien", "catalan", "croatian", "czech", "danish", "dutch",
  63 "english", "esperanto", "estonian", "farsi", "finnish", "francais", "french",
  64 "frenchb", "frenchle", "frenchpro", "galician", "german", "germanb", "greek",
  65 "hebrew", "hungarian", "icelandic", "indon", "indonesian", "interlingua",
  66 "irish", "italian", "kazakh", "latin", "latvian", "lithuanian", "lowersorbian",
  67 "lsorbian", "magyar", "malay", "meyalu", "mongolian", "naustrian", "newzealand",
  68 "ngerman", "ngermanb", "norsk", "nynorsk", "polutonikogreek", "polish",
  69 "portuges", "portuguese", "romanian", "russian", "russianb", "samin",
  70 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
  71 "swedish", "thai", "turkish", "turkmen", "ukraineb", "ukrainian",
  72 "uppersorbian", "UKenglish", "USenglish", "usorbian", "vietnam", "welsh",
  73 0};
  74
  75 /**
  76  * the same as known_languages with .lyx names
  77  * please keep this in sync with known_languages line by line!
  78  */
  79 const char * const known_coded_languages[] = {"french", "afrikaans", "albanian",
  80 "american", "arabic_arabi", "arabic_arabtex", "austrian", "bahasa", "bahasa", "bahasam",
  81 "basque", "belarusian", "brazilian", "brazilian", "breton", "british", "bulgarian",
  82 "canadian", "canadien", "catalan", "croatian", "czech", "danish", "dutch",
  83 "english", "esperanto", "estonian", "farsi", "finnish", "french", "french",
  84 "french", "french", "french", "galician", "german", "german", "greek",
  85 "hebrew", "magyar", "icelandic", "bahasa", "bahasa", "interlingua",
  86 "irish", "italian", "kazakh", "latin", "latvian", "lithuanian", "lowersorbian",
  87 "lowersorbian", "magyar", "bahasam", "bahasam", "mongolian", "naustrian", "english",
  88 "ngerman", "ngerman", "norsk", "nynorsk", "polutonikogreek", "polish",
  89 "portuguese", "portuguese", "romanian", "russian", "russian", "samin",
  90 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
  91 "swedish", "thai", "turkish", "turkmen", "ukrainian", "ukrainian",
  92 "uppersorbian", "uppersorbian", "english", "english", "vietnamese", "welsh",
  93 0};
  94
  95 /// languages with english quotes (.lyx names)
  96 const char * const known_english_quotes_languages[] = {"american", "bahasa",
  97 "bahasam", "brazilian", "canadian", "chinese-simplified", "english",
  98 "esperanto", "hebrew", "irish", "korean", "portuguese", "scottish", "thai", 0};
  99
 100 /// languages with french quotes (.lyx names)
 101 const char * const known_french_quotes_languages[] = {"albanian",
 102 "arabic_arabi", "arabic_arabtex", "basque", "canadien", "catalan", "french",
 103 "galician", "greek", "italian", "norsk", "nynorsk", "polutonikogreek",
 104 "russian", "spanish", "spanish-mexico", "turkish", "turkmen", "ukrainian",
 105 "vietnamese", 0};
 106
 107 /// languages with german quotes (.lyx names)
 108 const char * const known_german_quotes_languages[] = {"austrian", "bulgarian",
 109 "czech", "german", "icelandic", "lithuanian", "lowersorbian", "naustrian",
 110 "ngerman", "serbian", "serbian-latin", "slovak", "slovene", "uppersorbian", 0};
 111
 112 /// languages with polish quotes (.lyx names)
 113 const char * const known_polish_quotes_languages[] = {"afrikaans", "croatian",
 114 "dutch", "estonian", "magyar", "polish", "romanian", 0};
 115
 116 /// languages with swedish quotes (.lyx names)
 117 const char * const known_swedish_quotes_languages[] = {"finnish",
 118 "swedish", 0};
 119
 120 /// known language packages from the times before babel
 121 const char * const known_old_language_packages[] = {"french", "frenchle",
 122 "frenchpro", "german", "ngerman", "pmfrench", 0};
 123
 124 char const * const known_fontsizes[] = { "10pt", "11pt", "12pt", 0 };
 125
 126 const char * const known_roman_fonts[] = { "ae", "beraserif", "bookman",
 127 "ccfonts", "chancery", "charter", "cmr", "fourier", "lmodern", "mathpazo",
 128 "mathptmx", "newcent", "utopia", 0};
 129
 130 const char * const known_sans_fonts[] = { "avant", "berasans", "cmbr", "cmss",
 131 "helvet", "lmss", 0};
 132
 133 const char * const known_typewriter_fonts[] = { "beramono", "cmtl", "cmtt",
 134 "courier", "lmtt", "luximono", "fourier", "lmodern", "mathpazo", "mathptmx",
 135 "newcent", 0};
 136
 137 const char * const known_paper_sizes[] = { "a0paper", "b0paper", "c0paper",
 138 "a1paper", "b1paper", "c1paper", "a2paper", "b2paper", "c2paper", "a3paper",
 139 "b3paper", "c3paper", "a4paper", "b4paper", "c4paper", "a5paper", "b5paper",
 140 "c5paper", "a6paper", "b6paper", "c6paper", "executivepaper", "legalpaper",
 141 "letterpaper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j", "b6j", 0};
 142
 143 const char * const known_class_paper_sizes[] = { "a4paper", "a5paper",
 144 "executivepaper", "legalpaper", "letterpaper", 0};
 145
 146 const char * const known_paper_margins[] = { "lmargin", "tmargin", "rmargin",
 147 "bmargin", "headheight", "headsep", "footskip", "columnsep", 0};
 148
 149 const char * const known_coded_paper_margins[] = { "leftmargin", "topmargin",
 150 "rightmargin", "bottommargin", "headheight", "headsep", "footskip",
 151 "columnsep", 0};
 152
 153 /// commands that can start an \if...\else...\endif sequence
 154 const char * const known_if_commands[] = {"if", "ifarydshln", "ifbraket",
 155 "ifcancel", "ifcolortbl", "ifeurosym", "ifmarginnote", "ifmmode", "ifpdf",
 156 "ifsidecap", "ifupgreek", 0};
 157
 158 const char * const known_basic_colors[] = {"blue", "black", "cyan", "green",
 159 "magenta", "red", "white", "yellow", 0};
 160
 161 const char * const known_basic_color_codes[] = {"#0000ff", "#000000", "#00ffff", "#00ff00",
 162 "#ff00ff", "#ff0000", "#ffffff", "#ffff00", 0};
 163
 164 /// conditional commands with three arguments like \@ifundefined{}{}{}
 165 const char * const known_if_3arg_commands[] = {"@ifundefined", "IfFileExists",
 166 0};
 167
 168 /// packages that work only in xetex
 169 const char * const known_xetex_packages[] = {"arabxetex", "fixlatvian",
 170 "fontbook", "fontwrap", "mathspec", "philokalia", "polyglossia", "unisugar",
 171 "xeCJK", "xecolor", "xecyr", "xeindex", "xepersian", "xunicode", 0};
 172
 173 // codes used to remove packages that are loaded automatically by LyX.
 174 // Syntax: package_beg_sep<name>package_mid_sep<package loading code>package_end_sep
 175 const char package_beg_sep = '\001';
 176 const char package_mid_sep = '\002';
 177 const char package_end_sep = '\003';
 178
 179
 180 // returns true if at least one of the options in what has been found
 181 bool handle_opt(vector<string> & opts, char const * const * what, string & target)
 182 {
 183         if (opts.empty())
 184                 return false;
 185
 186         bool found = false;
 187         // the last language option is the document language (for babel and LyX)
 188         // the last size option is the document font size
 189         vector<string>::iterator it;
 190         vector<string>::iterator position = opts.begin();
 191         for (; *what; ++what) {
 192                 it = find(opts.begin(), opts.end(), *what);
 193                 if (it != opts.end()) {
 194                         if (it >= position) {
 195                                 found = true;
 196                                 target = *what;
 197                                 position = it;
 198                         }
 199                 }
 200         }
 201         return found;
 202 }
 203
 204
 205 void delete_opt(vector<string> & opts, char const * const * what)
 206 {
 207         if (opts.empty())
 208                 return;
 209
 210         // remove found options from the list
 211         // do this after handle_opt to avoid potential memory leaks
 212         vector<string>::iterator it;
 213         for (; *what; ++what) {
 214                 it = find(opts.begin(), opts.end(), *what);
 215                 if (it != opts.end())
 216                         opts.erase(it);
 217         }
 218 }
 219
 220
 221 /*!
 222  * Split a package options string (keyval format) into a vector.
 223  * Example input:
 224  *   authorformat=smallcaps,
 225  *   commabeforerest,
 226  *   titleformat=colonsep,
 227  *   bibformat={tabular,ibidem,numbered}
 228  */
 229 vector<string> split_options(string const & input)
 230 {
 231         vector<string> options;
 232         string option;
 233         Parser p(input);
 234         while (p.good()) {
 235                 Token const & t = p.get_token();
 236                 if (t.asInput() == ",") {
 237                         options.push_back(trimSpaceAndEol(option));
 238                         option.erase();
 239                 } else if (t.asInput() == "=") {
 240                         option += '=';
 241                         p.skip_spaces(true);
 242                         if (p.next_token().asInput() == "{")
 243                                 option += '{' + p.getArg('{', '}') + '}';
 244                 } else if (t.cat() != catSpace)
 245                         option += t.asInput();
 246         }
 247
 248         if (!option.empty())
 249                 options.push_back(trimSpaceAndEol(option));
 250
 251         return options;
 252 }
 253
 254
 255 /*!
 256  * Retrieve a keyval option "name={value with=sign}" named \p name from
 257  * \p options and return the value.
 258  * The found option is also removed from \p options.
 259  */
 260 string process_keyval_opt(vector<string> & options, string name)
 261 {
 262         for (size_t i = 0; i < options.size(); ++i) {
 263                 vector<string> option;
 264                 split(options[i], option, '=');
 265                 if (option.size() < 2)
 266                         continue;
 267                 if (option[0] == name) {
 268                         options.erase(options.begin() + i);
 269                         option.erase(option.begin());
 270                         return join(option, "=");
 271                 }
 272         }
 273         return "";
 274 }
 275
 276 } // anonymous namespace
 277
 278
 279 bool Preamble::indentParagraphs() const
 280 {
 281         return h_paragraph_separation == "indent";
 282 }
 283
 284
 285 bool Preamble::isPackageUsed(string const & package) const
 286 {
 287         return used_packages.find(package) != used_packages.end();
 288 }
 289
 290
 291 vector<string> Preamble::getPackageOptions(string const & package) const
 292 {
 293         map<string, vector<string> >::const_iterator it = used_packages.find(package);
 294         if (it != used_packages.end())
 295                 return it->second;
 296         return vector<string>();
 297 }
 298
 299
 300 void Preamble::registerAutomaticallyLoadedPackage(std::string const & package)
 301 {
 302         auto_packages.insert(package);
 303 }
 304
 305
 306 void Preamble::addModule(string const & module)
 307 {
 308         used_modules.push_back(module);
 309 }
 310
 311
 312 void Preamble::suppressDate(bool suppress)
 313 {
 314         if (suppress)
 315                 h_suppress_date = "true";
 316         else
 317                 h_suppress_date = "false";
 318 }
 319
 320
 321 void Preamble::registerAuthor(std::string const & name)
 322 {
 323         Author author(from_utf8(name), empty_docstring());
 324         author.setUsed(true);
 325         authors_.record(author);
 326         h_tracking_changes = "true";
 327         h_output_changes = "true";
 328 }
 329
 330
 331 Author const & Preamble::getAuthor(std::string const & name) const
 332 {
 333         Author author(from_utf8(name), empty_docstring());
 334         for (AuthorList::Authors::const_iterator it = authors_.begin();
 335              it != authors_.end(); it++)
 336                 if (*it == author)
 337                         return *it;
 338         static Author const dummy;
 339         return dummy;
 340 }
 341
 342
 343 void Preamble::add_package(string const & name, vector<string> & options)
 344 {
 345         // every package inherits the global options
 346         if (used_packages.find(name) == used_packages.end())
 347                 used_packages[name] = split_options(h_options);
 348
 349         vector<string> & v = used_packages[name];
 350         v.insert(v.end(), options.begin(), options.end());
 351         if (name == "jurabib") {
 352                 // Don't output the order argument (see the cite command
 353                 // handling code in text.cpp).
 354                 vector<string>::iterator end =
 355                         remove(options.begin(), options.end(), "natbiborder");
 356                 end = remove(options.begin(), end, "jurabiborder");
 357                 options.erase(end, options.end());
 358         }
 359 }
 360
 361
 362 namespace {
 363
 364 // Given is a string like "scaled=0.9", return 0.9 * 100
 365 string const scale_as_percentage(string const & scale)
 366 {
 367         string::size_type pos = scale.find('=');
 368         if (pos != string::npos) {
 369                 string value = scale.substr(pos + 1);
 370                 if (isStrDbl(value))
 371                         return convert<string>(100 * convert<double>(value));
 372         }
 373         // If the input string didn't match our expectations.
 374         // return the default value "100"
 375         return "100";
 376 }
 377
 378
 379 string remove_braces(string const & value)
 380 {
 381         if (value.empty())
 382                 return value;
 383         if (value[0] == '{' && value[value.length()-1] == '}')
 384                 return value.substr(1, value.length()-2);
 385         return value;
 386 }
 387
 388 } // anonymous namespace
 389
 390
 391 Preamble::Preamble() : one_language(true)
 392 {
 393         //h_backgroundcolor;
 394         //h_boxbgcolor;
 395         h_cite_engine             = "basic";
 396         h_defskip                 = "medskip";
 397         //h_float_placement;
 398         //h_fontcolor;
 399         h_fontencoding            = "default";
 400         h_font_roman              = "default";
 401         h_font_sans               = "default";
 402         h_font_typewriter         = "default";
 403         h_font_default_family     = "default";
 404         h_font_sc                 = "false";
 405         h_font_osf                = "false";
 406         h_font_sf_scale           = "100";
 407         h_font_tt_scale           = "100";
 408         h_graphics                = "default";
 409         h_html_be_strict          = "false";
 410         h_html_css_as_file        = "0";
 411         h_html_math_output        = "0";
 412         h_inputencoding           = "auto";
 413         h_language                = "english";
 414         h_language_package        = "none";
 415         //h_listings_params;
 416         //h_margins;
 417         //h_notefontcolor;
 418         //h_options;
 419         h_output_changes          = "false";
 420         h_papercolumns            = "1";
 421         h_paperfontsize           = "default";
 422         h_paperorientation        = "portrait";
 423         h_paperpagestyle          = "default";
 424         //h_papersides;
 425         h_papersize               = "default";
 426         h_paragraph_indentation   = "default";
 427         h_paragraph_separation    = "indent";
 428         //h_pdf_title;
 429         //h_pdf_author;
 430         //h_pdf_subject;
 431         //h_pdf_keywords;
 432         h_pdf_bookmarks           = "1";
 433         h_pdf_bookmarksnumbered   = "0";
 434         h_pdf_bookmarksopen       = "0";
 435         h_pdf_bookmarksopenlevel  = "1";
 436         h_pdf_breaklinks          = "0";
 437         h_pdf_pdfborder           = "0";
 438         h_pdf_colorlinks          = "0";
 439         h_pdf_backref             = "section";
 440         h_pdf_pdfusetitle         = "1";
 441         //h_pdf_pagemode;
 442         //h_pdf_quoted_options;
 443         h_quotes_language         = "english";
 444         h_secnumdepth             = "3";
 445         h_spacing                 = "single";
 446         h_suppress_date           = "false";
 447         h_textclass               = "article";
 448         h_tocdepth                = "3";
 449         h_tracking_changes        = "false";
 450         h_use_bibtopic            = "false";
 451         h_use_geometry            = "false";
 452         h_use_amsmath             = "1";
 453         h_use_default_options     = "false";
 454         h_use_esint               = "1";
 455         h_use_hyperref            = "0";
 456         h_use_mhchem              = "0";
 457         h_use_mathdots            = "0";
 458         h_use_refstyle            = "0";
 459         h_use_undertilde          = "0";
 460 }
 461
 462
 463 void Preamble::handle_hyperref(vector<string> & options)
 464 {
 465         // FIXME swallow inputencoding changes that might surround the
 466         //       hyperref setup if it was written by LyX
 467         h_use_hyperref = "1";
 468         // swallow "unicode=true", since LyX does always write that
 469         vector<string>::iterator it =
 470                 find(options.begin(), options.end(), "unicode=true");
 471         if (it != options.end())
 472                 options.erase(it);
 473         it = find(options.begin(), options.end(), "pdfusetitle");
 474         if (it != options.end()) {
 475                 h_pdf_pdfusetitle = "1";
 476                 options.erase(it);
 477         }
 478         string bookmarks = process_keyval_opt(options, "bookmarks");
 479         if (bookmarks == "true")
 480                 h_pdf_bookmarks = "1";
 481         else if (bookmarks == "false")
 482                 h_pdf_bookmarks = "0";
 483         if (h_pdf_bookmarks == "1") {
 484                 string bookmarksnumbered =
 485                         process_keyval_opt(options, "bookmarksnumbered");
 486                 if (bookmarksnumbered == "true")
 487                         h_pdf_bookmarksnumbered = "1";
 488                 else if (bookmarksnumbered == "false")
 489                         h_pdf_bookmarksnumbered = "0";
 490                 string bookmarksopen =
 491                         process_keyval_opt(options, "bookmarksopen");
 492                 if (bookmarksopen == "true")
 493                         h_pdf_bookmarksopen = "1";
 494                 else if (bookmarksopen == "false")
 495                         h_pdf_bookmarksopen = "0";
 496                 if (h_pdf_bookmarksopen == "1") {
 497                         string bookmarksopenlevel =
 498                                 process_keyval_opt(options, "bookmarksopenlevel");
 499                         if (!bookmarksopenlevel.empty())
 500                                 h_pdf_bookmarksopenlevel = bookmarksopenlevel;
 501                 }
 502         }
 503         string breaklinks = process_keyval_opt(options, "breaklinks");
 504         if (breaklinks == "true")
 505                 h_pdf_breaklinks = "1";
 506         else if (breaklinks == "false")
 507                 h_pdf_breaklinks = "0";
 508         string pdfborder = process_keyval_opt(options, "pdfborder");
 509         if (pdfborder == "{0 0 0}")
 510                 h_pdf_pdfborder = "1";
 511         else if (pdfborder == "{0 0 1}")
 512                 h_pdf_pdfborder = "0";
 513         string backref = process_keyval_opt(options, "backref");
 514         if (!backref.empty())
 515                 h_pdf_backref = backref;
 516         string colorlinks = process_keyval_opt(options, "colorlinks");
 517         if (colorlinks == "true")
 518                 h_pdf_colorlinks = "1";
 519         else if (colorlinks == "false")
 520                 h_pdf_colorlinks = "0";
 521         string pdfpagemode = process_keyval_opt(options, "pdfpagemode");
 522         if (!pdfpagemode.empty())
 523                 h_pdf_pagemode = pdfpagemode;
 524         string pdftitle = process_keyval_opt(options, "pdftitle");
 525         if (!pdftitle.empty()) {
 526                 h_pdf_title = remove_braces(pdftitle);
 527         }
 528         string pdfauthor = process_keyval_opt(options, "pdfauthor");
 529         if (!pdfauthor.empty()) {
 530                 h_pdf_author = remove_braces(pdfauthor);
 531         }
 532         string pdfsubject = process_keyval_opt(options, "pdfsubject");
 533         if (!pdfsubject.empty())
 534                 h_pdf_subject = remove_braces(pdfsubject);
 535         string pdfkeywords = process_keyval_opt(options, "pdfkeywords");
 536         if (!pdfkeywords.empty())
 537                 h_pdf_keywords = remove_braces(pdfkeywords);
 538         if (!options.empty()) {
 539                 if (!h_pdf_quoted_options.empty())
 540                         h_pdf_quoted_options += ',';
 541                 h_pdf_quoted_options += join(options, ",");
 542                 options.clear();
 543         }
 544 }
 545
 546
 547 void Preamble::handle_package(Parser &p, string const & name,
 548                               string const & opts, bool in_lyx_preamble)
 549 {
 550         vector<string> options = split_options(opts);
 551         add_package(name, options);
 552         string scale;
 553
 554         if (is_known(name, known_xetex_packages))
 555                 xetex = true;
 556
 557         // roman fonts
 558         if (is_known(name, known_roman_fonts)) {
 559                 h_font_roman = name;
 560                 p.skip_spaces();
 561         }
 562
 563         if (name == "fourier") {
 564                 h_font_roman = "utopia";
 565                 // when font uses real small capitals
 566                 if (opts == "expert")
 567                         h_font_sc = "true";
 568         }
 569
 570         if (name == "mathpazo")
 571                 h_font_roman = "palatino";
 572
 573         if (name == "mathptmx")
 574                 h_font_roman = "times";
 575
 576         // sansserif fonts
 577         if (is_known(name, known_sans_fonts)) {
 578                 h_font_sans = name;
 579                 if (!opts.empty()) {
 580                         scale = opts;
 581                         h_font_sf_scale = scale_as_percentage(scale);
 582                 }
 583         }
 584
 585         // typewriter fonts
 586         if (is_known(name, known_typewriter_fonts)) {
 587                 // fourier can be set as roman font _only_
 588                 // fourier as typewriter is handled in handling of \ttdefault
 589                 if (name != "fourier") {
 590                         h_font_typewriter = name;
 591                         if (!opts.empty()) {
 592                                 scale = opts;
 593                                 h_font_tt_scale = scale_as_percentage(scale);
 594                         }
 595                 }
 596         }
 597
 598         // font uses old-style figure
 599         if (name == "eco")
 600                 h_font_osf = "true";
 601
 602         // after the detection and handling of special cases, we can remove the
 603         // fonts, otherwise they would appear in the preamble, see bug #7856
 604         if (is_known(name, known_roman_fonts) || is_known(name, known_sans_fonts)
 605                 ||      is_known(name, known_typewriter_fonts))
 606                 ;
 607
 608         else if (name == "amsmath" || name == "amssymb")
 609                 h_use_amsmath = "2";
 610
 611         else if (name == "esint")
 612                 h_use_esint = "2";
 613
 614         else if (name == "mhchem")
 615                 h_use_mhchem = "2";
 616
 617         else if (name == "mathdots")
 618                 h_use_mathdots = "2";
 619
 620         else if (name == "undertilde")
 621                 h_use_undertilde = "2";
 622
 623         else if (name == "babel") {
 624                 h_language_package = "default";
 625                 // One might think we would have to do nothing if babel is loaded
 626                 // without any options to prevent pollution of the preamble with this
 627                 // babel call in every roundtrip.
 628                 // But the user could have defined babel-specific things afterwards. So
 629                 // we need to keep it in the preamble to prevent cases like bug #7861.
 630                 if (!opts.empty()) {
 631                         // check if more than one option was used - used later for inputenc
 632                         if (options.begin() != options.end() - 1)
 633                                 one_language = false;
 634                         // babel takes the last language of the option of its \usepackage
 635                         // call as document language. If there is no such language option, the
 636                         // last language in the documentclass options is used.
 637                         handle_opt(options, known_languages, h_language);
 638                         // If babel is called with options, LyX puts them by default into the
 639                         // document class options. This works for most languages, except
 640                         // for Latvian, Lithuanian, Mongolian, Turkmen and Vietnamese and
 641                         // perhaps in future others.
 642                         // Therefore keep the babel call as it is as the user might have
 643                         // reasons for it.
 644                         h_preamble << "\\usepackage[" << opts << "]{babel}\n";
 645                         delete_opt(options, known_languages);
 646                 }
 647                 else
 648                         h_preamble << "\\usepackage{babel}\n";
 649         }
 650
 651         else if (name == "fontenc") {
 652                 h_fontencoding = getStringFromVector(options, ",");
 653                 /* We could do the following for better round trip support,
 654                  * but this makes the document less portable, so I skip it:
 655                 if (h_fontencoding == lyxrc.fontenc)
 656                         h_fontencoding = "global";
 657                  */
 658                 options.clear();
 659         }
 660
 661         else if (name == "inputenc" || name == "luainputenc") {
 662                 // h_inputencoding is only set when there is not more than one
 663                 // inputenc option because otherwise h_inputencoding must be
 664                 // set to "auto" (the default encoding of the document language)
 665                 // Therefore check for the "," character.
 666                 // It is also only set when there is not more than one babel
 667                 // language option.
 668                 if (opts.find(",") == string::npos && one_language == true)
 669                         h_inputencoding = opts;
 670                 if (!options.empty())
 671                         p.setEncoding(options.back());
 672                 options.clear();
 673         }
 674
 675         else if (is_known(name, known_old_language_packages)) {
 676                 // known language packages from the times before babel
 677                 // if they are found and not also babel, they will be used as
 678                 // cutom language package
 679                 h_language_package = "\\usepackage{" + name + "}";
 680         }
 681
 682         else if (name == "makeidx")
 683                 ; // ignore this
 684
 685         else if (name == "prettyref")
 686                 ; // ignore this
 687
 688         else if (name == "varioref")
 689                 ; // ignore this
 690
 691         else if (name == "verbatim")
 692                 ; // ignore this
 693
 694         else if (name == "nomencl")
 695                 ; // ignore this
 696
 697         else if (name == "textcomp")
 698                 ; // ignore this
 699
 700         else if (name == "url")
 701                 ; // ignore this
 702
 703         else if (name == "color" || name == "subscript" || name == "ulem") {
 704                 if (!in_lyx_preamble)
 705                         h_preamble << package_beg_sep << name
 706                                    << package_mid_sep << "\\usepackage{"
 707                                    << name << '}' << package_end_sep;
 708         }
 709
 710         else if (name == "graphicx")
 711                 ; // ignore this
 712
 713         else if (name == "setspace")
 714                 ; // ignore this
 715
 716         else if (name == "geometry")
 717                 ; // Ignore this, the geometry settings are made by the \geometry
 718                   // command. This command is handled below.
 719
 720         else if (name == "rotfloat")
 721                 ; // ignore this
 722
 723         else if (name == "wrapfig")
 724                 ; // ignore this
 725
 726         else if (name == "subfig")
 727                 ; // ignore this
 728
 729         else if (is_known(name, known_languages))
 730                 h_language = name;
 731
 732         else if (name == "natbib") {
 733                 h_cite_engine = "natbib_authoryear";
 734                 vector<string>::iterator it =
 735                         find(options.begin(), options.end(), "authoryear");
 736                 if (it != options.end())
 737                         options.erase(it);
 738                 else {
 739                         it = find(options.begin(), options.end(), "numbers");
 740                         if (it != options.end()) {
 741                                 h_cite_engine = "natbib_numerical";
 742                                 options.erase(it);
 743                         }
 744                 }
 745         }
 746
 747         else if (name == "jurabib")
 748                 h_cite_engine = "jurabib";
 749
 750         else if (name == "hyperref")
 751                 handle_hyperref(options);
 752
 753         else if (!in_lyx_preamble) {
 754                 if (options.empty())
 755                         h_preamble << "\\usepackage{" << name << "}";
 756                 else {
 757                         h_preamble << "\\usepackage[" << opts << "]{"
 758                                    << name << "}";
 759                         options.clear();
 760                 }
 761         }
 762
 763         // We need to do something with the options...
 764         if (!options.empty())
 765                 cerr << "Ignoring options '" << join(options, ",")
 766                      << "' of package " << name << '.' << endl;
 767
 768         // remove the whitespace
 769         p.skip_spaces();
 770 }
 771
 772
 773 void Preamble::handle_if(Parser & p, bool in_lyx_preamble)
 774 {
 775         while (p.good()) {
 776                 Token t = p.get_token();
 777                 if (t.cat() == catEscape &&
 778                     is_known(t.cs(), known_if_commands))
 779                         handle_if(p, in_lyx_preamble);
 780                 else {
 781                         if (!in_lyx_preamble)
 782                                 h_preamble << t.asInput();
 783                         if (t.cat() == catEscape && t.cs() == "fi")
 784                                 return;
 785                 }
 786         }
 787 }
 788
 789
 790 bool Preamble::writeLyXHeader(ostream & os)
 791 {
 792         // translate from babel to LyX names
 793         h_language = babel2lyx(h_language);
 794
 795         // set the quote language
 796         // LyX only knows the following quotes languages:
 797         // english, swedish, german, polish, french and danish
 798         // (quotes for "japanese" and "chinese-traditional" are missing because
 799         //  they wouldn't be useful: http://www.lyx.org/trac/ticket/6383)
 800         // conversion list taken from
 801         // http://en.wikipedia.org/wiki/Quotation_mark,_non-English_usage
 802         // (quotes for kazakh and interlingua are unknown)
 803         // danish
 804         if (h_language == "danish")
 805                 h_quotes_language = "danish";
 806         // french
 807         else if (is_known(h_language, known_french_quotes_languages))
 808                 h_quotes_language = "french";
 809         // german
 810         else if (is_known(h_language, known_german_quotes_languages))
 811                 h_quotes_language = "german";
 812         // polish
 813         else if (is_known(h_language, known_polish_quotes_languages))
 814                 h_quotes_language = "polish";
 815         // swedish
 816         else if (is_known(h_language, known_swedish_quotes_languages))
 817                 h_quotes_language = "swedish";
 818         //english
 819         else if (is_known(h_language, known_english_quotes_languages))
 820                 h_quotes_language = "english";
 821
 822         // output the LyX file settings
 823         os << "#LyX file created by tex2lyx " << PACKAGE_VERSION << "\n"
 824            << "\\lyxformat " << LYX_FORMAT << '\n'
 825            << "\\begin_document\n"
 826            << "\\begin_header\n"
 827            << "\\textclass " << h_textclass << "\n";
 828         string const raw = h_preamble.str();
 829         if (!raw.empty()) {
 830                 os << "\\begin_preamble\n";
 831                 for (string::size_type i = 0; i < raw.size(); ++i) {
 832                         if (raw[i] == package_beg_sep) {
 833                                 // Here follows some package loading code that
 834                                 // must be skipped if the package is loaded
 835                                 // automatically.
 836                                 string::size_type j = raw.find(package_mid_sep, i);
 837                                 if (j == string::npos)
 838                                         return false;
 839                                 string::size_type k = raw.find(package_end_sep, j);
 840                                 if (k == string::npos)
 841                                         return false;
 842                                 string const package = raw.substr(i + 1, j - i - 1);
 843                                 string const replacement = raw.substr(j + 1, k - j - 1);
 844                                 if (auto_packages.find(package) == auto_packages.end())
 845                                         os << replacement;
 846                                 i = k;
 847                         } else
 848                                 os.put(raw[i]);
 849                 }
 850                 os << "\n\\end_preamble\n";
 851         }
 852         if (!h_options.empty())
 853                 os << "\\options " << h_options << "\n";
 854         os << "\\use_default_options " << h_use_default_options << "\n";
 855         if (!used_modules.empty()) {
 856                 os << "\\begin_modules\n";
 857                 vector<string>::const_iterator const end = used_modules.end();
 858                 vector<string>::const_iterator it = used_modules.begin();
 859                 for (; it != end; it++)
 860                         os << *it << '\n';
 861                 os << "\\end_modules\n";
 862         }
 863         os << "\\language " << h_language << "\n"
 864            << "\\language_package " << h_language_package << "\n"
 865            << "\\inputencoding " << h_inputencoding << "\n"
 866            << "\\fontencoding " << h_fontencoding << "\n"
 867            << "\\font_roman " << h_font_roman << "\n"
 868            << "\\font_sans " << h_font_sans << "\n"
 869            << "\\font_typewriter " << h_font_typewriter << "\n"
 870            << "\\font_default_family " << h_font_default_family << "\n"
 871            << "\\font_sc " << h_font_sc << "\n"
 872            << "\\font_osf " << h_font_osf << "\n"
 873            << "\\font_sf_scale " << h_font_sf_scale << "\n"
 874            << "\\font_tt_scale " << h_font_tt_scale << "\n"
 875            << "\\graphics " << h_graphics << "\n";
 876         if (!h_float_placement.empty())
 877                 os << "\\float_placement " << h_float_placement << "\n";
 878         os << "\\paperfontsize " << h_paperfontsize << "\n"
 879            << "\\spacing " << h_spacing << "\n"
 880            << "\\use_hyperref " << h_use_hyperref << '\n';
 881         if (h_use_hyperref == "1") {
 882                 if (!h_pdf_title.empty())
 883                         os << "\\pdf_title \"" << h_pdf_title << "\"\n";
 884                 if (!h_pdf_author.empty())
 885                         os << "\\pdf_author \"" << h_pdf_author << "\"\n";
 886                 if (!h_pdf_subject.empty())
 887                         os << "\\pdf_subject \"" << h_pdf_subject << "\"\n";
 888                 if (!h_pdf_keywords.empty())
 889                         os << "\\pdf_keywords \"" << h_pdf_keywords << "\"\n";
 890                 os << "\\pdf_bookmarks " << h_pdf_bookmarks << "\n"
 891                       "\\pdf_bookmarksnumbered " << h_pdf_bookmarksnumbered << "\n"
 892                       "\\pdf_bookmarksopen " << h_pdf_bookmarksopen << "\n"
 893                       "\\pdf_bookmarksopenlevel " << h_pdf_bookmarksopenlevel << "\n"
 894                       "\\pdf_breaklinks " << h_pdf_breaklinks << "\n"
 895                       "\\pdf_pdfborder " << h_pdf_pdfborder << "\n"
 896                       "\\pdf_colorlinks " << h_pdf_colorlinks << "\n"
 897                       "\\pdf_backref " << h_pdf_backref << "\n"
 898                       "\\pdf_pdfusetitle " << h_pdf_pdfusetitle << '\n';
 899                 if (!h_pdf_pagemode.empty())
 900                         os << "\\pdf_pagemode " << h_pdf_pagemode << '\n';
 901                 if (!h_pdf_quoted_options.empty())
 902                         os << "\\pdf_quoted_options \"" << h_pdf_quoted_options << "\"\n";
 903         }
 904         os << "\\papersize " << h_papersize << "\n"
 905            << "\\use_geometry " << h_use_geometry << "\n"
 906            << "\\use_amsmath " << h_use_amsmath << "\n"
 907            << "\\use_esint " << h_use_esint << "\n"
 908            << "\\use_mhchem " << h_use_mhchem << "\n"
 909            << "\\use_mathdots " << h_use_mathdots << "\n"
 910            << "\\use_undertilde " << h_use_undertilde << "\n"
 911            << "\\cite_engine " << h_cite_engine << "\n"
 912            << "\\use_bibtopic " << h_use_bibtopic << "\n"
 913            << "\\paperorientation " << h_paperorientation << '\n'
 914            << "\\suppress_date " << h_suppress_date << '\n'
 915            << "\\use_refstyle " << h_use_refstyle << '\n';
 916         if (!h_fontcolor.empty())
 917                 os << "\\fontcolor " << h_fontcolor << '\n';
 918         if (!h_notefontcolor.empty())
 919                 os << "\\notefontcolor " << h_notefontcolor << '\n';
 920         if (!h_backgroundcolor.empty())
 921                 os << "\\backgroundcolor " << h_backgroundcolor << '\n';
 922         if (!h_boxbgcolor.empty())
 923                 os << "\\boxbgcolor " << h_boxbgcolor << '\n';
 924         os << h_margins
 925            << "\\secnumdepth " << h_secnumdepth << "\n"
 926            << "\\tocdepth " << h_tocdepth << "\n"
 927            << "\\paragraph_separation " << h_paragraph_separation << "\n";
 928         if (h_paragraph_separation == "skip")
 929                 os << "\\defskip " << h_defskip << "\n";
 930         else
 931                 os << "\\paragraph_indentation " << h_paragraph_indentation << "\n";
 932         os << "\\quotes_language " << h_quotes_language << "\n"
 933            << "\\papercolumns " << h_papercolumns << "\n"
 934            << "\\papersides " << h_papersides << "\n"
 935            << "\\paperpagestyle " << h_paperpagestyle << "\n";
 936         if (!h_listings_params.empty())
 937                 os << "\\listings_params " << h_listings_params << "\n";
 938         os << "\\tracking_changes " << h_tracking_changes << "\n"
 939            << "\\output_changes " << h_output_changes << "\n"
 940            << "\\html_math_output " << h_html_math_output << "\n"
 941            << "\\html_css_as_file " << h_html_css_as_file << "\n"
 942            << "\\html_be_strict " << h_html_be_strict << "\n"
 943            << authors_
 944            << "\\end_header\n\n"
 945            << "\\begin_body\n";
 946         // clear preamble for subdocuments
 947         h_preamble.str("");
 948         return true;
 949 }
 950
 951
 952 void Preamble::parse(Parser & p, string const & forceclass,
 953                      TeX2LyXDocClass & tc)
 954 {
 955         // initialize fixed types
 956         special_columns['D'] = 3;
 957         bool is_full_document = false;
 958         bool is_lyx_file = false;
 959         bool in_lyx_preamble = false;
 960
 961         // determine whether this is a full document or a fragment for inclusion
 962         while (p.good()) {
 963                 Token const & t = p.get_token();
 964
 965                 if (t.cat() == catEscape && t.cs() == "documentclass") {
 966                         is_full_document = true;
 967                         break;
 968                 }
 969         }
 970         p.reset();
 971
 972         while (is_full_document && p.good()) {
 973                 Token const & t = p.get_token();
 974
 975 #ifdef FILEDEBUG
 976                 cerr << "t: " << t << "\n";
 977 #endif
 978
 979                 //
 980                 // cat codes
 981                 //
 982                 if (!in_lyx_preamble &&
 983                     (t.cat() == catLetter ||
 984                      t.cat() == catSuper ||
 985                      t.cat() == catSub ||
 986                      t.cat() == catOther ||
 987                      t.cat() == catMath ||
 988                      t.cat() == catActive ||
 989                      t.cat() == catBegin ||
 990                      t.cat() == catEnd ||
 991                      t.cat() == catAlign ||
 992                      t.cat() == catParameter))
 993                         h_preamble << t.cs();
 994
 995                 else if (!in_lyx_preamble &&
 996                          (t.cat() == catSpace || t.cat() == catNewline))
 997                         h_preamble << t.asInput();
 998
 999                 else if (t.cat() == catComment) {
1000                         static regex const islyxfile("%% LyX .* created this file");
1001                         static regex const usercommands("User specified LaTeX commands");
1002
1003                         string const comment = t.asInput();
1004
1005                         // magically switch encoding default if it looks like XeLaTeX
1006                         static string const magicXeLaTeX =
1007                                 "% This document must be compiled with XeLaTeX ";
1008                         if (comment.size() > magicXeLaTeX.size()
1009                                   && comment.substr(0, magicXeLaTeX.size()) == magicXeLaTeX
1010                                   && h_inputencoding == "auto") {
1011                                 cerr << "XeLaTeX comment found, switching to UTF8\n";
1012                                 h_inputencoding = "utf8";
1013                         }
1014                         smatch sub;
1015                         if (regex_search(comment, sub, islyxfile)) {
1016                                 is_lyx_file = true;
1017                                 in_lyx_preamble = true;
1018                         } else if (is_lyx_file
1019                                    && regex_search(comment, sub, usercommands))
1020                                 in_lyx_preamble = false;
1021                         else if (!in_lyx_preamble)
1022                                 h_preamble << t.asInput();
1023                 }
1024
1025                 else if (t.cs() == "pagestyle")
1026                         h_paperpagestyle = p.verbatim_item();
1027
1028                 else if (t.cs() == "date") {
1029                         string argument = p.getArg('{', '}');
1030                         if (argument.empty())
1031                                 h_suppress_date = "true";
1032                         else
1033                                 h_preamble << t.asInput() << '{' << argument << '}';
1034                 }
1035
1036                 else if (t.cs() == "color") {
1037                         string const space =
1038                                 (p.hasOpt() ? p.getOpt() : string());
1039                         string argument = p.getArg('{', '}');
1040                         // check the case that a standard color is used
1041                         if (space.empty() && is_known(argument, known_basic_colors)) {
1042                                 h_fontcolor = rgbcolor2code(argument);
1043                                 preamble.registerAutomaticallyLoadedPackage("color");
1044                         } else if (space.empty() && argument == "document_fontcolor")
1045                                 preamble.registerAutomaticallyLoadedPackage("color");
1046                         // check the case that LyX's document_fontcolor is defined
1047                         // but not used for \color
1048                         else {
1049                                 h_preamble << t.asInput();
1050                                 if (!space.empty())
1051                                         h_preamble << space;
1052                                 h_preamble << '{' << argument << '}';
1053                                 // the color might already be set because \definecolor
1054                                 // is parsed before this
1055                                 h_fontcolor = "";
1056                         }
1057                 }
1058
1059                 else if (t.cs() == "pagecolor") {
1060                         string argument = p.getArg('{', '}');
1061                         // check the case that a standard color is used
1062                         if (is_known(argument, known_basic_colors)) {
1063                                 h_backgroundcolor = rgbcolor2code(argument);
1064                         } else if (argument == "page_backgroundcolor")
1065                                 preamble.registerAutomaticallyLoadedPackage("color");
1066                         // check the case that LyX's page_backgroundcolor is defined
1067                         // but not used for \pagecolor
1068                         else {
1069                                 h_preamble << t.asInput() << '{' << argument << '}';
1070                                 // the color might already be set because \definecolor
1071                                 // is parsed before this
1072                                 h_backgroundcolor = "";
1073                         }
1074                 }
1075
1076                 else if (t.cs() == "makeatletter") {
1077                         // LyX takes care of this
1078                         p.setCatCode('@', catLetter);
1079                 }
1080
1081                 else if (t.cs() == "makeatother") {
1082                         // LyX takes care of this
1083                         p.setCatCode('@', catOther);
1084                 }
1085
1086                 else if (t.cs() == "newcommand" || t.cs() == "newcommandx"
1087                       || t.cs() == "renewcommand" || t.cs() == "renewcommandx"
1088                       || t.cs() == "providecommand" || t.cs() == "providecommandx"
1089                                 || t.cs() == "DeclareRobustCommand"
1090                       || t.cs() == "DeclareRobustCommandx"
1091                                 || t.cs() == "ProvideTextCommandDefault"
1092                                 || t.cs() == "DeclareMathAccent") {
1093                         bool star = false;
1094                         if (p.next_token().character() == '*') {
1095                                 p.get_token();
1096                                 star = true;
1097                         }
1098                         string const name = p.verbatim_item();
1099                         string const opt1 = p.getFullOpt();
1100                         string const opt2 = p.getFullOpt();
1101                         string const body = p.verbatim_item();
1102                         // font settings
1103                         if (name == "\\rmdefault")
1104                                 if (is_known(body, known_roman_fonts))
1105                                         h_font_roman = body;
1106                         if (name == "\\sfdefault")
1107                                 if (is_known(body, known_sans_fonts))
1108                                         h_font_sans = body;
1109                         if (name == "\\ttdefault")
1110                                 if (is_known(body, known_typewriter_fonts))
1111                                         h_font_typewriter = body;
1112                         if (name == "\\familydefault") {
1113                                 string family = body;
1114                                 // remove leading "\"
1115                                 h_font_default_family = family.erase(0,1);
1116                         }
1117
1118                         // Add the command to the known commands
1119                         add_known_command(name, opt1, !opt2.empty(), from_utf8(body));
1120
1121                         // only non-lyxspecific stuff
1122                         if (!in_lyx_preamble) {
1123                                 ostringstream ss;
1124                                 ss << '\\' << t.cs();
1125                                 if (star)
1126                                         ss << '*';
1127                                 ss << '{' << name << '}' << opt1 << opt2
1128                                    << '{' << body << "}";
1129                                 h_preamble << ss.str();
1130 /*
1131                                 ostream & out = in_preamble ? h_preamble : os;
1132                                 out << "\\" << t.cs() << "{" << name << "}"
1133                                     << opts << "{" << body << "}";
1134 */
1135                         }
1136                 }
1137
1138                 else if (t.cs() == "documentclass") {
1139                         vector<string>::iterator it;
1140                         vector<string> opts = split_options(p.getArg('[', ']'));
1141                         handle_opt(opts, known_fontsizes, h_paperfontsize);
1142                         delete_opt(opts, known_fontsizes);
1143                         // delete "pt" at the end
1144                         string::size_type i = h_paperfontsize.find("pt");
1145                         if (i != string::npos)
1146                                 h_paperfontsize.erase(i);
1147                         // The documentclass options are always parsed before the options
1148                         // of the babel call so that a language cannot overwrite the babel
1149                         // options.
1150                         handle_opt(opts, known_languages, h_language);
1151                         delete_opt(opts, known_languages);
1152
1153                         // paper orientation
1154                         if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
1155                                 h_paperorientation = "landscape";
1156                                 opts.erase(it);
1157                         }
1158                         // paper sides
1159                         if ((it = find(opts.begin(), opts.end(), "oneside"))
1160                                  != opts.end()) {
1161                                 h_papersides = "1";
1162                                 opts.erase(it);
1163                         }
1164                         if ((it = find(opts.begin(), opts.end(), "twoside"))
1165                                  != opts.end()) {
1166                                 h_papersides = "2";
1167                                 opts.erase(it);
1168                         }
1169                         // paper columns
1170                         if ((it = find(opts.begin(), opts.end(), "onecolumn"))
1171                                  != opts.end()) {
1172                                 h_papercolumns = "1";
1173                                 opts.erase(it);
1174                         }
1175                         if ((it = find(opts.begin(), opts.end(), "twocolumn"))
1176                                  != opts.end()) {
1177                                 h_papercolumns = "2";
1178                                 opts.erase(it);
1179                         }
1180                         // paper sizes
1181                         // some size options are know to any document classes, other sizes
1182                         // are handled by the \geometry command of the geometry package
1183                         handle_opt(opts, known_class_paper_sizes, h_papersize);
1184                         delete_opt(opts, known_class_paper_sizes);
1185                         // the remaining options
1186                         h_options = join(opts, ",");
1187                         // FIXME This does not work for classes that have a
1188                         //       different name in LyX than in LaTeX
1189                         h_textclass = p.getArg('{', '}');
1190                 }
1191
1192                 else if (t.cs() == "usepackage") {
1193                         string const options = p.getArg('[', ']');
1194                         string const name = p.getArg('{', '}');
1195                         vector<string> vecnames;
1196                         split(name, vecnames, ',');
1197                         vector<string>::const_iterator it  = vecnames.begin();
1198                         vector<string>::const_iterator end = vecnames.end();
1199                         for (; it != end; ++it)
1200                                 handle_package(p, trimSpaceAndEol(*it), options,
1201                                                in_lyx_preamble);
1202                 }
1203
1204                 else if (t.cs() == "inputencoding") {
1205                         string const encoding = p.getArg('{','}');
1206                         h_inputencoding = encoding;
1207                         p.setEncoding(encoding);
1208                 }
1209
1210                 else if (t.cs() == "newenvironment") {
1211                         string const name = p.getArg('{', '}');
1212                         string const opt1 = p.getFullOpt();
1213                         string const opt2 = p.getFullOpt();
1214                         string const beg = p.verbatim_item();
1215                         string const end = p.verbatim_item();
1216                         if (!in_lyx_preamble) {
1217                                 h_preamble << "\\newenvironment{" << name
1218                                            << '}' << opt1 << opt2 << '{'
1219                                            << beg << "}{" << end << '}';
1220                         }
1221                         add_known_environment(name, opt1, !opt2.empty(),
1222                                               from_utf8(beg), from_utf8(end));
1223
1224                 }
1225
1226                 else if (t.cs() == "def") {
1227                         string name = p.get_token().cs();
1228                         while (p.next_token().cat() != catBegin)
1229                                 name += p.get_token().cs();
1230                         if (!in_lyx_preamble)
1231                                 h_preamble << "\\def\\" << name << '{'
1232                                            << p.verbatim_item() << "}";
1233                 }
1234
1235                 else if (t.cs() == "newcolumntype") {
1236                         string const name = p.getArg('{', '}');
1237                         trimSpaceAndEol(name);
1238                         int nargs = 0;
1239                         string opts = p.getOpt();
1240                         if (!opts.empty()) {
1241                                 istringstream is(string(opts, 1));
1242                                 is >> nargs;
1243                         }
1244                         special_columns[name[0]] = nargs;
1245                         h_preamble << "\\newcolumntype{" << name << "}";
1246                         if (nargs)
1247                                 h_preamble << "[" << nargs << "]";
1248                         h_preamble << "{" << p.verbatim_item() << "}";
1249                 }
1250
1251                 else if (t.cs() == "setcounter") {
1252                         string const name = p.getArg('{', '}');
1253                         string const content = p.getArg('{', '}');
1254                         if (name == "secnumdepth")
1255                                 h_secnumdepth = content;
1256                         else if (name == "tocdepth")
1257                                 h_tocdepth = content;
1258                         else
1259                                 h_preamble << "\\setcounter{" << name << "}{" << content << "}";
1260                 }
1261
1262                 else if (t.cs() == "setlength") {
1263                         string const name = p.verbatim_item();
1264                         string const content = p.verbatim_item();
1265                         // the paragraphs are only not indented when \parindent is set to zero
1266                         if (name == "\\parindent" && content != "") {
1267                                 if (content[0] == '0')
1268                                         h_paragraph_separation = "skip";
1269                                 else
1270                                         h_paragraph_indentation = translate_len(content);
1271                         } else if (name == "\\parskip") {
1272                                 if (content == "\\smallskipamount")
1273                                         h_defskip = "smallskip";
1274                                 else if (content == "\\medskipamount")
1275                                         h_defskip = "medskip";
1276                                 else if (content == "\\bigskipamount")
1277                                         h_defskip = "bigskip";
1278                                 else
1279                                         h_defskip = content;
1280                         } else
1281                                 h_preamble << "\\setlength{" << name << "}{" << content << "}";
1282                 }
1283
1284                 else if (t.cs() == "onehalfspacing")
1285                         h_spacing = "onehalf";
1286
1287                 else if (t.cs() == "doublespacing")
1288                         h_spacing = "double";
1289
1290                 else if (t.cs() == "setstretch")
1291                         h_spacing = "other " + p.verbatim_item();
1292
1293                 else if (t.cs() == "begin") {
1294                         string const name = p.getArg('{', '}');
1295                         if (name == "document")
1296                                 break;
1297                         h_preamble << "\\begin{" << name << "}";
1298                 }
1299
1300                 else if (t.cs() == "geometry") {
1301                         h_use_geometry = "true";
1302                         vector<string> opts = split_options(p.getArg('{', '}'));
1303                         vector<string>::iterator it;
1304                         // paper orientation
1305                         if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
1306                                 h_paperorientation = "landscape";
1307                                 opts.erase(it);
1308                         }
1309                         // paper size
1310                         handle_opt(opts, known_paper_sizes, h_papersize);
1311                         delete_opt(opts, known_paper_sizes);
1312                         // page margins
1313                         char const * const * margin = known_paper_margins;
1314                         int k = -1;
1315                         for (; *margin; ++margin) {
1316                                 k += 1;
1317                                 // search for the "=" in e.g. "lmargin=2cm" to get the value
1318                                 for(size_t i = 0; i != opts.size(); i++) {
1319                                         if (opts.at(i).find(*margin) != string::npos) {
1320                                                 string::size_type pos = opts.at(i).find("=");
1321                                                 string value = opts.at(i).substr(pos + 1);
1322                                                 string name = known_coded_paper_margins[k];
1323                                                 h_margins += "\\" + name + " " + value + "\n";
1324                                         }
1325                                 }
1326                         }
1327                 }
1328
1329                 else if (t.cs() == "definecolor") {
1330                         string const color = p.getArg('{', '}');
1331                         string const space = p.getArg('{', '}');
1332                         string const value = p.getArg('{', '}');
1333                         if (color == "document_fontcolor" && space == "rgb") {
1334                                 RGBColor c(RGBColorFromLaTeX(value));
1335                                 h_fontcolor = X11hexname(c);
1336                         } else if (color == "note_fontcolor" && space == "rgb") {
1337                                 RGBColor c(RGBColorFromLaTeX(value));
1338                                 h_notefontcolor = X11hexname(c);
1339                         } else if (color == "page_backgroundcolor" && space == "rgb") {
1340                                 RGBColor c(RGBColorFromLaTeX(value));
1341                                 h_backgroundcolor = X11hexname(c);
1342                         } else if (color == "shadecolor" && space == "rgb") {
1343                                 RGBColor c(RGBColorFromLaTeX(value));
1344                                 h_boxbgcolor = X11hexname(c);
1345                         } else {
1346                                 h_preamble << "\\definecolor{" << color
1347                                            << "}{" << space << "}{" << value
1348                                            << '}';
1349                         }
1350                 }
1351
1352                 else if (t.cs() == "jurabibsetup") {
1353                         // FIXME p.getArg('{', '}') is most probably wrong (it
1354                         //       does not handle nested braces).
1355                         //       Use p.verbatim_item() instead.
1356                         vector<string> jurabibsetup =
1357                                 split_options(p.getArg('{', '}'));
1358                         // add jurabibsetup to the jurabib package options
1359                         add_package("jurabib", jurabibsetup);
1360                         if (!jurabibsetup.empty()) {
1361                                 h_preamble << "\\jurabibsetup{"
1362                                            << join(jurabibsetup, ",") << '}';
1363                         }
1364                 }
1365
1366                 else if (t.cs() == "hypersetup") {
1367                         vector<string> hypersetup =
1368                                 split_options(p.verbatim_item());
1369                         // add hypersetup to the hyperref package options
1370                         handle_hyperref(hypersetup);
1371                         if (!hypersetup.empty()) {
1372                                 h_preamble << "\\hypersetup{"
1373                                            << join(hypersetup, ",") << '}';
1374                         }
1375                 }
1376
1377                 else if (is_known(t.cs(), known_if_3arg_commands)) {
1378                         // prevent misparsing of \usepackage if it is used
1379                         // as an argument (see e.g. our own output of
1380                         // \@ifundefined above)
1381                         string const arg1 = p.verbatim_item();
1382                         string const arg2 = p.verbatim_item();
1383                         string const arg3 = p.verbatim_item();
1384                         // test case \@ifundefined{date}{}{\date{}}
1385                         if (t.cs() == "@ifundefined" && arg1 == "date" &&
1386                             arg2.empty() && arg3 == "\\date{}") {
1387                                 h_suppress_date = "true";
1388                         // older tex2lyx versions did output
1389                         // \@ifundefined{definecolor}{\usepackage{color}}{}
1390                         } else if (t.cs() == "@ifundefined" &&
1391                                    arg1 == "definecolor" &&
1392                                    arg2 == "\\usepackage{color}" &&
1393                                    arg3.empty()) {
1394                                 if (!in_lyx_preamble)
1395                                         h_preamble << package_beg_sep
1396                                                    << "color"
1397                                                    << package_mid_sep
1398                                                    << "\\@ifundefined{definecolor}{color}{}"
1399                                                    << package_end_sep;
1400                         // test for case
1401                         //\@ifundefined{showcaptionsetup}{}{%
1402                         // \PassOptionsToPackage{caption=false}{subfig}}
1403                         // that LyX uses for subfloats
1404                         } else if (t.cs() == "@ifundefined" &&
1405                                    arg1 == "showcaptionsetup" && arg2.empty()
1406                                 && arg3 == "%\n \\PassOptionsToPackage{caption=false}{subfig}") {
1407                                 ; // do nothing
1408                         } else if (!in_lyx_preamble) {
1409                                 h_preamble << t.asInput()
1410                                            << '{' << arg1 << '}'
1411                                            << '{' << arg2 << '}'
1412                                            << '{' << arg3 << '}';
1413                         }
1414                 }
1415
1416                 else if (is_known(t.cs(), known_if_commands)) {
1417                         // must not parse anything in conditional code, since
1418                         // LyX would output the parsed contents unconditionally
1419                         if (!in_lyx_preamble)
1420                                 h_preamble << t.asInput();
1421                         handle_if(p, in_lyx_preamble);
1422                 }
1423
1424                 else if (!t.cs().empty() && !in_lyx_preamble)
1425                         h_preamble << '\\' << t.cs();
1426         }
1427
1428         // remove the whitespace
1429         p.skip_spaces();
1430
1431         // Force textclass if the user wanted it
1432         if (!forceclass.empty())
1433                 h_textclass = forceclass;
1434         if (noweb_mode && !prefixIs(h_textclass, "literate-"))
1435                 h_textclass.insert(0, "literate-");
1436         tc.setName(h_textclass);
1437         if (!tc.load()) {
1438                 cerr << "Error: Could not read layout file for textclass \"" << h_textclass << "\"." << endl;
1439                 exit(EXIT_FAILURE);
1440         }
1441         if (h_papersides.empty()) {
1442                 ostringstream ss;
1443                 ss << tc.sides();
1444                 h_papersides = ss.str();
1445         }
1446 }
1447
1448
1449 string babel2lyx(string const & language)
1450 {
1451         char const * const * where = is_known(language, known_languages);
1452         if (where)
1453                 return known_coded_languages[where - known_languages];
1454         return language;
1455 }
1456
1457
1458 string rgbcolor2code(string const & name)
1459 {
1460         char const * const * where = is_known(name, known_basic_colors);
1461         if (where) {
1462                 // "red", "green" etc
1463                 return known_basic_color_codes[where - known_basic_colors];
1464         }
1465         // "255,0,0", "0,255,0" etc
1466         RGBColor c(RGBColorFromLaTeX(name));
1467         return X11hexname(c);
1468 }
1469
1470 // }])
1471
1472
1473 } // namespace lyx