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"
15 #include "lyxlayout_ptr_fwd.h"
17 #include "support/types.h"
19 #include <boost/shared_ptr.hpp>
27 /// Stores the layout specification of a LyX document class.
30 /// The individual styles comprising the document class
31 typedef std::vector<LyXLayout_ptr> LayoutList;
32 /// Enumerate the paragraph styles.
33 typedef LayoutList::const_iterator const_iterator;
34 /// Construct a layout with default values. Actual values loaded later.
36 LyXTextClass(string const & = string(),
37 string const & = string(),
38 string const & = string(),
41 /// check whether the TeX class is available
42 bool isTeXClassAvailable() const;
44 /// paragraph styles begin iterator.
45 const_iterator begin() const { return layoutlist_.begin(); }
46 /// paragraph styles end iterator
47 const_iterator end() const { return layoutlist_.end(); }
49 /// Performs the read of the layout file.
50 bool Read(string const & filename, bool merge = false);
52 void readOutputType(LyXLex &);
54 void readTitleType(LyXLex &);
56 void readMaxCounter(LyXLex &);
58 void readClassOptions(LyXLex &);
60 void readFloat(LyXLex &);
62 void readCounter(LyXLex &);
64 bool hasLayout(string const & name) const;
67 LyXLayout_ptr const & operator[](string const & vname) const;
69 LyXLayout_ptr const & getEnv(string const & vname) const;
71 /// Sees to that the textclass structure has been loaded
74 /// the list of floats defined in the document class
76 /// the list of floats defined in the document class
77 FloatList const & floats() const;
78 /// The Counters present in this document class.
79 Counters & counters() const;
81 string const & defaultLayoutName() const;
83 LyXLayout_ptr const & defaultLayout() const;
85 string const & name() const;
87 string const & latexname() const;
89 string const & description() const;
91 string const & opt_fontsize() const;
93 string const & opt_pagestyle() const;
95 string const & options() const;
97 string const & pagestyle() const;
99 string const & preamble() const;
101 /// Packages that are already loaded by the class
115 bool provides(Provides p) const;
118 unsigned int columns() const;
127 PageSides sides() const;
129 int secnumdepth() const;
131 int tocdepth() const;
133 /// Can be LaTeX, LinuxDoc, etc.
134 OutputType outputType() const;
137 LyXFont const & defaultfont() const;
139 /// Text that dictates how wide the left margin is on the screen
140 string const & leftmargin() const;
142 /// Text that dictates how wide the right margin is on the screen
143 string const & rightmargin() const;
145 int maxcounter() const;
147 /// The type of command used to produce a title
148 LYX_TITLE_LATEX_TYPES titletype() const;
149 /// The name of the title command
150 string const & titlename() const;
156 bool delete_layout(string const &);
158 bool delete_env(string const &);
160 bool do_readStyle(LyXLex &, LyXLayout &);
163 /// document class name
165 /// document class description
167 /// Specific class options
168 string opt_fontsize_;
170 string opt_pagestyle_;
176 string defaultlayout_;
177 /// preamble text to support layout styles
179 /// latex packages loaded by document class.
182 unsigned int columns_;
185 /// header depth to have numbering
187 /// header depth to appear in table of contents
189 /// Can be LaTeX, LinuxDoc, etc.
190 OutputType outputType_;
191 /** Base font. The paragraph and layout fonts are resolved against
192 this font. This has to be fully instantiated. Attributes
193 LyXFont::INHERIT, LyXFont::IGNORE, and LyXFont::TOGGLE are
196 LyXFont defaultfont_;
197 /// Text that dictates how wide the left margin is on the screen
200 /// Text that dictates how wide the right margin is on the screen
202 /// highest header level used in this layout.
203 int maxcounter_; // add approp. signedness
205 /// The type of command used to produce a title
206 LYX_TITLE_LATEX_TYPES titletype_;
207 /// The name of the title command
210 /// Paragraph styles used in this layout
211 LayoutList layoutlist_;
213 /// Environment styles used in this layout
216 /// available types of float, eg. figure, algorithm.
217 boost::shared_ptr<FloatList> floatlist_;
219 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
220 boost::shared_ptr<Counters> ctrs_;
222 /// Has this layout file been loaded yet?
225 /// Is the TeX class available?
230 /// Merge two different provides flags into one bit field record
232 void operator|=(LyXTextClass::Provides & p1, LyXTextClass::Provides p2)
234 p1 = static_cast<LyXTextClass::Provides>(p1 | p2);
238 /// convert page sides option to text 1 or 2
239 std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p);