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