4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
11 * Full author contact details are available in file CREDITS.
18 #include "LayoutEnums.h"
20 #include "support/debug.h"
21 #include "support/docstring.h"
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.
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.
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!
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);
63 void readAlign(Lexer &);
65 void readAlignPossible(Lexer &);
67 void readLabelType(Lexer &);
69 void readEndLabelType(Lexer &);
71 void readMargin(Lexer &);
73 void readLatexType(Lexer &);
75 void readSpacing(Lexer &);
77 void readArgument(Lexer &, bool);
78 /// Write a layout definition in utf8 encoding
79 void write(std::ostream &) const;
81 docstring const & name() const { return name_; }
83 void setName(docstring const & n) { name_ = n; }
85 docstring const & obsoleted_by() const { return obsoleted_by_; }
87 docstring const & depends_on() const { return depends_on_; }
89 std::string const & latexname() const { return latexname_; }
91 std::string const & itemcommand() const { return itemcommand_; }
92 /// One argument of this layout
94 docstring labelstring;
96 bool mandatory = false;
97 bool nodelims = false;
100 docstring defaultarg;
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;
127 typedef std::map<std::string, latexarg> LaTeXArgMap;
129 LaTeXArgMap const & latexargs() const { return latexargs_; }
131 LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
133 LaTeXArgMap const & listpreamble() const { return listpreamble_; }
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
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;
149 int requiredArgs() const;
151 docstring const & labelstring(bool in_appendix) const
152 { return in_appendix ? labelstring_appendix_ : labelstring_; }
154 docstring const & endlabelstring() const { return endlabelstring_; }
156 docstring const & category() const { return category_; }
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_; }
166 std::set<std::string> const & required() const { return required_; }
168 std::set<docstring> const & autonests() const { return autonests_; }
170 std::set<docstring> const & isAutonestedBy() const { return autonested_by_; }
172 std::string const & latexparam() const { return latexparam_; }
174 docstring leftdelim() const { return leftdelim_; }
176 docstring rightdelim() const { return rightdelim_; }
178 std::string const & innertag() const { return innertag_; }
180 std::string const & labeltag() const { return labeltag_; }
182 std::string const & itemtag() const { return itemtag_; }
184 std::string const & htmltag() const;
186 std::string const & htmlattr() const { return htmlattr_; }
188 std::string const & htmlclass() const;
189 /// Returns a complete attribute string, including class, etc.
190 std::string const & htmlGetAttrString() const;
192 std::string const & htmlitemtag() const;
194 std::string const & htmlitemattr() const;
196 std::string const & htmllabeltag() const;
198 std::string const & htmllabelattr() const;
200 bool htmlintoc() const { return htmlintoc_; }
202 std::string defaultCSSClass() const;
204 bool htmllabelfirst() const { return htmllabelfirst_; }
206 docstring htmlstyle() const;
208 docstring const & htmlpreamble() const { return htmlpreamble_; }
210 bool htmltitle() const { return htmltitle_; }
212 std::string const & docbooktag() const;
214 std::string const & docbookattr() const;
216 std::string const & docbooktagtype() const;
218 std::string const & docbookinnertag() const;
220 std::string const & docbookinnerattr() const;
222 std::string const & docbookinnertagtype() const;
224 std::string const & docbookininfo() const;
226 bool docbookabstract() const { return docbookabstract_; }
228 std::string const & docbookwrappertag() const;
230 std::string const & docbookwrapperattr() const;
232 std::string const & docbookwrappertagtype() const;
234 bool docbookwrappermergewithprevious() const { return docbookwrappermergewithprevious_; }
236 std::string const & docbooksectiontag() const;
238 bool docbooksection() const { return docbooksection_; }
240 std::string const & docbookitemwrappertag() const;
242 std::string const & docbookitemwrapperattr() const;
244 std::string const & docbookitemwrappertagtype() const;
246 std::string const & docbookitemlabeltag() const;
248 std::string const & docbookitemlabelattr() const;
250 std::string const & docbookitemlabeltagtype() const;
252 std::string const & docbookiteminnertag() const;
254 std::string const & docbookiteminnerattr() const;
256 std::string const & docbookiteminnertagtype() const;
258 std::string const & docbookitemtag() const;
260 std::string const & docbookitemattr() const;
262 std::string const & docbookitemtagtype() const;
264 std::string const & docbookforceabstracttag() const;
266 bool docbooknofontinside() const { return docbooknofontinside_; }
268 bool docbookgeneratetitle() const { return docbookgeneratetitle_; }
270 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
272 bool isCommand() const { return latextype == LATEX_COMMAND; }
274 bool isEnvironment() const {
275 return latextype == LATEX_ENVIRONMENT
276 || latextype == LATEX_BIB_ENVIRONMENT
277 || latextype == LATEX_ITEM_ENVIRONMENT
278 || latextype == LATEX_LIST_ENVIRONMENT;
280 /// Is this the kind of layout in which adjacent paragraphs
281 /// are handled as one group?
282 bool isParagraphGroup() const { return par_group_; }
284 bool labelIsInline() const {
285 return labeltype == LABEL_STATIC
286 || labeltype == LABEL_SENSITIVE
287 || labeltype == LABEL_ENUMERATE
288 || labeltype == LABEL_ITEMIZE;
290 bool labelIsAbove() const {
291 return labeltype == LABEL_ABOVE
292 || labeltype == LABEL_CENTERED
293 || labeltype == LABEL_BIBLIO;
296 bool addToToc() const { return add_to_toc_; }
298 std::string tocType() const { return toc_type_; }
300 bool isTocCaption() const { return is_toc_caption_; }
303 bool operator==(Layout const &) const;
305 bool operator!=(Layout const & rhs) const
306 { return !(*this == rhs); }
308 ////////////////////////////////////////////////////////////////
310 ////////////////////////////////////////////////////////////////
311 /** Default font for this layout/environment.
312 The main font for this kind of environment. If an attribute has
313 INHERITED_*, it means that the value is specified by
314 the defaultfont for the entire layout. If we are nested, the
315 font is inherited from the font in the environment one level
316 up until the font is resolved. The values :IGNORE_*
317 and FONT_TOGGLE are illegal here.
321 /** Default font for labels.
322 Interpretation the same as for font above
326 /** Resolved version of the font for this layout/environment.
327 This is a resolved version the default font. The font is resolved
328 against the defaultfont of the entire layout.
332 /** Resolved version of the font used for labels.
333 This is a resolved version the label font. The font is resolved
334 against the defaultfont of the entire layout.
336 FontInfo reslabelfont;
338 /// Text that dictates how wide the left margin is on the screen
339 docstring leftmargin;
340 /// Text that dictates how wide the right margin is on the screen
341 docstring rightmargin;
342 /// Text that dictates how much space to leave after a potential label
344 /// Text that dictates how much space to leave before a potential label
345 docstring labelindent;
346 /// Text that dictates the width of the indentation of indented pars
357 double labelbottomsep;
365 LyXAlignment alignpossible;
369 EndLabelType endlabeltype;
371 MarginType margintype;
373 bool newline_allowed;
377 ToggleIndentation toggle_indent;
382 /// Individual chars to be passed verbatim
383 docstring pass_thru_chars;
385 bool parbreak_is_newline;
388 /// special value of toclevel for non-section layouts
389 static const int NOT_IN_TOC;
391 /** true when the fragile commands in the paragraph need to be
394 /** true when the verbatim stuff of this layout needs to be
397 /** true when specific commands in this paragraph need to be
398 protected in an \mbox. */
399 bool needmboxprotect;
400 /// true when empty paragraphs should be kept.
402 /// Type of LaTeX object
404 /// Does this object belong in the title part of the document?
406 /// Is the content to go in the preamble rather than the body?
408 /// Which counter to step
412 /// Step parent counter?
413 bool stepparentcounter;
414 /// Prefix to use when creating labels
416 /// Depth of XML command
419 /// Is this spellchecked?
422 * Should this layout definition always be written to the document preamble?
423 * Possible values are:
424 * 0: Do not enforce local layout
425 * >=1: Enforce local layout with version forcelocal
426 * -1: Enforce local layout with infinite version
427 * On reading, the forced local layout is only used if its version
428 * number is greater than the version number of the same layout in the
429 * document class. Otherwise, it is ignored.
435 /// Reads a layout definition from file
436 /// \return true on success.
437 bool readIgnoreForcelocal(Lexer &, TextClass const &, bool validating);
438 /// generates the default CSS for this layout
439 void makeDefaultCSS() const;
441 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
443 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
445 /// Name of the layout/paragraph environment
448 /// LaTeX name for environment
449 std::string latexname_;
451 /** Is this layout the default layout for an unknown layout? If
452 * so, its name will be displayed as xxx (unknown).
456 /** Name of an layout that has replaced this layout.
457 This is used to rename a layout, while keeping backward
460 docstring obsoleted_by_;
462 /** Name of an layout which preamble must come before this one
463 This is used when the preamble snippet uses macros defined in
466 docstring depends_on_;
468 /// Label string. "Abstract", "Reference", "Caption"...
469 docstring labelstring_;
471 docstring endlabelstring_;
472 /// Label string inside appendix. "Appendix", ...
473 docstring labelstring_appendix_;
474 /// LaTeX parameter for environment
475 std::string latexparam_;
476 /// Item command in lists
477 std::string itemcommand_;
478 /// Left delimiter of the content
479 docstring leftdelim_;
480 /// Right delimiter of the content
481 docstring rightdelim_;
482 /// Internal tag to use (e.g., <title></title> for sect header)
483 std::string innertag_;
484 /// Internal tag to use (e.g. to surround varentrylist label)
485 std::string labeltag_;
486 /// Internal tag to surround the item text in a list.
487 std::string itemtag_;
488 /// The interpretation of this tag varies depending upon the latextype.
489 /// In an environment, it is the tag enclosing all content for this set of
490 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
491 /// it would be: ul. (You get the idea.)
493 /// For a command, it is the tag enclosing the content of the command.
494 /// So, for section, it might be: h2.
496 /// For the paragraph type, it is the tag that will enclose each paragraph.
498 /// Defaults to "div".
499 mutable std::string htmltag_;
500 /// Additional attributes for inclusion with the start tag.
501 /// Note that the CSS class is handled separately.
502 std::string htmlattr_;
503 /// The CSS class to use. Calculated from the layout name if not given.
504 mutable std::string htmlclass_;
506 mutable std::string htmlfullattrs_;
507 /// Tag for individual paragraphs in an environment. In lists, this
508 /// would be something like "li". But it also needs to be set for
509 /// quotation, e.g., since the paragraphs in a quote need to be
510 /// in "p" tags. Default is "div".
511 /// Note that when I said "environment", I meant it: This has no
512 /// effect for LATEX_PARAGRAPH type layouts.
513 mutable std::string htmlitemtag_;
514 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
515 mutable std::string htmlitemattr_;
516 /// Tag for labels, of whatever sort. One use for this is in setting
517 /// descriptions, in which case it would be: dt. Another use is to
518 /// customize the display of, say, the auto-generated label for
519 /// sections. Defaults to "span".
520 /// If set to "NONE", this suppresses the printing of the label.
521 mutable std::string htmllabeltag_;
522 /// Attributes for the label. Defaults to: class="layoutname_label".
523 mutable std::string htmllabelattr_;
524 /// Whether to put the label before the item, or within the item.
525 /// I.e., do we have (true):
526 /// <label>...</label><item>...</item>
527 /// or instead (false):
528 /// <item><label>...</label>...</item>
529 /// The latter is the default.
530 bool htmllabelfirst_;
531 /// Is this to be output with the toc?
533 /// CSS information needed by this layout.
534 docstring htmlstyle_;
535 /// DocBook tag corresponding to this layout.
536 mutable std::string docbooktag_;
537 /// Roles to add to docbooktag_, if any (default: none).
538 mutable std::string docbookattr_;
539 /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
540 mutable std::string docbooktagtype_;
541 /// DocBook inner tag corresponding to this layout.
542 mutable std::string docbookinnertag_;
543 /// Roles to add to docbookinnertag_, if any (default: none).
544 mutable std::string docbookinnerattr_;
545 /// DocBook inner-tag type corresponding to this layout (block, paragraph, or inline; default: block).
546 mutable std::string docbookinnertagtype_;
547 /// DocBook tag corresponding to this item (mainly for lists).
548 mutable std::string docbookitemtag_;
549 /// Roles to add to docbookitemtag_, if any (default: none).
550 mutable std::string docbookitemattr_;
551 /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
552 mutable std::string docbookitemtagtype_;
553 /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
554 mutable std::string docbookitemwrappertag_;
555 /// Roles to add to docbookitemwrappertag_, if any (default: none).
556 mutable std::string docbookitemwrapperattr_;
557 /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
558 mutable std::string docbookitemwrappertagtype_;
559 /// DocBook tag corresponding to this label (mostly for description lists;
560 /// labels in the common sense do not exist with DocBook).
561 mutable std::string docbookitemlabeltag_;
562 /// Roles to add to docbooklabeltag_, if any (default: none).
563 mutable std::string docbookitemlabelattr_;
564 /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
565 mutable std::string docbookitemlabeltagtype_;
566 /// DocBook tag to add within the item, around its direct content (mainly for lists).
567 mutable std::string docbookiteminnertag_;
568 /// Roles to add to docbookiteminnertag_, if any (default: none).
569 mutable std::string docbookiteminnerattr_;
570 /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
571 mutable std::string docbookiteminnertagtype_;
572 /// DocBook tag corresponding to this wrapper around the main tag.
573 mutable std::string docbookwrappertag_;
574 /// Roles to add to docbookwrappertag_, if any (default: none).
575 mutable std::string docbookwrapperattr_;
576 /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
577 mutable std::string docbookwrappertagtype_;
578 /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
579 bool docbookwrappermergewithprevious_;
580 /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
581 /// (default: section).
582 mutable std::string docbooksectiontag_;
583 /// Whether this element should be considered as a section-level element in DocBook.
584 bool docbooksection_;
585 /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
586 mutable std::string docbookininfo_;
587 /// Whether this paragraph should be considered as abstract. Such paragraphs are output as a part of the document
588 /// abstract element (corresponding to the root tag).
589 bool docbookabstract_;
590 /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
591 /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
592 /// held by this attribute.
593 mutable std::string docbookforceabstracttag_;
594 /// Whether font tags are allowed inside this tag.
595 bool docbooknofontinside_ = false;
596 /// Whether LyX should create a title on its own, just after the wrapper tag. Typically, this parameter is required
597 /// because the wrapper tag requires a title (like a figure). The generated title will be similar to a LyXHTML label
598 /// (environment type and a number).
599 bool docbookgeneratetitle_ = false;
600 /// Should we generate the default CSS for this layout, even if HTMLStyle
601 /// has been given? Default is false.
602 /// Note that the default CSS is output first, then the user CSS, so it is
603 /// possible to override what one does not want.
605 /// A cache for the default style info so generated.
606 mutable docstring htmldefaultstyle_;
607 /// Any other info for the HTML header.
608 docstring htmlpreamble_;
609 /// Whether this is the <title> paragraph.
611 /// calculating this is expensive, so we cache it.
612 mutable std::string defaultcssclass_;
613 /// This is the `category' for this layout. The following are
614 /// recommended basic categories: FrontMatter, BackMatter, MainText,
615 /// Sectioning, Starred, List, Reasoning.
617 /// Macro definitions needed for this layout
619 /// Language dependent macro definitions needed for this layout
620 docstring langpreamble_;
621 /// Language and babel dependent macro definitions needed for this layout
622 docstring babelpreamble_;
623 /// Are adjacent paragraphs handled as one group?
625 /// Packages needed for this layout
626 std::set<std::string> required_;
627 /// Layouts that are by default nested after this one
628 std::set<docstring> autonests_;
629 /// Layouts that by auto-nest this one
630 std::set<docstring> autonested_by_;
632 LaTeXArgMap latexargs_;
634 LaTeXArgMap postcommandargs_;
636 LaTeXArgMap listpreamble_;
638 LaTeXArgMap itemargs_;
642 std::string toc_type_;
644 bool is_toc_caption_;