X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FModuleList.h;h=d3abef913a5450830365451e6f71c1f5697ed099;hb=73b81b79868dbee9ee0277045e8a672a615040fd;hp=66353affe35928ad443503fe3f5aac64733eda1c;hpb=9dfac742653af4b3de4f8dc502f76ae77063166b;p=lyx.git diff --git a/src/ModuleList.h b/src/ModuleList.h index 66353affe3..d3abef913a 100644 --- a/src/ModuleList.h +++ b/src/ModuleList.h @@ -19,7 +19,7 @@ namespace lyx { /** - * This struct represents a particular LyX "module", which is a like a layout + * This class represents a particular LyX "module", which is a like a layout * 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. Or, in * LyX's own terms, a module is more like an included file that can be used @@ -37,9 +37,11 @@ namespace lyx { * #DescriptionEnd * #Requires: theorems-std | theorems-ams * #Excludes: theorems-chap + * #Category: theorems * The description is used in the gui to give information to the user. The - * Requires and Excludes lines are read by the configuration script and - * written to a file lyxmodules.lst in the user configuration directory. + * Requires, Excludes, and Categofy lines are read by the configuration script + * and written to a file lyxmodules.lst in the user configuration directory. + * That file is then read on startup to populate the ModuleList, below. * * Modules can also be "provided" or "excluded" by document classes, using * the ProvidesModule and ExcludesModule tags. @@ -48,56 +50,68 @@ namespace lyx { class LyXModule { public: /// - LyXModule(std::string const & n, std::string const & i, - std::string const & d, std::vector const & p, - std::vector const & r, - std::vector const & e); + LyXModule(std::string const & name, std::string const & id, + std::string const & description, + std::vector const & packagelist, + std::vector const & requires, + std::vector const & excludes, + std::string const & catgy); /// whether the required packages are available - bool isAvailable(); + bool isAvailable() const; + /// the missing prerequisites, if any + std::vector prerequisites() const; /// - std::string const & getName() const { return name; } + std::string const & getName() const { return name_; } /// - std::string const & getID() const { return id; } + std::string const & getID() const { return id_; } /// - std::string const & getFilename() const { return filename; } + std::string const & getFilename() const { return filename_; } /// - std::string const & getDescription() const { return description; } + std::string const & getDescription() const { return description_; } /// std::vector const & getPackageList() const - { return packageList; } + { return package_list_; } /// std::vector const & getRequiredModules() const - { return requiredModules; } + { return required_modules_; } /// Modules this one excludes: the list should be treated disjunctively std::vector const & getExcludedModules() const - { return excludedModules; } + { return excluded_modules_; } + /// + std::string category() const { return category_; } /// \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 + /// 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; + 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; + std::string name_; /// the module's unique identifier /// at present, this is the filename, without the extension - std::string id; + std::string id_; /// the filename - std::string filename; + std::string filename_; /// a short description for use in the ui - std::string description; + std::string description_; /// the LaTeX packages on which this depends, if any - std::vector packageList; + std::vector package_list_; /// Modules this one requires: at least one - std::vector requiredModules; + std::vector required_modules_; /// Modules this one excludes: none of these - std::vector excludedModules; + std::vector excluded_modules_; + /// Category, also used in the UI + std::string category_; + // these are mutable because they are used to cache the results + // or an otherwise const operation. + /// + mutable bool checked_; /// - bool checked; + mutable bool available_; /// - bool available; + mutable std::vector prerequisites_; }; typedef std::vector LyXModuleList; @@ -111,7 +125,7 @@ public: /// ModuleList() {} /// reads the modules from a file generated by configure.py - bool load(); + bool read(); /// LyXModuleList::const_iterator begin() const; /// @@ -124,8 +138,10 @@ public: bool empty() const { return modlist_.empty(); } /// Returns a pointer to the LyXModule with filename str. /// Returns a null pointer if no such module is found. + LyXModule const * operator[](std::string const & str) const; + /// LyXModule * operator[](std::string const & str); -private: + private: /// noncopyable ModuleList(ModuleList const &); /// @@ -133,11 +149,12 @@ private: /// add a module to the list void addLayoutModule(std::string const &, std::string const &, std::string const &, std::vector const &, - std::vector const &, std::vector const &); + std::vector const &, std::vector const &, + std::string const &); /// std::vector modlist_; }; -extern ModuleList moduleList; +extern ModuleList theModuleList; } #endif