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 & category() const { return category_; }
199 std::string const & description() const { return description_; }
201 std::string const & latexname() const { return latexname_; }
203 std::string const & prerequisites(std::string const & sep = "\n\t") const;
204 /// Can be LaTeX, DocBook, etc.
205 OutputType outputType() const { return outputType_; }
206 /// Can be latex, docbook ... (the name of a format)
207 std::string outputFormat() const { return outputFormat_; }
209 docstring outlinerName(std::string const & type) const;
211 /// Protect construction
214 Layout & operator[](docstring const & name);
215 /** Create an new, very basic layout for this textclass. This is used for
216 the Plain Layout common to all TextClass objects and also, in
217 DocumentClass, for the creation of new layouts `on the fly' when
218 previously unknown layouts are encountered.
219 \param unknown Set to true if this layout is used to represent an
222 Layout createBasicLayout(docstring const & name, bool unknown = false) const;
224 ///////////////////////////////////////////////////////////////////
225 // non-const iterators
226 ///////////////////////////////////////////////////////////////////
228 typedef LayoutList::iterator iterator;
230 iterator begin() { return layoutlist_.begin(); }
232 iterator end() { return layoutlist_.end(); }
234 ///////////////////////////////////////////////////////////////////
236 ///////////////////////////////////////////////////////////////////
237 /// Paragraph styles used in this layout
238 /// This variable is mutable because unknown layouts can be added
239 /// to const textclass.
240 mutable LayoutList layoutlist_;
244 std::string category_;
245 /// document class name
246 std::string latexname_;
247 /// document class description
248 std::string description_;
249 /// available types of float, eg. figure, algorithm.
250 mutable FloatList floatlist_;
251 /// Types of counters, eg. sections, eqns, figures, avail. in document class.
252 mutable Counters counters_;
253 /// Has this layout file been loaded yet?
254 mutable bool loaded_;
255 /// Is the TeX class available?
256 bool tex_class_avail_;
257 /// document class prerequisites
258 mutable std::string prerequisites_;
259 /// The possible cite engine types
260 std::string opt_enginetype_;
261 /// The cite framework (bibtex, biblatex)
262 std::string citeframework_;
264 std::string opt_fontsize_;
266 std::string opt_pagestyle_;
267 /// Specific class options
268 std::string options_;
270 std::string pagestyle_;
272 std::string class_header_;
274 docstring defaultlayout_;
275 /// name of plain layout
276 static const docstring plain_layout_;
277 /// preamble text to support layout styles
279 /// same, but for HTML output
280 /// this is output as is to the header
281 docstring htmlpreamble_;
282 /// same, but specifically for CSS information
283 docstring htmlstyles_;
284 /// the paragraph style to use for TOCs, Bibliography, etc
285 mutable docstring html_toc_section_;
286 /// latex packages loaded by document class.
287 std::set<std::string> provides_;
288 /// latex packages requested by document class.
289 std::set<std::string> requires_;
291 std::map<std::string, std::string> package_options_;
292 /// default modules wanted by document class
293 LayoutModuleList default_modules_;
294 /// modules provided by document class
295 LayoutModuleList provided_modules_;
296 /// modules excluded by document class
297 LayoutModuleList excluded_modules_;
299 unsigned int columns_;
302 /// header depth to have numbering
304 /// header depth to appear in table of contents
306 /// Can be LaTeX, DocBook, etc.
307 OutputType outputType_;
308 /// Can be latex, docbook ... (the name of a format)
309 std::string outputFormat_;
310 /** Base font. The paragraph and layout fonts are resolved against
311 this font. This has to be fully instantiated. Attributes
312 FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
315 FontInfo defaultfont_;
316 /// Text that dictates how wide the left margin is on the screen
317 docstring leftmargin_;
318 /// Text that dictates how wide the right margin is on the screen
319 docstring rightmargin_;
320 /// The type of command used to produce a title
321 TitleLatexType titletype_;
322 /// The name of the title command
323 std::string titlename_;
324 /// Input layouts available to this layout
325 InsetLayouts insetlayoutlist_;
326 /// The minimal TocLevel of sectioning layouts
328 /// The maximal TocLevel of sectioning layouts
330 /// Citation formatting information
331 std::map<CiteEngineType, std::map<std::string, std::string> > cite_formats_;
333 std::map<CiteEngineType, std::map<std::string, std::string> > cite_macros_;
334 /// The default BibTeX bibliography style file
335 std::map<std::string, std::string> cite_default_biblio_style_;
336 /// Citation command aliases
337 std::map<std::string, std::string> cite_command_aliases_;
338 /// The maximum number of citations before "et al."
339 size_t maxcitenames_;
340 /// Whether full author lists are supported
341 bool cite_full_author_list_;
342 /// The possible citation styles
343 std::map<CiteEngineType, std::vector<CitationStyle> > cite_styles_;
345 std::map<std::string, docstring> outliner_names_;
347 ///////////////////////////////////////////////////////////////////
348 // helper routines for reading layout files
349 ///////////////////////////////////////////////////////////////////
351 bool deleteLayout(docstring const &);
353 bool deleteInsetLayout(docstring const &);
355 bool convertLayoutFormat(support::FileName const &, ReadType);
356 /// Reads the layout file without running layout2layout.
357 ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
358 /// \return true for success.
359 bool readStyle(Lexer &, Layout &) const;
361 void readOutputType(Lexer &);
363 void readTitleType(Lexer &);
365 void readMaxCounter(Lexer &);
367 void readClassOptions(Lexer &);
369 void readCharStyle(Lexer &, std::string const &);
371 bool readFloat(Lexer &);
373 bool readCiteEngine(Lexer &);
375 int readCiteEngineType(Lexer &) const;
377 bool readCiteFormat(Lexer &);
379 bool readOutlinerName(Lexer &);
383 /// A DocumentClass represents the layout information associated with a
384 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
387 /// In that regard, DocumentClass objects are "dynamic". But this is really
388 /// an illusion, since DocumentClass objects are not (currently) changed
389 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
390 /// discarded---actually, it will be kept around if something on the cut
391 /// stack needs it---and a new one is created from scratch.
392 class DocumentClass : public TextClass {
395 virtual ~DocumentClass() {}
397 ///////////////////////////////////////////////////////////////////
399 ///////////////////////////////////////////////////////////////////
400 /// \return true if there is a Layout with latexname lay
401 bool hasLaTeXLayout(std::string const & lay) const;
402 /// A DocumentClass nevers count as loaded, since it is dynamic
403 virtual bool loaded() const { return false; }
404 /// \return the layout object of an inset given by name. If the name
405 /// is not found as such, the part after the ':' is stripped off, and
406 /// searched again. In this way, an error fallback can be provided:
407 /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
408 /// will invoke the layout object defined by name = 'CharStyle'.
409 /// If that doesn't work either, an empty object returns (shouldn't
410 /// happen). -- Idea JMarc, comment MV
411 InsetLayout const & insetLayout(docstring const & name) const;
412 /// a plain inset layout for use as a default
413 static InsetLayout const & plainInsetLayout();
414 /// add a new layout \c name if it does not exist in layoutlist_
415 /// \return whether we had to add one.
416 bool addLayoutIfNeeded(docstring const & name) const;
417 /// Forced layouts in layout file syntax
418 std::string forcedLayouts() const;
420 ///////////////////////////////////////////////////////////////////
422 ///////////////////////////////////////////////////////////////////
423 /// the list of floats defined in the document class
424 FloatList const & floats() const { return floatlist_; }
426 Counters & counters() const { return counters_; }
428 std::string const & opt_enginetype() const { return opt_enginetype_; }
430 std::string const & citeFramework() const { return citeframework_; }
432 std::string const & opt_fontsize() const { return opt_fontsize_; }
434 std::string const & opt_pagestyle() const { return opt_pagestyle_; }
436 std::string const & options() const { return options_; }
438 std::string const & class_header() const { return class_header_; }
440 std::string const & pagestyle() const { return pagestyle_; }
442 docstring const & preamble() const { return preamble_; }
444 docstring const & htmlpreamble() const { return htmlpreamble_; }
446 docstring const & htmlstyles() const { return htmlstyles_; }
447 /// Looks for the layout of "highest level", other than Part (or other
448 /// layouts with a negative toc number), for use in constructing TOCs and
449 /// similar information.
450 Layout const & getTOCLayout() const;
451 /// the paragraph style to use for TOCs, Bibliography, etc
452 /// we will attempt to calculate this if it was not given
453 Layout const & htmlTOCLayout() const;
454 /// is this feature already provided by the class?
455 bool provides(std::string const & p) const;
456 /// features required by the class?
457 std::set<std::string> const & requires() const { return requires_; }
458 /// package options to write to LaTeX file
459 std::map<std::string, std::string> const & packageOptions() const
460 { return package_options_; }
462 unsigned int columns() const { return columns_; }
464 PageSides sides() const { return sides_; }
466 int secnumdepth() const { return secnumdepth_; }
468 int tocdepth() const { return tocdepth_; }
470 FontInfo const & defaultfont() const { return defaultfont_; }
471 /// Text that dictates how wide the left margin is on the screen
472 docstring const & leftmargin() const { return leftmargin_; }
473 /// Text that dictates how wide the right margin is on the screen
474 docstring const & rightmargin() const { return rightmargin_; }
475 /// The type of command used to produce a title
476 TitleLatexType titletype() const { return titletype_; }
477 /// The name of the title command
478 std::string const & titlename() const { return titlename_; }
480 int size() const { return layoutlist_.size(); }
481 /// The minimal TocLevel of sectioning layouts
482 int min_toclevel() const { return min_toclevel_; }
483 /// The maximal TocLevel of sectioning layouts
484 int max_toclevel() const { return max_toclevel_; }
485 /// returns true if the class has a ToC structure
486 bool hasTocLevels() const;
488 std::string const getCiteFormat(CiteEngineType const & type,
489 std::string const & entry, bool const punct = true,
490 std::string const & fallback = "") const;
492 std::string const & getCiteMacro(CiteEngineType const & type,
493 std::string const & macro) const;
495 std::vector<std::string> const citeCommands(CiteEngineType const &) const;
497 std::vector<CitationStyle> const & citeStyles(CiteEngineType const &) const;
499 std::map<std::string, std::string> const & defaultBiblioStyle() const
500 { return cite_default_biblio_style_; }
502 std::map<std::string, std::string> const & citeCommandAliases() const
503 { return cite_command_aliases_; }
504 /// The maximum number of citations before "et al."
505 size_t max_citenames() const { return maxcitenames_; }
507 bool const & fullAuthorList() const { return cite_full_author_list_; }
509 /// Constructs a DocumentClass based upon a LayoutFile.
510 DocumentClass(LayoutFile const & tc);
511 /// Needed in tex2lyx
514 /// The only way to make a DocumentClass is to call this function.
515 friend DocumentClassPtr
516 getDocumentClass(LayoutFile const &, LayoutModuleList const &,
517 LayoutModuleList const &,
522 /// The only way to make a DocumentClass is to call this function.
523 /// The shared_ptr is needed because DocumentClass objects can be kept
524 /// in memory long after their associated Buffer is destroyed, mostly
526 DocumentClassPtr getDocumentClass(LayoutFile const & baseClass,
527 LayoutModuleList const & modlist,
528 LayoutModuleList const & celist,
529 bool const clone = false);
531 /// convert page sides option to text 1 or 2
532 std::ostream & operator<<(std::ostream & os, PageSides p);
534 /// current format of layout files
535 extern int const LAYOUT_FORMAT;
536 /// layout format for the current lyx file format (usually equal to
538 extern int const LYXFILE_LAYOUT_FORMAT;