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;
112 typedef std::map<std::string, latexarg> LaTeXArgMap;
114 LaTeXArgMap const & latexargs() const { return latexargs_; }
116 LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
118 LaTeXArgMap const & itemargs() const { return itemargs_; }
119 /// Returns latexargs() + postcommandargs() + itemargs().
120 /// But note that it returns a *copy*, not a reference, so do not do
122 /// Layout::LaTeXArgMap::iterator it = args().begin();
123 /// Layout::LaTeXArgMap::iterator en = args().end();
124 /// Those are iterators for different containers.
125 LaTeXArgMap args() const;
129 int requiredArgs() const;
131 docstring const & labelstring(bool in_appendix) const
132 { return in_appendix ? labelstring_appendix_ : labelstring_; }
134 docstring const & endlabelstring() const { return endlabelstring_; }
136 docstring const & category() const { return category_; }
138 docstring const & preamble() const { return preamble_; }
139 /// Get language dependent macro definitions needed for this layout
140 /// for language \p lang
141 docstring const langpreamble() const { return langpreamble_; }
142 /// Get language and babel dependent macro definitions needed for
143 /// this layout for language \p lang
144 docstring const babelpreamble() const { return babelpreamble_; }
146 std::set<std::string> const & requires() const { return requires_; }
148 std::string const & latexparam() const { return latexparam_; }
150 docstring leftdelim() const { return leftdelim_; }
152 docstring rightdelim() const { return rightdelim_; }
154 std::string const & innertag() const { return innertag_; }
156 std::string const & labeltag() const { return labeltag_; }
158 std::string const & itemtag() const { return itemtag_; }
160 std::string const & htmltag() const;
162 std::string const & htmlattr() const;
164 std::string const & htmlitemtag() const;
166 std::string const & htmlitemattr() const;
168 std::string const & htmllabeltag() const;
170 std::string const & htmllabelattr() const;
172 std::string defaultCSSClass() const;
174 bool htmllabelfirst() const { return htmllabelfirst_; }
176 docstring htmlstyle() const;
178 docstring const & htmlpreamble() const { return htmlpreamble_; }
180 bool htmltitle() const { return htmltitle_; }
182 bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
184 bool isCommand() const { return latextype == LATEX_COMMAND; }
186 bool isEnvironment() const {
187 return latextype == LATEX_ENVIRONMENT
188 || latextype == LATEX_BIB_ENVIRONMENT
189 || latextype == LATEX_ITEM_ENVIRONMENT
190 || latextype == LATEX_LIST_ENVIRONMENT;
192 /// Is this the kind of layout in which adjacent paragraphs
193 /// are handled as one group?
194 bool isParagraphGroup() const { return par_group_; }
196 bool labelIsInline() const {
197 return labeltype == LABEL_STATIC
198 || labeltype == LABEL_SENSITIVE
199 || labeltype == LABEL_ENUMERATE
200 || labeltype == LABEL_ITEMIZE;
202 bool labelIsAbove() const {
203 return labeltype == LABEL_ABOVE
204 || labeltype == LABEL_CENTERED
205 || labeltype == LABEL_BIBLIO;
208 bool addToToc() const { return add_to_toc_; }
210 std::string tocType() const { return toc_type_; }
212 bool isTocCaption() const { return is_toc_caption_; }
215 bool operator==(Layout const &) const;
217 bool operator!=(Layout const & rhs) const
218 { return !(*this == rhs); }
220 ////////////////////////////////////////////////////////////////
222 ////////////////////////////////////////////////////////////////
223 /** Default font for this layout/environment.
224 The main font for this kind of environment. If an attribute has
225 INHERITED_*, it means that the value is specified by
226 the defaultfont for the entire layout. If we are nested, the
227 font is inherited from the font in the environment one level
228 up until the font is resolved. The values :IGNORE_*
229 and FONT_TOGGLE are illegal here.
233 /** Default font for labels.
234 Interpretation the same as for font above
238 /** Resolved version of the font for this layout/environment.
239 This is a resolved version the default font. The font is resolved
240 against the defaultfont of the entire layout.
244 /** Resolved version of the font used for labels.
245 This is a resolved version the label font. The font is resolved
246 against the defaultfont of the entire layout.
248 FontInfo reslabelfont;
250 /// Text that dictates how wide the left margin is on the screen
251 docstring leftmargin;
252 /// Text that dictates how wide the right margin is on the screen
253 docstring rightmargin;
254 /// Text that dictates how much space to leave after a potential label
256 /// Text that dictates how much space to leave before a potential label
257 docstring labelindent;
258 /// Text that dictates the width of the indentation of indented pars
269 double labelbottomsep;
277 LyXAlignment alignpossible;
281 EndLabelType endlabeltype;
283 MarginType margintype;
285 bool newline_allowed;
289 ToggleIndentation toggle_indent;
294 /// Individual chars to be passed verbatim
295 docstring pass_thru_chars;
297 bool parbreak_is_newline;
300 /// special value of toclevel for non-section layouts
301 static const int NOT_IN_TOC;
303 /** true when the fragile commands in the paragraph need to be
306 /// true when empty paragraphs should be kept.
308 /// Type of LaTeX object
310 /// Does this object belong in the title part of the document?
312 /// Is the content to go in the preamble rather than the body?
314 /// Which counter to step
316 /// Prefix to use when creating labels
318 /// Depth of XML command
321 /// Return a pointer on a new layout suitable to describe a caption.
322 /// FIXME: remove this eventually. This is only for tex2lyx
323 /// until it has proper support for the caption inset (JMarc)
324 static Layout * forCaption();
326 /// Is this spellchecked?
329 * Should this layout definition always be written to the document preamble?
330 * Possible values are:
331 * 0: Do not enforce local layout
332 * >=1: Enforce local layout with version forcelocal
333 * -1: Enforce local layout with infinite version
334 * On reading, the forced local layout is only used if its version
335 * number is greater than the version number of the same layout in the
336 * document class. Otherwise, it is ignored.
342 /// Reads a layout definition from file
343 /// \return true on success.
344 bool readIgnoreForcelocal(Lexer &, TextClass const &);
345 /// generates the default CSS for this layout
346 void makeDefaultCSS() const;
348 std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
350 std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
352 /// Name of the layout/paragraph environment
355 /// LaTeX name for environment
356 std::string latexname_;
358 /** Is this layout the default layout for an unknown layout? If
359 * so, its name will be displayed as xxx (unknown).
363 /** Name of an layout that has replaced this layout.
364 This is used to rename a layout, while keeping backward
367 docstring obsoleted_by_;
369 /** Name of an layout which preamble must come before this one
370 This is used when the preamble snippet uses macros defined in
373 docstring depends_on_;
375 /// Label string. "Abstract", "Reference", "Caption"...
376 docstring labelstring_;
378 docstring endlabelstring_;
379 /// Label string inside appendix. "Appendix", ...
380 docstring labelstring_appendix_;
381 /// LaTeX parameter for environment
382 std::string latexparam_;
383 /// Item command in lists
384 std::string itemcommand_;
385 /// Left delimiter of the content
386 docstring leftdelim_;
387 /// Right delimiter of the content
388 docstring rightdelim_;
389 /// Internal tag to use (e.g., <title></title> for sect header)
390 std::string innertag_;
391 /// Internal tag to use (e.g. to surround varentrylist label)
392 std::string labeltag_;
393 /// Internal tag to surround the item text in a list.
394 std::string itemtag_;
395 /// The interpretation of this tag varies depending upon the latextype.
396 /// In an environment, it is the tag enclosing all content for this set of
397 /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
398 /// it would be: ul. (You get the idea.)
400 /// For a command, it is the tag enclosing the content of the command.
401 /// So, for section, it might be: h2.
403 /// For the paragraph type, it is the tag that will enclose each paragraph.
405 /// Defaults to "div".
406 mutable std::string htmltag_;
407 /// Additional attributes for inclusion with the start tag. Defaults
408 /// to: class="layoutname".
409 mutable std::string htmlattr_;
410 /// Tag for individual paragraphs in an environment. In lists, this
411 /// would be something like "li". But it also needs to be set for
412 /// quotation, e.g., since the paragraphs in a quote need to be
413 /// in "p" tags. Default is "div".
414 /// Note that when I said "environment", I meant it: This has no
415 /// effect for LATEX_PARAGRAPH type layouts.
416 mutable std::string htmlitemtag_;
417 /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
418 mutable std::string htmlitemattr_;
419 /// Tag for labels, of whatever sort. One use for this is in setting
420 /// descriptions, in which case it would be: dt. Another use is to
421 /// customize the display of, say, the auto-generated label for
422 /// sections. Defaults to "span".
423 /// If set to "NONE", this suppresses the printing of the label.
424 mutable std::string htmllabeltag_;
425 /// Attributes for the label. Defaults to: class="layoutname_label".
426 mutable std::string htmllabelattr_;
427 /// Whether to put the label before the item, or within the item.
428 /// I.e., do we have (true):
429 /// <label>...</label><item>...</item>
430 /// or instead (false):
431 /// <item><label>...</label>...</item>
432 /// The latter is the default.
433 bool htmllabelfirst_;
434 /// CSS information needed by this layout.
435 docstring htmlstyle_;
436 /// Should we generate the default CSS for this layout, even if HTMLStyle
437 /// has been given? Default is false.
438 /// Note that the default CSS is output first, then the user CSS, so it is
439 /// possible to override what one does not want.
441 /// A cache for the default style info so generated.
442 mutable docstring htmldefaultstyle_;
443 /// Any other info for the HTML header.
444 docstring htmlpreamble_;
445 /// Whether this is the <title> paragraph.
447 /// calculating this is expensive, so we cache it.
448 mutable std::string defaultcssclass_;
449 /// This is the `category' for this layout. The following are
450 /// recommended basic categories: FrontMatter, BackMatter, MainText,
451 /// Sectioning, Starred, List, Reasoning.
453 /// Macro definitions needed for this layout
455 /// Language dependent macro definitions needed for this layout
456 docstring langpreamble_;
457 /// Language and babel dependent macro definitions needed for this layout
458 docstring babelpreamble_;
459 /// Are adjacent paragraphs handled as one group?
461 /// Packages needed for this layout
462 std::set<std::string> requires_;
464 LaTeXArgMap latexargs_;
466 LaTeXArgMap postcommandargs_;
468 LaTeXArgMap itemargs_;
472 std::string toc_type_;
474 bool is_toc_caption_;