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;
115 docstring docbooktag;
116 docstring docbooktagtype;
117 docstring docbookattr;
120 typedef std::map<std::string, latexarg> LaTeXArgMap;
122 LaTeXArgMap const & latexargs() const { return latexargs_; }
124 LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
126 LaTeXArgMap const & listpreamble() const { return listpreamble_; }
128 LaTeXArgMap const & itemargs() const { return itemargs_; }
129 /// Returns true is the layout has arguments. If false, then an
130 /// InsetArgument in this layout stands for the parent InsetText.
131 bool hasArgs() const;
132 /// Returns latexargs() + postcommandargs() + itemargs().
133 /// But note that it returns a *copy*, not a reference, so do not do
135 /// Layout::LaTeXArgMap::iterator it = args().begin();
136 /// Layout::LaTeXArgMap::iterator en = args().end();
137 /// Those are iterators for different containers.
138 LaTeXArgMap args() const;
142 int requiredArgs() const;
144 docstring const & labelstring(bool in_appendix) const
145 { return in_appendix ? labelstring_appendix_ : labelstring_; }
147 docstring const & endlabelstring() const { return endlabelstring_; }
149 docstring const & category() const { return category_; }
151 docstring const & preamble() const { return preamble_; }
152 /// Get language dependent macro definitions needed for this layout
153 /// for language \p lang
154 docstring const langpreamble() const { return langpreamble_; }
155 /// Get language and babel dependent macro definitions needed for
156 /// this layout for language \p lang
157 docstring const babelpreamble() const { return babelpreamble_; }
159 std::set<std::string> const & required() const { return required_; }
161 std::set<docstring> const & autonests() const { return autonests_; }
163 std::set<docstring> const & isAutonestedBy() const { return autonested_by_; }
165 std::string const & latexparam() const { return latexparam_; }
167 docstring leftdelim() const { return leftdelim_; }
169 docstring rightdelim() const { return rightdelim_; }
171 std::string const & innertag() const { return innertag_; }
173 std::string const & labeltag() const { return labeltag_; }
175 std::string const & itemtag() const { return itemtag_; }
177 std::string const & htmltag() const;
179 std::string const & htmlattr() const;
181 std::string const & htmlitemtag() const;
183 std::string const & htmlitemattr() const;
185 std::string const & htmllabeltag() const;
187 std::string const & htmllabelattr() const;
189 std::string defaultCSSClass() const;
191 bool htmllabelfirst() const { return htmllabelfirst_; }
193 docstring htmlstyle() const;
195 docstring const & htmlpreamble() const { return htmlpreamble_; }
197 bool htmltitle() const { return htmltitle_; }
199 std::string const & docbooktag() const;
201 std::string const & docbookattr() const;
203 std::string const & docbooktagtype() const;
205 std::string const & docbookinnertag() const;
207 std::string const & docbookinnerattr() const;
209 std::string const & docbookinnertagtype() const;
211 std::string const & docbookininfo() const;
213 bool docbookabstract() const { return docbookabstract_; }
215 std::string const & docbookwrappertag() const;
217 std::string const & docbookwrapperattr() const;
219 std::string const & docbookwrappertagtype() const;
221 bool docbookwrappermergewithprevious() const { return docbookwrappermergewithprevious_; }
223 std::string const & docbooksectiontag() const;
225 bool docbooksection() const { return docbooksection_; }
227 std::string const & docbookitemwrappertag() const;
229 std::string const & docbookitemwrapperattr() const;
231 std::string const & docbookitemwrappertagtype() const;
233 std::string const & docbookitemlabeltag() const;
235 std::string const & docbookitemlabelattr() const;
237 std::string const & docbookitemlabeltagtype() const;
239 std::string const & docbookiteminnertag() const;
241 std::string const & docbookiteminnerattr() const;
243 std::string const & docbookiteminnertagtype() const;
245 std::string const & docbookitemtag() const;
247 std::string const & docbookitemattr() const;
249 std::string const & docbookitemtagtype() const;
251 std::string const & docbookforceabstracttag() const;
253 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
255 bool isCommand() const { return latextype == LATEX_COMMAND; }
257 bool isEnvironment() const {
258 return latextype == LATEX_ENVIRONMENT
259 || latextype == LATEX_BIB_ENVIRONMENT
260 || latextype == LATEX_ITEM_ENVIRONMENT
261 || latextype == LATEX_LIST_ENVIRONMENT;
263 /// Is this the kind of layout in which adjacent paragraphs
264 /// are handled as one group?
265 bool isParagraphGroup() const { return par_group_; }
267 bool labelIsInline() const {
268 return labeltype == LABEL_STATIC
269 || labeltype == LABEL_SENSITIVE
270 || labeltype == LABEL_ENUMERATE
271 || labeltype == LABEL_ITEMIZE;
273 bool labelIsAbove() const {
274 return labeltype == LABEL_ABOVE
275 || labeltype == LABEL_CENTERED
276 || labeltype == LABEL_BIBLIO;
279 bool addToToc() const { return add_to_toc_; }
281 std::string tocType() const { return toc_type_; }
283 bool isTocCaption() const { return is_toc_caption_; }
286 bool operator==(Layout const &) const;
288 bool operator!=(Layout const & rhs) const
289 { return !(*this == rhs); }
291 ////////////////////////////////////////////////////////////////
293 ////////////////////////////////////////////////////////////////
294 /** Default font for this layout/environment.
295 The main font for this kind of environment. If an attribute has
296 INHERITED_*, it means that the value is specified by
297 the defaultfont for the entire layout. If we are nested, the
298 font is inherited from the font in the environment one level
299 up until the font is resolved. The values :IGNORE_*
300 and FONT_TOGGLE are illegal here.
304 /** Default font for labels.
305 Interpretation the same as for font above
309 /** Resolved version of the font for this layout/environment.
310 This is a resolved version the default font. The font is resolved
311 against the defaultfont of the entire layout.
315 /** Resolved version of the font used for labels.
316 This is a resolved version the label font. The font is resolved
317 against the defaultfont of the entire layout.
319 FontInfo reslabelfont;
321 /// Text that dictates how wide the left margin is on the screen
322 docstring leftmargin;
323 /// Text that dictates how wide the right margin is on the screen
324 docstring rightmargin;
325 /// Text that dictates how much space to leave after a potential label
327 /// Text that dictates how much space to leave before a potential label
328 docstring labelindent;
329 /// Text that dictates the width of the indentation of indented pars
340 double labelbottomsep;
348 LyXAlignment alignpossible;
352 EndLabelType endlabeltype;
354 MarginType margintype;
356 bool newline_allowed;
360 ToggleIndentation toggle_indent;
365 /// Individual chars to be passed verbatim
366 docstring pass_thru_chars;
368 bool parbreak_is_newline;
371 /// special value of toclevel for non-section layouts
372 static const int NOT_IN_TOC;
374 /** true when the fragile commands in the paragraph need to be
377 /** true when the verbatim stuff of this layout needs to be
380 /** true when specific commands in this paragraph need to be
381 protected in an \mbox. */
382 bool needmboxprotect;
383 /// true when empty paragraphs should be kept.
385 /// Type of LaTeX object
387 /// Does this object belong in the title part of the document?
389 /// Is the content to go in the preamble rather than the body?
391 /// Which counter to step
395 /// Step parent counter?
396 bool stepparentcounter;
397 /// Prefix to use when creating labels
399 /// Depth of XML command
402 /// Return a pointer on a new layout suitable to describe a caption.
403 /// FIXME: remove this eventually. This is only for tex2lyx
404 /// until it has proper support for the caption inset (JMarc)
405 static Layout * forCaption();
407 /// Is this spellchecked?
410 * Should this layout definition always be written to the document preamble?
411 * Possible values are:
412 * 0: Do not enforce local layout
413 * >=1: Enforce local layout with version forcelocal
414 * -1: Enforce local layout with infinite version
415 * On reading, the forced local layout is only used if its version
416 * number is greater than the version number of the same layout in the
417 * document class. Otherwise, it is ignored.
423 /// Reads a layout definition from file
424 /// \return true on success.
425 bool readIgnoreForcelocal(Lexer &, TextClass const &, bool validating);
426 /// generates the default CSS for this layout
427 void makeDefaultCSS() const;
429 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
431 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
433 /// Name of the layout/paragraph environment
436 /// LaTeX name for environment
437 std::string latexname_;
439 /** Is this layout the default layout for an unknown layout? If
440 * so, its name will be displayed as xxx (unknown).
444 /** Name of an layout that has replaced this layout.
445 This is used to rename a layout, while keeping backward
448 docstring obsoleted_by_;
450 /** Name of an layout which preamble must come before this one
451 This is used when the preamble snippet uses macros defined in
454 docstring depends_on_;
456 /// Label string. "Abstract", "Reference", "Caption"...
457 docstring labelstring_;
459 docstring endlabelstring_;
460 /// Label string inside appendix. "Appendix", ...
461 docstring labelstring_appendix_;
462 /// LaTeX parameter for environment
463 std::string latexparam_;
464 /// Item command in lists
465 std::string itemcommand_;
466 /// Left delimiter of the content
467 docstring leftdelim_;
468 /// Right delimiter of the content
469 docstring rightdelim_;
470 /// Internal tag to use (e.g., <title></title> for sect header)
471 std::string innertag_;
472 /// Internal tag to use (e.g. to surround varentrylist label)
473 std::string labeltag_;
474 /// Internal tag to surround the item text in a list.
475 std::string itemtag_;
476 /// The interpretation of this tag varies depending upon the latextype.
477 /// In an environment, it is the tag enclosing all content for this set of
478 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
479 /// it would be: ul. (You get the idea.)
481 /// For a command, it is the tag enclosing the content of the command.
482 /// So, for section, it might be: h2.
484 /// For the paragraph type, it is the tag that will enclose each paragraph.
486 /// Defaults to "div".
487 mutable std::string htmltag_;
488 /// Additional attributes for inclusion with the start tag. Defaults
489 /// to: class="layoutname".
490 mutable std::string htmlattr_;
491 /// Tag for individual paragraphs in an environment. In lists, this
492 /// would be something like "li". But it also needs to be set for
493 /// quotation, e.g., since the paragraphs in a quote need to be
494 /// in "p" tags. Default is "div".
495 /// Note that when I said "environment", I meant it: This has no
496 /// effect for LATEX_PARAGRAPH type layouts.
497 mutable std::string htmlitemtag_;
498 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
499 mutable std::string htmlitemattr_;
500 /// Tag for labels, of whatever sort. One use for this is in setting
501 /// descriptions, in which case it would be: dt. Another use is to
502 /// customize the display of, say, the auto-generated label for
503 /// sections. Defaults to "span".
504 /// If set to "NONE", this suppresses the printing of the label.
505 mutable std::string htmllabeltag_;
506 /// Attributes for the label. Defaults to: class="layoutname_label".
507 mutable std::string htmllabelattr_;
508 /// Whether to put the label before the item, or within the item.
509 /// I.e., do we have (true):
510 /// <label>...</label><item>...</item>
511 /// or instead (false):
512 /// <item><label>...</label>...</item>
513 /// The latter is the default.
514 bool htmllabelfirst_;
515 /// CSS information needed by this layout.
516 docstring htmlstyle_;
517 /// DocBook tag corresponding to this layout.
518 mutable std::string docbooktag_;
519 /// Roles to add to docbooktag_, if any (default: none).
520 mutable std::string docbookattr_;
521 /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
522 mutable std::string docbooktagtype_;
523 /// DocBook inner tag corresponding to this layout.
524 mutable std::string docbookinnertag_;
525 /// Roles to add to docbookinnertag_, if any (default: none).
526 mutable std::string docbookinnerattr_;
527 /// DocBook inner-tag type corresponding to this layout (block, paragraph, or inline; default: block).
528 mutable std::string docbookinnertagtype_;
529 /// DocBook tag corresponding to this item (mainly for lists).
530 mutable std::string docbookitemtag_;
531 /// Roles to add to docbookitemtag_, if any (default: none).
532 mutable std::string docbookitemattr_;
533 /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
534 mutable std::string docbookitemtagtype_;
535 /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
536 mutable std::string docbookitemwrappertag_;
537 /// Roles to add to docbookitemwrappertag_, if any (default: none).
538 mutable std::string docbookitemwrapperattr_;
539 /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
540 mutable std::string docbookitemwrappertagtype_;
541 /// DocBook tag corresponding to this label (mostly for description lists;
542 /// labels in the common sense do not exist with DocBook).
543 mutable std::string docbookitemlabeltag_;
544 /// Roles to add to docbooklabeltag_, if any (default: none).
545 mutable std::string docbookitemlabelattr_;
546 /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
547 mutable std::string docbookitemlabeltagtype_;
548 /// DocBook tag to add within the item, around its direct content (mainly for lists).
549 mutable std::string docbookiteminnertag_;
550 /// Roles to add to docbookiteminnertag_, if any (default: none).
551 mutable std::string docbookiteminnerattr_;
552 /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
553 mutable std::string docbookiteminnertagtype_;
554 /// DocBook tag corresponding to this wrapper around the main tag.
555 mutable std::string docbookwrappertag_;
556 /// Roles to add to docbookwrappertag_, if any (default: none).
557 mutable std::string docbookwrapperattr_;
558 /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
559 mutable std::string docbookwrappertagtype_;
560 /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
561 bool docbookwrappermergewithprevious_;
562 /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
563 /// (default: section).
564 mutable std::string docbooksectiontag_;
565 /// Whether this element should be considered as a section-level element in DocBook.
566 bool docbooksection_;
567 /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
568 mutable std::string docbookininfo_;
569 /// Wehther this paragraph should be considered as abstract.
570 bool docbookabstract_;
571 /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
572 /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
573 /// held by this attribute
574 mutable std::string docbookforceabstracttag_;
575 /// Should we generate the default CSS for this layout, even if HTMLStyle
576 /// has been given? Default is false.
577 /// Note that the default CSS is output first, then the user CSS, so it is
578 /// possible to override what one does not want.
580 /// A cache for the default style info so generated.
581 mutable docstring htmldefaultstyle_;
582 /// Any other info for the HTML header.
583 docstring htmlpreamble_;
584 /// Whether this is the <title> paragraph.
586 /// calculating this is expensive, so we cache it.
587 mutable std::string defaultcssclass_;
588 /// This is the `category' for this layout. The following are
589 /// recommended basic categories: FrontMatter, BackMatter, MainText,
590 /// Sectioning, Starred, List, Reasoning.
592 /// Macro definitions needed for this layout
594 /// Language dependent macro definitions needed for this layout
595 docstring langpreamble_;
596 /// Language and babel dependent macro definitions needed for this layout
597 docstring babelpreamble_;
598 /// Are adjacent paragraphs handled as one group?
600 /// Packages needed for this layout
601 std::set<std::string> required_;
602 /// Layouts that are by default nested after this one
603 std::set<docstring> autonests_;
604 /// Layouts that by auto-nest this one
605 std::set<docstring> autonested_by_;
607 LaTeXArgMap latexargs_;
609 LaTeXArgMap postcommandargs_;
611 LaTeXArgMap listpreamble_;
613 LaTeXArgMap itemargs_;
617 std::string toc_type_;
619 bool is_toc_caption_;