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         docstring const & htmlstyle() const { return htmlstyle_; }
 125         ///
 126         docstring const & labelstring_appendix() const {
 127                 return labelstring_appendix_;
 128         }
 129         ///
 130         bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
 131         ///
 132         bool isCommand() const { return latextype == LATEX_COMMAND; }
 133         ///
 134         bool isEnvironment() const {
 135                 return latextype == LATEX_ENVIRONMENT
 136                         || latextype == LATEX_BIB_ENVIRONMENT
 137                         || latextype == LATEX_ITEM_ENVIRONMENT
 138                         || latextype == LATEX_LIST_ENVIRONMENT;
 139         }
 140
 141         ///
 142         bool operator==(Layout const &) const;
 143         ///
 144         bool operator!=(Layout const & rhs) const
 145                 { return !(*this == rhs); }
 146
 147         ////////////////////////////////////////////////////////////////
 148         // members
 149         ////////////////////////////////////////////////////////////////
 150         /** Default font for this layout/environment.
 151             The main font for this kind of environment. If an attribute has
 152             INHERITED_*, it means that the value is specified by
 153             the defaultfont for the entire layout. If we are nested, the
 154             font is inherited from the font in the environment one level
 155             up until the font is resolved. The values :IGNORE_*
 156             and FONT_TOGGLE are illegal here.
 157         */
 158         FontInfo font;
 159
 160         /** Default font for labels.
 161             Interpretation the same as for font above
 162         */
 163         FontInfo labelfont;
 164
 165         /** Resolved version of the font for this layout/environment.
 166             This is a resolved version the default font. The font is resolved
 167             against the defaultfont of the entire layout.
 168         */
 169         FontInfo resfont;
 170
 171         /** Resolved version of the font used for labels.
 172             This is a resolved version the label font. The font is resolved
 173             against the defaultfont of the entire layout.
 174         */
 175         FontInfo reslabelfont;
 176
 177         /// Text that dictates how wide the left margin is on the screen
 178         docstring leftmargin;
 179         /// Text that dictates how wide the right margin is on the screen
 180         docstring rightmargin;
 181         /// Text that dictates how much space to leave after a potential label
 182         docstring labelsep;
 183         /// Text that dictates how much space to leave before a potential label
 184         docstring labelindent;
 185         /// Text that dictates the width of the indentation of indented pars
 186         docstring parindent;
 187         ///
 188         double parskip;
 189         ///
 190         double itemsep;
 191         ///
 192         double topsep;
 193         ///
 194         double bottomsep;
 195         ///
 196         double labelbottomsep;
 197         ///
 198         double parsep;
 199         ///
 200         Spacing spacing;
 201         ///
 202         LyXAlignment align;
 203         ///
 204         LyXAlignment alignpossible;
 205         ///
 206         LabelType labeltype;
 207         ///
 208         EndLabelType endlabeltype;
 209         ///
 210         MarginType margintype;
 211         ///
 212         bool fill_top;
 213         ///
 214         bool fill_bottom;
 215         ///
 216         bool newline_allowed;
 217         ///
 218         bool nextnoindent;
 219         ///
 220         bool free_spacing;
 221         ///
 222         bool pass_thru;
 223         /// show this in toc
 224         int toclevel;
 225         /// special value of toclevel for non-section layouts
 226         static const int NOT_IN_TOC;
 227
 228         /** true when the fragile commands in the paragraph need to be
 229             \protect'ed. */
 230         bool needprotect;
 231         /// true when empty paragraphs should be kept.
 232         bool keepempty;
 233         /// Type of LaTeX object
 234         LatexType latextype;
 235         /// Does this object belong in the title part of the document?
 236         bool intitle;
 237         /// Does this layout allow for an optional parameter?
 238         int optionalargs;
 239         /// Which counter to step
 240         docstring counter;
 241         /// Depth of XML command
 242         int commanddepth;
 243
 244         /// Return a pointer on a new layout suitable to describe a caption.
 245         /// FIXME: remove this eventually. This is only for tex2lyx
 246         /// until it has proper support for the caption inset (JMarc)
 247         static Layout * forCaption();
 248
 249
 250 private:
 251         /// Name of the layout/paragraph environment
 252         docstring name_;
 253
 254         /// LaTeX name for environment
 255         std::string latexname_;
 256
 257         /** Is this layout the default layout for an unknown layout? If
 258          * so, its name will be displayed as xxx (unknown).
 259          */
 260         bool unknown_;
 261
 262         /** Name of an layout that has replaced this layout.
 263             This is used to rename a layout, while keeping backward
 264             compatibility
 265         */
 266         docstring obsoleted_by_;
 267
 268         /** Name of an layout which preamble must come before this one
 269             This is used when the preamble snippet uses macros defined in
 270             another preamble
 271          */
 272         docstring depends_on_;
 273
 274         /// Label string. "Abstract", "Reference", "Caption"...
 275         docstring labelstring_;
 276         ///
 277         docstring endlabelstring_;
 278         /// Label string inside appendix. "Appendix", ...
 279         docstring labelstring_appendix_;
 280         /// LaTeX parameter for environment
 281         std::string latexparam_;
 282         /// Internal tag to use (e.g., <title></title> for sect header)
 283         std::string innertag_;
 284         /// Internal tag to use e.g. to surround varlistentry label)
 285         std::string labeltag_;
 286         /// Internal tag to surround the item text in a list)
 287         std::string itemtag_;
 288         /// Tag for HTML output, e.g., h2.
 289         std::string htmltag_;
 290         /// Additional attributes for inclusion with the start tag,
 291         /// e.g.: class='section'.
 292         std::string htmlattr_;
 293         /// Tag for individual paragraphs in an environment. In lists, this
 294         /// would be something like "li". But it also needs to be set for
 295         /// quotation, e.g., since the paragraphs in a quote need to be
 296         /// in "p" tags.
 297         std::string htmlitem_;
 298         /// Attributes for htmlitem_
 299         std::string htmlitemattr_;
 300         /// Tag for labels, of whatever sort. One use for this is in setting
 301         /// descriptions, in which case it would be: dt. Another use is to
 302         /// customize the display of, say, the auto-generated label for
 303         /// sections (in that case, it might be: span).
 304         std::string htmllabel_;
 305         /// Attributes for the label.
 306         std::string htmllabelattr_;
 307         /// CSS information needed by this layout.
 308         docstring htmlstyle_;
 309         /// This is the `category' for this layout. The following are
 310         /// recommended basic categories: FrontMatter, BackMatter, MainText,
 311         /// Section, Starred, List, Theorem.
 312         docstring category_;
 313         /// Macro definitions needed for this layout
 314         docstring preamble_;
 315         /// Language dependent macro definitions needed for this layout
 316         docstring langpreamble_;
 317         /// Language and babel dependent macro definitions needed for this layout
 318         docstring babelpreamble_;
 319         /// Packages needed for this layout
 320         std::set<std::string> requires_;
 321 };
 322
 323 } // namespace lyx
 324
 325 #endif