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 /// this is output as is to the header
259 docstring htmlpreamble_;
260 /// the paragraph style to use for TOCs, Bibliography, etc
261 mutable docstring html_toc_section_;
262 /// latex packages loaded by document class.
263 std::set<std::string> provides_;
264 /// latex packages requested by document class.
265 std::set<std::string> requires_;
266 /// default modules wanted by document class
267 LayoutModuleList default_modules_;
268 /// modules provided by document class
269 LayoutModuleList provided_modules_;
270 /// modules excluded by document class
271 LayoutModuleList excluded_modules_;
273 unsigned int columns_;
276 /// header depth to have numbering
278 /// header depth to appear in table of contents
280 /// Can be LaTeX, DocBook, etc.
281 OutputType outputType_;
282 /// Can be latex, docbook ... (the name of a format)
283 std::string outputFormat_;
284 /** Base font. The paragraph and layout fonts are resolved against
285 this font. This has to be fully instantiated. Attributes
286 FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
289 FontInfo defaultfont_;
290 /// Text that dictates how wide the left margin is on the screen
291 docstring leftmargin_;
292 /// Text that dictates how wide the right margin is on the screen
293 docstring rightmargin_;
294 /// The type of command used to produce a title
295 TitleLatexType titletype_;
296 /// The name of the title command
297 std::string titlename_;
298 /// Input layouts available to this layout
299 InsetLayouts insetlayoutlist_;
300 /// The minimal TocLevel of sectioning layouts
302 /// The maximal TocLevel of sectioning layouts
305 ///////////////////////////////////////////////////////////////////
306 // helper routines for reading layout files
307 ///////////////////////////////////////////////////////////////////
309 bool deleteLayout(docstring const &);
311 bool convertLayoutFormat(support::FileName const &, ReadType);
312 /// Reads the layout file without running layout2layout.
313 ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
314 /// \return true for success.
315 bool readStyle(Lexer &, Layout &) const;
317 void readOutputType(Lexer &);
319 void readTitleType(Lexer &);
321 void readMaxCounter(Lexer &);
323 void readClassOptions(Lexer &);
325 void readCharStyle(Lexer &, std::string const &);
327 void readFloat(Lexer &);
331 /// A DocumentClass represents the layout information associated with a
332 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
335 /// In that regard, DocumentClass objects are "dynamic". But this is really
336 /// an illusion, since DocumentClass objects are not (currently) changed
337 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
338 /// discarded---actually, it's kept around in case something on the cut
339 /// stack needs it---and a new one is created from scratch.
341 /// In the main LyX code, DocumentClass objects are created only by
342 /// DocumentClassBundle, for which see below.
344 class DocumentClass : public TextClass, boost::noncopyable {
347 virtual ~DocumentClass() {}
349 ///////////////////////////////////////////////////////////////////
351 ///////////////////////////////////////////////////////////////////
352 /// \return true if there is a Layout with latexname lay
353 bool hasLaTeXLayout(std::string const & lay) const;
354 /// A DocumentClass nevers count as loaded, since it is dynamic
355 virtual bool loaded() { return false; }
356 /// \return the layout object of an inset given by name. If the name
357 /// is not found as such, the part after the ':' is stripped off, and
358 /// searched again. In this way, an error fallback can be provided:
359 /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
360 /// will invoke the layout object defined by name = 'CharStyle'.
361 /// If that doesn't work either, an empty object returns (shouldn't
362 /// happen). -- Idea JMarc, comment MV
363 InsetLayout const & insetLayout(docstring const & name) const;
364 /// a plain inset layout for use as a default
365 static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; }
366 /// add a new layout \c name if it does not exist in layoutlist_
367 void addLayoutIfNeeded(docstring const & name) const;
369 ///////////////////////////////////////////////////////////////////
371 ///////////////////////////////////////////////////////////////////
372 /// the list of floats defined in the document class
373 FloatList const & floats() const { return floatlist_; }
375 Counters & counters() const { return counters_; }
377 std::string const & opt_fontsize() const { return opt_fontsize_; }
379 std::string const & opt_pagestyle() const { return opt_pagestyle_; }
381 std::string const & options() const { return options_; }
383 std::string const & class_header() const { return class_header_; }
385 std::string const & pagestyle() const { return pagestyle_; }
387 docstring const & preamble() const { return preamble_; }
389 docstring const & htmlpreamble() const { return htmlpreamble_; }
390 /// the paragraph style to use for TOCs, Bibliography, etc
391 /// we will attempt to calculate this if it was not given
392 Layout const & htmlTOCLayout() const;
393 /// is this feature already provided by the class?
394 bool provides(std::string const & p) const;
395 /// features required by the class?
396 std::set<std::string> const & requires() const { return requires_; }
398 unsigned int columns() const { return columns_; }
400 PageSides sides() const { return sides_; }
402 int secnumdepth() const { return secnumdepth_; }
404 int tocdepth() const { return tocdepth_; }
406 FontInfo const & defaultfont() const { return defaultfont_; }
407 /// Text that dictates how wide the left margin is on the screen
408 docstring const & leftmargin() const { return leftmargin_; }
409 /// Text that dictates how wide the right margin is on the screen
410 docstring const & rightmargin() const { return rightmargin_; }
411 /// The type of command used to produce a title
412 TitleLatexType titletype() const { return titletype_; }
413 /// The name of the title command
414 std::string const & titlename() const { return titlename_; }
416 int size() const { return layoutlist_.size(); }
417 /// The minimal TocLevel of sectioning layouts
418 int min_toclevel() const { return min_toclevel_; }
419 /// The maximal TocLevel of sectioning layouts
420 int max_toclevel() const { return max_toclevel_; }
421 /// returns true if the class has a ToC structure
422 bool hasTocLevels() const;
424 /// Constructs a DocumentClass based upon a LayoutFile.
425 DocumentClass(LayoutFile const & tc);
426 /// Needed in tex2lyx
429 /// The only class that can create a DocumentClass is
430 /// DocumentClassBundle, which calls the protected constructor.
431 friend class DocumentClassBundle;
433 static InsetLayout plain_insetlayout_;
437 /// DocumentClassBundle is a container for DocumentClass objects, so that
438 /// they stay in memory for use by Insets, CutAndPaste, and the like, even
439 /// when their associated Buffers are destroyed.
440 /// FIXME Some sort of garbage collection or reference counting wouldn't
441 /// be a bad idea here. It might be enough to check when a Buffer is closed
442 /// (or makeDocumentClass is called) whether the old DocumentClass is in use
445 /// This is a singleton class. Its sole instance is accessed via
446 /// DocumentClassBundle::get().
447 class DocumentClassBundle : boost::noncopyable {
449 /// \return The sole instance of this class.
450 static DocumentClassBundle & get();
451 /// \return A new DocumentClass based on baseClass, with info added
452 /// from the modules in modlist.
453 DocumentClass & makeDocumentClass(LayoutFile const & baseClass,
454 LayoutModuleList const & modlist);
456 /// control instantiation
457 DocumentClassBundle() {}
459 ~DocumentClassBundle();
460 /// \return Reference to a new DocumentClass equal to baseClass
461 DocumentClass & newClass(LayoutFile const & baseClass);
463 std::vector<DocumentClass *> documentClasses_;
467 /// convert page sides option to text 1 or 2
468 std::ostream & operator<<(std::ostream & os, PageSides p);