3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
20 #include "LayoutFile.h"
23 #include "TextClass.h"
26 #include "support/convert.h"
27 #include "support/FileName.h"
28 #include "support/filetools.h"
29 #include "support/lstrings.h"
31 #include "support/regex.h"
37 using namespace lyx::support;
46 // CJK languages are handled in text.cpp, polyglossia languages are listed
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!
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",
71 * the same as known_languages with .lyx names
72 * please keep this in sync with known_languages line by line!
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",
91 /// languages with british quotes (.lyx names)
92 const char * const known_british_quotes_languages[] = {"british", "welsh", 0};
94 /// languages with cjk quotes (.lyx names)
95 const char * const known_cjk_quotes_languages[] = {"chinese-traditional",
96 "japanese", "japanese-cjk", 0};
98 /// languages with cjk-angle quotes (.lyx names)
99 const char * const known_cjkangle_quotes_languages[] = {"korean", 0};
101 /// languages with danish quotes (.lyx names)
102 const char * const known_danish_quotes_languages[] = {"danish", 0};
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};
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};
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",
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};
126 /// languages with russian quotes (.lyx names)
127 const char * const known_russian_quotes_languages[] = {"russian", "ukrainian", 0};
129 /// languages with swedish quotes (.lyx names)
130 const char * const known_swedish_quotes_languages[] = {"finnish", "swedish", 0};
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};
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};
141 char const * const known_fontsizes[] = { "10pt", "11pt", "12pt", 0 };
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", 0 };
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 };
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 };
158 const char * const known_math_fonts[] = { "eulervm", "newtxmath", 0};
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};
166 const char * const known_class_paper_sizes[] = { "a4paper", "a5paper",
167 "executivepaper", "legalpaper", "letterpaper", 0};
169 const char * const known_paper_margins[] = { "lmargin", "tmargin", "rmargin",
170 "bmargin", "headheight", "headsep", "footskip", "columnsep", 0};
172 const char * const known_coded_paper_margins[] = { "leftmargin", "topmargin",
173 "rightmargin", "bottommargin", "headheight", "headsep", "footskip",
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};
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};
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};
189 /// conditional commands with three arguments like \@ifundefined{}{}{}
190 const char * const known_if_3arg_commands[] = {"@ifundefined", "IfFileExists",
194 * Known file extensions for TeX files as used by \\includeonly
196 char const * const known_tex_extensions[] = {"tex", 0};
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};
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", "multirow", "nomencl", "pdfpages", "prettyref", "refstyle",
209 "rotating", "rotfloat", "splitidx", "setspace", "subscript", "textcomp", "tipa",
210 "tipx", "tone", "ulem", "url", "varioref", "verbatim", "wrapfig", "xcolor",
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';
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)
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) {
245 void delete_opt(vector<string> & opts, char const * const * what)
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())
262 * Split a package options string (keyval format) into a vector.
264 * authorformat=smallcaps,
266 * titleformat=colonsep,
267 * bibformat={tabular,ibidem,numbered}
269 vector<string> split_options(string const & input)
271 vector<string> options;
275 Token const & t = p.get_token();
276 if (t.asInput() == ",") {
277 options.push_back(trimSpaceAndEol(option));
279 } else if (t.asInput() == "=") {
282 if (p.next_token().asInput() == "{")
283 option += '{' + p.getArg('{', '}') + '}';
284 } else if (t.cat() != catSpace && t.cat() != catComment)
285 option += t.asInput();
289 options.push_back(trimSpaceAndEol(option));
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.
300 string process_keyval_opt(vector<string> & options, string name)
302 for (size_t i = 0; i < options.size(); ++i) {
303 vector<string> option;
304 split(options[i], option, '=');
305 if (option.size() < 2)
307 if (option[0] == name) {
308 options.erase(options.begin() + i);
309 option.erase(option.begin());
310 return join(option, "=");
316 } // anonymous namespace
320 * known polyglossia language names (including variants)
321 * FIXME: support spelling=old for german variants (german vs. ngerman LyX names etc)
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"
339 * the same as polyglossia_languages with .lyx names
340 * please keep this in sync with polyglossia_languages line by line!
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"
358 bool Preamble::usePolyglossia() const
360 return h_use_non_tex_fonts && h_language_package == "default";
364 bool Preamble::indentParagraphs() const
366 return h_paragraph_separation == "indent";
370 bool Preamble::isPackageUsed(string const & package) const
372 return used_packages.find(package) != used_packages.end();
376 vector<string> Preamble::getPackageOptions(string const & package) const
378 map<string, vector<string> >::const_iterator it = used_packages.find(package);
379 if (it != used_packages.end())
381 return vector<string>();
385 void Preamble::registerAutomaticallyLoadedPackage(std::string const & package)
387 auto_packages.insert(package);
391 void Preamble::addModule(string const & module)
393 used_modules.push_back(module);
397 void Preamble::suppressDate(bool suppress)
400 h_suppress_date = "true";
402 h_suppress_date = "false";
406 void Preamble::registerAuthor(std::string const & name)
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";
416 Author const & Preamble::getAuthor(std::string const & name) const
418 Author author(from_utf8(name), empty_docstring());
419 for (AuthorList::Authors::const_iterator it = authors_.begin();
420 it != authors_.end(); ++it)
423 static Author const dummy;
428 int Preamble::getSpecialTableColumnArguments(char c) const
430 map<char, int>::const_iterator it = special_columns_.find(c);
431 if (it == special_columns_.end())
437 void Preamble::add_package(string const & name, vector<string> & options)
439 // every package inherits the global options
440 if (used_packages.find(name) == used_packages.end())
441 used_packages[name] = split_options(h_options);
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);
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());
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)
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)));
483 string remove_braces(string const & value)
487 if (value[0] == '{' && value[value.length()-1] == '}')
488 return value.substr(1, value.length()-2);
492 } // anonymous namespace
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")
501 h_biblio_style = "plain";
502 h_bibtex_command = "default";
503 h_cite_engine = "basic";
504 h_cite_engine_type = "default";
506 h_defskip = "medskip";
507 h_dynamic_quotes = false;
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;
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";
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";
542 h_maintain_unincluded_children = "false";
546 h_output_changes = "false";
548 //h_output_sync_macro
549 h_papercolumns = "1";
550 h_paperfontsize = "default";
551 h_paperorientation = "portrait";
552 h_paperpagestyle = "default";
554 h_papersize = "default";
555 h_paragraph_indentation = "default";
556 h_paragraph_separation = "indent";
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";
571 //h_pdf_quoted_options;
572 h_quotes_style = "english";
574 h_shortcut[0] = "idx";
575 h_spacing = "single";
576 h_save_transient_properties = "true";
577 h_suppress_date = "false";
578 h_textclass = "article";
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";
603 void Preamble::handle_hyperref(vector<string> & options)
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())
613 it = find(options.begin(), options.end(), "pdfusetitle");
614 if (it != options.end()) {
615 h_pdf_pdfusetitle = "1";
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;
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);
668 string pdfauthor = process_keyval_opt(options, "pdfauthor");
669 if (!pdfauthor.empty()) {
670 h_pdf_author = remove_braces(pdfauthor);
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, ",");
687 void Preamble::handle_geometry(vector<string> & options)
689 h_use_geometry = "true";
690 vector<string>::iterator it;
692 if ((it = find(options.begin(), options.end(), "landscape")) != options.end()) {
693 h_paperorientation = "landscape";
697 // keyval version: "paper=letter"
698 string paper = process_keyval_opt(options, "paper");
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);
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';
717 void Preamble::handle_package(Parser &p, string const & name,
718 string const & opts, bool in_lyx_preamble,
721 vector<string> options = split_options(opts);
722 add_package(name, options);
724 if (is_known(name, known_xetex_packages)) {
726 h_use_non_tex_fonts = true;
727 registerAutomaticallyLoadedPackage("fontspec");
728 if (h_inputencoding == "auto")
729 p.setEncoding("UTF-8");
733 if (is_known(name, known_roman_fonts))
734 h_font_roman[0] = name;
736 if (name == "fourier") {
737 h_font_roman[0] = "utopia";
738 // when font uses real small capitals
739 if (opts == "expert")
743 if (name == "garamondx") {
744 h_font_roman[0] = "garamondx";
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";
757 else if (opts == "lining")
758 h_font_osf = "false";
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")
772 if (name == "MinionPro") {
773 h_font_roman[0] = "minionpro";
774 if (opts.find("lf") != string::npos)
775 h_font_osf = "false";
778 if (opts.find("onlytext") != string::npos)
779 h_font_math[0] = "default";
781 h_font_math[0] = "auto";
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) {
797 else if (name == "mathpazo")
798 h_font_roman[0] = "palatino";
800 else if (name == "mathptmx")
801 h_font_roman[0] = "times";
803 if (name == "crimson")
804 h_font_roman[0] = "cochineal";
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)
814 if (name == "noto") {
815 // noto can have several options
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";
829 // noto as typewriter is handled in handling of \ttdefault
830 // special cases are handled in handling of \rmdefault and \sfdefault
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";
840 if (name == "PTSerif")
841 h_font_roman[0] = "PTSerif-TLF";
844 if (is_known(name, known_sans_fonts)) {
845 h_font_sans[0] = name;
846 if (options.size() >= 1) {
847 if (scale_as_percentage(opts, h_font_sf_scale[0]))
852 if (name == "biolinum" || name == "biolinum-type1") {
853 h_font_sans[0] = "biolinum";
854 // biolinum can have several options, e.g. [osf,scaled=0.97]
855 string::size_type pos = opts.find("osf");
856 if (pos != string::npos)
860 if (name == "PTSans") {
861 h_font_sans[0] = "PTSans-TLF";
862 if (options.size() >= 1) {
863 if (scale_as_percentage(opts, h_font_sf_scale[0]))
869 if (is_known(name, known_typewriter_fonts)) {
870 // fourier can be set as roman font _only_
871 // fourier as typewriter is handled in handling of \ttdefault
872 if (name != "fourier") {
873 h_font_typewriter[0] = name;
874 if (options.size() >= 1) {
875 if (scale_as_percentage(opts, h_font_tt_scale[0]))
881 if (name == "libertineMono" || name == "libertineMono-type1")
882 h_font_typewriter[0] = "libertine-mono";
884 if (name == "PTMono") {
885 h_font_typewriter[0] = "PTMono-TLF";
886 if (options.size() >= 1) {
887 if (scale_as_percentage(opts, h_font_tt_scale[0]))
892 // font uses old-style figure
897 if (is_known(name, known_math_fonts))
898 h_font_math[0] = name;
900 if (name == "newtxmath") {
902 h_font_math[0] = "newtxmath";
903 else if (opts == "garamondx")
904 h_font_math[0] = "garamondx-ntxm";
905 else if (opts == "libertine")
906 h_font_math[0] = "libertine-ntxm";
907 else if (opts == "minion")
908 h_font_math[0] = "minion-ntxm";
909 else if (opts == "cochineal")
910 h_font_math[0] = "cochineal-ntxm";
915 h_font_math[0] = "iwona-math";
917 if (name == "kurier")
919 h_font_math[0] = "kurier-math";
921 // after the detection and handling of special cases, we can remove the
922 // fonts, otherwise they would appear in the preamble, see bug #7856
923 if (is_known(name, known_roman_fonts) || is_known(name, known_sans_fonts)
924 || is_known(name, known_typewriter_fonts) || is_known(name, known_math_fonts))
926 //"On". See the enum Package in BufferParams.h if you thought that "2" should have been "42"
927 else if (name == "amsmath" || name == "amssymb" || name == "cancel" ||
928 name == "esint" || name == "mhchem" || name == "mathdots" ||
929 name == "mathtools" || name == "stackrel" ||
930 name == "stmaryrd" || name == "undertilde")
931 h_use_packages[name] = "2";
933 else if (name == "babel") {
934 h_language_package = "default";
935 // One might think we would have to do nothing if babel is loaded
936 // without any options to prevent pollution of the preamble with this
937 // babel call in every roundtrip.
938 // But the user could have defined babel-specific things afterwards. So
939 // we need to keep it in the preamble to prevent cases like bug #7861.
941 // check if more than one option was used - used later for inputenc
942 if (options.begin() != options.end() - 1)
943 one_language = false;
944 // babel takes the last language of the option of its \usepackage
945 // call as document language. If there is no such language option, the
946 // last language in the documentclass options is used.
947 handle_opt(options, known_languages, h_language);
948 // translate the babel name to a LyX name
949 h_language = babel2lyx(h_language);
950 if (h_language == "japanese") {
951 // For Japanese, the encoding isn't indicated in the source
952 // file, and there's really not much we can do. We could
953 // 1) offer a list of possible encodings to choose from, or
954 // 2) determine the encoding of the file by inspecting it.
955 // For the time being, we leave the encoding alone so that
956 // we don't get iconv errors when making a wrong guess, and
957 // we will output a note at the top of the document
958 // explaining what to do.
959 Encoding const * const enc = encodings.fromIconvName(
960 p.getEncoding(), Encoding::japanese, false);
962 h_inputencoding = enc->name();
963 is_nonCJKJapanese = true;
964 // in this case babel can be removed from the preamble
965 registerAutomaticallyLoadedPackage("babel");
967 // If babel is called with options, LyX puts them by default into the
968 // document class options. This works for most languages, except
969 // for Latvian, Lithuanian, Mongolian, Turkmen and Vietnamese and
970 // perhaps in future others.
971 // Therefore keep the babel call as it is as the user might have
973 h_preamble << "\\usepackage[" << opts << "]{babel}\n";
975 delete_opt(options, known_languages);
977 h_preamble << "\\usepackage{babel}\n";
978 explicit_babel = true;
982 else if (name == "polyglossia") {
983 h_language_package = "default";
984 h_default_output_format = "pdf4";
985 h_use_non_tex_fonts = true;
987 registerAutomaticallyLoadedPackage("xunicode");
988 if (h_inputencoding == "auto")
989 p.setEncoding("UTF-8");
992 else if (name == "CJK") {
993 // set the encoding to "auto" because it might be set to "default" by the babel handling
994 // and this would not be correct for CJK
995 if (h_inputencoding == "default")
996 h_inputencoding = "auto";
997 registerAutomaticallyLoadedPackage("CJK");
1000 else if (name == "CJKutf8") {
1001 h_inputencoding = "utf8-cjk";
1002 p.setEncoding("UTF-8");
1003 registerAutomaticallyLoadedPackage("CJKutf8");
1006 else if (name == "fontenc") {
1007 h_fontencoding = getStringFromVector(options, ",");
1008 /* We could do the following for better round trip support,
1009 * but this makes the document less portable, so I skip it:
1010 if (h_fontencoding == lyxrc.fontenc)
1011 h_fontencoding = "global";
1016 else if (name == "inputenc" || name == "luainputenc") {
1017 // h_inputencoding is only set when there is not more than one
1018 // inputenc option because otherwise h_inputencoding must be
1019 // set to "auto" (the default encoding of the document language)
1020 // Therefore check that exactly one option is passed to inputenc.
1021 // It is also only set when there is not more than one babel
1023 if (!options.empty()) {
1024 string const encoding = options.back();
1025 Encoding const * const enc = encodings.fromLaTeXName(
1026 encoding, Encoding::inputenc, true);
1028 if (!detectEncoding)
1029 cerr << "Unknown encoding " << encoding
1030 << ". Ignoring." << std::endl;
1032 if (!enc->unsafe() && options.size() == 1 && one_language == true)
1033 h_inputencoding = enc->name();
1034 p.setEncoding(enc->iconvName());
1040 else if (name == "srcltx") {
1041 h_output_sync = "1";
1042 if (!opts.empty()) {
1043 h_output_sync_macro = "\\usepackage[" + opts + "]{srcltx}";
1046 h_output_sync_macro = "\\usepackage{srcltx}";
1049 else if (is_known(name, known_old_language_packages)) {
1050 // known language packages from the times before babel
1051 // if they are found and not also babel, they will be used as
1052 // custom language package
1053 h_language_package = "\\usepackage{" + name + "}";
1056 else if (name == "lyxskak") {
1057 // ignore this and its options
1058 const char * const o[] = {"ps", "mover", 0};
1059 delete_opt(options, o);
1062 else if (is_known(name, known_lyx_packages) && options.empty()) {
1063 if (name == "splitidx")
1064 h_use_indices = "true";
1065 else if (name == "minted")
1066 h_use_minted = true;
1067 else if (name == "refstyle")
1068 h_use_refstyle = true;
1069 else if (name == "prettyref")
1070 h_use_refstyle = false;
1071 if (!in_lyx_preamble) {
1072 h_preamble << package_beg_sep << name
1073 << package_mid_sep << "\\usepackage{"
1075 if (p.next_token().cat() == catNewline ||
1076 (p.next_token().cat() == catSpace &&
1077 p.next_next_token().cat() == catNewline))
1079 h_preamble << package_end_sep;
1083 else if (name == "geometry")
1084 handle_geometry(options);
1086 else if (name == "subfig")
1087 ; // ignore this FIXME: Use the package separator mechanism instead
1089 else if (char const * const * where = is_known(name, known_languages))
1090 h_language = known_coded_languages[where - known_languages];
1092 else if (name == "natbib") {
1093 h_biblio_style = "plainnat";
1094 h_cite_engine = "natbib";
1095 h_cite_engine_type = "authoryear";
1096 vector<string>::iterator it =
1097 find(options.begin(), options.end(), "authoryear");
1098 if (it != options.end())
1101 it = find(options.begin(), options.end(), "numbers");
1102 if (it != options.end()) {
1103 h_cite_engine_type = "numerical";
1107 if (!options.empty())
1108 h_biblio_options = join(options, ",");
1111 else if (name == "biblatex") {
1112 h_biblio_style = "plainnat";
1113 h_cite_engine = "biblatex";
1114 h_cite_engine_type = "authoryear";
1116 vector<string>::iterator it =
1117 find(options.begin(), options.end(), "natbib");
1118 if (it != options.end()) {
1120 h_cite_engine = "biblatex-natbib";
1122 opt = process_keyval_opt(options, "natbib");
1124 h_cite_engine = "biblatex-natbib";
1126 opt = process_keyval_opt(options, "style");
1128 h_biblatex_citestyle = opt;
1129 h_biblatex_bibstyle = opt;
1131 opt = process_keyval_opt(options, "citestyle");
1133 h_biblatex_citestyle = opt;
1134 opt = process_keyval_opt(options, "bibstyle");
1136 h_biblatex_bibstyle = opt;
1138 opt = process_keyval_opt(options, "refsection");
1140 if (opt == "none" || opt == "part"
1141 || opt == "chapter" || opt == "section"
1142 || opt == "subsection")
1145 cerr << "Ignoring unkown refesection value '"
1148 if (!options.empty()) {
1149 h_biblio_options = join(options, ",");
1154 else if (name == "jurabib") {
1155 h_biblio_style = "jurabib";
1156 h_cite_engine = "jurabib";
1157 h_cite_engine_type = "authoryear";
1158 if (!options.empty())
1159 h_biblio_options = join(options, ",");
1162 else if (name == "bibtopic")
1163 h_use_bibtopic = "true";
1165 else if (name == "chapterbib")
1166 h_multibib = "child";
1168 else if (name == "hyperref")
1169 handle_hyperref(options);
1171 else if (name == "algorithm2e") {
1172 // Load "algorithm2e" module
1173 addModule("algorithm2e");
1174 // Add the package options to the global document options
1175 if (!options.empty()) {
1176 if (h_options.empty())
1177 h_options = join(options, ",");
1179 h_options += ',' + join(options, ",");
1182 else if (name == "microtype") {
1183 //we internally support only microtype without params
1184 if (options.empty())
1185 h_use_microtype = "true";
1187 h_preamble << "\\usepackage[" << opts << "]{microtype}";
1190 else if (!in_lyx_preamble) {
1191 if (options.empty())
1192 h_preamble << "\\usepackage{" << name << '}';
1194 h_preamble << "\\usepackage[" << opts << "]{"
1198 if (p.next_token().cat() == catNewline ||
1199 (p.next_token().cat() == catSpace &&
1200 p.next_next_token().cat() == catNewline))
1204 // We need to do something with the options...
1205 if (!options.empty() && !detectEncoding)
1206 cerr << "Ignoring options '" << join(options, ",")
1207 << "' of package " << name << '.' << endl;
1209 // remove the whitespace
1214 void Preamble::handle_if(Parser & p, bool in_lyx_preamble)
1217 Token t = p.get_token();
1218 if (t.cat() == catEscape &&
1219 is_known(t.cs(), known_if_commands))
1220 handle_if(p, in_lyx_preamble);
1222 if (!in_lyx_preamble)
1223 h_preamble << t.asInput();
1224 if (t.cat() == catEscape && t.cs() == "fi")
1231 bool Preamble::writeLyXHeader(ostream & os, bool subdoc, string const & outfiledir)
1233 if (contains(h_float_placement, "H"))
1234 registerAutomaticallyLoadedPackage("float");
1235 if (h_spacing != "single" && h_spacing != "default")
1236 registerAutomaticallyLoadedPackage("setspace");
1237 if (h_use_packages["amsmath"] == "2") {
1238 // amsbsy and amstext are already provided by amsmath
1239 registerAutomaticallyLoadedPackage("amsbsy");
1240 registerAutomaticallyLoadedPackage("amstext");
1243 // output the LyX file settings
1244 // Important: Keep the version formatting in sync with LyX and
1245 // lyx2lyx (bug 7951)
1246 string const origin = roundtripMode() ? "roundtrip" : outfiledir;
1247 os << "#LyX file created by tex2lyx " << lyx_version_major << '.'
1248 << lyx_version_minor << '\n'
1249 << "\\lyxformat " << LYX_FORMAT << '\n'
1250 << "\\begin_document\n"
1251 << "\\begin_header\n"
1252 << "\\save_transient_properties " << h_save_transient_properties << "\n"
1253 << "\\origin " << origin << "\n"
1254 << "\\textclass " << h_textclass << "\n";
1255 string const raw = subdoc ? empty_string() : h_preamble.str();
1257 os << "\\begin_preamble\n";
1258 for (string::size_type i = 0; i < raw.size(); ++i) {
1259 if (raw[i] == package_beg_sep) {
1260 // Here follows some package loading code that
1261 // must be skipped if the package is loaded
1263 string::size_type j = raw.find(package_mid_sep, i);
1264 if (j == string::npos)
1266 string::size_type k = raw.find(package_end_sep, j);
1267 if (k == string::npos)
1269 string const package = raw.substr(i + 1, j - i - 1);
1270 string const replacement = raw.substr(j + 1, k - j - 1);
1271 if (auto_packages.find(package) == auto_packages.end())
1277 os << "\n\\end_preamble\n";
1279 if (!h_options.empty())
1280 os << "\\options " << h_options << "\n";
1281 os << "\\use_default_options " << h_use_default_options << "\n";
1282 if (!used_modules.empty()) {
1283 os << "\\begin_modules\n";
1284 vector<string>::const_iterator const end = used_modules.end();
1285 vector<string>::const_iterator it = used_modules.begin();
1286 for (; it != end; ++it)
1288 os << "\\end_modules\n";
1290 if (!h_includeonlys.empty()) {
1291 os << "\\begin_includeonly\n";
1292 for (auto const & iofile : h_includeonlys)
1293 os << iofile << '\n';
1294 os << "\\end_includeonly\n";
1296 os << "\\maintain_unincluded_children " << h_maintain_unincluded_children << "\n"
1297 << "\\language " << h_language << "\n"
1298 << "\\language_package " << h_language_package << "\n"
1299 << "\\inputencoding " << h_inputencoding << "\n"
1300 << "\\fontencoding " << h_fontencoding << "\n"
1301 << "\\font_roman \"" << h_font_roman[0]
1302 << "\" \"" << h_font_roman[1] << "\"\n"
1303 << "\\font_sans \"" << h_font_sans[0] << "\" \"" << h_font_sans[1] << "\"\n"
1304 << "\\font_typewriter \"" << h_font_typewriter[0]
1305 << "\" \"" << h_font_typewriter[1] << "\"\n"
1306 << "\\font_math \"" << h_font_math[0] << "\" \"" << h_font_math[1] << "\"\n"
1307 << "\\font_default_family " << h_font_default_family << "\n"
1308 << "\\use_non_tex_fonts " << (h_use_non_tex_fonts ? "true" : "false") << '\n'
1309 << "\\font_sc " << h_font_sc << "\n"
1310 << "\\font_osf " << h_font_osf << "\n"
1311 << "\\font_sf_scale " << h_font_sf_scale[0]
1312 << ' ' << h_font_sf_scale[1] << '\n'
1313 << "\\font_tt_scale " << h_font_tt_scale[0]
1314 << ' ' << h_font_tt_scale[1] << '\n';
1315 if (!h_font_cjk.empty())
1316 os << "\\font_cjk " << h_font_cjk << '\n';
1317 os << "\\use_microtype " << h_use_microtype << '\n'
1318 << "\\use_dash_ligatures " << h_use_dash_ligatures << '\n'
1319 << "\\graphics " << h_graphics << '\n'
1320 << "\\default_output_format " << h_default_output_format << "\n"
1321 << "\\output_sync " << h_output_sync << "\n";
1322 if (h_output_sync == "1")
1323 os << "\\output_sync_macro \"" << h_output_sync_macro << "\"\n";
1324 os << "\\bibtex_command " << h_bibtex_command << "\n"
1325 << "\\index_command " << h_index_command << "\n";
1326 if (!h_float_placement.empty())
1327 os << "\\float_placement " << h_float_placement << "\n";
1328 os << "\\paperfontsize " << h_paperfontsize << "\n"
1329 << "\\spacing " << h_spacing << "\n"
1330 << "\\use_hyperref " << h_use_hyperref << '\n';
1331 if (h_use_hyperref == "true") {
1332 if (!h_pdf_title.empty())
1333 os << "\\pdf_title " << Lexer::quoteString(h_pdf_title) << '\n';
1334 if (!h_pdf_author.empty())
1335 os << "\\pdf_author " << Lexer::quoteString(h_pdf_author) << '\n';
1336 if (!h_pdf_subject.empty())
1337 os << "\\pdf_subject " << Lexer::quoteString(h_pdf_subject) << '\n';
1338 if (!h_pdf_keywords.empty())
1339 os << "\\pdf_keywords " << Lexer::quoteString(h_pdf_keywords) << '\n';
1340 os << "\\pdf_bookmarks " << h_pdf_bookmarks << "\n"
1341 "\\pdf_bookmarksnumbered " << h_pdf_bookmarksnumbered << "\n"
1342 "\\pdf_bookmarksopen " << h_pdf_bookmarksopen << "\n"
1343 "\\pdf_bookmarksopenlevel " << h_pdf_bookmarksopenlevel << "\n"
1344 "\\pdf_breaklinks " << h_pdf_breaklinks << "\n"
1345 "\\pdf_pdfborder " << h_pdf_pdfborder << "\n"
1346 "\\pdf_colorlinks " << h_pdf_colorlinks << "\n"
1347 "\\pdf_backref " << h_pdf_backref << "\n"
1348 "\\pdf_pdfusetitle " << h_pdf_pdfusetitle << '\n';
1349 if (!h_pdf_pagemode.empty())
1350 os << "\\pdf_pagemode " << h_pdf_pagemode << '\n';
1351 if (!h_pdf_quoted_options.empty())
1352 os << "\\pdf_quoted_options " << Lexer::quoteString(h_pdf_quoted_options) << '\n';
1354 os << "\\papersize " << h_papersize << "\n"
1355 << "\\use_geometry " << h_use_geometry << '\n';
1356 for (map<string, string>::const_iterator it = h_use_packages.begin();
1357 it != h_use_packages.end(); ++it)
1358 os << "\\use_package " << it->first << ' ' << it->second << '\n';
1359 os << "\\cite_engine " << h_cite_engine << '\n'
1360 << "\\cite_engine_type " << h_cite_engine_type << '\n'
1361 << "\\biblio_style " << h_biblio_style << "\n"
1362 << "\\use_bibtopic " << h_use_bibtopic << "\n";
1363 if (!h_biblio_options.empty())
1364 os << "\\biblio_options " << h_biblio_options << "\n";
1365 if (!h_biblatex_bibstyle.empty())
1366 os << "\\biblatex_bibstyle " << h_biblatex_bibstyle << "\n";
1367 if (!h_biblatex_citestyle.empty())
1368 os << "\\biblatex_citestyle " << h_biblatex_citestyle << "\n";
1369 if (!h_multibib.empty())
1370 os << "\\multibib " << h_multibib << "\n";
1371 os << "\\use_indices " << h_use_indices << "\n"
1372 << "\\paperorientation " << h_paperorientation << '\n'
1373 << "\\suppress_date " << h_suppress_date << '\n'
1374 << "\\justification " << h_justification << '\n'
1375 << "\\use_refstyle " << h_use_refstyle << '\n'
1376 << "\\use_minted " << h_use_minted << '\n';
1377 if (!h_fontcolor.empty())
1378 os << "\\fontcolor " << h_fontcolor << '\n';
1379 if (!h_notefontcolor.empty())
1380 os << "\\notefontcolor " << h_notefontcolor << '\n';
1381 if (!h_backgroundcolor.empty())
1382 os << "\\backgroundcolor " << h_backgroundcolor << '\n';
1383 if (!h_boxbgcolor.empty())
1384 os << "\\boxbgcolor " << h_boxbgcolor << '\n';
1385 if (index_number != 0)
1386 for (int i = 0; i < index_number; i++) {
1387 os << "\\index " << h_index[i] << '\n'
1388 << "\\shortcut " << h_shortcut[i] << '\n'
1389 << "\\color " << h_color << '\n'
1393 os << "\\index " << h_index[0] << '\n'
1394 << "\\shortcut " << h_shortcut[0] << '\n'
1395 << "\\color " << h_color << '\n'
1399 << "\\secnumdepth " << h_secnumdepth << "\n"
1400 << "\\tocdepth " << h_tocdepth << "\n"
1401 << "\\paragraph_separation " << h_paragraph_separation << "\n";
1402 if (h_paragraph_separation == "skip")
1403 os << "\\defskip " << h_defskip << "\n";
1405 os << "\\paragraph_indentation " << h_paragraph_indentation << "\n";
1406 os << "\\is_math_indent " << h_is_mathindent << "\n";
1407 if (!h_mathindentation.empty())
1408 os << "\\math_indentation " << h_mathindentation << "\n";
1409 os << "\\math_numbering_side " << h_math_numbering_side << "\n";
1410 os << "\\quotes_style " << h_quotes_style << "\n"
1411 << "\\dynamic_quotes " << h_dynamic_quotes << "\n"
1412 << "\\papercolumns " << h_papercolumns << "\n"
1413 << "\\papersides " << h_papersides << "\n"
1414 << "\\paperpagestyle " << h_paperpagestyle << "\n";
1415 if (!h_listings_params.empty())
1416 os << "\\listings_params " << h_listings_params << "\n";
1417 os << "\\tracking_changes " << h_tracking_changes << "\n"
1418 << "\\output_changes " << h_output_changes << "\n"
1419 << "\\html_math_output " << h_html_math_output << "\n"
1420 << "\\html_css_as_file " << h_html_css_as_file << "\n"
1421 << "\\html_be_strict " << h_html_be_strict << "\n"
1423 << "\\end_header\n\n"
1424 << "\\begin_body\n";
1429 void Preamble::parse(Parser & p, string const & forceclass,
1430 TeX2LyXDocClass & tc)
1432 // initialize fixed types
1433 special_columns_['D'] = 3;
1434 parse(p, forceclass, false, tc);
1438 void Preamble::parse(Parser & p, string const & forceclass,
1439 bool detectEncoding, TeX2LyXDocClass & tc)
1441 bool is_full_document = false;
1442 bool is_lyx_file = false;
1443 bool in_lyx_preamble = false;
1445 // determine whether this is a full document or a fragment for inclusion
1447 Token const & t = p.get_token();
1449 if (t.cat() == catEscape && t.cs() == "documentclass") {
1450 is_full_document = true;
1456 if (detectEncoding && !is_full_document)
1459 while (is_full_document && p.good()) {
1460 if (detectEncoding && h_inputencoding != "auto" &&
1461 h_inputencoding != "default")
1464 Token const & t = p.get_token();
1467 if (!detectEncoding)
1468 cerr << "t: " << t << '\n';
1474 if (!in_lyx_preamble &&
1475 (t.cat() == catLetter ||
1476 t.cat() == catSuper ||
1477 t.cat() == catSub ||
1478 t.cat() == catOther ||
1479 t.cat() == catMath ||
1480 t.cat() == catActive ||
1481 t.cat() == catBegin ||
1482 t.cat() == catEnd ||
1483 t.cat() == catAlign ||
1484 t.cat() == catParameter)) {
1485 h_preamble << t.cs();
1489 if (!in_lyx_preamble &&
1490 (t.cat() == catSpace || t.cat() == catNewline)) {
1491 h_preamble << t.asInput();
1495 if (t.cat() == catComment) {
1496 static regex const islyxfile("%% LyX .* created this file");
1497 static regex const usercommands("User specified LaTeX commands");
1499 string const comment = t.asInput();
1501 // magically switch encoding default if it looks like XeLaTeX
1502 static string const magicXeLaTeX =
1503 "% This document must be compiled with XeLaTeX ";
1504 if (comment.size() > magicXeLaTeX.size()
1505 && comment.substr(0, magicXeLaTeX.size()) == magicXeLaTeX
1506 && h_inputencoding == "auto") {
1507 if (!detectEncoding)
1508 cerr << "XeLaTeX comment found, switching to UTF8\n";
1509 h_inputencoding = "utf8";
1512 if (regex_search(comment, sub, islyxfile)) {
1514 in_lyx_preamble = true;
1515 } else if (is_lyx_file
1516 && regex_search(comment, sub, usercommands))
1517 in_lyx_preamble = false;
1518 else if (!in_lyx_preamble)
1519 h_preamble << t.asInput();
1523 if (t.cs() == "PassOptionsToPackage") {
1524 string const poptions = p.getArg('{', '}');
1525 string const package = p.verbatim_item();
1526 extra_package_options_.insert(make_pair(package, poptions));
1530 if (t.cs() == "pagestyle") {
1531 h_paperpagestyle = p.verbatim_item();
1535 if (t.cs() == "setdefaultlanguage") {
1537 // We don't yet care about non-language variant options
1538 // because LyX doesn't support this yet, see bug #8214
1540 string langopts = p.getOpt();
1541 // check if the option contains a variant, if yes, extract it
1542 string::size_type pos_var = langopts.find("variant");
1543 string::size_type i = langopts.find(',', pos_var);
1544 string::size_type k = langopts.find('=', pos_var);
1545 if (pos_var != string::npos){
1547 if (i == string::npos)
1548 variant = langopts.substr(k + 1, langopts.length() - k - 2);
1550 variant = langopts.substr(k + 1, i - k - 1);
1551 h_language = variant;
1555 h_language = p.verbatim_item();
1556 //finally translate the poyglossia name to a LyX name
1557 h_language = polyglossia2lyx(h_language);
1561 if (t.cs() == "setotherlanguage") {
1562 // We don't yet care about the option because LyX doesn't
1563 // support this yet, see bug #8214
1564 p.hasOpt() ? p.getOpt() : string();
1569 if (t.cs() == "setmainfont") {
1570 // we don't care about the option
1571 p.hasOpt() ? p.getOpt() : string();
1572 h_font_roman[1] = p.getArg('{', '}');
1576 if (t.cs() == "setsansfont" || t.cs() == "setmonofont") {
1577 // LyX currently only supports the scale option
1580 string fontopts = p.getArg('[', ']');
1581 // check if the option contains a scaling, if yes, extract it
1582 string::size_type pos = fontopts.find("Scale");
1583 if (pos != string::npos) {
1584 string::size_type i = fontopts.find(',', pos);
1585 if (i == string::npos)
1586 scale_as_percentage(fontopts.substr(pos + 1), scale);
1588 scale_as_percentage(fontopts.substr(pos, i - pos), scale);
1591 if (t.cs() == "setsansfont") {
1593 h_font_sf_scale[1] = scale;
1594 h_font_sans[1] = p.getArg('{', '}');
1597 h_font_tt_scale[1] = scale;
1598 h_font_typewriter[1] = p.getArg('{', '}');
1603 if (t.cs() == "date") {
1604 string argument = p.getArg('{', '}');
1605 if (argument.empty())
1606 h_suppress_date = "true";
1608 h_preamble << t.asInput() << '{' << argument << '}';
1612 if (t.cs() == "color") {
1613 string const space =
1614 (p.hasOpt() ? p.getOpt() : string());
1615 string argument = p.getArg('{', '}');
1616 // check the case that a standard color is used
1617 if (space.empty() && is_known(argument, known_basic_colors)) {
1618 h_fontcolor = rgbcolor2code(argument);
1619 registerAutomaticallyLoadedPackage("color");
1620 } else if (space.empty() && argument == "document_fontcolor")
1621 registerAutomaticallyLoadedPackage("color");
1622 // check the case that LyX's document_fontcolor is defined
1623 // but not used for \color
1625 h_preamble << t.asInput();
1627 h_preamble << space;
1628 h_preamble << '{' << argument << '}';
1629 // the color might already be set because \definecolor
1630 // is parsed before this
1636 if (t.cs() == "pagecolor") {
1637 string argument = p.getArg('{', '}');
1638 // check the case that a standard color is used
1639 if (is_known(argument, known_basic_colors)) {
1640 h_backgroundcolor = rgbcolor2code(argument);
1641 } else if (argument == "page_backgroundcolor")
1642 registerAutomaticallyLoadedPackage("color");
1643 // check the case that LyX's page_backgroundcolor is defined
1644 // but not used for \pagecolor
1646 h_preamble << t.asInput() << '{' << argument << '}';
1647 // the color might already be set because \definecolor
1648 // is parsed before this
1649 h_backgroundcolor = "";
1654 if (t.cs() == "makeatletter") {
1655 // LyX takes care of this
1656 p.setCatcode('@', catLetter);
1660 if (t.cs() == "makeatother") {
1661 // LyX takes care of this
1662 p.setCatcode('@', catOther);
1666 if (t.cs() == "makeindex") {
1667 // LyX will re-add this if a print index command is found
1672 if (t.cs() == "newindex") {
1673 string const indexname = p.getArg('[', ']');
1674 string const shortcut = p.verbatim_item();
1675 if (!indexname.empty())
1676 h_index[index_number] = indexname;
1678 h_index[index_number] = shortcut;
1679 h_shortcut[index_number] = shortcut;
1685 if (t.cs() == "addbibresource") {
1686 biblatex_bibliographies.push_back(removeExtension(p.getArg('{', '}')));
1690 if (t.cs() == "bibliography") {
1691 vector<string> bibs = getVectorFromString(p.getArg('{', '}'));
1692 biblatex_bibliographies.insert(biblatex_bibliographies.end(), bibs.begin(), bibs.end());
1696 if (t.cs() == "RS@ifundefined") {
1697 string const name = p.verbatim_item();
1698 string const body1 = p.verbatim_item();
1699 string const body2 = p.verbatim_item();
1700 // only non-lyxspecific stuff
1701 if (in_lyx_preamble &&
1702 (name == "subsecref" || name == "thmref" || name == "lemref"))
1706 ss << '\\' << t.cs();
1707 ss << '{' << name << '}'
1708 << '{' << body1 << '}'
1709 << '{' << body2 << '}';
1710 h_preamble << ss.str();
1715 if (t.cs() == "AtBeginDocument") {
1716 string const name = p.verbatim_item();
1717 // only non-lyxspecific stuff
1718 if (in_lyx_preamble &&
1719 (name == "\\providecommand\\partref[1]{\\ref{part:#1}}"
1720 || name == "\\providecommand\\chapref[1]{\\ref{chap:#1}}"
1721 || name == "\\providecommand\\secref[1]{\\ref{sec:#1}}"
1722 || name == "\\providecommand\\subsecref[1]{\\ref{subsec:#1}}"
1723 || name == "\\providecommand\\parref[1]{\\ref{par:#1}}"
1724 || name == "\\providecommand\\figref[1]{\\ref{fig:#1}}"
1725 || name == "\\providecommand\\tabref[1]{\\ref{tab:#1}}"
1726 || name == "\\providecommand\\algref[1]{\\ref{alg:#1}}"
1727 || name == "\\providecommand\\fnref[1]{\\ref{fn:#1}}"
1728 || name == "\\providecommand\\enuref[1]{\\ref{enu:#1}}"
1729 || name == "\\providecommand\\eqref[1]{\\ref{eq:#1}}"
1730 || name == "\\providecommand\\lemref[1]{\\ref{lem:#1}}"
1731 || name == "\\providecommand\\thmref[1]{\\ref{thm:#1}}"
1732 || name == "\\providecommand\\corref[1]{\\ref{cor:#1}}"
1733 || name == "\\providecommand\\propref[1]{\\ref{prop:#1}}"))
1737 ss << '\\' << t.cs();
1738 ss << '{' << name << '}';
1739 h_preamble << ss.str();
1744 if (t.cs() == "newcommand" || t.cs() == "newcommandx"
1745 || t.cs() == "renewcommand" || t.cs() == "renewcommandx"
1746 || t.cs() == "providecommand" || t.cs() == "providecommandx"
1747 || t.cs() == "DeclareRobustCommand"
1748 || t.cs() == "DeclareRobustCommandx"
1749 || t.cs() == "ProvideTextCommandDefault"
1750 || t.cs() == "DeclareMathAccent") {
1752 if (p.next_token().character() == '*') {
1756 string const name = p.verbatim_item();
1757 string const opt1 = p.getFullOpt();
1758 string const opt2 = p.getFullOpt();
1759 string const body = p.verbatim_item();
1760 // store the in_lyx_preamble setting
1761 bool const was_in_lyx_preamble = in_lyx_preamble;
1763 if (name == "\\rmdefault")
1764 if (is_known(body, known_roman_fonts)) {
1765 h_font_roman[0] = body;
1767 in_lyx_preamble = true;
1769 if (name == "\\sfdefault")
1770 if (is_known(body, known_sans_fonts)) {
1771 h_font_sans[0] = body;
1773 in_lyx_preamble = true;
1775 if (name == "\\ttdefault")
1776 if (is_known(body, known_typewriter_fonts)) {
1777 h_font_typewriter[0] = body;
1779 in_lyx_preamble = true;
1781 if (name == "\\familydefault") {
1782 string family = body;
1783 // remove leading "\"
1784 h_font_default_family = family.erase(0,1);
1786 in_lyx_preamble = true;
1789 // remove LyX-specific definitions that are re-added by LyX
1791 // \lyxline is an ancient command that is converted by tex2lyx into
1792 // a \rule therefore remove its preamble code
1793 if (name == "\\lyxdot" || name == "\\lyxarrow"
1794 || name == "\\lyxline" || name == "\\LyX") {
1796 in_lyx_preamble = true;
1799 // Add the command to the known commands
1800 add_known_command(name, opt1, !opt2.empty(), from_utf8(body));
1802 // only non-lyxspecific stuff
1803 if (!in_lyx_preamble) {
1805 ss << '\\' << t.cs();
1808 ss << '{' << name << '}' << opt1 << opt2
1809 << '{' << body << "}";
1810 h_preamble << ss.str();
1812 ostream & out = in_preamble ? h_preamble : os;
1813 out << "\\" << t.cs() << "{" << name << "}"
1814 << opts << "{" << body << "}";
1817 // restore the in_lyx_preamble setting
1818 in_lyx_preamble = was_in_lyx_preamble;
1822 if (t.cs() == "documentclass") {
1823 vector<string>::iterator it;
1824 vector<string> opts = split_options(p.getArg('[', ']'));
1825 handle_opt(opts, known_fontsizes, h_paperfontsize);
1826 delete_opt(opts, known_fontsizes);
1827 // delete "pt" at the end
1828 string::size_type i = h_paperfontsize.find("pt");
1829 if (i != string::npos)
1830 h_paperfontsize.erase(i);
1831 // The documentclass options are always parsed before the options
1832 // of the babel call so that a language cannot overwrite the babel
1834 handle_opt(opts, known_languages, h_language);
1835 delete_opt(opts, known_languages);
1838 if ((it = find(opts.begin(), opts.end(), "fleqn"))
1840 h_is_mathindent = "1";
1843 // formula numbering side
1844 if ((it = find(opts.begin(), opts.end(), "leqno"))
1846 h_math_numbering_side = "left";
1849 else if ((it = find(opts.begin(), opts.end(), "reqno"))
1851 h_math_numbering_side = "right";
1855 // paper orientation
1856 if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
1857 h_paperorientation = "landscape";
1861 if ((it = find(opts.begin(), opts.end(), "oneside"))
1866 if ((it = find(opts.begin(), opts.end(), "twoside"))
1872 if ((it = find(opts.begin(), opts.end(), "onecolumn"))
1874 h_papercolumns = "1";
1877 if ((it = find(opts.begin(), opts.end(), "twocolumn"))
1879 h_papercolumns = "2";
1883 // some size options are known to any document classes, other sizes
1884 // are handled by the \geometry command of the geometry package
1885 handle_opt(opts, known_class_paper_sizes, h_papersize);
1886 delete_opt(opts, known_class_paper_sizes);
1887 // the remaining options
1888 h_options = join(opts, ",");
1889 // FIXME This does not work for classes that have a
1890 // different name in LyX than in LaTeX
1891 h_textclass = p.getArg('{', '}');
1896 if (t.cs() == "usepackage") {
1897 string const options = p.getArg('[', ']');
1898 string const name = p.getArg('{', '}');
1899 vector<string> vecnames;
1900 split(name, vecnames, ',');
1901 vector<string>::const_iterator it = vecnames.begin();
1902 vector<string>::const_iterator end = vecnames.end();
1903 for (; it != end; ++it)
1904 handle_package(p, trimSpaceAndEol(*it), options,
1905 in_lyx_preamble, detectEncoding);
1909 if (t.cs() == "inputencoding") {
1910 string const encoding = p.getArg('{','}');
1911 Encoding const * const enc = encodings.fromLaTeXName(
1912 encoding, Encoding::inputenc, true);
1914 if (!detectEncoding)
1915 cerr << "Unknown encoding " << encoding
1916 << ". Ignoring." << std::endl;
1919 h_inputencoding = enc->name();
1920 p.setEncoding(enc->iconvName());
1925 if (t.cs() == "newenvironment") {
1926 string const name = p.getArg('{', '}');
1927 string const opt1 = p.getFullOpt();
1928 string const opt2 = p.getFullOpt();
1929 string const beg = p.verbatim_item();
1930 string const end = p.verbatim_item();
1931 if (!in_lyx_preamble) {
1932 h_preamble << "\\newenvironment{" << name
1933 << '}' << opt1 << opt2 << '{'
1934 << beg << "}{" << end << '}';
1936 add_known_environment(name, opt1, !opt2.empty(),
1937 from_utf8(beg), from_utf8(end));
1941 if (t.cs() == "newtheorem") {
1943 if (p.next_token().character() == '*') {
1947 string const name = p.getArg('{', '}');
1948 string const opt1 = p.getFullOpt();
1949 string const opt2 = p.getFullOpt();
1950 string const body = p.verbatim_item();
1951 string const opt3 = p.getFullOpt();
1952 string const cmd = star ? "\\newtheorem*" : "\\newtheorem";
1954 string const complete = cmd + "{" + name + '}' +
1955 opt1 + opt2 + '{' + body + '}' + opt3;
1957 add_known_theorem(name, opt1, !opt2.empty(), from_utf8(complete));
1959 if (!in_lyx_preamble)
1960 h_preamble << complete;
1964 if (t.cs() == "def") {
1965 string name = p.get_token().cs();
1966 // In fact, name may be more than the name:
1967 // In the test case of bug 8116
1968 // name == "csname SF@gobble@opt \endcsname".
1969 // Therefore, we need to use asInput() instead of cs().
1970 while (p.next_token().cat() != catBegin)
1971 name += p.get_token().asInput();
1972 if (!in_lyx_preamble)
1973 h_preamble << "\\def\\" << name << '{'
1974 << p.verbatim_item() << "}";
1978 if (t.cs() == "newcolumntype") {
1979 string const name = p.getArg('{', '}');
1980 trimSpaceAndEol(name);
1982 string opts = p.getOpt();
1983 if (!opts.empty()) {
1984 istringstream is(string(opts, 1));
1987 special_columns_[name[0]] = nargs;
1988 h_preamble << "\\newcolumntype{" << name << "}";
1990 h_preamble << "[" << nargs << "]";
1991 h_preamble << "{" << p.verbatim_item() << "}";
1995 if (t.cs() == "setcounter") {
1996 string const name = p.getArg('{', '}');
1997 string const content = p.getArg('{', '}');
1998 if (name == "secnumdepth")
1999 h_secnumdepth = content;
2000 else if (name == "tocdepth")
2001 h_tocdepth = content;
2003 h_preamble << "\\setcounter{" << name << "}{" << content << "}";
2007 if (t.cs() == "setlength") {
2008 string const name = p.verbatim_item();
2009 string const content = p.verbatim_item();
2010 // the paragraphs are only not indented when \parindent is set to zero
2011 if (name == "\\parindent" && content != "") {
2012 if (content[0] == '0')
2013 h_paragraph_separation = "skip";
2015 h_paragraph_indentation = translate_len(content);
2016 } else if (name == "\\parskip") {
2017 if (content == "\\smallskipamount")
2018 h_defskip = "smallskip";
2019 else if (content == "\\medskipamount")
2020 h_defskip = "medskip";
2021 else if (content == "\\bigskipamount")
2022 h_defskip = "bigskip";
2024 h_defskip = translate_len(content);
2025 } else if (name == "\\mathindent") {
2026 h_mathindentation = translate_len(content);
2028 h_preamble << "\\setlength{" << name << "}{" << content << "}";
2032 if (t.cs() == "onehalfspacing") {
2033 h_spacing = "onehalf";
2037 if (t.cs() == "doublespacing") {
2038 h_spacing = "double";
2042 if (t.cs() == "setstretch") {
2043 h_spacing = "other " + p.verbatim_item();
2047 if (t.cs() == "synctex") {
2048 // the scheme is \synctex=value
2049 // where value can only be "1" or "-1"
2050 h_output_sync = "1";
2051 // there can be any character behind the value (e.g. a linebreak or a '\'
2052 // therefore we extract it char by char
2054 string value = p.get_token().asInput();
2056 value += p.get_token().asInput();
2057 h_output_sync_macro = "\\synctex=" + value;
2061 if (t.cs() == "begin") {
2062 string const name = p.getArg('{', '}');
2063 if (name == "document")
2065 h_preamble << "\\begin{" << name << "}";
2069 if (t.cs() == "geometry") {
2070 vector<string> opts = split_options(p.getArg('{', '}'));
2071 handle_geometry(opts);
2075 if (t.cs() == "definecolor") {
2076 string const color = p.getArg('{', '}');
2077 string const space = p.getArg('{', '}');
2078 string const value = p.getArg('{', '}');
2079 if (color == "document_fontcolor" && space == "rgb") {
2080 RGBColor c(RGBColorFromLaTeX(value));
2081 h_fontcolor = X11hexname(c);
2082 } else if (color == "note_fontcolor" && space == "rgb") {
2083 RGBColor c(RGBColorFromLaTeX(value));
2084 h_notefontcolor = X11hexname(c);
2085 } else if (color == "page_backgroundcolor" && space == "rgb") {
2086 RGBColor c(RGBColorFromLaTeX(value));
2087 h_backgroundcolor = X11hexname(c);
2088 } else if (color == "shadecolor" && space == "rgb") {
2089 RGBColor c(RGBColorFromLaTeX(value));
2090 h_boxbgcolor = X11hexname(c);
2092 h_preamble << "\\definecolor{" << color
2093 << "}{" << space << "}{" << value
2099 if (t.cs() == "bibliographystyle") {
2100 h_biblio_style = p.verbatim_item();
2104 if (t.cs() == "jurabibsetup") {
2105 // FIXME p.getArg('{', '}') is most probably wrong (it
2106 // does not handle nested braces).
2107 // Use p.verbatim_item() instead.
2108 vector<string> jurabibsetup =
2109 split_options(p.getArg('{', '}'));
2110 // add jurabibsetup to the jurabib package options
2111 add_package("jurabib", jurabibsetup);
2112 if (!jurabibsetup.empty()) {
2113 h_preamble << "\\jurabibsetup{"
2114 << join(jurabibsetup, ",") << '}';
2119 if (t.cs() == "hypersetup") {
2120 vector<string> hypersetup =
2121 split_options(p.verbatim_item());
2122 // add hypersetup to the hyperref package options
2123 handle_hyperref(hypersetup);
2124 if (!hypersetup.empty()) {
2125 h_preamble << "\\hypersetup{"
2126 << join(hypersetup, ",") << '}';
2131 if (t.cs() == "includeonly") {
2132 vector<string> includeonlys = getVectorFromString(p.getArg('{', '}'));
2133 for (auto & iofile : includeonlys) {
2134 string filename(normalize_filename(iofile));
2135 string const path = getMasterFilePath(true);
2136 // We want to preserve relative/absolute filenames,
2137 // therefore path is only used for testing
2138 if (!makeAbsPath(filename, path).exists()) {
2139 // The file extension is probably missing.
2140 // Now try to find it out.
2141 string const tex_name =
2142 find_file(filename, path,
2143 known_tex_extensions);
2144 if (!tex_name.empty())
2145 filename = tex_name;
2148 if (makeAbsPath(filename, path).exists())
2149 fix_child_filename(filename);
2151 cerr << "Warning: Could not find included file '"
2152 << filename << "'." << endl;
2153 outname = changeExtension(filename, "lyx");
2154 h_includeonlys.push_back(outname);
2159 if (is_known(t.cs(), known_if_3arg_commands)) {
2160 // prevent misparsing of \usepackage if it is used
2161 // as an argument (see e.g. our own output of
2162 // \@ifundefined above)
2163 string const arg1 = p.verbatim_item();
2164 string const arg2 = p.verbatim_item();
2165 string const arg3 = p.verbatim_item();
2166 // test case \@ifundefined{date}{}{\date{}}
2167 if (t.cs() == "@ifundefined" && arg1 == "date" &&
2168 arg2.empty() && arg3 == "\\date{}") {
2169 h_suppress_date = "true";
2170 // older tex2lyx versions did output
2171 // \@ifundefined{definecolor}{\usepackage{color}}{}
2172 } else if (t.cs() == "@ifundefined" &&
2173 arg1 == "definecolor" &&
2174 arg2 == "\\usepackage{color}" &&
2176 if (!in_lyx_preamble)
2177 h_preamble << package_beg_sep
2180 << "\\@ifundefined{definecolor}{color}{}"
2183 //\@ifundefined{showcaptionsetup}{}{%
2184 // \PassOptionsToPackage{caption=false}{subfig}}
2185 // that LyX uses for subfloats
2186 } else if (t.cs() == "@ifundefined" &&
2187 arg1 == "showcaptionsetup" && arg2.empty()
2188 && arg3 == "%\n \\PassOptionsToPackage{caption=false}{subfig}") {
2190 } else if (!in_lyx_preamble) {
2191 h_preamble << t.asInput()
2192 << '{' << arg1 << '}'
2193 << '{' << arg2 << '}'
2194 << '{' << arg3 << '}';
2199 if (is_known(t.cs(), known_if_commands)) {
2200 // must not parse anything in conditional code, since
2201 // LyX would output the parsed contents unconditionally
2202 if (!in_lyx_preamble)
2203 h_preamble << t.asInput();
2204 handle_if(p, in_lyx_preamble);
2208 if (!t.cs().empty() && !in_lyx_preamble) {
2209 h_preamble << '\\' << t.cs();
2214 // remove the whitespace
2217 // Force textclass if the user wanted it
2218 if (!forceclass.empty())
2219 h_textclass = forceclass;
2220 tc.setName(h_textclass);
2221 if (!LayoutFileList::get().haveClass(h_textclass) || !tc.load()) {
2222 cerr << "Error: Could not read layout file for textclass \"" << h_textclass << "\"." << endl;
2225 if (h_papersides.empty()) {
2228 h_papersides = ss.str();
2231 // If the CJK package is used we cannot set the document language from
2232 // the babel options. Instead, we guess which language is used most
2233 // and set this one.
2234 default_language = h_language;
2235 if (is_full_document &&
2236 (auto_packages.find("CJK") != auto_packages.end() ||
2237 auto_packages.find("CJKutf8") != auto_packages.end())) {
2239 h_language = guessLanguage(p, default_language);
2241 if (explicit_babel && h_language != default_language) {
2242 // We set the document language to a CJK language,
2243 // but babel is explicitly called in the user preamble
2244 // without options. LyX will not add the default
2245 // language to the document options if it is either
2246 // english, or no text is set as default language.
2247 // Therefore we need to add a language option explicitly.
2248 // FIXME: It would be better to remove all babel calls
2249 // from the user preamble, but this is difficult
2250 // without re-introducing bug 7861.
2251 if (h_options.empty())
2252 h_options = lyx2babel(default_language);
2254 h_options += ',' + lyx2babel(default_language);
2258 // Finally, set the quote style.
2259 // LyX knows the following quotes styles:
2260 // british, cjk, cjkangle, danish, english, french, german,
2261 // polish, russian, swedish and swiss
2262 // conversion list taken from
2263 // https://en.wikipedia.org/wiki/Quotation_mark,_non-English_usage
2264 // (quotes for kazakh are unknown)
2266 if (is_known(h_language, known_british_quotes_languages))
2267 h_quotes_style = "british";
2269 else if (is_known(h_language, known_cjk_quotes_languages))
2270 h_quotes_style = "cjk";
2272 else if (is_known(h_language, known_cjkangle_quotes_languages))
2273 h_quotes_style = "cjkangle";
2275 else if (is_known(h_language, known_danish_quotes_languages))
2276 h_quotes_style = "danish";
2278 else if (is_known(h_language, known_french_quotes_languages))
2279 h_quotes_style = "french";
2281 else if (is_known(h_language, known_german_quotes_languages))
2282 h_quotes_style = "german";
2284 else if (is_known(h_language, known_polish_quotes_languages))
2285 h_quotes_style = "polish";
2287 else if (is_known(h_language, known_russian_quotes_languages))
2288 h_quotes_style = "russian";
2290 else if (is_known(h_language, known_swedish_quotes_languages))
2291 h_quotes_style = "swedish";
2293 else if (is_known(h_language, known_swiss_quotes_languages))
2294 h_quotes_style = "swiss";
2296 else if (is_known(h_language, known_english_quotes_languages))
2297 h_quotes_style = "english";
2301 string Preamble::parseEncoding(Parser & p, string const & forceclass)
2303 TeX2LyXDocClass dummy;
2304 parse(p, forceclass, true, dummy);
2305 if (h_inputencoding != "auto" && h_inputencoding != "default")
2306 return h_inputencoding;
2311 string babel2lyx(string const & language)
2313 char const * const * where = is_known(language, known_languages);
2315 return known_coded_languages[where - known_languages];
2320 string lyx2babel(string const & language)
2322 char const * const * where = is_known(language, known_coded_languages);
2324 return known_languages[where - known_coded_languages];
2329 string Preamble::polyglossia2lyx(string const & language)
2331 char const * const * where = is_known(language, polyglossia_languages);
2333 return coded_polyglossia_languages[where - polyglossia_languages];
2338 string rgbcolor2code(string const & name)
2340 char const * const * where = is_known(name, known_basic_colors);
2342 // "red", "green" etc
2343 return known_basic_color_codes[where - known_basic_colors];
2345 // "255,0,0", "0,255,0" etc
2346 RGBColor c(RGBColorFromLaTeX(name));
2347 return X11hexname(c);