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