]> git.lyx.org Git - lyx.git/blob - src/Layout.h
Hack to display section symbol
[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 docbookgeneratetitle() const { return docbookgeneratetitle_; }
269         ///
270         bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
271         ///
272         bool isCommand() const { return latextype == LATEX_COMMAND; }
273         ///
274         bool isEnvironment() const {
275                 return latextype == LATEX_ENVIRONMENT
276                         || latextype == LATEX_BIB_ENVIRONMENT
277                         || latextype == LATEX_ITEM_ENVIRONMENT
278                         || latextype == LATEX_LIST_ENVIRONMENT;
279         }
280         /// Is this the kind of layout in which adjacent paragraphs
281         /// are handled as one group?
282         bool isParagraphGroup() const { return par_group_; }
283         ///
284         bool labelIsInline() const {
285                 return labeltype == LABEL_STATIC
286                         || labeltype == LABEL_SENSITIVE
287                         || labeltype == LABEL_ENUMERATE
288                         || labeltype == LABEL_ITEMIZE;
289         }
290         bool labelIsAbove() const {
291                 return labeltype == LABEL_ABOVE
292                         || labeltype == LABEL_CENTERED
293                         || labeltype == LABEL_BIBLIO;
294         }
295         bool isNumHeadingLabelType() const {
296                 return labeltype == LABEL_ABOVE
297                         || labeltype == LABEL_CENTERED
298                         || labeltype == LABEL_STATIC;
299         }
300         ///
301         bool addToToc() const { return add_to_toc_; }
302         ///
303         std::string tocType() const { return toc_type_; }
304         ///
305         bool isTocCaption() const { return is_toc_caption_; }
306
307         ///
308         bool operator==(Layout const &) const;
309         ///
310         bool operator!=(Layout const & rhs) const
311                 { return !(*this == rhs); }
312
313         ////////////////////////////////////////////////////////////////
314         // members
315         ////////////////////////////////////////////////////////////////
316         /** Default font for this layout/environment.
317             The main font for this kind of environment. If an attribute has
318             INHERITED_*, it means that the value is specified by
319             the defaultfont for the entire layout. If we are nested, the
320             font is inherited from the font in the environment one level
321             up until the font is resolved. The values :IGNORE_*
322             and FONT_TOGGLE are illegal here.
323         */
324         FontInfo font;
325
326         /** Default font for labels.
327             Interpretation the same as for font above
328         */
329         FontInfo labelfont;
330
331         /** Resolved version of the font for this layout/environment.
332             This is a resolved version the default font. The font is resolved
333             against the defaultfont of the entire layout.
334         */
335         FontInfo resfont;
336
337         /** Resolved version of the font used for labels.
338             This is a resolved version the label font. The font is resolved
339             against the defaultfont of the entire layout.
340         */
341         FontInfo reslabelfont;
342
343         /// Text that dictates how wide the left margin is on the screen
344         docstring leftmargin;
345         /// Text that dictates how wide the right margin is on the screen
346         docstring rightmargin;
347         /// Text that dictates how much space to leave after a potential label
348         docstring labelsep;
349         /// Text that dictates how much space to leave before a potential label
350         docstring labelindent;
351         /// Text that dictates the width of the indentation of indented pars
352         docstring parindent;
353         ///
354         double parskip;
355         ///
356         double itemsep;
357         ///
358         double topsep;
359         ///
360         double bottomsep;
361         ///
362         double labelbottomsep;
363         ///
364         double parsep;
365         ///
366         Spacing spacing;
367         ///
368         LyXAlignment align;
369         ///
370         LyXAlignment alignpossible;
371         ///
372         LabelType labeltype;
373         ///
374         EndLabelType endlabeltype;
375         ///
376         MarginType margintype;
377         ///
378         bool newline_allowed;
379         ///
380         bool nextnoindent;
381         ///
382         ToggleIndentation toggle_indent;
383         ///
384         bool free_spacing;
385         ///
386         bool pass_thru;
387         /// Individual chars to be passed verbatim
388         docstring pass_thru_chars;
389         ///
390         bool parbreak_is_newline;
391         /// show this in toc
392         int toclevel;
393         /// special value of toclevel for non-section layouts
394         static const int NOT_IN_TOC;
395
396         /** true when the fragile commands in the paragraph need to be
397             \protect'ed. */
398         bool needprotect;
399         /** true when the verbatim stuff of this layout needs to be
400             \cprotect'ed. */
401         bool needcprotect;
402         /** true when specific commands in this paragraph need to be
403             protected in an \mbox. */
404         bool needmboxprotect;
405         /// true when empty paragraphs should be kept.
406         bool keepempty;
407         /// Type of LaTeX object
408         LatexType latextype;
409         /// Does this object belong in the title part of the document?
410         bool intitle;
411         /// Is the content to go in the preamble rather than the body?
412         bool inpreamble;
413         /// Which counter to step
414         docstring counter;
415         /// Resume counter?
416         bool resumecounter;
417         /// Step parent counter?
418         bool stepparentcounter;
419         /// Prefix to use when creating labels
420         docstring refprefix;
421         /// Depth of XML command
422         int commanddepth;
423
424         /// Is this spellchecked?
425         bool spellcheck;
426         /**
427          * Should this layout definition always be written to the document preamble?
428          * Possible values are:
429          *   0: Do not enforce local layout
430          * >=1: Enforce local layout with version forcelocal
431          *  -1: Enforce local layout with infinite version
432          * On reading, the forced local layout is only used if its version
433          * number is greater than the version number of the same layout in the
434          * document class. Otherwise, it is ignored.
435          */
436         int forcelocal;
437
438
439 private:
440         /// Reads a layout definition from file
441         /// \return true on success.
442         bool readIgnoreForcelocal(Lexer &, TextClass const &, bool validating);
443         /// generates the default CSS for this layout
444         void makeDefaultCSS() const;
445         ///
446         std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
447         ///
448         std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
449
450         /// Name of the layout/paragraph environment
451         docstring name_;
452
453         /// LaTeX name for environment
454         std::string latexname_;
455
456         /** Is this layout the default layout for an unknown layout? If
457          * so, its name will be displayed as xxx (unknown).
458          */
459         bool unknown_;
460
461         /** Name of an layout that has replaced this layout.
462             This is used to rename a layout, while keeping backward
463             compatibility
464         */
465         docstring obsoleted_by_;
466
467         /** Name of an layout which preamble must come before this one
468             This is used when the preamble snippet uses macros defined in
469             another preamble
470          */
471         docstring depends_on_;
472
473         /// Label string. "Abstract", "Reference", "Caption"...
474         docstring labelstring_;
475         ///
476         docstring endlabelstring_;
477         /// Label string inside appendix. "Appendix", ...
478         docstring labelstring_appendix_;
479         /// LaTeX parameter for environment
480         std::string latexparam_;
481         /// Item command in lists
482         std::string itemcommand_;
483         /// Left delimiter of the content
484         docstring leftdelim_;
485         /// Right delimiter of the content
486         docstring rightdelim_;
487         /// Internal tag to use (e.g., <title></title> for sect header)
488         std::string innertag_;
489         /// Internal tag to use (e.g. to surround varentrylist label)
490         std::string labeltag_;
491         /// Internal tag to surround the item text in a list.
492         std::string itemtag_;
493         /// The interpretation of this tag varies depending upon the latextype.
494         /// In an environment, it is the tag enclosing all content for this set of
495         /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
496         /// it would be: ul. (You get the idea.)
497         ///
498         /// For a command, it is the tag enclosing the content of the command.
499         /// So, for section, it might be: h2.
500         ///
501         /// For the paragraph type, it is the tag that will enclose each paragraph.
502         ///
503         /// Defaults to "div".
504         mutable std::string htmltag_;
505         /// Additional attributes for inclusion with the start tag.
506         /// Note that the CSS class is handled separately.
507         std::string htmlattr_;
508         /// The CSS class to use. Calculated from the layout name if not given.
509         mutable std::string htmlclass_;
510         /// cached
511         mutable std::string htmlfullattrs_;
512         /// Tag for individual paragraphs in an environment. In lists, this
513         /// would be something like "li". But it also needs to be set for
514         /// quotation, e.g., since the paragraphs in a quote need to be
515         /// in "p" tags. Default is "div".
516         /// Note that when I said "environment", I meant it: This has no
517         /// effect for LATEX_PARAGRAPH type layouts.
518         mutable std::string htmlitemtag_;
519         /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
520         mutable std::string htmlitemattr_;
521         /// Tag for labels, of whatever sort. One use for this is in setting
522         /// descriptions, in which case it would be: dt. Another use is to
523         /// customize the display of, say, the auto-generated label for
524         /// sections. Defaults to "span".
525         /// If set to "NONE", this suppresses the printing of the label.
526         mutable std::string htmllabeltag_;
527         /// Attributes for the label. Defaults to: class="layoutname_label".
528         mutable std::string htmllabelattr_;
529         /// Whether to put the label before the item, or within the item.
530         /// I.e., do we have (true):
531         ///    <label>...</label><item>...</item>
532         /// or instead (false):
533         ///    <item><label>...</label>...</item>
534         /// The latter is the default.
535         bool htmllabelfirst_;
536         /// Is this to be output with the toc?
537         bool htmlintoc_;
538         /// CSS information needed by this layout.
539         docstring htmlstyle_;
540         /// DocBook tag corresponding to this layout.
541         mutable std::string docbooktag_;
542         /// Roles to add to docbooktag_, if any (default: none).
543         mutable std::string docbookattr_;
544         /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
545         mutable std::string docbooktagtype_;
546         /// DocBook inner tag corresponding to this layout.
547         mutable std::string docbookinnertag_;
548         /// Roles to add to docbookinnertag_, if any (default: none).
549         mutable std::string docbookinnerattr_;
550         /// DocBook inner-tag type corresponding to this layout (block, paragraph, or inline; default: block).
551         mutable std::string docbookinnertagtype_;
552         /// DocBook tag corresponding to this item (mainly for lists).
553         mutable std::string docbookitemtag_;
554         /// Roles to add to docbookitemtag_, if any (default: none).
555         mutable std::string docbookitemattr_;
556         /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
557         mutable std::string docbookitemtagtype_;
558         /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
559         mutable std::string docbookitemwrappertag_;
560         /// Roles to add to docbookitemwrappertag_, if any (default: none).
561         mutable std::string docbookitemwrapperattr_;
562         /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
563         mutable std::string docbookitemwrappertagtype_;
564         /// DocBook tag corresponding to this label (mostly for description lists;
565         /// labels in the common sense do not exist with DocBook).
566         mutable std::string docbookitemlabeltag_;
567         /// Roles to add to docbooklabeltag_, if any (default: none).
568         mutable std::string docbookitemlabelattr_;
569         /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
570         mutable std::string docbookitemlabeltagtype_;
571         /// DocBook tag to add within the item, around its direct content (mainly for lists).
572         mutable std::string docbookiteminnertag_;
573         /// Roles to add to docbookiteminnertag_, if any (default: none).
574         mutable std::string docbookiteminnerattr_;
575         /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
576         mutable std::string docbookiteminnertagtype_;
577         /// DocBook tag corresponding to this wrapper around the main tag.
578         mutable std::string docbookwrappertag_;
579         /// Roles to add to docbookwrappertag_, if any (default: none).
580         mutable std::string docbookwrapperattr_;
581         /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
582         mutable std::string docbookwrappertagtype_;
583         /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
584         bool docbookwrappermergewithprevious_;
585         /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
586         /// (default: section).
587         mutable std::string docbooksectiontag_;
588         /// Whether this element should be considered as a section-level element in DocBook.
589         bool docbooksection_;
590         /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
591         mutable std::string docbookininfo_;
592         /// Whether this paragraph should be considered as abstract. Such paragraphs are output as a part of the document
593         /// abstract element (corresponding to the root tag).
594         bool docbookabstract_;
595         /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
596         /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
597         /// held by this attribute.
598         mutable std::string docbookforceabstracttag_;
599         /// Whether font tags are allowed inside this tag.
600         bool docbooknofontinside_ = false;
601         /// Whether LyX should create a title on its own, just after the wrapper tag. Typically, this parameter is required
602         /// because the wrapper tag requires a title (like a figure). The generated title will be similar to a LyXHTML label
603         /// (environment type and a number).
604         bool docbookgeneratetitle_ = false;
605         /// Should we generate the default CSS for this layout, even if HTMLStyle
606         /// has been given? Default is false.
607         /// Note that the default CSS is output first, then the user CSS, so it is
608         /// possible to override what one does not want.
609         bool htmlforcecss_;
610         /// A cache for the default style info so generated.
611         mutable docstring htmldefaultstyle_;
612         /// Any other info for the HTML header.
613         docstring htmlpreamble_;
614         /// Whether this is the <title> paragraph.
615         bool htmltitle_;
616         /// calculating this is expensive, so we cache it.
617         mutable std::string defaultcssclass_;
618         /// This is the `category' for this layout. The following are
619         /// recommended basic categories: FrontMatter, BackMatter, MainText,
620         /// Sectioning, Starred, List, Reasoning.
621         docstring category_;
622         /// Macro definitions needed for this layout
623         docstring preamble_;
624         /// Language dependent macro definitions needed for this layout
625         docstring langpreamble_;
626         /// Language and babel dependent macro definitions needed for this layout
627         docstring babelpreamble_;
628         /// Are adjacent paragraphs handled as one group?
629         bool par_group_;
630         /// Packages needed for this layout
631         std::set<std::string> required_;
632         /// Layouts that are by default nested after this one
633         std::set<docstring> autonests_;
634         /// Layouts that by auto-nest this one
635         std::set<docstring> autonested_by_;
636         ///
637         LaTeXArgMap latexargs_;
638         ///
639         LaTeXArgMap postcommandargs_;
640         ///
641         LaTeXArgMap listpreamble_;
642         ///
643         LaTeXArgMap itemargs_;
644         ///
645         bool add_to_toc_;
646         ///
647         std::string toc_type_;
648         ///
649         bool is_toc_caption_;
650 };
651
652
653 } // namespace lyx
654
655 #endif