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>
36 namespace support { class FileName; }
44 /// Based upon ideas in boost::noncopyable, inheriting from this
45 /// class effectively makes the copy constructor protected but the
46 /// assignment constructor private.
52 ProtectCopy(const ProtectCopy &) {}
54 const ProtectCopy & operator=(const ProtectCopy &);
58 /// A TextClass represents a collection of layout information: At the
59 /// moment, this includes Layout's and InsetLayout's.
61 /// There are two major subclasses of TextClass: LayoutFile and
62 /// DocumentClass. These subclasses are what are actually used in LyX.
63 /// Simple TextClass objects are not directly constructed in the main
64 /// LyX code---the constructor is protected. (That said, in tex2lyx
65 /// there are what amount to simple TextClass objects.)
67 /// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file.
68 /// These are generally static objects---though they can be reloaded
69 /// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
70 /// they will never change.
72 /// A DocumentClass (see below) represents the layout information that
73 /// is associated with a given Buffer. These are static, in the sense
74 /// that they will not themselves change, but which DocumentClass is
75 /// associated with a Buffer can change, as modules are loaded and
76 /// unloaded, for example.
78 class TextClass : protected ProtectCopy {
81 virtual ~TextClass() {}
82 ///////////////////////////////////////////////////////////////////
84 ///////////////////////////////////////////////////////////////////
85 // NOTE Do NOT try to make this a container of Layout pointers, e.g.,
86 // std::list<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.
95 // NOTE: Layout pointers are directly assigned to paragraphs so a
96 // container that does not invalidate these pointers after insertion
98 /// The individual paragraph layouts comprising the document class
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()
161 /// Performs the read of the layout file.
162 /// \return true on success.
163 // FIXME Should return ReturnValues....
164 bool read(support::FileName const & filename, ReadType rt = BASECLASS);
166 ReturnValues read(std::string const & str, ReadType rt = MODULE);
168 ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
169 /// validates the layout information passed in str
170 static ReturnValues validate(std::string const & str);
172 static std::string convert(std::string const & str);
174 ///////////////////////////////////////////////////////////////////
176 ///////////////////////////////////////////////////////////////////
177 /// Sees to it the textclass structure has been loaded
178 /// This function will search for $classname.layout in default directories
179 /// and an optional path, but if path points to a file, it will be loaded
181 bool load(std::string const & path = std::string()) const;
182 /// Has this layout file been loaded yet?
183 /// Overridden by DocumentClass
184 virtual bool loaded() const { return loaded_; }
186 ///////////////////////////////////////////////////////////////////
188 ///////////////////////////////////////////////////////////////////
190 std::string const & name() const { return name_; }
192 std::string const & description() const { return description_; }
194 std::string const & latexname() const { return latexname_; }
196 std::string const & prerequisites() const;
197 /// Can be LaTeX, DocBook, etc.
198 OutputType outputType() const { return outputType_; }
199 /// Can be latex, docbook ... (the name of a format)
200 std::string outputFormat() const { return outputFormat_; }
202 /// Protect construction
205 Layout & operator[](docstring const & name);
206 /** Create an new, very basic layout for this textclass. This is used for
207 the Plain Layout common to all TextClass objects and also, in
208 DocumentClass, for the creation of new layouts `on the fly' when
209 previously unknown layouts are encountered.
210 \param unknown Set to true if this layout is used to represent an
213 Layout createBasicLayout(docstring const & name, bool unknown = false) const;
215 ///////////////////////////////////////////////////////////////////
216 // non-const iterators
217 ///////////////////////////////////////////////////////////////////
219 typedef LayoutList::iterator iterator;
221 iterator begin() { return layoutlist_.begin(); }
223 iterator end() { return layoutlist_.end(); }
225 ///////////////////////////////////////////////////////////////////
227 ///////////////////////////////////////////////////////////////////
228 /// Paragraph styles used in this layout
229 /// This variable is mutable because unknown layouts can be added
230 /// to const textclass.
231 mutable LayoutList layoutlist_;
234 /// document class name
235 std::string latexname_;
236 /// document class description
237 std::string description_;
238 /// available types of float, eg. figure, algorithm.
239 mutable FloatList floatlist_;
240 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
241 mutable Counters counters_;
242 /// Has this layout file been loaded yet?
243 mutable bool loaded_;
244 /// Is the TeX class available?
245 bool tex_class_avail_;
246 /// document class prerequisites
247 mutable std::string prerequisites_;
249 std::string opt_fontsize_;
251 std::string opt_pagestyle_;
252 /// Specific class options
253 std::string options_;
255 std::string pagestyle_;
257 std::string class_header_;
259 docstring defaultlayout_;
260 /// name of plain layout
261 static const docstring plain_layout_;
262 /// preamble text to support layout styles
264 /// same, but for HTML output
265 /// this is output as is to the header
266 docstring htmlpreamble_;
267 /// the paragraph style to use for TOCs, Bibliography, etc
268 mutable docstring html_toc_section_;
269 /// latex packages loaded by document class.
270 std::set<std::string> provides_;
271 /// latex packages requested by document class.
272 std::set<std::string> requires_;
273 /// default modules wanted by document class
274 LayoutModuleList default_modules_;
275 /// modules provided by document class
276 LayoutModuleList provided_modules_;
277 /// modules excluded by document class
278 LayoutModuleList excluded_modules_;
280 unsigned int columns_;
283 /// header depth to have numbering
285 /// header depth to appear in table of contents
287 /// Can be LaTeX, DocBook, etc.
288 OutputType outputType_;
289 /// Can be latex, docbook ... (the name of a format)
290 std::string outputFormat_;
291 /** Base font. The paragraph and layout fonts are resolved against
292 this font. This has to be fully instantiated. Attributes
293 FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
296 FontInfo defaultfont_;
297 /// Text that dictates how wide the left margin is on the screen
298 docstring leftmargin_;
299 /// Text that dictates how wide the right margin is on the screen
300 docstring rightmargin_;
301 /// The type of command used to produce a title
302 TitleLatexType titletype_;
303 /// The name of the title command
304 std::string titlename_;
305 /// Input layouts available to this layout
306 InsetLayouts insetlayoutlist_;
307 /// The minimal TocLevel of sectioning layouts
309 /// The maximal TocLevel of sectioning layouts
311 /// Citation formatting information
312 std::map<std::string, std::string> cite_formats_;
314 std::map<std::string, std::string> cite_macros_;
316 ///////////////////////////////////////////////////////////////////
317 // helper routines for reading layout files
318 ///////////////////////////////////////////////////////////////////
320 bool deleteLayout(docstring const &);
322 bool convertLayoutFormat(support::FileName const &, ReadType);
323 /// Reads the layout file without running layout2layout.
324 ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
325 /// \return true for success.
326 bool readStyle(Lexer &, Layout &) const;
328 void readOutputType(Lexer &);
330 void readTitleType(Lexer &);
332 void readMaxCounter(Lexer &);
334 void readClassOptions(Lexer &);
336 void readCharStyle(Lexer &, std::string const &);
338 bool readFloat(Lexer &);
340 void readCiteFormat(Lexer &);
344 /// A DocumentClass represents the layout information associated with a
345 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
348 /// In that regard, DocumentClass objects are "dynamic". But this is really
349 /// an illusion, since DocumentClass objects are not (currently) changed
350 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
351 /// discarded---actually, it's kept around in case something on the cut
352 /// stack needs it---and a new one is created from scratch.
354 /// In the main LyX code, DocumentClass objects are created only by
355 /// DocumentClassBundle, for which see below.
357 class DocumentClass : public TextClass, boost::noncopyable {
360 virtual ~DocumentClass() {}
362 ///////////////////////////////////////////////////////////////////
364 ///////////////////////////////////////////////////////////////////
365 /// \return true if there is a Layout with latexname lay
366 bool hasLaTeXLayout(std::string const & lay) const;
367 /// A DocumentClass nevers count as loaded, since it is dynamic
368 virtual bool loaded() { return false; }
369 /// \return the layout object of an inset given by name. If the name
370 /// is not found as such, the part after the ':' is stripped off, and
371 /// searched again. In this way, an error fallback can be provided:
372 /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
373 /// will invoke the layout object defined by name = 'CharStyle'.
374 /// If that doesn't work either, an empty object returns (shouldn't
375 /// happen). -- Idea JMarc, comment MV
376 InsetLayout const & insetLayout(docstring const & name) const;
377 /// a plain inset layout for use as a default
378 static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; }
379 /// add a new layout \c name if it does not exist in layoutlist_
380 /// \return whether we had to add one.
381 bool addLayoutIfNeeded(docstring const & name) const;
383 ///////////////////////////////////////////////////////////////////
385 ///////////////////////////////////////////////////////////////////
386 /// the list of floats defined in the document class
387 FloatList const & floats() const { return floatlist_; }
389 Counters & counters() const { return counters_; }
391 std::string const & opt_fontsize() const { return opt_fontsize_; }
393 std::string const & opt_pagestyle() const { return opt_pagestyle_; }
395 std::string const & options() const { return options_; }
397 std::string const & class_header() const { return class_header_; }
399 std::string const & pagestyle() const { return pagestyle_; }
401 docstring const & preamble() const { return preamble_; }
403 docstring const & htmlpreamble() const { return htmlpreamble_; }
404 /// the paragraph style to use for TOCs, Bibliography, etc
405 /// we will attempt to calculate this if it was not given
406 Layout const & htmlTOCLayout() const;
407 /// is this feature already provided by the class?
408 bool provides(std::string const & p) const;
409 /// features required by the class?
410 std::set<std::string> const & requires() const { return requires_; }
412 unsigned int columns() const { return columns_; }
414 PageSides sides() const { return sides_; }
416 int secnumdepth() const { return secnumdepth_; }
418 int tocdepth() const { return tocdepth_; }
420 FontInfo const & defaultfont() const { return defaultfont_; }
421 /// Text that dictates how wide the left margin is on the screen
422 docstring const & leftmargin() const { return leftmargin_; }
423 /// Text that dictates how wide the right margin is on the screen
424 docstring const & rightmargin() const { return rightmargin_; }
425 /// The type of command used to produce a title
426 TitleLatexType titletype() const { return titletype_; }
427 /// The name of the title command
428 std::string const & titlename() const { return titlename_; }
430 int size() const { return layoutlist_.size(); }
431 /// The minimal TocLevel of sectioning layouts
432 int min_toclevel() const { return min_toclevel_; }
433 /// The maximal TocLevel of sectioning layouts
434 int max_toclevel() const { return max_toclevel_; }
435 /// returns true if the class has a ToC structure
436 bool hasTocLevels() const;
438 std::string const & getCiteFormat(std::string const & entry_type) const;
440 std::string const & getCiteMacro(std::string const & macro) const;
442 /// Constructs a DocumentClass based upon a LayoutFile.
443 DocumentClass(LayoutFile const & tc);
444 /// Needed in tex2lyx
447 /// The only class that can create a DocumentClass is
448 /// DocumentClassBundle, which calls the protected constructor.
449 friend class DocumentClassBundle;
451 static InsetLayout plain_insetlayout_;
455 /// DocumentClassBundle is a container for DocumentClass objects, so that
456 /// they stay in memory for use by Insets, CutAndPaste, and the like, even
457 /// when their associated Buffers are destroyed.
458 /// FIXME Some sort of garbage collection or reference counting wouldn't
459 /// be a bad idea here. It might be enough to check when a Buffer is closed
460 /// (or makeDocumentClass is called) whether the old DocumentClass is in use
463 /// This is a singleton class. Its sole instance is accessed via
464 /// DocumentClassBundle::get().
465 class DocumentClassBundle : boost::noncopyable {
467 /// \return The sole instance of this class.
468 static DocumentClassBundle & get();
469 /// \return A new DocumentClass based on baseClass, with info added
470 /// from the modules in modlist.
471 DocumentClass & makeDocumentClass(LayoutFile const & baseClass,
472 LayoutModuleList const & modlist);
474 /// control instantiation
475 DocumentClassBundle() {}
477 ~DocumentClassBundle();
478 /// \return Reference to a new DocumentClass equal to baseClass
479 DocumentClass & newClass(LayoutFile const & baseClass);
481 std::vector<DocumentClass *> documentClasses_;
485 /// convert page sides option to text 1 or 2
486 std::ostream & operator<<(std::ostream & os, PageSides p);
488 /// current format of layout files
489 extern int const LAYOUT_FORMAT;