]> git.lyx.org Git - features.git/commitdiff
tex2lyx: improve module support
authorJuergen Spitzmueller <spitz@lyx.org>
Thu, 4 Apr 2019 13:46:49 +0000 (15:46 +0200)
committerJuergen Spitzmueller <spitz@lyx.org>
Thu, 4 Apr 2019 14:01:07 +0000 (16:01 +0200)
The current heuristics only considered modules with styles that defined
a searched command in their preamble, and only for commands/environments
that were defined in the document's preamble. This limited the module
support drastically.

The new heuristics also checks for commands coming from packages. If the
command is not (re-)defined in the document preamble, it checks modules
that provide a style with a matching LaTeXName, checks for their
requirements and matches those with the packages loaded by the document.

If no module provides a searched style, but we found modules that load
packages that are loaded in the imported tex file, and if those packages
are not auto-loaded by LyX anyway, we also load this module.

fixes: #11259, part of #8229

src/tex2lyx/Preamble.cpp
src/tex2lyx/Preamble.h
src/tex2lyx/TODO.txt
src/tex2lyx/test/test-modules.lyx.lyx
src/tex2lyx/test/test-structure.lyx.lyx
src/tex2lyx/tex2lyx.cpp

index b0ac77970b3ff30d33f0f57fff90c0c17dfd229d..39298851d153dd68d86bd241e2f0940d1f2281c6 100644 (file)
@@ -373,6 +373,12 @@ bool Preamble::isPackageUsed(string const & package) const
 }
 
 
