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