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 "Encoding.h"
  20 #include "LayoutFile.h"
  21 #include "Layout.h"
  22 #include "Lexer.h"
  23 #include "TextClass.h"
  24
  25 #include "support/convert.h"
  26 #include "support/FileName.h"
  27 #include "support/filetools.h"
  28 #include "support/lstrings.h"
  29
  30 #include "support/regex.h"
  31
  32 #include <algorithm>
  33 #include <iostream>
  34
  35 using namespace std;
  36 using namespace lyx::support;
  37
  38
  39 namespace lyx {
  40
  41 // special columntypes
  42 extern map<char, int> special_columns;
  43
  44 Preamble preamble;
  45
  46 namespace {
  47
  48 // CJK languages are handled in text.cpp, polyglossia languages are listed
  49 // further down.
  50 /**
  51  * known babel language names (including synonyms)
  52  * not in standard babel: arabic, arabtex, armenian, belarusian, serbian-latin, thai
  53  * please keep this in sync with known_coded_languages line by line!
  54  */
  55 const char * const known_languages[] = {"acadian", "afrikaans", "albanian",
  56 "american", "arabic", "arabtex", "australian", "austrian", "bahasa", "bahasai",
  57 "bahasam", "basque", "belarusian", "brazil", "brazilian", "breton", "british",
  58 "bulgarian", "canadian", "canadien", "catalan", "croatian", "czech", "danish",
  59 "dutch", "english", "esperanto", "estonian", "farsi", "finnish", "francais",
  60 "french", "frenchb", "frenchle", "frenchpro", "galician", "german", "germanb",
  61 "greek", "hebrew", "hungarian", "icelandic", "indon", "indonesian", "interlingua",
  62 "irish", "italian", "japanese", "kazakh", "kurmanji", "latin", "latvian", "lithuanian",
  63 "lowersorbian", "lsorbian", "magyar", "malay", "meyalu", "mongolian", "naustrian",
  64 "newzealand", "ngerman", "ngermanb", "norsk", "nynorsk", "polutonikogreek", "polish",
  65 "portuges", "portuguese", "romanian", "russian", "russianb", "samin",
  66 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
  67 "swedish", "thai", "turkish", "turkmen", "ukraineb", "ukrainian",
  68 "uppersorbian", "UKenglish", "USenglish", "usorbian", "vietnam", "welsh",
  69 0};
  70
  71 /**
  72  * the same as known_languages with .lyx names
  73  * please keep this in sync with known_languages line by line!
  74  */
  75 const char * const known_coded_languages[] = {"french", "afrikaans", "albanian",
  76 "american", "arabic_arabi", "arabic_arabtex", "australian", "austrian", "bahasa", "bahasa",
  77 "bahasam", "basque", "belarusian", "brazilian", "brazilian", "breton", "british",
  78 "bulgarian", "canadian", "canadien", "catalan", "croatian", "czech", "danish",
  79 "dutch", "english", "esperanto", "estonian", "farsi", "finnish", "french",
  80 "french", "french", "french", "french", "galician", "german", "german",
  81 "greek", "hebrew", "magyar", "icelandic", "bahasa", "bahasa", "interlingua",
  82 "irish", "italian", "japanese", "kazakh", "kurmanji", "latin", "latvian", "lithuanian",
  83 "lowersorbian", "lowersorbian", "magyar", "bahasam", "bahasam", "mongolian", "naustrian",
  84 "newzealand", "ngerman", "ngerman", "norsk", "nynorsk", "polutonikogreek", "polish",
  85 "portuguese", "portuguese", "romanian", "russian", "russian", "samin",
  86 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
  87 "swedish", "thai", "turkish", "turkmen", "ukrainian", "ukrainian",
  88 "uppersorbian", "uppersorbian", "english", "english", "vietnamese", "welsh",
  89 0};
  90
  91 /// languages with danish quotes (.lyx names)
  92 const char * const known_danish_quotes_languages[] = {"danish", 0};
  93
  94 /// languages with english quotes (.lyx names)
  95 const char * const known_english_quotes_languages[] = {"american", "australian",
  96 "bahasa", "bahasam", "brazilian", "canadian", "chinese-simplified", "english",
  97 "esperanto", "hebrew", "irish", "korean", "newzealand", "portuguese", "scottish",
  98 "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", "garamondx", "libertine",
 128 "libertine-type1", "lmodern", "mathdesign", "mathpazo", "mathptmx", "newcent",
 129 "tgbonum", "tgchorus", "tgpagella", "tgschola", "tgtermes", "utopia", 0};
 130
 131 const char * const known_sans_fonts[] = { "avant", "berasans", "biolinum-type1",
 132 "cmbr", "cmss", "helvet", "kurier", "kurierl", "lmss", "tgadventor", "tgheros", 0};
 133
 134 const char * const known_kurier_fonts[] = { "kurier", "kurierl",
 135 "kurier-condensed", "kurier-light-condensed", 0};
 136
 137 const char * const known_typewriter_fonts[] = { "beramono", "cmtl", "cmtt",
 138 "courier", "lmtt", "luximono", "fourier", "lmodern", "mathpazo", "mathptmx",
 139 "newcent", "tgcursor", "txtt", 0};
 140
 141 const char * const known_math_fonts[] = { "eulervm", "newtxmath", 0};
 142
 143 const char * const known_paper_sizes[] = { "a0paper", "b0paper", "c0paper",
 144 "a1paper", "b1paper", "c1paper", "a2paper", "b2paper", "c2paper", "a3paper",
 145 "b3paper", "c3paper", "a4paper", "b4paper", "c4paper", "a5paper", "b5paper",
 146 "c5paper", "a6paper", "b6paper", "c6paper", "executivepaper", "legalpaper",
 147 "letterpaper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j", "b6j", 0};
 148
 149 const char * const known_class_paper_sizes[] = { "a4paper", "a5paper",
 150 "executivepaper", "legalpaper", "letterpaper", 0};
 151
 152 const char * const known_paper_margins[] = { "lmargin", "tmargin", "rmargin",
 153 "bmargin", "headheight", "headsep", "footskip", "columnsep", 0};
 154
 155 const char * const known_coded_paper_margins[] = { "leftmargin", "topmargin",
 156 "rightmargin", "bottommargin", "headheight", "headsep", "footskip",
 157 "columnsep", 0};
 158
 159 /// commands that can start an \if...\else...\endif sequence
 160 const char * const known_if_commands[] = {"if", "ifarydshln", "ifbraket",
 161 "ifcancel", "ifcolortbl", "ifeurosym", "ifmarginnote", "ifmmode", "ifpdf",
 162 "ifsidecap", "ifupgreek", 0};
 163
 164 const char * const known_basic_colors[] = {"blue", "black", "cyan", "green",
 165 "magenta", "red", "white", "yellow", 0};
 166
 167 const char * const known_basic_color_codes[] = {"#0000ff", "#000000", "#00ffff",
 168 "#00ff00", "#ff00ff", "#ff0000", "#ffffff", "#ffff00", 0};
 169
 170 /// conditional commands with three arguments like \@ifundefined{}{}{}
 171 const char * const known_if_3arg_commands[] = {"@ifundefined", "IfFileExists",
 172 0};
 173
 174 /// packages that work only in xetex
 175 /// polyglossia is handled separately
 176 const char * const known_xetex_packages[] = {"arabxetex", "fixlatvian",
 177 "fontbook", "fontwrap", "mathspec", "philokalia", "unisugar",
 178 "xeCJK", "xecolor", "xecyr", "xeindex", "xepersian", "xunicode", 0};
 179
 180 /// packages that are automatically skipped if loaded by LyX
 181 const char * const known_lyx_packages[] = {"amsbsy", "amsmath", "amssymb",
 182 "amstext", "amsthm", "array", "babel", "booktabs", "calc", "CJK", "color",
 183 "float", "fontspec", "graphicx", "hhline", "ifthen", "longtable", "makeidx",
 184 "multirow", "nomencl", "pdfpages", "refstyle", "rotating", "rotfloat", "splitidx",
 185 "setspace", "subscript", "textcomp", "tipa", "tipx", "tone", "ulem", "url",
 186 "varioref", "verbatim", "wrapfig", "xunicode", 0};
 187
 188 // used for the handling of \newindex
 189 int index_number = 0;
 190
 191 // codes used to remove packages that are loaded automatically by LyX.
 192 // Syntax: package_beg_sep<name>package_mid_sep<package loading code>package_end_sep
 193 const char package_beg_sep = '\001';
 194 const char package_mid_sep = '\002';
 195 const char package_end_sep = '\003';
 196
 197
 198 // returns true if at least one of the options in what has been found
 199 bool handle_opt(vector<string> & opts, char const * const * what, string & target)
 200 {
 201         if (opts.empty())
 202                 return false;
 203
 204         bool found = false;
 205         // the last language option is the document language (for babel and LyX)
 206         // the last size option is the document font size
 207         vector<string>::iterator it;
 208         vector<string>::iterator position = opts.begin();
 209         for (; *what; ++what) {
 210                 it = find(opts.begin(), opts.end(), *what);
 211                 if (it != opts.end()) {
 212                         if (it >= position) {
 213                                 found = true;
 214                                 target = *what;
 215                                 position = it;
 216                         }
 217                 }
 218         }
 219         return found;
 220 }
 221
 222
 223 void delete_opt(vector<string> & opts, char const * const * what)
 224 {
 225         if (opts.empty())
 226                 return;
 227
 228         // remove found options from the list
 229         // do this after handle_opt to avoid potential memory leaks
 230         vector<string>::iterator it;
 231         for (; *what; ++what) {
 232                 it = find(opts.begin(), opts.end(), *what);
 233                 if (it != opts.end())
 234                         opts.erase(it);
 235         }
 236 }
 237
 238
 239 /*!
 240  * Split a package options string (keyval format) into a vector.
 241  * Example input:
 242  *   authorformat=smallcaps,
 243  *   commabeforerest,
 244  *   titleformat=colonsep,
 245  *   bibformat={tabular,ibidem,numbered}
 246  */
 247 vector<string> split_options(string const & input)
 248 {
 249         vector<string> options;
 250         string option;
 251         Parser p(input);
 252         while (p.good()) {
 253                 Token const & t = p.get_token();
 254                 if (t.asInput() == ",") {
 255                         options.push_back(trimSpaceAndEol(option));
 256                         option.erase();
 257                 } else if (t.asInput() == "=") {
 258                         option += '=';
 259                         p.skip_spaces(true);
 260                         if (p.next_token().asInput() == "{")
 261                                 option += '{' + p.getArg('{', '}') + '}';
 262                 } else if (t.cat() != catSpace)
 263                         option += t.asInput();
 264         }
 265
 266         if (!option.empty())
 267                 options.push_back(trimSpaceAndEol(option));
 268
 269         return options;
 270 }
 271
 272
 273 /*!
 274  * Retrieve a keyval option "name={value with=sign}" named \p name from
 275  * \p options and return the value.
 276  * The found option is also removed from \p options.
 277  */
 278 string process_keyval_opt(vector<string> & options, string name)
 279 {
 280         for (size_t i = 0; i < options.size(); ++i) {
 281                 vector<string> option;
 282                 split(options[i], option, '=');
 283                 if (option.size() < 2)
 284                         continue;
 285                 if (option[0] == name) {
 286                         options.erase(options.begin() + i);
 287                         option.erase(option.begin());
 288                         return join(option, "=");
 289                 }
 290         }
 291         return "";
 292 }
 293
 294 } // anonymous namespace
 295
 296
 297 /**
 298  * known polyglossia language names (including variants)
 299  */
 300 const char * const Preamble::polyglossia_languages[] = {
 301 "albanian", "croatian", "hebrew", "norsk", "swedish", "amharic", "czech", "hindi",
 302 "nynorsk", "syriac", "arabic", "danish", "icelandic", "occitan", "tamil",
 303 "armenian", "divehi", "interlingua", "polish", "telugu", "asturian", "dutch",
 304 "irish", "portuges", "thai", "bahasai", "english", "italian", "romanian", "turkish",
 305 "bahasam", "esperanto", "lao", "russian", "turkmen", "basque", "estonian", "latin",
 306 "samin", "ukrainian", "bengali", "farsi", "latvian", "sanskrit", "urdu", "brazil",
 307 "brazilian", "finnish", "lithuanian", "scottish", "usorbian", "breton", "french",
 308 "lsorbian", "serbian", "vietnamese", "bulgarian", "galician", "magyar", "slovak",
 309 "welsh", "catalan", "german", "malayalam", "slovenian", "coptic", "greek",
 310 "marathi", "spanish",
 311 "american", "ancient", "australian", "british", "monotonic", "newzealand",
 312 "polytonic", 0};
 313
 314 /**
 315  * the same as polyglossia_languages with .lyx names
 316  * please keep this in sync with polyglossia_languages line by line!
 317  */
 318 const char * const Preamble::coded_polyglossia_languages[] = {
 319 "albanian", "croatian", "hebrew", "norsk", "swedish", "amharic", "czech", "hindi",
 320 "nynorsk", "syriac", "arabic_arabi", "danish", "icelandic", "occitan", "tamil",
 321 "armenian", "divehi", "interlingua", "polish", "telugu", "asturian", "dutch",
 322 "irish", "portuges", "thai", "bahasa", "english", "italian", "romanian", "turkish",
 323 "bahasam", "esperanto", "lao", "russian", "turkmen", "basque", "estonian", "latin",
 324 "samin", "ukrainian", "bengali", "farsi", "latvian", "sanskrit", "urdu", "brazilian",
 325 "brazilian", "finnish", "lithuanian", "scottish", "uppersorbian", "breton", "french",
 326 "lowersorbian", "serbian", "vietnamese", "bulgarian", "galician", "magyar", "slovak",
 327 "welsh", "catalan", "ngerman", "malayalam", "slovene", "coptic", "greek",
 328 "marathi", "spanish",
 329 "american", "ancientgreek", "australian", "british", "greek", "newzealand",
 330 "polutonikogreek", 0};
 331
 332
 333 bool Preamble::indentParagraphs() const
 334 {
 335         return h_paragraph_separation == "indent";
 336 }
 337
 338
 339 bool Preamble::isPackageUsed(string const & package) const
 340 {
 341         return used_packages.find(package) != used_packages.end();
 342 }
 343
 344
 345 vector<string> Preamble::getPackageOptions(string const & package) const
 346 {
 347         map<string, vector<string> >::const_iterator it = used_packages.find(package);
 348         if (it != used_packages.end())
 349                 return it->second;
 350         return vector<string>();
 351 }
 352
 353
 354 void Preamble::registerAutomaticallyLoadedPackage(std::string const & package)
 355 {
 356         auto_packages.insert(package);
 357 }
 358
 359
 360 void Preamble::addModule(string const & module)
 361 {
 362         used_modules.push_back(module);
 363 }
 364
 365
 366 void Preamble::suppressDate(bool suppress)
 367 {
 368         if (suppress)
 369                 h_suppress_date = "true";
 370         else
 371                 h_suppress_date = "false";
 372 }
 373
 374
 375 void Preamble::registerAuthor(std::string const & name)
 376 {
 377         Author author(from_utf8(name), empty_docstring());
 378         author.setUsed(true);
 379         authors_.record(author);
 380         h_tracking_changes = "true";
 381         h_output_changes = "true";
 382 }
 383
 384
 385 Author const & Preamble::getAuthor(std::string const & name) const
 386 {
 387         Author author(from_utf8(name), empty_docstring());
 388         for (AuthorList::Authors::const_iterator it = authors_.begin();
 389              it != authors_.end(); ++it)
 390                 if (*it == author)
 391                         return *it;
 392         static Author const dummy;
 393         return dummy;
 394 }
 395
 396
 397 void Preamble::add_package(string const & name, vector<string> & options)
 398 {
 399         // every package inherits the global options
 400         if (used_packages.find(name) == used_packages.end())
 401                 used_packages[name] = split_options(h_options);
 402
 403         vector<string> & v = used_packages[name];
 404         v.insert(v.end(), options.begin(), options.end());
 405         if (name == "jurabib") {
 406                 // Don't output the order argument (see the cite command
 407                 // handling code in text.cpp).
 408                 vector<string>::iterator end =
 409                         remove(options.begin(), options.end(), "natbiborder");
 410                 end = remove(options.begin(), end, "jurabiborder");
 411                 options.erase(end, options.end());
 412         }
 413 }
 414
 415
 416 namespace {
 417
 418 // Given is a string like "scaled=0.9" or "Scale=0.9", return 0.9 * 100
 419 bool scale_as_percentage(string const & scale, string & percentage)
 420 {
 421         string::size_type pos = scale.find('=');
 422         if (pos != string::npos) {
 423                 string value = scale.substr(pos + 1);
 424                 if (isStrDbl(value)) {
 425                         percentage = convert<string>(100 * convert<double>(value));
 426                         return true;
 427                 }
 428         }
 429         return false;
 430 }
 431
 432
 433 string remove_braces(string const & value)
 434 {
 435         if (value.empty())
 436                 return value;
 437         if (value[0] == '{' && value[value.length()-1] == '}')
 438                 return value.substr(1, value.length()-2);
 439         return value;
 440 }
 441
 442 } // anonymous namespace
 443
 444
 445 Preamble::Preamble() : one_language(true), explicit_babel(false),
 446         title_layout_found(false), h_font_cjk_set(false)
 447 {
 448         //h_backgroundcolor;
 449         //h_boxbgcolor;
 450         h_biblio_style            = "plain";
 451         h_bibtex_command          = "default";
 452         h_cite_engine             = "basic";
 453         h_cite_engine_type        = "numerical";
 454         h_color                   = "#008000";
 455         h_defskip                 = "medskip";
 456         //h_float_placement;
 457         //h_fontcolor;
 458         h_fontencoding            = "default";
 459         h_font_roman              = "default";
 460         h_font_sans               = "default";
 461         h_font_typewriter         = "default";
 462         h_font_math               = "auto";
 463         h_font_default_family     = "default";
 464         h_use_non_tex_fonts       = "false";
 465         h_font_sc                 = "false";
 466         h_font_osf                = "false";
 467         h_font_sf_scale           = "100";
 468         h_font_tt_scale           = "100";
 469         //h_font_cjk
 470         h_graphics                = "default";
 471         h_default_output_format   = "default";
 472         h_html_be_strict          = "false";
 473         h_html_css_as_file        = "0";
 474         h_html_math_output        = "0";
 475         h_index[0]                = "Index";
 476         h_index_command           = "default";
 477         h_inputencoding           = "auto";
 478         h_justification           = "true";
 479         h_language                = "english";
 480         h_language_package        = "none";
 481         //h_listings_params;
 482         h_maintain_unincluded_children = "false";
 483         //h_margins;
 484         //h_notefontcolor;
 485         //h_options;
 486         h_output_changes          = "false";
 487         h_output_sync             = "0";
 488         //h_output_sync_macro
 489         h_papercolumns            = "1";
 490         h_paperfontsize           = "default";
 491         h_paperorientation        = "portrait";
 492         h_paperpagestyle          = "default";
 493         //h_papersides;
 494         h_papersize               = "default";
 495         h_paragraph_indentation   = "default";
 496         h_paragraph_separation    = "indent";
 497         //h_pdf_title;
 498         //h_pdf_author;
 499         //h_pdf_subject;
 500         //h_pdf_keywords;
 501         h_pdf_bookmarks           = "1";
 502         h_pdf_bookmarksnumbered   = "0";
 503         h_pdf_bookmarksopen       = "0";
 504         h_pdf_bookmarksopenlevel  = "1";
 505         h_pdf_breaklinks          = "0";
 506         h_pdf_pdfborder           = "0";
 507         h_pdf_colorlinks          = "0";
 508         h_pdf_backref             = "section";
 509         h_pdf_pdfusetitle         = "1";
 510         //h_pdf_pagemode;
 511         //h_pdf_quoted_options;
 512         h_quotes_language         = "english";
 513         h_secnumdepth             = "3";
 514         h_shortcut[0]             = "idx";
 515         h_spacing                 = "single";
 516         h_suppress_date           = "false";
 517         h_textclass               = "article";
 518         h_tocdepth                = "3";
 519         h_tracking_changes        = "false";
 520         h_use_bibtopic            = "false";
 521         h_use_indices             = "false";
 522         h_use_geometry            = "false";
 523         h_use_default_options     = "false";
 524         h_use_hyperref            = "false";
 525         h_use_refstyle            = "0";
 526         h_use_packages["amsmath"]    = "1";
 527         h_use_packages["amssymb"]    = "0";
 528         h_use_packages["esint"]      = "1";
 529         h_use_packages["mhchem"]     = "0";
 530         h_use_packages["mathdots"]   = "0";
 531         h_use_packages["mathtools"]  = "0";
 532         h_use_packages["stackrel"]   = "0";
 533         h_use_packages["stmaryrd"]   = "0";
 534         h_use_packages["undertilde"] = "0";
 535 }
 536
 537
 538 void Preamble::handle_hyperref(vector<string> & options)
 539 {
 540         // FIXME swallow inputencoding changes that might surround the
 541         //       hyperref setup if it was written by LyX
 542         h_use_hyperref = "true";
 543         // swallow "unicode=true", since LyX does always write that
 544         vector<string>::iterator it =
 545                 find(options.begin(), options.end(), "unicode=true");
 546         if (it != options.end())
 547                 options.erase(it);
 548         it = find(options.begin(), options.end(), "pdfusetitle");
 549         if (it != options.end()) {
 550                 h_pdf_pdfusetitle = "1";
 551                 options.erase(it);
 552         }
 553         string bookmarks = process_keyval_opt(options, "bookmarks");
 554         if (bookmarks == "true")
 555                 h_pdf_bookmarks = "1";
 556         else if (bookmarks == "false")
 557                 h_pdf_bookmarks = "0";
 558         if (h_pdf_bookmarks == "1") {
 559                 string bookmarksnumbered =
 560                         process_keyval_opt(options, "bookmarksnumbered");
 561                 if (bookmarksnumbered == "true")
 562                         h_pdf_bookmarksnumbered = "1";
 563                 else if (bookmarksnumbered == "false")
 564                         h_pdf_bookmarksnumbered = "0";
 565                 string bookmarksopen =
 566                         process_keyval_opt(options, "bookmarksopen");
 567                 if (bookmarksopen == "true")
 568                         h_pdf_bookmarksopen = "1";
 569                 else if (bookmarksopen == "false")
 570                         h_pdf_bookmarksopen = "0";
 571                 if (h_pdf_bookmarksopen == "1") {
 572                         string bookmarksopenlevel =
 573                                 process_keyval_opt(options, "bookmarksopenlevel");
 574                         if (!bookmarksopenlevel.empty())
 575                                 h_pdf_bookmarksopenlevel = bookmarksopenlevel;
 576                 }
 577         }
 578         string breaklinks = process_keyval_opt(options, "breaklinks");
 579         if (breaklinks == "true")
 580                 h_pdf_breaklinks = "1";
 581         else if (breaklinks == "false")
 582                 h_pdf_breaklinks = "0";
 583         string pdfborder = process_keyval_opt(options, "pdfborder");
 584         if (pdfborder == "{0 0 0}")
 585                 h_pdf_pdfborder = "1";
 586         else if (pdfborder == "{0 0 1}")
 587                 h_pdf_pdfborder = "0";
 588         string backref = process_keyval_opt(options, "backref");
 589         if (!backref.empty())
 590                 h_pdf_backref = backref;
 591         string colorlinks = process_keyval_opt(options, "colorlinks");
 592         if (colorlinks == "true")
 593                 h_pdf_colorlinks = "1";
 594         else if (colorlinks == "false")
 595                 h_pdf_colorlinks = "0";
 596         string pdfpagemode = process_keyval_opt(options, "pdfpagemode");
 597         if (!pdfpagemode.empty())
 598                 h_pdf_pagemode = pdfpagemode;
 599         string pdftitle = process_keyval_opt(options, "pdftitle");
 600         if (!pdftitle.empty()) {
 601                 h_pdf_title = remove_braces(pdftitle);
 602         }
 603         string pdfauthor = process_keyval_opt(options, "pdfauthor");
 604         if (!pdfauthor.empty()) {
 605                 h_pdf_author = remove_braces(pdfauthor);
 606         }
 607         string pdfsubject = process_keyval_opt(options, "pdfsubject");
 608         if (!pdfsubject.empty())
 609                 h_pdf_subject = remove_braces(pdfsubject);
 610         string pdfkeywords = process_keyval_opt(options, "pdfkeywords");
 611         if (!pdfkeywords.empty())
 612                 h_pdf_keywords = remove_braces(pdfkeywords);
 613         if (!options.empty()) {
 614                 if (!h_pdf_quoted_options.empty())
 615                         h_pdf_quoted_options += ',';
 616                 h_pdf_quoted_options += join(options, ",");
 617                 options.clear();
 618         }
 619 }
 620
 621
 622 void Preamble::handle_geometry(vector<string> & options)
 623 {
 624         h_use_geometry = "true";
 625         vector<string>::iterator it;
 626         // paper orientation
 627         if ((it = find(options.begin(), options.end(), "landscape")) != options.end()) {
 628                 h_paperorientation = "landscape";
 629                 options.erase(it);
 630         }
 631         // paper size
 632         // keyval version: "paper=letter"
 633         string paper = process_keyval_opt(options, "paper");
 634         if (!paper.empty())
 635                 h_papersize = paper + "paper";
 636         // alternative version: "letterpaper"
 637         handle_opt(options, known_paper_sizes, h_papersize);
 638         delete_opt(options, known_paper_sizes);
 639         // page margins
 640         char const * const * margin = known_paper_margins;
 641         for (; *margin; ++margin) {
 642                 string value = process_keyval_opt(options, *margin);
 643                 if (!value.empty()) {
 644                         int k = margin - known_paper_margins;
 645                         string name = known_coded_paper_margins[k];
 646                         h_margins += '\\' + name + ' ' + value + '\n';
 647                 }
 648         }
 649 }
 650
 651
 652 void Preamble::handle_package(Parser &p, string const & name,
 653                               string const & opts, bool in_lyx_preamble)
 654 {
 655         vector<string> options = split_options(opts);
 656         add_package(name, options);
 657         char const * const * where = 0;
 658
 659         if (is_known(name, known_xetex_packages)) {
 660                 xetex = true;
 661                 h_use_non_tex_fonts = "true";
 662                 registerAutomaticallyLoadedPackage("fontspec");
 663                 if (h_inputencoding == "auto")
 664                         p.setEncoding("UTF-8");
 665         }
 666
 667         // roman fonts
 668         if (is_known(name, known_roman_fonts))
 669                 h_font_roman = name;
 670
 671         if (name == "fourier") {
 672                 h_font_roman = "utopia";
 673                 // when font uses real small capitals
 674                 if (opts == "expert")
 675                         h_font_sc = "true";
 676         }
 677
 678         if (name == "garamondx") {
 679                 h_font_roman = "garamondx";
 680                 if (opts == "osfI")
 681                         h_font_osf = "true";
 682         }
 683
 684         if (name == "libertine") {
 685                 h_font_roman = "libertine";
 686                 // this automatically invokes biolinum
 687                 h_font_sans = "biolinum";
 688                 if (opts == "osf")
 689                         h_font_osf = "true";
 690                 else if (opts == "lining")
 691                         h_font_osf = "false";
 692         }
 693
 694         if (name == "libertine-type1") {
 695                 h_font_roman = "libertine";
 696                 // NOTE: contrary to libertine.sty, libertine-type1
 697                 // does not automatically invoke biolinum
 698                 if (opts == "lining")
 699                         h_font_osf = "false";
 700                 else if (opts == "osf")
 701                         h_font_osf = "true";
 702         }
 703
 704         if (name == "mathdesign") {
 705                 if (opts.find("charter") != string::npos)
 706                         h_font_roman = "md-charter";
 707                 if (opts.find("garamond") != string::npos)
 708                         h_font_roman = "md-garamond";
 709                 if (opts.find("utopia") != string::npos)
 710                         h_font_roman = "md-utopia";
 711                 if (opts.find("expert") != string::npos) {
 712                         h_font_sc = "true";
 713                         h_font_osf = "true";
 714                 }
 715         }
 716
 717         else if (name == "mathpazo")
 718                 h_font_roman = "palatino";
 719
 720         else if (name == "mathptmx")
 721                 h_font_roman = "times";
 722
 723         // sansserif fonts
 724         if (is_known(name, known_sans_fonts)) {
 725                 h_font_sans = name;
 726                 if (options.size() == 1) {
 727                         if (scale_as_percentage(opts, h_font_sf_scale))
 728                                 options.clear();
 729                 }
 730         }
 731
 732         if (name == "biolinum-type1")
 733                 h_font_sans = "biolinum";
 734
 735         // typewriter fonts
 736         if (is_known(name, known_typewriter_fonts)) {
 737                 // fourier can be set as roman font _only_
 738                 // fourier as typewriter is handled in handling of \ttdefault
 739                 if (name != "fourier") {
 740                         h_font_typewriter = name;
 741                         if (options.size() == 1) {
 742                                 if (scale_as_percentage(opts, h_font_tt_scale))
 743                                         options.clear();
 744                         }
 745                 }
 746         }
 747
 748         // font uses old-style figure
 749         if (name == "eco")
 750                 h_font_osf = "true";
 751
 752         // math fonts
 753         if (is_known(name, known_math_fonts))
 754                 h_font_math = name;
 755
 756         if (name == "newtxmath") {
 757                 if (opts.empty())
 758                         h_font_math = "newtxmath";
 759                 else if (opts == "garamondx")
 760                         h_font_math = "garamondx-ntxm";
 761                 else if (opts == "libertine")
 762                         h_font_math = "libertine-ntxm";
 763                 else if (opts == "minion")
 764                         h_font_math = "minion-ntxm";
 765         }
 766
 767         // after the detection and handling of special cases, we can remove the
 768         // fonts, otherwise they would appear in the preamble, see bug #7856
 769         if (is_known(name, known_roman_fonts) || is_known(name, known_sans_fonts)
 770                 ||      is_known(name, known_typewriter_fonts) || is_known(name, known_math_fonts))
 771                 ;
 772
 773         else if (name == "amsmath" || name == "amssymb" ||
 774                  name == "esint" || name == "mhchem" || name == "mathdots" ||
 775                  name == "mathtools" || name == "stackrel" ||
 776                  name == "stmaryrd" || name == "undertilde")
 777                 h_use_packages[name] = "2";
 778
 779         else if (name == "babel") {
 780                 h_language_package = "default";
 781                 // One might think we would have to do nothing if babel is loaded
 782                 // without any options to prevent pollution of the preamble with this
 783                 // babel call in every roundtrip.
 784                 // But the user could have defined babel-specific things afterwards. So
 785                 // we need to keep it in the preamble to prevent cases like bug #7861.
 786                 if (!opts.empty()) {
 787                         // check if more than one option was used - used later for inputenc
 788                         if (options.begin() != options.end() - 1)
 789                                 one_language = false;
 790                         // babel takes the last language of the option of its \usepackage
 791                         // call as document language. If there is no such language option, the
 792                         // last language in the documentclass options is used.
 793                         handle_opt(options, known_languages, h_language);
 794                         // translate the babel name to a LyX name
 795                         h_language = babel2lyx(h_language);
 796                         if (h_language == "japanese") {
 797                                 // For Japanese, the encoding isn't indicated in the source
 798                                 // file, and there's really not much we can do. We could
 799                                 // 1) offer a list of possible encodings to choose from, or
 800                                 // 2) determine the encoding of the file by inspecting it.
 801                                 // For the time being, we leave the encoding alone so that
 802                                 // we don't get iconv errors when making a wrong guess, and
 803                                 // we will output a note at the top of the document
 804                                 // explaining what to do.
 805                                 Encoding const * const enc = encodings.fromIconvName(
 806                                         p.getEncoding(), Encoding::japanese, false);
 807                                 if (enc)
 808                                         h_inputencoding = enc->latexName();
 809                                 is_nonCJKJapanese = true;
 810                                 // in this case babel can be removed from the preamble
 811                                 registerAutomaticallyLoadedPackage("babel");
 812                         } else {
 813                                 // If babel is called with options, LyX puts them by default into the
 814                                 // document class options. This works for most languages, except
 815                                 // for Latvian, Lithuanian, Mongolian, Turkmen and Vietnamese and
 816                                 // perhaps in future others.
 817                                 // Therefore keep the babel call as it is as the user might have
 818                                 // reasons for it.
 819                                 h_preamble << "\\usepackage[" << opts << "]{babel}\n";
 820                         }
 821                         delete_opt(options, known_languages);
 822                 } else {
 823                         h_preamble << "\\usepackage{babel}\n";
 824                         explicit_babel = true;
 825                 }
 826         }
 827
 828         else if (name == "polyglossia") {
 829                 h_language_package = "default";
 830                 h_default_output_format = "pdf4";
 831                 h_use_non_tex_fonts = "true";
 832                 xetex = true;
 833                 registerAutomaticallyLoadedPackage("xunicode");
 834                 if (h_inputencoding == "auto")
 835                         p.setEncoding("UTF-8");
 836         }
 837
 838         else if (name == "CJK") {
 839                 // set the encoding to "auto" because it might be set to "default" by the babel handling
 840                 // and this would not be correct for CJK
 841                 if (h_inputencoding == "default")
 842                         h_inputencoding = "auto";
 843                 registerAutomaticallyLoadedPackage("CJK");
 844         }
 845
 846         else if (name == "CJKutf8") {
 847                 h_inputencoding = "UTF8";
 848                 p.setEncoding("UTF-8");
 849                 registerAutomaticallyLoadedPackage("CJKutf8");
 850         }
 851
 852         else if (name == "fontenc") {
 853                 h_fontencoding = getStringFromVector(options, ",");
 854                 /* We could do the following for better round trip support,
 855                  * but this makes the document less portable, so I skip it:
 856                 if (h_fontencoding == lyxrc.fontenc)
 857                         h_fontencoding = "global";
 858                  */
 859                 options.clear();
 860         }
 861
 862         else if (name == "inputenc" || name == "luainputenc") {
 863                 // h_inputencoding is only set when there is not more than one
 864                 // inputenc option because otherwise h_inputencoding must be
 865                 // set to "auto" (the default encoding of the document language)
 866                 // Therefore check for the "," character.
 867                 // It is also only set when there is not more than one babel
 868                 // language option.
 869                 if (opts.find(",") == string::npos && one_language == true)
 870                         h_inputencoding = opts;
 871                 if (!options.empty())
 872                         p.setEncoding(options.back(), Encoding::inputenc);
 873                 options.clear();
 874         }
 875
 876         else if (name == "srcltx") {
 877                 h_output_sync = "1";
 878                 if (!opts.empty()) {
 879                         h_output_sync_macro = "\\usepackage[" + opts + "]{srcltx}";
 880                         options.clear();
 881                 } else
 882                         h_output_sync_macro = "\\usepackage{srcltx}";
 883         }
 884
 885         else if (is_known(name, known_old_language_packages)) {
 886                 // known language packages from the times before babel
 887                 // if they are found and not also babel, they will be used as
 888                 // custom language package
 889                 h_language_package = "\\usepackage{" + name + "}";
 890         }
 891
 892         else if (name == "prettyref")
 893                 ; // ignore this FIXME: Use the package separator mechanism instead
 894
 895         else if (name == "lyxskak") {
 896                 // ignore this and its options
 897                 const char * const o[] = {"ps", "mover", 0};
 898                 delete_opt(options, o);
 899         }
 900
 901         else if (is_known(name, known_lyx_packages) && options.empty()) {
 902                 if (name == "splitidx")
 903                         h_use_indices = "true";
 904                 if (name == "refstyle")
 905                         h_use_refstyle = "1";
 906                 if (!in_lyx_preamble) {
 907                         h_preamble << package_beg_sep << name
 908                                    << package_mid_sep << "\\usepackage{"
 909                                    << name << '}';
 910                         if (p.next_token().cat() == catNewline ||
 911                             (p.next_token().cat() == catSpace &&
 912                              p.next_next_token().cat() == catNewline))
 913                                 h_preamble << '\n';
 914                         h_preamble << package_end_sep;
 915                 }
 916         }
 917
 918         else if (name == "geometry")
 919                 handle_geometry(options);
 920
 921         else if (name == "subfig")
 922                 ; // ignore this FIXME: Use the package separator mechanism instead
 923
 924         else if ((where = is_known(name, known_languages)))
 925                 h_language = known_coded_languages[where - known_languages];
 926
 927         else if (name == "natbib") {
 928                 h_biblio_style = "plainnat";
 929                 h_cite_engine = "natbib";
 930                 h_cite_engine_type = "authoryear";
 931                 vector<string>::iterator it =
 932                         find(options.begin(), options.end(), "authoryear");
 933                 if (it != options.end())
 934                         options.erase(it);
 935                 else {
 936                         it = find(options.begin(), options.end(), "numbers");
 937                         if (it != options.end()) {
 938                                 h_cite_engine_type = "numerical";
 939                                 options.erase(it);
 940                         }
 941                 }
 942         }
 943
 944         else if (name == "jurabib") {
 945                 h_biblio_style = "jurabib";
 946                 h_cite_engine = "jurabib";
 947                 h_cite_engine_type = "authoryear";
 948         }
 949
 950         else if (name == "hyperref")
 951                 handle_hyperref(options);
 952
 953         else if (!in_lyx_preamble) {
 954                 if (options.empty())
 955                         h_preamble << "\\usepackage{" << name << '}';
 956                 else {
 957                         h_preamble << "\\usepackage[" << opts << "]{"
 958                                    << name << '}';
 959                         options.clear();
 960                 }
 961                 if (p.next_token().cat() == catNewline ||
 962                     (p.next_token().cat() == catSpace &&
 963                      p.next_next_token().cat() == catNewline))
 964                         h_preamble << '\n';
 965         }
 966
 967         // We need to do something with the options...
 968         if (!options.empty())
 969                 cerr << "Ignoring options '" << join(options, ",")
 970                      << "' of package " << name << '.' << endl;
 971
 972         // remove the whitespace
 973         p.skip_spaces();
 974 }
 975
 976
 977 void Preamble::handle_if(Parser & p, bool in_lyx_preamble)
 978 {
 979         while (p.good()) {
 980                 Token t = p.get_token();
 981                 if (t.cat() == catEscape &&
 982                     is_known(t.cs(), known_if_commands))
 983                         handle_if(p, in_lyx_preamble);
 984                 else {
 985                         if (!in_lyx_preamble)
 986                                 h_preamble << t.asInput();
 987                         if (t.cat() == catEscape && t.cs() == "fi")
 988                                 return;
 989                 }
 990         }
 991 }
 992
 993
 994 bool Preamble::writeLyXHeader(ostream & os, bool subdoc)
 995 {
 996         // set the quote language
 997         // LyX only knows the following quotes languages:
 998         // english, swedish, german, polish, french and danish
 999         // (quotes for "japanese" and "chinese-traditional" are missing because
1000         //  they wouldn't be useful: http://www.lyx.org/trac/ticket/6383)
1001         // conversion list taken from
1002         // http://en.wikipedia.org/wiki/Quotation_mark,_non-English_usage
1003         // (quotes for kazakh and interlingua are unknown)
1004         // danish
1005         if (is_known(h_language, known_danish_quotes_languages))
1006                 h_quotes_language = "danish";
1007         // french
1008         else if (is_known(h_language, known_french_quotes_languages))
1009                 h_quotes_language = "french";
1010         // german
1011         else if (is_known(h_language, known_german_quotes_languages))
1012                 h_quotes_language = "german";
1013         // polish
1014         else if (is_known(h_language, known_polish_quotes_languages))
1015                 h_quotes_language = "polish";
1016         // swedish
1017         else if (is_known(h_language, known_swedish_quotes_languages))
1018                 h_quotes_language = "swedish";
1019         //english
1020         else if (is_known(h_language, known_english_quotes_languages))
1021                 h_quotes_language = "english";
1022
1023         if (contains(h_float_placement, "H"))
1024                 registerAutomaticallyLoadedPackage("float");
1025         if (h_spacing != "single" && h_spacing != "default")
1026                 registerAutomaticallyLoadedPackage("setspace");
1027         if (h_use_packages["amsmath"] == "2") {
1028                 // amsbsy and amstext are already provided by amsmath
1029                 registerAutomaticallyLoadedPackage("amsbsy");
1030                 registerAutomaticallyLoadedPackage("amstext");
1031         }
1032
1033         // output the LyX file settings
1034         os << "#LyX file created by tex2lyx " << PACKAGE_VERSION << "\n"
1035            << "\\lyxformat " << LYX_FORMAT << '\n'
1036            << "\\begin_document\n"
1037            << "\\begin_header\n"
1038            << "\\textclass " << h_textclass << "\n";
1039         string const raw = subdoc ? empty_string() : h_preamble.str();
1040         if (!raw.empty()) {
1041                 os << "\\begin_preamble\n";
1042                 for (string::size_type i = 0; i < raw.size(); ++i) {
1043                         if (raw[i] == package_beg_sep) {
1044                                 // Here follows some package loading code that
1045                                 // must be skipped if the package is loaded
1046                                 // automatically.
1047                                 string::size_type j = raw.find(package_mid_sep, i);
1048                                 if (j == string::npos)
1049                                         return false;
1050                                 string::size_type k = raw.find(package_end_sep, j);
1051                                 if (k == string::npos)
1052                                         return false;
1053                                 string const package = raw.substr(i + 1, j - i - 1);
1054                                 string const replacement = raw.substr(j + 1, k - j - 1);
1055                                 if (auto_packages.find(package) == auto_packages.end())
1056                                         os << replacement;
1057                                 i = k;
1058                         } else
1059                                 os.put(raw[i]);
1060                 }
1061                 os << "\n\\end_preamble\n";
1062         }
1063         if (!h_options.empty())
1064                 os << "\\options " << h_options << "\n";
1065         os << "\\use_default_options " << h_use_default_options << "\n";
1066         if (!used_modules.empty()) {
1067                 os << "\\begin_modules\n";
1068                 vector<string>::const_iterator const end = used_modules.end();
1069                 vector<string>::const_iterator it = used_modules.begin();
1070                 for (; it != end; ++it)
1071                         os << *it << '\n';
1072                 os << "\\end_modules\n";
1073         }
1074         os << "\\maintain_unincluded_children " << h_maintain_unincluded_children << "\n"
1075            << "\\language " << h_language << "\n"
1076            << "\\language_package " << h_language_package << "\n"
1077            << "\\inputencoding " << h_inputencoding << "\n"
1078            << "\\fontencoding " << h_fontencoding << "\n"
1079            << "\\font_roman " << h_font_roman << "\n"
1080            << "\\font_sans " << h_font_sans << "\n"
1081            << "\\font_typewriter " << h_font_typewriter << "\n"
1082            << "\\font_math " << h_font_math << "\n"
1083            << "\\font_default_family " << h_font_default_family << "\n"
1084            << "\\use_non_tex_fonts " << h_use_non_tex_fonts << "\n"
1085            << "\\font_sc " << h_font_sc << "\n"
1086            << "\\font_osf " << h_font_osf << "\n"
1087            << "\\font_sf_scale " << h_font_sf_scale << "\n"
1088            << "\\font_tt_scale " << h_font_tt_scale << '\n';
1089         if (!h_font_cjk.empty())
1090                 os << "\\font_cjk " << h_font_cjk << '\n';
1091         os << "\\graphics " << h_graphics << '\n'
1092            << "\\default_output_format " << h_default_output_format << "\n"
1093            << "\\output_sync " << h_output_sync << "\n";
1094         if (h_output_sync == "1")
1095                 os << "\\output_sync_macro \"" << h_output_sync_macro << "\"\n";
1096         os << "\\bibtex_command " << h_bibtex_command << "\n"
1097            << "\\index_command " << h_index_command << "\n";
1098         if (!h_float_placement.empty())
1099                 os << "\\float_placement " << h_float_placement << "\n";
1100         os << "\\paperfontsize " << h_paperfontsize << "\n"
1101            << "\\spacing " << h_spacing << "\n"
1102            << "\\use_hyperref " << h_use_hyperref << '\n';
1103         if (h_use_hyperref == "true") {
1104                 if (!h_pdf_title.empty())
1105                         os << "\\pdf_title \"" << h_pdf_title << "\"\n";
1106                 if (!h_pdf_author.empty())
1107                         os << "\\pdf_author \"" << h_pdf_author << "\"\n";
1108                 if (!h_pdf_subject.empty())
1109                         os << "\\pdf_subject \"" << h_pdf_subject << "\"\n";
1110                 if (!h_pdf_keywords.empty())
1111                         os << "\\pdf_keywords \"" << h_pdf_keywords << "\"\n";
1112                 os << "\\pdf_bookmarks " << h_pdf_bookmarks << "\n"
1113                       "\\pdf_bookmarksnumbered " << h_pdf_bookmarksnumbered << "\n"
1114                       "\\pdf_bookmarksopen " << h_pdf_bookmarksopen << "\n"
1115                       "\\pdf_bookmarksopenlevel " << h_pdf_bookmarksopenlevel << "\n"
1116                       "\\pdf_breaklinks " << h_pdf_breaklinks << "\n"
1117                       "\\pdf_pdfborder " << h_pdf_pdfborder << "\n"
1118                       "\\pdf_colorlinks " << h_pdf_colorlinks << "\n"
1119                       "\\pdf_backref " << h_pdf_backref << "\n"
1120                       "\\pdf_pdfusetitle " << h_pdf_pdfusetitle << '\n';
1121                 if (!h_pdf_pagemode.empty())
1122                         os << "\\pdf_pagemode " << h_pdf_pagemode << '\n';
1123                 if (!h_pdf_quoted_options.empty())
1124                         os << "\\pdf_quoted_options \"" << h_pdf_quoted_options << "\"\n";
1125         }
1126         os << "\\papersize " << h_papersize << "\n"
1127            << "\\use_geometry " << h_use_geometry << '\n';
1128         for (map<string, string>::const_iterator it = h_use_packages.begin();
1129              it != h_use_packages.end(); ++it)
1130                 os << "\\use_package " << it->first << ' ' << it->second << '\n';
1131         os << "\\cite_engine " << h_cite_engine << '\n'
1132            << "\\cite_engine_type " << h_cite_engine_type << '\n'
1133            << "\\biblio_style " << h_biblio_style << "\n"
1134            << "\\use_bibtopic " << h_use_bibtopic << "\n"
1135            << "\\use_indices " << h_use_indices << "\n"
1136            << "\\paperorientation " << h_paperorientation << '\n'
1137            << "\\suppress_date " << h_suppress_date << '\n'
1138            << "\\justification " << h_justification << '\n'
1139            << "\\use_refstyle " << h_use_refstyle << '\n';
1140         if (!h_fontcolor.empty())
1141                 os << "\\fontcolor " << h_fontcolor << '\n';
1142         if (!h_notefontcolor.empty())
1143                 os << "\\notefontcolor " << h_notefontcolor << '\n';
1144         if (!h_backgroundcolor.empty())
1145                 os << "\\backgroundcolor " << h_backgroundcolor << '\n';
1146         if (!h_boxbgcolor.empty())
1147                 os << "\\boxbgcolor " << h_boxbgcolor << '\n';
1148         if (index_number != 0)
1149                 for (int i = 0; i < index_number; i++) {
1150                         os << "\\index " << h_index[i] << '\n'
1151                            << "\\shortcut " << h_shortcut[i] << '\n'
1152                            << "\\color " << h_color << '\n'
1153                            << "\\end_index\n";
1154                 }
1155         else {
1156                 os << "\\index " << h_index[0] << '\n'
1157                    << "\\shortcut " << h_shortcut[0] << '\n'
1158                    << "\\color " << h_color << '\n'
1159                    << "\\end_index\n";
1160         }
1161         os << h_margins
1162            << "\\secnumdepth " << h_secnumdepth << "\n"
1163            << "\\tocdepth " << h_tocdepth << "\n"
1164            << "\\paragraph_separation " << h_paragraph_separation << "\n";
1165         if (h_paragraph_separation == "skip")
1166                 os << "\\defskip " << h_defskip << "\n";
1167         else
1168                 os << "\\paragraph_indentation " << h_paragraph_indentation << "\n";
1169         os << "\\quotes_language " << h_quotes_language << "\n"
1170            << "\\papercolumns " << h_papercolumns << "\n"
1171            << "\\papersides " << h_papersides << "\n"
1172            << "\\paperpagestyle " << h_paperpagestyle << "\n";
1173         if (!h_listings_params.empty())
1174                 os << "\\listings_params " << h_listings_params << "\n";
1175         os << "\\tracking_changes " << h_tracking_changes << "\n"
1176            << "\\output_changes " << h_output_changes << "\n"
1177            << "\\html_math_output " << h_html_math_output << "\n"
1178            << "\\html_css_as_file " << h_html_css_as_file << "\n"
1179            << "\\html_be_strict " << h_html_be_strict << "\n"
1180            << authors_
1181            << "\\end_header\n\n"
1182            << "\\begin_body\n";
1183         return true;
1184 }
1185
1186
1187 void Preamble::parse(Parser & p, string const & forceclass,
1188                      TeX2LyXDocClass & tc)
1189 {
1190         // initialize fixed types
1191         special_columns['D'] = 3;
1192         bool is_full_document = false;
1193         bool is_lyx_file = false;
1194         bool in_lyx_preamble = false;
1195
1196         // determine whether this is a full document or a fragment for inclusion
1197         while (p.good()) {
1198                 Token const & t = p.get_token();
1199
1200                 if (t.cat() == catEscape && t.cs() == "documentclass") {
1201                         is_full_document = true;
1202                         break;
1203                 }
1204         }
1205         p.reset();
1206
1207         while (is_full_document && p.good()) {
1208                 Token const & t = p.get_token();
1209
1210 #ifdef FILEDEBUG
1211                 cerr << "t: " << t << "\n";
1212 #endif
1213
1214                 //
1215                 // cat codes
1216                 //
1217                 if (!in_lyx_preamble &&
1218                     (t.cat() == catLetter ||
1219                      t.cat() == catSuper ||
1220                      t.cat() == catSub ||
1221                      t.cat() == catOther ||
1222                      t.cat() == catMath ||
1223                      t.cat() == catActive ||
1224                      t.cat() == catBegin ||
1225                      t.cat() == catEnd ||
1226                      t.cat() == catAlign ||
1227                      t.cat() == catParameter))
1228                         h_preamble << t.cs();
1229
1230                 else if (!in_lyx_preamble &&
1231                          (t.cat() == catSpace || t.cat() == catNewline))
1232                         h_preamble << t.asInput();
1233
1234                 else if (t.cat() == catComment) {
1235                         static regex const islyxfile("%% LyX .* created this file");
1236                         static regex const usercommands("User specified LaTeX commands");
1237
1238                         string const comment = t.asInput();
1239
1240                         // magically switch encoding default if it looks like XeLaTeX
1241                         static string const magicXeLaTeX =
1242                                 "% This document must be compiled with XeLaTeX ";
1243                         if (comment.size() > magicXeLaTeX.size()
1244                                   && comment.substr(0, magicXeLaTeX.size()) == magicXeLaTeX
1245                                   && h_inputencoding == "auto") {
1246                                 cerr << "XeLaTeX comment found, switching to UTF8\n";
1247                                 h_inputencoding = "utf8";
1248                         }
1249                         smatch sub;
1250                         if (regex_search(comment, sub, islyxfile)) {
1251                                 is_lyx_file = true;
1252                                 in_lyx_preamble = true;
1253                         } else if (is_lyx_file
1254                                    && regex_search(comment, sub, usercommands))
1255                                 in_lyx_preamble = false;
1256                         else if (!in_lyx_preamble)
1257                                 h_preamble << t.asInput();
1258                 }
1259
1260                 else if (t.cs() == "pagestyle")
1261                         h_paperpagestyle = p.verbatim_item();
1262
1263                 else if (t.cs() == "setdefaultlanguage") {
1264                         xetex = true;
1265                         // We don't yet care about non-language variant options
1266                         // because LyX doesn't support this yet, see bug #8214
1267                         if (p.hasOpt()) {
1268                                 string langopts = p.getOpt();
1269                                 // check if the option contains a variant, if yes, extract it
1270                                 string::size_type pos_var = langopts.find("variant");
1271                                 string::size_type i = langopts.find(',', pos_var);
1272                                 string::size_type k = langopts.find('=', pos_var);
1273                                 if (pos_var != string::npos){
1274                                         string variant;
1275                                         if (i == string::npos)
1276                                                 variant = langopts.substr(k + 1, langopts.length() - k - 2);
1277                                         else
1278                                                 variant = langopts.substr(k + 1, i - k - 1);
1279                                         h_language = variant;
1280                                 }
1281                                 p.verbatim_item();
1282                         } else
1283                                 h_language = p.verbatim_item();
1284                         //finally translate the poyglossia name to a LyX name
1285                         h_language = polyglossia2lyx(h_language);
1286                 }
1287
1288                 else if (t.cs() == "setotherlanguage") {
1289                         // We don't yet care about the option because LyX doesn't
1290                         // support this yet, see bug #8214
1291                         p.hasOpt() ? p.getOpt() : string();
1292                         p.verbatim_item();
1293                 }
1294
1295                 else if (t.cs() == "setmainfont") {
1296                         // we don't care about the option
1297                         p.hasOpt() ? p.getOpt() : string();
1298                         h_font_roman = p.getArg('{', '}');
1299                 }
1300
1301                 else if (t.cs() == "setsansfont" || t.cs() == "setmonofont") {
1302                         // LyX currently only supports the scale option
1303                         string scale;
1304                         if (p.hasOpt()) {
1305                                 string fontopts = p.getArg('[', ']');
1306                                 // check if the option contains a scaling, if yes, extract it
1307                                 string::size_type pos = fontopts.find("Scale");
1308                                 if (pos != string::npos) {
1309                                         string::size_type i = fontopts.find(',', pos);
1310                                         if (i == string::npos)
1311                                                 scale_as_percentage(fontopts.substr(pos + 1), scale);
1312                                         else
1313                                                 scale_as_percentage(fontopts.substr(pos, i - pos), scale);
1314                                 }
1315                         }
1316                         if (t.cs() == "setsansfont") {
1317                                 if (!scale.empty())
1318                                         h_font_sf_scale = scale;
1319                                 h_font_sans = p.getArg('{', '}');
1320                         } else {
1321                                 if (!scale.empty())
1322                                         h_font_tt_scale = scale;
1323                                 h_font_typewriter = p.getArg('{', '}');
1324                         }
1325                 }
1326
1327                 else if (t.cs() == "date") {
1328                         string argument = p.getArg('{', '}');
1329                         if (argument.empty())
1330                                 h_suppress_date = "true";
1331                         else
1332                                 h_preamble << t.asInput() << '{' << argument << '}';
1333                 }
1334
1335                 else if (t.cs() == "color") {
1336                         string const space =
1337                                 (p.hasOpt() ? p.getOpt() : string());
1338                         string argument = p.getArg('{', '}');
1339                         // check the case that a standard color is used
1340                         if (space.empty() && is_known(argument, known_basic_colors)) {
1341                                 h_fontcolor = rgbcolor2code(argument);
1342                                 preamble.registerAutomaticallyLoadedPackage("color");
1343                         } else if (space.empty() && argument == "document_fontcolor")
1344                                 preamble.registerAutomaticallyLoadedPackage("color");
1345                         // check the case that LyX's document_fontcolor is defined
1346                         // but not used for \color
1347                         else {
1348                                 h_preamble << t.asInput();
1349                                 if (!space.empty())
1350                                         h_preamble << space;
1351                                 h_preamble << '{' << argument << '}';
1352                                 // the color might already be set because \definecolor
1353                                 // is parsed before this
1354                                 h_fontcolor = "";
1355                         }
1356                 }
1357
1358                 else if (t.cs() == "pagecolor") {
1359                         string argument = p.getArg('{', '}');
1360                         // check the case that a standard color is used
1361                         if (is_known(argument, known_basic_colors)) {
1362                                 h_backgroundcolor = rgbcolor2code(argument);
1363                         } else if (argument == "page_backgroundcolor")
1364                                 preamble.registerAutomaticallyLoadedPackage("color");
1365                         // check the case that LyX's page_backgroundcolor is defined
1366                         // but not used for \pagecolor
1367                         else {
1368                                 h_preamble << t.asInput() << '{' << argument << '}';
1369                                 // the color might already be set because \definecolor
1370                                 // is parsed before this
1371                                 h_backgroundcolor = "";
1372                         }
1373                 }
1374
1375                 else if (t.cs() == "makeatletter") {
1376                         // LyX takes care of this
1377                         p.setCatcode('@', catLetter);
1378                 }
1379
1380                 else if (t.cs() == "makeatother") {
1381                         // LyX takes care of this
1382                         p.setCatcode('@', catOther);
1383                 }
1384
1385                 else if (t.cs() == "makeindex") {
1386                         // LyX will re-add this if a print index command is found
1387                         p.skip_spaces();
1388                 }
1389
1390                 else if (t.cs() == "newindex") {
1391                         string const indexname = p.getArg('[', ']');
1392                         string const shortcut = p.verbatim_item();
1393                         if (!indexname.empty())
1394                                 h_index[index_number] = indexname;
1395                         else
1396                                 h_index[index_number] = shortcut;
1397                         h_shortcut[index_number] = shortcut;
1398                         index_number += 1;
1399                         p.skip_spaces();
1400                 }
1401
1402                 else if (t.cs() == "RS@ifundefined") {
1403                         string const name = p.verbatim_item();
1404                         string const body1 = p.verbatim_item();
1405                         string const body2 = p.verbatim_item();
1406                         // store the in_lyx_preamble setting
1407                         bool const was_in_lyx_preamble = in_lyx_preamble;
1408                         if (name == "subref"
1409                                 || name == "thmref"
1410                                 || name == "lemref") {
1411                                 p.skip_spaces();
1412                                 preamble.registerAutomaticallyLoadedPackage("refstyle");
1413                                 in_lyx_preamble = true;
1414                         }
1415                         // only non-lyxspecific stuff
1416                         if (!in_lyx_preamble) {
1417                                 ostringstream ss;
1418                                 ss << '\\' << t.cs();
1419                                 ss << '{' << name << '}'
1420                                    << '{' << body1 << '}'
1421                                    << '{' << body2 << '}';
1422                                 h_preamble << ss.str();
1423                         }
1424                         // restore the in_lyx_preamble setting
1425                         in_lyx_preamble = was_in_lyx_preamble;
1426                 }
1427
1428                 else if (t.cs() == "AtBeginDocument") {
1429                         string const name = p.verbatim_item();
1430                         // store the in_lyx_preamble setting
1431                         bool const was_in_lyx_preamble = in_lyx_preamble;
1432                         if (name == "\\providecommand\\partref[1]{\\ref{part:#1}}"
1433                                 || name == "\\providecommand\\chapref[1]{\\ref{chap:#1}}"
1434                                 || name == "\\providecommand\\secref[1]{\\ref{sec:#1}}"
1435                                 || name == "\\providecommand\\subref[1]{\\ref{sub:#1}}"
1436                                 || name == "\\providecommand\\parref[1]{\\ref{par:#1}}"
1437                                 || name == "\\providecommand\\figref[1]{\\ref{fig:#1}}"
1438                                 || name == "\\providecommand\\tabref[1]{\\ref{tab:#1}}"
1439                                 || name == "\\providecommand\\algref[1]{\\ref{alg:#1}}"
1440                                 || name == "\\providecommand\\fnref[1]{\\ref{fn:#1}}"
1441                                 || name == "\\providecommand\\enuref[1]{\\ref{enu:#1}}"
1442                                 || name == "\\providecommand\\eqref[1]{\\ref{eq:#1}}"
1443                                 || name == "\\providecommand\\lemref[1]{\\ref{lem:#1}}"
1444                                 || name == "\\providecommand\\thmref[1]{\\ref{thm:#1}}"
1445                                 || name == "\\providecommand\\corref[1]{\\ref{cor:#1}}"
1446                                 || name == "\\providecommand\\propref[1]{\\ref{prop:#1}}") {
1447                                 p.skip_spaces();
1448                                 preamble.registerAutomaticallyLoadedPackage("refstyle");
1449                                 in_lyx_preamble = true;
1450                         }
1451                         // only non-lyxspecific stuff
1452                         if (!in_lyx_preamble) {
1453                                 ostringstream ss;
1454                                 ss << '\\' << t.cs();
1455                                 ss << '{' << name << '}';
1456                                 h_preamble << ss.str();
1457                         }
1458                         // restore the in_lyx_preamble setting
1459                         in_lyx_preamble = was_in_lyx_preamble;
1460                 }
1461
1462                 else if (t.cs() == "newcommand" || t.cs() == "newcommandx"
1463                       || t.cs() == "renewcommand" || t.cs() == "renewcommandx"
1464                       || t.cs() == "providecommand" || t.cs() == "providecommandx"
1465                                 || t.cs() == "DeclareRobustCommand"
1466                       || t.cs() == "DeclareRobustCommandx"
1467                                 || t.cs() == "ProvideTextCommandDefault"
1468                                 || t.cs() == "DeclareMathAccent") {
1469                         bool star = false;
1470                         if (p.next_token().character() == '*') {
1471                                 p.get_token();
1472                                 star = true;
1473                         }
1474                         string const name = p.verbatim_item();
1475                         string const opt1 = p.getFullOpt();
1476                         string const opt2 = p.getFullOpt();
1477                         string const body = p.verbatim_item();
1478                         // store the in_lyx_preamble setting
1479                         bool const was_in_lyx_preamble = in_lyx_preamble;
1480                         // font settings
1481                         if (name == "\\rmdefault")
1482                                 if (is_known(body, known_roman_fonts)) {
1483                                         h_font_roman = body;
1484                                         p.skip_spaces();
1485                                         in_lyx_preamble = true;
1486                                 }
1487                         if (name == "\\sfdefault")
1488                                 if (is_known(body, known_sans_fonts)) {
1489                                         h_font_sans = body;
1490                                         p.skip_spaces();
1491                                         in_lyx_preamble = true;
1492                                 }
1493                         if (name == "\\ttdefault")
1494                                 if (is_known(body, known_typewriter_fonts)) {
1495                                         h_font_typewriter = body;
1496                                         p.skip_spaces();
1497                                         in_lyx_preamble = true;
1498                                 }
1499                         if (name == "\\familydefault") {
1500                                 string family = body;
1501                                 // remove leading "\"
1502                                 h_font_default_family = family.erase(0,1);
1503                                 p.skip_spaces();
1504                                 in_lyx_preamble = true;
1505                         }
1506                         if (name == "\\bfdefault")
1507                                 // LyX re-adds this if a kurier font is used
1508                                 if (is_known(h_font_sans, known_kurier_fonts) && body == "b") {
1509                                         p.skip_spaces();
1510                                         in_lyx_preamble = true;
1511                                 }
1512
1513                         // remove the lyxdot definition that is re-added by LyX
1514                         // if necessary
1515                         if (name == "\\lyxdot") {
1516                                 p.skip_spaces();
1517                                 in_lyx_preamble = true;
1518                         }
1519
1520                         // Add the command to the known commands
1521                         add_known_command(name, opt1, !opt2.empty(), from_utf8(body));
1522
1523                         // only non-lyxspecific stuff
1524                         if (!in_lyx_preamble) {
1525                                 ostringstream ss;
1526                                 ss << '\\' << t.cs();
1527                                 if (star)
1528                                         ss << '*';
1529                                 ss << '{' << name << '}' << opt1 << opt2
1530                                    << '{' << body << "}";
1531                                 h_preamble << ss.str();
1532 /*
1533                                 ostream & out = in_preamble ? h_preamble : os;
1534                                 out << "\\" << t.cs() << "{" << name << "}"
1535                                     << opts << "{" << body << "}";
1536 */
1537                         }
1538                         // restore the in_lyx_preamble setting
1539                         in_lyx_preamble = was_in_lyx_preamble;
1540                 }
1541
1542                 else if (t.cs() == "edef"){
1543                         // we only support this for kurier fonts
1544                         string const command = p.next_token().asInput();
1545                         p.get_token();
1546                         if (command == "\\sfdefault") {
1547                                 p.getArg('{', '}');
1548                                 if (h_font_sans == "kurier")
1549                                         h_font_sans = "kurier-condensed";
1550                                 if (h_font_sans == "kurierl")
1551                                         h_font_sans = "kurier-light-condensed";
1552                                 p.skip_spaces();
1553                         }
1554                         else
1555                                 h_preamble << "\\edef" << command << "{" << p.getArg('{', '}') << "}\n";
1556                 }
1557
1558                 else if (t.cs() == "documentclass") {
1559                         vector<string>::iterator it;
1560                         vector<string> opts = split_options(p.getArg('[', ']'));
1561                         handle_opt(opts, known_fontsizes, h_paperfontsize);
1562                         delete_opt(opts, known_fontsizes);
1563                         // delete "pt" at the end
1564                         string::size_type i = h_paperfontsize.find("pt");
1565                         if (i != string::npos)
1566                                 h_paperfontsize.erase(i);
1567                         // The documentclass options are always parsed before the options
1568                         // of the babel call so that a language cannot overwrite the babel
1569                         // options.
1570                         handle_opt(opts, known_languages, h_language);
1571                         delete_opt(opts, known_languages);
1572
1573                         // paper orientation
1574                         if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
1575                                 h_paperorientation = "landscape";
1576                                 opts.erase(it);
1577                         }
1578                         // paper sides
1579                         if ((it = find(opts.begin(), opts.end(), "oneside"))
1580                                  != opts.end()) {
1581                                 h_papersides = "1";
1582                                 opts.erase(it);
1583                         }
1584                         if ((it = find(opts.begin(), opts.end(), "twoside"))
1585                                  != opts.end()) {
1586                                 h_papersides = "2";
1587                                 opts.erase(it);
1588                         }
1589                         // paper columns
1590                         if ((it = find(opts.begin(), opts.end(), "onecolumn"))
1591                                  != opts.end()) {
1592                                 h_papercolumns = "1";
1593                                 opts.erase(it);
1594                         }
1595                         if ((it = find(opts.begin(), opts.end(), "twocolumn"))
1596                                  != opts.end()) {
1597                                 h_papercolumns = "2";
1598                                 opts.erase(it);
1599                         }
1600                         // paper sizes
1601                         // some size options are known to any document classes, other sizes
1602                         // are handled by the \geometry command of the geometry package
1603                         handle_opt(opts, known_class_paper_sizes, h_papersize);
1604                         delete_opt(opts, known_class_paper_sizes);
1605                         // the remaining options
1606                         h_options = join(opts, ",");
1607                         // FIXME This does not work for classes that have a
1608                         //       different name in LyX than in LaTeX
1609                         h_textclass = p.getArg('{', '}');
1610                         p.skip_spaces();
1611                 }
1612
1613                 else if (t.cs() == "usepackage") {
1614                         string const options = p.getArg('[', ']');
1615                         string const name = p.getArg('{', '}');
1616                         vector<string> vecnames;
1617                         split(name, vecnames, ',');
1618                         vector<string>::const_iterator it  = vecnames.begin();
1619                         vector<string>::const_iterator end = vecnames.end();
1620                         for (; it != end; ++it)
1621                                 handle_package(p, trimSpaceAndEol(*it), options,
1622                                                in_lyx_preamble);
1623                 }
1624
1625                 else if (t.cs() == "inputencoding") {
1626                         string const encoding = p.getArg('{','}');
1627                         h_inputencoding = encoding;
1628                         p.setEncoding(encoding, Encoding::inputenc);
1629                 }
1630
1631                 else if (t.cs() == "newenvironment") {
1632                         string const name = p.getArg('{', '}');
1633                         string const opt1 = p.getFullOpt();
1634                         string const opt2 = p.getFullOpt();
1635                         string const beg = p.verbatim_item();
1636                         string const end = p.verbatim_item();
1637                         if (!in_lyx_preamble) {
1638                                 h_preamble << "\\newenvironment{" << name
1639                                            << '}' << opt1 << opt2 << '{'
1640                                            << beg << "}{" << end << '}';
1641                         }
1642                         add_known_environment(name, opt1, !opt2.empty(),
1643                                               from_utf8(beg), from_utf8(end));
1644
1645                 }
1646
1647                 else if (t.cs() == "newtheorem") {
1648                         string const name = p.getArg('{', '}');
1649                         string const opt1 = p.getFullOpt();
1650                         string const opt2 = p.getFullOpt();
1651                         string const body = p.verbatim_item();
1652                         string const opt3 = p.getFullOpt();
1653
1654                         add_known_theorem(name, opt1, !opt2.empty(),
1655                                 from_utf8("\\newtheorem{" + name + '}' +
1656                                           opt1 + opt2 + '{' + body + '}' + opt3));
1657
1658                         if (!in_lyx_preamble)
1659                                 h_preamble << "\\newtheorem{" << name << '}'
1660                                            << opt1 << opt2 << '{' << '}' << opt3;
1661                 }
1662
1663                 else if (t.cs() == "def") {
1664                         string name = p.get_token().cs();
1665                         // In fact, name may be more than the name:
1666                         // In the test case of bug 8116
1667                         // name == "csname SF@gobble@opt \endcsname".
1668                         // Therefore, we need to use asInput() instead of cs().
1669                         while (p.next_token().cat() != catBegin)
1670                                 name += p.get_token().asInput();
1671                         if (!in_lyx_preamble)
1672                                 h_preamble << "\\def\\" << name << '{'
1673                                            << p.verbatim_item() << "}";
1674                 }
1675
1676                 else if (t.cs() == "newcolumntype") {
1677                         string const name = p.getArg('{', '}');
1678                         trimSpaceAndEol(name);
1679                         int nargs = 0;
1680                         string opts = p.getOpt();
1681                         if (!opts.empty()) {
1682                                 istringstream is(string(opts, 1));
1683                                 is >> nargs;
1684                         }
1685                         special_columns[name[0]] = nargs;
1686                         h_preamble << "\\newcolumntype{" << name << "}";
1687                         if (nargs)
1688                                 h_preamble << "[" << nargs << "]";
1689                         h_preamble << "{" << p.verbatim_item() << "}";
1690                 }
1691
1692                 else if (t.cs() == "setcounter") {
1693                         string const name = p.getArg('{', '}');
1694                         string const content = p.getArg('{', '}');
1695                         if (name == "secnumdepth")
1696                                 h_secnumdepth = content;
1697                         else if (name == "tocdepth")
1698                                 h_tocdepth = content;
1699                         else
1700                                 h_preamble << "\\setcounter{" << name << "}{" << content << "}";
1701                 }
1702
1703                 else if (t.cs() == "setlength") {
1704                         string const name = p.verbatim_item();
1705                         string const content = p.verbatim_item();
1706                         // the paragraphs are only not indented when \parindent is set to zero
1707                         if (name == "\\parindent" && content != "") {
1708                                 if (content[0] == '0')
1709                                         h_paragraph_separation = "skip";
1710                                 else
1711                                         h_paragraph_indentation = translate_len(content);
1712                         } else if (name == "\\parskip") {
1713                                 if (content == "\\smallskipamount")
1714                                         h_defskip = "smallskip";
1715                                 else if (content == "\\medskipamount")
1716                                         h_defskip = "medskip";
1717                                 else if (content == "\\bigskipamount")
1718                                         h_defskip = "bigskip";
1719                                 else
1720                                         h_defskip = content;
1721                         } else
1722                                 h_preamble << "\\setlength{" << name << "}{" << content << "}";
1723                 }
1724
1725                 else if (t.cs() == "onehalfspacing")
1726                         h_spacing = "onehalf";
1727
1728                 else if (t.cs() == "doublespacing")
1729                         h_spacing = "double";
1730
1731                 else if (t.cs() == "setstretch")
1732                         h_spacing = "other " + p.verbatim_item();
1733
1734                 else if (t.cs() == "synctex") {
1735                         // the scheme is \synctex=value
1736                         // where value can only be "1" or "-1"
1737                         h_output_sync = "1";
1738                         // there can be any character behind the value (e.g. a linebreak or a '\'
1739                         // therefore we extract it char by char
1740                         p.get_token();
1741                         string value = p.get_token().asInput();
1742                         if (value == "-")
1743                                 value += p.get_token().asInput();
1744                         h_output_sync_macro = "\\synctex=" + value;
1745                 }
1746
1747                 else if (t.cs() == "begin") {
1748                         string const name = p.getArg('{', '}');
1749                         if (name == "document")
1750                                 break;
1751                         h_preamble << "\\begin{" << name << "}";
1752                 }
1753
1754                 else if (t.cs() == "geometry") {
1755                         vector<string> opts = split_options(p.getArg('{', '}'));
1756                         handle_geometry(opts);
1757                 }
1758
1759                 else if (t.cs() == "definecolor") {
1760                         string const color = p.getArg('{', '}');
1761                         string const space = p.getArg('{', '}');
1762                         string const value = p.getArg('{', '}');
1763                         if (color == "document_fontcolor" && space == "rgb") {
1764                                 RGBColor c(RGBColorFromLaTeX(value));
1765                                 h_fontcolor = X11hexname(c);
1766                         } else if (color == "note_fontcolor" && space == "rgb") {
1767                                 RGBColor c(RGBColorFromLaTeX(value));
1768                                 h_notefontcolor = X11hexname(c);
1769                         } else if (color == "page_backgroundcolor" && space == "rgb") {
1770                                 RGBColor c(RGBColorFromLaTeX(value));
1771                                 h_backgroundcolor = X11hexname(c);
1772                         } else if (color == "shadecolor" && space == "rgb") {
1773                                 RGBColor c(RGBColorFromLaTeX(value));
1774                                 h_boxbgcolor = X11hexname(c);
1775                         } else {
1776                                 h_preamble << "\\definecolor{" << color
1777                                            << "}{" << space << "}{" << value
1778                                            << '}';
1779                         }
1780                 }
1781
1782                 else if (t.cs() == "bibliographystyle")
1783                         h_biblio_style = p.verbatim_item();
1784
1785                 else if (t.cs() == "jurabibsetup") {
1786                         // FIXME p.getArg('{', '}') is most probably wrong (it
1787                         //       does not handle nested braces).
1788                         //       Use p.verbatim_item() instead.
1789                         vector<string> jurabibsetup =
1790                                 split_options(p.getArg('{', '}'));
1791                         // add jurabibsetup to the jurabib package options
1792                         add_package("jurabib", jurabibsetup);
1793                         if (!jurabibsetup.empty()) {
1794                                 h_preamble << "\\jurabibsetup{"
1795                                            << join(jurabibsetup, ",") << '}';
1796                         }
1797                 }
1798
1799                 else if (t.cs() == "hypersetup") {
1800                         vector<string> hypersetup =
1801                                 split_options(p.verbatim_item());
1802                         // add hypersetup to the hyperref package options
1803                         handle_hyperref(hypersetup);
1804                         if (!hypersetup.empty()) {
1805                                 h_preamble << "\\hypersetup{"
1806                                            << join(hypersetup, ",") << '}';
1807                         }
1808                 }
1809
1810                 else if (is_known(t.cs(), known_if_3arg_commands)) {
1811                         // prevent misparsing of \usepackage if it is used
1812                         // as an argument (see e.g. our own output of
1813                         // \@ifundefined above)
1814                         string const arg1 = p.verbatim_item();
1815                         string const arg2 = p.verbatim_item();
1816                         string const arg3 = p.verbatim_item();
1817                         // test case \@ifundefined{date}{}{\date{}}
1818                         if (t.cs() == "@ifundefined" && arg1 == "date" &&
1819                             arg2.empty() && arg3 == "\\date{}") {
1820                                 h_suppress_date = "true";
1821                         // older tex2lyx versions did output
1822                         // \@ifundefined{definecolor}{\usepackage{color}}{}
1823                         } else if (t.cs() == "@ifundefined" &&
1824                                    arg1 == "definecolor" &&
1825                                    arg2 == "\\usepackage{color}" &&
1826                                    arg3.empty()) {
1827                                 if (!in_lyx_preamble)
1828                                         h_preamble << package_beg_sep
1829                                                    << "color"
1830                                                    << package_mid_sep
1831                                                    << "\\@ifundefined{definecolor}{color}{}"
1832                                                    << package_end_sep;
1833                         // test for case
1834                         //\@ifundefined{showcaptionsetup}{}{%
1835                         // \PassOptionsToPackage{caption=false}{subfig}}
1836                         // that LyX uses for subfloats
1837                         } else if (t.cs() == "@ifundefined" &&
1838                                    arg1 == "showcaptionsetup" && arg2.empty()
1839                                 && arg3 == "%\n \\PassOptionsToPackage{caption=false}{subfig}") {
1840                                 ; // do nothing
1841                         } else if (!in_lyx_preamble) {
1842                                 h_preamble << t.asInput()
1843                                            << '{' << arg1 << '}'
1844                                            << '{' << arg2 << '}'
1845                                            << '{' << arg3 << '}';
1846                         }
1847                 }
1848
1849                 else if (is_known(t.cs(), known_if_commands)) {
1850                         // must not parse anything in conditional code, since
1851                         // LyX would output the parsed contents unconditionally
1852                         if (!in_lyx_preamble)
1853                                 h_preamble << t.asInput();
1854                         handle_if(p, in_lyx_preamble);
1855                 }
1856
1857                 else if (!t.cs().empty() && !in_lyx_preamble)
1858                         h_preamble << '\\' << t.cs();
1859         }
1860
1861         // remove the whitespace
1862         p.skip_spaces();
1863
1864         // Force textclass if the user wanted it
1865         if (!forceclass.empty())
1866                 h_textclass = forceclass;
1867         tc.setName(h_textclass);
1868         if (!tc.load()) {
1869                 cerr << "Error: Could not read layout file for textclass \"" << h_textclass << "\"." << endl;
1870                 exit(EXIT_FAILURE);
1871         }
1872         if (h_papersides.empty()) {
1873                 ostringstream ss;
1874                 ss << tc.sides();
1875                 h_papersides = ss.str();
1876         }
1877
1878         // If the CJK package is used we cannot set the document language from
1879         // the babel options. Instead, we guess which language is used most
1880         // and set this one.
1881         default_language = h_language;
1882         if (is_full_document &&
1883             (auto_packages.find("CJK") != auto_packages.end() ||
1884              auto_packages.find("CJKutf8") != auto_packages.end())) {
1885                 p.pushPosition();
1886                 h_language = guessLanguage(p, default_language);
1887                 p.popPosition();
1888                 if (explicit_babel && h_language != default_language) {
1889                         // We set the document language to a CJK language,
1890                         // but babel is explicitly called in the user preamble
1891                         // without options. LyX will not add the default
1892                         // language to the document options if it is either
1893                         // english, or no text is set as default language.
1894                         // Therefore we need to add a language option explicitly.
1895                         // FIXME: It would be better to remove all babel calls
1896                         //        from the user preamble, but this is difficult
1897                         //        without re-introducing bug 7861.
1898                         if (h_options.empty())
1899                                 h_options = lyx2babel(default_language);
1900                         else
1901                                 h_options += ',' + lyx2babel(default_language);
1902                 }
1903         }
1904 }
1905
1906
1907 string babel2lyx(string const & language)
1908 {
1909         char const * const * where = is_known(language, known_languages);
1910         if (where)
1911                 return known_coded_languages[where - known_languages];
1912         return language;
1913 }
1914
1915
1916 string lyx2babel(string const & language)
1917 {
1918         char const * const * where = is_known(language, known_coded_languages);
1919         if (where)
1920                 return known_languages[where - known_coded_languages];
1921         return language;
1922 }
1923
1924
1925 string Preamble::polyglossia2lyx(string const & language)
1926 {
1927         char const * const * where = is_known(language, polyglossia_languages);
1928         if (where)
1929                 return coded_polyglossia_languages[where - polyglossia_languages];
1930         return language;
1931 }
1932
1933
1934 string rgbcolor2code(string const & name)
1935 {
1936         char const * const * where = is_known(name, known_basic_colors);
1937         if (where) {
1938                 // "red", "green" etc
1939                 return known_basic_color_codes[where - known_basic_colors];
1940         }
1941         // "255,0,0", "0,255,0" etc
1942         RGBColor c(RGBColorFromLaTeX(name));
1943         return X11hexname(c);
1944 }
1945
1946 // }])
1947
1948
1949 } // namespace lyx