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
9 * Full author contact details are available in file CREDITS.
12 #ifndef BASECLASSLIST_H
13 #define BASECLASSLIST_H
15 #include "TextClass.h"
17 #include "support/strfwd.h"
19 #include <boost/noncopyable.hpp>
28 /// Reads the style files
29 extern bool LyXSetStyle();
32 /// Index into LayoutFileList. Basically a 'strong typedef'.
33 class LayoutFileIndex {
36 typedef std::string base_type;
38 LayoutFileIndex(base_type t) { data_ = t; }
40 operator base_type() const { return data_; }
42 bool empty() const { return data_.empty(); }
47 /// This class amounts to little more than a `strong typedef'.
48 /// A LayoutFile represents the layout information that is
49 /// contained in a *.layout file.
50 class LayoutFile : public TextClass, boost::noncopyable {
52 /// check whether the TeX class is available
53 bool isTeXClassAvailable() const { return texClassAvail_; }
55 /// Construct a layout with default values. Actual values loaded later.
56 explicit LayoutFile(std::string const & filename,
57 std::string const & className = std::string(),
58 std::string const & description = std::string(),
59 bool texClassAvail = false);
60 /// The only class that should create a LayoutFile is
61 /// LayoutFileList, which calls the private constructor.
62 friend class LayoutFileList;
63 /// can't create empty LayoutFile
68 /// A list of base document classes (*.layout files).
69 /// This is a singleton class. The sole instance is accessed
70 /// via LayoutFileList::get()
71 class LayoutFileList {
75 /// \return The sole instance of this class.
76 static LayoutFileList & get();
78 bool empty() const { return classmap_.empty(); }
80 bool haveClass(std::string const & classname) const;
82 LayoutFile const & operator[](std::string const & classname) const;
84 LayoutFile & operator[](std::string const & classname);
85 /// Read textclass list. Returns false if this fails.
87 /// Clears the textclass so as to force it to be reloaded
88 void reset(LayoutFileIndex const & tc);
96 /// add a textclass from user local directory.
97 /// \return the identifier for the loaded file, or else an
98 /// empty string if no file was loaded.
100 addLayoutFile(std::string const & textclass, std::string const & path,
102 /// a list of the available classes
103 std::vector<LayoutFileIndex> classList() const;
105 static std::string const localPrefix;
106 static std::string const embeddedPrefix;
109 typedef std::map<std::string, LayoutFile *> ClassMap;
111 LayoutFileList(LayoutFileList const &);
113 void operator=(LayoutFileList const &);
115 mutable ClassMap classmap_; //FIXME
119 LayoutFileIndex defaultBaseclass();