+bool Preamble::isPackageAutoLoaded(string const & package) const
+{
+       return auto_packages.find(package) != auto_packages.end();
+}
+
+
 vector<string> Preamble::getPackageOptions(string const & package) const
 {
        map<string, vector<string> >::const_iterator it = used_packages.find(package);
@@ -390,6 +396,10 @@ void Preamble::registerAutomaticallyLoadedPackage(std::string const & package)
 
 void Preamble::addModule(string const & module)
 {
+       for (auto const & m : used_modules) {
+               if (m == module)
+                       return;
+       }               
        used_modules.push_back(module);
 }
 
@@ -998,8 +1008,10 @@ void Preamble::handle_package(Parser &p, string const & name,
        else if (name == "amsmath" || name == "amssymb" || name == "cancel" ||
                 name == "esint" || name == "mhchem" || name == "mathdots" ||
                 name == "mathtools" || name == "stackrel" ||
-                name == "stmaryrd" || name == "undertilde")
+                name == "stmaryrd" || name == "undertilde") {
                h_use_packages[name] = "2";
+               registerAutomaticallyLoadedPackage(name);
+       }
 
        else if (name == "babel") {
                h_language_package = "default";
index 63b812bd868256ed0164b43b9ef199825a46e8b4..6c11d889c32c644c73ddac08957270954a9743ce 100644 (file)
@@ -67,6 +67,8 @@ public:
        ///
        bool isPackageUsed(std::string const & package) const;
        ///
+       bool isPackageAutoLoaded(std::string const & package) const;
+       ///
        std::vector<std::string>
        getPackageOptions(std::string const & package) const;
        /// Tell that \p package will be loaded automatically by LyX.
index 1706ef4f54aab8bde8bb32216a321832e6b4b942..d1760ace5105a2601b6b0b033f75e14e32af6e40 100644 (file)
@@ -39,8 +39,6 @@ Format LaTeX feature                        LyX feature
 
 General
 
-* Consider layouts in modules that do not have a preamble definition (see #11259).
-
 * Use the language information provided by Language.cpp and the languages file (for babel/lyx/polyglossia name, quote style etc.)
   instead of hardcoding this information in Preamble.cpp.
 
index bd854499c455c5f245807e532f3ea1b196b74d1b..ea4560996e4f508c098ebaffdffa599465029419 100644 (file)
@@ -106,32 +106,8 @@ theorem.
 The proof is recognized as a builtin style provided by the text class.
 \end_layout
 
-\begin_layout Standard
-
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-begin{lem}
-\end_layout
-
-\end_inset
-
- this is a lemma
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-end{lem}
-\end_layout
-
-\end_inset
-
+\begin_layout Lemma
+this is a lemma
 \end_layout
 
 \begin_layout Theorem
index b148b1cabb3bb726b7ea69914700a5df8b1afc1b..6c4e9c77ac5d8bee65cb6b8cee4fb8eb58518752 100644 (file)
@@ -43,6 +43,7 @@
 \options dummyoption
 \use_default_options false
 \begin_modules
+fixltx2e
 logicalmkup
 \end_modules
 \maintain_unincluded_children false
index 6437d9902de82e68162cc4b5677fe643edcfa5a6..03330342452fcd40c8fdccc610be35058406ffe2 100644 (file)
@@ -321,17 +321,18 @@ bool checkModule(string const & name, bool command)
        // Cache to avoid slowdown by repated searches
        static set<string> failed[2];
 
-       // Only add the module if the command was actually defined in the LyX preamble
+       // Record whether the command was actually defined in the LyX preamble
        bool theorem = false;
+       bool preamble_def = true;
        if (command) {
                if (possible_textclass_commands.find('\\' + name) == possible_textclass_commands.end())
-                       return false;
+                       preamble_def = false;
        } else {
                if (possible_textclass_environments.find(name) == possible_textclass_environments.end()) {
                        if (possible_textclass_theorems.find(name) != possible_textclass_theorems.end())
                                theorem = true;
                        else
-                               return false;
+                               preamble_def = false;
                }
        }
        if (failed[command].find(name) != failed[command].end())
@@ -341,12 +342,16 @@ bool checkModule(string const & name, bool command)
        LayoutFile const & baseClass = LayoutFileList::get()[textclass.name()];
 
        // Try to find a module that defines the command.
-       // Only add it if the definition can be found in the preamble of the
-       // style that corresponds to the command. This is a heuristic and
-       // different from the way how we parse the builtin commands of the
-       // text class (in that case we only compare the name), but it is
-       // needed since it is not unlikely that two different modules define a
+       // For commands with preamble definitions we prefer modules where the definition
+       // can be found in the preamble of the style that corresponds to the command. 
+       // For others we check whether the command or module requires a package that is loaded
+       // in the tex file and use a style with the respective command.
+       // This is a heuristic and different from the way how we parse the builtin
+       // commands of the text class (in that case we only compare the name), 
+       // but it is needed since it is not unlikely that two different modules define a
        // command with the same name.
+       string found_module;
+       vector<string> potential_modules;
        ModuleMap::iterator const end = modules.end();
        for (ModuleMap::iterator it = modules.begin(); it != end; ++it) {
                string const module = it->first;
@@ -358,53 +363,102 @@ bool checkModule(string const & name, bool command)
                        continue;
                DocumentClassConstPtr c = it->second;
                Layout const * layout = findLayoutWithoutModule(*c, name, command);
-               InsetLayout const * insetlayout = layout ? 0 :
+               InsetLayout const * insetlayout = layout ? nullptr :
                        findInsetLayoutWithoutModule(*c, name, command);
                docstring dpre;
-               if (layout)
+               std::set<std::string> cmd_reqs;
+               bool found_style = false;
+               if (layout) {
+                       found_style = true;
                        dpre = layout->preamble();
-               else if (insetlayout)
+                       std::set<std::string> lreqs = layout->requires();
+                       if (!lreqs.empty())
+                               cmd_reqs.insert(lreqs.begin(), lreqs.end());
+               } else if (insetlayout) {
+                       found_style = true;
                        dpre = insetlayout->preamble();
-               if (dpre.empty())
+                       std::set<std::string> lreqs = insetlayout->requires();
+                       if (!lreqs.empty())
+                               cmd_reqs.insert(lreqs.begin(), lreqs.end());
+               }
+               if (dpre.empty() && preamble_def)
                        continue;
-               bool add = false;
-               if (command) {
-                       FullCommand const & cmd =
-                               possible_textclass_commands['\\' + name];
-                       if (dpre.find(cmd.def) != docstring::npos)
-                               add = true;
-               } else if (theorem) {
-                       FullCommand const & thm =
-                               possible_textclass_theorems[name];
-                       if (dpre.find(thm.def) != docstring::npos)
-                               add = true;
-               } else {
-                       FullEnvironment const & env =
-                               possible_textclass_environments[name];
-                       if (dpre.find(env.beg) != docstring::npos &&
-                           dpre.find(env.end) != docstring::npos)
-                               add = true;
+               bool const package_cmd = dpre.empty();
+               bool match_req = false;
+               if (package_cmd) {
+                       std::set<std::string> mreqs = it->second->requires();
+                       if (!mreqs.empty())
+                               cmd_reqs.insert(mreqs.begin(), mreqs.end());
+                       for (auto const & pack : cmd_reqs) {
+                               // If a requirement of the module matches a used package
+                               // we load the module except if we have an auto-loaded package
+                               // which is only required generally by the module, and the module
+                               // does not provide the [inset]layout we are looking for.
+                               // This heuristics should
+                               // * load modules if the provide a style we don't have in the class
+                               // * load modules that provide a package support generally (such as fixltx2e)
+                               // * not unnecessarily load modules just because they require a package which we
+                               //   load anyway.
+                               if (preamble.isPackageUsed(pack)
+                                   && (found_style || !preamble.isPackageAutoLoaded(pack))) {
+                                   if (found_style)
+                                           match_req = true;
+                                   else                
+                                           potential_modules.push_back(module);
+                                   break;
+                               }
+                       }
+               }
+               bool add = match_req;
+               if (preamble_def) {
+                       if (command) {
+                               FullCommand const & cmd =
+                                       possible_textclass_commands['\\' + name];
+                               if (dpre.find(cmd.def) != docstring::npos)
+                                       add = true;
+                       } else if (theorem) {
+                               FullCommand const & thm =
+                                       possible_textclass_theorems[name];
+                               if (dpre.find(thm.def) != docstring::npos)
+                                       add = true;
+                       } else {
+                               FullEnvironment const & env =
+                                       possible_textclass_environments[name];
+                               if (dpre.find(env.beg) != docstring::npos &&
+                                   dpre.find(env.end) != docstring::npos)
+                                       add = true;
+                       }
                }
                if (add) {
-                       vector<string> v;
-                       LayoutModuleList mods;
-                       // addModule is necessary in order to catch required modules
-                       // as well (see #11156)
-                       if (!addModule(module, baseClass, mods, v))
+                       found_module = module;
+                       break;
+               }
+       }
+       if (found_module.empty()) {
+               // take one of the second row
+               if (!potential_modules.empty())
+                       found_module = potential_modules.front();  
+       }
+               
+       if (!found_module.empty()) {
+               vector<string> v;
+               LayoutModuleList mods;
+               // addModule is necessary in order to catch required modules
+               // as well (see #11156)
+               if (!addModule(found_module, baseClass, mods, v))
+                       return false;
+               for (auto const & mod : mods) {
+                       if (!used_modules.moduleCanBeAdded(mod, &baseClass))
                                return false;
-                       for (auto const & mod : mods) {
-                               if (!used_modules.moduleCanBeAdded(mod, &baseClass))
-                                       return false;
-                               FileName layout_file = libFileSearch("layouts", mod, "module");
-                               if (textclass.read(layout_file, TextClass::MODULE)) {
-                                       used_modules.push_back(mod);
-                                       // speed up further searches:
-                                       // the module does not need to be checked anymore.
-                                       ModuleMap::iterator const it = modules.find(mod);
-                                       if (it != modules.end())
-                                               modules.erase(it);
-                                       return true;
-                               }
+                       FileName layout_file = libFileSearch("layouts", mod, "module");
+                       if (textclass.read(layout_file, TextClass::MODULE)) {
+                               used_modules.push_back(mod);
+                               // speed up further searches:
+                               // the module does not need to be checked anymore.
+                               ModuleMap::iterator const it = modules.find(mod);
+                               if (it != modules.end())
+                                       modules.erase(it);
+                               return true;
                        }
                }
        }