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.
15 #include "DocumentClassPtr.h"
16 #include "FloatList.h"
19 #include "LayoutEnums.h"
20 #include "LayoutModuleList.h"
22 #include "insets/InsetLayout.h"
24 #include "support/docstring.h"
25 #include "support/types.h"
39 namespace support { class FileName; }
47 /// Based upon ideas in boost::noncopyable, inheriting from this
48 /// class effectively makes the copy constructor protected but the
49 /// assignment constructor private.
55 ProtectCopy(const ProtectCopy &) {}
57 const ProtectCopy & operator=(const ProtectCopy &);
61 /// A TextClass represents a collection of layout information: At the
62 /// moment, this includes Layout's and InsetLayout's.
64 /// There are two major subclasses of TextClass: LayoutFile and
65 /// DocumentClass. These subclasses are what are actually used in LyX.
66 /// Simple TextClass objects are not directly constructed in the main
67 /// LyX code---the constructor is protected. (That said, in tex2lyx
68 /// there are what amount to simple TextClass objects.)
70 /// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file.
71 /// These are generally static objects---though they can be reloaded
72 /// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
73 /// they will never change.
75 /// A DocumentClass (see below) represents the layout information that
76 /// is associated with a given Buffer. These are static, in the sense
77 /// that they will not themselves change, but which DocumentClass is
78 /// associated with a Buffer can change, as modules are loaded and
79 /// unloaded, for example.
81 class TextClass : protected ProtectCopy {
84 virtual ~TextClass() {}
85 ///////////////////////////////////////////////////////////////////
87 ///////////////////////////////////////////////////////////////////
88 // NOTE Do NOT try to make this a container of Layout pointers, e.g.,
89 // std::list<Layout *>. This will lead to problems. The reason is
90 // that DocumentClass objects are generally created by copying a
91 // LayoutFile, which serves as a base for the DocumentClass. If the
92 // LayoutList is a container of pointers, then every DocumentClass
93 // that derives from a given LayoutFile (e.g., article) will SHARE
94 // a basic set of layouts. So if one Buffer were to modify a layout
95 // (say, Standard), that would modify that layout for EVERY Buffer
96 // that was based upon the same DocumentClass.
98 // NOTE: Layout pointers are directly assigned to paragraphs so a
99 // container that does not invalidate these pointers after insertion
101 /// The individual paragraph layouts comprising the document class
102 typedef std::list<Layout> LayoutList;
103 /// The inset layouts available to this class
104 typedef std::map<docstring, InsetLayout> InsetLayouts;
106 typedef LayoutList::const_iterator const_iterator;
108 ///////////////////////////////////////////////////////////////////
110 ///////////////////////////////////////////////////////////////////
112 const_iterator begin() const { return layoutlist_.begin(); }
114 const_iterator end() const { return layoutlist_.end(); }
117 ///////////////////////////////////////////////////////////////////
119 ///////////////////////////////////////////////////////////////////
121 Layout const & defaultLayout() const;
123 docstring const & defaultLayoutName() const;
125 bool isDefaultLayout(Layout const &) const;
127 bool isPlainLayout(Layout const &) const;
128 /// returns a special layout for use when we don't really want one,
129 /// e.g., in table cells
130 Layout const & plainLayout() const
131 { return operator[](plain_layout_); }
132 /// the name of the plain layout
133 docstring const & plainLayoutName() const
134 { return plain_layout_; }
135 /// Enumerate the paragraph styles.
136 size_t layoutCount() const { return layoutlist_.size(); }
138 bool hasLayout(docstring const & name) const;
140 bool hasInsetLayout(docstring const & name) const;
142 Layout const & operator[](docstring const & vname) const;
143 /// Inset layouts of this doc class
144 InsetLayouts const & insetLayouts() const { return insetlayoutlist_; }
146 ///////////////////////////////////////////////////////////////////
148 ///////////////////////////////////////////////////////////////////
149 /// Enum used with TextClass::read
151 BASECLASS, //>This is a base class, i.e., top-level layout file
152 MERGE, //>This is a file included in a layout file
153 MODULE, //>This is a layout module
154 CITE_ENGINE, //>This is a cite engine
155 VALIDATION //>We're just validating
157 /// return values for read()
165 /// Performs the read of the layout file.
166 /// \return true on success.
167 // FIXME Should return ReturnValues....
168 bool read(support::FileName const & filename, ReadType rt = BASECLASS);
170 ReturnValues read(std::string const & str, ReadType rt = MODULE);
172 ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
173 /// validates the layout information passed in str
174 static ReturnValues validate(std::string const & str);
175 /// \return the conversion of \param str to the latest layout format
176 /// compatible with the lyx format.
177 static std::string convert(std::string const & str);
179 ///////////////////////////////////////////////////////////////////
181 ///////////////////////////////////////////////////////////////////
182 /// Sees to it the textclass structure has been loaded
183 /// This function will search for $classname.layout in default directories
184 /// and an optional path, but if path points to a file, it will be loaded
186 bool load(std::string const & path = std::string()) const;
187 /// Has this layout file been loaded yet?
188 /// Overridden by DocumentClass
189 virtual bool loaded() const { return loaded_; }
191 ///////////////////////////////////////////////////////////////////
193 ///////////////////////////////////////////////////////////////////
195 std::string const & name() const { return name_; }
197 std::string const & path() const { return path_; }
199 std::string const & category() const { return category_; }
201 std::string const & description() const { return description_; }
203 std::string const & latexname() const { return latexname_; }
205 std::string const & prerequisites(std::string const & sep = "\n\t") const;
206 /// Can be LaTeX, DocBook, etc.
207 OutputType outputType() const { return outputType_; }
208 /// Can be latex, docbook ... (the name of a format)
209 std::string outputFormat() const { return outputFormat_; }
210 /// Does this class redefine the output format?
211 bool hasOutputFormat() const { return has_output_format_; }
212 /// Return the non-localised names for the toc types.
213 std::map<std::string, docstring> const &
214 outlinerNames() const { return outliner_names_; }
215 /// \returns Layout named \p name if it exists, otherwise 0
216 Layout const * getLayout(docstring const & name) const;
217 /// \returns Layout named \p name if it exists, otherwise 0
218 Layout * getLayout(docstring const & name);
221 /// Protect construction
224 Layout & operator[](docstring const & name);
225 /** Create an new, very basic layout for this textclass. This is used for
226 the Plain Layout common to all TextClass objects and also, in
227 DocumentClass, for the creation of new layouts `on the fly' when
228 previously unknown layouts are encountered.
229 \param unknown Set to true if this layout is used to represent an
232 Layout createBasicLayout(docstring const & name, bool unknown = false) const;
234 ///////////////////////////////////////////////////////////////////
235 // non-const iterators
236 ///////////////////////////////////////////////////////////////////
238 typedef LayoutList::iterator iterator;
240 iterator begin() { return layoutlist_.begin(); }
242 iterator end() { return layoutlist_.end(); }
244 ///////////////////////////////////////////////////////////////////
246 ///////////////////////////////////////////////////////////////////
247 /// Paragraph styles used in this layout
248 /// This variable is mutable because unknown layouts can be added
249 /// to const textclass.
250 mutable LayoutList layoutlist_;
253 /// Layout file path (empty for system layout files)
256 std::string category_;
257 /// document class name
258 std::string latexname_;
259 /// document class description
260 std::string description_;
261 /// available types of float, eg. figure, algorithm.
262 mutable FloatList floatlist_;
263 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
264 mutable Counters counters_;
265 /// Has this layout file been loaded yet?
266 mutable bool loaded_;
267 /// Is the TeX class available?
268 bool tex_class_avail_;
269 /// document class prerequisites
270 mutable std::string prerequisites_;
271 /// The possible cite engine types
272 std::string opt_enginetype_;
273 /// The cite framework (bibtex, biblatex)
274 std::string citeframework_;
276 std::string opt_fontsize_;
278 std::string opt_pagesize_;
280 std::string opt_pagestyle_;
281 /// Specific class options
282 std::string options_;
283 /// Format of the fontsize option
284 std::string fontsize_format_;
285 /// Default page size
286 std::string pagesize_;
287 /// Format of the papersize option
288 std::string pagesize_format_;
290 std::string pagestyle_;
292 std::string tablestyle_;
294 std::string class_header_;
296 docstring defaultlayout_;
297 /// name of plain layout
298 static const docstring plain_layout_;
299 /// preamble text to support layout styles
301 /// same, but for HTML output
302 /// this is output as is to the header
303 docstring htmlpreamble_;
304 /// same, but specifically for CSS information
305 docstring htmlstyles_;
306 /// the paragraph style to use for TOCs, Bibliography, etc
307 mutable docstring html_toc_section_;
308 /// latex packages loaded by document class.
309 std::set<std::string> provides_;
310 /// latex packages requested by document class.
311 std::set<std::string> required_;
313 std::map<std::string, std::string> package_options_;
314 /// default modules wanted by document class
315 LayoutModuleList default_modules_;
316 /// modules provided by document class
317 LayoutModuleList provided_modules_;
318 /// modules excluded by document class
319 LayoutModuleList excluded_modules_;
321 unsigned int columns_;
324 /// header depth to have numbering
326 /// header depth to appear in table of contents
328 /// Can be LaTeX, DocBook, etc.
329 OutputType outputType_;
330 /// Can be latex, docbook ... (the name of a format)
331 std::string outputFormat_;
332 /// Does this class redefine the output format?
333 bool has_output_format_;
334 /** Base font. The paragraph and layout fonts are resolved against
335 this font. This has to be fully instantiated. Attributes
336 FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
339 FontInfo defaultfont_;
340 /// Text that dictates how wide the left margin is on the screen
341 docstring leftmargin_;
342 /// Text that dictates how wide the right margin is on the screen
343 docstring rightmargin_;
344 /// The type of command used to produce a title
345 TitleLatexType titletype_;
346 /// The name of the title command
347 std::string titlename_;
348 /// Input layouts available to this layout
349 InsetLayouts insetlayoutlist_;
350 /// The minimal TocLevel of sectioning layouts
352 /// The maximal TocLevel of sectioning layouts
354 /// Citation formatting information
355 std::map<CiteEngineType, std::map<std::string, std::string> > cite_formats_;
357 std::map<CiteEngineType, std::map<std::string, std::string> > cite_macros_;
358 /// The default BibTeX bibliography style file
359 std::map<std::string, std::string> cite_default_biblio_style_;
360 /// Citation command aliases
361 std::map<std::string, std::string> cite_command_aliases_;
362 /// The maximum number of citations before "et al."
363 size_t maxcitenames_;
364 /// Whether full author lists are supported
365 bool cite_full_author_list_;
366 /// The possible citation styles
367 std::map<CiteEngineType, std::vector<CitationStyle> > cite_styles_;
368 /// Class-added citation styles
369 std::map<CiteEngineType, std::vector<CitationStyle> > class_cite_styles_;
371 std::map<std::string, docstring> outliner_names_;
372 /// Does this class put the bibliography to toc by itself?
375 ///////////////////////////////////////////////////////////////////
376 // helper routines for reading layout files
377 ///////////////////////////////////////////////////////////////////
379 bool deleteLayout(docstring const &);
381 bool deleteInsetLayout(docstring const &);
383 bool convertLayoutFormat(support::FileName const &, ReadType);
384 /// Reads the layout file without running layout2layout.
385 ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
386 /// \return true for success.
387 bool readStyle(Lexer &, Layout &) const;
389 void readOutputType(Lexer &);
391 void readTitleType(Lexer &);
393 void readMaxCounter(Lexer &);
395 void readClassOptions(Lexer &);
397 void readCharStyle(Lexer &, std::string const &);
399 bool readFloat(Lexer &);
401 std::vector<CitationStyle> const & getCiteStyles(CiteEngineType const &) const;
403 bool readCiteEngine(Lexer &, ReadType, bool const add = false);
405 int readCiteEngineType(Lexer &) const;
407 bool readCiteFormat(Lexer &, ReadType);
409 bool readOutlinerName(Lexer &);
413 /// A DocumentClass represents the layout information associated with a
414 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
417 /// In that regard, DocumentClass objects are "dynamic". But this is really
418 /// an illusion, since DocumentClass objects are not (currently) changed
419 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
420 /// discarded---actually, it will be kept around if something on the cut
421 /// stack needs it---and a new one is created from scratch.
422 class DocumentClass : public TextClass {
425 virtual ~DocumentClass() {}
427 ///////////////////////////////////////////////////////////////////
429 ///////////////////////////////////////////////////////////////////
430 /// \return true if there is a Layout with latexname lay
431 bool hasLaTeXLayout(std::string const & lay) const;
432 /// A DocumentClass nevers count as loaded, since it is dynamic
433 virtual bool loaded() const { return false; }
434 /// \return the layout object of an inset given by name. If the name
435 /// is not found as such, the part after the ':' is stripped off, and
436 /// searched again. In this way, an error fallback can be provided:
437 /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
438 /// will invoke the layout object defined by name = 'CharStyle'.
439 /// If that doesn't work either, an empty object returns (shouldn't
440 /// happen). -- Idea JMarc, comment MV
441 InsetLayout const & insetLayout(docstring const & name) const;
442 /// a plain inset layout for use as a default
443 static InsetLayout const & plainInsetLayout();
444 /// add a new layout \c name if it does not exist in layoutlist_
445 /// \return whether we had to add one.
446 bool addLayoutIfNeeded(docstring const & name) const;
447 /// Forced layouts in layout file syntax
448 std::string forcedLayouts() const;
450 ///////////////////////////////////////////////////////////////////
452 ///////////////////////////////////////////////////////////////////
453 /// the list of floats defined in the document class
454 FloatList const & floats() const { return floatlist_; }
456 Counters & counters() const { return counters_; }
458 std::string const & opt_enginetype() const { return opt_enginetype_; }
460 std::string const & citeFramework() const { return citeframework_; }
462 std::string const & opt_fontsize() const { return opt_fontsize_; }
464 std::string const & opt_pagesize() const { return opt_pagesize_; }
466 std::string const & opt_pagestyle() const { return opt_pagestyle_; }
468 std::string const & options() const { return options_; }
470 std::string const & class_header() const { return class_header_; }
472 std::string const & fontsizeformat() const { return fontsize_format_; }
474 std::string const & pagesize() const { return pagesize_; }
476 std::string const & pagesizeformat() const { return pagesize_format_; }
478 std::string const & pagestyle() const { return pagestyle_; }
480 std::string const & tablestyle() const { return tablestyle_; }
482 docstring const & preamble() const { return preamble_; }
484 docstring const & htmlpreamble() const { return htmlpreamble_; }
486 docstring const & htmlstyles() const { return htmlstyles_; }
487 /// Looks for the layout of "highest level", other than Part (or other
488 /// layouts with a negative toc number), for use in constructing TOCs and
489 /// similar information.
490 Layout const & getTOCLayout() const;
491 /// the paragraph style to use for TOCs, Bibliography, etc
492 /// we will attempt to calculate this if it was not given
493 Layout const & htmlTOCLayout() const;
494 /// is this feature already provided by the class?
495 bool provides(std::string const & p) const;
496 /// features required by the class?
497 std::set<std::string> const & required() const { return required_; }
498 /// package options to write to LaTeX file
499 std::map<std::string, std::string> const & packageOptions() const
500 { return package_options_; }
502 unsigned int columns() const { return columns_; }
504 PageSides sides() const { return sides_; }
506 int secnumdepth() const { return secnumdepth_; }
508 int tocdepth() const { return tocdepth_; }
510 FontInfo const & defaultfont() const { return defaultfont_; }
511 /// Text that dictates how wide the left margin is on the screen
512 docstring const & leftmargin() const { return leftmargin_; }
513 /// Text that dictates how wide the right margin is on the screen
514 docstring const & rightmargin() const { return rightmargin_; }
515 /// The type of command used to produce a title
516 TitleLatexType titletype() const { return titletype_; }
517 /// The name of the title command
518 std::string const & titlename() const { return titlename_; }
520 int size() const { return layoutlist_.size(); }
521 /// The minimal TocLevel of sectioning layouts
522 int min_toclevel() const { return min_toclevel_; }
523 /// The maximal TocLevel of sectioning layouts
524 int max_toclevel() const { return max_toclevel_; }
525 /// returns true if the class has a ToC structure
526 bool hasTocLevels() const;
528 std::string const getCiteFormat(CiteEngineType const & type,
529 std::string const & entry, bool const punct = true,
530 std::string const & fallback = "") const;
532 std::string const & getCiteMacro(CiteEngineType const & type,
533 std::string const & macro) const;
535 std::vector<std::string> const citeCommands(CiteEngineType const &) const;
537 std::vector<CitationStyle> const & citeStyles(CiteEngineType const &) const;
539 std::map<std::string, std::string> const & defaultBiblioStyle() const
540 { return cite_default_biblio_style_; }
542 std::map<std::string, std::string> const & citeCommandAliases() const
543 { return cite_command_aliases_; }
544 /// The maximum number of citations before "et al."
545 size_t max_citenames() const { return maxcitenames_; }
547 bool const & fullAuthorList() const { return cite_full_author_list_; }
549 bool const & bibInToc() const { return bibintoc_; }
551 /// Constructs a DocumentClass based upon a LayoutFile.
552 DocumentClass(LayoutFile const & tc);
553 /// Needed in tex2lyx
556 /// The only way to make a DocumentClass is to call this function.
557 friend DocumentClassPtr
558 getDocumentClass(LayoutFile const &, LayoutModuleList const &,
564 /// The only way to make a DocumentClass is to call this function.
565 /// The shared_ptr is needed because DocumentClass objects can be kept
566 /// in memory long after their associated Buffer is destroyed, mostly
568 DocumentClassPtr getDocumentClass(LayoutFile const & baseClass,
569 LayoutModuleList const & modlist,
570 std::string const & cengine = std::string(),
571 bool const clone = false);
573 /// convert page sides option to text 1 or 2
574 std::ostream & operator<<(std::ostream & os, PageSides p);
576 /// current format of layout files
577 extern int const LAYOUT_FORMAT;
578 /// layout format for the current lyx file format (usually equal to
580 extern int const LYXFILE_LAYOUT_FORMAT;