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"
19 #include "LayoutModuleList.h"
21 #include "insets/InsetLayout.h"
23 #include "support/docstring.h"
24 #include "support/types.h"
26 #include <boost/noncopyable.hpp>
35 namespace support { class FileName; }
43 /// Based upon ideas in boost::noncopyable, inheriting from this
44 /// class effectively makes the copy constructor protected but the
45 /// assignment constructor private.
51 ProtectCopy(const ProtectCopy &) {};
53 const ProtectCopy & operator=(const ProtectCopy &);
57 /// A TextClass represents a collection of layout information: At the
58 /// moment, this includes Layout's and InsetLayout's.
60 /// There are two major subclasses of TextClass: LayoutFile and
61 /// DocumentClass. These subclasses are what are actually used in LyX.
62 /// Simple TextClass objects are not directly constructed in the main
63 /// LyX code---the constructor is protected. (That said, in tex2lyx
64 /// there are what amount to simple TextClass objects.)
66 /// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file.
67 /// These are generally static objects---though they can be reloaded
68 /// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
69 /// they will never change.
71 /// A DocumentClass (see below) represents the layout information that
72 /// is associated with a given Buffer. These are static, in the sense
73 /// that they will not themselves change, but which DocumentClass is
74 /// associated with a Buffer can change, as modules are loaded and
75 /// unloaded, for example.
77 class TextClass : protected ProtectCopy {
80 virtual ~TextClass() {};
81 ///////////////////////////////////////////////////////////////////
83 ///////////////////////////////////////////////////////////////////
84 /// The individual paragraph layouts comprising the document class
85 // NOTE Do NOT try to make this a container of Layout pointers, e.g.,
86 // std::vector<Layout *>. This will lead to problems. The reason is
87 // that DocumentClass objects are generally created by copying a
88 // LayoutFile, which serves as a base for the DocumentClass. If the
89 // LayoutList is a container of pointers, then every DocumentClass
90 // that derives from a given LayoutFile (e.g., article) will SHARE
91 // a basic set of layouts. So if one Buffer were to modify a layout
92 // (say, Standard), that would modify that layout for EVERY Buffer
93 // that was based upon the same DocumentClass. (Of course, if you
94 // really, REALLY want to make LayoutList a vector<Layout *>, then
95 // you can implement custom assignment and copy constructors.)
97 // NOTE: Layout pointers are directly assigned to paragraphs so a
98 // container that does not invalidate these pointers after insertion
100 typedef std::list<Layout> LayoutList;
101 /// The inset layouts available to this class
102 typedef std::map<docstring, InsetLayout> InsetLayouts;
104 typedef LayoutList::const_iterator const_iterator;
106 ///////////////////////////////////////////////////////////////////
108 ///////////////////////////////////////////////////////////////////
110 const_iterator begin() const { return layoutlist_.begin(); }
112 const_iterator end() const { return layoutlist_.end(); }
115 ///////////////////////////////////////////////////////////////////
117 ///////////////////////////////////////////////////////////////////
119 Layout const & defaultLayout() const;
121 docstring const & defaultLayoutName() const;
123 bool isDefaultLayout(Layout const &) const;
125 bool isPlainLayout(Layout const &) const;
126 /// returns a special layout for use when we don't really want one,
127 /// e.g., in table cells
128 Layout const & plainLayout() const
129 { return operator[](plain_layout_); };
130 /// the name of the plain layout
131 docstring const & plainLayoutName() const
132 { return plain_layout_; }
133 /// Enumerate the paragraph styles.
134 size_t layoutCount() const { return layoutlist_.size(); }
136 bool hasLayout(docstring const & name) const;
138 bool hasInsetLayout(docstring const & name) const;
140 Layout const & operator[](docstring const & vname) const;
141 /// Inset layouts of this doc class
142 InsetLayouts const & insetLayouts() const { return insetlayoutlist_; };
144 ///////////////////////////////////////////////////////////////////
146 ///////////////////////////////////////////////////////////////////
147 /// Enum used with TextClass::read
149 BASECLASS, //>This is a base class, i.e., top-level layout file
150 MERGE, //>This is a file included in a layout file
151 MODULE, //>This is a layout module
152 VALIDATION //>We're just validating
154 /// return values for read()
161 /// Performs the read of the layout file.
162 /// \return true on success.
163 bool read(support::FileName const & filename, ReadType rt = BASECLASS);
165 bool read(std::string const & str, ReadType rt = BASECLASS);
167 ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
168 /// validates the layout information passed in str
169 static bool validate(std::string const & str);
171 ///////////////////////////////////////////////////////////////////
173 ///////////////////////////////////////////////////////////////////
174 /// Sees to it the textclass structure has been loaded
175 /// This function will search for $classname.layout in default directories
176 /// and an optional path, but if path points to a file, it will be loaded
178 bool load(std::string const & path = std::string()) const;
179 /// Has this layout file been loaded yet?
180 /// Overridden by DocumentClass
181 virtual bool loaded() const { return loaded_; }
183 ///////////////////////////////////////////////////////////////////
185 ///////////////////////////////////////////////////////////////////
187 std::string const & name() const { return name_; }
189 std::string const & description() const { return description_; }
191 std::string const & latexname() const { return latexname_; }
192 /// Can be LaTeX, DocBook, etc.
193 OutputType outputType() const { return outputType_; }
194 /// Can be latex, docbook ... (the name of a format)
195 std::string outputFormat() const { return outputFormat_; }
197 /// Protect construction
200 Layout & operator[](docstring const & name);
201 /** Create an new, very basic layout for this textclass. This is used for
202 the Plain Layout common to all TextClass objects and also, in
203 DocumentClass, for the creation of new layouts `on the fly' when
204 previously unknown layouts are encountered.
205 \param unknown Set to true if this layout is used to represent an
208 Layout createBasicLayout(docstring const & name, bool unknown = false) const;
210 ///////////////////////////////////////////////////////////////////
211 // non-const iterators
212 ///////////////////////////////////////////////////////////////////
214 typedef LayoutList::iterator iterator;
216 iterator begin() { return layoutlist_.begin(); }
218 iterator end() { return layoutlist_.end(); }
220 ///////////////////////////////////////////////////////////////////
222 ///////////////////////////////////////////////////////////////////
223 /// Paragraph styles used in this layout
224 /// This variable is mutable because unknown layouts can be added
225 /// to const textclass.
226 mutable LayoutList layoutlist_;
229 /// document class name
230 std::string latexname_;
231 /// document class description
232 std::string description_;
233 /// available types of float, eg. figure, algorithm.
234 mutable FloatList floatlist_;
235 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
236 mutable Counters counters_;
237 /// Has this layout file been loaded yet?
238 mutable bool loaded_;
239 /// Is the TeX class available?
242 std::string opt_fontsize_;
244 std::string opt_pagestyle_;
245 /// Specific class options
246 std::string options_;
248 std::string pagestyle_;
250 std::string class_header_;
252 docstring defaultlayout_;
253 /// name of plain layout
254 static const docstring plain_layout_;
255 /// preamble text to support layout styles
257 /// same, but for HTML output
258 docstring htmlpreamble_;
259 /// latex packages loaded by document class.
260 std::set<std::string> provides_;
261 /// latex packages requested by document class.
262 std::set<std::string> requires_;
263 /// default modules wanted by document class
264 LayoutModuleList default_modules_;
265 /// modules provided by document class
266 LayoutModuleList provided_modules_;
267 /// modules excluded by document class
268 LayoutModuleList excluded_modules_;
270 unsigned int columns_;
273 /// header depth to have numbering
275 /// header depth to appear in table of contents
277 /// Can be LaTeX, DocBook, etc.
278 OutputType outputType_;
279 /// Can be latex, docbook ... (the name of a format)
280 std::string outputFormat_;
281 /** Base font. The paragraph and layout fonts are resolved against
282 this font. This has to be fully instantiated. Attributes
283 FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
286 FontInfo defaultfont_;
287 /// Text that dictates how wide the left margin is on the screen
288 docstring leftmargin_;
289 /// Text that dictates how wide the right margin is on the screen
290 docstring rightmargin_;
291 /// The type of command used to produce a title
292 TitleLatexType titletype_;
293 /// The name of the title command
294 std::string titlename_;
295 /// Input layouts available to this layout
296 InsetLayouts insetlayoutlist_;
297 /// The minimal TocLevel of sectioning layouts
299 /// The maximal TocLevel of sectioning layouts
302 ///////////////////////////////////////////////////////////////////
303 // helper routines for reading layout files
304 ///////////////////////////////////////////////////////////////////
306 bool deleteLayout(docstring const &);
308 bool convertLayoutFormat(support::FileName const &, ReadType);
309 /// Reads the layout file without running layout2layout.
310 ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
311 /// \return true for success.
312 bool readStyle(Lexer &, Layout &) const;
314 void readOutputType(Lexer &);
316 void readTitleType(Lexer &);
318 void readMaxCounter(Lexer &);
320 void readClassOptions(Lexer &);
322 void readCharStyle(Lexer &, std::string const &);
324 void readFloat(Lexer &);
328 /// A DocumentClass represents the layout information associated with a
329 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
332 /// In that regard, DocumentClass objects are "dynamic". But this is really
333 /// an illusion, since DocumentClass objects are not (currently) changed
334 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
335 /// discarded---actually, it's kept around in case something on the cut
336 /// stack needs it---and a new one is created from scratch.
338 /// In the main LyX code, DocumentClass objects are created only by
339 /// DocumentClassBundle, for which see below.
341 class DocumentClass : public TextClass, boost::noncopyable {
344 virtual ~DocumentClass() {}
346 ///////////////////////////////////////////////////////////////////
348 ///////////////////////////////////////////////////////////////////
349 /// \return true if there is a Layout with latexname lay
350 bool hasLaTeXLayout(std::string const & lay) const;
351 /// A DocumentClass nevers count as loaded, since it is dynamic
352 virtual bool loaded() { return false; }
353 /// \return the layout object of an inset given by name. If the name
354 /// is not found as such, the part after the ':' is stripped off, and
355 /// searched again. In this way, an error fallback can be provided:
356 /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
357 /// will invoke the layout object defined by name = 'CharStyle'.
358 /// If that doesn't work either, an empty object returns (shouldn't
359 /// happen). -- Idea JMarc, comment MV
360 InsetLayout const & insetLayout(docstring const & name) const;
361 /// a plain inset layout for use as a default
362 static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; }
363 /// add a new layout \c name if it does not exist in layoutlist_
364 void addLayoutIfNeeded(docstring const & name) const;
366 ///////////////////////////////////////////////////////////////////
368 ///////////////////////////////////////////////////////////////////
369 /// the list of floats defined in the document class
370 FloatList const & floats() const { return floatlist_; }
372 Counters & counters() const { return counters_; }
374 std::string const & opt_fontsize() const { return opt_fontsize_; }
376 std::string const & opt_pagestyle() const { return opt_pagestyle_; }
378 std::string const & options() const { return options_; }
380 std::string const & class_header() const { return class_header_; }
382 std::string const & pagestyle() const { return pagestyle_; }
384 docstring const & preamble() const { return preamble_; }
386 docstring const & htmlpreamble() const { return htmlpreamble_; }
387 /// is this feature already provided by the class?
388 bool provides(std::string const & p) const;
389 /// features required by the class?
390 std::set<std::string> const & requires() const { return requires_; }
392 unsigned int columns() const { return columns_; }
394 PageSides sides() const { return sides_; }
396 int secnumdepth() const { return secnumdepth_; }
398 int tocdepth() const { return tocdepth_; }
400 FontInfo const & defaultfont() const { return defaultfont_; }
401 /// Text that dictates how wide the left margin is on the screen
402 docstring const & leftmargin() const { return leftmargin_; }
403 /// Text that dictates how wide the right margin is on the screen
404 docstring const & rightmargin() const { return rightmargin_; }
405 /// The type of command used to produce a title
406 TitleLatexType titletype() const { return titletype_; };
407 /// The name of the title command
408 std::string const & titlename() const { return titlename_; };
410 int size() const { return layoutlist_.size(); }
411 /// The minimal TocLevel of sectioning layouts
412 int min_toclevel() const { return min_toclevel_; }
413 /// The maximal TocLevel of sectioning layouts
414 int max_toclevel() const { return max_toclevel_; }
415 /// returns true if the class has a ToC structure
416 bool hasTocLevels() const;
418 /// Constructs a DocumentClass based upon a LayoutFile.
419 DocumentClass(LayoutFile const & tc);
420 /// Needed in tex2lyx
423 /// The only class that can create a DocumentClass is
424 /// DocumentClassBundle, which calls the protected constructor.
425 friend class DocumentClassBundle;
427 static InsetLayout plain_insetlayout_;
431 /// DocumentClassBundle is a container for DocumentClass objects, so that
432 /// they stay in memory for use by Insets, CutAndPaste, and the like, even
433 /// when their associated Buffers are destroyed.
434 /// FIXME Some sort of garbage collection or reference counting wouldn't
435 /// be a bad idea here. It might be enough to check when a Buffer is closed
436 /// (or makeDocumentClass is called) whether the old DocumentClass is in use
439 /// This is a singleton class. Its sole instance is accessed via
440 /// DocumentClassBundle::get().
441 class DocumentClassBundle : boost::noncopyable {
443 /// \return The sole instance of this class.
444 static DocumentClassBundle & get();
445 /// \return A new DocumentClass based on baseClass, with info added
446 /// from the modules in modlist.
447 DocumentClass & makeDocumentClass(LayoutFile const & baseClass,
448 LayoutModuleList const & modlist);
450 /// control instantiation
451 DocumentClassBundle() {}
453 ~DocumentClassBundle();
454 /// \return Reference to a new DocumentClass equal to baseClass
455 DocumentClass & newClass(LayoutFile const & baseClass);
457 std::vector<DocumentClass *> documentClasses_;
461 /// convert page sides option to text 1 or 2
462 std::ostream & operator<<(std::ostream & os, PageSides p);