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>
25 /// Stores the layout specification of a LyX document class.
28 /// The individual styles comprising the document class
29 typedef std::vector<LyXLayout_ptr> LayoutList;
30 /// Enumerate the paragraph styles.
31 typedef LayoutList::const_iterator const_iterator;
32 /// Construct a layout with default values. Actual values loaded later.
34 LyXTextClass(std::string const & = std::string(),
35 std::string const & = std::string(),
36 std::string const & = std::string(),
39 /// check whether the TeX class is available
40 bool isTeXClassAvailable() const;
42 /// paragraph styles begin iterator.
43 const_iterator begin() const { return layoutlist_.begin(); }
44 /// paragraph styles end iterator
45 const_iterator end() const { return layoutlist_.end(); }
47 /// Performs the read of the layout file.
48 bool Read(std::string const & filename, bool merge = false);
50 void readOutputType(LyXLex &);
52 void readTitleType(LyXLex &);
54 void readMaxCounter(LyXLex &);
56 void readClassOptions(LyXLex &);
58 void readFloat(LyXLex &);
60 void readCounter(LyXLex &);
62 bool hasLayout(std::string const & name) const;
65 LyXLayout_ptr const & operator[](std::string const & vname) const;
67 /// Sees to that the textclass structure has been loaded
70 /// the list of floats defined in the document class
72 /// the list of floats defined in the document class
73 FloatList const & floats() const;
74 /// The Counters present in this document class.
75 Counters & counters() const;
77 std::string const & defaultLayoutName() const;
79 LyXLayout_ptr const & defaultLayout() const;
81 std::string const & name() const;
83 std::string const & latexname() const;
85 std::string const & description() const;
87 std::string const & opt_fontsize() const;
89 std::string const & opt_pagestyle() const;
91 std::string const & options() const;
93 std::string const & pagestyle() const;
95 std::string const & preamble() const;
97 /// Packages that are already loaded by the class
111 bool provides(Provides p) const;
114 unsigned int columns() const;
123 PageSides sides() const;
125 int secnumdepth() const;
127 int tocdepth() const;
129 /// Can be LaTeX, LinuxDoc, etc.
130 OutputType outputType() const;
133 LyXFont const & defaultfont() const;
135 /// Text that dictates how wide the left margin is on the screen
136 std::string const & leftmargin() const;
138 /// Text that dictates how wide the right margin is on the screen
139 std::string const & rightmargin() const;
141 /// The type of command used to produce a title
142 LYX_TITLE_LATEX_TYPES titletype() const;
143 /// The name of the title command
144 std::string const & titlename() const;
150 bool delete_layout(std::string const &);
152 bool do_readStyle(LyXLex &, LyXLayout &);
155 /// document class name
156 std::string latexname_;
157 /// document class description
158 std::string description_;
159 /// Specific class options
160 std::string opt_fontsize_;
162 std::string opt_pagestyle_;
164 std::string options_;
166 std::string pagestyle_;
168 std::string defaultlayout_;
169 /// preamble text to support layout styles
170 std::string preamble_;
171 /// latex packages loaded by document class.
174 unsigned int columns_;
177 /// header depth to have numbering
179 /// header depth to appear in table of contents
181 /// Can be LaTeX, LinuxDoc, etc.
182 OutputType outputType_;
183 /** Base font. The paragraph and layout fonts are resolved against
184 this font. This has to be fully instantiated. Attributes
185 LyXFont::INHERIT, LyXFont::IGNORE, and LyXFont::TOGGLE are
188 LyXFont defaultfont_;
189 /// Text that dictates how wide the left margin is on the screen
190 std::string leftmargin_;
192 /// Text that dictates how wide the right margin is on the screen
193 std::string rightmargin_;
195 /// The type of command used to produce a title
196 LYX_TITLE_LATEX_TYPES titletype_;
197 /// The name of the title command
198 std::string titlename_;
200 /// Paragraph styles used in this layout
201 LayoutList layoutlist_;
203 /// available types of float, eg. figure, algorithm.
204 boost::shared_ptr<FloatList> floatlist_;
206 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
207 boost::shared_ptr<Counters> ctrs_;
209 /// Has this layout file been loaded yet?
212 /// Is the TeX class available?
217 /// Merge two different provides flags into one bit field record
219 void operator|=(LyXTextClass::Provides & p1, LyXTextClass::Provides p2)
221 p1 = static_cast<LyXTextClass::Provides>(p1 | p2);
225 /// convert page sides option to text 1 or 2
226 std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p);