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;
183 /// Is this the kind of layout in which adjacent paragraphs
184 /// are handled as one group?
185 bool isParagraphGroup() const {
186 return latextype == LATEX_ENVIRONMENT
187 || latextype == LATEX_BIB_ENVIRONMENT;
190 bool labelIsInline() const {
191 return labeltype == LABEL_STATIC
192 || labeltype == LABEL_SENSITIVE
193 || labeltype == LABEL_ENUMERATE
194 || labeltype == LABEL_ITEMIZE;
196 bool labelIsAbove() const {
197 return labeltype == LABEL_ABOVE
198 || labeltype == LABEL_CENTERED
199 || labeltype == LABEL_BIBLIO;
203 bool operator==(Layout const &) const;
205 bool operator!=(Layout const & rhs) const
206 { return !(*this == rhs); }
208 ////////////////////////////////////////////////////////////////
210 ////////////////////////////////////////////////////////////////
211 /** Default font for this layout/environment.
212 The main font for this kind of environment. If an attribute has
213 INHERITED_*, it means that the value is specified by
214 the defaultfont for the entire layout. If we are nested, the
215 font is inherited from the font in the environment one level
216 up until the font is resolved. The values :IGNORE_*
217 and FONT_TOGGLE are illegal here.
221 /** Default font for labels.
222 Interpretation the same as for font above
226 /** Resolved version of the font for this layout/environment.
227 This is a resolved version the default font. The font is resolved
228 against the defaultfont of the entire layout.
232 /** Resolved version of the font used for labels.
233 This is a resolved version the label font. The font is resolved
234 against the defaultfont of the entire layout.
236 FontInfo reslabelfont;
238 /// Text that dictates how wide the left margin is on the screen
239 docstring leftmargin;
240 /// Text that dictates how wide the right margin is on the screen
241 docstring rightmargin;
242 /// Text that dictates how much space to leave after a potential label
244 /// Text that dictates how much space to leave before a potential label
245 docstring labelindent;
246 /// Text that dictates the width of the indentation of indented pars
257 double labelbottomsep;
265 LyXAlignment alignpossible;
269 EndLabelType endlabeltype;
271 MarginType margintype;
273 bool newline_allowed;
281 bool parbreak_is_newline;
284 /// special value of toclevel for non-section layouts
285 static const int NOT_IN_TOC;
287 /** true when the fragile commands in the paragraph need to be
290 /// true when empty paragraphs should be kept.
292 /// Type of LaTeX object
294 /// Does this object belong in the title part of the document?
296 /// Is the content to go in the preamble rather than the body?
298 /// Which counter to step
300 /// Prefix to use when creating labels
302 /// Depth of XML command
305 /// Return a pointer on a new layout suitable to describe a caption.
306 /// FIXME: remove this eventually. This is only for tex2lyx
307 /// until it has proper support for the caption inset (JMarc)
308 static Layout * forCaption();
310 /// Is this spellchecked?
315 /// generates the default CSS for this layout
316 void makeDefaultCSS() const;
318 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
320 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
322 /// Name of the layout/paragraph environment
325 /// LaTeX name for environment
326 std::string latexname_;
328 /** Is this layout the default layout for an unknown layout? If
329 * so, its name will be displayed as xxx (unknown).
333 /** Name of an layout that has replaced this layout.
334 This is used to rename a layout, while keeping backward
337 docstring obsoleted_by_;
339 /** Name of an layout which preamble must come before this one
340 This is used when the preamble snippet uses macros defined in
343 docstring depends_on_;
345 /// Label string. "Abstract", "Reference", "Caption"...
346 docstring labelstring_;
348 docstring endlabelstring_;
349 /// Label string inside appendix. "Appendix", ...
350 docstring labelstring_appendix_;
351 /// LaTeX parameter for environment
352 std::string latexparam_;
353 /// Item command in lists
354 std::string itemcommand_;
355 /// Left delimiter of the content
356 docstring leftdelim_;
357 /// Right delimiter of the content
358 docstring rightdelim_;
359 /// Internal tag to use (e.g., <title></title> for sect header)
360 std::string innertag_;
361 /// Internal tag to use (e.g. to surround varentrylist label)
362 std::string labeltag_;
363 /// Internal tag to surround the item text in a list.
364 std::string itemtag_;
365 /// The interpretation of this tag varies depending upon the latextype.
366 /// In an environment, it is the tag enclosing all content for this set of
367 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
368 /// it would be: ul. (You get the idea.)
370 /// For a command, it is the tag enclosing the content of the command.
371 /// So, for section, it might be: h2.
373 /// For the paragraph type, it is the tag that will enclose each paragraph.
375 /// Defaults to "div".
376 mutable std::string htmltag_;
377 /// Additional attributes for inclusion with the start tag. Defaults
378 /// to: class="layoutname".
379 mutable std::string htmlattr_;
380 /// Tag for individual paragraphs in an environment. In lists, this
381 /// would be something like "li". But it also needs to be set for
382 /// quotation, e.g., since the paragraphs in a quote need to be
383 /// in "p" tags. Default is "div".
384 /// Note that when I said "environment", I meant it: This has no
385 /// effect for LATEX_PARAGRAPH type layouts.
386 mutable std::string htmlitemtag_;
387 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
388 mutable std::string htmlitemattr_;
389 /// Tag for labels, of whatever sort. One use for this is in setting
390 /// descriptions, in which case it would be: dt. Another use is to
391 /// customize the display of, say, the auto-generated label for
392 /// sections. Defaults to "span".
393 /// If set to "NONE", this suppresses the printing of the label.
394 mutable std::string htmllabeltag_;
395 /// Attributes for the label. Defaults to: class="layoutname_label".
396 mutable std::string htmllabelattr_;
397 /// Whether to put the label before the item, or within the item.
398 /// I.e., do we have (true):
399 /// <label>...</label><item>...</item>
400 /// or instead (false):
401 /// <item><label>...</label>...</item>
402 /// The latter is the default.
403 bool htmllabelfirst_;
404 /// CSS information needed by this layout.
405 docstring htmlstyle_;
406 /// Should we generate the default CSS for this layout, even if HTMLStyle
407 /// has been given? Default is false.
408 /// Note that the default CSS is output first, then the user CSS, so it is
409 /// possible to override what one does not want.
411 /// A cache for the default style info so generated.
412 mutable docstring htmldefaultstyle_;
413 /// Any other info for the HTML header.
414 docstring htmlpreamble_;
415 /// Whether this is the <title> paragraph.
417 /// calculating this is expensive, so we cache it.
418 mutable std::string defaultcssclass_;
419 /// This is the `category' for this layout. The following are
420 /// recommended basic categories: FrontMatter, BackMatter, MainText,
421 /// Section, Starred, List, Theorem.
423 /// Macro definitions needed for this layout
425 /// Language dependent macro definitions needed for this layout
426 docstring langpreamble_;
427 /// Language and babel dependent macro definitions needed for this layout
428 docstring babelpreamble_;
429 /// Packages needed for this layout
430 std::set<std::string> requires_;
432 LaTeXArgMap latexargs_;
434 LaTeXArgMap postcommandargs_;
436 LaTeXArgMap itemargs_;