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.
13 #include "ColorCode.h"
15 #include "FloatList.h"
18 #include "LayoutEnums.h"
20 #include "insets/InsetLayout.h"
22 #include "support/docstring.h"
23 #include "support/types.h"
25 #include <boost/noncopyable.hpp>
34 namespace support { class FileName; }
42 /// Based upon ideas in boost::noncopyable, inheriting from this
43 /// class effectively makes the copy constructor protected but the
44 /// assignment constructor private.
50 ProtectCopy(const ProtectCopy &) {};
52 const ProtectCopy & operator=(const ProtectCopy &);
56 /// A TextClass represents a collection of layout information: At the
57 /// moment, this includes Layout's and InsetLayout's.
59 /// There are two major subclasses of TextClass: LayoutFile and
60 /// DocumentClass. These subclasses are what are actually used in LyX.
61 /// Simple TextClass objects are not directly constructed in the main
62 /// LyX code---the constructor is protected. (That said, in tex2lyx
63 /// there are what amount to simple TextClass objects.)
65 /// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file.
66 /// These are generally static objects---though they can be reloaded
67 /// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
68 /// they will never change.
70 /// A DocumentClass (see below) represents the layout information that
71 /// is associated with a given Buffer. These are static, in the sense
72 /// that they will not themselves change, but which DocumentClass is
73 /// associated with a Buffer can change, as modules are loaded and
74 /// unloaded, for example.
76 class TextClass : protected ProtectCopy {
79 virtual ~TextClass() {};
80 ///////////////////////////////////////////////////////////////////
82 ///////////////////////////////////////////////////////////////////
83 /// The individual paragraph layouts comprising the document class
84 // NOTE Do NOT try to make this a container of Layout pointers, e.g.,
85 // std::vector<Layout *>. This will lead to problems. The reason is
86 // that DocumentClass objects are generally created by copying a
87 // LayoutFile, which serves as a base for the DocumentClass. If the
88 // LayoutList is a container of pointers, then every DocumentClass
89 // that derives from a given LayoutFile (e.g., article) will SHARE
90 // a basic set of layouts. So if one Buffer were to modify a layout
91 // (say, Standard), that would modify that layout for EVERY Buffer
92 // that was based upon the same DocumentClass. (Of course, if you
93 // really, REALLY want to make LayoutList a vector<Layout *>, then
94 // you can implement custom assignment and copy constructors.)
96 // NOTE: Layout pointers are directly assigned to paragraphs so a
97 // container that does not invalidate these pointers after insertion
99 typedef std::list<Layout> LayoutList;
100 /// The inset layouts available to this class
101 typedef std::map<docstring, InsetLayout> InsetLayouts;
103 typedef LayoutList::const_iterator const_iterator;
105 ///////////////////////////////////////////////////////////////////
107 ///////////////////////////////////////////////////////////////////
109 const_iterator begin() const { return layoutlist_.begin(); }
111 const_iterator end() const { return layoutlist_.end(); }
114 ///////////////////////////////////////////////////////////////////
116 ///////////////////////////////////////////////////////////////////
118 Layout const & defaultLayout() const;
120 docstring const & defaultLayoutName() const;
122 bool isDefaultLayout(Layout const &) const;
124 bool isPlainLayout(Layout const &) const;
125 /// returns a special layout for use when we don't really want one,
126 /// e.g., in table cells
127 Layout const & plainLayout() const
128 { return operator[](plain_layout_); };
129 /// the name of the plain layout
130 docstring const & plainLayoutName() const
131 { return plain_layout_; }
132 /// Enumerate the paragraph styles.
133 size_t layoutCount() const { return layoutlist_.size(); }
135 bool hasLayout(docstring const & name) const;
137 Layout const & operator[](docstring const & vname) const;
138 /// Inset layouts of this doc class
139 InsetLayouts const & insetLayouts() const { return insetlayoutlist_; };
141 ///////////////////////////////////////////////////////////////////
143 ///////////////////////////////////////////////////////////////////
144 /// Enum used with TextClass::read
146 BASECLASS, //>This is a base class, i.e., top-level layout file
147 MERGE, //>This is a file included in a layout file
148 MODULE, //>This is a layout module
149 VALIDATION //>We're just validating
151 /// return values for read()
158 /// Performs the read of the layout file.
159 /// \return true on success.
160 bool read(support::FileName const & filename, ReadType rt = BASECLASS);
162 bool read(std::string const & str, ReadType rt = BASECLASS);
164 ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
165 /// validates the layout information passed in str
166 static bool validate(std::string const & str);
168 ///////////////////////////////////////////////////////////////////
170 ///////////////////////////////////////////////////////////////////
171 /// Sees to it the textclass structure has been loaded
172 /// This function will search for $classname.layout in default directories
173 /// and an optional path, but if path points to a file, it will be loaded
175 bool load(std::string const & path = std::string()) const;
176 /// Has this layout file been loaded yet?
177 /// Overridden by DocumentClass
178 virtual bool loaded() const { return loaded_; }
180 ///////////////////////////////////////////////////////////////////
182 ///////////////////////////////////////////////////////////////////
184 std::string const & name() const { return name_; };
186 std::string const & description() const { return description_; };
188 std::string const & latexname() const { return latexname_; }
190 /// Protect construction
193 Layout & operator[](docstring const & name);
194 /** Create an new, very basic layout for this textclass. This is used for
195 the Plain Layout common to all TextClass objects and also, in
196 DocumentClass, for the creation of new layouts `on the fly' when
197 previously unknown layouts are encountered.
198 \param unknown Set to true if this layout is used to represent an
201 Layout createBasicLayout(docstring const & name, bool unknown = false) const;
203 ///////////////////////////////////////////////////////////////////
204 // non-const iterators
205 ///////////////////////////////////////////////////////////////////
207 typedef LayoutList::iterator iterator;
209 iterator begin() { return layoutlist_.begin(); }
211 iterator end() { return layoutlist_.end(); }
213 ///////////////////////////////////////////////////////////////////
215 ///////////////////////////////////////////////////////////////////
216 /// Paragraph styles used in this layout
217 /// This variable is mutable because unknown layouts can be added
218 /// to const textclass.
219 mutable LayoutList layoutlist_;
222 /// document class name
223 std::string latexname_;
224 /// document class description
225 std::string description_;
226 /// available types of float, eg. figure, algorithm.
227 mutable FloatList floatlist_;
228 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
229 mutable Counters counters_;
230 /// Has this layout file been loaded yet?
231 mutable bool loaded_;
232 /// Is the TeX class available?
235 std::string opt_fontsize_;
237 std::string opt_pagestyle_;
238 /// Specific class options
239 std::string options_;
241 std::string pagestyle_;
243 std::string class_header_;
245 docstring defaultlayout_;
246 /// name of plain layout
247 static const docstring plain_layout_;
248 /// preamble text to support layout styles
250 /// latex packages loaded by document class.
251 std::set<std::string> provides_;
252 /// latex packages requested by document class.
253 std::set<std::string> requires_;
254 /// modules wanted by document class
255 std::list<std::string> usemod_;
257 unsigned int columns_;
260 /// header depth to have numbering
262 /// header depth to appear in table of contents
264 /// Can be LaTeX, DocBook, etc.
265 OutputType outputType_;
266 /** Base font. The paragraph and layout fonts are resolved against
267 this font. This has to be fully instantiated. Attributes
268 FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
271 FontInfo defaultfont_;
272 /// Text that dictates how wide the left margin is on the screen
273 docstring leftmargin_;
274 /// Text that dictates how wide the right margin is on the screen
275 docstring rightmargin_;
276 /// The type of command used to produce a title
277 TitleLatexType titletype_;
278 /// The name of the title command
279 std::string titlename_;
280 /// Input layouts available to this layout
281 InsetLayouts insetlayoutlist_;
282 /// The minimal TocLevel of sectioning layouts
284 /// The maximal TocLevel of sectioning layouts
287 ///////////////////////////////////////////////////////////////////
288 // helper routines for reading layout files
289 ///////////////////////////////////////////////////////////////////
291 bool deleteLayout(docstring const &);
293 bool convertLayoutFormat(support::FileName const &, ReadType);
294 /// \return true for success.
295 bool readStyle(Lexer &, Layout &) const;
297 void readOutputType(Lexer &);
299 void readTitleType(Lexer &);
301 void readMaxCounter(Lexer &);
303 void readClassOptions(Lexer &);
305 void readCharStyle(Lexer &, std::string const &);
307 void readFloat(Lexer &);
311 /// A DocumentClass represents the layout information associated with a
312 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
315 /// In that regard, DocumentClass objects are "dynamic". But this is really
316 /// an illusion, since DocumentClass objects are not (currently) changed
317 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
318 /// discarded---actually, it's kept around in case something on the cut
319 /// stack needs it---and a new one is created from scratch.
321 /// In the main LyX code, DocumentClass objects are created only by
322 /// DocumentClassBundle, for which see below.
324 class DocumentClass : public TextClass, boost::noncopyable {
327 virtual ~DocumentClass() {}
329 ///////////////////////////////////////////////////////////////////
331 ///////////////////////////////////////////////////////////////////
332 /// \return true if there is a Layout with latexname lay
333 bool hasLaTeXLayout(std::string const & lay) const;
334 /// A DocumentClass nevers count as loaded, since it is dynamic
335 virtual bool loaded() { return false; }
336 /// \return the layout object of an inset given by name. If the name
337 /// is not found as such, the part after the ':' is stripped off, and
338 /// searched again. In this way, an error fallback can be provided:
339 /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
340 /// will invoke the layout object defined by name = 'CharStyle'.
341 /// If that doesn't work either, an empty object returns (shouldn't
342 /// happen). -- Idea JMarc, comment MV
343 InsetLayout const & insetLayout(docstring const & name) const;
344 /// a plain inset layout for use as a default
345 static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; }
346 /// add a new layout \c name if it does not exist in layoutlist_
347 void addLayoutIfNeeded(docstring const & name) const;
349 ///////////////////////////////////////////////////////////////////
351 ///////////////////////////////////////////////////////////////////
352 /// the list of floats defined in the document class
353 FloatList const & floats() const { return floatlist_; }
355 Counters & counters() const { return counters_; }
357 std::string const & opt_fontsize() const { return opt_fontsize_; }
359 std::string const & opt_pagestyle() const { return opt_pagestyle_; }
361 std::string const & options() const { return options_; }
363 std::string const & class_header() const { return class_header_; }
365 std::string const & pagestyle() const { return pagestyle_; }
367 docstring const & preamble() const { return preamble_; }
368 /// is this feature already provided by the class?
369 bool provides(std::string const & p) const;
370 /// features required by the class?
371 std::set<std::string> const & requires() const { return requires_; }
373 unsigned int columns() const { return columns_; }
375 PageSides sides() const { return sides_; }
377 int secnumdepth() const { return secnumdepth_; }
379 int tocdepth() const { return tocdepth_; }
381 FontInfo const & defaultfont() const { return defaultfont_; }
382 /// Text that dictates how wide the left margin is on the screen
383 docstring const & leftmargin() const { return leftmargin_; }
384 /// Text that dictates how wide the right margin is on the screen
385 docstring const & rightmargin() const { return rightmargin_; }
386 /// The type of command used to produce a title
387 TitleLatexType titletype() const { return titletype_; };
388 /// The name of the title command
389 std::string const & titlename() const { return titlename_; };
391 int size() const { return layoutlist_.size(); }
392 /// The minimal TocLevel of sectioning layouts
393 int min_toclevel() const { return min_toclevel_; }
394 /// The maximal TocLevel of sectioning layouts
395 int max_toclevel() const { return max_toclevel_; }
396 /// returns true if the class has a ToC structure
397 bool hasTocLevels() const;
398 /// Can be LaTeX, DocBook, etc.
399 OutputType outputType() const { return outputType_; }
401 /// Constructs a DocumentClass based upon a LayoutFile.
402 DocumentClass(LayoutFile const & tc);
403 /// Needed in tex2lyx
406 /// The only class that can create a DocumentClass is
407 /// DocumentClassBundle, which calls the protected constructor.
408 friend class DocumentClassBundle;
410 static InsetLayout plain_insetlayout_;
414 /// DocumentClassBundle is a container for DocumentClass objects, so that
415 /// they stay in memory for use by Insets, CutAndPaste, and the like, even
416 /// when their associated Buffers are destroyed.
417 /// FIXME Some sort of garbage collection or reference counting wouldn't
418 /// be a bad idea here. It might be enough to check when a Buffer is closed
419 /// (or makeDocumentClass is called) whether the old DocumentClass is in use
422 /// This is a singleton class. Its sole instance is accessed via
423 /// DocumentClassBundle::get().
424 class DocumentClassBundle : boost::noncopyable {
426 /// \return Pointer to a new class equal to baseClass
427 DocumentClass & newClass(LayoutFile const & baseClass);
428 /// \return The sole instance of this class.
429 static DocumentClassBundle & get();
431 /// control instantiation
432 DocumentClassBundle() {}
434 ~DocumentClassBundle();
436 std::vector<DocumentClass *> documentClasses_;
440 /// convert page sides option to text 1 or 2
441 std::ostream & operator<<(std::ostream & os, PageSides p);