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 <boost/regex.hpp>
38 using namespace lyx::support;
44 // special columntypes
45 extern map<char, int> special_columns;
47 map<string, vector<string> > used_packages;
49 // needed to handle encodings with babel
50 bool one_language = true;
52 // to avoid that the babel options overwrite the documentclass options
53 bool documentclass_language;
57 const char * const known_languages[] = { "afrikaans", "american", "arabic",
58 "austrian", "bahasa", "basque", "belarusian", "brazil", "breton", "british",
59 "bulgarian", "canadian", "canadien", "catalan", "croatian", "czech", "danish",
60 "dutch", "english", "esperanto", "estonian", "finnish", "francais", "french",
61 "frenchb", "frenchle", "frenchpro", "galician", "german", "germanb", "greek",
62 "hebrew", "icelandic", "irish", "italian", "lsorbian", "magyar", "naustrian",
63 "ngerman", "ngermanb", "norsk", "nynorsk", "polish", "portuges", "romanian",
64 "russian", "russianb", "scottish", "serbian", "slovak", "slovene", "spanish",
65 "swedish", "thai", "turkish", "ukraineb", "ukrainian", "usorbian", "welsh", 0};
67 //note this when updating to lyxformat 305:
68 //bahasai, indonesian, and indon = equal to bahasa
69 //malay, and meyalu = equal to bahasam
71 const char * const known_french_languages[] = {"french", "frenchb", "francais",
72 "frenchle", "frenchpro", 0};
73 const char * const known_german_languages[] = {"german", "germanb", 0};
74 const char * const known_ngerman_languages[] = {"ngerman", "ngermanb", 0};
75 const char * const known_russian_languages[] = {"russian", "russianb", 0};
76 const char * const known_ukrainian_languages[] = {"ukrainian", "ukraineb", 0};
78 char const * const known_fontsizes[] = { "10pt", "11pt", "12pt", 0 };
80 const char * const known_roman_fonts[] = { "ae", "bookman", "charter",
81 "cmr", "fourier", "lmodern", "mathpazo", "mathptmx", "newcent", 0};
83 const char * const known_sans_fonts[] = { "avant", "berasans", "cmbr", "cmss",
86 const char * const known_typewriter_fonts[] = { "beramono", "cmtl", "cmtt",
87 "courier", "lmtt", "luximono", "fourier", "lmodern", "mathpazo", "mathptmx",
90 const char * const known_paper_sizes[] = { "a3paper", "b3paper", "a4paper",
91 "b4paper", "a5paper", "b5paper", "executivepaper", "legalpaper",
94 const char * const known_class_paper_sizes[] = { "a4paper", "a5paper",
95 "executivepaper", "legalpaper", "letterpaper", 0};
97 const char * const known_paper_margins[] = { "lmargin", "tmargin", "rmargin",
98 "bmargin", "headheight", "headsep", "footskip", "columnsep", 0};
100 const char * const known_coded_paper_margins[] = { "leftmargin", "topmargin",
101 "rightmargin", "bottommargin", "headheight", "headsep", "footskip",
105 ostringstream h_preamble;
106 string h_textclass = "article";
107 string h_options = string();
108 string h_language = "english";
109 string h_inputencoding = "auto";
110 string h_font_roman = "default";
111 string h_font_sans = "default";
112 string h_font_typewriter = "default";
113 string h_font_default_family = "default";
114 string h_font_sc = "false";
115 string h_font_osf = "false";
116 string h_font_sf_scale = "100";
117 string h_font_tt_scale = "100";
118 string h_graphics = "default";
119 string h_paperfontsize = "default";
120 string h_spacing = "single";
121 string h_papersize = "default";
122 string h_use_geometry = "false";
123 string h_use_amsmath = "0";
124 string h_cite_engine = "basic";
125 string h_use_bibtopic = "false";
126 string h_paperorientation = "portrait";
127 string h_secnumdepth = "3";
128 string h_tocdepth = "3";
129 string h_paragraph_separation = "indent";
130 string h_defskip = "medskip";
131 string h_quotes_language = "english";
132 string h_papercolumns = "1";
133 string h_papersides = string();
134 string h_paperpagestyle = "default";
135 string h_tracking_changes = "false";
136 string h_output_changes = "false";
137 string h_margins = "";
140 void handle_opt(vector<string> & opts, char const * const * what, string & target)
145 // the last language option is the document language (for babel and LyX)
146 // the last size option is the document font size
147 vector<string>::iterator it;
148 vector<string>::iterator position = opts.begin();
149 for (; *what; ++what) {
150 it = find(opts.begin(), opts.end(), *what);
151 if (it != opts.end()) {
152 documentclass_language = true;
153 if (it >= position) {
162 void delete_opt(vector<string> & opts, char const * const * what)
167 // remove found options from the list
168 // do this after handle_opt to avoid potential memory leaks and to be able
169 // to find in every case the last language option
170 vector<string>::iterator it;
171 for (; *what; ++what) {
172 it = find(opts.begin(), opts.end(), *what);
173 if (it != opts.end())
180 * Split a package options string (keyval format) into a vector.
182 * authorformat=smallcaps,
184 * titleformat=colonsep,
185 * bibformat={tabular,ibidem,numbered}
187 vector<string> split_options(string const & input)
189 vector<string> options;
193 Token const & t = p.get_token();
194 if (t.asInput() == ",") {
195 options.push_back(trim(option));
197 } else if (t.asInput() == "=") {
200 if (p.next_token().asInput() == "{")
201 option += '{' + p.getArg('{', '}') + '}';
202 } else if (t.cat() != catSpace)
203 option += t.asInput();
207 options.push_back(trim(option));
214 * Add package \p name with options \p options to used_packages.
215 * Remove options from \p options that we don't want to output.
217 void add_package(string const & name, vector<string> & options)
219 // every package inherits the global options
220 if (used_packages.find(name) == used_packages.end())
221 used_packages[name] = split_options(h_options);
223 vector<string> & v = used_packages[name];
224 v.insert(v.end(), options.begin(), options.end());
225 if (name == "jurabib") {
226 // Don't output the order argument (see the cite command
227 // handling code in text.cpp).
228 vector<string>::iterator end =
229 remove(options.begin(), options.end(), "natbiborder");
230 end = remove(options.begin(), end, "jurabiborder");
231 options.erase(end, options.end());
236 // Given is a string like "scaled=0.9", return 0.9 * 100
237 string const scale_as_percentage(string const & scale)
239 string::size_type pos = scale.find('=');
240 if (pos != string::npos) {
241 string value = scale.substr(pos + 1);
243 return convert<string>(100 * convert<double>(value));
245 // If the input string didn't match our expectations.
246 // return the default value "100"
251 void handle_package(string const & name, string const & opts,
252 bool in_lyx_preamble)
254 vector<string> options = split_options(opts);
255 add_package(name, options);
259 if (is_known(name, known_roman_fonts))
262 if (name == "fourier") {
263 h_font_roman = "utopia";
264 // when font uses real small capitals
265 if (opts == "expert")
268 if (name == "mathpazo")
269 h_font_roman = "palatino";
271 if (name == "mathptmx")
272 h_font_roman = "times";
275 if (is_known(name, known_sans_fonts)) {
279 h_font_sf_scale = scale_as_percentage(scale);
283 if (is_known(name, known_typewriter_fonts)) {
284 h_font_typewriter = name;
287 h_font_tt_scale = scale_as_percentage(scale);
290 // font uses old-style figure
294 else if (name == "amsmath" || name == "amssymb")
297 else if (name == "babel" && !opts.empty()) {
298 // check if more than one option was used - used later for inputenc
299 // in case inputenc is parsed before babel, set the encoding to auto
300 if (options.begin() != options.end() - 1) {
301 one_language = false;
302 h_inputencoding = "auto";
304 // only set the document language when there was not already one set
305 // via the documentclass options
306 // babel takes the the last language given in the documentclass options
307 // as document language. If there is no such language option, the last
308 // option of its \usepackage call is used.
309 if (documentclass_language == false) {
310 handle_opt(options, known_languages, h_language);
311 delete_opt(options, known_languages);
312 if (is_known(h_language, known_french_languages))
313 h_language = "french";
314 else if (is_known(h_language, known_german_languages))
315 h_language = "german";
316 else if (is_known(h_language, known_ngerman_languages))
317 h_language = "ngerman";
318 else if (is_known(h_language, known_russian_languages))
319 h_language = "russian";
320 else if (is_known(h_language, known_ukrainian_languages))
321 h_language = "ukrainian";
322 h_quotes_language = h_language;
325 else if (name == "fontenc")
328 else if (name == "inputenc") {
329 // only set when there is not more than one inputenc option
330 // therefore check for the "," character
331 // also only set when there is not more then one babel language option
332 if (opts.find(",") == string::npos && one_language == true) {
334 //change ascii to auto to be in the unicode range, see
335 //http://bugzilla.lyx.org/show_bug.cgi?id=4719
336 h_inputencoding = "auto";
337 else if (!opts.empty())
338 h_inputencoding = opts;
343 else if (name == "makeidx")
346 else if (name == "verbatim")
349 else if (name == "color")
350 // with the following command this package is only loaded when needed for
351 // undefined colors, since we only support the predefined colors
352 h_preamble << "\\@ifundefined{definecolor}\n {\\usepackage{color}}{}\n";
354 else if (name == "graphicx")
357 else if (name == "setspace")
360 else if (name == "geometry")
361 ; // Ignore this, the geometry settings are made by the \geometry
362 // command. This command is handled below.
364 else if (is_known(name, known_languages)) {
365 if (is_known(name, known_french_languages))
366 h_language = "french";
367 else if (is_known(name, known_german_languages))
368 h_language = "german";
369 else if (is_known(name, known_ngerman_languages))
370 h_language = "ngerman";
371 else if (is_known(name, known_russian_languages))
372 h_language = "russian";
373 else if (is_known(name, known_ukrainian_languages))
374 h_language = "ukrainian";
377 h_quotes_language = h_language;
379 else if (name == "natbib") {
380 h_cite_engine = "natbib_authoryear";
381 vector<string>::iterator it =
382 find(options.begin(), options.end(), "authoryear");
383 if (it != options.end())
386 it = find(options.begin(), options.end(), "numbers");
387 if (it != options.end()) {
388 h_cite_engine = "natbib_numerical";
393 else if (name == "jurabib")
394 h_cite_engine = "jurabib";
395 else if (!in_lyx_preamble) {
397 h_preamble << "\\usepackage{" << name << "}\n";
399 h_preamble << "\\usepackage[" << opts << "]{"
405 // We need to do something with the options...
406 if (!options.empty())
407 cerr << "Ignoring options '" << join(options, ",")
408 << "' of package " << name << '.' << endl;
413 void end_preamble(ostream & os, TextClass const & /*textclass*/)
415 os << "#LyX file created by tex2lyx " << PACKAGE_VERSION << "\n"
416 << "\\lyxformat 249\n"
417 << "\\begin_document\n"
418 << "\\begin_header\n"
419 << "\\textclass " << h_textclass << "\n";
420 if (!h_preamble.str().empty())
421 os << "\\begin_preamble\n" << h_preamble.str() << "\n\\end_preamble\n";
422 if (!h_options.empty())
423 os << "\\options " << h_options << "\n";
424 os << "\\language " << h_language << "\n"
425 << "\\inputencoding " << h_inputencoding << "\n"
426 << "\\font_roman " << h_font_roman << "\n"
427 << "\\font_sans " << h_font_sans << "\n"
428 << "\\font_typewriter " << h_font_typewriter << "\n"
429 << "\\font_default_family " << h_font_default_family << "\n"
430 << "\\font_sc " << h_font_sc << "\n"
431 << "\\font_osf " << h_font_osf << "\n"
432 << "\\font_sf_scale " << h_font_sf_scale << "\n"
433 << "\\font_tt_scale " << h_font_tt_scale << "\n"
434 << "\\graphics " << h_graphics << "\n"
435 << "\\paperfontsize " << h_paperfontsize << "\n"
436 << "\\spacing " << h_spacing << "\n"
437 << "\\papersize " << h_papersize << "\n"
438 << "\\use_geometry " << h_use_geometry << "\n"
439 << "\\use_amsmath " << h_use_amsmath << "\n"
440 << "\\cite_engine " << h_cite_engine << "\n"
441 << "\\use_bibtopic " << h_use_bibtopic << "\n"
442 << "\\paperorientation " << h_paperorientation << "\n"
444 << "\\secnumdepth " << h_secnumdepth << "\n"
445 << "\\tocdepth " << h_tocdepth << "\n"
446 << "\\paragraph_separation " << h_paragraph_separation << "\n"
447 << "\\defskip " << h_defskip << "\n"
448 << "\\quotes_language " << h_quotes_language << "\n"
449 << "\\papercolumns " << h_papercolumns << "\n"
450 << "\\papersides " << h_papersides << "\n"
451 << "\\paperpagestyle " << h_paperpagestyle << "\n"
452 << "\\tracking_changes " << h_tracking_changes << "\n"
453 << "\\output_changes " << h_output_changes << "\n"
454 << "\\end_header\n\n"
456 // clear preamble for subdocuments
460 } // anonymous namespace
462 void parse_preamble(Parser & p, ostream & os,
463 string const & forceclass, TeX2LyXDocClass & tc)
465 // initialize fixed types
466 special_columns['D'] = 3;
467 bool is_full_document = false;
468 bool is_lyx_file = false;
469 bool in_lyx_preamble = true;
471 // determine whether this is a full document or a fragment for inclusion
473 Token const & t = p.get_token();
475 if (t.cat() == catEscape && t.cs() == "documentclass") {
476 is_full_document = true;
482 while (is_full_document && p.good()) {
483 Token const & t = p.get_token();
486 cerr << "t: " << t << "\n";
492 if (!in_lyx_preamble &&
493 (t.cat() == catLetter ||
494 t.cat() == catSuper ||
496 t.cat() == catOther ||
497 t.cat() == catMath ||
498 t.cat() == catActive ||
499 t.cat() == catBegin ||
501 t.cat() == catAlign ||
502 t.cat() == catParameter))
503 h_preamble << t.character();
505 else if (!in_lyx_preamble &&
506 (t.cat() == catSpace || t.cat() == catNewline))
507 h_preamble << t.asInput();
509 else if (t.cat() == catComment) {
510 // regex to parse comments
511 static regex const islyxfile("%% LyX .* created this file");
512 static regex const usercommands("User specified LaTeX commands");
514 string const comment = t.asInput();
516 // magically switch encoding default if it looks like XeLaTeX
517 static string const magicXeLaTeX =
518 "% This document must be compiled with XeLaTeX ";
519 if (comment.size() > magicXeLaTeX.size()
520 && comment.substr(0, magicXeLaTeX.size()) == magicXeLaTeX
521 && h_inputencoding == "auto") {
522 cerr << "XeLaTeX comment found, switching to UTF8\n";
523 h_inputencoding = "utf8";
527 if (regex_search(comment, sub, islyxfile))
530 && regex_search(comment, sub, usercommands))
531 in_lyx_preamble = false;
532 else if (!in_lyx_preamble)
533 h_preamble << t.asInput();
536 else if (t.cs() == "pagestyle")
537 h_paperpagestyle = p.verbatim_item();
539 else if (t.cs() == "makeatletter") {
540 if (!is_lyx_file || !in_lyx_preamble
541 || p.getCatCode('@') != catLetter)
542 h_preamble << "\\makeatletter";
543 p.setCatCode('@', catLetter);
546 else if (t.cs() == "makeatother") {
547 if (!is_lyx_file || !in_lyx_preamble
548 || p.getCatCode('@') != catOther)
549 h_preamble << "\\makeatother";
550 p.setCatCode('@', catOther);
553 else if (t.cs() == "newcommand" || t.cs() == "renewcommand"
554 || t.cs() == "providecommand") {
556 if (p.next_token().character() == '*') {
560 string const name = p.verbatim_item();
561 string const opt1 = p.getOpt();
562 string const opt2 = p.getFullOpt();
563 string const body = p.verbatim_item();
565 if (name == "\\rmdefault")
566 if (is_known(body, known_roman_fonts))
569 if (name == "\\sfdefault")
570 if (is_known(body, known_sans_fonts))
573 if (name == "\\ttdefault")
574 if (is_known(body, known_typewriter_fonts))
575 h_font_typewriter = body;
577 if (name == "\\familydefault") {
578 string family = body;
579 // remove leading "\"
580 h_font_default_family = family.erase(0,1);
582 // only non-lyxspecific stuff
583 if (!in_lyx_preamble) {
585 ss << '\\' << t.cs();
588 ss << '{' << name << '}' << opt1 << opt2
589 << '{' << body << "}";
590 h_preamble << ss.str();
592 // Add the command to the known commands
593 add_known_command(name, opt1, !opt2.empty());
595 ostream & out = in_preamble ? h_preamble : os;
596 out << "\\" << t.cs() << "{" << name << "}"
597 << opts << "{" << body << "}";
602 else if (t.cs() == "documentclass") {
603 vector<string>::iterator it;
604 vector<string> opts = split_options(p.getArg('[', ']'));
605 handle_opt(opts, known_fontsizes, h_paperfontsize);
606 delete_opt(opts, known_fontsizes);
607 // delete "pt" at the end
608 string::size_type i = h_paperfontsize.find("pt");
609 if (i != string::npos)
610 h_paperfontsize.erase(i);
611 // to avoid that the babel options overwrite the documentclass options
612 documentclass_language = false;
613 handle_opt(opts, known_languages, h_language);
614 delete_opt(opts, known_languages);
615 if (is_known(h_language, known_french_languages))
616 h_language = "french";
617 else if (is_known(h_language, known_german_languages))
618 h_language = "german";
619 else if (is_known(h_language, known_ngerman_languages))
620 h_language = "ngerman";
621 else if (is_known(h_language, known_russian_languages))
622 h_language = "russian";
623 else if (is_known(h_language, known_ukrainian_languages))
624 h_language = "ukrainian";
625 h_quotes_language = h_language;
627 if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
628 h_paperorientation = "landscape";
632 if ((it = find(opts.begin(), opts.end(), "oneside"))
637 if ((it = find(opts.begin(), opts.end(), "twoside"))
643 if ((it = find(opts.begin(), opts.end(), "onecolumn"))
645 h_papercolumns = "1";
648 if ((it = find(opts.begin(), opts.end(), "twocolumn"))
650 h_papercolumns = "2";
654 // some size options are know to any document classes, other sizes
655 // are handled by the \geometry command of the geometry package
656 handle_opt(opts, known_class_paper_sizes, h_papersize);
657 delete_opt(opts, known_class_paper_sizes);
658 // the remaining options
659 h_options = join(opts, ",");
660 h_textclass = p.getArg('{', '}');
663 else if (t.cs() == "usepackage") {
664 string const options = p.getArg('[', ']');
665 string const name = p.getArg('{', '}');
666 if (options.empty() && name.find(',')) {
667 vector<string> vecnames;
668 split(name, vecnames, ',');
669 vector<string>::const_iterator it = vecnames.begin();
670 vector<string>::const_iterator end = vecnames.end();
671 for (; it != end; ++it)
672 handle_package(trim(*it), string(),
675 handle_package(name, options, in_lyx_preamble);
679 else if (t.cs() == "inputencoding") {
680 h_inputencoding = p.getArg('{','}');
683 else if (t.cs() == "newenvironment") {
684 string const name = p.getArg('{', '}');
686 ss << "\\newenvironment{" << name << "}";
689 ss << '{' << p.verbatim_item() << '}';
690 ss << '{' << p.verbatim_item() << '}';
691 if (!in_lyx_preamble)
692 h_preamble << ss.str();
695 else if (t.cs() == "def") {
696 string name = p.get_token().cs();
697 while (p.next_token().cat() != catBegin)
698 name += p.get_token().asString();
699 if (!in_lyx_preamble)
700 h_preamble << "\\def\\" << name << '{'
701 << p.verbatim_item() << "}";
704 else if (t.cs() == "newcolumntype") {
705 string const name = p.getArg('{', '}');
708 string opts = p.getOpt();
710 istringstream is(string(opts, 1));
713 special_columns[name[0]] = nargs;
714 h_preamble << "\\newcolumntype{" << name << "}";
716 h_preamble << "[" << nargs << "]";
717 h_preamble << "{" << p.verbatim_item() << "}";
720 else if (t.cs() == "setcounter") {
721 string const name = p.getArg('{', '}');
722 string const content = p.getArg('{', '}');
723 if (name == "secnumdepth")
724 h_secnumdepth = content;
725 else if (name == "tocdepth")
726 h_tocdepth = content;
728 h_preamble << "\\setcounter{" << name << "}{" << content << "}";
731 else if (t.cs() == "setlength") {
732 string const name = p.verbatim_item();
733 string const content = p.verbatim_item();
734 // the paragraphs are only not indented when \parindent is set to zero
735 if (name == "\\parindent" && content != "") {
736 if (content[0] == '0')
737 h_paragraph_separation = "skip";
738 } else if (name == "\\parskip") {
739 if (content == "\\smallskipamount")
740 h_defskip = "smallskip";
741 else if (content == "\\medskipamount")
742 h_defskip = "medskip";
743 else if (content == "\\bigskipamount")
744 h_defskip = "bigskip";
748 h_preamble << "\\setlength{" << name << "}{" << content << "}";
751 else if (t.cs() == "onehalfspacing")
752 h_spacing = "onehalf";
754 else if (t.cs() == "doublespacing")
755 h_spacing = "double";
757 else if (t.cs() == "setstretch")
758 h_spacing = "other " + p.verbatim_item();
760 else if (t.cs() == "begin") {
761 string const name = p.getArg('{', '}');
762 if (name == "document")
764 h_preamble << "\\begin{" << name << "}";
767 else if (t.cs() == "geometry") {
768 h_use_geometry = "true";
769 vector<string> opts = split_options(p.getArg('{', '}'));
770 vector<string>::iterator it;
772 if ((it = find(opts.begin(), opts.end(), "landscape")) != opts.end()) {
773 h_paperorientation = "landscape";
777 handle_opt(opts, known_paper_sizes, h_papersize);
778 delete_opt(opts, known_paper_sizes);
780 char const * const * margin = known_paper_margins;
782 for (; *margin; ++margin) {
784 // search for the "=" in e.g. "lmargin=2cm" to get the value
785 for(size_t i = 0; i != opts.size(); i++) {
786 if (opts.at(i).find(*margin) != string::npos) {
787 string::size_type pos = opts.at(i).find("=");
788 string value = opts.at(i).substr(pos + 1);
789 string name = known_coded_paper_margins[k];
790 h_margins += "\\" + name + " " + value + "\n";
796 else if (t.cs() == "jurabibsetup") {
797 vector<string> jurabibsetup =
798 split_options(p.getArg('{', '}'));
799 // add jurabibsetup to the jurabib package options
800 add_package("jurabib", jurabibsetup);
801 if (!jurabibsetup.empty()) {
802 h_preamble << "\\jurabibsetup{"
803 << join(jurabibsetup, ",") << '}';
807 else if (!t.cs().empty() && !in_lyx_preamble)
808 h_preamble << '\\' << t.cs();
812 // Force textclass if the user wanted it
813 if (!forceclass.empty())
814 h_textclass = forceclass;
815 if (noweb_mode && !prefixIs(h_textclass, "literate-"))
816 h_textclass.insert(0, "literate-");
817 FileName layoutfilename = libFileSearch("layouts", h_textclass, "layout");
818 if (layoutfilename.empty()) {
819 cerr << "Error: Could not find layout file for textclass \"" << h_textclass << "\"." << endl;
822 tc.read(layoutfilename);
823 if (h_papersides.empty()) {
826 h_papersides = ss.str();
828 end_preamble(os, tc);