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.
18 #include "LayoutFile.h"
21 #include "TextClass.h"
23 #include "support/convert.h"
24 #include "support/FileName.h"
25 #include "support/filetools.h"
26 #include "support/lstrings.h"
28 #include "support/regex.h"
38 using namespace lyx::support;
43 // special columntypes
44 extern map<char, int> special_columns;
46 map<string, vector<string> > used_packages;
47 const char * const modules_placeholder = "\001modules\001";
49 // needed to handle encodings with babel
50 bool one_language = true;
51 string h_inputencoding = "auto";
52 string h_paragraph_separation = "indent";
54 // necessary to avoid that our preamble stuff is added at each tex2lyx run
55 // which would pollute the preamble when doing roundtrips
56 bool ifundefined_color_set = false;
60 //add this to known_languages when updating to lyxformat 266:
61 // "armenian" (needs special handling since not supported by standard babel)
62 //add these to known_languages when updating to lyxformat 268:
63 //"chinese-simplified", "chinese-traditional", "japanese", "korean"
64 // Both changes require first that support for non-babel languages (CJK,
66 // add turkmen for lyxformat 383
68 * known babel language names (including synonyms)
69 * not in standard babel: arabic, arabtex, armenian, belarusian, serbian-latin, thai
70 * not yet supported by LyX: kurmanji
71 * please keep this in sync with known_coded_languages line by line!
73 const char * const known_languages[] = {"acadian", "afrikaans", "albanian",
74 "american", "arabic", "arabtex", "austrian", "bahasa", "bahasai", "bahasam",
75 "basque", "belarusian", "brazil", "brazilian", "breton", "british", "bulgarian",
76 "canadian", "canadien", "catalan", "croatian", "czech", "danish", "dutch",
77 "english", "esperanto", "estonian", "farsi", "finnish", "francais", "french",
78 "frenchb", "frenchle", "frenchpro", "galician", "german", "germanb", "greek",
79 "hebrew", "hungarian", "icelandic", "indon", "indonesian", "interlingua",
80 "irish", "italian", "kazakh", "latin", "latvian", "lithuanian", "lowersorbian",
81 "lsorbian", "magyar", "malay", "meyalu", "mongolian", "naustrian", "newzealand",
82 "ngerman", "ngermanb", "norsk", "nynorsk", "polutonikogreek", "polish",
83 "portuges", "portuguese", "romanian", "russian", "russianb", "samin",
84 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
85 "swedish", "thai", "turkish", "turkmen", "ukraineb", "ukrainian",
86 "uppersorbian", "UKenglish", "USenglish", "usorbian", "vietnam", "welsh",
90 * the same as known_languages with .lyx names
91 * please keep this in sync with known_languages line by line!
93 const char * const known_coded_languages[] = {"french", "afrikaans", "albanian",
94 "american", "arabic_arabi", "arabic_arabtex", "austrian", "bahasa", "bahasa", "bahasam",
95 "basque", "belarusian", "brazilian", "brazilian", "breton", "british", "bulgarian",
96 "canadian", "canadien", "catalan", "croatian", "czech", "danish", "dutch",
97 "english", "esperanto", "estonian", "farsi", "finnish", "french", "french",
98 "french", "french", "french", "galician", "german", "german", "greek",
99 "hebrew", "magyar", "icelandic", "bahasa", "bahasa", "interlingua",
100 "irish", "italian", "kazakh", "latin", "latvian", "lithuanian", "lowersorbian",
101 "lowersorbian", "magyar", "bahasam", "bahasam", "mongolian", "naustrian", "english",
102 "ngerman", "ngerman", "norsk", "nynorsk", "polutonikogreek", "polish",
103 "portuguese", "portuguese", "romanian", "russian", "russian", "samin",
104 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
105 "swedish", "thai", "turkish", "turkmen", "ukrainian", "ukrainian",
106 "uppersorbian", "uppersorbian", "english", "english", "vietnamese", "welsh",
109 /// languages with english quotes (.lyx names)
110 const char * const known_english_quotes_languages[] = {"american", "bahasa",
111 "bahasam", "brazilian", "canadian", "chinese-simplified", "english",
112 "esperanto", "hebrew", "irish", "korean", "portuguese", "scottish", "thai", 0};
114 /// languages with french quotes (.lyx names)
115 const char * const known_french_quotes_languages[] = {"albanian",
116 "arabic_arabi", "arabic_arabtex", "basque", "canadien", "catalan", "french",
117 "galician", "greek", "italian", "norsk", "nynorsk", "polutonikogreek",
118 "russian", "spanish", "spanish-mexico", "turkish", "turkmen", "ukrainian",
121 /// languages with german quotes (.lyx names)
122 const char * const known_german_quotes_languages[] = {"austrian", "bulgarian",
123 "czech", "german", "icelandic", "lithuanian", "lowersorbian", "naustrian",
124 "ngerman", "serbian", "serbian-latin", "slovak", "slovene", "uppersorbian", 0};
126 /// languages with polish quotes (.lyx names)
127 const char * const known_polish_quotes_languages[] = {"afrikaans", "croatian",
128 "dutch", "estonian", "magyar", "polish", "romanian", 0};
130 /// languages with swedish quotes (.lyx names)
131 const char * const known_swedish_quotes_languages[] = {"finnish",
134 /// known language packages from the times before babel
135 const char * const known_old_language_packages[] = {"french", "frenchle",
136 "frenchpro", "german", "ngerman", "pmfrench", 0};
138 char const * const known_fontsizes[] = { "10pt", "11pt", "12pt", 0 };
140 const char * const known_roman_fonts[] = { "ae", "beraserif", "bookman",
141 "ccfonts", "chancery", "charter", "cmr", "fourier", "lmodern", "mathpazo",
142 "mathptmx", "newcent", "utopia", 0};
144 const char * const known_sans_fonts[] = { "avant", "berasans", "cmbr", "cmss",
145 "helvet", "lmss", 0};
147 const char * const known_typewriter_fonts[] = { "beramono", "cmtl", "cmtt",
148 "courier", "lmtt", "luximono", "fourier", "lmodern", "mathpazo", "mathptmx",
151 const char * const known_paper_sizes[] = { "a0paper", "b0paper", "c0paper",
152 "a1paper", "b1paper", "c1paper", "a2paper", "b2paper", "c2paper", "a3paper",
153 "b3paper", "c3paper", "a4paper", "b4paper", "c4paper", "a5paper", "b5paper",
154 "c5paper", "a6paper", "b6paper", "c6paper", "executivepaper", "legalpaper",
155 "letterpaper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j", "b6j", 0};
157 const char * const known_class_paper_sizes[] = { "a4paper", "a5paper",
158 "executivepaper", "legalpaper", "letterpaper", 0};
160 const char * const known_paper_margins[] = { "lmargin", "tmargin", "rmargin",
161 "bmargin", "headheight", "headsep", "footskip", "columnsep", 0};
163 const char * const known_coded_paper_margins[] = { "leftmargin", "topmargin",
164 "rightmargin", "bottommargin", "headheight", "headsep", "footskip",
167 /// commands that can start an \if...\else...\endif sequence
168 const char * const known_if_commands[] = {"if", "ifarydshln", "ifbraket",
169 "ifcancel", "ifcolortbl", "ifeurosym", "ifmarginnote", "ifmmode", "ifpdf",
170 "ifsidecap", "ifupgreek", 0};
172 const char * const known_basic_colors[] = {"blue", "black", "cyan", "green",
173 "magenta", "red", "white", "yellow", 0};
175 const char * const known_basic_color_codes[] = {"#0000ff", "#000000", "#00ffff", "#00ff00",
176 "#ff00ff", "#ff0000", "#ffffff", "#ffff00", 0};
178 /// conditional commands with three arguments like \@ifundefined{}{}{}
179 const char * const known_if_3arg_commands[] = {"@ifundefined", "IfFileExists",
183 ostringstream h_preamble;
184 string h_textclass = "article";
185 string h_use_default_options = "false";
187 string h_language = "english";
188 string h_language_package = "none";
189 string h_fontencoding = "default";
190 string h_font_roman = "default";
191 string h_font_sans = "default";
192 string h_font_typewriter = "default";
193 string h_font_default_family = "default";
194 string h_font_sc = "false";
195 string h_font_osf = "false";
196 string h_font_sf_scale = "100";
197 string h_font_tt_scale = "100";
198 string h_graphics = "default";
199 string h_float_placement;
200 string h_paperfontsize = "default";
201 string h_spacing = "single";
202 string h_use_hyperref = "0";
205 string h_pdf_subject;
206 string h_pdf_keywords;
207 string h_pdf_bookmarks = "1";
208 string h_pdf_bookmarksnumbered = "0";
209 string h_pdf_bookmarksopen = "0";
210 string h_pdf_bookmarksopenlevel = "1";
211 string h_pdf_breaklinks = "0";
212 string h_pdf_pdfborder = "0";
213 string h_pdf_colorlinks = "0";
214 string h_pdf_backref = "section";
215 string h_pdf_pdfusetitle = "1";
216 string h_pdf_pagemode;
217 string h_pdf_quoted_options;
218 string h_papersize = "default";
219 string h_use_geometry = "false";
220 string h_use_amsmath = "1";
221 string h_use_esint = "1";
222 string h_use_mhchem = "0";
223 string h_use_mathdots = "0";
224 string h_use_undertilde = "0";
225 string h_cite_engine = "basic";
226 string h_use_bibtopic = "false";
227 string h_paperorientation = "portrait";
228 string h_suppress_date = "false";
229 string h_use_refstyle = "0";
230 string h_backgroundcolor;
233 string h_notefontcolor;
234 string h_secnumdepth = "3";
235 string h_tocdepth = "3";
236 string h_defskip = "medskip";
237 string h_paragraph_indentation = "default";
238 string h_quotes_language = "english";
239 string h_papercolumns = "1";
241 string h_paperpagestyle = "default";
242 string h_listings_params;
243 string h_tracking_changes = "false";
244 string h_output_changes = "false";
245 string h_html_math_output = "0";
246 string h_html_css_as_file = "0";
247 string h_html_be_strict = "false";
251 // returns true if at least one of the options in what has been found
252 bool handle_opt(vector<string> & opts, char const * const * what, string & target)
258 // the last language option is the document language (for babel and LyX)
259 // the last size option is the document font size
260 vector<string>::iterator it;
261 vector<string>::iterator position = opts.begin();
262 for (; *what; ++what) {
263 it = find(opts.begin(), opts.end(), *what);
264 if (it != opts.end()) {
265 if (it >= position) {
276 void delete_opt(vector<string> & opts, char const * const * what)
281 // remove found options from the list
282 // do this after handle_opt to avoid potential memory leaks
283 vector<string>::iterator it;
284 for (; *what; ++what) {
285 it = find(opts.begin(), opts.end(), *what);
286 if (it != opts.end())
293 * Split a package options string (keyval format) into a vector.
295 * authorformat=smallcaps,
297 * titleformat=colonsep,
298 * bibformat={tabular,ibidem,numbered}
300 vector<string> split_options(string const & input)
302 vector<string> options;
306 Token const & t = p.get_token();
307 if (t.asInput() == ",") {
308 options.push_back(trimSpaceAndEol(option));
310 } else if (t.asInput() == "=") {
313 if (p.next_token().asInput() == "{")
314 option += '{' + p.getArg('{', '}') + '}';
315 } else if (t.cat() != catSpace)
316 option += t.asInput();
320 options.push_back(trimSpaceAndEol(option));
327 * Retrieve a keyval option "name={value with=sign}" named \p name from
328 * \p options and return the value.
329 * The found option is also removed from \p options.
331 string process_keyval_opt(vector<string> & options, string name)
333 for (size_t i = 0; i < options.size(); ++i) {
334 vector<string> option;
335 split(options[i], option, '=');
336 if (option.size() < 2)
338 if (option[0] == name) {
339 options.erase(options.begin() + i);
340 option.erase(option.begin());
341 return join(option, "=");
349 * Add package \p name with options \p options to used_packages.
350 * Remove options from \p options that we don't want to output.
352 void add_package(string const & name, vector<string> & options)
354 // every package inherits the global options
355 if (used_packages.find(name) == used_packages.end())
356 used_packages[name] = split_options(h_options);
358 vector<string> & v = used_packages[name];
359 v.insert(v.end(), options.begin(), options.end());
360 if (name == "jurabib") {
361 // Don't output the order argument (see the cite command
362 // handling code in text.cpp).
363 vector<string>::iterator end =
364 remove(options.begin(), options.end(), "natbiborder");
365 end = remove(options.begin(), end, "jurabiborder");
366 options.erase(end, options.end());
371 // Given is a string like "scaled=0.9", return 0.9 * 100
372 string const scale_as_percentage(string const & scale)
374 string::size_type pos = scale.find('=');
375 if (pos != string::npos) {
376 string value = scale.substr(pos + 1);
378 return convert<string>(100 * convert<double>(value));
380 // If the input string didn't match our expectations.
381 // return the default value "100"
386 string remove_braces(string const & value)
390 if (value[0] == '{' && value[value.length()-1] == '}')
391 return value.substr(1, value.length()-2);
396 void handle_hyperref(vector<string> & options)
398 // FIXME swallow inputencoding changes that might surround the
399 // hyperref setup if it was written by LyX
400 h_use_hyperref = "1";
401 // swallow "unicode=true", since LyX does always write that
402 vector<string>::iterator it =
403 find(options.begin(), options.end(), "unicode=true");
404 if (it != options.end())
406 it = find(options.begin(), options.end(), "pdfusetitle");
407 if (it != options.end()) {
408 h_pdf_pdfusetitle = "1";
411 string bookmarks = process_keyval_opt(options, "bookmarks");
412 if (bookmarks == "true")
413 h_pdf_bookmarks = "1";
414 else if (bookmarks == "false")
415 h_pdf_bookmarks = "0";
416 if (h_pdf_bookmarks == "1") {
417 string bookmarksnumbered =
418 process_keyval_opt(options, "bookmarksnumbered");
419 if (bookmarksnumbered == "true")
420 h_pdf_bookmarksnumbered = "1";
421 else if (bookmarksnumbered == "false")
422 h_pdf_bookmarksnumbered = "0";
423 string bookmarksopen =
424 process_keyval_opt(options, "bookmarksopen");
425 if (bookmarksopen == "true")
426 h_pdf_bookmarksopen = "1";
427 else if (bookmarksopen == "false")
428 h_pdf_bookmarksopen = "0";
429 if (h_pdf_bookmarksopen == "1") {
430 string bookmarksopenlevel =
431 process_keyval_opt(options, "bookmarksopenlevel");
432 if (!bookmarksopenlevel.empty())
433 h_pdf_bookmarksopenlevel = bookmarksopenlevel;
436 string breaklinks = process_keyval_opt(options, "breaklinks");
437 if (breaklinks == "true")
438 h_pdf_breaklinks = "1";
439 else if (breaklinks == "false")
440 h_pdf_breaklinks = "0";
441 string pdfborder = process_keyval_opt(options, "pdfborder");
442 if (pdfborder == "{0 0 0}")
443 h_pdf_pdfborder = "1";
444 else if (pdfborder == "{0 0 1}")
445 h_pdf_pdfborder = "0";
446 string backref = process_keyval_opt(options, "backref");
447 if (!backref.empty())
448 h_pdf_backref = backref;
449 string colorlinks = process_keyval_opt(options, "colorlinks");
450 if (colorlinks == "true")
451 h_pdf_colorlinks = "1";
452 else if (colorlinks == "false")
453 h_pdf_colorlinks = "0";
454 string pdfpagemode = process_keyval_opt(options, "pdfpagemode");
455 if (!pdfpagemode.empty())
456 h_pdf_pagemode = pdfpagemode;
457 string pdftitle = process_keyval_opt(options, "pdftitle");
458 if (!pdftitle.empty()) {
459 h_pdf_title = remove_braces(pdftitle);
461 string pdfauthor = process_keyval_opt(options, "pdfauthor");
462 if (!pdfauthor.empty()) {
463 h_pdf_author = remove_braces(pdfauthor);
465 string pdfsubject = process_keyval_opt(options, "pdfsubject");
466 if (!pdfsubject.empty())
467 h_pdf_subject = remove_braces(pdfsubject);
468 string pdfkeywords = process_keyval_opt(options, "pdfkeywords");
469 if (!pdfkeywords.empty())
470 h_pdf_keywords = remove_braces(pdfkeywords);
471 if (!options.empty()) {
472 if (!h_pdf_quoted_options.empty())
473 h_pdf_quoted_options += ',';
474 h_pdf_quoted_options += join(options, ",");
480 void handle_package(Parser &p, string const & name, string const & opts,
481 bool in_lyx_preamble)
483 vector<string> options = split_options(opts);
484 add_package(name, options);
488 if (is_known(name, known_roman_fonts)) {
493 if (name == "fourier") {
494 h_font_roman = "utopia";
495 // when font uses real small capitals
496 if (opts == "expert")
500 if (name == "mathpazo")
501 h_font_roman = "palatino";
503 if (name == "mathptmx")
504 h_font_roman = "times";
507 if (is_known(name, known_sans_fonts)) {
511 h_font_sf_scale = scale_as_percentage(scale);
516 if (is_known(name, known_typewriter_fonts)) {
517 // fourier can be set as roman font _only_
518 // fourier as typewriter is handled in handling of \ttdefault
519 if (name != "fourier") {
520 h_font_typewriter = name;
523 h_font_tt_scale = scale_as_percentage(scale);
528 // font uses old-style figure
532 // after the detection and handling of special cases, we can remove the
533 // fonts, otherwise they would appear in the preamble, see bug #7856
534 if (is_known(name, known_roman_fonts) || is_known(name, known_sans_fonts)
535 || is_known(name, known_typewriter_fonts))
538 else if (name == "amsmath" || name == "amssymb")
541 else if (name == "esint")
544 else if (name == "mhchem")
547 else if (name == "mathdots")
548 h_use_mathdots = "2";
550 else if (name == "undertilde")
551 h_use_undertilde = "2";
553 else if (name == "babel") {
554 h_language_package = "default";
555 // we have to do nothing if babel is loaded without any options, otherwise
556 // we would pollute the preamble with this call in every roundtrip
558 // check if more than one option was used - used later for inputenc
559 // in case inputenc is parsed before babel, set the encoding to auto
560 if (options.begin() != options.end() - 1) {
561 one_language = false;
562 h_inputencoding = "auto";
564 // babel takes the last language of the option of its \usepackage
565 // call as document language. If there is no such language option, the
566 // last language in the documentclass options is used.
567 handle_opt(options, known_languages, h_language);
568 delete_opt(options, known_languages);
572 else if (name == "fontenc") {
573 h_fontencoding = getStringFromVector(options, ",");
574 // as of version LyX 2.0 "T1" is equal to the setting "global"
575 if (h_fontencoding == "T1")
576 h_fontencoding = "global";
580 else if (name == "inputenc" || name == "luainputenc") {
581 // h_inputencoding is only set when there is not more than one
582 // inputenc option because otherwise h_inputencoding must be
583 // set to "auto" (the default encoding of the document language)
584 // Therefore check for the "," character.
585 // It is also only set when there is not more then one babel
586 // language option but this is handled in the routine for babel.
587 if (opts.find(",") == string::npos && one_language == true)
588 h_inputencoding = opts;
589 if (!options.empty())
590 p.setEncoding(options.back());
594 else if (is_known(name, known_old_language_packages)) {
595 // known language packages from the times before babel
596 // if they are found and not also babel, they will be used as
597 // cutom language package
598 h_language_package = "\\usepackage{" + name + "}";
601 else if (name == "makeidx")
604 else if (name == "prettyref")
607 else if (name == "varioref")
610 else if (name == "verbatim")
613 else if (name == "nomencl")
616 else if (name == "textcomp")
619 else if (name == "url")
622 else if (name == "subscript")
625 else if (name == "color") {
626 // with the following command this package is only loaded when needed for
627 // undefined colors, since we only support the predefined colors
628 // only add it if not yet added
629 if (!ifundefined_color_set)
630 h_preamble << "\\@ifundefined{definecolor}\n {\\usepackage{color}}{}\n";
633 else if (name == "graphicx")
636 else if (name == "setspace")
640 // do not ignore as long as we don't support all commands (e.g. \xout is missing)
641 else if (name == "ulem")
645 else if (name == "geometry")
646 ; // Ignore this, the geometry settings are made by the \geometry
647 // command. This command is handled below.
649 else if (is_known(name, known_languages))
652 else if (name == "natbib") {
653 h_cite_engine = "natbib_authoryear";
654 vector<string>::iterator it =
655 find(options.begin(), options.end(), "authoryear");
656 if (it != options.end())
659 it = find(options.begin(), options.end(), "numbers");
660 if (it != options.end()) {
661 h_cite_engine = "natbib_numerical";
667 else if (name == "jurabib")
668 h_cite_engine = "jurabib";
670 else if (name == "hyperref")
671 handle_hyperref(options);
673 else if (!in_lyx_preamble) {
675 h_preamble << "\\usepackage{" << name << "}";
677 h_preamble << "\\usepackage[" << opts << "]{"
683 // We need to do something with the options...
684 if (!options.empty())
685 cerr << "Ignoring options '" << join(options, ",")
686 << "' of package " << name << '.' << endl;
688 // remove the whitespace
693 void handle_if(Parser & p, bool in_lyx_preamble)
696 Token t = p.get_token();
697 if (t.cat() == catEscape &&
698 is_known(t.cs(), known_if_commands))
699 handle_if(p, in_lyx_preamble);
701 if (!in_lyx_preamble)
702 h_preamble << t.asInput();
703 if (t.cat() == catEscape && t.cs() == "fi")
710 void end_preamble(ostream & os, TextClass const & /*textclass*/)
712 // translate from babel to LyX names
713 h_language = babel2lyx(h_language);
715 // set the quote language
716 // LyX only knows the following quotes languages:
717 // english, swedish, german, polish, french and danish
718 // (quotes for "japanese" and "chinese-traditional" are missing because
719 // they wouldn't be useful: http://www.lyx.org/trac/ticket/6383)
720 // conversion list taken from
721 // http://en.wikipedia.org/wiki/Quotation_mark,_non-English_usage
722 // (quotes for kazakh and interlingua are unknown)
724 if (h_language == "danish")
725 h_quotes_language = "danish";
727 else if (is_known(h_language, known_french_quotes_languages))
728 h_quotes_language = "french";
730 else if (is_known(h_language, known_german_quotes_languages))
731 h_quotes_language = "german";
733 else if (is_known(h_language, known_polish_quotes_languages))
734 h_quotes_language = "polish";
736 else if (is_known(h_language, known_swedish_quotes_languages))
737 h_quotes_language = "swedish";
739 else if (is_known(h_language, known_english_quotes_languages))
740 h_quotes_language = "english";
742 // output the LyX file settings
743 os << "#LyX file created by tex2lyx " << PACKAGE_VERSION << "\n"
744 << "\\lyxformat " << LYX_FORMAT << '\n'
745 << "\\begin_document\n"
746 << "\\begin_header\n"
747 << "\\textclass " << h_textclass << "\n";
748 if (!h_preamble.str().empty())
749 os << "\\begin_preamble\n" << h_preamble.str() << "\n\\end_preamble\n";
750 if (!h_options.empty())
751 os << "\\options " << h_options << "\n";
752 os << "\\use_default_options " << h_use_default_options << "\n"
753 << modules_placeholder
754 << "\\language " << h_language << "\n"
755 << "\\language_package " << h_language_package << "\n"
756 << "\\inputencoding " << h_inputencoding << "\n"
757 << "\\fontencoding " << h_fontencoding << "\n"
758 << "\\font_roman " << h_font_roman << "\n"
759 << "\\font_sans " << h_font_sans << "\n"
760 << "\\font_typewriter " << h_font_typewriter << "\n"
761 << "\\font_default_family " << h_font_default_family << "\n"
762 << "\\font_sc " << h_font_sc << "\n"
763 << "\\font_osf " << h_font_osf << "\n"
764 << "\\font_sf_scale " << h_font_sf_scale << "\n"
765 << "\\font_tt_scale " << h_font_tt_scale << "\n"
766 << "\\graphics " << h_graphics << "\n";
767 if (!h_float_placement.empty())
768 os << "\\float_placement " << h_float_placement << "\n";
769 os << "\\paperfontsize " << h_paperfontsize << "\n"
770 << "\\spacing " << h_spacing << "\n"
771 << "\\use_hyperref " << h_use_hyperref << '\n';
772 if (h_use_hyperref == "1") {
773 if (!h_pdf_title.empty())
774 os << "\\pdf_title \"" << h_pdf_title << "\"\n";
775 if (!h_pdf_author.empty())
776 os << "\\pdf_author \"" << h_pdf_author << "\"\n";
777 if (!h_pdf_subject.empty())
778 os << "\\pdf_subject \"" << h_pdf_subject << "\"\n";
779 if (!h_pdf_keywords.empty())
780 os << "\\pdf_keywords \"" << h_pdf_keywords << "\"\n";
781 os << "\\pdf_bookmarks " << h_pdf_bookmarks << "\n"
782 "\\pdf_bookmarksnumbered " << h_pdf_bookmarksnumbered << "\n"
783 "\\pdf_bookmarksopen " << h_pdf_bookmarksopen << "\n"
784 "\\pdf_bookmarksopenlevel " << h_pdf_bookmarksopenlevel << "\n"
785 "\\pdf_breaklinks " << h_pdf_breaklinks << "\n"
786 "\\pdf_pdfborder " << h_pdf_pdfborder << "\n"
787 "\\pdf_colorlinks " << h_pdf_colorlinks << "\n"
788 "\\pdf_backref " << h_pdf_backref << "\n"
789 "\\pdf_pdfusetitle " << h_pdf_pdfusetitle << '\n';
790 if (!h_pdf_pagemode.empty())
791 os << "\\pdf_pagemode " << h_pdf_pagemode << '\n';
792 if (!h_pdf_quoted_options.empty())
793 os << "\\pdf_quoted_options \"" << h_pdf_quoted_options << "\"\n";
795 os << "\\papersize " << h_papersize << "\n"
796 << "\\use_geometry " << h_use_geometry << "\n"
797 << "\\use_amsmath " << h_use_amsmath << "\n"
798 << "\\use_esint " << h_use_esint << "\n"
799 << "\\use_mhchem " << h_use_mhchem << "\n"
800 << "\\use_mathdots " << h_use_mathdots << "\n"
801 << "\\use_undertilde " << h_use_undertilde << "\n"
802 << "\\cite_engine " << h_cite_engine << "\n"
803 << "\\use_bibtopic " << h_use_bibtopic << "\n"
804 << "\\paperorientation " << h_paperorientation << '\n'
805 << "\\suppress_date " << h_suppress_date << '\n'
806 << "\\use_refstyle " << h_use_refstyle << '\n';
807 if (!h_fontcolor.empty())
808 os << "\\fontcolor " << h_fontcolor << '\n';
809 if (!h_notefontcolor.empty())
810 os << "\\notefontcolor " << h_notefontcolor << '\n';
811 if (!h_backgroundcolor.empty())
812 os << "\\backgroundcolor " << h_backgroundcolor << '\n';
813 if (!h_boxbgcolor.empty())
814 os << "\\boxbgcolor " << h_boxbgcolor << '\n';
816 << "\\secnumdepth " << h_secnumdepth << "\n"
817 << "\\tocdepth " << h_tocdepth << "\n"
818 << "\\paragraph_separation " << h_paragraph_separation << "\n";
819 if (h_paragraph_separation == "skip")
820 os << "\\defskip " << h_defskip << "\n";
822 os << "\\paragraph_indentation " << h_paragraph_indentation << "\n";
823 os << "\\quotes_language " << h_quotes_language << "\n"
824 << "\\papercolumns " << h_papercolumns << "\n"
825 << "\\papersides " << h_papersides << "\n"
826 << "\\paperpagestyle " << h_paperpagestyle << "\n";
827 if (!h_listings_params.empty())
828 os << "\\listings_params " << h_listings_params << "\n";
829 os << "\\tracking_changes " << h_tracking_changes << "\n"
830 << "\\output_changes " << h_output_changes << "\n"
831 << "\\html_math_output " << h_html_math_output << "\n"
832 << "\\html_css_as_file " << h_html_css_as_file << "\n"
833 << "\\html_be_strict " << h_html_be_strict << "\n"
834 << "\\end_header\n\n"
836 // clear preamble for subdocuments
840 } // anonymous namespace
843 void parse_preamble(Parser & p, ostream & os,
844 string const & forceclass, TeX2LyXDocClass & tc)
846 // initialize fixed types
847 special_columns['D'] = 3;
848 bool is_full_document = false;
849 bool is_lyx_file = false;
850 bool in_lyx_preamble = false;
852 // determine whether this is a full document or a fragment for inclusion
854 Token const & t = p.get_token();
856 if (t.cat() == catEscape && t.cs() == "documentclass") {
857 is_full_document = true;
863 while (is_full_document && p.good()) {
864 Token const & t = p.get_token();
867 cerr << "t: " << t << "\n";
873 if (!in_lyx_preamble &&
874 (t.cat() == catLetter ||
875 t.cat() == catSuper ||
877 t.cat() == catOther ||
878 t.cat() == catMath ||
879 t.cat() == catActive ||
880 t.cat() == catBegin ||
882 t.cat() == catAlign ||
883 t.cat() == catParameter))
884 h_preamble << t.cs();
886 else if (!in_lyx_preamble &&
887 (t.cat() == catSpace || t.cat() == catNewline))
888 h_preamble << t.asInput();
890 else if (t.cat() == catComment) {
891 static regex const islyxfile("%% LyX .* created this file");
892 static regex const usercommands("User specified LaTeX commands");
894 string const comment = t.asInput();
896 // magically switch encoding default if it looks like XeLaTeX
897 static string const magicXeLaTeX =
898 "% This document must be compiled with XeLaTeX ";
899 if (comment.size() > magicXeLaTeX.size()
900 && comment.substr(0, magicXeLaTeX.size()) == magicXeLaTeX
901 && h_inputencoding == "auto") {
902 cerr << "XeLaTeX comment found, switching to UTF8\n";
903 h_inputencoding = "utf8";
906 if (regex_search(comment, sub, islyxfile)) {
908 in_lyx_preamble = true;
909 } else if (is_lyx_file
910 && regex_search(comment, sub, usercommands))
911 in_lyx_preamble = false;
912 else if (!in_lyx_preamble)
913 h_preamble << t.asInput();
916 else if (t.cs() == "pagestyle")
917 h_paperpagestyle = p.verbatim_item();
919 else if (t.cs() == "date") {
920 string argument = p.getArg('{', '}');
921 if (argument.empty())
922 h_suppress_date = "true";
924 h_preamble << t.asInput() << '{' << argument << '}';
927 else if (t.cs() == "color") {
928 string argument = p.getArg('{', '}');
929 // check the case that a standard color is used
930 if (is_known(argument, known_basic_colors))
931 h_fontcolor = color2code(argument);
932 // check the case that LyX's document_fontcolor is defined
933 // but not used for \color
934 if (argument != "document_fontcolor"
935 && !is_known(argument, known_basic_colors)) {
936 h_preamble << t.asInput() << '{' << argument << '}';
937 // the color might already be set because \definecolor
938 // is parsed before this
943 else if (t.cs() == "pagecolor") {
944 string argument = p.getArg('{', '}');
945 // check the case that a standard color is used
946 if (is_known(argument, known_basic_colors))
947 h_backgroundcolor = color2code(argument);
948 // check the case that LyX's page_backgroundcolor is defined
949 // but not used for \pagecolor
950 if (argument != "page_backgroundcolor"
951 && !is_known(argument, known_basic_colors)) {
952 h_preamble << t.asInput() << '{' << argument << '}';
953 // the color might already be set because \definecolor
954 // is parsed before this
955 h_backgroundcolor = "";
959 else if (t.cs() == "makeatletter") {
960 // LyX takes care of this
961 p.setCatCode('@', catLetter);
964 else if (t.cs() == "makeatother") {
965 // LyX takes care of this
966 p.setCatCode('@', catOther);
969 else if (t.cs() == "newcommand" || t.cs() == "newcommandx"
970 || t.cs() == "renewcommand" || t.cs() == "renewcommandx"
971 || t.cs() == "providecommand" || t.cs() == "providecommandx"
972 || t.cs() == "DeclareRobustCommand"
973 || t.cs() == "DeclareRobustCommandx"
974 || t.cs() == "ProvideTextCommandDefault"
975 || t.cs() == "DeclareMathAccent") {
977 if (p.next_token().character() == '*') {
981 string const name = p.verbatim_item();
982 string const opt1 = p.getFullOpt();
983 string const opt2 = p.getFullOpt();
984 string const body = p.verbatim_item();
986 if (name == "\\rmdefault")
987 if (is_known(body, known_roman_fonts))
989 if (name == "\\sfdefault")
990 if (is_known(body, known_sans_fonts))
992 if (name == "\\ttdefault")
993 if (is_known(body, known_typewriter_fonts))
994 h_font_typewriter = body;
995 if (name == "\\familydefault") {
996 string family = body;
997 // remove leading "\"
998 h_font_default_family = family.erase(0,1);
1001 // Add the command to the known commands
1002 add_known_command(name, opt1, !opt2.empty(), from_utf8(body));
1004 // only non-lyxspecific stuff
1005 if (!in_lyx_preamble) {
1007 ss << '\\' << t.cs();
1010 ss << '{' << name << '}' << opt1 << opt2
1011 << '{' << body << "}";
1012 h_preamble << ss.str();
1014 ostream & out = in_preamble ? h_preamble : os;
1015 out << "\\" << t.cs() << "{" << name << "}"
1016 << opts << "{" << body << "}";
1021 else if (t.cs() == "documentclass") {
1022 vector<string>::iterator it;
1023 vector<string> opts = split_options(p.getArg('[', ']'));
1024 handle_opt(opts, known_fontsizes, h_paperfontsize);
1025 delete_opt(opts, known_fontsizes);
1026 // delete "pt" at the end
1027 string::size_type i = h_paperfontsize.find("pt");
1028 if (i != string::npos)
1029 h_paperfontsize.erase(i);
1030 // The documentclass options are always parsed before the options
1031 // of the babel call so that a language cannot overwrite the babel
1033 handle_opt(opts, known_languages, h_language);
1034 delete_opt(opts, known_languages);
1036 // paper orientation
1037 if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
1038 h_paperorientation = "landscape";
1042 if ((it = find(opts.begin(), opts.end(), "oneside"))
1047 if ((it = find(opts.begin(), opts.end(), "twoside"))
1053 if ((it = find(opts.begin(), opts.end(), "onecolumn"))
1055 h_papercolumns = "1";
1058 if ((it = find(opts.begin(), opts.end(), "twocolumn"))
1060 h_papercolumns = "2";
1064 // some size options are know to any document classes, other sizes
1065 // are handled by the \geometry command of the geometry package
1066 handle_opt(opts, known_class_paper_sizes, h_papersize);
1067 delete_opt(opts, known_class_paper_sizes);
1068 // the remaining options
1069 h_options = join(opts, ",");
1070 // FIXME This does not work for classes that have a
1071 // different name in LyX than in LaTeX
1072 h_textclass = p.getArg('{', '}');
1075 else if (t.cs() == "usepackage") {
1076 string const options = p.getArg('[', ']');
1077 string const name = p.getArg('{', '}');
1078 vector<string> vecnames;
1079 split(name, vecnames, ',');
1080 vector<string>::const_iterator it = vecnames.begin();
1081 vector<string>::const_iterator end = vecnames.end();
1082 for (; it != end; ++it)
1083 handle_package(p, trimSpaceAndEol(*it), options,
1087 else if (t.cs() == "inputencoding") {
1088 string const encoding = p.getArg('{','}');
1089 h_inputencoding = encoding;
1090 p.setEncoding(encoding);
1093 else if (t.cs() == "newenvironment") {
1094 string const name = p.getArg('{', '}');
1095 string const opt1 = p.getFullOpt();
1096 string const opt2 = p.getFullOpt();
1097 string const beg = p.verbatim_item();
1098 string const end = p.verbatim_item();
1099 if (!in_lyx_preamble) {
1100 h_preamble << "\\newenvironment{" << name
1101 << '}' << opt1 << opt2 << '{'
1102 << beg << "}{" << end << '}';
1104 add_known_environment(name, opt1, !opt2.empty(),
1105 from_utf8(beg), from_utf8(end));
1109 else if (t.cs() == "def") {
1110 string name = p.get_token().cs();
1111 while (p.next_token().cat() != catBegin)
1112 name += p.get_token().cs();
1113 if (!in_lyx_preamble)
1114 h_preamble << "\\def\\" << name << '{'
1115 << p.verbatim_item() << "}";
1118 else if (t.cs() == "newcolumntype") {
1119 string const name = p.getArg('{', '}');
1120 trimSpaceAndEol(name);
1122 string opts = p.getOpt();
1123 if (!opts.empty()) {
1124 istringstream is(string(opts, 1));
1127 special_columns[name[0]] = nargs;
1128 h_preamble << "\\newcolumntype{" << name << "}";
1130 h_preamble << "[" << nargs << "]";
1131 h_preamble << "{" << p.verbatim_item() << "}";
1134 else if (t.cs() == "setcounter") {
1135 string const name = p.getArg('{', '}');
1136 string const content = p.getArg('{', '}');
1137 if (name == "secnumdepth")
1138 h_secnumdepth = content;
1139 else if (name == "tocdepth")
1140 h_tocdepth = content;
1142 h_preamble << "\\setcounter{" << name << "}{" << content << "}";
1145 else if (t.cs() == "setlength") {
1146 string const name = p.verbatim_item();
1147 string const content = p.verbatim_item();
1148 // the paragraphs are only not indented when \parindent is set to zero
1149 if (name == "\\parindent" && content != "") {
1150 if (content[0] == '0')
1151 h_paragraph_separation = "skip";
1153 h_paragraph_indentation = translate_len(content);
1154 } else if (name == "\\parskip") {
1155 if (content == "\\smallskipamount")
1156 h_defskip = "smallskip";
1157 else if (content == "\\medskipamount")
1158 h_defskip = "medskip";
1159 else if (content == "\\bigskipamount")
1160 h_defskip = "bigskip";
1162 h_defskip = content;
1164 h_preamble << "\\setlength{" << name << "}{" << content << "}";
1167 else if (t.cs() == "onehalfspacing")
1168 h_spacing = "onehalf";
1170 else if (t.cs() == "doublespacing")
1171 h_spacing = "double";
1173 else if (t.cs() == "setstretch")
1174 h_spacing = "other " + p.verbatim_item();
1176 else if (t.cs() == "begin") {
1177 string const name = p.getArg('{', '}');
1178 if (name == "document")
1180 h_preamble << "\\begin{" << name << "}";
1183 else if (t.cs() == "geometry") {
1184 h_use_geometry = "true";
1185 vector<string> opts = split_options(p.getArg('{', '}'));
1186 vector<string>::iterator it;
1187 // paper orientation
1188 if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
1189 h_paperorientation = "landscape";
1193 handle_opt(opts, known_paper_sizes, h_papersize);
1194 delete_opt(opts, known_paper_sizes);
1196 char const * const * margin = known_paper_margins;
1198 for (; *margin; ++margin) {
1200 // search for the "=" in e.g. "lmargin=2cm" to get the value
1201 for(size_t i = 0; i != opts.size(); i++) {
1202 if (opts.at(i).find(*margin) != string::npos) {
1203 string::size_type pos = opts.at(i).find("=");
1204 string value = opts.at(i).substr(pos + 1);
1205 string name = known_coded_paper_margins[k];
1206 h_margins += "\\" + name + " " + value + "\n";
1212 else if (t.cs() == "definecolor") {
1213 string const color = p.getArg('{', '}');
1214 string const space = p.getArg('{', '}');
1215 string const value = p.getArg('{', '}');
1216 if (color == "document_fontcolor" && space == "rgb") {
1217 RGBColor c(RGBColorFromLaTeX(value));
1218 h_fontcolor = X11hexname(c);
1219 } else if (color == "note_fontcolor" && space == "rgb") {
1220 RGBColor c(RGBColorFromLaTeX(value));
1221 h_notefontcolor = X11hexname(c);
1222 } else if (color == "page_backgroundcolor" && space == "rgb") {
1223 RGBColor c(RGBColorFromLaTeX(value));
1224 h_backgroundcolor = X11hexname(c);
1225 } else if (color == "shadecolor" && space == "rgb") {
1226 RGBColor c(RGBColorFromLaTeX(value));
1227 h_boxbgcolor = X11hexname(c);
1229 h_preamble << "\\definecolor{" << color
1230 << "}{" << space << "}{" << value
1235 else if (t.cs() == "jurabibsetup") {
1236 // FIXME p.getArg('{', '}') is most probably wrong (it
1237 // does not handle nested braces).
1238 // Use p.verbatim_item() instead.
1239 vector<string> jurabibsetup =
1240 split_options(p.getArg('{', '}'));
1241 // add jurabibsetup to the jurabib package options
1242 add_package("jurabib", jurabibsetup);
1243 if (!jurabibsetup.empty()) {
1244 h_preamble << "\\jurabibsetup{"
1245 << join(jurabibsetup, ",") << '}';
1249 else if (t.cs() == "hypersetup") {
1250 vector<string> hypersetup =
1251 split_options(p.verbatim_item());
1252 // add hypersetup to the hyperref package options
1253 handle_hyperref(hypersetup);
1254 if (!hypersetup.empty()) {
1255 h_preamble << "\\hypersetup{"
1256 << join(hypersetup, ",") << '}';
1260 else if (is_known(t.cs(), known_if_3arg_commands)) {
1261 // prevent misparsing of \usepackage if it is used
1262 // as an argument (see e.g. our own output of
1263 // \@ifundefined above)
1264 string const arg1 = p.verbatim_item();
1265 string const arg2 = p.verbatim_item();
1266 string const arg3 = p.verbatim_item();
1267 // test case \@ifundefined{date}{}{\date{}}
1268 if (arg1 == "date" && arg2.empty() && arg3 == "\\date{}") {
1269 h_suppress_date = "true";
1270 // test case \@ifundefined{definecolor}{\usepackage{color}}{}
1271 // because we could pollute the preamble with it in roundtrips
1272 } else if (arg1 == "definecolor" && arg2 == "\\usepackage{color}"
1274 ifundefined_color_set = true;
1275 } else if (!in_lyx_preamble) {
1276 h_preamble << t.asInput()
1277 << '{' << arg1 << '}'
1278 << '{' << arg2 << '}'
1279 << '{' << arg3 << '}';
1283 else if (is_known(t.cs(), known_if_commands)) {
1284 // must not parse anything in conditional code, since
1285 // LyX would output the parsed contents unconditionally
1286 if (!in_lyx_preamble)
1287 h_preamble << t.asInput();
1288 handle_if(p, in_lyx_preamble);
1291 else if (!t.cs().empty() && !in_lyx_preamble)
1292 h_preamble << '\\' << t.cs();
1295 // remove the whitespace
1298 // Force textclass if the user wanted it
1299 if (!forceclass.empty())
1300 h_textclass = forceclass;
1301 if (noweb_mode && !prefixIs(h_textclass, "literate-"))
1302 h_textclass.insert(0, "literate-");
1303 tc.setName(h_textclass);
1305 cerr << "Error: Could not read layout file for textclass \"" << h_textclass << "\"." << endl;
1308 if (h_papersides.empty()) {
1311 h_papersides = ss.str();
1313 end_preamble(os, tc);
1317 /// translates a babel language name to a LyX language name
1318 string babel2lyx(string const & language)
1320 char const * const * where = is_known(language, known_languages);
1322 return known_coded_languages[where - known_languages];
1327 /// translates a color name to a LyX color code
1328 string color2code(string const & name)
1330 char const * const * where = is_known(name, known_basic_colors);
1332 return known_basic_color_codes[where - known_basic_colors];