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.
19 #include "LayoutFile.h"
22 #include "TextClass.h"
24 #include "support/convert.h"
25 #include "support/FileName.h"
26 #include "support/filetools.h"
27 #include "support/lstrings.h"
29 #include "support/regex.h"
35 using namespace lyx::support;
40 // special columntypes
41 extern map<char, int> special_columns;
47 //add this to known_languages when updating to lyxformat 266:
48 // "armenian" (needs special handling since not supported by standard babel)
49 //add these to known_languages when updating to lyxformat 268:
50 //"chinese-simplified", "chinese-traditional", "japanese", "korean"
51 // Both changes require first that support for non-babel languages (CJK,
54 * known babel language names (including synonyms)
55 * not in standard babel: arabic, arabtex, armenian, belarusian, serbian-latin, thai
56 * not yet supported by LyX: kurmanji
57 * please keep this in sync with known_coded_languages line by line!
59 const char * const known_languages[] = {"acadian", "afrikaans", "albanian",
60 "american", "arabic", "arabtex", "austrian", "bahasa", "bahasai", "bahasam",
61 "basque", "belarusian", "brazil", "brazilian", "breton", "british", "bulgarian",
62 "canadian", "canadien", "catalan", "croatian", "czech", "danish", "dutch",
63 "english", "esperanto", "estonian", "farsi", "finnish", "francais", "french",
64 "frenchb", "frenchle", "frenchpro", "galician", "german", "germanb", "greek",
65 "hebrew", "hungarian", "icelandic", "indon", "indonesian", "interlingua",
66 "irish", "italian", "kazakh", "latin", "latvian", "lithuanian", "lowersorbian",
67 "lsorbian", "magyar", "malay", "meyalu", "mongolian", "naustrian", "newzealand",
68 "ngerman", "ngermanb", "norsk", "nynorsk", "polutonikogreek", "polish",
69 "portuges", "portuguese", "romanian", "russian", "russianb", "samin",
70 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
71 "swedish", "thai", "turkish", "turkmen", "ukraineb", "ukrainian",
72 "uppersorbian", "UKenglish", "USenglish", "usorbian", "vietnam", "welsh",
76 * the same as known_languages with .lyx names
77 * please keep this in sync with known_languages line by line!
79 const char * const known_coded_languages[] = {"french", "afrikaans", "albanian",
80 "american", "arabic_arabi", "arabic_arabtex", "austrian", "bahasa", "bahasa", "bahasam",
81 "basque", "belarusian", "brazilian", "brazilian", "breton", "british", "bulgarian",
82 "canadian", "canadien", "catalan", "croatian", "czech", "danish", "dutch",
83 "english", "esperanto", "estonian", "farsi", "finnish", "french", "french",
84 "french", "french", "french", "galician", "german", "german", "greek",
85 "hebrew", "magyar", "icelandic", "bahasa", "bahasa", "interlingua",
86 "irish", "italian", "kazakh", "latin", "latvian", "lithuanian", "lowersorbian",
87 "lowersorbian", "magyar", "bahasam", "bahasam", "mongolian", "naustrian", "english",
88 "ngerman", "ngerman", "norsk", "nynorsk", "polutonikogreek", "polish",
89 "portuguese", "portuguese", "romanian", "russian", "russian", "samin",
90 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
91 "swedish", "thai", "turkish", "turkmen", "ukrainian", "ukrainian",
92 "uppersorbian", "uppersorbian", "english", "english", "vietnamese", "welsh",
95 /// languages with english quotes (.lyx names)
96 const char * const known_english_quotes_languages[] = {"american", "bahasa",
97 "bahasam", "brazilian", "canadian", "chinese-simplified", "english",
98 "esperanto", "hebrew", "irish", "korean", "portuguese", "scottish", "thai", 0};
100 /// languages with french quotes (.lyx names)
101 const char * const known_french_quotes_languages[] = {"albanian",
102 "arabic_arabi", "arabic_arabtex", "basque", "canadien", "catalan", "french",
103 "galician", "greek", "italian", "norsk", "nynorsk", "polutonikogreek",
104 "russian", "spanish", "spanish-mexico", "turkish", "turkmen", "ukrainian",
107 /// languages with german quotes (.lyx names)
108 const char * const known_german_quotes_languages[] = {"austrian", "bulgarian",
109 "czech", "german", "icelandic", "lithuanian", "lowersorbian", "naustrian",
110 "ngerman", "serbian", "serbian-latin", "slovak", "slovene", "uppersorbian", 0};
112 /// languages with polish quotes (.lyx names)
113 const char * const known_polish_quotes_languages[] = {"afrikaans", "croatian",
114 "dutch", "estonian", "magyar", "polish", "romanian", 0};
116 /// languages with swedish quotes (.lyx names)
117 const char * const known_swedish_quotes_languages[] = {"finnish",
120 /// known language packages from the times before babel
121 const char * const known_old_language_packages[] = {"french", "frenchle",
122 "frenchpro", "german", "ngerman", "pmfrench", 0};
124 char const * const known_fontsizes[] = { "10pt", "11pt", "12pt", 0 };
126 const char * const known_roman_fonts[] = { "ae", "beraserif", "bookman",
127 "ccfonts", "chancery", "charter", "cmr", "fourier", "lmodern", "mathpazo",
128 "mathptmx", "newcent", "utopia", 0};
130 const char * const known_sans_fonts[] = { "avant", "berasans", "cmbr", "cmss",
131 "helvet", "lmss", 0};
133 const char * const known_typewriter_fonts[] = { "beramono", "cmtl", "cmtt",
134 "courier", "lmtt", "luximono", "fourier", "lmodern", "mathpazo", "mathptmx",
137 const char * const known_paper_sizes[] = { "a0paper", "b0paper", "c0paper",
138 "a1paper", "b1paper", "c1paper", "a2paper", "b2paper", "c2paper", "a3paper",
139 "b3paper", "c3paper", "a4paper", "b4paper", "c4paper", "a5paper", "b5paper",
140 "c5paper", "a6paper", "b6paper", "c6paper", "executivepaper", "legalpaper",
141 "letterpaper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j", "b6j", 0};
143 const char * const known_class_paper_sizes[] = { "a4paper", "a5paper",
144 "executivepaper", "legalpaper", "letterpaper", 0};
146 const char * const known_paper_margins[] = { "lmargin", "tmargin", "rmargin",
147 "bmargin", "headheight", "headsep", "footskip", "columnsep", 0};
149 const char * const known_coded_paper_margins[] = { "leftmargin", "topmargin",
150 "rightmargin", "bottommargin", "headheight", "headsep", "footskip",
153 /// commands that can start an \if...\else...\endif sequence
154 const char * const known_if_commands[] = {"if", "ifarydshln", "ifbraket",
155 "ifcancel", "ifcolortbl", "ifeurosym", "ifmarginnote", "ifmmode", "ifpdf",
156 "ifsidecap", "ifupgreek", 0};
158 const char * const known_basic_colors[] = {"blue", "black", "cyan", "green",
159 "magenta", "red", "white", "yellow", 0};
161 const char * const known_basic_color_codes[] = {"#0000ff", "#000000", "#00ffff", "#00ff00",
162 "#ff00ff", "#ff0000", "#ffffff", "#ffff00", 0};
164 /// conditional commands with three arguments like \@ifundefined{}{}{}
165 const char * const known_if_3arg_commands[] = {"@ifundefined", "IfFileExists",
168 /// packages that work only in xetex
169 const char * const known_xetex_packages[] = {"arabxetex", "fixlatvian",
170 "fontbook", "fontwrap", "mathspec", "philokalia", "polyglossia", "unisugar",
171 "xeCJK", "xecolor", "xecyr", "xeindex", "xepersian", "xunicode", 0};
173 // codes used to remove packages that are loaded automatically by LyX.
174 // Syntax: package_beg_sep<name>package_mid_sep<package loading code>package_end_sep
175 const char package_beg_sep = '\001';
176 const char package_mid_sep = '\002';
177 const char package_end_sep = '\003';
180 // returns true if at least one of the options in what has been found
181 bool handle_opt(vector<string> & opts, char const * const * what, string & target)
187 // the last language option is the document language (for babel and LyX)
188 // the last size option is the document font size
189 vector<string>::iterator it;
190 vector<string>::iterator position = opts.begin();
191 for (; *what; ++what) {
192 it = find(opts.begin(), opts.end(), *what);
193 if (it != opts.end()) {
194 if (it >= position) {
205 void delete_opt(vector<string> & opts, char const * const * what)
210 // remove found options from the list
211 // do this after handle_opt to avoid potential memory leaks
212 vector<string>::iterator it;
213 for (; *what; ++what) {
214 it = find(opts.begin(), opts.end(), *what);
215 if (it != opts.end())
222 * Split a package options string (keyval format) into a vector.
224 * authorformat=smallcaps,
226 * titleformat=colonsep,
227 * bibformat={tabular,ibidem,numbered}
229 vector<string> split_options(string const & input)
231 vector<string> options;
235 Token const & t = p.get_token();
236 if (t.asInput() == ",") {
237 options.push_back(trimSpaceAndEol(option));
239 } else if (t.asInput() == "=") {
242 if (p.next_token().asInput() == "{")
243 option += '{' + p.getArg('{', '}') + '}';
244 } else if (t.cat() != catSpace)
245 option += t.asInput();
249 options.push_back(trimSpaceAndEol(option));
256 * Retrieve a keyval option "name={value with=sign}" named \p name from
257 * \p options and return the value.
258 * The found option is also removed from \p options.
260 string process_keyval_opt(vector<string> & options, string name)
262 for (size_t i = 0; i < options.size(); ++i) {
263 vector<string> option;
264 split(options[i], option, '=');
265 if (option.size() < 2)
267 if (option[0] == name) {
268 options.erase(options.begin() + i);
269 option.erase(option.begin());
270 return join(option, "=");
276 } // anonymous namespace
279 bool Preamble::indentParagraphs() const
281 return h_paragraph_separation == "indent";
285 bool Preamble::isPackageUsed(string const & package) const
287 return used_packages.find(package) != used_packages.end();
291 vector<string> Preamble::getPackageOptions(string const & package) const
293 map<string, vector<string> >::const_iterator it = used_packages.find(package);
294 if (it != used_packages.end())
296 return vector<string>();
300 void Preamble::registerAutomaticallyLoadedPackage(std::string const & package)
302 auto_packages.insert(package);
306 void Preamble::addModule(string const & module)
308 used_modules.push_back(module);
312 void Preamble::suppressDate(bool suppress)
315 h_suppress_date = "true";
317 h_suppress_date = "false";
321 void Preamble::registerAuthor(std::string const & name)
323 Author author(from_utf8(name), empty_docstring());
324 author.setUsed(true);
325 authors_.record(author);
326 h_tracking_changes = "true";
327 h_output_changes = "true";
331 Author const & Preamble::getAuthor(std::string const & name) const
333 Author author(from_utf8(name), empty_docstring());
334 for (AuthorList::Authors::const_iterator it = authors_.begin();
335 it != authors_.end(); it++)
338 static Author const dummy;
343 void Preamble::add_package(string const & name, vector<string> & options)
345 // every package inherits the global options
346 if (used_packages.find(name) == used_packages.end())
347 used_packages[name] = split_options(h_options);
349 vector<string> & v = used_packages[name];
350 v.insert(v.end(), options.begin(), options.end());
351 if (name == "jurabib") {
352 // Don't output the order argument (see the cite command
353 // handling code in text.cpp).
354 vector<string>::iterator end =
355 remove(options.begin(), options.end(), "natbiborder");
356 end = remove(options.begin(), end, "jurabiborder");
357 options.erase(end, options.end());
364 // Given is a string like "scaled=0.9", return 0.9 * 100
365 string const scale_as_percentage(string const & scale)
367 string::size_type pos = scale.find('=');
368 if (pos != string::npos) {
369 string value = scale.substr(pos + 1);
371 return convert<string>(100 * convert<double>(value));
373 // If the input string didn't match our expectations.
374 // return the default value "100"
379 string remove_braces(string const & value)
383 if (value[0] == '{' && value[value.length()-1] == '}')
384 return value.substr(1, value.length()-2);
388 } // anonymous namespace
391 Preamble::Preamble() : one_language(true)
395 h_cite_engine = "basic";
396 h_defskip = "medskip";
399 h_fontencoding = "default";
400 h_font_roman = "default";
401 h_font_sans = "default";
402 h_font_typewriter = "default";
403 h_font_default_family = "default";
405 h_font_osf = "false";
406 h_font_sf_scale = "100";
407 h_font_tt_scale = "100";
408 h_graphics = "default";
409 h_html_be_strict = "false";
410 h_html_css_as_file = "0";
411 h_html_math_output = "0";
412 h_inputencoding = "auto";
413 h_language = "english";
414 h_language_package = "none";
419 h_output_changes = "false";
420 h_papercolumns = "1";
421 h_paperfontsize = "default";
422 h_paperorientation = "portrait";
423 h_paperpagestyle = "default";
425 h_papersize = "default";
426 h_paragraph_indentation = "default";
427 h_paragraph_separation = "indent";
432 h_pdf_bookmarks = "1";
433 h_pdf_bookmarksnumbered = "0";
434 h_pdf_bookmarksopen = "0";
435 h_pdf_bookmarksopenlevel = "1";
436 h_pdf_breaklinks = "0";
437 h_pdf_pdfborder = "0";
438 h_pdf_colorlinks = "0";
439 h_pdf_backref = "section";
440 h_pdf_pdfusetitle = "1";
442 //h_pdf_quoted_options;
443 h_quotes_language = "english";
445 h_spacing = "single";
446 h_suppress_date = "false";
447 h_textclass = "article";
449 h_tracking_changes = "false";
450 h_use_bibtopic = "false";
451 h_use_indices = "false";
452 h_use_geometry = "false";
454 h_use_default_options = "false";
456 h_use_hyperref = "0";
458 h_use_mathdots = "0";
459 h_use_refstyle = "0";
460 h_use_undertilde = "0";
464 void Preamble::handle_hyperref(vector<string> & options)
466 // FIXME swallow inputencoding changes that might surround the
467 // hyperref setup if it was written by LyX
468 h_use_hyperref = "1";
469 // swallow "unicode=true", since LyX does always write that
470 vector<string>::iterator it =
471 find(options.begin(), options.end(), "unicode=true");
472 if (it != options.end())
474 it = find(options.begin(), options.end(), "pdfusetitle");
475 if (it != options.end()) {
476 h_pdf_pdfusetitle = "1";
479 string bookmarks = process_keyval_opt(options, "bookmarks");
480 if (bookmarks == "true")
481 h_pdf_bookmarks = "1";
482 else if (bookmarks == "false")
483 h_pdf_bookmarks = "0";
484 if (h_pdf_bookmarks == "1") {
485 string bookmarksnumbered =
486 process_keyval_opt(options, "bookmarksnumbered");
487 if (bookmarksnumbered == "true")
488 h_pdf_bookmarksnumbered = "1";
489 else if (bookmarksnumbered == "false")
490 h_pdf_bookmarksnumbered = "0";
491 string bookmarksopen =
492 process_keyval_opt(options, "bookmarksopen");
493 if (bookmarksopen == "true")
494 h_pdf_bookmarksopen = "1";
495 else if (bookmarksopen == "false")
496 h_pdf_bookmarksopen = "0";
497 if (h_pdf_bookmarksopen == "1") {
498 string bookmarksopenlevel =
499 process_keyval_opt(options, "bookmarksopenlevel");
500 if (!bookmarksopenlevel.empty())
501 h_pdf_bookmarksopenlevel = bookmarksopenlevel;
504 string breaklinks = process_keyval_opt(options, "breaklinks");
505 if (breaklinks == "true")
506 h_pdf_breaklinks = "1";
507 else if (breaklinks == "false")
508 h_pdf_breaklinks = "0";
509 string pdfborder = process_keyval_opt(options, "pdfborder");
510 if (pdfborder == "{0 0 0}")
511 h_pdf_pdfborder = "1";
512 else if (pdfborder == "{0 0 1}")
513 h_pdf_pdfborder = "0";
514 string backref = process_keyval_opt(options, "backref");
515 if (!backref.empty())
516 h_pdf_backref = backref;
517 string colorlinks = process_keyval_opt(options, "colorlinks");
518 if (colorlinks == "true")
519 h_pdf_colorlinks = "1";
520 else if (colorlinks == "false")
521 h_pdf_colorlinks = "0";
522 string pdfpagemode = process_keyval_opt(options, "pdfpagemode");
523 if (!pdfpagemode.empty())
524 h_pdf_pagemode = pdfpagemode;
525 string pdftitle = process_keyval_opt(options, "pdftitle");
526 if (!pdftitle.empty()) {
527 h_pdf_title = remove_braces(pdftitle);
529 string pdfauthor = process_keyval_opt(options, "pdfauthor");
530 if (!pdfauthor.empty()) {
531 h_pdf_author = remove_braces(pdfauthor);
533 string pdfsubject = process_keyval_opt(options, "pdfsubject");
534 if (!pdfsubject.empty())
535 h_pdf_subject = remove_braces(pdfsubject);
536 string pdfkeywords = process_keyval_opt(options, "pdfkeywords");
537 if (!pdfkeywords.empty())
538 h_pdf_keywords = remove_braces(pdfkeywords);
539 if (!options.empty()) {
540 if (!h_pdf_quoted_options.empty())
541 h_pdf_quoted_options += ',';
542 h_pdf_quoted_options += join(options, ",");
548 void Preamble::handle_geometry(vector<string> & options)
550 h_use_geometry = "true";
551 vector<string>::iterator it;
553 if ((it = find(options.begin(), options.end(), "landscape")) != options.end()) {
554 h_paperorientation = "landscape";
558 // keyval version: "paper=letter"
559 string paper = process_keyval_opt(options, "paper");
561 h_papersize = paper + "paper";
562 // alternative version: "letterpaper"
563 handle_opt(options, known_paper_sizes, h_papersize);
564 delete_opt(options, known_paper_sizes);
566 char const * const * margin = known_paper_margins;
567 for (; *margin; ++margin) {
568 string value = process_keyval_opt(options, *margin);
569 if (!value.empty()) {
570 int k = margin - known_paper_margins;
571 string name = known_coded_paper_margins[k];
572 h_margins += '\\' + name + ' ' + value + '\n';
578 void Preamble::handle_package(Parser &p, string const & name,
579 string const & opts, bool in_lyx_preamble)
581 vector<string> options = split_options(opts);
582 add_package(name, options);
585 if (is_known(name, known_xetex_packages))
589 if (is_known(name, known_roman_fonts)) {
594 if (name == "fourier") {
595 h_font_roman = "utopia";
596 // when font uses real small capitals
597 if (opts == "expert")
601 if (name == "mathpazo")
602 h_font_roman = "palatino";
604 if (name == "mathptmx")
605 h_font_roman = "times";
608 if (is_known(name, known_sans_fonts)) {
612 h_font_sf_scale = scale_as_percentage(scale);
617 if (is_known(name, known_typewriter_fonts)) {
618 // fourier can be set as roman font _only_
619 // fourier as typewriter is handled in handling of \ttdefault
620 if (name != "fourier") {
621 h_font_typewriter = name;
624 h_font_tt_scale = scale_as_percentage(scale);
629 // font uses old-style figure
633 // after the detection and handling of special cases, we can remove the
634 // fonts, otherwise they would appear in the preamble, see bug #7856
635 if (is_known(name, known_roman_fonts) || is_known(name, known_sans_fonts)
636 || is_known(name, known_typewriter_fonts))
639 else if (name == "amsmath" || name == "amssymb")
642 else if (name == "esint")
645 else if (name == "mhchem")
648 else if (name == "mathdots")
649 h_use_mathdots = "2";
651 else if (name == "undertilde")
652 h_use_undertilde = "2";
654 else if (name == "babel") {
655 h_language_package = "default";
656 // One might think we would have to do nothing if babel is loaded
657 // without any options to prevent pollution of the preamble with this
658 // babel call in every roundtrip.
659 // But the user could have defined babel-specific things afterwards. So
660 // we need to keep it in the preamble to prevent cases like bug #7861.
662 // check if more than one option was used - used later for inputenc
663 if (options.begin() != options.end() - 1)
664 one_language = false;
665 // babel takes the last language of the option of its \usepackage
666 // call as document language. If there is no such language option, the
667 // last language in the documentclass options is used.
668 handle_opt(options, known_languages, h_language);
669 // If babel is called with options, LyX puts them by default into the
670 // document class options. This works for most languages, except
671 // for Latvian, Lithuanian, Mongolian, Turkmen and Vietnamese and
672 // perhaps in future others.
673 // Therefore keep the babel call as it is as the user might have
675 h_preamble << "\\usepackage[" << opts << "]{babel}\n";
676 delete_opt(options, known_languages);
679 h_preamble << "\\usepackage{babel}\n";
682 else if (name == "fontenc") {
683 h_fontencoding = getStringFromVector(options, ",");
684 /* We could do the following for better round trip support,
685 * but this makes the document less portable, so I skip it:
686 if (h_fontencoding == lyxrc.fontenc)
687 h_fontencoding = "global";
692 else if (name == "inputenc" || name == "luainputenc") {
693 // h_inputencoding is only set when there is not more than one
694 // inputenc option because otherwise h_inputencoding must be
695 // set to "auto" (the default encoding of the document language)
696 // Therefore check for the "," character.
697 // It is also only set when there is not more than one babel
699 if (opts.find(",") == string::npos && one_language == true)
700 h_inputencoding = opts;
701 if (!options.empty())
702 p.setEncoding(options.back());
706 else if (is_known(name, known_old_language_packages)) {
707 // known language packages from the times before babel
708 // if they are found and not also babel, they will be used as
709 // custom language package
710 h_language_package = "\\usepackage{" + name + "}";
713 else if (name == "prettyref")
714 ; // ignore this FIXME: Use the package separator mechanism instead
716 else if (name == "varioref")
717 ; // ignore this FIXME: Use the package separator mechanism instead
719 else if (name == "verbatim")
720 ; // ignore this FIXME: Use the package separator mechanism instead
722 else if (name == "textcomp")
723 ; // ignore this FIXME: Use the package separator mechanism instead
725 else if (name == "lyxskak") {
726 // ignore this and its options
727 if (!options.empty())
731 else if (name == "array" || name == "booktabs" || name == "float" ||
732 name == "color" || name == "hhline" || name == "longtable" ||
733 name == "makeidx" || name == "nomencl" || name == "splitidx" ||
734 name == "setspace" || name == "subscript" || name == "ulem" ||
736 if (!in_lyx_preamble)
737 h_preamble << package_beg_sep << name
738 << package_mid_sep << "\\usepackage{"
739 << name << '}' << package_end_sep;
742 else if (name == "graphicx")
743 ; // ignore this FIXME: Use the package separator mechanism instead
745 else if (name == "geometry")
746 handle_geometry(options);
748 else if (name == "rotfloat")
749 ; // ignore this FIXME: Use the package separator mechanism instead
751 else if (name == "wrapfig")
752 ; // ignore this FIXME: Use the package separator mechanism instead
754 else if (name == "subfig")
755 ; // ignore this FIXME: Use the package separator mechanism instead
757 else if (is_known(name, known_languages))
760 else if (name == "natbib") {
761 h_cite_engine = "natbib_authoryear";
762 vector<string>::iterator it =
763 find(options.begin(), options.end(), "authoryear");
764 if (it != options.end())
767 it = find(options.begin(), options.end(), "numbers");
768 if (it != options.end()) {
769 h_cite_engine = "natbib_numerical";
775 else if (name == "jurabib")
776 h_cite_engine = "jurabib";
778 else if (name == "hyperref")
779 handle_hyperref(options);
781 else if (!in_lyx_preamble) {
783 h_preamble << "\\usepackage{" << name << "}";
785 h_preamble << "\\usepackage[" << opts << "]{"
791 // We need to do something with the options...
792 if (!options.empty())
793 cerr << "Ignoring options '" << join(options, ",")
794 << "' of package " << name << '.' << endl;
796 // remove the whitespace
801 void Preamble::handle_if(Parser & p, bool in_lyx_preamble)
804 Token t = p.get_token();
805 if (t.cat() == catEscape &&
806 is_known(t.cs(), known_if_commands))
807 handle_if(p, in_lyx_preamble);
809 if (!in_lyx_preamble)
810 h_preamble << t.asInput();
811 if (t.cat() == catEscape && t.cs() == "fi")
818 bool Preamble::writeLyXHeader(ostream & os)
820 // translate from babel to LyX names
821 h_language = babel2lyx(h_language);
823 // set the quote language
824 // LyX only knows the following quotes languages:
825 // english, swedish, german, polish, french and danish
826 // (quotes for "japanese" and "chinese-traditional" are missing because
827 // they wouldn't be useful: http://www.lyx.org/trac/ticket/6383)
828 // conversion list taken from
829 // http://en.wikipedia.org/wiki/Quotation_mark,_non-English_usage
830 // (quotes for kazakh and interlingua are unknown)
832 if (h_language == "danish")
833 h_quotes_language = "danish";
835 else if (is_known(h_language, known_french_quotes_languages))
836 h_quotes_language = "french";
838 else if (is_known(h_language, known_german_quotes_languages))
839 h_quotes_language = "german";
841 else if (is_known(h_language, known_polish_quotes_languages))
842 h_quotes_language = "polish";
844 else if (is_known(h_language, known_swedish_quotes_languages))
845 h_quotes_language = "swedish";
847 else if (is_known(h_language, known_english_quotes_languages))
848 h_quotes_language = "english";
850 if (contains(h_float_placement, "H"))
851 registerAutomaticallyLoadedPackage("float");
852 if (h_spacing != "single" && h_spacing != "default")
853 registerAutomaticallyLoadedPackage("setspace");
855 // output the LyX file settings
856 os << "#LyX file created by tex2lyx " << PACKAGE_VERSION << "\n"
857 << "\\lyxformat " << LYX_FORMAT << '\n'
858 << "\\begin_document\n"
859 << "\\begin_header\n"
860 << "\\textclass " << h_textclass << "\n";
861 string const raw = h_preamble.str();
863 os << "\\begin_preamble\n";
864 for (string::size_type i = 0; i < raw.size(); ++i) {
865 if (raw[i] == package_beg_sep) {
866 // Here follows some package loading code that
867 // must be skipped if the package is loaded
869 string::size_type j = raw.find(package_mid_sep, i);
870 if (j == string::npos)
872 string::size_type k = raw.find(package_end_sep, j);
873 if (k == string::npos)
875 string const package = raw.substr(i + 1, j - i - 1);
876 string const replacement = raw.substr(j + 1, k - j - 1);
877 if (auto_packages.find(package) == auto_packages.end())
883 os << "\n\\end_preamble\n";
885 if (!h_options.empty())
886 os << "\\options " << h_options << "\n";
887 os << "\\use_default_options " << h_use_default_options << "\n";
888 if (!used_modules.empty()) {
889 os << "\\begin_modules\n";
890 vector<string>::const_iterator const end = used_modules.end();
891 vector<string>::const_iterator it = used_modules.begin();
892 for (; it != end; it++)
894 os << "\\end_modules\n";
896 os << "\\language " << h_language << "\n"
897 << "\\language_package " << h_language_package << "\n"
898 << "\\inputencoding " << h_inputencoding << "\n"
899 << "\\fontencoding " << h_fontencoding << "\n"
900 << "\\font_roman " << h_font_roman << "\n"
901 << "\\font_sans " << h_font_sans << "\n"
902 << "\\font_typewriter " << h_font_typewriter << "\n"
903 << "\\font_default_family " << h_font_default_family << "\n"
904 << "\\font_sc " << h_font_sc << "\n"
905 << "\\font_osf " << h_font_osf << "\n"
906 << "\\font_sf_scale " << h_font_sf_scale << "\n"
907 << "\\font_tt_scale " << h_font_tt_scale << "\n"
908 << "\\graphics " << h_graphics << "\n";
909 if (!h_float_placement.empty())
910 os << "\\float_placement " << h_float_placement << "\n";
911 os << "\\paperfontsize " << h_paperfontsize << "\n"
912 << "\\spacing " << h_spacing << "\n"
913 << "\\use_hyperref " << h_use_hyperref << '\n';
914 if (h_use_hyperref == "1") {
915 if (!h_pdf_title.empty())
916 os << "\\pdf_title \"" << h_pdf_title << "\"\n";
917 if (!h_pdf_author.empty())
918 os << "\\pdf_author \"" << h_pdf_author << "\"\n";
919 if (!h_pdf_subject.empty())
920 os << "\\pdf_subject \"" << h_pdf_subject << "\"\n";
921 if (!h_pdf_keywords.empty())
922 os << "\\pdf_keywords \"" << h_pdf_keywords << "\"\n";
923 os << "\\pdf_bookmarks " << h_pdf_bookmarks << "\n"
924 "\\pdf_bookmarksnumbered " << h_pdf_bookmarksnumbered << "\n"
925 "\\pdf_bookmarksopen " << h_pdf_bookmarksopen << "\n"
926 "\\pdf_bookmarksopenlevel " << h_pdf_bookmarksopenlevel << "\n"
927 "\\pdf_breaklinks " << h_pdf_breaklinks << "\n"
928 "\\pdf_pdfborder " << h_pdf_pdfborder << "\n"
929 "\\pdf_colorlinks " << h_pdf_colorlinks << "\n"
930 "\\pdf_backref " << h_pdf_backref << "\n"
931 "\\pdf_pdfusetitle " << h_pdf_pdfusetitle << '\n';
932 if (!h_pdf_pagemode.empty())
933 os << "\\pdf_pagemode " << h_pdf_pagemode << '\n';
934 if (!h_pdf_quoted_options.empty())
935 os << "\\pdf_quoted_options \"" << h_pdf_quoted_options << "\"\n";
937 os << "\\papersize " << h_papersize << "\n"
938 << "\\use_geometry " << h_use_geometry << "\n"
939 << "\\use_amsmath " << h_use_amsmath << "\n"
940 << "\\use_esint " << h_use_esint << "\n"
941 << "\\use_mhchem " << h_use_mhchem << "\n"
942 << "\\use_mathdots " << h_use_mathdots << "\n"
943 << "\\use_undertilde " << h_use_undertilde << "\n"
944 << "\\cite_engine " << h_cite_engine << "\n"
945 << "\\use_bibtopic " << h_use_bibtopic << "\n"
946 << "\\use_indices " << h_use_indices << "\n"
947 << "\\paperorientation " << h_paperorientation << '\n'
948 << "\\suppress_date " << h_suppress_date << '\n'
949 << "\\use_refstyle " << h_use_refstyle << '\n';
950 if (!h_fontcolor.empty())
951 os << "\\fontcolor " << h_fontcolor << '\n';
952 if (!h_notefontcolor.empty())
953 os << "\\notefontcolor " << h_notefontcolor << '\n';
954 if (!h_backgroundcolor.empty())
955 os << "\\backgroundcolor " << h_backgroundcolor << '\n';
956 if (!h_boxbgcolor.empty())
957 os << "\\boxbgcolor " << h_boxbgcolor << '\n';
959 << "\\secnumdepth " << h_secnumdepth << "\n"
960 << "\\tocdepth " << h_tocdepth << "\n"
961 << "\\paragraph_separation " << h_paragraph_separation << "\n";
962 if (h_paragraph_separation == "skip")
963 os << "\\defskip " << h_defskip << "\n";
965 os << "\\paragraph_indentation " << h_paragraph_indentation << "\n";
966 os << "\\quotes_language " << h_quotes_language << "\n"
967 << "\\papercolumns " << h_papercolumns << "\n"
968 << "\\papersides " << h_papersides << "\n"
969 << "\\paperpagestyle " << h_paperpagestyle << "\n";
970 if (!h_listings_params.empty())
971 os << "\\listings_params " << h_listings_params << "\n";
972 os << "\\tracking_changes " << h_tracking_changes << "\n"
973 << "\\output_changes " << h_output_changes << "\n"
974 << "\\html_math_output " << h_html_math_output << "\n"
975 << "\\html_css_as_file " << h_html_css_as_file << "\n"
976 << "\\html_be_strict " << h_html_be_strict << "\n"
978 << "\\end_header\n\n"
980 // clear preamble for subdocuments
986 void Preamble::parse(Parser & p, string const & forceclass,
987 TeX2LyXDocClass & tc)
989 // initialize fixed types
990 special_columns['D'] = 3;
991 bool is_full_document = false;
992 bool is_lyx_file = false;
993 bool in_lyx_preamble = false;
995 // determine whether this is a full document or a fragment for inclusion
997 Token const & t = p.get_token();
999 if (t.cat() == catEscape && t.cs() == "documentclass") {
1000 is_full_document = true;
1006 while (is_full_document && p.good()) {
1007 Token const & t = p.get_token();
1010 cerr << "t: " << t << "\n";
1016 if (!in_lyx_preamble &&
1017 (t.cat() == catLetter ||
1018 t.cat() == catSuper ||
1019 t.cat() == catSub ||
1020 t.cat() == catOther ||
1021 t.cat() == catMath ||
1022 t.cat() == catActive ||
1023 t.cat() == catBegin ||
1024 t.cat() == catEnd ||
1025 t.cat() == catAlign ||
1026 t.cat() == catParameter))
1027 h_preamble << t.cs();
1029 else if (!in_lyx_preamble &&
1030 (t.cat() == catSpace || t.cat() == catNewline))
1031 h_preamble << t.asInput();
1033 else if (t.cat() == catComment) {
1034 static regex const islyxfile("%% LyX .* created this file");
1035 static regex const usercommands("User specified LaTeX commands");
1037 string const comment = t.asInput();
1039 // magically switch encoding default if it looks like XeLaTeX
1040 static string const magicXeLaTeX =
1041 "% This document must be compiled with XeLaTeX ";
1042 if (comment.size() > magicXeLaTeX.size()
1043 && comment.substr(0, magicXeLaTeX.size()) == magicXeLaTeX
1044 && h_inputencoding == "auto") {
1045 cerr << "XeLaTeX comment found, switching to UTF8\n";
1046 h_inputencoding = "utf8";
1049 if (regex_search(comment, sub, islyxfile)) {
1051 in_lyx_preamble = true;
1052 } else if (is_lyx_file
1053 && regex_search(comment, sub, usercommands))
1054 in_lyx_preamble = false;
1055 else if (!in_lyx_preamble)
1056 h_preamble << t.asInput();
1059 else if (t.cs() == "pagestyle")
1060 h_paperpagestyle = p.verbatim_item();
1062 else if (t.cs() == "date") {
1063 string argument = p.getArg('{', '}');
1064 if (argument.empty())
1065 h_suppress_date = "true";
1067 h_preamble << t.asInput() << '{' << argument << '}';
1070 else if (t.cs() == "color") {
1071 string const space =
1072 (p.hasOpt() ? p.getOpt() : string());
1073 string argument = p.getArg('{', '}');
1074 // check the case that a standard color is used
1075 if (space.empty() && is_known(argument, known_basic_colors)) {
1076 h_fontcolor = rgbcolor2code(argument);
1077 preamble.registerAutomaticallyLoadedPackage("color");
1078 } else if (space.empty() && argument == "document_fontcolor")
1079 preamble.registerAutomaticallyLoadedPackage("color");
1080 // check the case that LyX's document_fontcolor is defined
1081 // but not used for \color
1083 h_preamble << t.asInput();
1085 h_preamble << space;
1086 h_preamble << '{' << argument << '}';
1087 // the color might already be set because \definecolor
1088 // is parsed before this
1093 else if (t.cs() == "pagecolor") {
1094 string argument = p.getArg('{', '}');
1095 // check the case that a standard color is used
1096 if (is_known(argument, known_basic_colors)) {
1097 h_backgroundcolor = rgbcolor2code(argument);
1098 } else if (argument == "page_backgroundcolor")
1099 preamble.registerAutomaticallyLoadedPackage("color");
1100 // check the case that LyX's page_backgroundcolor is defined
1101 // but not used for \pagecolor
1103 h_preamble << t.asInput() << '{' << argument << '}';
1104 // the color might already be set because \definecolor
1105 // is parsed before this
1106 h_backgroundcolor = "";
1110 else if (t.cs() == "makeatletter") {
1111 // LyX takes care of this
1112 p.setCatCode('@', catLetter);
1115 else if (t.cs() == "makeatother") {
1116 // LyX takes care of this
1117 p.setCatCode('@', catOther);
1120 else if (t.cs() == "newcommand" || t.cs() == "newcommandx"
1121 || t.cs() == "renewcommand" || t.cs() == "renewcommandx"
1122 || t.cs() == "providecommand" || t.cs() == "providecommandx"
1123 || t.cs() == "DeclareRobustCommand"
1124 || t.cs() == "DeclareRobustCommandx"
1125 || t.cs() == "ProvideTextCommandDefault"
1126 || t.cs() == "DeclareMathAccent") {
1128 if (p.next_token().character() == '*') {
1132 string const name = p.verbatim_item();
1133 string const opt1 = p.getFullOpt();
1134 string const opt2 = p.getFullOpt();
1135 string const body = p.verbatim_item();
1137 if (name == "\\rmdefault")
1138 if (is_known(body, known_roman_fonts))
1139 h_font_roman = body;
1140 if (name == "\\sfdefault")
1141 if (is_known(body, known_sans_fonts))
1143 if (name == "\\ttdefault")
1144 if (is_known(body, known_typewriter_fonts))
1145 h_font_typewriter = body;
1146 if (name == "\\familydefault") {
1147 string family = body;
1148 // remove leading "\"
1149 h_font_default_family = family.erase(0,1);
1152 // remove the lyxdot definition that is re-added by LyX
1154 if (name == "\\lyxdot")
1155 in_lyx_preamble = true;
1157 // Add the command to the known commands
1158 add_known_command(name, opt1, !opt2.empty(), from_utf8(body));
1160 // only non-lyxspecific stuff
1161 if (!in_lyx_preamble) {
1163 ss << '\\' << t.cs();
1166 ss << '{' << name << '}' << opt1 << opt2
1167 << '{' << body << "}";
1168 h_preamble << ss.str();
1170 ostream & out = in_preamble ? h_preamble : os;
1171 out << "\\" << t.cs() << "{" << name << "}"
1172 << opts << "{" << body << "}";
1177 else if (t.cs() == "documentclass") {
1178 vector<string>::iterator it;
1179 vector<string> opts = split_options(p.getArg('[', ']'));
1180 handle_opt(opts, known_fontsizes, h_paperfontsize);
1181 delete_opt(opts, known_fontsizes);
1182 // delete "pt" at the end
1183 string::size_type i = h_paperfontsize.find("pt");
1184 if (i != string::npos)
1185 h_paperfontsize.erase(i);
1186 // The documentclass options are always parsed before the options
1187 // of the babel call so that a language cannot overwrite the babel
1189 handle_opt(opts, known_languages, h_language);
1190 delete_opt(opts, known_languages);
1192 // paper orientation
1193 if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
1194 h_paperorientation = "landscape";
1198 if ((it = find(opts.begin(), opts.end(), "oneside"))
1203 if ((it = find(opts.begin(), opts.end(), "twoside"))
1209 if ((it = find(opts.begin(), opts.end(), "onecolumn"))
1211 h_papercolumns = "1";
1214 if ((it = find(opts.begin(), opts.end(), "twocolumn"))
1216 h_papercolumns = "2";
1220 // some size options are known to any document classes, other sizes
1221 // are handled by the \geometry command of the geometry package
1222 handle_opt(opts, known_class_paper_sizes, h_papersize);
1223 delete_opt(opts, known_class_paper_sizes);
1224 // the remaining options
1225 h_options = join(opts, ",");
1226 // FIXME This does not work for classes that have a
1227 // different name in LyX than in LaTeX
1228 h_textclass = p.getArg('{', '}');
1231 else if (t.cs() == "usepackage") {
1232 string const options = p.getArg('[', ']');
1233 string const name = p.getArg('{', '}');
1234 vector<string> vecnames;
1235 split(name, vecnames, ',');
1236 vector<string>::const_iterator it = vecnames.begin();
1237 vector<string>::const_iterator end = vecnames.end();
1238 for (; it != end; ++it)
1239 handle_package(p, trimSpaceAndEol(*it), options,
1243 else if (t.cs() == "inputencoding") {
1244 string const encoding = p.getArg('{','}');
1245 h_inputencoding = encoding;
1246 p.setEncoding(encoding);
1249 else if (t.cs() == "newenvironment") {
1250 string const name = p.getArg('{', '}');
1251 string const opt1 = p.getFullOpt();
1252 string const opt2 = p.getFullOpt();
1253 string const beg = p.verbatim_item();
1254 string const end = p.verbatim_item();
1255 if (!in_lyx_preamble) {
1256 h_preamble << "\\newenvironment{" << name
1257 << '}' << opt1 << opt2 << '{'
1258 << beg << "}{" << end << '}';
1260 add_known_environment(name, opt1, !opt2.empty(),
1261 from_utf8(beg), from_utf8(end));
1265 else if (t.cs() == "def") {
1266 string name = p.get_token().cs();
1267 while (p.next_token().cat() != catBegin)
1268 name += p.get_token().cs();
1269 if (!in_lyx_preamble)
1270 h_preamble << "\\def\\" << name << '{'
1271 << p.verbatim_item() << "}";
1274 else if (t.cs() == "newcolumntype") {
1275 string const name = p.getArg('{', '}');
1276 trimSpaceAndEol(name);
1278 string opts = p.getOpt();
1279 if (!opts.empty()) {
1280 istringstream is(string(opts, 1));
1283 special_columns[name[0]] = nargs;
1284 h_preamble << "\\newcolumntype{" << name << "}";
1286 h_preamble << "[" << nargs << "]";
1287 h_preamble << "{" << p.verbatim_item() << "}";
1290 else if (t.cs() == "setcounter") {
1291 string const name = p.getArg('{', '}');
1292 string const content = p.getArg('{', '}');
1293 if (name == "secnumdepth")
1294 h_secnumdepth = content;
1295 else if (name == "tocdepth")
1296 h_tocdepth = content;
1298 h_preamble << "\\setcounter{" << name << "}{" << content << "}";
1301 else if (t.cs() == "setlength") {
1302 string const name = p.verbatim_item();
1303 string const content = p.verbatim_item();
1304 // the paragraphs are only not indented when \parindent is set to zero
1305 if (name == "\\parindent" && content != "") {
1306 if (content[0] == '0')
1307 h_paragraph_separation = "skip";
1309 h_paragraph_indentation = translate_len(content);
1310 } else if (name == "\\parskip") {
1311 if (content == "\\smallskipamount")
1312 h_defskip = "smallskip";
1313 else if (content == "\\medskipamount")
1314 h_defskip = "medskip";
1315 else if (content == "\\bigskipamount")
1316 h_defskip = "bigskip";
1318 h_defskip = content;
1320 h_preamble << "\\setlength{" << name << "}{" << content << "}";
1323 else if (t.cs() == "onehalfspacing")
1324 h_spacing = "onehalf";
1326 else if (t.cs() == "doublespacing")
1327 h_spacing = "double";
1329 else if (t.cs() == "setstretch")
1330 h_spacing = "other " + p.verbatim_item();
1332 else if (t.cs() == "begin") {
1333 string const name = p.getArg('{', '}');
1334 if (name == "document")
1336 h_preamble << "\\begin{" << name << "}";
1339 else if (t.cs() == "geometry") {
1340 vector<string> opts = split_options(p.getArg('{', '}'));
1341 handle_geometry(opts);
1344 else if (t.cs() == "definecolor") {
1345 string const color = p.getArg('{', '}');
1346 string const space = p.getArg('{', '}');
1347 string const value = p.getArg('{', '}');
1348 if (color == "document_fontcolor" && space == "rgb") {
1349 RGBColor c(RGBColorFromLaTeX(value));
1350 h_fontcolor = X11hexname(c);
1351 } else if (color == "note_fontcolor" && space == "rgb") {
1352 RGBColor c(RGBColorFromLaTeX(value));
1353 h_notefontcolor = X11hexname(c);
1354 } else if (color == "page_backgroundcolor" && space == "rgb") {
1355 RGBColor c(RGBColorFromLaTeX(value));
1356 h_backgroundcolor = X11hexname(c);
1357 } else if (color == "shadecolor" && space == "rgb") {
1358 RGBColor c(RGBColorFromLaTeX(value));
1359 h_boxbgcolor = X11hexname(c);
1361 h_preamble << "\\definecolor{" << color
1362 << "}{" << space << "}{" << value
1367 else if (t.cs() == "jurabibsetup") {
1368 // FIXME p.getArg('{', '}') is most probably wrong (it
1369 // does not handle nested braces).
1370 // Use p.verbatim_item() instead.
1371 vector<string> jurabibsetup =
1372 split_options(p.getArg('{', '}'));
1373 // add jurabibsetup to the jurabib package options
1374 add_package("jurabib", jurabibsetup);
1375 if (!jurabibsetup.empty()) {
1376 h_preamble << "\\jurabibsetup{"
1377 << join(jurabibsetup, ",") << '}';
1381 else if (t.cs() == "hypersetup") {
1382 vector<string> hypersetup =
1383 split_options(p.verbatim_item());
1384 // add hypersetup to the hyperref package options
1385 handle_hyperref(hypersetup);
1386 if (!hypersetup.empty()) {
1387 h_preamble << "\\hypersetup{"
1388 << join(hypersetup, ",") << '}';
1392 else if (is_known(t.cs(), known_if_3arg_commands)) {
1393 // prevent misparsing of \usepackage if it is used
1394 // as an argument (see e.g. our own output of
1395 // \@ifundefined above)
1396 string const arg1 = p.verbatim_item();
1397 string const arg2 = p.verbatim_item();
1398 string const arg3 = p.verbatim_item();
1399 // test case \@ifundefined{date}{}{\date{}}
1400 if (t.cs() == "@ifundefined" && arg1 == "date" &&
1401 arg2.empty() && arg3 == "\\date{}") {
1402 h_suppress_date = "true";
1403 // older tex2lyx versions did output
1404 // \@ifundefined{definecolor}{\usepackage{color}}{}
1405 } else if (t.cs() == "@ifundefined" &&
1406 arg1 == "definecolor" &&
1407 arg2 == "\\usepackage{color}" &&
1409 if (!in_lyx_preamble)
1410 h_preamble << package_beg_sep
1413 << "\\@ifundefined{definecolor}{color}{}"
1416 //\@ifundefined{showcaptionsetup}{}{%
1417 // \PassOptionsToPackage{caption=false}{subfig}}
1418 // that LyX uses for subfloats
1419 } else if (t.cs() == "@ifundefined" &&
1420 arg1 == "showcaptionsetup" && arg2.empty()
1421 && arg3 == "%\n \\PassOptionsToPackage{caption=false}{subfig}") {
1423 } else if (!in_lyx_preamble) {
1424 h_preamble << t.asInput()
1425 << '{' << arg1 << '}'
1426 << '{' << arg2 << '}'
1427 << '{' << arg3 << '}';
1431 else if (is_known(t.cs(), known_if_commands)) {
1432 // must not parse anything in conditional code, since
1433 // LyX would output the parsed contents unconditionally
1434 if (!in_lyx_preamble)
1435 h_preamble << t.asInput();
1436 handle_if(p, in_lyx_preamble);
1439 else if (!t.cs().empty() && !in_lyx_preamble)
1440 h_preamble << '\\' << t.cs();
1443 // remove the whitespace
1446 // Force textclass if the user wanted it
1447 if (!forceclass.empty())
1448 h_textclass = forceclass;
1449 if (noweb_mode && !prefixIs(h_textclass, "literate-"))
1450 h_textclass.insert(0, "literate-");
1451 tc.setName(h_textclass);
1453 cerr << "Error: Could not read layout file for textclass \"" << h_textclass << "\"." << endl;
1456 if (h_papersides.empty()) {
1459 h_papersides = ss.str();
1464 string babel2lyx(string const & language)
1466 char const * const * where = is_known(language, known_languages);
1468 return known_coded_languages[where - known_languages];
1473 string rgbcolor2code(string const & name)
1475 char const * const * where = is_known(name, known_basic_colors);
1477 // "red", "green" etc
1478 return known_basic_color_codes[where - known_basic_colors];
1480 // "255,0,0", "0,255,0" etc
1481 RGBColor c(RGBColorFromLaTeX(name));
1482 return X11hexname(c);