X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLayoutFile.h;h=b56da88319d122b4dfe2174195a29dbd120c68fc;hb=2098f1d8c20d51e63e670bcdc9da8996068975bf;hp=ed38f0ccad38b1f3c9d7609251defbdce110dd9e;hpb=6edb3984bf70ab2c65329c6fe4dc853396a8d8de;p=lyx.git diff --git a/src/LayoutFile.h b/src/LayoutFile.h index ed38f0ccad..b56da88319 100644 --- a/src/LayoutFile.h +++ b/src/LayoutFile.h @@ -4,7 +4,8 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes + * \author Richard Heck (typedefs and such) * * Full author contact details are available in file CREDITS. */ @@ -12,12 +13,15 @@ #ifndef BASECLASSLIST_H #define BASECLASSLIST_H +#include "LayoutModuleList.h" #include "TextClass.h" #include "support/strfwd.h" #include +#include +#include #include @@ -45,12 +49,31 @@ private: }; /// This class amounts to little more than a `strong typedef'. +/// /// A LayoutFile represents the layout information that is /// contained in a *.layout file. +/// +/// No document- (that is, Buffer-) specific information should +/// be placed in these objects. They are used as the basis for +/// constructing DocumentClass objects, which are what represent +/// the layout information associated with a Buffer. (This is also +/// a subclass of TextClass, implemented in TextClass.{h,cpp}.) +/// Buffer-specific information should therefore be placed in a +/// DocumentClass object. +/// class LayoutFile : public TextClass, boost::noncopyable { public: /// check whether the TeX class is available bool isTeXClassAvailable() const { return texClassAvail_; } + /// + LayoutModuleList const & defaultModules() const + { return default_modules_; } + /// + LayoutModuleList const & providedModules() const + { return provided_modules_; } + /// + LayoutModuleList const & excludedModules() const + { return excluded_modules_; } private: /// Construct a layout with default values. Actual values loaded later. explicit LayoutFile(std::string const & filename, @@ -72,29 +95,39 @@ class LayoutFileList { public: /// LayoutFileList() {} + /// + ~LayoutFileList(); /// \return The sole instance of this class. static LayoutFileList & get(); /// bool empty() const { return classmap_.empty(); } /// bool haveClass(std::string const & classname) const; - /// + /// Note that this will assert if we don't have classname, so + /// check via haveClass() first. LayoutFile const & operator[](std::string const & classname) const; - /// + /// Note that this will assert if we don't have classname, so + /// check via haveClass() first. LayoutFile & operator[](std::string const & classname); /// Read textclass list. Returns false if this fails. bool read(); /// Clears the textclass so as to force it to be reloaded void reset(LayoutFileIndex const & tc); + + /// add a default textclass with all standard layouts. + LayoutFileIndex addEmptyClass(std::string const & textclass); + /// add a textclass from user local directory. /// \return the identifier for the loaded file, or else an /// empty string if no file was loaded. LayoutFileIndex - addLayoutFile(std::string const & textclass, std::string const & path); + addLocalLayout(std::string const & textclass, std::string const & path); /// a list of the available classes std::vector classList() const; - /// - static std::string const localPrefix; + + /// + bool load(std::string const & name, std::string const & buf_path); + private: /// typedef std::map ClassMap;