]> git.lyx.org Git - lyx.git/blob - src/Layout.h
7fc8a7c7772413d81111840c070f5bf2a46d1f69
[lyx.git] / src / Layout.h
1 // -*- C++ -*-
2 /**
3  * \file Layout.h
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author Lars Gullik Bjønnes
8  * \author Jean-Marc Lasgouttes
9  * \author André Pönitz
10  *
11  * Full author contact details are available in file CREDITS.
12  */
13
14 #ifndef LAYOUT_H
15 #define LAYOUT_H
16
17 #include "FontInfo.h"
18 #include "LayoutEnums.h"
19 #include "Spacing.h"
20 #include "support/debug.h"
21 #include "support/docstring.h"
22
23 #include <map>
24 #include <set>
25 #include <string>
26
27 namespace lyx {
28
29 class Lexer;
30 class TextClass;
31
32 /* Fixed labels are printed flushright, manual labels flushleft.
33  * MARGIN_MANUAL and MARGIN_FIRST_DYNAMIC are *only* for LABEL_MANUAL,
34  * MARGIN_DYNAMIC and MARGIN_STATIC are *not* for LABEL_MANUAL.
35  * This seems a funny restriction, but I think other combinations are
36  * not needed, so I will not change it yet.
37  * Correction: MARGIN_FIRST_DYNAMIC also usable with LABEL_STATIC.
38  */
39
40
41 /* There is a parindent and a parskip. Which one is used depends on the
42  * paragraph_separation-flag of the text-object.
43  * BUT: parindent is only thrown away, if a parskip is defined! So if you
44  * want a space between the paragraphs and a parindent at the same time,
45  * you should set parskip to zero and use topsep, parsep and bottomsep.
46  *
47  * The standard layout is an exception: its parindent is only set, if the
48  * previous paragraph is standard too. Well, this is LateX and it is good!
49  */
50
51 ///
52 class Layout {
53 public:
54         ///
55         Layout();
56         /// is this layout a default layout created for an unknown layout
57         bool isUnknown() const { return unknown_; }
58         void setUnknown(bool unknown) { unknown_ = unknown; }
59         /// Reads a layout definition from file
60         /// \return true on success.
61         bool read(Lexer &, TextClass const &, bool validating = false);
62         ///
63         void readAlign(Lexer &);
64         ///
65         void readAlignPossible(Lexer &);
66         ///
67         void readLabelType(Lexer &);
68         ///
69         void readEndLabelType(Lexer &);
70         ///
71         void readMargin(Lexer &);
72         ///
73         void readLatexType(Lexer &);
74         ///
75         void readSpacing(Lexer &);
76         ///
77         void readArgument(Lexer &, bool);
78         /// Write a layout definition in utf8 encoding
79         void write(std::ostream &) const;
80         ///
81         docstring const & name() const { return name_; }
82         ///
83         void setName(docstring const & n) { name_ = n; }
84         ///
85         docstring const & obsoleted_by() const { return obsoleted_by_; }
86         ///
87         docstring const & depends_on() const { return depends_on_; }
88         ///
89         std::string const & latexname() const { return latexname_; }
90         ///
91         std::string const & itemcommand() const { return itemcommand_; }
92         /// One argument of this layout
93         struct latexarg {
94                 docstring labelstring;
95                 docstring menustring;
96                 bool mandatory = false;
97                 bool nodelims = false;
98                 docstring ldelim;
99                 docstring rdelim;
100                 docstring defaultarg;
101                 docstring presetarg;
102                 docstring tooltip;
103                 std::string required;
104                 std::string decoration;
105                 FontInfo font = inherit_font;
106                 FontInfo labelfont = inherit_font;
107                 bool autoinsert = false;
108                 bool insertcotext = false;
109                 bool insertonnewline = false;
110                 ArgPassThru passthru = PT_INHERITED;
111                 docstring pass_thru_chars;
112                 bool is_toc_caption = false;
113                 bool free_spacing = false;
114                 std::string newlinecmd;
115                 /// The DocBook tag corresponding to this argument.
116                 docstring docbooktag;
117                 docstring docbooktagtype;
118                 docstring docbookattr;
119                 /// Whether this argument should be output after the main tag (default: inside). The result if the argument
120                 /// should be output both before and after the main tag is undefined.
121                 bool docbookargumentbeforemaintag = false;
122                 /// Whether this argument should be output before the main tag (default: inside). The result if the argument
123                 /// should be output both before and after the main tag is undefined.
124                 bool docbookargumentaftermaintag = false;
125         };
126         ///
127         typedef std::map<std::string, latexarg> LaTeXArgMap;
128         ///
129         LaTeXArgMap const & latexargs() const { return latexargs_; }
130         ///
131         LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
132         ///
133         LaTeXArgMap const & listpreamble() const { return listpreamble_; }
134         ///
135         LaTeXArgMap const & itemargs() const { return itemargs_; }
136         /// Returns true is the layout has arguments. If false, then an
137         /// InsetArgument in this layout stands for the parent InsetText.
138         bool hasArgs() const;
139         /// Returns latexargs() + postcommandargs() + itemargs().
140         /// But note that it returns a *copy*, not a reference, so do not do
141         /// anything like:
142         ///   Layout::LaTeXArgMap::iterator it = args().begin();
143         ///   Layout::LaTeXArgMap::iterator en = args().end();
144         /// Those are iterators for different containers.
145         LaTeXArgMap args() const;
146         ///
147         int optArgs() const;
148         ///
149         int requiredArgs() const;
150         ///
151         docstring const & labelstring(bool in_appendix) const
152         { return in_appendix ? labelstring_appendix_ : labelstring_; }
153         ///
154         docstring const & endlabelstring() const { return endlabelstring_; }
155         ///
156         docstring const & category() const { return category_; }
157         ///
158         docstring const & preamble() const { return preamble_; }
159         /// Get language dependent macro definitions needed for this layout
160         /// for language \p lang
161         docstring const langpreamble() const { return langpreamble_; }
162         /// Get language and babel dependent macro definitions needed for
163         /// this layout for language \p lang
164         docstring const babelpreamble() const { return babelpreamble_; }
165         ///
166         std::set<std::string> const & required() const { return required_; }
167         ///
168         std::set<docstring> const & autonests() const { return autonests_; }
169         ///
170         std::set<docstring> const & isAutonestedBy() const { return autonested_by_; }
171         ///
172         std::string const & latexparam() const { return latexparam_; }
173         ///
174         docstring leftdelim() const { return leftdelim_; }
175         ///
176         docstring rightdelim() const { return rightdelim_; }
177         ///
178         std::string const & innertag() const { return innertag_; }
179         ///
180         std::string const & labeltag() const { return labeltag_; }
181         ///
182         std::string const & itemtag() const { return itemtag_; }
183         ///
184         std::string const & htmltag() const;
185         ///
186         std::string const & htmlattr() const { return htmlattr_; }
187         ///
188         std::string const & htmlclass() const;
189         /// Returns a complete attribute string, including class, etc.
190         std::string const & htmlGetAttrString() const;
191         ///
192         std::string const & htmlitemtag() const;
193         ///
194         std::string const & htmlitemattr() const;
195         ///
196         std::string const & htmllabeltag() const;
197         ///
198         std::string const & htmllabelattr() const;
199         ///
200         bool htmlintoc() const { return htmlintoc_; }
201         ///
202         std::string defaultCSSClass() const;
203         ///
204         bool htmllabelfirst() const { return htmllabelfirst_; }
205         ///
206         docstring htmlstyle() const;
207         ///
208         docstring const & htmlpreamble() const { return htmlpreamble_; }
209         ///
210         bool htmltitle() const { return htmltitle_; }
211         ///
212         std::string const & docbooktag() const;
213         ///
214         std::string const & docbookattr() const;
215         ///
216         std::string const & docbooktagtype() const;
217         ///
218         std::string const & docbookinnertag() const;
219         ///
220         std::string const & docbookinnerattr() const;
221         ///
222         std::string const & docbookinnertagtype() const;
223         ///
224         std::string const & docbookininfo() const;
225         ///
226         bool docbookabstract() const { return docbookabstract_; }
227         ///
228         std::string const & docbookwrappertag() const;
229         ///
230         std::string const & docbookwrapperattr() const;
231         ///
232         std::string const & docbookwrappertagtype() const;
233         ///
234         bool docbookwrappermergewithprevious() const { return docbookwrappermergewithprevious_; }
235         ///
236         std::string const & docbooksectiontag() const;
237         ///
238         bool docbooksection() const { return docbooksection_; }
239         ///
240         std::string const & docbookitemwrappertag() const;
241         ///
242         std::string const & docbookitemwrapperattr() const;
243         ///
244         std::string const & docbookitemwrappertagtype() const;
245         ///
246         std::string const & docbookitemlabeltag() const;
247         ///
248         std::string const & docbookitemlabelattr() const;
249         ///
250         std::string const & docbookitemlabeltagtype() const;
251         ///
252         std::string const & docbookiteminnertag() const;
253         ///
254         std::string const & docbookiteminnerattr() const;
255         ///
256         std::string const & docbookiteminnertagtype() const;
257         ///
258         std::string const & docbookitemtag() const;
259         ///
260         std::string const & docbookitemattr() const;
261         ///
262         std::string const & docbookitemtagtype() const;
263         ///
264         std::string const & docbookforceabstracttag() const;
265         ///
266         bool docbooknofontinside() const { return docbooknofontinside_; }
267         ///
268         bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
269         ///
270         bool isCommand() const { return latextype == LATEX_COMMAND; }
271         ///
272         bool isEnvironment() const {
273                 return latextype == LATEX_ENVIRONMENT
274                         || latextype == LATEX_BIB_ENVIRONMENT
275                         || latextype == LATEX_ITEM_ENVIRONMENT
276                         || latextype == LATEX_LIST_ENVIRONMENT;
277         }
278         /// Is this the kind of layout in which adjacent paragraphs
279         /// are handled as one group?
280         bool isParagraphGroup() const { return par_group_; }
281         ///
282         bool labelIsInline() const {
283                 return labeltype == LABEL_STATIC
284                         || labeltype == LABEL_SENSITIVE
285                         || labeltype == LABEL_ENUMERATE
286                         || labeltype == LABEL_ITEMIZE;
287         }
288         bool labelIsAbove() const {
289                 return labeltype == LABEL_ABOVE
290                         || labeltype == LABEL_CENTERED
291                         || labeltype == LABEL_BIBLIO;
292         }
293         ///
294         bool addToToc() const { return add_to_toc_; }
295         ///
296         std::string tocType() const { return toc_type_; }
297         ///
298         bool isTocCaption() const { return is_toc_caption_; }
299
300         ///
301         bool operator==(Layout const &) const;
302         ///
303         bool operator!=(Layout const & rhs) const
304                 { return !(*this == rhs); }
305
306         ////////////////////////////////////////////////////////////////
307         // members
308         ////////////////////////////////////////////////////////////////
309         /** Default font for this layout/environment.
310             The main font for this kind of environment. If an attribute has
311             INHERITED_*, it means that the value is specified by
312             the defaultfont for the entire layout. If we are nested, the
313             font is inherited from the font in the environment one level
314             up until the font is resolved. The values :IGNORE_*
315             and FONT_TOGGLE are illegal here.
316         */
317         FontInfo font;
318
319         /** Default font for labels.
320             Interpretation the same as for font above
321         */
322         FontInfo labelfont;
323
324         /** Resolved version of the font for this layout/environment.
325             This is a resolved version the default font. The font is resolved
326             against the defaultfont of the entire layout.
327         */
328         FontInfo resfont;
329
330         /** Resolved version of the font used for labels.
331             This is a resolved version the label font. The font is resolved
332             against the defaultfont of the entire layout.
333         */
334         FontInfo reslabelfont;
335
336         /// Text that dictates how wide the left margin is on the screen
337         docstring leftmargin;
338         /// Text that dictates how wide the right margin is on the screen
339         docstring rightmargin;
340         /// Text that dictates how much space to leave after a potential label
341         docstring labelsep;
342         /// Text that dictates how much space to leave before a potential label
343         docstring labelindent;
344         /// Text that dictates the width of the indentation of indented pars
345         docstring parindent;
346         ///
347         double parskip;
348         ///
349         double itemsep;
350         ///
351         double topsep;
352         ///
353         double bottomsep;
354         ///
355         double labelbottomsep;
356         ///
357         double parsep;
358         ///
359         Spacing spacing;
360         ///
361         LyXAlignment align;
362         ///
363         LyXAlignment alignpossible;
364         ///
365         LabelType labeltype;
366         ///
367         EndLabelType endlabeltype;
368         ///
369         MarginType margintype;
370         ///
371         bool newline_allowed;
372         ///
373         bool nextnoindent;
374         ///
375         ToggleIndentation toggle_indent;
376         ///
377         bool free_spacing;
378         ///
379         bool pass_thru;
380         /// Individual chars to be passed verbatim
381         docstring pass_thru_chars;
382         ///
383         bool parbreak_is_newline;
384         /// show this in toc
385         int toclevel;
386         /// special value of toclevel for non-section layouts
387         static const int NOT_IN_TOC;
388
389         /** true when the fragile commands in the paragraph need to be
390             \protect'ed. */
391         bool needprotect;
392         /** true when the verbatim stuff of this layout needs to be
393             \cprotect'ed. */
394         bool needcprotect;
395         /** true when specific commands in this paragraph need to be
396             protected in an \mbox. */
397         bool needmboxprotect;
398         /// true when empty paragraphs should be kept.
399         bool keepempty;
400         /// Type of LaTeX object
401         LatexType latextype;
402         /// Does this object belong in the title part of the document?
403         bool intitle;
404         /// Is the content to go in the preamble rather than the body?
405         bool inpreamble;
406         /// Which counter to step
407         docstring counter;
408         /// Resume counter?
409         bool resumecounter;
410         /// Step parent counter?
411         bool stepparentcounter;
412         /// Prefix to use when creating labels
413         docstring refprefix;
414         /// Depth of XML command
415         int commanddepth;
416
417         /// Is this spellchecked?
418         bool spellcheck;
419         /**
420          * Should this layout definition always be written to the document preamble?
421          * Possible values are:
422          *   0: Do not enforce local layout
423          * >=1: Enforce local layout with version forcelocal
424          *  -1: Enforce local layout with infinite version
425          * On reading, the forced local layout is only used if its version
426          * number is greater than the version number of the same layout in the
427          * document class. Otherwise, it is ignored.
428          */
429         int forcelocal;
430
431
432 private:
433         /// Reads a layout definition from file
434         /// \return true on success.
435         bool readIgnoreForcelocal(Lexer &, TextClass const &, bool validating);
436         /// generates the default CSS for this layout
437         void makeDefaultCSS() const;
438         ///
439         std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
440         ///
441         std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
442
443         /// Name of the layout/paragraph environment
444         docstring name_;
445
446         /// LaTeX name for environment
447         std::string latexname_;
448
449         /** Is this layout the default layout for an unknown layout? If
450          * so, its name will be displayed as xxx (unknown).
451          */
452         bool unknown_;
453
454         /** Name of an layout that has replaced this layout.
455             This is used to rename a layout, while keeping backward
456             compatibility
457         */
458         docstring obsoleted_by_;
459
460         /** Name of an layout which preamble must come before this one
461             This is used when the preamble snippet uses macros defined in
462             another preamble
463          */
464         docstring depends_on_;
465
466         /// Label string. "Abstract", "Reference", "Caption"...
467         docstring labelstring_;
468         ///
469         docstring endlabelstring_;
470         /// Label string inside appendix. "Appendix", ...
471         docstring labelstring_appendix_;
472         /// LaTeX parameter for environment
473         std::string latexparam_;
474         /// Item command in lists
475         std::string itemcommand_;
476         /// Left delimiter of the content
477         docstring leftdelim_;
478         /// Right delimiter of the content
479         docstring rightdelim_;
480         /// Internal tag to use (e.g., <title></title> for sect header)
481         std::string innertag_;
482         /// Internal tag to use (e.g. to surround varentrylist label)
483         std::string labeltag_;
484         /// Internal tag to surround the item text in a list.
485         std::string itemtag_;
486         /// The interpretation of this tag varies depending upon the latextype.
487         /// In an environment, it is the tag enclosing all content for this set of
488         /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
489         /// it would be: ul. (You get the idea.)
490         ///
491         /// For a command, it is the tag enclosing the content of the command.
492         /// So, for section, it might be: h2.
493         ///
494         /// For the paragraph type, it is the tag that will enclose each paragraph.
495         ///
496         /// Defaults to "div".
497         mutable std::string htmltag_;
498         /// Additional attributes for inclusion with the start tag.
499         /// Note that the CSS class is handled separately.
500         std::string htmlattr_;
501         /// The CSS class to use. Calculated from the layout name if not given.
502         mutable std::string htmlclass_;
503         /// cached
504         mutable std::string htmlfullattrs_;
505         /// Tag for individual paragraphs in an environment. In lists, this
506         /// would be something like "li". But it also needs to be set for
507         /// quotation, e.g., since the paragraphs in a quote need to be
508         /// in "p" tags. Default is "div".
509         /// Note that when I said "environment", I meant it: This has no
510         /// effect for LATEX_PARAGRAPH type layouts.
511         mutable std::string htmlitemtag_;
512         /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
513         mutable std::string htmlitemattr_;
514         /// Tag for labels, of whatever sort. One use for this is in setting
515         /// descriptions, in which case it would be: dt. Another use is to
516         /// customize the display of, say, the auto-generated label for
517         /// sections. Defaults to "span".
518         /// If set to "NONE", this suppresses the printing of the label.
519         mutable std::string htmllabeltag_;
520         /// Attributes for the label. Defaults to: class="layoutname_label".
521         mutable std::string htmllabelattr_;
522         /// Whether to put the label before the item, or within the item.
523         /// I.e., do we have (true):
524         ///    <label>...</label><item>...</item>
525         /// or instead (false):
526         ///    <item><label>...</label>...</item>
527         /// The latter is the default.
528         bool htmllabelfirst_;
529         /// Is this to be output with the toc?
530         bool htmlintoc_;
531         /// CSS information needed by this layout.
532         docstring htmlstyle_;
533         /// DocBook tag corresponding to this layout.
534         mutable std::string docbooktag_;
535         /// Roles to add to docbooktag_, if any (default: none).
536         mutable std::string docbookattr_;
537         /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
538         mutable std::string docbooktagtype_;
539         /// DocBook inner tag corresponding to this layout.
540         mutable std::string docbookinnertag_;
541         /// Roles to add to docbookinnertag_, if any (default: none).
542         mutable std::string docbookinnerattr_;
543         /// DocBook inner-tag type corresponding to this layout (block, paragraph, or inline; default: block).
544         mutable std::string docbookinnertagtype_;
545         /// DocBook tag corresponding to this item (mainly for lists).
546         mutable std::string docbookitemtag_;
547         /// Roles to add to docbookitemtag_, if any (default: none).
548         mutable std::string docbookitemattr_;
549         /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
550         mutable std::string docbookitemtagtype_;
551         /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
552         mutable std::string docbookitemwrappertag_;
553         /// Roles to add to docbookitemwrappertag_, if any (default: none).
554         mutable std::string docbookitemwrapperattr_;
555         /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
556         mutable std::string docbookitemwrappertagtype_;
557         /// DocBook tag corresponding to this label (mostly for description lists;
558         /// labels in the common sense do not exist with DocBook).
559         mutable std::string docbookitemlabeltag_;
560         /// Roles to add to docbooklabeltag_, if any (default: none).
561         mutable std::string docbookitemlabelattr_;
562         /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
563         mutable std::string docbookitemlabeltagtype_;
564         /// DocBook tag to add within the item, around its direct content (mainly for lists).
565         mutable std::string docbookiteminnertag_;
566         /// Roles to add to docbookiteminnertag_, if any (default: none).
567         mutable std::string docbookiteminnerattr_;
568         /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
569         mutable std::string docbookiteminnertagtype_;
570         /// DocBook tag corresponding to this wrapper around the main tag.
571         mutable std::string docbookwrappertag_;
572         /// Roles to add to docbookwrappertag_, if any (default: none).
573         mutable std::string docbookwrapperattr_;
574         /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
575         mutable std::string docbookwrappertagtype_;
576         /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
577         bool docbookwrappermergewithprevious_;
578         /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
579         /// (default: section).
580         mutable std::string docbooksectiontag_;
581         /// Whether this element should be considered as a section-level element in DocBook.
582         bool docbooksection_;
583         /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
584         mutable std::string docbookininfo_;
585         /// Whether this paragraph should be considered as abstract. Such paragraphs are output as a part of the document
586         /// abstract element (corresponding to the root tag).
587         bool docbookabstract_;
588         /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
589         /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
590         /// held by this attribute
591         mutable std::string docbookforceabstracttag_;
592         /// Whether font tags are allowed inside this tag.
593         bool docbooknofontinside_ = false;
594         /// Should we generate the default CSS for this layout, even if HTMLStyle
595         /// has been given? Default is false.
596         /// Note that the default CSS is output first, then the user CSS, so it is
597         /// possible to override what one does not want.
598         bool htmlforcecss_;
599         /// A cache for the default style info so generated.
600         mutable docstring htmldefaultstyle_;
601         /// Any other info for the HTML header.
602         docstring htmlpreamble_;
603         /// Whether this is the <title> paragraph.
604         bool htmltitle_;
605         /// calculating this is expensive, so we cache it.
606         mutable std::string defaultcssclass_;
607         /// This is the `category' for this layout. The following are
608         /// recommended basic categories: FrontMatter, BackMatter, MainText,
609         /// Sectioning, Starred, List, Reasoning.
610         docstring category_;
611         /// Macro definitions needed for this layout
612         docstring preamble_;
613         /// Language dependent macro definitions needed for this layout
614         docstring langpreamble_;
615         /// Language and babel dependent macro definitions needed for this layout
616         docstring babelpreamble_;
617         /// Are adjacent paragraphs handled as one group?
618         bool par_group_;
619         /// Packages needed for this layout
620         std::set<std::string> required_;
621         /// Layouts that are by default nested after this one
622         std::set<docstring> autonests_;
623         /// Layouts that by auto-nest this one
624         std::set<docstring> autonested_by_;
625         ///
626         LaTeXArgMap latexargs_;
627         ///
628         LaTeXArgMap postcommandargs_;
629         ///
630         LaTeXArgMap listpreamble_;
631         ///
632         LaTeXArgMap itemargs_;
633         ///
634         bool add_to_toc_;
635         ///
636         std::string toc_type_;
637         ///
638         bool is_toc_caption_;
639 };
640
641
642 } // namespace lyx
643
644 #endif