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 bool hasInsetLayout(docstring const & name) const;
139 Layout const & operator[](docstring const & vname) const;
140 /// Inset layouts of this doc class
141 InsetLayouts const & insetLayouts() const { return insetlayoutlist_; };
143 ///////////////////////////////////////////////////////////////////
145 ///////////////////////////////////////////////////////////////////
146 /// Enum used with TextClass::read
148 BASECLASS, //>This is a base class, i.e., top-level layout file
149 MERGE, //>This is a file included in a layout file
150 MODULE, //>This is a layout module
151 VALIDATION //>We're just validating
153 /// return values for read()
160 /// Performs the read of the layout file.
161 /// \return true on success.
162 bool read(support::FileName const & filename, ReadType rt = BASECLASS);
164 bool read(std::string const & str, ReadType rt = BASECLASS);
166 ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
167 /// validates the layout information passed in str
168 static bool validate(std::string const & str);
170 ///////////////////////////////////////////////////////////////////
172 ///////////////////////////////////////////////////////////////////
173 /// Sees to it the textclass structure has been loaded
174 /// This function will search for $classname.layout in default directories
175 /// and an optional path, but if path points to a file, it will be loaded
177 bool load(std::string const & path = std::string()) const;
178 /// Has this layout file been loaded yet?
179 /// Overridden by DocumentClass
180 virtual bool loaded() const { return loaded_; }
182 ///////////////////////////////////////////////////////////////////
184 ///////////////////////////////////////////////////////////////////
186 std::string const & name() const { return name_; };
188 std::string const & description() const { return description_; };
190 std::string const & latexname() const { return latexname_; }
192 /// Protect construction
195 Layout & operator[](docstring const & name);
196 /** Create an new, very basic layout for this textclass. This is used for
197 the Plain Layout common to all TextClass objects and also, in
198 DocumentClass, for the creation of new layouts `on the fly' when
199 previously unknown layouts are encountered.
200 \param unknown Set to true if this layout is used to represent an
203 Layout createBasicLayout(docstring const & name, bool unknown = false) const;
205 ///////////////////////////////////////////////////////////////////
206 // non-const iterators
207 ///////////////////////////////////////////////////////////////////
209 typedef LayoutList::iterator iterator;
211 iterator begin() { return layoutlist_.begin(); }
213 iterator end() { return layoutlist_.end(); }
215 ///////////////////////////////////////////////////////////////////
217 ///////////////////////////////////////////////////////////////////
218 /// Paragraph styles used in this layout
219 /// This variable is mutable because unknown layouts can be added
220 /// to const textclass.
221 mutable LayoutList layoutlist_;
224 /// document class name
225 std::string latexname_;
226 /// document class description
227 std::string description_;
228 /// available types of float, eg. figure, algorithm.
229 mutable FloatList floatlist_;
230 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
231 mutable Counters counters_;
232 /// Has this layout file been loaded yet?
233 mutable bool loaded_;
234 /// Is the TeX class available?
237 std::string opt_fontsize_;
239 std::string opt_pagestyle_;
240 /// Specific class options
241 std::string options_;
243 std::string pagestyle_;
245 std::string class_header_;
247 docstring defaultlayout_;
248 /// name of plain layout
249 static const docstring plain_layout_;
250 /// preamble text to support layout styles
252 /// latex packages loaded by document class.
253 std::set<std::string> provides_;
254 /// latex packages requested by document class.
255 std::set<std::string> requires_;
256 /// default modules wanted by document class
257 std::list<std::string> default_modules_;
258 /// modules provided by document class
259 std::list<std::string> provided_modules_;
260 /// modules excluded by document class
261 std::list<std::string> excluded_modules_;
263 unsigned int columns_;
266 /// header depth to have numbering
268 /// header depth to appear in table of contents
270 /// Can be LaTeX, DocBook, etc.
271 OutputType outputType_;
272 /** Base font. The paragraph and layout fonts are resolved against
273 this font. This has to be fully instantiated. Attributes
274 FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
277 FontInfo defaultfont_;
278 /// Text that dictates how wide the left margin is on the screen
279 docstring leftmargin_;
280 /// Text that dictates how wide the right margin is on the screen
281 docstring rightmargin_;
282 /// The type of command used to produce a title
283 TitleLatexType titletype_;
284 /// The name of the title command
285 std::string titlename_;
286 /// Input layouts available to this layout
287 InsetLayouts insetlayoutlist_;
288 /// The minimal TocLevel of sectioning layouts
290 /// The maximal TocLevel of sectioning layouts
293 ///////////////////////////////////////////////////////////////////
294 // helper routines for reading layout files
295 ///////////////////////////////////////////////////////////////////
297 bool deleteLayout(docstring const &);
299 bool convertLayoutFormat(support::FileName const &, ReadType);
300 /// \return true for success.
301 bool readStyle(Lexer &, Layout &) const;
303 void readOutputType(Lexer &);
305 void readTitleType(Lexer &);
307 void readMaxCounter(Lexer &);
309 void readClassOptions(Lexer &);
311 void readCharStyle(Lexer &, std::string const &);
313 void readFloat(Lexer &);
317 /// A DocumentClass represents the layout information associated with a
318 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
321 /// In that regard, DocumentClass objects are "dynamic". But this is really
322 /// an illusion, since DocumentClass objects are not (currently) changed
323 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
324 /// discarded---actually, it's kept around in case something on the cut
325 /// stack needs it---and a new one is created from scratch.
327 /// In the main LyX code, DocumentClass objects are created only by
328 /// DocumentClassBundle, for which see below.
330 class DocumentClass : public TextClass, boost::noncopyable {
333 virtual ~DocumentClass() {}
335 ///////////////////////////////////////////////////////////////////
337 ///////////////////////////////////////////////////////////////////
338 /// \return true if there is a Layout with latexname lay
339 bool hasLaTeXLayout(std::string const & lay) const;
340 /// A DocumentClass nevers count as loaded, since it is dynamic
341 virtual bool loaded() { return false; }
342 /// \return the layout object of an inset given by name. If the name
343 /// is not found as such, the part after the ':' is stripped off, and
344 /// searched again. In this way, an error fallback can be provided:
345 /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
346 /// will invoke the layout object defined by name = 'CharStyle'.
347 /// If that doesn't work either, an empty object returns (shouldn't
348 /// happen). -- Idea JMarc, comment MV
349 InsetLayout const & insetLayout(docstring const & name) const;
350 /// a plain inset layout for use as a default
351 static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; }
352 /// add a new layout \c name if it does not exist in layoutlist_
353 void addLayoutIfNeeded(docstring const & name) const;
355 ///////////////////////////////////////////////////////////////////
357 ///////////////////////////////////////////////////////////////////
358 /// the list of floats defined in the document class
359 FloatList const & floats() const { return floatlist_; }
361 Counters & counters() const { return counters_; }
363 std::string const & opt_fontsize() const { return opt_fontsize_; }
365 std::string const & opt_pagestyle() const { return opt_pagestyle_; }
367 std::string const & options() const { return options_; }
369 std::string const & class_header() const { return class_header_; }
371 std::string const & pagestyle() const { return pagestyle_; }
373 docstring const & preamble() const { return preamble_; }
374 /// is this feature already provided by the class?
375 bool provides(std::string const & p) const;
376 /// features required by the class?
377 std::set<std::string> const & requires() const { return requires_; }
379 unsigned int columns() const { return columns_; }
381 PageSides sides() const { return sides_; }
383 int secnumdepth() const { return secnumdepth_; }
385 int tocdepth() const { return tocdepth_; }
387 FontInfo const & defaultfont() const { return defaultfont_; }
388 /// Text that dictates how wide the left margin is on the screen
389 docstring const & leftmargin() const { return leftmargin_; }
390 /// Text that dictates how wide the right margin is on the screen
391 docstring const & rightmargin() const { return rightmargin_; }
392 /// The type of command used to produce a title
393 TitleLatexType titletype() const { return titletype_; };
394 /// The name of the title command
395 std::string const & titlename() const { return titlename_; };
397 int size() const { return layoutlist_.size(); }
398 /// The minimal TocLevel of sectioning layouts
399 int min_toclevel() const { return min_toclevel_; }
400 /// The maximal TocLevel of sectioning layouts
401 int max_toclevel() const { return max_toclevel_; }
402 /// returns true if the class has a ToC structure
403 bool hasTocLevels() const;
404 /// Can be LaTeX, DocBook, etc.
405 OutputType outputType() const { return outputType_; }
407 /// Constructs a DocumentClass based upon a LayoutFile.
408 DocumentClass(LayoutFile const & tc);
409 /// Needed in tex2lyx
412 /// The only class that can create a DocumentClass is
413 /// DocumentClassBundle, which calls the protected constructor.
414 friend class DocumentClassBundle;
416 static InsetLayout plain_insetlayout_;
420 /// DocumentClassBundle is a container for DocumentClass objects, so that
421 /// they stay in memory for use by Insets, CutAndPaste, and the like, even
422 /// when their associated Buffers are destroyed.
423 /// FIXME Some sort of garbage collection or reference counting wouldn't
424 /// be a bad idea here. It might be enough to check when a Buffer is closed
425 /// (or makeDocumentClass is called) whether the old DocumentClass is in use
428 /// This is a singleton class. Its sole instance is accessed via
429 /// DocumentClassBundle::get().
430 class DocumentClassBundle : boost::noncopyable {
432 /// \return Pointer to a new class equal to baseClass
433 DocumentClass & newClass(LayoutFile const & baseClass);
434 /// \return The sole instance of this class.
435 static DocumentClassBundle & get();
437 /// control instantiation
438 DocumentClassBundle() {}
440 ~DocumentClassBundle();
442 std::vector<DocumentClass *> documentClasses_;
446 /// convert page sides option to text 1 or 2
447 std::ostream & operator<<(std::ostream & os, PageSides p);