* Licence details can be found in the file COPYING.
*
* \author Alfredo Braunstein
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
* \author John Levon
- * \author André Pönitz
+ * \author André Pönitz
* \author Martin Vermeer
*
* Full author contact details are available in file CREDITS.
}
-void BufferParams::removeExcludedModules()
+bool BufferParams::removeBadModules()
{
- // remove any modules the new base class excludes
+ // we'll write a new list of modules, since we can't just remove them,
+ // as that would invalidate our iterators
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();
+ bool consistent = true; // set to false if we have to do anything
+
+ list<string>::const_iterator oit = oldModules.begin();
+ list<string>::const_iterator const oen = oldModules.end();
for (; oit != oen; ++oit) {
string const & modname = *oit;
+ // skip modules that the class provides
+ if (find(provmods.begin(), provmods.end(), modname) != provmods.end()) {
+ LYXERR0("Module `" << modname << "' dropped because provided by document class.");
+ consistent = false;
+ continue;
+ }
// are we excluded by the document class?
if (find(exclmods.begin(), exclmods.end(), modname) != exclmods.end()) {
- LYXERR0("Module " << modname << " dropped because excluded by document class.");
+ LYXERR0("Module `" << modname << "' dropped because excluded by document class.");
+ consistent = false;
continue;
}
// 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();
+ list<string>::const_iterator const pen = provmods.end();
bool excluded = false;
for (; !excluded && pit != pen; ++pit) {
if (!LyXModule::areCompatible(modname, *pit)) {
LYXERR0("Module " << modname <<
- " dropped becuase it conflicts with provided module " << *pit);
+ " dropped becuase it conflicts with provided module `" << *pit << "'.");
+ consistent = false;
excluded = true;
}
}
if (excluded)
continue;
- layoutModules_.push_back(*oit);
+ layoutModules_.push_back(modname);
}
+ return consistent;
}
list<string>::const_iterator mit = mods.begin();
list<string>::const_iterator men = mods.end();
- // we want to add these to the front, but in the right order,
- // so we collect them here first.
- list<string> modulesToAdd;
+ // We want to insert the default modules at the beginning of
+ // the list, but also to insert them in the correct order.
+ // The obvious thing to do would be to collect them and then
+ // insert them, but that doesn't work because a later default
+ // module may require an earlier one, and then the test below
+ // moduleCanBeAdded(modname)
+ // will fail. So we have to do it a more complicated way.
+ list<string>::iterator insertpos = layoutModules_.begin();
+ int numinserts = 0;
for (; mit != men; mit++) {
string const & modName = *mit;
continue;
}
- 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.");
+ if (!moduleCanBeAdded(modName)) {
+ // FIXME This could be because it's already present, so we should
+ // probably return something indicating that.
+ LYXERR(Debug::TCLASS, "Default module `" << modName <<
+ "' could not be added.");
+ continue;
+ }
+ LYXERR(Debug::TCLASS, "Default module `" << modName << "' added.");
+ layoutModules_.insert(insertpos, modName);
+ // now we reset insertpos
+ ++numinserts;
+ insertpos = layoutModules_.begin();
+ advance(insertpos, numinserts);
}
-
- // 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.
+ // Perform a consistency check on the set of modules. We need to make
+ // sure that none of the modules exclude each other and that requires
+ // are satisfied.
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?
- // FIXME This can probably be removed, since removeExcludedModules ought
- // already to have done this test.
- if (find(exclmods.begin(), exclmods.end(), modname) != exclmods.end()) {
- consistent = false;
- LYXERR0("WARNING: Module " << modname << " should already have been dropped!");
- continue;
- }
-
- // 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 (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();
// moment. (Thanks to Philippe Charpentier for helping work out all
// the bugs---rgh.)
//
- // first, we remove any modules the new document class excludes
- removeExcludedModules();
- // next, we add any default modules the new class provides
+ // first, we remove any modules the new document class itself provides,
+ // those it excludes, and those that conflict with ones it excludes.
+ // this has to be done first because, otherwise, a module we're about
+ // to remove could prevent a default module from being added.
+ removeBadModules();
+ // next, we add any default modules the new class provides.
addDefaultModules();
// finally, we perform a general consistency check on the set of
- // loaded modules
+ // loaded modules.
checkModuleConsistency();
+ // FIXME removeBadModules() and checkModuleConsistency() both return
+ // a boolean indicating whether something had to be changed. It might
+ // be worth popping a message to the user if so.
return true;
}
projects / lyx.git / blobdiff