X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLayoutFile.h;h=31031eae8e6b0221d408d1c2f6a3e622d7347060;hb=86994bf75320524ec656fd70950633c83d445a6c;hp=e23d214bd0cec33d5d88a4ec4f9d596334b44ede;hpb=48f9225e2703d398e71fd12618c8b9174f822bf3;p=lyx.git diff --git a/src/LayoutFile.h b/src/LayoutFile.h index e23d214bd0..31031eae8e 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 @@ -25,10 +29,6 @@ namespace lyx { class Layout; -/// Reads the style files -extern bool LyXSetStyle(); - - /// Index into LayoutFileList. Basically a 'strong typedef'. class LayoutFileIndex { public: @@ -45,18 +45,39 @@ 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_; } + bool isTeXClassAvailable() const { return tex_class_avail_; } + /// + 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, std::string const & className = std::string(), std::string const & description = std::string(), - bool texClassAvail = false); + std::string const & prerequisites = std::string(), + std::string const & category = std::string(), + bool texclassavail = false); /// The only class that should create a LayoutFile is /// LayoutFileList, which calls the private constructor. friend class LayoutFileList; @@ -72,38 +93,41 @@ 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); - enum Layout_Type { - System, - Local, - Embedded - }; - + /// Add a default textclass with all standard layouts. + /// Note that this will over-write any information we may have + /// gotten from textclass.lst about this class. + 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, - Layout_Type type); + addLocalLayout(std::string const & textclass, std::string const & path); /// a list of the available classes std::vector classList() const; - /// - static std::string const localPrefix; - static std::string const embeddedPrefix; + + /// + bool load(std::string const & name, std::string const & buf_path); + private: /// typedef std::map ClassMap;