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