4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * Full author contact details are available in file CREDITS.
10 #ifndef LYXTEXTCLASS_H
11 #define LYXTEXTCLASS_H
13 #include "lyxlayout.h"
14 #include "lyxlayout_ptr_fwd.h"
16 #include <boost/shared_ptr.hpp>
23 namespace support { class FileName; }
34 std::string latextype;
35 std::string latexname;
36 std::string latexparam;
43 /// List of semantically defined character style insets
44 typedef std::vector<CharStyle> CharStyles;
47 /// Stores the layout specification of a LyX document class.
50 /// The individual styles comprising the document class
51 typedef std::vector<LyXLayout_ptr> LayoutList;
52 /// Enumerate the paragraph styles.
53 typedef LayoutList::const_iterator const_iterator;
54 /// Construct a layout with default values. Actual values loaded later.
56 LyXTextClass(std::string const & = std::string(),
57 std::string const & = std::string(),
58 std::string const & = std::string(),
61 /// check whether the TeX class is available
62 bool isTeXClassAvailable() const;
64 /// paragraph styles begin iterator.
65 const_iterator begin() const { return layoutlist_.begin(); }
66 /// paragraph styles end iterator
67 const_iterator end() const { return layoutlist_.end(); }
69 /// Performs the read of the layout file.
70 bool read(support::FileName const & filename, bool merge = false);
72 void readOutputType(LyXLex &);
74 void readTitleType(LyXLex &);
76 void readMaxCounter(LyXLex &);
78 void readClassOptions(LyXLex &);
80 void readCharStyle(LyXLex &, std::string const &);
82 void readFloat(LyXLex &);
84 void readCounter(LyXLex &);
86 bool hasLayout(std::string const & name) const;
89 LyXLayout_ptr const & operator[](std::string const & vname) const;
91 /// Sees to that the textclass structure has been loaded
92 bool load(std::string const & path = std::string()) const;
93 /// Has this layout file been loaded yet?
94 bool loaded() const { return loaded_; }
96 /// the list of floats defined in the document class
98 /// the list of floats defined in the document class
99 FloatList const & floats() const;
100 /// The Counters present in this document class.
101 Counters & counters() const;
102 /// CharStyles of this doc class
103 CharStyles & charstyles() const { return charstylelist_; };
104 /// Retrieve element of name s:
105 CharStyles::iterator charstyle(std::string const & s) const;
107 std::string const & defaultLayoutName() const;
109 LyXLayout_ptr const & defaultLayout() const;
111 std::string const & name() const;
113 std::string const & latexname() const;
115 std::string const & description() const;
117 std::string const & opt_fontsize() const;
119 std::string const & opt_pagestyle() const;
121 std::string const & options() const;
123 std::string const & class_header() const;
125 std::string const & pagestyle() const;
127 docstring const & preamble() const;
129 /// Packages that are already loaded by the class
143 bool provides(Provides p) const;
146 unsigned int columns() const;
155 PageSides sides() const;
157 int secnumdepth() const;
159 int tocdepth() const;
161 /// Can be LaTeX, DocBook, etc.
162 OutputType outputType() const;
165 LyXFont const & defaultfont() const;
167 /// Text that dictates how wide the left margin is on the screen
168 std::string const & leftmargin() const;
170 /// Text that dictates how wide the right margin is on the screen
171 std::string const & rightmargin() const;
173 /// The type of command used to produce a title
174 LYX_TITLE_LATEX_TYPES titletype() const;
175 /// The name of the title command
176 std::string const & titlename() const;
180 /// The minimal TocLevel of sectioning layouts
181 int min_toclevel() const;
182 /// The maximal TocLevel of sectioning layouts
183 int max_toclevel() const;
184 /// returns true if the class has a ToC structure
185 bool hasTocLevels() const;
188 bool delete_layout(std::string const &);
190 bool do_readStyle(LyXLex &, LyXLayout &);
193 /// document class name
194 std::string latexname_;
195 /// document class description
196 std::string description_;
197 /// Specific class options
198 std::string opt_fontsize_;
200 std::string opt_pagestyle_;
202 std::string options_;
204 std::string pagestyle_;
206 std::string class_header_;
208 std::string defaultlayout_;
209 /// preamble text to support layout styles
211 /// latex packages loaded by document class.
214 unsigned int columns_;
217 /// header depth to have numbering
219 /// header depth to appear in table of contents
221 /// Can be LaTeX, DocBook, etc.
222 OutputType outputType_;
223 /** Base font. The paragraph and layout fonts are resolved against
224 this font. This has to be fully instantiated. Attributes
225 LyXFont::INHERIT, LyXFont::IGNORE, and LyXFont::TOGGLE are
228 LyXFont defaultfont_;
229 /// Text that dictates how wide the left margin is on the screen
230 std::string leftmargin_;
232 /// Text that dictates how wide the right margin is on the screen
233 std::string rightmargin_;
235 /// The type of command used to produce a title
236 LYX_TITLE_LATEX_TYPES titletype_;
237 /// The name of the title command
238 std::string titlename_;
240 /// Paragraph styles used in this layout
241 LayoutList layoutlist_;
242 /// CharStyles available to this layout
243 mutable CharStyles charstylelist_;
245 /// available types of float, eg. figure, algorithm.
246 boost::shared_ptr<FloatList> floatlist_;
248 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
249 boost::shared_ptr<Counters> ctrs_;
251 /// Has this layout file been loaded yet?
252 mutable bool loaded_;
254 /// Is the TeX class available?
257 /// The minimal TocLevel of sectioning layouts
259 /// The maximal TocLevel of sectioning layouts
264 /// Merge two different provides flags into one bit field record
266 void operator|=(LyXTextClass::Provides & p1, LyXTextClass::Provides p2)
268 p1 = static_cast<LyXTextClass::Provides>(p1 | p2);
272 /// convert page sides option to text 1 or 2
273 std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p);