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 & emptyLayout() const
128 { return operator[](emptylayout_); };
129 /// the name of the empty layout
130 docstring const & emptyLayoutName() const
131 { return emptylayout_; }
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;
139 ///////////////////////////////////////////////////////////////////
141 ///////////////////////////////////////////////////////////////////
142 /// Enum used with TextClass::read
144 BASECLASS, //>This is a base class, i.e., top-level layout file
145 MERGE, //>This is a file included in a layout file
146 MODULE, //>This is a layout module
147 VALIDATION //>We're just validating
149 /// return values for read()
156 /// Performs the read of the layout file.
157 /// \return true on success.
158 bool read(support::FileName const & filename, ReadType rt = BASECLASS);
160 bool read(std::string const & str, ReadType rt = BASECLASS);
162 ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
163 /// validates the layout information passed in str
164 static bool validate(std::string const & str);
166 ///////////////////////////////////////////////////////////////////
168 ///////////////////////////////////////////////////////////////////
169 /// Sees to it the textclass structure has been loaded
170 /// This function will search for $classname.layout in default directories
171 /// and an optional path, but if path points to a file, it will be loaded
173 bool load(std::string const & path = std::string()) const;
174 /// Has this layout file been loaded yet?
175 /// Overridden by DocumentClass
176 virtual bool loaded() const { return loaded_; }
178 ///////////////////////////////////////////////////////////////////
180 ///////////////////////////////////////////////////////////////////
182 std::string const & name() const { return name_; };
184 std::string const & description() const { return description_; };
186 std::string const & latexname() const { return latexname_; }
188 /// Protect construction
191 Layout & operator[](docstring const & vname);
192 /// Create an empty layout for this textclass.
193 /** \param unknown Set to true if this layout is a default layout used to
194 * represent an unknown layout
196 Layout createEmptyLayout(docstring const & name, bool unknown = false) const;
198 ///////////////////////////////////////////////////////////////////
199 // non-const iterators
200 ///////////////////////////////////////////////////////////////////
202 typedef LayoutList::iterator iterator;
204 iterator begin() { return layoutlist_.begin(); }
206 iterator end() { return layoutlist_.end(); }
208 ///////////////////////////////////////////////////////////////////
210 ///////////////////////////////////////////////////////////////////
211 /// Paragraph styles used in this layout
212 /// This variable is mutable because unknown layouts can be added
213 /// to const textclass.
214 mutable LayoutList layoutlist_;
217 /// document class name
218 std::string latexname_;
219 /// document class description
220 std::string description_;
221 /// available types of float, eg. figure, algorithm.
222 mutable FloatList floatlist_;
223 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
224 mutable Counters counters_;
225 /// Has this layout file been loaded yet?
226 mutable bool loaded_;
227 /// Is the TeX class available?
230 std::string opt_fontsize_;
232 std::string opt_pagestyle_;
233 /// Specific class options
234 std::string options_;
236 std::string pagestyle_;
238 std::string class_header_;
240 docstring defaultlayout_;
241 /// name of empty layout
242 static const docstring emptylayout_;
243 /// preamble text to support layout styles
245 /// latex packages loaded by document class.
246 std::set<std::string> provides_;
247 /// latex packages requested by document class.
248 std::set<std::string> requires_;
250 unsigned int columns_;
253 /// header depth to have numbering
255 /// header depth to appear in table of contents
257 /// Can be LaTeX, DocBook, etc.
258 OutputType outputType_;
259 /** Base font. The paragraph and layout fonts are resolved against
260 this font. This has to be fully instantiated. Attributes
261 FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
264 FontInfo defaultfont_;
265 /// Text that dictates how wide the left margin is on the screen
266 docstring leftmargin_;
267 /// Text that dictates how wide the right margin is on the screen
268 docstring rightmargin_;
269 /// The type of command used to produce a title
270 TitleLatexType titletype_;
271 /// The name of the title command
272 std::string titlename_;
273 /// Input layouts available to this layout
274 InsetLayouts insetlayoutlist_;
275 /// The minimal TocLevel of sectioning layouts
277 /// The maximal TocLevel of sectioning layouts
280 ///////////////////////////////////////////////////////////////////
281 // helper routines for reading layout files
282 ///////////////////////////////////////////////////////////////////
284 bool deleteLayout(docstring const &);
286 bool convertLayoutFormat(support::FileName const &, ReadType);
287 /// \return true for success.
288 bool readStyle(Lexer &, Layout &) const;
290 void readOutputType(Lexer &);
292 void readTitleType(Lexer &);
294 void readMaxCounter(Lexer &);
296 void readClassOptions(Lexer &);
298 void readCharStyle(Lexer &, std::string const &);
300 void readFloat(Lexer &);
302 void readCounter(Lexer &);
306 /// A DocumentClass represents the layout information associated with a
307 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
310 /// In that regard, DocumentClass objects are "dynamic". But this is really
311 /// an illusion, since DocumentClass objects are not (currently) changed
312 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
313 /// discarded---actually, it's kept around in case something on the cut
314 /// stack needs it---and a new one is created from scratch.
316 /// In the main LyX code, DocumentClass objects are created only by
317 /// DocumentClassBundle, for which see below.
319 class DocumentClass : public TextClass, boost::noncopyable {
322 virtual ~DocumentClass() {}
324 ///////////////////////////////////////////////////////////////////
326 ///////////////////////////////////////////////////////////////////
327 /// \return true if there is a Layout with latexname lay
328 bool hasLaTeXLayout(std::string const & lay) const;
329 /// A DocumentClass nevers count as loaded, since it is dynamic
330 virtual bool loaded() { return false; }
331 /// Inset layouts of this doc class
332 InsetLayouts const & insetLayouts() const { return insetlayoutlist_; };
333 /// \return the layout object of an inset given by name. If the name
334 /// is not found as such, the part after the ':' is stripped off, and
335 /// searched again. In this way, an error fallback can be provided:
336 /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
337 /// will invoke the layout object defined by name = 'CharStyle'.
338 /// If that doesn't work either, an empty object returns (shouldn't
339 /// happen). -- Idea JMarc, comment MV
340 InsetLayout const & insetLayout(docstring const & name) const;
341 /// an empty inset layout for use as a default
342 static InsetLayout const & emptyInsetLayout() { return empty_insetlayout_; }
343 /// add an empty layout \c name if it does not exist in layoutlist_
344 void addLayoutIfNeeded(docstring const & name) const;
346 ///////////////////////////////////////////////////////////////////
348 ///////////////////////////////////////////////////////////////////
349 /// the list of floats defined in the document class
350 FloatList const & floats() const { return floatlist_; }
352 Counters & counters() const { return counters_; }
354 std::string const & opt_fontsize() const { return opt_fontsize_; }
356 std::string const & opt_pagestyle() const { return opt_pagestyle_; }
358 std::string const & options() const { return options_; }
360 std::string const & class_header() const { return class_header_; }
362 std::string const & pagestyle() const { return pagestyle_; }
364 docstring const & preamble() const { return preamble_; }
365 /// is this feature already provided by the class?
366 bool provides(std::string const & p) const;
367 /// features required by the class?
368 std::set<std::string> const & requires() const { return requires_; }
370 unsigned int columns() const { return columns_; }
372 PageSides sides() const { return sides_; }
374 int secnumdepth() const { return secnumdepth_; }
376 int tocdepth() const { return tocdepth_; }
378 FontInfo const & defaultfont() const { return defaultfont_; }
379 /// Text that dictates how wide the left margin is on the screen
380 docstring const & leftmargin() const { return leftmargin_; }
381 /// Text that dictates how wide the right margin is on the screen
382 docstring const & rightmargin() const { return rightmargin_; }
383 /// The type of command used to produce a title
384 TitleLatexType titletype() const { return titletype_; };
385 /// The name of the title command
386 std::string const & titlename() const { return titlename_; };
388 int size() const { return layoutlist_.size(); }
389 /// The minimal TocLevel of sectioning layouts
390 int min_toclevel() const { return min_toclevel_; }
391 /// The maximal TocLevel of sectioning layouts
392 int max_toclevel() const { return max_toclevel_; }
393 /// returns true if the class has a ToC structure
394 bool hasTocLevels() const;
395 /// Can be LaTeX, DocBook, etc.
396 OutputType outputType() const { return outputType_; }
398 /// Constructs a DocumentClass based upon a LayoutFile.
399 DocumentClass(LayoutFile const & tc);
400 /// Needed in tex2lyx
403 /// The only class that can create a DocumentClass is
404 /// DocumentClassBundle, which calls the protected constructor.
405 friend class DocumentClassBundle;
407 static InsetLayout empty_insetlayout_;
411 /// DocumentClassBundle is a container for DocumentClass objects, so that
412 /// they stay in memory for use by Insets, CutAndPaste, and the like, even
413 /// when their associated Buffers are destroyed.
414 /// FIXME Some sort of garbage collection or reference counting wouldn't
415 /// be a bad idea here. It might be enough to check when a Buffer is closed
416 /// (or makeDocumentClass is called) whether the old DocumentClass is in use
419 /// This is a singleton class. Its sole instance is accessed via
420 /// DocumentClassBundle::get().
421 class DocumentClassBundle : boost::noncopyable {
423 /// \return Pointer to a new class equal to baseClass
424 DocumentClass & newClass(LayoutFile const & baseClass);
425 /// \return The sole instance of this class.
426 static DocumentClassBundle & get();
428 /// control instantiation
429 DocumentClassBundle() {}
431 ~DocumentClassBundle();
433 std::vector<DocumentClass *> documentClasses_;
437 /// convert page sides option to text 1 or 2
438 std::ostream & operator<<(std::ostream & os, PageSides p);