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;
102 std::string requires;
103 std::string decoration;
109 typedef std::map<std::string, latexarg> LaTeXArgMap;
111 LaTeXArgMap args() const;
113 LaTeXArgMap const & latexargs() const { return latexargs_; }
115 LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
117 LaTeXArgMap const & itemargs() const { return itemargs_; }
121 int requiredArgs() const;
123 docstring const & labelstring(bool in_appendix) const
124 { return in_appendix ? labelstring_appendix_ : labelstring_; }
126 docstring const & endlabelstring() const { return endlabelstring_; }
128 docstring const & category() const { return category_; }
130 docstring const & preamble() const { return preamble_; }
131 /// Get language dependent macro definitions needed for this layout
132 /// for language \p lang
133 docstring const langpreamble() const { return langpreamble_; }
134 /// Get language and babel dependent macro definitions needed for
135 /// this layout for language \p lang
136 docstring const babelpreamble() const { return babelpreamble_; }
138 std::set<std::string> const & requires() const { return requires_; }
140 std::string const & latexparam() const { return latexparam_; }
142 docstring leftdelim() const { return leftdelim_; }
144 docstring rightdelim() const { return rightdelim_; }
146 std::string const & innertag() const { return innertag_; }
148 std::string const & labeltag() const { return labeltag_; }
150 std::string const & itemtag() const { return itemtag_; }
152 std::string const & htmltag() const;
154 std::string const & htmlattr() const;
156 std::string const & htmlitemtag() const;
158 std::string const & htmlitemattr() const;
160 std::string const & htmllabeltag() const;
162 std::string const & htmllabelattr() const;
164 std::string defaultCSSClass() const;
166 bool htmllabelfirst() const { return htmllabelfirst_; }
168 docstring htmlstyle() const;
170 docstring const & htmlpreamble() const { return htmlpreamble_; }
172 bool htmltitle() const { return htmltitle_; }
174 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
176 bool isCommand() const { return latextype == LATEX_COMMAND; }
178 bool isEnvironment() const {
179 return latextype == LATEX_ENVIRONMENT
180 || latextype == LATEX_BIB_ENVIRONMENT
181 || latextype == LATEX_ITEM_ENVIRONMENT
182 || latextype == LATEX_LIST_ENVIRONMENT;
184 /// Is this the kind of layout in which adjacent paragraphs
185 /// are handled as one group?
186 bool isParagraphGroup() const {
187 return latextype == LATEX_ENVIRONMENT
188 || latextype == LATEX_BIB_ENVIRONMENT;
191 bool labelIsInline() const {
192 return labeltype == LABEL_STATIC
193 || labeltype == LABEL_SENSITIVE
194 || labeltype == LABEL_ENUMERATE
195 || labeltype == LABEL_ITEMIZE;
197 bool labelIsAbove() const {
198 return labeltype == LABEL_ABOVE
199 || labeltype == LABEL_CENTERED
200 || labeltype == LABEL_BIBLIO;
204 bool operator==(Layout const &) const;
206 bool operator!=(Layout const & rhs) const
207 { return !(*this == rhs); }
209 ////////////////////////////////////////////////////////////////
211 ////////////////////////////////////////////////////////////////
212 /** Default font for this layout/environment.
213 The main font for this kind of environment. If an attribute has
214 INHERITED_*, it means that the value is specified by
215 the defaultfont for the entire layout. If we are nested, the
216 font is inherited from the font in the environment one level
217 up until the font is resolved. The values :IGNORE_*
218 and FONT_TOGGLE are illegal here.
222 /** Default font for labels.
223 Interpretation the same as for font above
227 /** Resolved version of the font for this layout/environment.
228 This is a resolved version the default font. The font is resolved
229 against the defaultfont of the entire layout.
233 /** Resolved version of the font used for labels.
234 This is a resolved version the label font. The font is resolved
235 against the defaultfont of the entire layout.
237 FontInfo reslabelfont;
239 /// Text that dictates how wide the left margin is on the screen
240 docstring leftmargin;
241 /// Text that dictates how wide the right margin is on the screen
242 docstring rightmargin;
243 /// Text that dictates how much space to leave after a potential label
245 /// Text that dictates how much space to leave before a potential label
246 docstring labelindent;
247 /// Text that dictates the width of the indentation of indented pars
258 double labelbottomsep;
266 LyXAlignment alignpossible;
270 EndLabelType endlabeltype;
272 MarginType margintype;
274 bool newline_allowed;
282 bool parbreak_is_newline;
285 /// special value of toclevel for non-section layouts
286 static const int NOT_IN_TOC;
288 /** true when the fragile commands in the paragraph need to be
291 /// true when empty paragraphs should be kept.
293 /// Type of LaTeX object
295 /// Does this object belong in the title part of the document?
297 /// Is the content to go in the preamble rather than the body?
299 /// Which counter to step
301 /// Prefix to use when creating labels
303 /// Depth of XML command
306 /// Return a pointer on a new layout suitable to describe a caption.
307 /// FIXME: remove this eventually. This is only for tex2lyx
308 /// until it has proper support for the caption inset (JMarc)
309 static Layout * forCaption();
311 /// Is this spellchecked?
316 /// generates the default CSS for this layout
317 void makeDefaultCSS() const;
319 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
321 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
323 /// Name of the layout/paragraph environment
326 /// LaTeX name for environment
327 std::string latexname_;
329 /** Is this layout the default layout for an unknown layout? If
330 * so, its name will be displayed as xxx (unknown).
334 /** Name of an layout that has replaced this layout.
335 This is used to rename a layout, while keeping backward
338 docstring obsoleted_by_;
340 /** Name of an layout which preamble must come before this one
341 This is used when the preamble snippet uses macros defined in
344 docstring depends_on_;
346 /// Label string. "Abstract", "Reference", "Caption"...
347 docstring labelstring_;
349 docstring endlabelstring_;
350 /// Label string inside appendix. "Appendix", ...
351 docstring labelstring_appendix_;
352 /// LaTeX parameter for environment
353 std::string latexparam_;
354 /// Item command in lists
355 std::string itemcommand_;
356 /// Left delimiter of the content
357 docstring leftdelim_;
358 /// Right delimiter of the content
359 docstring rightdelim_;
360 /// Internal tag to use (e.g., <title></title> for sect header)
361 std::string innertag_;
362 /// Internal tag to use (e.g. to surround varentrylist label)
363 std::string labeltag_;
364 /// Internal tag to surround the item text in a list.
365 std::string itemtag_;
366 /// The interpretation of this tag varies depending upon the latextype.
367 /// In an environment, it is the tag enclosing all content for this set of
368 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
369 /// it would be: ul. (You get the idea.)
371 /// For a command, it is the tag enclosing the content of the command.
372 /// So, for section, it might be: h2.
374 /// For the paragraph type, it is the tag that will enclose each paragraph.
376 /// Defaults to "div".
377 mutable std::string htmltag_;
378 /// Additional attributes for inclusion with the start tag. Defaults
379 /// to: class="layoutname".
380 mutable std::string htmlattr_;
381 /// Tag for individual paragraphs in an environment. In lists, this
382 /// would be something like "li". But it also needs to be set for
383 /// quotation, e.g., since the paragraphs in a quote need to be
384 /// in "p" tags. Default is "div".
385 /// Note that when I said "environment", I meant it: This has no
386 /// effect for LATEX_PARAGRAPH type layouts.
387 mutable std::string htmlitemtag_;
388 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
389 mutable std::string htmlitemattr_;
390 /// Tag for labels, of whatever sort. One use for this is in setting
391 /// descriptions, in which case it would be: dt. Another use is to
392 /// customize the display of, say, the auto-generated label for
393 /// sections. Defaults to "span".
394 /// If set to "NONE", this suppresses the printing of the label.
395 mutable std::string htmllabeltag_;
396 /// Attributes for the label. Defaults to: class="layoutname_label".
397 mutable std::string htmllabelattr_;
398 /// Whether to put the label before the item, or within the item.
399 /// I.e., do we have (true):
400 /// <label>...</label><item>...</item>
401 /// or instead (false):
402 /// <item><label>...</label>...</item>
403 /// The latter is the default.
404 bool htmllabelfirst_;
405 /// CSS information needed by this layout.
406 docstring htmlstyle_;
407 /// Should we generate the default CSS for this layout, even if HTMLStyle
408 /// has been given? Default is false.
409 /// Note that the default CSS is output first, then the user CSS, so it is
410 /// possible to override what one does not want.
412 /// A cache for the default style info so generated.
413 mutable docstring htmldefaultstyle_;
414 /// Any other info for the HTML header.
415 docstring htmlpreamble_;
416 /// Whether this is the <title> paragraph.
418 /// calculating this is expensive, so we cache it.
419 mutable std::string defaultcssclass_;
420 /// This is the `category' for this layout. The following are
421 /// recommended basic categories: FrontMatter, BackMatter, MainText,
422 /// Section, Starred, List, Theorem.
424 /// Macro definitions needed for this layout
426 /// Language dependent macro definitions needed for this layout
427 docstring langpreamble_;
428 /// Language and babel dependent macro definitions needed for this layout
429 docstring babelpreamble_;
430 /// Packages needed for this layout
431 std::set<std::string> requires_;
433 LaTeXArgMap latexargs_;
435 LaTeXArgMap postcommandargs_;
437 LaTeXArgMap itemargs_;