Fix bug 5374

[lyx.git] / src / ModuleList.h

diff --git a/src/ModuleList.h b/src/ModuleList.h
index e0e52f72ee572408ca32f3f372afe493d344ad58..0ef152c06962ec2ee39a27169eb464e3010be936 100644 (file)
--- a/src/ModuleList.h
+++ b/src/ModuleList.h
@@ -24,11 +24,10 @@ namespace lyx {
  *  a LaTeX package, where a layout file corresponds to a LaTeX class.
  */
 
-//FIXME Give us some access functions here.
 class LyXModule {
 public:
        ///
-       LyXModule(std::string const & n, std::string const & f, 
+       LyXModule(std::string const & n, std::string const & i, 
                  std::string const & d, std::vector<std::string> const & p,
                  std::vector<std::string> const & r, 
                  std::vector<std::string> const & e);
@@ -37,6 +36,8 @@ public:
        ///
        std::string const & getName() const { return name; }
        ///
+       std::string const & getID() const { return id; }
+       ///
        std::string const & getFilename() const { return filename; }
        ///
        std::string const & getDescription() const { return description; }
@@ -49,15 +50,24 @@ public:
        /// Modules this one excludes: the list should be treated disjunctively
        std::vector<std::string> const & getExcludedModules() const 
                { return excludedModules; }
-       
+       /// \return true if the module is compatible with this one, i.e.,
+       /// it does not exclude us and we do not exclude it.
+       /// this will also return true if modName is unknown and we do not
+       /// exclude it, since in that case we cannot check its exclusions.
+       bool isCompatible(std::string const & modName) const;
+       ///
+       static bool areCompatible(std::string const & mod1, std::string const & mod2);
 private:
        /// what appears in the ui
        std::string name;
-       /// the filename, without any path
+       /// the module's unique identifier
+       /// at present, this is the filename, without the extension
+       std::string id;
+       /// the filename
        std::string filename;
        /// a short description for use in the ui
        std::string description;
-       /// the LaTeX packages on which this depends, if any (not implemented)
+       /// the LaTeX packages on which this depends, if any
        std::vector<std::string> packageList;
        /// Modules this one requires: at least one
        std::vector<std::string> requiredModules;
@@ -91,7 +101,7 @@ public:
        LyXModuleList::iterator end();
        ///
        bool empty() const { return modlist_.empty(); }
-       /// Returns a pointer to the LyXModule with name str.
+       /// Returns a pointer to the LyXModule with filename str.
        /// Returns a null pointer if no such module is found.
        LyXModule * operator[](std::string const & str);
 private: