}
-bool BufferParams::setBaseClass(string const & classname)
+void BufferParams::addDefaultModules()
{
- LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
- LayoutFileList & bcl = LayoutFileList::get();
- if (!bcl.haveClass(classname)) {
- docstring s =
- bformat(_("The document class %1$s could not be found. "
- "A default textclass with default layouts will be used. "
- "LyX might not be able to produce output unless a correct "
- "textclass is selected from the document settings dialog."),
- from_utf8(classname));
- frontend::Alert::error(_("Document class not found"), s);
- bcl.addEmptyClass(classname);
- }
-
- bool const success = bcl[classname].load();
- if (!success) {
- docstring s =
- bformat(_("The document class %1$s could not be loaded."),
- from_utf8(classname));
- frontend::Alert::error(_("Could not load class"), s);
- return false;
- }
-
- pimpl_->baseClass_ = classname;
-
// add any default modules not already in use
list<string> const & mods = baseClass()->defaultModules();
list<string>::const_iterator mit = mods.begin();
for (; mit != men; mit++) {
string const & modName = *mit;
- // see if we're already in use
- if (find(layoutModules_.begin(), layoutModules_.end(), modName) !=
- layoutModules_.end()) {
- LYXERR(Debug::TCLASS, "Default module `" << modName <<
- "' not added because already used.");
- continue;
- }
// make sure the user hasn't removed it
if (find(removedModules_.begin(), removedModules_.end(), modName) !=
removedModules_.end()) {
continue;
}
- // Now we want to check the list of selected modules to see if any of them
- // excludes this one, or if we exclude one of them.
- LyXModule * thismod = moduleList[modName];
- if (!thismod) {
- LYXERR0("Adding default module " << modName <<
- " even though it is unavailable.");
+ if (moduleCanBeAdded(modName)) {
+ LYXERR(Debug::TCLASS, "Default module `" << modName << "' added.");
modulesToAdd.push_back(modName);
+ } else
+ LYXERR(Debug::TCLASS,
+ "Default module `" << modName << "' could not be added.");
+ }
+
+ // OK, now we can add the default modules.
+ layoutModules_.insert(
+ layoutModules_.begin(), modulesToAdd.begin(), modulesToAdd.end());
+}
+
+
+bool BufferParams::checkModuleConsistency() {
+ bool consistent = true;
+ // Perform a consistency check on the set of modules.
+ // In particular, we need to check that modules provided by this class
+ // do not conflict with modules chosen by the user.
+ list<string> oldModules = getModules();
+ clearLayoutModules();
+ list<string>::const_iterator oit = oldModules.begin();
+ list<string>::const_iterator oen = oldModules.end();
+ list<string> const & provmods = baseClass()->providedModules();
+ list<string> const & exclmods = baseClass()->excludedModules();
+ for (; oit != oen; ++oit) {
+ string const & modname = *oit;
+ // skip modules that the class provides
+ if (find(provmods.begin(), provmods.end(), modname) != provmods.end()) {
+ consistent = false;
+ LYXERR0("Module " << modname << " dropped because provided by document class.");
+ continue;
+ }
+ // are we excluded by the document class?
+ if (find(exclmods.begin(), exclmods.end(), modname) != exclmods.end()) {
+ consistent = false;
+ LYXERR0("Module " << modname << " dropped because excluded by document class.");
continue;
}
- bool foundit = false;
- vector<string> const ourExcMods = thismod->getExcludedModules();
- vector<string>::const_iterator const eit = ourExcMods.begin();
- vector<string>::const_iterator const een = ourExcMods.end();
-
- // so iterate over the selected modules...
- LayoutModuleList::const_iterator lit = layoutModules_.begin();
- LayoutModuleList::const_iterator const len = layoutModules_.end();
- for (; lit != len; lit++) {
- LyXModule * lm = moduleList[*lit];
- if (!lm)
- continue;
- vector<string> const & exc = lm->getExcludedModules();
- // ...and see if this one excludes us.
- if (find(exc.begin(), exc.end(), modName) != exc.end()) {
- foundit = true;
- LYXERR(Debug::TCLASS, "Default module `" << modName <<
- "' not added because excluded by loaded module `" <<
- *lit << "'.");
- break;
+ // determine whether some provided module excludes us or we exclude it
+ list<string>::const_iterator pit = provmods.begin();
+ list<string>::const_iterator pen = provmods.end();
+ bool excluded = false;
+ for (; !excluded && pit != pen; ++pit) {
+ if (!LyXModule::areCompatible(modname, *pit)) {
+ consistent = false;
+ LYXERR0("Module " << modname <<
+ " dropped becuase it conflicts with provided module " << *pit);
+ excluded = true;
}
- if (find(eit, een, *lit) != een) {
- foundit = true;
- LYXERR(Debug::TCLASS, "Default module `" << modName <<
- "' not added because it excludes loaded module `" <<
- *lit << "'.");
- break;
+ }
+
+ if (excluded)
+ continue;
+
+ // Determine whether some prior module excludes us, or we exclude it
+ list<string>::const_iterator lit = layoutModules_.begin();
+ list<string>::const_iterator len = layoutModules_.end();
+ for (; !excluded && lit != len; ++lit) {
+ if (!LyXModule::areCompatible(modname, *lit)) {
+ consistent = false;
+ LYXERR0("Module " << modname <<
+ " dropped because it is excluded by prior module " << *lit);
+ excluded = true;
}
}
- if (!foundit) {
- LYXERR(Debug::TCLASS, "Default module `" << modName << "' added.");
- modulesToAdd.push_back(modName);
+ if (excluded)
+ continue;
+
+ // determine whether some provided module or some prior module
+ // satisfies our requirements
+ LyXModule const * const oldmod = moduleList[modname];
+ if (!oldmod) {
+ LYXERR0("Default module " << modname <<
+ " added although it is unavailable and can't check requirements.");
+ continue;
+ }
+
+ vector<string> const & reqs = oldmod->getRequiredModules();
+ if (!reqs.empty()) {
+ // we now set excluded to true, meaning that we haven't
+ // yet found a required module.
+ excluded = true;
+ vector<string>::const_iterator rit = reqs.begin();
+ vector<string>::const_iterator ren = reqs.end();
+ for (; rit != ren; ++rit) {
+ string const reqmod = *rit;
+ if (find(provmods.begin(), provmods.end(), reqmod) !=
+ provmods.end()) {
+ excluded = false;
+ break;
+ }
+ if (find(layoutModules_.begin(), layoutModules_.end(), reqmod) !=
+ layoutModules_.end()) {
+ excluded = false;
+ break;
+ }
+ }
+ }
+ if (excluded) {
+ consistent = false;
+ LYXERR0("Module " << modname << " dropped because requirements not met.");
+ } else {
+ LYXERR(Debug::TCLASS, "Module " << modname << " passed consistency check.");
+ layoutModules_.push_back(modname);
}
}
+ return consistent;
+}
+
+
+bool BufferParams::setBaseClass(string const & classname)
+{
+ LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
+ LayoutFileList & bcl = LayoutFileList::get();
+ if (!bcl.haveClass(classname)) {
+ docstring s =
+ bformat(_("The document class %1$s could not be found. "
+ "A default textclass with default layouts will be used. "
+ "LyX might not be able to produce output unless a correct "
+ "textclass is selected from the document settings dialog."),
+ from_utf8(classname));
+ frontend::Alert::error(_("Document class not found"), s);
+ bcl.addEmptyClass(classname);
+ }
+
+ bool const success = bcl[classname].load();
+ if (!success) {
+ docstring s =
+ bformat(_("The document class %1$s could not be loaded."),
+ from_utf8(classname));
+ frontend::Alert::error(_("Could not load class"), s);
+ return false;
+ }
+
+ pimpl_->baseClass_ = classname;
+ addDefaultModules();
+ checkModuleConsistency();
- layoutModules_.insert(layoutModules_.begin(), modulesToAdd.begin(), modulesToAdd.end());
return true;
}
}
-bool BufferParams::addLayoutModule(string const & modName)
+bool BufferParams::moduleCanBeAdded(string const & modName) const
+{
+ // Is the module already present?
+ LayoutModuleList::const_iterator it = layoutModules_.begin();
+ LayoutModuleList::const_iterator end = layoutModules_.end();
+ for (; it != end; it++)
+ if (*it == modName)
+ return false;
+
+ LyXModule const * const lm = moduleList[modName];
+ if (!lm)
+ return true;
+
+ // Is this module explicitly excluded by the document class?
+ list<string>::const_iterator const exclmodstart =
+ baseClass()->excludedModules().begin();
+ list<string>::const_iterator const exclmodend =
+ baseClass()->excludedModules().end();
+ if (find(exclmodstart, exclmodend, modName) != exclmodend)
+ return false;
+
+ // Is this module already provided by the document class?
+ list<string>::const_iterator const provmodstart =
+ baseClass()->providedModules().begin();
+ list<string>::const_iterator const provmodend =
+ baseClass()->providedModules().end();
+ if (find(provmodstart, provmodend, modName) != provmodend)
+ return false;
+
+ // Check for conflicts with used modules
+ // first the provided modules...
+ list<string>::const_iterator provmodit = provmodstart;
+ for (; provmodit != provmodend; ++provmodit) {
+ if (!LyXModule::areCompatible(modName, *provmodit))
+ return false;
+ }
+ // and then the selected modules
+ LayoutModuleList::const_iterator mit = getModules().begin();
+ LayoutModuleList::const_iterator const men = getModules().end();
+ for (; mit != men; ++mit)
+ if (!LyXModule::areCompatible(modName, *mit))
+ return false;
+
+ // Check whether some required module is available
+ vector<string> const reqs = lm->getRequiredModules();
+ if (reqs.empty())
+ return true;
+
+ mit = getModules().begin(); // reset
+ vector<string>::const_iterator rit = reqs.begin();
+ vector<string>::const_iterator ren = reqs.end();
+ bool foundone = false;
+ for (; rit != ren; ++rit) {
+ if (find(mit, men, *rit) != men ||
+ find(provmodstart, provmodend, *rit) != provmodend) {
+ foundone = true;
+ break;
+ }
+ }
+
+ return foundone;
+}
+
+
+bool BufferParams::addLayoutModule(string const & modName)
{
LayoutModuleList::const_iterator it = layoutModules_.begin();
LayoutModuleList::const_iterator end = layoutModules_.end();
projects / lyx.git / blobdiff