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