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;
108 docstring pass_thru_chars;
111 typedef std::map<std::string, latexarg> LaTeXArgMap;
113 LaTeXArgMap const & latexargs() const { return latexargs_; }
115 LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
117 LaTeXArgMap const & itemargs() const { return itemargs_; }
118 /// Returns latexargs() + postcommandargs() + itemargs().
119 /// But note that it returns a *copy*, not a reference, so do not do
121 /// Layout::LaTeXArgMap::iterator it = args().begin();
122 /// Layout::LaTeXArgMap::iterator en = args().end();
123 /// Those are iterators for different containers.
124 LaTeXArgMap args() const;
128 int requiredArgs() const;
130 docstring const & labelstring(bool in_appendix) const
131 { return in_appendix ? labelstring_appendix_ : labelstring_; }
133 docstring const & endlabelstring() const { return endlabelstring_; }
135 docstring const & category() const { return category_; }
137 docstring const & preamble() const { return preamble_; }
138 /// Get language dependent macro definitions needed for this layout
139 /// for language \p lang
140 docstring const langpreamble() const { return langpreamble_; }
141 /// Get language and babel dependent macro definitions needed for
142 /// this layout for language \p lang
143 docstring const babelpreamble() const { return babelpreamble_; }
145 std::set<std::string> const & requires() const { return requires_; }
147 std::string const & latexparam() const { return latexparam_; }
149 docstring leftdelim() const { return leftdelim_; }
151 docstring rightdelim() const { return rightdelim_; }
153 std::string const & innertag() const { return innertag_; }
155 std::string const & labeltag() const { return labeltag_; }
157 std::string const & itemtag() const { return itemtag_; }
159 std::string const & htmltag() const;
161 std::string const & htmlattr() const;
163 std::string const & htmlitemtag() const;
165 std::string const & htmlitemattr() const;
167 std::string const & htmllabeltag() const;
169 std::string const & htmllabelattr() const;
171 std::string defaultCSSClass() const;
173 bool htmllabelfirst() const { return htmllabelfirst_; }
175 docstring htmlstyle() const;
177 docstring const & htmlpreamble() const { return htmlpreamble_; }
179 bool htmltitle() const { return htmltitle_; }
181 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
183 bool isCommand() const { return latextype == LATEX_COMMAND; }
185 bool isEnvironment() const {
186 return latextype == LATEX_ENVIRONMENT
187 || latextype == LATEX_BIB_ENVIRONMENT
188 || latextype == LATEX_ITEM_ENVIRONMENT
189 || latextype == LATEX_LIST_ENVIRONMENT;
191 /// Is this the kind of layout in which adjacent paragraphs
192 /// are handled as one group?
193 bool isParagraphGroup() const { return par_group_; }
195 bool labelIsInline() const {
196 return labeltype == LABEL_STATIC
197 || labeltype == LABEL_SENSITIVE
198 || labeltype == LABEL_ENUMERATE
199 || labeltype == LABEL_ITEMIZE;
201 bool labelIsAbove() const {
202 return labeltype == LABEL_ABOVE
203 || labeltype == LABEL_CENTERED
204 || labeltype == LABEL_BIBLIO;
208 bool operator==(Layout const &) const;
210 bool operator!=(Layout const & rhs) const
211 { return !(*this == rhs); }
213 ////////////////////////////////////////////////////////////////
215 ////////////////////////////////////////////////////////////////
216 /** Default font for this layout/environment.
217 The main font for this kind of environment. If an attribute has
218 INHERITED_*, it means that the value is specified by
219 the defaultfont for the entire layout. If we are nested, the
220 font is inherited from the font in the environment one level
221 up until the font is resolved. The values :IGNORE_*
222 and FONT_TOGGLE are illegal here.
226 /** Default font for labels.
227 Interpretation the same as for font above
231 /** Resolved version of the font for this layout/environment.
232 This is a resolved version the default font. The font is resolved
233 against the defaultfont of the entire layout.
237 /** Resolved version of the font used for labels.
238 This is a resolved version the label font. The font is resolved
239 against the defaultfont of the entire layout.
241 FontInfo reslabelfont;
243 /// Text that dictates how wide the left margin is on the screen
244 docstring leftmargin;
245 /// Text that dictates how wide the right margin is on the screen
246 docstring rightmargin;
247 /// Text that dictates how much space to leave after a potential label
249 /// Text that dictates how much space to leave before a potential label
250 docstring labelindent;
251 /// Text that dictates the width of the indentation of indented pars
262 double labelbottomsep;
270 LyXAlignment alignpossible;
274 EndLabelType endlabeltype;
276 MarginType margintype;
278 bool newline_allowed;
282 ToggleIndentation toggle_indent;
287 /// Individual chars to be passed verbatim
288 docstring pass_thru_chars;
290 bool parbreak_is_newline;
293 /// special value of toclevel for non-section layouts
294 static const int NOT_IN_TOC;
296 /** true when the fragile commands in the paragraph need to be
299 /// true when empty paragraphs should be kept.
301 /// Type of LaTeX object
303 /// Does this object belong in the title part of the document?
305 /// Is the content to go in the preamble rather than the body?
307 /// Which counter to step
309 /// Prefix to use when creating labels
311 /// Depth of XML command
314 /// Return a pointer on a new layout suitable to describe a caption.
315 /// FIXME: remove this eventually. This is only for tex2lyx
316 /// until it has proper support for the caption inset (JMarc)
317 static Layout * forCaption();
319 /// Is this spellchecked?
322 * Should this layout definition always be written to the document preamble?
323 * Possible values are:
324 * 0: Do not enforce local layout
325 * >=1: Enforce local layout with version forcelocal
326 * -1: Enforce local layout with infinite version
327 * On reading, the forced local layout is only used if its version
328 * number is greater than the version number of the same layout in the
329 * document class. Otherwise, it is ignored.
335 /// Reads a layout definition from file
336 /// \return true on success.
337 bool readIgnoreForcelocal(Lexer &, TextClass const &);
338 /// generates the default CSS for this layout
339 void makeDefaultCSS() const;
341 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
343 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
345 /// Name of the layout/paragraph environment
348 /// LaTeX name for environment
349 std::string latexname_;
351 /** Is this layout the default layout for an unknown layout? If
352 * so, its name will be displayed as xxx (unknown).
356 /** Name of an layout that has replaced this layout.
357 This is used to rename a layout, while keeping backward
360 docstring obsoleted_by_;
362 /** Name of an layout which preamble must come before this one
363 This is used when the preamble snippet uses macros defined in
366 docstring depends_on_;
368 /// Label string. "Abstract", "Reference", "Caption"...
369 docstring labelstring_;
371 docstring endlabelstring_;
372 /// Label string inside appendix. "Appendix", ...
373 docstring labelstring_appendix_;
374 /// LaTeX parameter for environment
375 std::string latexparam_;
376 /// Item command in lists
377 std::string itemcommand_;
378 /// Left delimiter of the content
379 docstring leftdelim_;
380 /// Right delimiter of the content
381 docstring rightdelim_;
382 /// Internal tag to use (e.g., <title></title> for sect header)
383 std::string innertag_;
384 /// Internal tag to use (e.g. to surround varentrylist label)
385 std::string labeltag_;
386 /// Internal tag to surround the item text in a list.
387 std::string itemtag_;
388 /// The interpretation of this tag varies depending upon the latextype.
389 /// In an environment, it is the tag enclosing all content for this set of
390 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
391 /// it would be: ul. (You get the idea.)
393 /// For a command, it is the tag enclosing the content of the command.
394 /// So, for section, it might be: h2.
396 /// For the paragraph type, it is the tag that will enclose each paragraph.
398 /// Defaults to "div".
399 mutable std::string htmltag_;
400 /// Additional attributes for inclusion with the start tag. Defaults
401 /// to: class="layoutname".
402 mutable std::string htmlattr_;
403 /// Tag for individual paragraphs in an environment. In lists, this
404 /// would be something like "li". But it also needs to be set for
405 /// quotation, e.g., since the paragraphs in a quote need to be
406 /// in "p" tags. Default is "div".
407 /// Note that when I said "environment", I meant it: This has no
408 /// effect for LATEX_PARAGRAPH type layouts.
409 mutable std::string htmlitemtag_;
410 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
411 mutable std::string htmlitemattr_;
412 /// Tag for labels, of whatever sort. One use for this is in setting
413 /// descriptions, in which case it would be: dt. Another use is to
414 /// customize the display of, say, the auto-generated label for
415 /// sections. Defaults to "span".
416 /// If set to "NONE", this suppresses the printing of the label.
417 mutable std::string htmllabeltag_;
418 /// Attributes for the label. Defaults to: class="layoutname_label".
419 mutable std::string htmllabelattr_;
420 /// Whether to put the label before the item, or within the item.
421 /// I.e., do we have (true):
422 /// <label>...</label><item>...</item>
423 /// or instead (false):
424 /// <item><label>...</label>...</item>
425 /// The latter is the default.
426 bool htmllabelfirst_;
427 /// CSS information needed by this layout.
428 docstring htmlstyle_;
429 /// Should we generate the default CSS for this layout, even if HTMLStyle
430 /// has been given? Default is false.
431 /// Note that the default CSS is output first, then the user CSS, so it is
432 /// possible to override what one does not want.
434 /// A cache for the default style info so generated.
435 mutable docstring htmldefaultstyle_;
436 /// Any other info for the HTML header.
437 docstring htmlpreamble_;
438 /// Whether this is the <title> paragraph.
440 /// calculating this is expensive, so we cache it.
441 mutable std::string defaultcssclass_;
442 /// This is the `category' for this layout. The following are
443 /// recommended basic categories: FrontMatter, BackMatter, MainText,
444 /// Sectioning, Starred, List, Reasoning.
446 /// Macro definitions needed for this layout
448 /// Language dependent macro definitions needed for this layout
449 docstring langpreamble_;
450 /// Language and babel dependent macro definitions needed for this layout
451 docstring babelpreamble_;
452 /// Are adjacent paragraphs handled as one group?
454 /// Packages needed for this layout
455 std::set<std::string> requires_;
457 LaTeXArgMap latexargs_;
459 LaTeXArgMap postcommandargs_;
461 LaTeXArgMap itemargs_;