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/docstring.h"
  21
  22 #include <set>
  23 #include <string>
  24
  25 namespace lyx {
  26
  27 class Language;
  28 class Lexer;
  29 class TextClass;
  30
  31 /* Fix labels are printed flushright, manual labels flushleft.
  32  * MARGIN_MANUAL and MARGIN_FIRST_DYNAMIC are *only* for LABEL_MANUAL,
  33  * MARGIN_DYNAMIC and MARGIN_STATIC are *not* for LABEL_MANUAL.
  34  * This seems a funny restriction, but I think other combinations are
  35  * not needed, so I will not change it yet.
  36  * Correction: MARGIN_FIRST_DYNAMIC also usable with LABEL_STATIC
  37  */
  38
  39
  40 /* There is a parindent and a parskip. Which one is used depends on the
  41  * paragraph_separation-flag of the text-object.
  42  * BUT: parindent is only thrown away, if a parskip is defined! So if you
  43  * want a space between the paragraphs and a parindent at the same time,
  44  * you should set parskip to zero and use topsep, parsep and bottomsep.
  45  *
  46  * The standard layout is an exception: its parindent is only set, if the
  47  * previous paragraph is standard too. Well, this is LateX and it is good!
  48  */
  49
  50 ///
  51 class Layout {
  52 public:
  53         ///
  54         Layout();
  55         /// is this layout a default layout created for an unknown layout
  56         bool isUnknown() const { return unknown_; }
  57         void setUnknown(bool unknown) { unknown_ = unknown; }
  58         /// Reads a layout definition from file
  59         /// \return true on success.
  60         bool read(Lexer &, TextClass const &);
  61         ///
  62         void readAlign(Lexer &);
  63         ///
  64         void readAlignPossible(Lexer &);
  65         ///
  66         void readLabelType(Lexer &);
  67         ///
  68         void readEndLabelType(Lexer &);
  69         ///
  70         void readMargin(Lexer &);
  71         ///
  72         void readLatexType(Lexer &);
  73         ///
  74         void readSpacing(Lexer &);
  75         ///
  76         docstring const & name() const { return name_; };
  77         ///
  78         void setName(docstring const & n) { name_ = n; }
  79         ///
  80         docstring const & obsoleted_by() const { return obsoleted_by_; }
  81         ///
  82         docstring const & depends_on() const { return depends_on_; }
  83         ///
  84         std::string const & latexname() const { return latexname_; }
  85         ///
  86         void setLatexName(std::string const & n) { latexname_ = n; }
  87         ///
  88         docstring const & labelstring() const { return labelstring_; }
  89         ///
  90         docstring const & endlabelstring() const { return endlabelstring_; }
  91         ///
  92         docstring const & category() const { return category_; }
  93         ///
  94         docstring const & preamble() const { return preamble_; }
  95         /// Get language dependent macro definitions needed for this layout
  96         /// for language \p lang
  97         docstring const langpreamble(Language const * lang) const;
  98         /// Get language and babel dependent macro definitions needed for
  99         /// this layout for language \p lang
 100         docstring const babelpreamble(Language const * lang) const;
 101         ///
 102         std::set<std::string> const & requires() const { return requires_; }
 103         ///
 104         std::string const & latexparam() const { return latexparam_; }
 105         ///
 106         std::string const & innertag() const { return innertag_; }
 107         ///
 108         std::string const & labeltag() const { return labeltag_; }
 109         ///
 110         std::string const & itemtag() const { return itemtag_; }
 111         ///
 112         std::string const & htmltag() const { return htmltag_; }
 113         ///
 114         std::string const & htmlattr() const { return htmlattr_; }
 115         ///
 116         std::string const & htmlitem() const { return htmlitem_; }
 117         ///
 118         std::string const & htmlitemattr() const { return htmlitemattr_; }
 119         ///
 120         std::string const & htmllabel() const { return htmllabel_; }
 121         ///
 122         std::string const & htmllabelattr() const { return htmllabelattr_; }
 123         ///
 124         bool htmllabelfirst() const { return htmllabelfirst_; }
 125         ///
 126         docstring const & htmlstyle() const { return htmlstyle_; }
 127         ///
 128         docstring const & htmlpreamble() const { return htmlpreamble_; }
 129         ///
 130         docstring const & labelstring_appendix() const {
 131                 return labelstring_appendix_;
 132         }
 133         ///
 134         bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
 135         ///
 136         bool isCommand() const { return latextype == LATEX_COMMAND; }
 137         ///
 138         bool isEnvironment() const {
 139                 return latextype == LATEX_ENVIRONMENT
 140                         || latextype == LATEX_BIB_ENVIRONMENT
 141                         || latextype == LATEX_ITEM_ENVIRONMENT
 142                         || latextype == LATEX_LIST_ENVIRONMENT;
 143         }
 144
 145         ///
 146         bool operator==(Layout const &) const;
 147         ///
 148         bool operator!=(Layout const & rhs) const
 149                 { return !(*this == rhs); }
 150
 151         ////////////////////////////////////////////////////////////////
 152         // members
 153         ////////////////////////////////////////////////////////////////
 154         /** Default font for this layout/environment.
 155             The main font for this kind of environment. If an attribute has
 156             INHERITED_*, it means that the value is specified by
 157             the defaultfont for the entire layout. If we are nested, the
 158             font is inherited from the font in the environment one level
 159             up until the font is resolved. The values :IGNORE_*
 160             and FONT_TOGGLE are illegal here.
 161         */
 162         FontInfo font;
 163
 164         /** Default font for labels.
 165             Interpretation the same as for font above
 166         */
 167         FontInfo labelfont;
 168
 169         /** Resolved version of the font for this layout/environment.
 170             This is a resolved version the default font. The font is resolved
 171             against the defaultfont of the entire layout.
 172         */
 173         FontInfo resfont;
 174
 175         /** Resolved version of the font used for labels.
 176             This is a resolved version the label font. The font is resolved
 177             against the defaultfont of the entire layout.
 178         */
 179         FontInfo reslabelfont;
 180
 181         /// Text that dictates how wide the left margin is on the screen
 182         docstring leftmargin;
 183         /// Text that dictates how wide the right margin is on the screen
 184         docstring rightmargin;
 185         /// Text that dictates how much space to leave after a potential label
 186         docstring labelsep;
 187         /// Text that dictates how much space to leave before a potential label
 188         docstring labelindent;
 189         /// Text that dictates the width of the indentation of indented pars
 190         docstring parindent;
 191         ///
 192         double parskip;
 193         ///
 194         double itemsep;
 195         ///
 196         double topsep;
 197         ///
 198         double bottomsep;
 199         ///
 200         double labelbottomsep;
 201         ///
 202         double parsep;
 203         ///
 204         Spacing spacing;
 205         ///
 206         LyXAlignment align;
 207         ///
 208         LyXAlignment alignpossible;
 209         ///
 210         LabelType labeltype;
 211         ///
 212         EndLabelType endlabeltype;
 213         ///
 214         MarginType margintype;
 215         ///
 216         bool fill_top;
 217         ///
 218         bool fill_bottom;
 219         ///
 220         bool newline_allowed;
 221         ///
 222         bool nextnoindent;
 223         ///
 224         bool free_spacing;
 225         ///
 226         bool pass_thru;
 227         /// show this in toc
 228         int toclevel;
 229         /// special value of toclevel for non-section layouts
 230         static const int NOT_IN_TOC;
 231
 232         /** true when the fragile commands in the paragraph need to be
 233             \protect'ed. */
 234         bool needprotect;
 235         /// true when empty paragraphs should be kept.
 236         bool keepempty;
 237         /// Type of LaTeX object
 238         LatexType latextype;
 239         /// Does this object belong in the title part of the document?
 240         bool intitle;
 241         /// Does this layout allow for an optional parameter?
 242         int optionalargs;
 243         /// Which counter to step
 244         docstring counter;
 245         /// Depth of XML command
 246         int commanddepth;
 247
 248         /// Return a pointer on a new layout suitable to describe a caption.
 249         /// FIXME: remove this eventually. This is only for tex2lyx
 250         /// until it has proper support for the caption inset (JMarc)
 251         static Layout * forCaption();
 252
 253
 254 private:
 255         /// Name of the layout/paragraph environment
 256         docstring name_;
 257
 258         /// LaTeX name for environment
 259         std::string latexname_;
 260
 261         /** Is this layout the default layout for an unknown layout? If
 262          * so, its name will be displayed as xxx (unknown).
 263          */
 264         bool unknown_;
 265
 266         /** Name of an layout that has replaced this layout.
 267             This is used to rename a layout, while keeping backward
 268             compatibility
 269         */
 270         docstring obsoleted_by_;
 271
 272         /** Name of an layout which preamble must come before this one
 273             This is used when the preamble snippet uses macros defined in
 274             another preamble
 275          */
 276         docstring depends_on_;
 277
 278         /// Label string. "Abstract", "Reference", "Caption"...
 279         docstring labelstring_;
 280         ///
 281         docstring endlabelstring_;
 282         /// Label string inside appendix. "Appendix", ...
 283         docstring labelstring_appendix_;
 284         /// LaTeX parameter for environment
 285         std::string latexparam_;
 286         /// Internal tag to use (e.g., <title></title> for sect header)
 287         std::string innertag_;
 288         /// Internal tag to use e.g. to surround varlistentry label)
 289         std::string labeltag_;
 290         /// Internal tag to surround the item text in a list)
 291         std::string itemtag_;
 292         /// Tag for HTML output, e.g., h2.
 293         std::string htmltag_;
 294         /// Additional attributes for inclusion with the start tag,
 295         /// e.g.: class='section'.
 296         std::string htmlattr_;
 297         /// Tag for individual paragraphs in an environment. In lists, this
 298         /// would be something like "li". But it also needs to be set for
 299         /// quotation, e.g., since the paragraphs in a quote need to be
 300         /// in "p" tags.
 301         std::string htmlitem_;
 302         /// Attributes for htmlitem_
 303         std::string htmlitemattr_;
 304         /// Tag for labels, of whatever sort. One use for this is in setting
 305         /// descriptions, in which case it would be: dt. Another use is to
 306         /// customize the display of, say, the auto-generated label for
 307         /// sections (in that case, it might be: span).
 308         std::string htmllabel_;
 309         /// Attributes for the label.
 310         std::string htmllabelattr_;
 311         /// Whether to put the label before the item, or within the item.
 312         /// I.e., do we have (true):
 313         ///    <label>...</label><item>...</item>
 314         /// or instead (false):
 315         ///    <item><label>...</label>...</item>
 316         /// The latter is the default.
 317         bool htmllabelfirst_;
 318         /// CSS information needed by this layout.
 319         docstring htmlstyle_;
 320         /// Any other info for the HTML header.
 321         docstring htmlpreamble_;
 322         /// This is the `category' for this layout. The following are
 323         /// recommended basic categories: FrontMatter, BackMatter, MainText,
 324         /// Section, Starred, List, Theorem.
 325         docstring category_;
 326         /// Macro definitions needed for this layout
 327         docstring preamble_;
 328         /// Language dependent macro definitions needed for this layout
 329         docstring langpreamble_;
 330         /// Language and babel dependent macro definitions needed for this layout
 331         docstring babelpreamble_;
 332         /// Packages needed for this layout
 333         std::set<std::string> requires_;
 334 };
 335
 336 } // namespace lyx
 337
 338 #endif