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 &);
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 &);
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;
100 docstring defaultarg;
103 std::string requires;
104 std::string decoration;
109 ArgPassThru passthru;
110 docstring pass_thru_chars;
112 std::string newlinecmd;
115 typedef std::map<std::string, latexarg> LaTeXArgMap;
117 LaTeXArgMap const & latexargs() const { return latexargs_; }
119 LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
121 LaTeXArgMap const & listpreamble() const { return listpreamble_; }
123 LaTeXArgMap const & itemargs() const { return itemargs_; }
124 /// Returns true is the layout has arguments. If false, then an
125 /// InsetArgument in this layout stands for the parent InsetText.
126 bool hasArgs() const;
127 /// Returns latexargs() + postcommandargs() + itemargs().
128 /// But note that it returns a *copy*, not a reference, so do not do
130 /// Layout::LaTeXArgMap::iterator it = args().begin();
131 /// Layout::LaTeXArgMap::iterator en = args().end();
132 /// Those are iterators for different containers.
133 LaTeXArgMap args() const;
137 int requiredArgs() const;
139 docstring const & labelstring(bool in_appendix) const
140 { return in_appendix ? labelstring_appendix_ : labelstring_; }
142 docstring const & endlabelstring() const { return endlabelstring_; }
144 docstring const & category() const { return category_; }
146 docstring const & preamble() const { return preamble_; }
147 /// Get language dependent macro definitions needed for this layout
148 /// for language \p lang
149 docstring const langpreamble() const { return langpreamble_; }
150 /// Get language and babel dependent macro definitions needed for
151 /// this layout for language \p lang
152 docstring const babelpreamble() const { return babelpreamble_; }
154 std::set<std::string> const & requires() const { return requires_; }
156 std::set<docstring> const & autonests() const { return autonests_; }
158 std::set<docstring> const & isAutonestedBy() const { return autonested_by_; }
160 std::string const & latexparam() const { return latexparam_; }
162 docstring leftdelim() const { return leftdelim_; }
164 docstring rightdelim() const { return rightdelim_; }
166 std::string const & innertag() const { return innertag_; }
168 std::string const & labeltag() const { return labeltag_; }
170 std::string const & itemtag() const { return itemtag_; }
172 std::string const & htmltag() const;
174 std::string const & htmlattr() const;
176 std::string const & htmlitemtag() const;
178 std::string const & htmlitemattr() const;
180 std::string const & htmllabeltag() const;
182 std::string const & htmllabelattr() const;
184 std::string defaultCSSClass() const;
186 bool htmllabelfirst() const { return htmllabelfirst_; }
188 docstring htmlstyle() const;
190 docstring const & htmlpreamble() const { return htmlpreamble_; }
192 bool htmltitle() const { return htmltitle_; }
194 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
196 bool isCommand() const { return latextype == LATEX_COMMAND; }
198 bool isEnvironment() const {
199 return latextype == LATEX_ENVIRONMENT
200 || latextype == LATEX_BIB_ENVIRONMENT
201 || latextype == LATEX_ITEM_ENVIRONMENT
202 || latextype == LATEX_LIST_ENVIRONMENT;
204 /// Is this the kind of layout in which adjacent paragraphs
205 /// are handled as one group?
206 bool isParagraphGroup() const { return par_group_; }
208 bool labelIsInline() const {
209 return labeltype == LABEL_STATIC
210 || labeltype == LABEL_SENSITIVE
211 || labeltype == LABEL_ENUMERATE
212 || labeltype == LABEL_ITEMIZE;
214 bool labelIsAbove() const {
215 return labeltype == LABEL_ABOVE
216 || labeltype == LABEL_CENTERED
217 || labeltype == LABEL_BIBLIO;
220 bool addToToc() const { return add_to_toc_; }
222 std::string tocType() const { return toc_type_; }
224 bool isTocCaption() const { return is_toc_caption_; }
227 bool operator==(Layout const &) const;
229 bool operator!=(Layout const & rhs) const
230 { return !(*this == rhs); }
232 ////////////////////////////////////////////////////////////////
234 ////////////////////////////////////////////////////////////////
235 /** Default font for this layout/environment.
236 The main font for this kind of environment. If an attribute has
237 INHERITED_*, it means that the value is specified by
238 the defaultfont for the entire layout. If we are nested, the
239 font is inherited from the font in the environment one level
240 up until the font is resolved. The values :IGNORE_*
241 and FONT_TOGGLE are illegal here.
245 /** Default font for labels.
246 Interpretation the same as for font above
250 /** Resolved version of the font for this layout/environment.
251 This is a resolved version the default font. The font is resolved
252 against the defaultfont of the entire layout.
256 /** Resolved version of the font used for labels.
257 This is a resolved version the label font. The font is resolved
258 against the defaultfont of the entire layout.
260 FontInfo reslabelfont;
262 /// Text that dictates how wide the left margin is on the screen
263 docstring leftmargin;
264 /// Text that dictates how wide the right margin is on the screen
265 docstring rightmargin;
266 /// Text that dictates how much space to leave after a potential label
268 /// Text that dictates how much space to leave before a potential label
269 docstring labelindent;
270 /// Text that dictates the width of the indentation of indented pars
281 double labelbottomsep;
289 LyXAlignment alignpossible;
293 EndLabelType endlabeltype;
295 MarginType margintype;
297 bool newline_allowed;
301 ToggleIndentation toggle_indent;
306 /// Individual chars to be passed verbatim
307 docstring pass_thru_chars;
309 bool parbreak_is_newline;
312 /// special value of toclevel for non-section layouts
313 static const int NOT_IN_TOC;
315 /** true when the fragile commands in the paragraph need to be
318 /** true when the verbatim stuff of this layout needs to be
321 /** true when specific commands in this paragraph need to be
322 protected in an \mbox. */
323 bool needmboxprotect;
324 /// true when empty paragraphs should be kept.
326 /// Type of LaTeX object
328 /// Does this object belong in the title part of the document?
330 /// Is the content to go in the preamble rather than the body?
332 /// Which counter to step
336 /// Step master counter?
337 bool stepmastercounter;
338 /// Prefix to use when creating labels
340 /// Depth of XML command
343 /// Return a pointer on a new layout suitable to describe a caption.
344 /// FIXME: remove this eventually. This is only for tex2lyx
345 /// until it has proper support for the caption inset (JMarc)
346 static Layout * forCaption();
348 /// Is this spellchecked?
351 * Should this layout definition always be written to the document preamble?
352 * Possible values are:
353 * 0: Do not enforce local layout
354 * >=1: Enforce local layout with version forcelocal
355 * -1: Enforce local layout with infinite version
356 * On reading, the forced local layout is only used if its version
357 * number is greater than the version number of the same layout in the
358 * document class. Otherwise, it is ignored.
364 /// Reads a layout definition from file
365 /// \return true on success.
366 bool readIgnoreForcelocal(Lexer &, TextClass const &);
367 /// generates the default CSS for this layout
368 void makeDefaultCSS() const;
370 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
372 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
374 /// Name of the layout/paragraph environment
377 /// LaTeX name for environment
378 std::string latexname_;
380 /** Is this layout the default layout for an unknown layout? If
381 * so, its name will be displayed as xxx (unknown).
385 /** Name of an layout that has replaced this layout.
386 This is used to rename a layout, while keeping backward
389 docstring obsoleted_by_;
391 /** Name of an layout which preamble must come before this one
392 This is used when the preamble snippet uses macros defined in
395 docstring depends_on_;
397 /// Label string. "Abstract", "Reference", "Caption"...
398 docstring labelstring_;
400 docstring endlabelstring_;
401 /// Label string inside appendix. "Appendix", ...
402 docstring labelstring_appendix_;
403 /// LaTeX parameter for environment
404 std::string latexparam_;
405 /// Item command in lists
406 std::string itemcommand_;
407 /// Left delimiter of the content
408 docstring leftdelim_;
409 /// Right delimiter of the content
410 docstring rightdelim_;
411 /// Internal tag to use (e.g., <title></title> for sect header)
412 std::string innertag_;
413 /// Internal tag to use (e.g. to surround varentrylist label)
414 std::string labeltag_;
415 /// Internal tag to surround the item text in a list.
416 std::string itemtag_;
417 /// The interpretation of this tag varies depending upon the latextype.
418 /// In an environment, it is the tag enclosing all content for this set of
419 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
420 /// it would be: ul. (You get the idea.)
422 /// For a command, it is the tag enclosing the content of the command.
423 /// So, for section, it might be: h2.
425 /// For the paragraph type, it is the tag that will enclose each paragraph.
427 /// Defaults to "div".
428 mutable std::string htmltag_;
429 /// Additional attributes for inclusion with the start tag. Defaults
430 /// to: class="layoutname".
431 mutable std::string htmlattr_;
432 /// Tag for individual paragraphs in an environment. In lists, this
433 /// would be something like "li". But it also needs to be set for
434 /// quotation, e.g., since the paragraphs in a quote need to be
435 /// in "p" tags. Default is "div".
436 /// Note that when I said "environment", I meant it: This has no
437 /// effect for LATEX_PARAGRAPH type layouts.
438 mutable std::string htmlitemtag_;
439 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
440 mutable std::string htmlitemattr_;
441 /// Tag for labels, of whatever sort. One use for this is in setting
442 /// descriptions, in which case it would be: dt. Another use is to
443 /// customize the display of, say, the auto-generated label for
444 /// sections. Defaults to "span".
445 /// If set to "NONE", this suppresses the printing of the label.
446 mutable std::string htmllabeltag_;
447 /// Attributes for the label. Defaults to: class="layoutname_label".
448 mutable std::string htmllabelattr_;
449 /// Whether to put the label before the item, or within the item.
450 /// I.e., do we have (true):
451 /// <label>...</label><item>...</item>
452 /// or instead (false):
453 /// <item><label>...</label>...</item>
454 /// The latter is the default.
455 bool htmllabelfirst_;
456 /// CSS information needed by this layout.
457 docstring htmlstyle_;
458 /// Should we generate the default CSS for this layout, even if HTMLStyle
459 /// has been given? Default is false.
460 /// Note that the default CSS is output first, then the user CSS, so it is
461 /// possible to override what one does not want.
463 /// A cache for the default style info so generated.
464 mutable docstring htmldefaultstyle_;
465 /// Any other info for the HTML header.
466 docstring htmlpreamble_;
467 /// Whether this is the <title> paragraph.
469 /// calculating this is expensive, so we cache it.
470 mutable std::string defaultcssclass_;
471 /// This is the `category' for this layout. The following are
472 /// recommended basic categories: FrontMatter, BackMatter, MainText,
473 /// Sectioning, Starred, List, Reasoning.
475 /// Macro definitions needed for this layout
477 /// Language dependent macro definitions needed for this layout
478 docstring langpreamble_;
479 /// Language and babel dependent macro definitions needed for this layout
480 docstring babelpreamble_;
481 /// Are adjacent paragraphs handled as one group?
483 /// Packages needed for this layout
484 std::set<std::string> requires_;
485 /// Layouts that are by default nested after this one
486 std::set<docstring> autonests_;
487 /// Layouts that by auto-nest this one
488 std::set<docstring> autonested_by_;
490 LaTeXArgMap latexargs_;
492 LaTeXArgMap postcommandargs_;
494 LaTeXArgMap listpreamble_;
496 LaTeXArgMap itemargs_;
500 std::string toc_type_;
502 bool is_toc_caption_;