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;
114 typedef std::map<std::string, latexarg> LaTeXArgMap;
116 LaTeXArgMap const & latexargs() const { return latexargs_; }
118 LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
120 LaTeXArgMap const & listpreamble() const { return listpreamble_; }
122 LaTeXArgMap const & itemargs() const { return itemargs_; }
123 /// Returns true is the layout has arguments. If false, then an
124 /// InsetArgument in this layout stands for the parent InsetText.
125 bool hasArgs() const;
126 /// Returns latexargs() + postcommandargs() + itemargs().
127 /// But note that it returns a *copy*, not a reference, so do not do
129 /// Layout::LaTeXArgMap::iterator it = args().begin();
130 /// Layout::LaTeXArgMap::iterator en = args().end();
131 /// Those are iterators for different containers.
132 LaTeXArgMap args() const;
136 int requiredArgs() const;
138 docstring const & labelstring(bool in_appendix) const
139 { return in_appendix ? labelstring_appendix_ : labelstring_; }
141 docstring const & endlabelstring() const { return endlabelstring_; }
143 docstring const & category() const { return category_; }
145 docstring const & preamble() const { return preamble_; }
146 /// Get language dependent macro definitions needed for this layout
147 /// for language \p lang
148 docstring const langpreamble() const { return langpreamble_; }
149 /// Get language and babel dependent macro definitions needed for
150 /// this layout for language \p lang
151 docstring const babelpreamble() const { return babelpreamble_; }
153 std::set<std::string> const & requires() const { return requires_; }
155 std::set<docstring> const & autonests() const { return autonests_; }
157 std::set<docstring> const & isAutonestedBy() const { return autonested_by_; }
159 std::string const & latexparam() const { return latexparam_; }
161 docstring leftdelim() const { return leftdelim_; }
163 docstring rightdelim() const { return rightdelim_; }
165 std::string const & innertag() const { return innertag_; }
167 std::string const & labeltag() const { return labeltag_; }
169 std::string const & itemtag() const { return itemtag_; }
171 std::string const & htmltag() const;
173 std::string const & htmlattr() const;
175 std::string const & htmlitemtag() const;
177 std::string const & htmlitemattr() const;
179 std::string const & htmllabeltag() const;
181 std::string const & htmllabelattr() const;
183 std::string defaultCSSClass() const;
185 bool htmllabelfirst() const { return htmllabelfirst_; }
187 docstring htmlstyle() const;
189 docstring const & htmlpreamble() const { return htmlpreamble_; }
191 bool htmltitle() const { return htmltitle_; }
193 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
195 bool isCommand() const { return latextype == LATEX_COMMAND; }
197 bool isEnvironment() const {
198 return latextype == LATEX_ENVIRONMENT
199 || latextype == LATEX_BIB_ENVIRONMENT
200 || latextype == LATEX_ITEM_ENVIRONMENT
201 || latextype == LATEX_LIST_ENVIRONMENT;
203 /// Is this the kind of layout in which adjacent paragraphs
204 /// are handled as one group?
205 bool isParagraphGroup() const { return par_group_; }
207 bool labelIsInline() const {
208 return labeltype == LABEL_STATIC
209 || labeltype == LABEL_SENSITIVE
210 || labeltype == LABEL_ENUMERATE
211 || labeltype == LABEL_ITEMIZE;
213 bool labelIsAbove() const {
214 return labeltype == LABEL_ABOVE
215 || labeltype == LABEL_CENTERED
216 || labeltype == LABEL_BIBLIO;
219 bool addToToc() const { return add_to_toc_; }
221 std::string tocType() const { return toc_type_; }
223 bool isTocCaption() const { return is_toc_caption_; }
226 bool operator==(Layout const &) const;
228 bool operator!=(Layout const & rhs) const
229 { return !(*this == rhs); }
231 ////////////////////////////////////////////////////////////////
233 ////////////////////////////////////////////////////////////////
234 /** Default font for this layout/environment.
235 The main font for this kind of environment. If an attribute has
236 INHERITED_*, it means that the value is specified by
237 the defaultfont for the entire layout. If we are nested, the
238 font is inherited from the font in the environment one level
239 up until the font is resolved. The values :IGNORE_*
240 and FONT_TOGGLE are illegal here.
244 /** Default font for labels.
245 Interpretation the same as for font above
249 /** Resolved version of the font for this layout/environment.
250 This is a resolved version the default font. The font is resolved
251 against the defaultfont of the entire layout.
255 /** Resolved version of the font used for labels.
256 This is a resolved version the label font. The font is resolved
257 against the defaultfont of the entire layout.
259 FontInfo reslabelfont;
261 /// Text that dictates how wide the left margin is on the screen
262 docstring leftmargin;
263 /// Text that dictates how wide the right margin is on the screen
264 docstring rightmargin;
265 /// Text that dictates how much space to leave after a potential label
267 /// Text that dictates how much space to leave before a potential label
268 docstring labelindent;
269 /// Text that dictates the width of the indentation of indented pars
280 double labelbottomsep;
288 LyXAlignment alignpossible;
292 EndLabelType endlabeltype;
294 MarginType margintype;
296 bool newline_allowed;
300 ToggleIndentation toggle_indent;
305 /// Individual chars to be passed verbatim
306 docstring pass_thru_chars;
308 bool parbreak_is_newline;
311 /// special value of toclevel for non-section layouts
312 static const int NOT_IN_TOC;
314 /** true when the fragile commands in the paragraph need to be
317 /** true when the verbatim stuff of this layout needs to be
320 /// true when empty paragraphs should be kept.
322 /// Type of LaTeX object
324 /// Does this object belong in the title part of the document?
326 /// Is the content to go in the preamble rather than the body?
328 /// Which counter to step
332 /// Step master counter?
333 bool stepmastercounter;
334 /// Prefix to use when creating labels
336 /// Depth of XML command
339 /// Return a pointer on a new layout suitable to describe a caption.
340 /// FIXME: remove this eventually. This is only for tex2lyx
341 /// until it has proper support for the caption inset (JMarc)
342 static Layout * forCaption();
344 /// Is this spellchecked?
347 * Should this layout definition always be written to the document preamble?
348 * Possible values are:
349 * 0: Do not enforce local layout
350 * >=1: Enforce local layout with version forcelocal
351 * -1: Enforce local layout with infinite version
352 * On reading, the forced local layout is only used if its version
353 * number is greater than the version number of the same layout in the
354 * document class. Otherwise, it is ignored.
360 /// Reads a layout definition from file
361 /// \return true on success.
362 bool readIgnoreForcelocal(Lexer &, TextClass const &);
363 /// generates the default CSS for this layout
364 void makeDefaultCSS() const;
366 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
368 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
370 /// Name of the layout/paragraph environment
373 /// LaTeX name for environment
374 std::string latexname_;
376 /** Is this layout the default layout for an unknown layout? If
377 * so, its name will be displayed as xxx (unknown).
381 /** Name of an layout that has replaced this layout.
382 This is used to rename a layout, while keeping backward
385 docstring obsoleted_by_;
387 /** Name of an layout which preamble must come before this one
388 This is used when the preamble snippet uses macros defined in
391 docstring depends_on_;
393 /// Label string. "Abstract", "Reference", "Caption"...
394 docstring labelstring_;
396 docstring endlabelstring_;
397 /// Label string inside appendix. "Appendix", ...
398 docstring labelstring_appendix_;
399 /// LaTeX parameter for environment
400 std::string latexparam_;
401 /// Item command in lists
402 std::string itemcommand_;
403 /// Left delimiter of the content
404 docstring leftdelim_;
405 /// Right delimiter of the content
406 docstring rightdelim_;
407 /// Internal tag to use (e.g., <title></title> for sect header)
408 std::string innertag_;
409 /// Internal tag to use (e.g. to surround varentrylist label)
410 std::string labeltag_;
411 /// Internal tag to surround the item text in a list.
412 std::string itemtag_;
413 /// The interpretation of this tag varies depending upon the latextype.
414 /// In an environment, it is the tag enclosing all content for this set of
415 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
416 /// it would be: ul. (You get the idea.)
418 /// For a command, it is the tag enclosing the content of the command.
419 /// So, for section, it might be: h2.
421 /// For the paragraph type, it is the tag that will enclose each paragraph.
423 /// Defaults to "div".
424 mutable std::string htmltag_;
425 /// Additional attributes for inclusion with the start tag. Defaults
426 /// to: class="layoutname".
427 mutable std::string htmlattr_;
428 /// Tag for individual paragraphs in an environment. In lists, this
429 /// would be something like "li". But it also needs to be set for
430 /// quotation, e.g., since the paragraphs in a quote need to be
431 /// in "p" tags. Default is "div".
432 /// Note that when I said "environment", I meant it: This has no
433 /// effect for LATEX_PARAGRAPH type layouts.
434 mutable std::string htmlitemtag_;
435 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
436 mutable std::string htmlitemattr_;
437 /// Tag for labels, of whatever sort. One use for this is in setting
438 /// descriptions, in which case it would be: dt. Another use is to
439 /// customize the display of, say, the auto-generated label for
440 /// sections. Defaults to "span".
441 /// If set to "NONE", this suppresses the printing of the label.
442 mutable std::string htmllabeltag_;
443 /// Attributes for the label. Defaults to: class="layoutname_label".
444 mutable std::string htmllabelattr_;
445 /// Whether to put the label before the item, or within the item.
446 /// I.e., do we have (true):
447 /// <label>...</label><item>...</item>
448 /// or instead (false):
449 /// <item><label>...</label>...</item>
450 /// The latter is the default.
451 bool htmllabelfirst_;
452 /// CSS information needed by this layout.
453 docstring htmlstyle_;
454 /// Should we generate the default CSS for this layout, even if HTMLStyle
455 /// has been given? Default is false.
456 /// Note that the default CSS is output first, then the user CSS, so it is
457 /// possible to override what one does not want.
459 /// A cache for the default style info so generated.
460 mutable docstring htmldefaultstyle_;
461 /// Any other info for the HTML header.
462 docstring htmlpreamble_;
463 /// Whether this is the <title> paragraph.
465 /// calculating this is expensive, so we cache it.
466 mutable std::string defaultcssclass_;
467 /// This is the `category' for this layout. The following are
468 /// recommended basic categories: FrontMatter, BackMatter, MainText,
469 /// Sectioning, Starred, List, Reasoning.
471 /// Macro definitions needed for this layout
473 /// Language dependent macro definitions needed for this layout
474 docstring langpreamble_;
475 /// Language and babel dependent macro definitions needed for this layout
476 docstring babelpreamble_;
477 /// Are adjacent paragraphs handled as one group?
479 /// Packages needed for this layout
480 std::set<std::string> requires_;
481 /// Layouts that are by default nested after this one
482 std::set<docstring> autonests_;
483 /// Layouts that by auto-nest this one
484 std::set<docstring> autonested_by_;
486 LaTeXArgMap latexargs_;
488 LaTeXArgMap postcommandargs_;
490 LaTeXArgMap listpreamble_;
492 LaTeXArgMap itemargs_;
496 std::string toc_type_;
498 bool is_toc_caption_;