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