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