anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-12-22 05:16:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Move some more code around so as to make module-related routines available

Browse Source 
to tex2lyx.



git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@28574 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Richard Heck 2009-02-21 16:45:37 +00:00
parent aedfb81808
commit f946b6ed0b
5 changed files with 41 additions and 257 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

245
src/BufferParams.cpp
View File

@ -1480,167 +1480,6 @@ void BufferParams::setDocumentClass(DocumentClass const * const tc) {
}
bool BufferParams::removeBadModules()
{
// we'll write a new list of modules, since we can't just remove them,
// as that would invalidate our iterators
LayoutModuleList oldModules = layoutModules_;
clearLayoutModules();
LayoutModuleList const & provmods = baseClass()->providedModules();
LayoutModuleList const & exclmods = baseClass()->excludedModules();
bool consistent = true; // set to false if we have to do anything
LayoutModuleList::const_iterator oit = oldModules.begin();
LayoutModuleList::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.");
consistent = false;
continue;
}
// determine whether some provided module excludes us or we exclude it
LayoutModuleList::const_iterator pit = provmods.begin();
LayoutModuleList::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 << "'.");
consistent = false;
excluded = true;
}
}
if (excluded)
continue;
layoutModules_.push_back(modname);
}
return consistent;
}
void BufferParams::addDefaultModules()
{
// add any default modules not already in use
LayoutModuleList const & mods = baseClass()->defaultModules();
LayoutModuleList::const_iterator mit = mods.begin();
LayoutModuleList::const_iterator men = mods.end();
// 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.
LayoutModuleList::iterator insertpos = layoutModules_.begin();
int numinserts = 0;
for (; mit != men; mit++) {
string const & modName = *mit;
// make sure the user hasn't removed it
if (find(removedModules_.begin(), removedModules_.end(), modName) !=
removedModules_.end()) {
LYXERR(Debug::TCLASS, "Default module `" << modName <<
"' not added because removed by user.");
continue;
}
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);
}
}
// 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.
bool BufferParams::checkModuleConsistency() {
bool consistent = true;
LayoutModuleList oldModules = layoutModules_;
clearLayoutModules();
LayoutModuleList::const_iterator oit = oldModules.begin();
LayoutModuleList::const_iterator oen = oldModules.end();
LayoutModuleList const & provmods = baseClass()->providedModules();
for (; oit != oen; ++oit) {
string const & modname = *oit;
bool excluded = false;
// Determine whether some prior module excludes us, or we exclude it
LayoutModuleList::const_iterator lit = layoutModules_.begin();
LayoutModuleList::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 (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);
@ -1666,28 +1505,7 @@ bool BufferParams::setBaseClass(string const & classname)
}
pimpl_->baseClass_ = classname;
// the previous document class may have loaded some modules that the
// new one excludes, and the new class may provide, etc, some that
// conflict with ones that were already loaded. So we need to go
// through the list and fix everything. I suppose there are various
// ways this could be done, but the following seems to work at the
// moment. (Thanks to Philippe Charpentier for helping work out all
// the bugs---rgh.)
//
// 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.
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.
layoutModules_.adaptToBaseClass(baseClass(), removedModules_);
return true;
}
@ -1722,68 +1540,9 @@ void BufferParams::makeDocumentClass()
}
}
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?
LayoutModuleList::const_iterator const exclmodstart =
baseClass()->excludedModules().begin();
LayoutModuleList::const_iterator const exclmodend =
baseClass()->excludedModules().end();
if (find(exclmodstart, exclmodend, modName) != exclmodend)
return false;
// Is this module already provided by the document class?
LayoutModuleList::const_iterator const provmodstart =
baseClass()->providedModules().begin();
LayoutModuleList::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...
LayoutModuleList::const_iterator provmodit = provmodstart;
for (; provmodit != provmodend; ++provmodit) {
if (!LyXModule::areCompatible(modName, *provmodit))
return false;
}
// and then the selected modules
LayoutModuleList::const_iterator mit = layoutModules_.begin();
LayoutModuleList::const_iterator const men = layoutModules_.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 = layoutModules_.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;
return layoutModules_.moduleCanBeAdded(modName, baseClass());
}

14
src/BufferParams.h
View File

@ -345,20 +345,6 @@ private:
void readModules(Lexer &);
///
void readRemovedModules(Lexer &);
/// Called when the document class changes. Removes modules
/// excluded by, provided by, etc, the document class.
/// \return true if modules were consistent, false if changes had
/// to be made.
bool removeBadModules();
/// Adds default modules, if they're addable.
void addDefaultModules();
/// checks for consistency among modules: makes sure requirements
/// are met, no modules exclude one another, etc, and resolves any
/// such conflicts, leaving us with a consistent collection.
/// \return true if modules were consistent, false if changes had
/// to be made.
bool checkModuleConsistency();
/// for use with natbib
CiteEngine cite_engine_;
///

37
src/LayoutModuleList.h
View File

@ -17,6 +17,8 @@
namespace lyx {
class LayoutFile;
class LayoutModuleList {
public:
///
@ -47,7 +49,42 @@ public:
/// This is needed in GuiDocument. It seems better than an
/// implicit conversion.
std::list<std::string> const & list() const { return lml_; }
/// Checks to make sure module's requriements are satisfied, that it does
/// not conflict with already-present modules, isn't already loaded, etc.
bool moduleCanBeAdded(std::string const & modName,
LayoutFile const * const lay) const;
/// If the user changes the base class for a given document, then the
/// associated module list has to be updated. This just calls
/// (i) removeBadModules()
/// (ii) addDefaultModules()
/// (iii) checkModuleConsistency()
/// in that order, for which see below.
/// \param lay The new base class.
/// \param removedModules Modules the user explicitly removed and so
/// which should not be included.
/// \return true if no changes had to be made, false if some did have
/// to be made.
bool adaptToBaseClass(LayoutFile const * const lay,
std::list<std::string> removedModules);
private:
/// Removes modules excluded by, provided by, etc, the base class.
/// \param lay The document class against which to check.
/// \return true, if modules were consistent, false if changes had
/// to be made.
bool removeBadModules(LayoutFile const * const lay);
/// Adds default modules, if they're addable.
/// \param lay The base class from which to get default modules.
/// \param removedModules Modules the user has explicitly removed.
void addDefaultModules(LayoutFile const * const lay,
std::list<std::string> removedModules);
/// Checks for consistency among modules: makes sure requirements
/// are met, no modules exclude one another, etc, and resolves any
/// such conflicts, leaving us with a consistent collection.
/// \param lay The base class against which to check.
/// \return true if modules were consistent, false if changes had
/// to be made.
bool checkModuleConsistency(LayoutFile const * const lay);
///
std::list<std::string> lml_;
};
}

1
src/Makefile.am
View File

@ -120,6 +120,7 @@ SOURCEFILESCORE = \
LaTeX.cpp \
LaTeXFeatures.cpp \
LayoutFile.cpp \
LayoutModuleList.cpp \
Length.cpp \
lengthcommon.cpp \
Lexer.cpp \

1
src/tex2lyx/Makefile.am
View File

@ -37,6 +37,7 @@ LINKED_FILES = \
../Layout.h \
../Layout.cpp \
../LayoutModuleList.h \
../LayoutModuleList.cpp \
../ModuleList.h \
../ModuleList.cpp \
../TextClass.cpp \