+ if (!definition.empty())
+ possible_textclass_commands[command] =
+ FullCommand(arguments, definition);
+}
+
+
+void add_known_environment(string const & environment, string const & o1,
+ bool o2, docstring const & beg, docstring const &end)
+{
+ vector<ArgumentType> arguments;
+ convertArgs(o1, o2, arguments);
+ known_environments[environment] = arguments;
+ if (!beg.empty() || ! end.empty())
+ possible_textclass_environments[environment] =
+ FullEnvironment(arguments, beg, end);
+}
+
+
+void add_known_theorem(string const & theorem, string const & o1,
+ bool o2, docstring const & definition)
+{
+ vector<ArgumentType> arguments;
+ convertArgs(o1, o2, arguments);
+ if (!definition.empty())
+ possible_textclass_theorems[theorem] =
+ FullCommand(arguments, definition);
+}
+
+
+Layout const * findLayoutWithoutModule(TextClass const & tc,
+ string const & name, bool command,
+ string const & latexparam)
+{
+ for (auto const & lay : tc) {
+ if (lay.latexname() == name &&
+ (latexparam.empty() ||
+ (!lay.latexparam().empty() && suffixIs(latexparam, lay.latexparam()))) &&
+ ((command && lay.isCommand()) || (!command && lay.isEnvironment())))
+ return &lay;
+ }
+ return 0;
+}
+
+
+InsetLayout const * findInsetLayoutWithoutModule(TextClass const & tc,
+ string const & name, bool command,
+ string const & latexparam)
+{
+ for (auto const & ilay : tc.insetLayouts()) {
+ if (ilay.second.latexname() == name &&
+ (latexparam.empty() ||
+ (!ilay.second.latexparam().empty() && suffixIs(latexparam, ilay.second.latexparam()))) &&
+ ((command && ilay.second.latextype() == InsetLayout::COMMAND) ||
+ (!command && ilay.second.latextype() == InsetLayout::ENVIRONMENT)))
+ return &(ilay.second);
+ }
+ return 0;
+}
+
+
+namespace {
+
+typedef map<string, DocumentClassPtr> ModuleMap;
+ModuleMap modules;
+
+
+bool addModule(string const & module, LayoutFile const & baseClass, LayoutModuleList & m, vector<string> & visited)
+{
+ // avoid endless loop for circular dependency
+ vector<string>::const_iterator const vb = visited.begin();
+ vector<string>::const_iterator const ve = visited.end();
+ if (find(vb, ve, module) != ve) {
+ cerr << "Circular dependency detected for module " << module << '\n';
+ return false;
+ }
+ LyXModule const * const lm = theModuleList[module];
+ if (!lm) {
+ cerr << "Could not find module " << module << " in module list.\n";
+ return false;
+ }
+ bool foundone = false;
+ LayoutModuleList::const_iterator const exclmodstart = baseClass.excludedModules().begin();
+ LayoutModuleList::const_iterator const exclmodend = baseClass.excludedModules().end();
+ LayoutModuleList::const_iterator const provmodstart = baseClass.providedModules().begin();
+ LayoutModuleList::const_iterator const provmodend = baseClass.providedModules().end();
+ vector<string> const reqs = lm->getRequiredModules();
+ if (reqs.empty())
+ foundone = true;
+ else {
+ LayoutModuleList::const_iterator mit = m.begin();
+ LayoutModuleList::const_iterator men = m.end();
+ vector<string>::const_iterator rit = reqs.begin();
+ vector<string>::const_iterator ren = reqs.end();
+ for (; rit != ren; ++rit) {
+ if (find(mit, men, *rit) != men) {
+ foundone = true;
+ break;
+ }
+ if (find(provmodstart, provmodend, *rit) != provmodend) {
+ foundone = true;
+ break;
+ }
+ }
+ if (!foundone) {
+ visited.push_back(module);
+ for (rit = reqs.begin(); rit != ren; ++rit) {
+ if (find(exclmodstart, exclmodend, *rit) == exclmodend) {
+ if (addModule(*rit, baseClass, m, visited)) {
+ foundone = true;
+ break;
+ }
+ }
+ }
+ visited.pop_back();
+ }
+ }
+ if (!foundone) {
+ cerr << "Could not add required modules for " << module << ".\n";
+ return false;
+ }
+ if (!m.moduleCanBeAdded(module, &baseClass))
+ return false;
+ m.push_back(module);
+ return true;
+}
+
+
+void initModules()
+{
+ // Create list of dummy document classes if not already done.
+ // This is needed since a module cannot be read on its own, only as
+ // part of a document class.
+ LayoutFile const & baseClass = LayoutFileList::get()[textclass.name()];
+ static bool init = true;
+ if (init) {
+ baseClass.load();
+ LyXModuleList::const_iterator const end = theModuleList.end();
+ LyXModuleList::const_iterator it = theModuleList.begin();
+ for (; it != end; ++it) {
+ string const module = it->getID();
+ LayoutModuleList m;
+ vector<string> v;
+ if (!addModule(module, baseClass, m, v))
+ continue;
+ modules[module] = getDocumentClass(baseClass, m);
+ }
+ init = false;
+ }
+}
+
+
+bool addModule(string const & module)
+{
+ initModules();
+ LayoutFile const & baseClass = LayoutFileList::get()[textclass.name()];
+ if (!used_modules.moduleCanBeAdded(module, &baseClass))
+ return false;
+ FileName layout_file = libFileSearch("layouts", module, "module");
+ if (textclass.read(layout_file, TextClass::MODULE)) {
+ used_modules.push_back(module);
+ // speed up further searches:
+ // the module does not need to be checked anymore.
+ ModuleMap::iterator const it = modules.find(module);
+ if (it != modules.end())
+ modules.erase(it);
+ return true;
+ }
+ return false;
+}
+
+} // namespace
+
+
+bool checkModule(string const & name, bool command)
+{
+ // Cache to avoid slowdown by repated searches
+ static set<string> failed[2];
+
+ // 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())
+ 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
+ preamble_def = false;
+ }
+ }
+ if (failed[command].find(name) != failed[command].end())
+ return false;
+
+ initModules();
+ LayoutFile const & baseClass = LayoutFileList::get()[textclass.name()];
+
+ // Try to find a module that defines the command.
+ // 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;
+ if (used_modules.moduleConflicts(module, &baseClass))
+ continue;
+ if (findLayoutWithoutModule(textclass, name, command))
+ continue;
+ if (findInsetLayoutWithoutModule(textclass, name, command))
+ continue;
+ DocumentClassConstPtr c = it->second;
+ Layout const * layout = findLayoutWithoutModule(*c, name, command);
+ InsetLayout const * insetlayout = layout ? nullptr :
+ findInsetLayoutWithoutModule(*c, name, command);
+ docstring dpre;
+ std::set<std::string> cmd_reqs;
+ bool found_style = false;
+ if (layout) {
+ found_style = true;
+ dpre = layout->preamble();
+ std::set<std::string> lreqs = layout->required();
+ if (!lreqs.empty())
+ cmd_reqs.insert(lreqs.begin(), lreqs.end());
+ } else if (insetlayout) {
+ found_style = true;
+ dpre = insetlayout->preamble();
+ std::set<std::string> lreqs = insetlayout->required();
+ if (!lreqs.empty())
+ cmd_reqs.insert(lreqs.begin(), lreqs.end());
+ }
+ if (dpre.empty() && preamble_def)
+ continue;
+ bool const package_cmd = dpre.empty();
+ bool match_req = false;
+ if (package_cmd) {
+ std::set<std::string> mreqs = it->second->required();
+ 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) {
+ 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;
+ 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;
+ }
+ }
+ }
+ failed[command].insert(name);
+ return false;
+}
+
+
+bool isProvided(string const & name)
+{
+ // This works only for features that are named like the LaTeX packages
+ return textclass.provides(name) || preamble.isPackageUsed(name);