]> git.lyx.org Git - lyx.git/blobdiff - src/tex2lyx/Preamble.cpp
update a tex2lyx test file
[lyx.git] / src / tex2lyx / Preamble.cpp
index 5dbd9f3a6618949e4443d98cb02cd2705b334680..4dc363b5e1c563cf14d9c05aab19cfdbb3b7ebf7 100644 (file)
@@ -44,16 +44,12 @@ Preamble preamble;
 
 namespace {
 
-//add this to known_languages when updating to lyxformat 266:
-// "armenian" (needs special handling since not supported by standard babel)
-//add these to known_languages when updating to lyxformat 268:
-//"chinese-simplified", "chinese-traditional", "japanese", "korean"
-// Both changes require first that support for non-babel languages (CJK,
-// armtex) is added.
+// "chinese-simplified", "chinese-traditional", "japanese-cjk", "korean"
+// cannot be supported because it is impossible to determine the correct document
+// language if CJK is used.
 /**
  * known babel language names (including synonyms)
  * not in standard babel: arabic, arabtex, armenian, belarusian, serbian-latin, thai
- * not yet supported by LyX: kurmanji
  * please keep this in sync with known_coded_languages line by line!
  */
 const char * const known_languages[] = {"acadian", "afrikaans", "albanian",
@@ -63,9 +59,9 @@ const char * const known_languages[] = {"acadian", "afrikaans", "albanian",
 "dutch", "english", "esperanto", "estonian", "farsi", "finnish", "francais",
 "french", "frenchb", "frenchle", "frenchpro", "galician", "german", "germanb",
 "greek", "hebrew", "hungarian", "icelandic", "indon", "indonesian", "interlingua",
-"irish", "italian", "kazakh", "latin", "latvian", "lithuanian", "lowersorbian",
-"lsorbian", "magyar", "malay", "meyalu", "mongolian", "naustrian", "newzealand",
-"ngerman", "ngermanb", "norsk", "nynorsk", "polutonikogreek", "polish",
+"irish", "italian", "japanese", "kazakh", "kurmanji", "latin", "latvian", "lithuanian",
+"lowersorbian", "lsorbian", "magyar", "malay", "meyalu", "mongolian", "naustrian",
+"newzealand", "ngerman", "ngermanb", "norsk", "nynorsk", "polutonikogreek", "polish",
 "portuges", "portuguese", "romanian", "russian", "russianb", "samin",
 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
 "swedish", "thai", "turkish", "turkmen", "ukraineb", "ukrainian",
@@ -83,9 +79,9 @@ const char * const known_coded_languages[] = {"french", "afrikaans", "albanian",
 "dutch", "english", "esperanto", "estonian", "farsi", "finnish", "french",
 "french", "french", "french", "french", "galician", "german", "german",
 "greek", "hebrew", "magyar", "icelandic", "bahasa", "bahasa", "interlingua",
-"irish", "italian", "kazakh", "latin", "latvian", "lithuanian", "lowersorbian",
-"lowersorbian", "magyar", "bahasam", "bahasam", "mongolian", "naustrian", "newzealand",
-"ngerman", "ngerman", "norsk", "nynorsk", "polutonikogreek", "polish",
+"irish", "italian", "japanese", "kazakh", "kurmanji", "latin", "latvian", "lithuanian",
+"lowersorbian", "lowersorbian", "magyar", "bahasam", "bahasam", "mongolian", "naustrian",
+"newzealand", "ngerman", "ngerman", "norsk", "nynorsk", "polutonikogreek", "polish",
 "portuguese", "portuguese", "romanian", "russian", "russian", "samin",
 "scottish", "serbian", "serbian-latin", "slovak", "slovene", "spanish",
 "swedish", "thai", "turkish", "turkmen", "ukrainian", "ukrainian",
@@ -167,16 +163,18 @@ const char * const known_if_3arg_commands[] = {"@ifundefined", "IfFileExists",
 0};
 
 /// packages that work only in xetex
+/// polyglossia is handled separately
 const char * const known_xetex_packages[] = {"arabxetex", "fixlatvian",
-"fontbook", "fontwrap", "mathspec", "philokalia", "polyglossia", "unisugar",
+"fontbook", "fontwrap", "mathspec", "philokalia", "unisugar",
 "xeCJK", "xecolor", "xecyr", "xeindex", "xepersian", "xunicode", 0};
 
 /// packages that are automatically skipped if loaded by LyX
 const char * const known_lyx_packages[] = {"amsbsy", "amsmath", "amssymb",
-"amstext", "amsthm", "array", "booktabs", "calc",
-"color", "float", "graphicx", "hhline", "ifthen", "longtable", "makeidx",
-"multirow", "nomencl", "pdfpages", "rotfloat", "splitidx", "setspace",
-"subscript", "textcomp", "ulem", "url", "varioref", "verbatim", "wrapfig", 0};
+"amstext", "amsthm", "array", "babel", "booktabs", "calc", "CJK", "color", "float",
+"fontspec", "graphicx", "hhline", "ifthen", "longtable", "makeidx", "multirow",
+"nomencl", "pdfpages", "rotating", "rotfloat", "splitidx", "setspace",
+"subscript", "textcomp", "ulem", "url", "varioref", "verbatim", "wrapfig",
+"xunicode", 0};
 
 // codes used to remove packages that are loaded automatically by LyX.
 // Syntax: package_beg_sep<name>package_mid_sep<package loading code>package_end_sep
@@ -284,6 +282,42 @@ string process_keyval_opt(vector<string> & options, string name)
 } // anonymous namespace
 
 
+/**
+ * known polyglossia language names (including variants)
+ */
+const char * const Preamble::polyglossia_languages[] = {
+"albanian", "croatian", "hebrew", "norsk", "swedish", "amharic", "czech", "hindi",
+"nynorsk", "syriac", "arabic", "danish", "icelandic", "occitan", "tamil",
+"armenian", "divehi", "interlingua", "polish", "telugu", "asturian", "dutch",
+"irish", "portuges", "thai", "bahasai", "english", "italian", "romanian", "turkish",
+"bahasam", "esperanto", "lao", "russian", "turkmen", "basque", "estonian", "latin",
+"samin", "ukrainian", "bengali", "farsi", "latvian", "sanskrit", "urdu", "brazil",
+"brazilian", "finnish", "lithuanian", "scottish", "usorbian", "breton", "french",
+"lsorbian", "serbian", "vietnamese", "bulgarian", "galician", "magyar", "slovak",
+"welsh", "catalan", "german", "malayalam", "slovenian", "coptic", "greek",
+"marathi", "spanish",
+"american", "ancient", "australian", "british", "monotonic", "newzealand",
+"polytonic", 0};
+
+/**
+ * the same as polyglossia_languages with .lyx names
+ * please keep this in sync with polyglossia_languages line by line!
+ */
+const char * const Preamble::coded_polyglossia_languages[] = {
+"albanian", "croatian", "hebrew", "norsk", "swedish", "amharic", "czech", "hindi",
+"nynorsk", "syriac", "arabic_arabi", "danish", "icelandic", "occitan", "tamil",
+"armenian", "divehi", "interlingua", "polish", "telugu", "asturian", "dutch",
+"irish", "portuges", "thai", "bahasa", "english", "italian", "romanian", "turkish",
+"bahasam", "esperanto", "lao", "russian", "turkmen", "basque", "estonian", "latin",
+"samin", "ukrainian", "bengali", "farsi", "latvian", "sanskrit", "urdu", "brazilian",
+"brazilian", "finnish", "lithuanian", "scottish", "uppersorbian", "breton", "french",
+"lowersorbian", "serbian", "vietnamese", "bulgarian", "galician", "magyar", "slovak",
+"welsh", "catalan", "ngerman", "malayalam", "slovene", "coptic", "greek",
+"marathi", "spanish",
+"american", "ancientgreek", "australian", "british", "greek", "newzealand",
+"polutonikogreek", 0};
+
+
 bool Preamble::indentParagraphs() const
 {
        return h_paragraph_separation == "indent";
@@ -340,7 +374,7 @@ Author const & Preamble::getAuthor(std::string const & name) const
 {
        Author author(from_utf8(name), empty_docstring());
        for (AuthorList::Authors::const_iterator it = authors_.begin();
-            it != authors_.end(); it++)
+            it != authors_.end(); ++it)
                if (*it == author)
                        return *it;
        static Author const dummy;
@@ -401,8 +435,10 @@ Preamble::Preamble() : one_language(true), title_layout_found(false)
        //h_backgroundcolor;
        //h_boxbgcolor;
        h_biblio_style            = "plain";
+       h_bibtex_command          = "default";
        h_cite_engine             = "basic";
        h_cite_engine_type        = "numerical";
+       h_color                   = "#008000";
        h_defskip                 = "medskip";
        //h_float_placement;
        //h_fontcolor;
@@ -417,18 +453,24 @@ Preamble::Preamble() : one_language(true), title_layout_found(false)
        h_font_sf_scale           = "100";
        h_font_tt_scale           = "100";
        h_graphics                = "default";
+       h_default_output_format   = "default";
        h_html_be_strict          = "false";
        h_html_css_as_file        = "0";
        h_html_math_output        = "0";
+       h_index                   = "Index";
+       h_index_command           = "default";
        h_inputencoding           = "auto";
        h_justification           = "true";
        h_language                = "english";
        h_language_package        = "none";
        //h_listings_params;
+       h_maintain_unincluded_children = "false";
        //h_margins;
        //h_notefontcolor;
        //h_options;
        h_output_changes          = "false";
+       h_output_sync             = "0";
+       //h_output_sync_macro
        h_papercolumns            = "1";
        h_paperfontsize           = "default";
        h_paperorientation        = "portrait";
@@ -454,6 +496,7 @@ Preamble::Preamble() : one_language(true), title_layout_found(false)
        //h_pdf_quoted_options;
        h_quotes_language         = "english";
        h_secnumdepth             = "3";
+       h_shortcut                = "idx";
        h_spacing                 = "single";
        h_suppress_date           = "false";
        h_textclass               = "article";
@@ -464,13 +507,14 @@ Preamble::Preamble() : one_language(true), title_layout_found(false)
        h_use_geometry            = "false";
        h_use_default_options     = "false";
        h_use_hyperref            = "0";
-       h_use_refstyle            = "0";
+       h_use_refstyle            = "1";
        h_use_packages["amsmath"]    = "1";
+       h_use_packages["amssymb"]    = "1";
        h_use_packages["esint"]      = "1";
-       h_use_packages["mhchem"]     = "0";
-       h_use_packages["mathdots"]   = "0";
-       h_use_packages["mathtools"]  = "0";
-       h_use_packages["undertilde"] = "0";
+       h_use_packages["mhchem"]     = "1";
+       h_use_packages["mathdots"]   = "1";
+       h_use_packages["mathtools"]  = "1";
+       h_use_packages["undertilde"] = "1";
 }
 
 
@@ -598,6 +642,7 @@ void Preamble::handle_package(Parser &p, string const & name,
        if (is_known(name, known_xetex_packages)) {
                xetex = true;
                h_use_non_tex_fonts = "true";
+               registerAutomaticallyLoadedPackage("fontspec");
                if (h_inputencoding == "auto")
                        p.setEncoding("utf8");
        }
@@ -653,10 +698,8 @@ void Preamble::handle_package(Parser &p, string const & name,
                ||      is_known(name, known_typewriter_fonts))
                ;
 
-       else if (name == "amsmath" || name == "amssymb")
-               h_use_packages["amsmath"] = "2";
-
-       else if (name == "esint" || name == "mhchem" || name == "mathdots" ||
+       else if (name == "amsmath" || name == "amssymb" ||
+                name == "esint" || name == "mhchem" || name == "mathdots" ||
                 name == "mathtools" || name == "undertilde")
                h_use_packages[name] = "2";
 
@@ -675,19 +718,51 @@ void Preamble::handle_package(Parser &p, string const & name,
                        // call as document language. If there is no such language option, the
                        // last language in the documentclass options is used.
                        handle_opt(options, known_languages, h_language);
-                       // If babel is called with options, LyX puts them by default into the
-                       // document class options. This works for most languages, except
-                       // for Latvian, Lithuanian, Mongolian, Turkmen and Vietnamese and
-                       // perhaps in future others.
-                       // Therefore keep the babel call as it is as the user might have
-                       // reasons for it.
-                       h_preamble << "\\usepackage[" << opts << "]{babel}\n";
+                       // translate the babel name to a LyX name
+                       h_language = babel2lyx(h_language);
+                       // for Japanese we assume EUC-JP as encoding
+                       // but we cannot determine the exact encoding and thus output also a note
+                       if (h_language == "japanese") {
+                               h_inputencoding = "euc";
+                               p.setEncoding("EUC-JP");
+                               is_nonCJKJapanese = true;
+                               // in this case babel can be removed from the preamble
+                               registerAutomaticallyLoadedPackage("babel");
+                       } else {
+                               // If babel is called with options, LyX puts them by default into the
+                               // document class options. This works for most languages, except
+                               // for Latvian, Lithuanian, Mongolian, Turkmen and Vietnamese and
+                               // perhaps in future others.
+                               // Therefore keep the babel call as it is as the user might have
+                               // reasons for it.
+                               h_preamble << "\\usepackage[" << opts << "]{babel}\n";
+                       }
                        delete_opt(options, known_languages);
                }
                else
                        h_preamble << "\\usepackage{babel}\n";
        }
 
+       else if (name == "polyglossia") {
+               h_language_package = "default";
+               h_default_output_format = "pdf4";
+               h_use_non_tex_fonts = "true";
+               xetex = true;
+               registerAutomaticallyLoadedPackage("xunicode");
+               if (h_inputencoding == "auto")
+                       p.setEncoding("utf8");
+       }
+
+       else if (name == "CJK") {
+               // It is impossible to determine the document language if CJK is used.
+               // All we can do is to notify the user that he has to set this by himself.
+               have_CJK = true;
+               // set the encoding to "auto" because it might be set to "default" by the babel handling
+               // and this would not be correct for CJK
+               h_inputencoding = "auto";
+               registerAutomaticallyLoadedPackage("CJK");
+       }
+
        else if (name == "fontenc") {
                h_fontencoding = getStringFromVector(options, ",");
                /* We could do the following for better round trip support,
@@ -712,6 +787,15 @@ void Preamble::handle_package(Parser &p, string const & name,
                options.clear();
        }
 
+       else if (name == "srcltx") {
+               h_output_sync = "1";
+               if (!opts.empty()) {
+                       h_output_sync_macro = "\\usepackage[" + opts + "]{srcltx}";
+                       options.clear();
+               } else
+                       h_output_sync_macro = "\\usepackage{srcltx}";
+       }
+
        else if (is_known(name, known_old_language_packages)) {
                // known language packages from the times before babel
                // if they are found and not also babel, they will be used as
@@ -811,9 +895,6 @@ void Preamble::handle_if(Parser & p, bool in_lyx_preamble)
 
 bool Preamble::writeLyXHeader(ostream & os, bool subdoc)
 {
-       // translate from babel to LyX names
-       h_language = babel2lyx(h_language);
-
        // set the quote language
        // LyX only knows the following quotes languages:
        // english, swedish, german, polish, french and danish
@@ -849,7 +930,6 @@ bool Preamble::writeLyXHeader(ostream & os, bool subdoc)
                // amsbsy and amstext are already provided by amsmath
                registerAutomaticallyLoadedPackage("amsbsy");
                registerAutomaticallyLoadedPackage("amstext");
-               registerAutomaticallyLoadedPackage("amssymb");
        }
 
        // output the LyX file settings
@@ -889,11 +969,12 @@ bool Preamble::writeLyXHeader(ostream & os, bool subdoc)
                os << "\\begin_modules\n";
                vector<string>::const_iterator const end = used_modules.end();
                vector<string>::const_iterator it = used_modules.begin();
-               for (; it != end; it++)
+               for (; it != end; ++it)
                        os << *it << '\n';
                os << "\\end_modules\n";
        }
-       os << "\\language " << h_language << "\n"
+       os << "\\maintain_unincluded_children " << h_maintain_unincluded_children << "\n"
+          << "\\language " << h_language << "\n"
           << "\\language_package " << h_language_package << "\n"
           << "\\inputencoding " << h_inputencoding << "\n"
           << "\\fontencoding " << h_fontencoding << "\n"
@@ -906,7 +987,13 @@ bool Preamble::writeLyXHeader(ostream & os, bool subdoc)
           << "\\font_osf " << h_font_osf << "\n"
           << "\\font_sf_scale " << h_font_sf_scale << "\n"
           << "\\font_tt_scale " << h_font_tt_scale << "\n"
-          << "\\graphics " << h_graphics << "\n";
+          << "\\graphics " << h_graphics << "\n"
+          << "\\default_output_format " << h_default_output_format << "\n"
+          << "\\output_sync " << h_output_sync << "\n";
+       if (h_output_sync == "1")
+               os << "\\output_sync_macro \"" << h_output_sync_macro << "\"\n";
+       os << "\\bibtex_command " << h_bibtex_command << "\n"
+          << "\\index_command " << h_index_command << "\n";
        if (!h_float_placement.empty())
                os << "\\float_placement " << h_float_placement << "\n";
        os << "\\paperfontsize " << h_paperfontsize << "\n"
@@ -938,7 +1025,7 @@ bool Preamble::writeLyXHeader(ostream & os, bool subdoc)
        os << "\\papersize " << h_papersize << "\n"
           << "\\use_geometry " << h_use_geometry << '\n';
        for (map<string, string>::const_iterator it = h_use_packages.begin();
-            it != h_use_packages.end(); it++)
+            it != h_use_packages.end(); ++it)
                os << "\\use_package " << it->first << ' ' << it->second << '\n';
        os << "\\cite_engine " << h_cite_engine << '\n'
           << "\\cite_engine_type " << h_cite_engine_type << '\n'
@@ -957,6 +1044,10 @@ bool Preamble::writeLyXHeader(ostream & os, bool subdoc)
                os << "\\backgroundcolor " << h_backgroundcolor << '\n';
        if (!h_boxbgcolor.empty())
                os << "\\boxbgcolor " << h_boxbgcolor << '\n';
+       os << "\\index " << h_index << '\n'
+          << "\\shortcut " << h_shortcut << '\n'
+          << "\\color " << h_color << '\n'
+          << "\\end_index\n";
        os << h_margins
           << "\\secnumdepth " << h_secnumdepth << "\n"
           << "\\tocdepth " << h_tocdepth << "\n"
@@ -1059,6 +1150,70 @@ void Preamble::parse(Parser & p, string const & forceclass,
                else if (t.cs() == "pagestyle")
                        h_paperpagestyle = p.verbatim_item();
 
+               else if (t.cs() == "setdefaultlanguage") {
+                       xetex = true;
+                       // We don't yet care about non-language variant options
+                       // because LyX doesn't support this yet, see bug #8214
+                       if (p.hasOpt()) {
+                               string langopts = p.getOpt();
+                               // check if the option contains a variant, if yes, extract it
+                               string::size_type pos_var = langopts.find("variant");
+                               string::size_type i = langopts.find(',', pos_var);
+                               string::size_type k = langopts.find('=', pos_var);
+                               if (pos_var != string::npos){
+                                       string variant;
+                                       if (i == string::npos)
+                                               variant = langopts.substr(k + 1, langopts.length() - k - 2);
+                                       else
+                                               variant = langopts.substr(k + 1, i - k - 1);
+                                       h_language = variant;
+                               }
+                               p.verbatim_item();
+                       } else
+                               h_language = p.verbatim_item();
+                       //finally translate the poyglossia name to a LyX name
+                       h_language = polyglossia2lyx(h_language);
+               }
+
+               else if (t.cs() == "setotherlanguage") {
+                       // We don't yet care about the option because LyX doesn't
+                       // support this yet, see bug #8214
+                       p.hasOpt() ? p.getOpt() : string();
+                       p.verbatim_item();
+               }
+
+               else if (t.cs() == "setmainfont") {
+                       // we don't care about the option
+                       p.hasOpt() ? p.getOpt() : string();
+                       h_font_roman = p.getArg('{', '}');
+               }
+
+               else if (t.cs() == "setsansfont" || t.cs() == "setmonofont") {
+                       // LyX currently only supports the scale option
+                       string scale;
+                       if (p.hasOpt()) {
+                               string fontopts = p.getArg('[', ']');
+                               // check if the option contains a scaling, if yes, extract it
+                               string::size_type pos = fontopts.find("Scale");
+                               if (pos != string::npos) {
+                                       string::size_type i = fontopts.find(',', pos);
+                                       if (i == string::npos)
+                                               scale = scale_as_percentage(fontopts.substr(pos + 1));
+                                       else
+                                               scale = scale_as_percentage(fontopts.substr(pos, i - pos));
+                               }
+                       }
+                       if (t.cs() == "setsansfont") {
+                               if (!scale.empty())
+                                       h_font_sf_scale = scale;
+                               h_font_sans = p.getArg('{', '}');
+                       } else {
+                               if (!scale.empty())
+                                       h_font_tt_scale = scale;
+                               h_font_typewriter = p.getArg('{', '}');
+                       }
+               }
+
                else if (t.cs() == "date") {
                        string argument = p.getArg('{', '}');
                        if (argument.empty())
@@ -1264,8 +1419,12 @@ void Preamble::parse(Parser & p, string const & forceclass,
 
                else if (t.cs() == "def") {
                        string name = p.get_token().cs();
+                       // In fact, name may be more than the name:
+                       // In the test case of bug 8116
+                       // name == "csname SF@gobble@opt \endcsname".
+                       // Therefore, we need to use asInput() instead of cs().
                        while (p.next_token().cat() != catBegin)
-                               name += p.get_token().cs();
+                               name += p.get_token().asInput();
                        if (!in_lyx_preamble)
                                h_preamble << "\\def\\" << name << '{'
                                           << p.verbatim_item() << "}";
@@ -1329,6 +1488,19 @@ void Preamble::parse(Parser & p, string const & forceclass,
                else if (t.cs() == "setstretch")
                        h_spacing = "other " + p.verbatim_item();
 
+               else if (t.cs() == "synctex") {
+                       // the scheme is \synctex=value
+                       // where value can only be "1" or "-1"
+                       h_output_sync = "1";
+                       // there can be any character behind the value (e.g. a linebreak or a '\'
+                       // therefore we extract it char by char
+                       p.get_token();
+                       string value = p.get_token().asInput();
+                       if (value == "-")
+                               value += p.get_token().asInput();
+                       h_output_sync_macro = "\\synctex=" + value;
+               }
+
                else if (t.cs() == "begin") {
                        string const name = p.getArg('{', '}');
                        if (name == "document")
@@ -1473,6 +1645,15 @@ string babel2lyx(string const & language)
 }
 
 
+string Preamble::polyglossia2lyx(string const & language)
+{
+       char const * const * where = is_known(language, polyglossia_languages);
+       if (where)
+               return coded_polyglossia_languages[where - polyglossia_languages];
+       return language;
+}
+
+
 string rgbcolor2code(string const & name)
 {
        char const * const * where = is_known(name, known_basic_colors);