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