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>
32 std::string latextype;
33 std::string latexname;
34 std::string latexparam;
41 /// List of semantically defined character style insets
42 typedef std::vector<CharStyle> CharStyles;
45 /// Stores the layout specification of a LyX document class.
48 /// The individual styles comprising the document class
49 typedef std::vector<LyXLayout_ptr> LayoutList;
50 /// Enumerate the paragraph styles.
51 typedef LayoutList::const_iterator const_iterator;
52 /// Construct a layout with default values. Actual values loaded later.
54 LyXTextClass(std::string const & = std::string(),
55 std::string const & = std::string(),
56 std::string const & = std::string(),
59 /// check whether the TeX class is available
60 bool isTeXClassAvailable() const;
62 /// paragraph styles begin iterator.
63 const_iterator begin() const { return layoutlist_.begin(); }
64 /// paragraph styles end iterator
65 const_iterator end() const { return layoutlist_.end(); }
67 /// Performs the read of the layout file.
68 bool read(std::string const & filename, bool merge = false);
70 void readOutputType(LyXLex &);
72 void readTitleType(LyXLex &);
74 void readMaxCounter(LyXLex &);
76 void readClassOptions(LyXLex &);
78 void readCharStyle(LyXLex &, std::string const &);
80 void readFloat(LyXLex &);
82 void readCounter(LyXLex &);
84 bool hasLayout(std::string const & name) const;
87 LyXLayout_ptr const & operator[](std::string const & vname) const;
89 /// Sees to that the textclass structure has been loaded
90 bool load(std::string const & path = std::string()) const;
91 /// Has this layout file been loaded yet?
92 bool loaded() const { return loaded_; }
94 /// the list of floats defined in the document class
96 /// the list of floats defined in the document class
97 FloatList const & floats() const;
98 /// The Counters present in this document class.
99 Counters & counters() const;
100 /// CharStyles of this doc class
101 CharStyles & charstyles() const { return charstylelist_; };
102 /// Retrieve element of name s:
103 CharStyles::iterator charstyle(std::string const & s) const;
105 std::string const & defaultLayoutName() const;
107 LyXLayout_ptr const & defaultLayout() const;
109 std::string const & name() const;
111 std::string const & latexname() const;
113 std::string const & description() const;
115 std::string const & opt_fontsize() const;
117 std::string const & opt_pagestyle() const;
119 std::string const & options() const;
121 std::string const & class_header() const;
123 std::string const & pagestyle() const;
125 docstring const & preamble() const;
127 /// Packages that are already loaded by the class
141 bool provides(Provides p) const;
144 unsigned int columns() const;
153 PageSides sides() const;
155 int secnumdepth() const;
157 int tocdepth() const;
159 /// Can be LaTeX, DocBook, etc.
160 OutputType outputType() const;
163 LyXFont const & defaultfont() const;
165 /// Text that dictates how wide the left margin is on the screen
166 std::string const & leftmargin() const;
168 /// Text that dictates how wide the right margin is on the screen
169 std::string const & rightmargin() const;
171 /// The type of command used to produce a title
172 LYX_TITLE_LATEX_TYPES titletype() const;
173 /// The name of the title command
174 std::string const & titlename() const;
178 /// The minimal TocLevel of sectioning layouts
179 int min_toclevel() const;
180 /// The maximal TocLevel of sectioning layouts
181 int max_toclevel() const;
182 /// returns true if the class has a ToC structure
183 bool hasTocLevels() const;
186 bool delete_layout(std::string const &);
188 bool do_readStyle(LyXLex &, LyXLayout &);
191 /// document class name
192 std::string latexname_;
193 /// document class description
194 std::string description_;
195 /// Specific class options
196 std::string opt_fontsize_;
198 std::string opt_pagestyle_;
200 std::string options_;
202 std::string pagestyle_;
204 std::string class_header_;
206 std::string defaultlayout_;
207 /// preamble text to support layout styles
209 /// latex packages loaded by document class.
212 unsigned int columns_;
215 /// header depth to have numbering
217 /// header depth to appear in table of contents
219 /// Can be LaTeX, DocBook, etc.
220 OutputType outputType_;
221 /** Base font. The paragraph and layout fonts are resolved against
222 this font. This has to be fully instantiated. Attributes
223 LyXFont::INHERIT, LyXFont::IGNORE, and LyXFont::TOGGLE are
226 LyXFont defaultfont_;
227 /// Text that dictates how wide the left margin is on the screen
228 std::string leftmargin_;
230 /// Text that dictates how wide the right margin is on the screen
231 std::string rightmargin_;
233 /// The type of command used to produce a title
234 LYX_TITLE_LATEX_TYPES titletype_;
235 /// The name of the title command
236 std::string titlename_;
238 /// Paragraph styles used in this layout
239 LayoutList layoutlist_;
240 /// CharStyles available to this layout
241 mutable CharStyles charstylelist_;
243 /// available types of float, eg. figure, algorithm.
244 boost::shared_ptr<FloatList> floatlist_;
246 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
247 boost::shared_ptr<Counters> ctrs_;
249 /// Has this layout file been loaded yet?
250 mutable bool loaded_;
252 /// Is the TeX class available?
255 /// The minimal TocLevel of sectioning layouts
257 /// The maximal TocLevel of sectioning layouts
262 /// Merge two different provides flags into one bit field record
264 void operator|=(LyXTextClass::Provides & p1, LyXTextClass::Provides p2)
266 p1 = static_cast<LyXTextClass::Provides>(p1 | p2);
270 /// convert page sides option to text 1 or 2
271 std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p);