4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Richard Heck (typedefs and such)
10 * Full author contact details are available in file CREDITS.
13 #ifndef BASECLASSLIST_H
14 #define BASECLASSLIST_H
16 #include "TextClass.h"
18 #include "support/strfwd.h"
26 class LayoutModuleList;
28 /// Index into LayoutFileList. Basically a 'strong typedef'.
29 class LayoutFileIndex {
32 typedef std::string base_type;
34 LayoutFileIndex(base_type const & t) : data_(t) { }
36 operator base_type() const { return data_; }
38 bool empty() const { return data_.empty(); }
43 /// This class amounts to little more than a `strong typedef'.
45 /// A LayoutFile represents the layout information that is
46 /// contained in a *.layout file.
48 /// No document- (that is, Buffer-) specific information should
49 /// be placed in these objects. They are used as the basis for
50 /// constructing DocumentClass objects, which are what represent
51 /// the layout information associated with a Buffer. (This is also
52 /// a subclass of TextClass, implemented in TextClass.{h,cpp}.)
53 /// Buffer-specific information should therefore be placed in a
54 /// DocumentClass object.
56 class LayoutFile : public TextClass {
58 /// check whether the TeX class is available
59 bool isTeXClassAvailable() const { return tex_class_avail_; }
61 LayoutModuleList const & defaultModules() const
62 { return default_modules_; }
64 LayoutModuleList const & providedModules() const
65 { return provided_modules_; }
67 LayoutModuleList const & excludedModules() const
68 { return excluded_modules_; }
71 LayoutFile(LayoutFile const &);
72 void operator=(LayoutFile const &);
73 /// Construct a layout with default values. Actual values loaded later.
74 explicit LayoutFile(std::string const & filename,
75 std::string const & className = std::string(),
76 std::string const & description = std::string(),
77 std::string const & prerequisites = std::string(),
78 std::string const & category = std::string(),
79 bool texclassavail = false);
80 /// The only class that should create a LayoutFile is
81 /// LayoutFileList, which calls the private constructor.
82 friend class LayoutFileList;
83 /// can't create empty LayoutFile
88 /// A list of base document classes (*.layout files).
89 /// This is a singleton class. The sole instance is accessed
90 /// via LayoutFileList::get()
91 class LayoutFileList {
95 /// \return The sole instance of this class.
96 static LayoutFileList & get();
98 bool empty() const { return classmap_.empty(); }
100 bool haveClass(std::string const & classname) const;
101 /// Note that this will assert if we don't have classname, so
102 /// check via haveClass() first.
103 LayoutFile const & operator[](std::string const & classname) const;
104 /// Note that this will assert if we don't have classname, so
105 /// check via haveClass() first.
106 LayoutFile & operator[](std::string const & classname);
107 /// Read textclass list. Returns false if this fails.
109 /// Clears the textclass so as to force it to be reloaded
110 void reset(LayoutFileIndex const & classname);
112 /// Add a default textclass with all standard layouts.
113 /// Note that this will over-write any information we may have
114 /// gotten from textclass.lst about this class.
115 LayoutFileIndex addEmptyClass(std::string const & textclass);
117 /// add a textclass from user local directory.
118 /// \return the identifier for the loaded file, or else an
119 /// empty string if no file was loaded.
120 LayoutFileIndex addLocalLayout(std::string const & textclass,
121 std::string const & path,
122 std::string const & oldpath = empty_string());
123 /// a list of the available classes
124 std::vector<LayoutFileIndex> classList() const;
127 bool load(std::string const & name, std::string const & buf_path);
133 typedef std::map<std::string, LayoutFile *> ClassMap;
135 LayoutFileList(LayoutFileList const &);
137 void operator=(LayoutFileList const &);
139 mutable ClassMap classmap_; //FIXME
143 LayoutFileIndex defaultBaseclass();