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