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 &);
79 docstring const & name() const { return name_; }
81 void setName(docstring const & n) { name_ = n; }
83 docstring const & obsoleted_by() const { return obsoleted_by_; }
85 docstring const & depends_on() const { return depends_on_; }
87 std::string const & latexname() const { return latexname_; }
89 std::string const & itemcommand() const { return itemcommand_; }
91 void setLatexName(std::string const & n) { latexname_ = n; }
92 /// The arguments of this layout
94 docstring labelstring;
101 std::string requires;
102 std::string decoration;
108 typedef std::map<std::string, latexarg> LaTeXArgMap;
110 LaTeXArgMap args() const;
112 LaTeXArgMap const & latexargs() const { return latexargs_; }
114 LaTeXArgMap const & itemargs() const { return itemargs_; }
118 int requiredArgs() const;
120 docstring const & labelstring(bool in_appendix) const
121 { return in_appendix ? labelstring_appendix_ : labelstring_; }
123 docstring const & endlabelstring() const { return endlabelstring_; }
125 docstring const & category() const { return category_; }
127 docstring const & preamble() const { return preamble_; }
128 /// Get language dependent macro definitions needed for this layout
129 /// for language \p lang
130 docstring const langpreamble() const { return langpreamble_; }
131 /// Get language and babel dependent macro definitions needed for
132 /// this layout for language \p lang
133 docstring const babelpreamble() const { return babelpreamble_; }
135 std::set<std::string> const & requires() const { return requires_; }
137 std::string const & latexparam() const { return latexparam_; }
139 docstring leftdelim() const { return leftdelim_; }
141 docstring rightdelim() const { return rightdelim_; }
143 std::string const & innertag() const { return innertag_; }
145 std::string const & labeltag() const { return labeltag_; }
147 std::string const & itemtag() const { return itemtag_; }
149 std::string const & htmltag() const;
151 std::string const & htmlattr() const;
153 std::string const & htmlitemtag() const;
155 std::string const & htmlitemattr() const;
157 std::string const & htmllabeltag() const;
159 std::string const & htmllabelattr() const;
161 std::string defaultCSSClass() const;
163 bool htmllabelfirst() const { return htmllabelfirst_; }
165 docstring htmlstyle() const;
167 docstring const & htmlpreamble() const { return htmlpreamble_; }
169 bool htmltitle() const { return htmltitle_; }
171 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
173 bool isCommand() const { return latextype == LATEX_COMMAND; }
175 bool isEnvironment() const {
176 return latextype == LATEX_ENVIRONMENT
177 || latextype == LATEX_BIB_ENVIRONMENT
178 || latextype == LATEX_ITEM_ENVIRONMENT
179 || latextype == LATEX_LIST_ENVIRONMENT;
183 bool operator==(Layout const &) const;
185 bool operator!=(Layout const & rhs) const
186 { return !(*this == rhs); }
188 ////////////////////////////////////////////////////////////////
190 ////////////////////////////////////////////////////////////////
191 /** Default font for this layout/environment.
192 The main font for this kind of environment. If an attribute has
193 INHERITED_*, it means that the value is specified by
194 the defaultfont for the entire layout. If we are nested, the
195 font is inherited from the font in the environment one level
196 up until the font is resolved. The values :IGNORE_*
197 and FONT_TOGGLE are illegal here.
201 /** Default font for labels.
202 Interpretation the same as for font above
206 /** Resolved version of the font for this layout/environment.
207 This is a resolved version the default font. The font is resolved
208 against the defaultfont of the entire layout.
212 /** Resolved version of the font used for labels.
213 This is a resolved version the label font. The font is resolved
214 against the defaultfont of the entire layout.
216 FontInfo reslabelfont;
218 /// Text that dictates how wide the left margin is on the screen
219 docstring leftmargin;
220 /// Text that dictates how wide the right margin is on the screen
221 docstring rightmargin;
222 /// Text that dictates how much space to leave after a potential label
224 /// Text that dictates how much space to leave before a potential label
225 docstring labelindent;
226 /// Text that dictates the width of the indentation of indented pars
237 double labelbottomsep;
245 LyXAlignment alignpossible;
249 EndLabelType endlabeltype;
251 MarginType margintype;
253 bool newline_allowed;
261 bool parbreak_is_newline;
264 /// special value of toclevel for non-section layouts
265 static const int NOT_IN_TOC;
267 /** true when the fragile commands in the paragraph need to be
270 /// true when empty paragraphs should be kept.
272 /// Type of LaTeX object
274 /// Does this object belong in the title part of the document?
276 /// Is the content to go in the preamble rather than the body?
278 /// Which counter to step
280 /// Prefix to use when creating labels
282 /// Depth of XML command
285 /// Return a pointer on a new layout suitable to describe a caption.
286 /// FIXME: remove this eventually. This is only for tex2lyx
287 /// until it has proper support for the caption inset (JMarc)
288 static Layout * forCaption();
290 /// Is this spellchecked?
295 /// generates the default CSS for this layout
296 void makeDefaultCSS() const;
298 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
300 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
302 /// Name of the layout/paragraph environment
305 /// LaTeX name for environment
306 std::string latexname_;
308 /** Is this layout the default layout for an unknown layout? If
309 * so, its name will be displayed as xxx (unknown).
313 /** Name of an layout that has replaced this layout.
314 This is used to rename a layout, while keeping backward
317 docstring obsoleted_by_;
319 /** Name of an layout which preamble must come before this one
320 This is used when the preamble snippet uses macros defined in
323 docstring depends_on_;
325 /// Label string. "Abstract", "Reference", "Caption"...
326 docstring labelstring_;
328 docstring endlabelstring_;
329 /// Label string inside appendix. "Appendix", ...
330 docstring labelstring_appendix_;
331 /// LaTeX parameter for environment
332 std::string latexparam_;
333 /// Item command in lists
334 std::string itemcommand_;
335 /// Left delimiter of the content
336 docstring leftdelim_;
337 /// Right delimiter of the content
338 docstring rightdelim_;
339 /// Internal tag to use (e.g., <title></title> for sect header)
340 std::string innertag_;
341 /// Internal tag to use (e.g. to surround varentrylist label)
342 std::string labeltag_;
343 /// Internal tag to surround the item text in a list.
344 std::string itemtag_;
345 /// The interpretation of this tag varies depending upon the latextype.
346 /// In an environment, it is the tag enclosing all content for this set of
347 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
348 /// it would be: ul. (You get the idea.)
350 /// For a command, it is the tag enclosing the content of the command.
351 /// So, for section, it might be: h2.
353 /// For the paragraph type, it is the tag that will enclose each paragraph.
355 /// Defaults to "div".
356 mutable std::string htmltag_;
357 /// Additional attributes for inclusion with the start tag. Defaults
358 /// to: class="layoutname".
359 mutable std::string htmlattr_;
360 /// Tag for individual paragraphs in an environment. In lists, this
361 /// would be something like "li". But it also needs to be set for
362 /// quotation, e.g., since the paragraphs in a quote need to be
363 /// in "p" tags. Default is "div".
364 /// Note that when I said "environment", I meant it: This has no
365 /// effect for LATEX_PARAGRAPH type layouts.
366 mutable std::string htmlitemtag_;
367 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
368 mutable std::string htmlitemattr_;
369 /// Tag for labels, of whatever sort. One use for this is in setting
370 /// descriptions, in which case it would be: dt. Another use is to
371 /// customize the display of, say, the auto-generated label for
372 /// sections. Defaults to "span".
373 /// If set to "NONE", this suppresses the printing of the label.
374 mutable std::string htmllabeltag_;
375 /// Attributes for the label. Defaults to: class="layoutname_label".
376 mutable std::string htmllabelattr_;
377 /// Whether to put the label before the item, or within the item.
378 /// I.e., do we have (true):
379 /// <label>...</label><item>...</item>
380 /// or instead (false):
381 /// <item><label>...</label>...</item>
382 /// The latter is the default.
383 bool htmllabelfirst_;
384 /// CSS information needed by this layout.
385 docstring htmlstyle_;
386 /// Should we generate the default CSS for this layout, even if HTMLStyle
387 /// has been given? Default is false.
388 /// Note that the default CSS is output first, then the user CSS, so it is
389 /// possible to override what one does not want.
391 /// A cache for the default style info so generated.
392 mutable docstring htmldefaultstyle_;
393 /// Any other info for the HTML header.
394 docstring htmlpreamble_;
395 /// Whether this is the <title> paragraph.
397 /// calculating this is expensive, so we cache it.
398 mutable std::string defaultcssclass_;
399 /// This is the `category' for this layout. The following are
400 /// recommended basic categories: FrontMatter, BackMatter, MainText,
401 /// Section, Starred, List, Theorem.
403 /// Macro definitions needed for this layout
405 /// Language dependent macro definitions needed for this layout
406 docstring langpreamble_;
407 /// Language and babel dependent macro definitions needed for this layout
408 docstring babelpreamble_;
409 /// Packages needed for this layout
410 std::set<std::string> requires_;
412 LaTeXArgMap latexargs_;
414 LaTeXArgMap itemargs_;