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