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