Add doxy.

[lyx.git] / src / ModuleList.cpp

diff --git a/src/ModuleList.cpp b/src/ModuleList.cpp
index 2de1cb014ceac32b2b8fa86a56ed71449310bff2..14e2917159bddeeea7fb184ad714221ed823c6a5 100644 (file)
--- a/src/ModuleList.cpp
+++ b/src/ModuleList.cpp
@@ -13,10 +13,10 @@
 
 #include "ModuleList.h"
 
-#include "support/debug.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 
+#include "support/debug.h"
 #include "support/FileName.h"
 #include "support/filetools.h"
 #include "support/lstrings.h"
@@ -34,10 +34,15 @@ namespace lyx {
 ModuleList moduleList;
 
 
-LyXModule::LyXModule(string n, string f, string d,
-                 vector<string> p) : 
-       name(n), filename(f), description(d), packageList(p), checked(false)
-{}
+LyXModule::LyXModule(string const & n, string const & i, 
+                          string const & d, vector<string> const & p,
+                          vector<string> const & r, vector<string> const & e):
+       name(n), id(i), description(d), 
+       packageList(p), requiredModules(r), excludedModules(e),
+       checked(false)
+{
+       filename = id + ".module";
+}
 
 
 bool LyXModule::isAvailable() {
@@ -45,12 +50,15 @@ bool LyXModule::isAvailable() {
                return true;
        if (checked)
                return available;
+       checked = true;
+       //check whether all of the required packages are available
        vector<string>::const_iterator it  = packageList.begin();
        vector<string>::const_iterator end = packageList.end(); 
        for (; it != end; ++it) {
-               if (!LaTeXFeatures::isAvailable(*it))
+               if (!LaTeXFeatures::isAvailable(*it)) {
                        available = false;
                        return available;
+               }
        }
        available = true;
        return available;
@@ -63,12 +71,12 @@ class ModuleSorter
 public:
        int operator()(LyXModule const & lm1, LyXModule const & lm2) const
        {
-               return lm1.name < lm2.name;
+               return lm1.getName() < lm2.getName();
        }
 };
 
 
-//Much of this is borrowed from TextClassList::read()
+//Much of this is borrowed from LayoutFileList::read()
 bool ModuleList::load()
 {
        FileName const real_file = libFileSearch("", "lyxmodules.lst");
@@ -122,17 +130,37 @@ bool ModuleList::load()
                        //FIXME Add packages
                        if (!lex.next())
                                break;
-                       string packages = lex.getString();
-                       LYXERR(Debug::TCLASS, "Packages: " << packages);
+                       string str = lex.getString();
+                       LYXERR(Debug::TCLASS, "Packages: " << str);
                        vector<string> pkgs;
-                       while (!packages.empty()) {
+                       while (!str.empty()) {
                                string p;
-                               packages = split(packages, p, ',');
+                               str = split(str, p, ',');
                                pkgs.push_back(p);
                        }
+                       if (!lex.next())
+                               break;
+                       str = lex.getString();
+                       LYXERR(Debug::TCLASS, "Required: " << str);
+                       vector<string> req;
+                       while (!str.empty()) {
+                               string p;
+                               str = split(str, p, '|');
+                               req.push_back(p);
+                       }
+                       if (!lex.next())
+                               break;
+                       str = lex.getString();
+                       LYXERR(Debug::TCLASS, "Excluded: " << str);
+                       vector<string> exc;
+                       while (!str.empty()) {
+                               string p;
+                               str = split(str, p, '|');
+                               exc.push_back(p);
+                       }
                        // This code is run when we have
-                       // modName, fname, desc, and pkgs
-                       addLayoutModule(modName, fname, desc, pkgs);
+                       // modName, fname, desc, pkgs, req, and exc
+                       addLayoutModule(modName, fname, desc, pkgs, req, exc);
                } // end switch
        } //end while
        
@@ -146,9 +174,10 @@ bool ModuleList::load()
 
 void ModuleList::addLayoutModule(string const & moduleName, 
        string const & filename, string const & description,
-       vector<string> const & pkgs)
+       vector<string> const & pkgs, vector<string> const & req,
+       vector<string> const & exc)
 {
-       LyXModule lm(moduleName, filename, description, pkgs);
+       LyXModule lm(moduleName, filename, description, pkgs, req, exc);
        modlist_.push_back(lm);
 }
 
@@ -177,11 +206,22 @@ LyXModuleList::iterator ModuleList::end()
 }
 
 
+LyXModule * ModuleList::getModuleByName(string const & str)
+{
+       LyXModuleList::iterator it = modlist_.begin();
+       for (; it != modlist_.end(); ++it)
+               if (it->getName() == str) {
+                       LyXModule & mod = *it;
+                       return &mod;
+               }
+       return 0;
+}
+
 LyXModule * ModuleList::operator[](string const & str)
 {
        LyXModuleList::iterator it = modlist_.begin();
        for (; it != modlist_.end(); ++it)
-               if (it->name == str) {
+               if (it->getID() == str) {
                        LyXModule & mod = *it;
                        return &mod;
                }