src/Layout.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Layout.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author André Pönitz
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef LAYOUT_H
  15 #define LAYOUT_H
  16
  17 #include "FontInfo.h"
  18 #include "LayoutEnums.h"
  19 #include "Spacing.h"
  20 #include "support/debug.h"
  21 #include "support/docstring.h"
  22
  23 #include <map>
  24 #include <set>
  25 #include <string>
  26
  27 namespace lyx {
  28
  29 class Lexer;
  30 class TextClass;
  31
  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.
  38  */
  39
  40
  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.
  46  *
  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!
  49  */
  50
  51 ///
  52 class Layout {
  53 public:
  54         ///
  55         Layout();
  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 &);
  62         ///
  63         void readAlign(Lexer &);
  64         ///
  65         void readAlignPossible(Lexer &);
  66         ///
  67         void readLabelType(Lexer &);
  68         ///
  69         void readEndLabelType(Lexer &);
  70         ///
  71         void readMargin(Lexer &);
  72         ///
  73         void readLatexType(Lexer &);
  74         ///
  75         void readSpacing(Lexer &);
  76         ///
  77         void readArgument(Lexer &);
  78         ///
  79         docstring const & name() const { return name_; }
  80         ///
  81         void setName(docstring const & n) { name_ = n; }
  82         ///
  83         docstring const & obsoleted_by() const { return obsoleted_by_; }
  84         ///
  85         docstring const & depends_on() const { return depends_on_; }
  86         ///
  87         std::string const & latexname() const { return latexname_; }
  88         ///
  89         void setLatexName(std::string const & n) { latexname_ = n; }
  90         /// The arguments of this layout
  91         struct latexarg {
  92                 docstring labelstring;
  93                 bool mandatory;
  94                 docstring ldelim;
  95                 docstring rdelim;
  96                 docstring tooltip;
  97                 std::string requires;
  98                 std::string decoration;
  99                 FontInfo font;
 100                 FontInfo labelfont;
 101         };
 102         ///
 103         typedef std::map<unsigned int, latexarg> LaTeXArgMap;
 104         ///
 105         LaTeXArgMap const & latexargs() const { return latexargs_; }
 106         ///
 107         int optArgs() const;
 108         ///
 109         int requiredArgs() const;
 110         ///
 111         docstring const & labelstring(bool in_appendix) const
 112         { return in_appendix ? labelstring_appendix_ : labelstring_; }
 113         ///
 114         docstring const & endlabelstring() const { return endlabelstring_; }
 115         ///
 116         docstring const & category() const { return category_; }
 117         ///
 118         docstring const & preamble() const { return preamble_; }
 119         /// Get language dependent macro definitions needed for this layout
 120         /// for language \p lang
 121         docstring const langpreamble() const { return langpreamble_; }
 122         /// Get language and babel dependent macro definitions needed for
 123         /// this layout for language \p lang
 124         docstring const babelpreamble() const { return babelpreamble_; }
 125         ///
 126         std::set<std::string> const & requires() const { return requires_; }
 127         ///
 128         std::string const & latexparam() const { return latexparam_; }
 129         ///
 130         docstring leftdelim() const { return leftdelim_; }
 131         ///
 132         docstring rightdelim() const { return rightdelim_; }
 133         ///
 134         std::string const & innertag() const { return innertag_; }
 135         ///
 136         std::string const & labeltag() const { return labeltag_; }
 137         ///
 138         std::string const & itemtag() const { return itemtag_; }
 139         ///
 140         std::string const & htmltag() const;
 141         ///
 142         std::string const & htmlattr() const;
 143         ///
 144         std::string const & htmlitemtag() const;
 145         ///
 146         std::string const & htmlitemattr() const;
 147         ///
 148         std::string const & htmllabeltag() const;
 149         ///
 150         std::string const & htmllabelattr() const;
 151         ///
 152         std::string defaultCSSClass() const;
 153         ///
 154         bool htmllabelfirst() const { return htmllabelfirst_; }
 155         ///
 156         docstring htmlstyle() const;
 157         ///
 158         docstring const & htmlpreamble() const { return htmlpreamble_; }
 159         ///
 160         bool htmltitle() const { return htmltitle_; }
 161         ///
 162         bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
 163         ///
 164         bool isCommand() const { return latextype == LATEX_COMMAND; }
 165         ///
 166         bool isEnvironment() const {
 167                 return latextype == LATEX_ENVIRONMENT
 168                         || latextype == LATEX_BIB_ENVIRONMENT
 169                         || latextype == LATEX_ITEM_ENVIRONMENT
 170                         || latextype == LATEX_LIST_ENVIRONMENT;
 171         }
 172
 173         ///
 174         bool operator==(Layout const &) const;
 175         ///
 176         bool operator!=(Layout const & rhs) const
 177                 { return !(*this == rhs); }
 178
 179         ////////////////////////////////////////////////////////////////
 180         // members
 181         ////////////////////////////////////////////////////////////////
 182         /** Default font for this layout/environment.
 183             The main font for this kind of environment. If an attribute has
 184             INHERITED_*, it means that the value is specified by
 185             the defaultfont for the entire layout. If we are nested, the
 186             font is inherited from the font in the environment one level
 187             up until the font is resolved. The values :IGNORE_*
 188             and FONT_TOGGLE are illegal here.
 189         */
 190         FontInfo font;
 191
 192         /** Default font for labels.
 193             Interpretation the same as for font above
 194         */
 195         FontInfo labelfont;
 196
 197         /** Resolved version of the font for this layout/environment.
 198             This is a resolved version the default font. The font is resolved
 199             against the defaultfont of the entire layout.
 200         */
 201         FontInfo resfont;
 202
 203         /** Resolved version of the font used for labels.
 204             This is a resolved version the label font. The font is resolved
 205             against the defaultfont of the entire layout.
 206         */
 207         FontInfo reslabelfont;
 208
 209         /// Text that dictates how wide the left margin is on the screen
 210         docstring leftmargin;
 211         /// Text that dictates how wide the right margin is on the screen
 212         docstring rightmargin;
 213         /// Text that dictates how much space to leave after a potential label
 214         docstring labelsep;
 215         /// Text that dictates how much space to leave before a potential label
 216         docstring labelindent;
 217         /// Text that dictates the width of the indentation of indented pars
 218         docstring parindent;
 219         ///
 220         double parskip;
 221         ///
 222         double itemsep;
 223         ///
 224         double topsep;
 225         ///
 226         double bottomsep;
 227         ///
 228         double labelbottomsep;
 229         ///
 230         double parsep;
 231         ///
 232         Spacing spacing;
 233         ///
 234         LyXAlignment align;
 235         ///
 236         LyXAlignment alignpossible;
 237         ///
 238         LabelType labeltype;
 239         ///
 240         EndLabelType endlabeltype;
 241         ///
 242         MarginType margintype;
 243         ///
 244         bool newline_allowed;
 245         ///
 246         bool nextnoindent;
 247         ///
 248         bool free_spacing;
 249         ///
 250         bool pass_thru;
 251         ///
 252         bool parbreak_is_newline;
 253         /// show this in toc
 254         int toclevel;
 255         /// special value of toclevel for non-section layouts
 256         static const int NOT_IN_TOC;
 257
 258         /** true when the fragile commands in the paragraph need to be
 259             \protect'ed. */
 260         bool needprotect;
 261         /// true when empty paragraphs should be kept.
 262         bool keepempty;
 263         /// Type of LaTeX object
 264         LatexType latextype;
 265         /// Does this object belong in the title part of the document?
 266         bool intitle;
 267         /// Is the content to go in the preamble rather than the body?
 268         bool inpreamble;
 269         /// Which counter to step
 270         docstring counter;
 271         /// Prefix to use when creating labels
 272         docstring refprefix;
 273         /// Depth of XML command
 274         int commanddepth;
 275
 276         /// Return a pointer on a new layout suitable to describe a caption.
 277         /// FIXME: remove this eventually. This is only for tex2lyx
 278         /// until it has proper support for the caption inset (JMarc)
 279         static Layout * forCaption();
 280
 281         /// Is this spellchecked?
 282         bool spellcheck;
 283
 284
 285 private:
 286         /// generates the default CSS for this layout
 287         void makeDefaultCSS() const;
 288         ///
 289         std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
 290         ///
 291         std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
 292
 293         /// Name of the layout/paragraph environment
 294         docstring name_;
 295
 296         /// LaTeX name for environment
 297         std::string latexname_;
 298
 299         /** Is this layout the default layout for an unknown layout? If
 300          * so, its name will be displayed as xxx (unknown).
 301          */
 302         bool unknown_;
 303
 304         /** Name of an layout that has replaced this layout.
 305             This is used to rename a layout, while keeping backward
 306             compatibility
 307         */
 308         docstring obsoleted_by_;
 309
 310         /** Name of an layout which preamble must come before this one
 311             This is used when the preamble snippet uses macros defined in
 312             another preamble
 313          */
 314         docstring depends_on_;
 315
 316         /// Label string. "Abstract", "Reference", "Caption"...
 317         docstring labelstring_;
 318         ///
 319         docstring endlabelstring_;
 320         /// Label string inside appendix. "Appendix", ...
 321         docstring labelstring_appendix_;
 322         /// LaTeX parameter for environment
 323         std::string latexparam_;
 324         /// Left delimiter of the content
 325         docstring leftdelim_;
 326         /// Right delimiter of the content
 327         docstring rightdelim_;
 328         /// Internal tag to use (e.g., <title></title> for sect header)
 329         std::string innertag_;
 330         /// Internal tag to use (e.g. to surround varentrylist label)
 331         std::string labeltag_;
 332         /// Internal tag to surround the item text in a list.
 333         std::string itemtag_;
 334         /// The interpretation of this tag varies depending upon the latextype.
 335         /// In an environment, it is the tag enclosing all content for this set of
 336         /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
 337         /// it would be: ul. (You get the idea.)
 338         ///
 339         /// For a command, it is the tag enclosing the content of the command.
 340         /// So, for section, it might be: h2.
 341         ///
 342         /// For the paragraph type, it is the tag that will enclose each paragraph.
 343         ///
 344         /// Defaults to "div".
 345         mutable std::string htmltag_;
 346         /// Additional attributes for inclusion with the start tag. Defaults
 347         /// to: class="layoutname".
 348         mutable std::string htmlattr_;
 349         /// Tag for individual paragraphs in an environment. In lists, this
 350         /// would be something like "li". But it also needs to be set for
 351         /// quotation, e.g., since the paragraphs in a quote need to be
 352         /// in "p" tags. Default is "div".
 353         /// Note that when I said "environment", I meant it: This has no
 354         /// effect for LATEX_PARAGRAPH type layouts.
 355         mutable std::string htmlitemtag_;
 356         /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
 357         mutable std::string htmlitemattr_;
 358         /// Tag for labels, of whatever sort. One use for this is in setting
 359         /// descriptions, in which case it would be: dt. Another use is to
 360         /// customize the display of, say, the auto-generated label for
 361         /// sections. Defaults to "span".
 362         /// If set to "NONE", this suppresses the printing of the label.
 363         mutable std::string htmllabeltag_;
 364         /// Attributes for the label. Defaults to: class="layoutname_label".
 365         mutable std::string htmllabelattr_;
 366         /// Whether to put the label before the item, or within the item.
 367         /// I.e., do we have (true):
 368         ///    <label>...</label><item>...</item>
 369         /// or instead (false):
 370         ///    <item><label>...</label>...</item>
 371         /// The latter is the default.
 372         bool htmllabelfirst_;
 373         /// CSS information needed by this layout.
 374         docstring htmlstyle_;
 375         /// Should we generate the default CSS for this layout, even if HTMLStyle
 376         /// has been given? Default is false.
 377         /// Note that the default CSS is output first, then the user CSS, so it is
 378         /// possible to override what one does not want.
 379         bool htmlforcecss_;
 380         /// A cache for the default style info so generated.
 381         mutable docstring htmldefaultstyle_;
 382         /// Any other info for the HTML header.
 383         docstring htmlpreamble_;
 384         /// Whether this is the <title> paragraph.
 385         bool htmltitle_;
 386         /// calculating this is expensive, so we cache it.
 387         mutable std::string defaultcssclass_;
 388         /// This is the `category' for this layout. The following are
 389         /// recommended basic categories: FrontMatter, BackMatter, MainText,
 390         /// Section, Starred, List, Theorem.
 391         docstring category_;
 392         /// Macro definitions needed for this layout
 393         docstring preamble_;
 394         /// Language dependent macro definitions needed for this layout
 395         docstring langpreamble_;
 396         /// Language and babel dependent macro definitions needed for this layout
 397         docstring babelpreamble_;
 398         /// Packages needed for this layout
 399         std::set<std::string> requires_;
 400         ///
 401         LaTeXArgMap latexargs_;
 402 };
 403
 404 } // namespace lyx
 405
 406 #endif