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 /// The arguments 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;
117 typedef std::map<std::string, latexarg> LaTeXArgMap;
119 LaTeXArgMap const & latexargs() const { return latexargs_; }
121 LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
123 LaTeXArgMap const & listpreamble() const { return listpreamble_; }
125 LaTeXArgMap const & itemargs() const { return itemargs_; }
126 /// Returns true is the layout has arguments. If false, then an
127 /// InsetArgument in this layout stands for the parent InsetText.
128 bool hasArgs() const;
129 /// Returns latexargs() + postcommandargs() + itemargs().
130 /// But note that it returns a *copy*, not a reference, so do not do
132 /// Layout::LaTeXArgMap::iterator it = args().begin();
133 /// Layout::LaTeXArgMap::iterator en = args().end();
134 /// Those are iterators for different containers.
135 LaTeXArgMap args() const;
139 int requiredArgs() const;
141 docstring const & labelstring(bool in_appendix) const
142 { return in_appendix ? labelstring_appendix_ : labelstring_; }
144 docstring const & endlabelstring() const { return endlabelstring_; }
146 docstring const & category() const { return category_; }
148 docstring const & preamble() const { return preamble_; }
149 /// Get language dependent macro definitions needed for this layout
150 /// for language \p lang
151 docstring const langpreamble() const { return langpreamble_; }
152 /// Get language and babel dependent macro definitions needed for
153 /// this layout for language \p lang
154 docstring const babelpreamble() const { return babelpreamble_; }
156 std::set<std::string> const & required() const { return required_; }
158 std::set<docstring> const & autonests() const { return autonests_; }
160 std::set<docstring> const & isAutonestedBy() const { return autonested_by_; }
162 std::string const & latexparam() const { return latexparam_; }
164 docstring leftdelim() const { return leftdelim_; }
166 docstring rightdelim() const { return rightdelim_; }
168 std::string const & innertag() const { return innertag_; }
170 std::string const & labeltag() const { return labeltag_; }
172 std::string const & itemtag() const { return itemtag_; }
174 std::string const & htmltag() const;
176 std::string const & htmlattr() const;
178 std::string const & htmlitemtag() const;
180 std::string const & htmlitemattr() const;
182 std::string const & htmllabeltag() const;
184 std::string const & htmllabelattr() const;
186 std::string defaultCSSClass() const;
188 bool htmllabelfirst() const { return htmllabelfirst_; }
190 docstring htmlstyle() const;
192 docstring const & htmlpreamble() const { return htmlpreamble_; }
194 bool htmltitle() const { return htmltitle_; }
196 std::string const & docbooktag() const;
198 std::string const & docbookattr() const;
200 std::string const & docbooktagtype() const;
202 std::string const & docbookinnertag() const;
204 std::string const & docbookinnerattr() const;
206 std::string const & docbookinnertagtype() const;
208 std::string const & docbookininfo() const;
210 bool docbookabstract() const { return docbookabstract_; }
212 std::string const & docbookwrappertag() const;
214 std::string const & docbookwrapperattr() const;
216 std::string const & docbookwrappertagtype() const;
218 bool docbookwrappermergewithprevious() const { return docbookwrappermergewithprevious_; }
220 std::string const & docbooksectiontag() const;
222 std::string const & docbookitemwrappertag() const;
224 std::string const & docbookitemwrapperattr() const;
226 std::string const & docbookitemwrappertagtype() const;
228 std::string const & docbookitemlabeltag() const;
230 std::string const & docbookitemlabelattr() const;
232 std::string const & docbookitemlabeltagtype() const;
234 std::string const & docbookiteminnertag() const;
236 std::string const & docbookiteminnerattr() const;
238 std::string const & docbookiteminnertagtype() const;
240 std::string const & docbookitemtag() const;
242 std::string const & docbookitemattr() const;
244 std::string const & docbookitemtagtype() const;
246 std::string const & docbookforceabstracttag() const;
248 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
250 bool isCommand() const { return latextype == LATEX_COMMAND; }
252 bool isEnvironment() const {
253 return latextype == LATEX_ENVIRONMENT
254 || latextype == LATEX_BIB_ENVIRONMENT
255 || latextype == LATEX_ITEM_ENVIRONMENT
256 || latextype == LATEX_LIST_ENVIRONMENT;
258 /// Is this the kind of layout in which adjacent paragraphs
259 /// are handled as one group?
260 bool isParagraphGroup() const { return par_group_; }
262 bool labelIsInline() const {
263 return labeltype == LABEL_STATIC
264 || labeltype == LABEL_SENSITIVE
265 || labeltype == LABEL_ENUMERATE
266 || labeltype == LABEL_ITEMIZE;
268 bool labelIsAbove() const {
269 return labeltype == LABEL_ABOVE
270 || labeltype == LABEL_CENTERED
271 || labeltype == LABEL_BIBLIO;
274 bool addToToc() const { return add_to_toc_; }
276 std::string tocType() const { return toc_type_; }
278 bool isTocCaption() const { return is_toc_caption_; }
281 bool operator==(Layout const &) const;
283 bool operator!=(Layout const & rhs) const
284 { return !(*this == rhs); }
286 ////////////////////////////////////////////////////////////////
288 ////////////////////////////////////////////////////////////////
289 /** Default font for this layout/environment.
290 The main font for this kind of environment. If an attribute has
291 INHERITED_*, it means that the value is specified by
292 the defaultfont for the entire layout. If we are nested, the
293 font is inherited from the font in the environment one level
294 up until the font is resolved. The values :IGNORE_*
295 and FONT_TOGGLE are illegal here.
299 /** Default font for labels.
300 Interpretation the same as for font above
304 /** Resolved version of the font for this layout/environment.
305 This is a resolved version the default font. The font is resolved
306 against the defaultfont of the entire layout.
310 /** Resolved version of the font used for labels.
311 This is a resolved version the label font. The font is resolved
312 against the defaultfont of the entire layout.
314 FontInfo reslabelfont;
316 /// Text that dictates how wide the left margin is on the screen
317 docstring leftmargin;
318 /// Text that dictates how wide the right margin is on the screen
319 docstring rightmargin;
320 /// Text that dictates how much space to leave after a potential label
322 /// Text that dictates how much space to leave before a potential label
323 docstring labelindent;
324 /// Text that dictates the width of the indentation of indented pars
335 double labelbottomsep;
343 LyXAlignment alignpossible;
347 EndLabelType endlabeltype;
349 MarginType margintype;
351 bool newline_allowed;
355 ToggleIndentation toggle_indent;
360 /// Individual chars to be passed verbatim
361 docstring pass_thru_chars;
363 bool parbreak_is_newline;
366 /// special value of toclevel for non-section layouts
367 static const int NOT_IN_TOC;
369 /** true when the fragile commands in the paragraph need to be
372 /** true when the verbatim stuff of this layout needs to be
375 /** true when specific commands in this paragraph need to be
376 protected in an \mbox. */
377 bool needmboxprotect;
378 /// true when empty paragraphs should be kept.
380 /// Type of LaTeX object
382 /// Does this object belong in the title part of the document?
384 /// Is the content to go in the preamble rather than the body?
386 /// Which counter to step
390 /// Step master counter?
391 bool stepmastercounter;
392 /// Prefix to use when creating labels
394 /// Depth of XML command
397 /// Return a pointer on a new layout suitable to describe a caption.
398 /// FIXME: remove this eventually. This is only for tex2lyx
399 /// until it has proper support for the caption inset (JMarc)
400 static Layout * forCaption();
402 /// Is this spellchecked?
405 * Should this layout definition always be written to the document preamble?
406 * Possible values are:
407 * 0: Do not enforce local layout
408 * >=1: Enforce local layout with version forcelocal
409 * -1: Enforce local layout with infinite version
410 * On reading, the forced local layout is only used if its version
411 * number is greater than the version number of the same layout in the
412 * document class. Otherwise, it is ignored.
418 /// Reads a layout definition from file
419 /// \return true on success.
420 bool readIgnoreForcelocal(Lexer &, TextClass const &, bool validating);
421 /// generates the default CSS for this layout
422 void makeDefaultCSS() const;
424 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
426 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
428 /// Name of the layout/paragraph environment
431 /// LaTeX name for environment
432 std::string latexname_;
434 /** Is this layout the default layout for an unknown layout? If
435 * so, its name will be displayed as xxx (unknown).
439 /** Name of an layout that has replaced this layout.
440 This is used to rename a layout, while keeping backward
443 docstring obsoleted_by_;
445 /** Name of an layout which preamble must come before this one
446 This is used when the preamble snippet uses macros defined in
449 docstring depends_on_;
451 /// Label string. "Abstract", "Reference", "Caption"...
452 docstring labelstring_;
454 docstring endlabelstring_;
455 /// Label string inside appendix. "Appendix", ...
456 docstring labelstring_appendix_;
457 /// LaTeX parameter for environment
458 std::string latexparam_;
459 /// Item command in lists
460 std::string itemcommand_;
461 /// Left delimiter of the content
462 docstring leftdelim_;
463 /// Right delimiter of the content
464 docstring rightdelim_;
465 /// Internal tag to use (e.g., <title></title> for sect header)
466 std::string innertag_;
467 /// Internal tag to use (e.g. to surround varentrylist label)
468 std::string labeltag_;
469 /// Internal tag to surround the item text in a list.
470 std::string itemtag_;
471 /// The interpretation of this tag varies depending upon the latextype.
472 /// In an environment, it is the tag enclosing all content for this set of
473 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
474 /// it would be: ul. (You get the idea.)
476 /// For a command, it is the tag enclosing the content of the command.
477 /// So, for section, it might be: h2.
479 /// For the paragraph type, it is the tag that will enclose each paragraph.
481 /// Defaults to "div".
482 mutable std::string htmltag_;
483 /// Additional attributes for inclusion with the start tag. Defaults
484 /// to: class="layoutname".
485 mutable std::string htmlattr_;
486 /// Tag for individual paragraphs in an environment. In lists, this
487 /// would be something like "li". But it also needs to be set for
488 /// quotation, e.g., since the paragraphs in a quote need to be
489 /// in "p" tags. Default is "div".
490 /// Note that when I said "environment", I meant it: This has no
491 /// effect for LATEX_PARAGRAPH type layouts.
492 mutable std::string htmlitemtag_;
493 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
494 mutable std::string htmlitemattr_;
495 /// Tag for labels, of whatever sort. One use for this is in setting
496 /// descriptions, in which case it would be: dt. Another use is to
497 /// customize the display of, say, the auto-generated label for
498 /// sections. Defaults to "span".
499 /// If set to "NONE", this suppresses the printing of the label.
500 mutable std::string htmllabeltag_;
501 /// Attributes for the label. Defaults to: class="layoutname_label".
502 mutable std::string htmllabelattr_;
503 /// Whether to put the label before the item, or within the item.
504 /// I.e., do we have (true):
505 /// <label>...</label><item>...</item>
506 /// or instead (false):
507 /// <item><label>...</label>...</item>
508 /// The latter is the default.
509 bool htmllabelfirst_;
510 /// CSS information needed by this layout.
511 docstring htmlstyle_;
512 /// DocBook tag corresponding to this layout.
513 mutable std::string docbooktag_;
514 /// Roles to add to docbooktag_, if any (default: none).
515 mutable std::string docbookattr_;
516 /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
517 mutable std::string docbooktagtype_;
518 /// DocBook inner tag corresponding to this layout.
519 mutable std::string docbookinnertag_;
520 /// Roles to add to docbookinnertag_, if any (default: none).
521 mutable std::string docbookinnerattr_;
522 /// DocBook inner-tag type corresponding to this layout (block, paragraph, or inline; default: block).
523 mutable std::string docbookinnertagtype_;
524 /// DocBook tag corresponding to this item (mainly for lists).
525 mutable std::string docbookitemtag_;
526 /// Roles to add to docbookitemtag_, if any (default: none).
527 mutable std::string docbookitemattr_;
528 /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
529 mutable std::string docbookitemtagtype_;
530 /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
531 mutable std::string docbookitemwrappertag_;
532 /// Roles to add to docbookitemwrappertag_, if any (default: none).
533 mutable std::string docbookitemwrapperattr_;
534 /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
535 mutable std::string docbookitemwrappertagtype_;
536 /// DocBook tag corresponding to this label (mostly for description lists;
537 /// labels in the common sense do not exist with DocBook).
538 mutable std::string docbookitemlabeltag_;
539 /// Roles to add to docbooklabeltag_, if any (default: none).
540 mutable std::string docbookitemlabelattr_;
541 /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
542 mutable std::string docbookitemlabeltagtype_;
543 /// DocBook tag to add within the item, around its direct content (mainly for lists).
544 mutable std::string docbookiteminnertag_;
545 /// Roles to add to docbookiteminnertag_, if any (default: none).
546 mutable std::string docbookiteminnerattr_;
547 /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
548 mutable std::string docbookiteminnertagtype_;
549 /// DocBook tag corresponding to this wrapper around the main tag.
550 mutable std::string docbookwrappertag_;
551 /// Roles to add to docbookwrappertag_, if any (default: none).
552 mutable std::string docbookwrapperattr_;
553 /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
554 mutable std::string docbookwrappertagtype_;
555 /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
556 bool docbookwrappermergewithprevious_;
557 /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
558 /// (default: section).
559 mutable std::string docbooksectiontag_;
560 /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
561 mutable std::string docbookininfo_;
562 /// Wehther this paragraph should be considered as abstract.
563 bool docbookabstract_;
564 /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
565 /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
566 /// held by this attribute
567 mutable std::string docbookforceabstracttag_;
568 /// Should we generate the default CSS for this layout, even if HTMLStyle
569 /// has been given? Default is false.
570 /// Note that the default CSS is output first, then the user CSS, so it is
571 /// possible to override what one does not want.
573 /// A cache for the default style info so generated.
574 mutable docstring htmldefaultstyle_;
575 /// Any other info for the HTML header.
576 docstring htmlpreamble_;
577 /// Whether this is the <title> paragraph.
579 /// calculating this is expensive, so we cache it.
580 mutable std::string defaultcssclass_;
581 /// This is the `category' for this layout. The following are
582 /// recommended basic categories: FrontMatter, BackMatter, MainText,
583 /// Sectioning, Starred, List, Reasoning.
585 /// Macro definitions needed for this layout
587 /// Language dependent macro definitions needed for this layout
588 docstring langpreamble_;
589 /// Language and babel dependent macro definitions needed for this layout
590 docstring babelpreamble_;
591 /// Are adjacent paragraphs handled as one group?
593 /// Packages needed for this layout
594 std::set<std::string> required_;
595 /// Layouts that are by default nested after this one
596 std::set<docstring> autonests_;
597 /// Layouts that by auto-nest this one
598 std::set<docstring> autonested_by_;
600 LaTeXArgMap latexargs_;
602 LaTeXArgMap postcommandargs_;
604 LaTeXArgMap listpreamble_;
606 LaTeXArgMap itemargs_;
610 std::string toc_type_;
612 bool is_toc_caption_;