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