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