Change the "empty layout" to the "plain layout", to try to avoid confusion.

[lyx.git] / src / ModuleList.h

diff --git a/src/ModuleList.h b/src/ModuleList.h
index 26b9973ddaa178fcc5606d0210df28877cb09c84..804cce1dea52a6c2563767316f1906e3f77f24b9 100644 (file)
--- a/src/ModuleList.h
+++ b/src/ModuleList.h
@@ -23,16 +23,54 @@ namespace lyx {
  *  file, except that it does not stand alone. In that sense, it is more like 
  *  a LaTeX package, where a layout file corresponds to a LaTeX class.
  */
-struct LyXModule {
+
+//FIXME Give us some access functions here.
+class LyXModule {
+public:
+       ///
+       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);
+       /// whether the required packages are available
+       bool isAvailable();
+       ///
+       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; }
+       ///
+       std::vector<std::string> const & getPackageList() const
+               { return packageList; }
+       ///
+       std::vector<std::string> const & getRequiredModules() const 
+               { return requiredModules; }
+       /// Modules this one excludes: the list should be treated disjunctively
+       std::vector<std::string> const & getExcludedModules() const 
+               { return excludedModules; }
+       
+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;
-       /// whether those packages are available (not implemented yet)
+       /// Modules this one requires: at least one
+       std::vector<std::string> requiredModules;
+       /// Modules this one excludes: none of these
+       std::vector<std::string> excludedModules;
+       ///
+       bool checked;
+       ///
        bool available;
 };
 
@@ -48,10 +86,6 @@ public:
        ModuleList() {}
        /// reads the modules from a file generated by configure.py
        bool load();
-       /// add a module to the list
-       void addLayoutModule(std::string const & name,
-               std::string const & filename, std::string const & description,
-               std::vector<std::string> const & packages);
        ///
        LyXModuleList::const_iterator begin() const;
        ///
@@ -64,12 +98,19 @@ public:
        bool empty() const { return modlist_.empty(); }
        /// Returns a pointer to the LyXModule with name str.
        /// Returns a null pointer if no such module is found.
+       LyXModule * getModuleByName(std::string const & 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:
+       private:
        /// noncopyable
        ModuleList(ModuleList const &);
+       ///
        void operator=(ModuleList const &);
-
+       /// add a module to the list
+       void addLayoutModule(std::string const &, std::string const &, 
+               std::string const &, std::vector<std::string> const &,
+               std::vector<std::string> const &, std::vector<std::string> const &);
        ///
        std::vector<LyXModule> modlist_;
 };