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