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 &, bool validating = false);
  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 &, bool);
  78         /// Write a layout definition in utf8 encoding
  79         void write(std::ostream &) const;
  80         ///
  81         docstring const & name() const { return name_; }
  82         ///
  83         void setName(docstring const & n) { name_ = n; }
  84         ///
  85         docstring const & obsoleted_by() const { return obsoleted_by_; }
  86         ///
  87         docstring const & depends_on() const { return depends_on_; }
  88         ///
  89         std::string const & latexname() const { return latexname_; }
  90         ///
  91         std::string const & itemcommand() const { return itemcommand_; }
  92         /// The arguments of this layout
  93         struct latexarg {
  94                 docstring labelstring;
  95                 docstring menustring;
  96                 bool mandatory = false;
  97                 bool nodelims = false;
  98                 docstring ldelim;
  99                 docstring rdelim;
 100                 docstring defaultarg;
 101                 docstring presetarg;
 102                 docstring tooltip;
 103                 std::string required;
 104                 std::string decoration;
 105                 FontInfo font = inherit_font;
 106                 FontInfo labelfont = inherit_font;
 107                 bool autoinsert = false;
 108                 bool insertcotext = false;
 109                 bool insertonnewline = false;
 110                 ArgPassThru passthru = PT_INHERITED;
 111                 docstring pass_thru_chars;
 112                 bool is_toc_caption = false;
 113                 bool free_spacing = false;
 114                 std::string newlinecmd;
 115                 docstring docbooktag;
 116                 docstring docbooktagtype;
 117                 docstring docbookattr;
 118                 bool docbookargumentbeforemaintag = false;
 119         };
 120         ///
 121         typedef std::map<std::string, latexarg> LaTeXArgMap;
 122         ///
 123         LaTeXArgMap const & latexargs() const { return latexargs_; }
 124         ///
 125         LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
 126         ///
 127         LaTeXArgMap const & listpreamble() const { return listpreamble_; }
 128         ///
 129         LaTeXArgMap const & itemargs() const { return itemargs_; }
 130         /// Returns true is the layout has arguments. If false, then an
 131         /// InsetArgument in this layout stands for the parent InsetText.
 132         bool hasArgs() const;
 133         /// Returns latexargs() + postcommandargs() + itemargs().
 134         /// But note that it returns a *copy*, not a reference, so do not do
 135         /// anything like:
 136         ///   Layout::LaTeXArgMap::iterator it = args().begin();
 137         ///   Layout::LaTeXArgMap::iterator en = args().end();
 138         /// Those are iterators for different containers.
 139         LaTeXArgMap args() const;
 140         ///
 141         int optArgs() const;
 142         ///
 143         int requiredArgs() const;
 144         ///
 145         docstring const & labelstring(bool in_appendix) const
 146         { return in_appendix ? labelstring_appendix_ : labelstring_; }
 147         ///
 148         docstring const & endlabelstring() const { return endlabelstring_; }
 149         ///
 150         docstring const & category() const { return category_; }
 151         ///
 152         docstring const & preamble() const { return preamble_; }
 153         /// Get language dependent macro definitions needed for this layout
 154         /// for language \p lang
 155         docstring const langpreamble() const { return langpreamble_; }
 156         /// Get language and babel dependent macro definitions needed for
 157         /// this layout for language \p lang
 158         docstring const babelpreamble() const { return babelpreamble_; }
 159         ///
 160         std::set<std::string> const & required() const { return required_; }
 161         ///
 162         std::set<docstring> const & autonests() const { return autonests_; }
 163         ///
 164         std::set<docstring> const & isAutonestedBy() const { return autonested_by_; }
 165         ///
 166         std::string const & latexparam() const { return latexparam_; }
 167         ///
 168         docstring leftdelim() const { return leftdelim_; }
 169         ///
 170         docstring rightdelim() const { return rightdelim_; }
 171         ///
 172         std::string const & innertag() const { return innertag_; }
 173         ///
 174         std::string const & labeltag() const { return labeltag_; }
 175         ///
 176         std::string const & itemtag() const { return itemtag_; }
 177         ///
 178         std::string const & htmltag() const;
 179         ///
 180         std::string const & htmlattr() const;
 181         ///
 182         std::string const & htmlitemtag() const;
 183         ///
 184         std::string const & htmlitemattr() const;
 185         ///
 186         std::string const & htmllabeltag() const;
 187         ///
 188         std::string const & htmllabelattr() const;
 189         ///
 190         std::string defaultCSSClass() const;
 191         ///
 192         bool htmllabelfirst() const { return htmllabelfirst_; }
 193         ///
 194         docstring htmlstyle() const;
 195         ///
 196         docstring const & htmlpreamble() const { return htmlpreamble_; }
 197         ///
 198         bool htmltitle() const { return htmltitle_; }
 199         ///
 200         std::string const & docbooktag() const;
 201         ///
 202         std::string const & docbookattr() const;
 203         ///
 204         std::string const & docbooktagtype() const;
 205         ///
 206         std::string const & docbookinnertag() const;
 207         ///
 208         std::string const & docbookinnerattr() const;
 209         ///
 210         std::string const & docbookinnertagtype() const;
 211         ///
 212         std::string const & docbookininfo() const;
 213         ///
 214         bool docbookabstract() const { return docbookabstract_; }
 215         ///
 216         std::string const & docbookwrappertag() const;
 217         ///
 218         std::string const & docbookwrapperattr() const;
 219         ///
 220         std::string const & docbookwrappertagtype() const;
 221         ///
 222         bool docbookwrappermergewithprevious() const { return docbookwrappermergewithprevious_; }
 223         ///
 224         std::string const & docbooksectiontag() const;
 225         ///
 226         bool docbooksection() const { return docbooksection_; }
 227         ///
 228         std::string const & docbookitemwrappertag() const;
 229         ///
 230         std::string const & docbookitemwrapperattr() const;
 231         ///
 232         std::string const & docbookitemwrappertagtype() const;
 233         ///
 234         std::string const & docbookitemlabeltag() const;
 235         ///
 236         std::string const & docbookitemlabelattr() const;
 237         ///
 238         std::string const & docbookitemlabeltagtype() const;
 239         ///
 240         std::string const & docbookiteminnertag() const;
 241         ///
 242         std::string const & docbookiteminnerattr() const;
 243         ///
 244         std::string const & docbookiteminnertagtype() const;
 245         ///
 246         std::string const & docbookitemtag() const;
 247         ///
 248         std::string const & docbookitemattr() const;
 249         ///
 250         std::string const & docbookitemtagtype() const;
 251         ///
 252         std::string const & docbookforceabstracttag() const;
 253         ///
 254         bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
 255         ///
 256         bool isCommand() const { return latextype == LATEX_COMMAND; }
 257         ///
 258         bool isEnvironment() const {
 259                 return latextype == LATEX_ENVIRONMENT
 260                         || latextype == LATEX_BIB_ENVIRONMENT
 261                         || latextype == LATEX_ITEM_ENVIRONMENT
 262                         || latextype == LATEX_LIST_ENVIRONMENT;
 263         }
 264         /// Is this the kind of layout in which adjacent paragraphs
 265         /// are handled as one group?
 266         bool isParagraphGroup() const { return par_group_; }
 267         ///
 268         bool labelIsInline() const {
 269                 return labeltype == LABEL_STATIC
 270                         || labeltype == LABEL_SENSITIVE
 271                         || labeltype == LABEL_ENUMERATE
 272                         || labeltype == LABEL_ITEMIZE;
 273         }
 274         bool labelIsAbove() const {
 275                 return labeltype == LABEL_ABOVE
 276                         || labeltype == LABEL_CENTERED
 277                         || labeltype == LABEL_BIBLIO;
 278         }
 279         ///
 280         bool addToToc() const { return add_to_toc_; }
 281         ///
 282         std::string tocType() const { return toc_type_; }
 283         ///
 284         bool isTocCaption() const { return is_toc_caption_; }
 285
 286         ///
 287         bool operator==(Layout const &) const;
 288         ///
 289         bool operator!=(Layout const & rhs) const
 290                 { return !(*this == rhs); }
 291
 292         ////////////////////////////////////////////////////////////////
 293         // members
 294         ////////////////////////////////////////////////////////////////
 295         /** Default font for this layout/environment.
 296             The main font for this kind of environment. If an attribute has
 297             INHERITED_*, it means that the value is specified by
 298             the defaultfont for the entire layout. If we are nested, the
 299             font is inherited from the font in the environment one level
 300             up until the font is resolved. The values :IGNORE_*
 301             and FONT_TOGGLE are illegal here.
 302         */
 303         FontInfo font;
 304
 305         /** Default font for labels.
 306             Interpretation the same as for font above
 307         */
 308         FontInfo labelfont;
 309
 310         /** Resolved version of the font for this layout/environment.
 311             This is a resolved version the default font. The font is resolved
 312             against the defaultfont of the entire layout.
 313         */
 314         FontInfo resfont;
 315
 316         /** Resolved version of the font used for labels.
 317             This is a resolved version the label font. The font is resolved
 318             against the defaultfont of the entire layout.
 319         */
 320         FontInfo reslabelfont;
 321
 322         /// Text that dictates how wide the left margin is on the screen
 323         docstring leftmargin;
 324         /// Text that dictates how wide the right margin is on the screen
 325         docstring rightmargin;
 326         /// Text that dictates how much space to leave after a potential label
 327         docstring labelsep;
 328         /// Text that dictates how much space to leave before a potential label
 329         docstring labelindent;
 330         /// Text that dictates the width of the indentation of indented pars
 331         docstring parindent;
 332         ///
 333         double parskip;
 334         ///
 335         double itemsep;
 336         ///
 337         double topsep;
 338         ///
 339         double bottomsep;
 340         ///
 341         double labelbottomsep;
 342         ///
 343         double parsep;
 344         ///
 345         Spacing spacing;
 346         ///
 347         LyXAlignment align;
 348         ///
 349         LyXAlignment alignpossible;
 350         ///
 351         LabelType labeltype;
 352         ///
 353         EndLabelType endlabeltype;
 354         ///
 355         MarginType margintype;
 356         ///
 357         bool newline_allowed;
 358         ///
 359         bool nextnoindent;
 360         ///
 361         ToggleIndentation toggle_indent;
 362         ///
 363         bool free_spacing;
 364         ///
 365         bool pass_thru;
 366         /// Individual chars to be passed verbatim
 367         docstring pass_thru_chars;
 368         ///
 369         bool parbreak_is_newline;
 370         /// show this in toc
 371         int toclevel;
 372         /// special value of toclevel for non-section layouts
 373         static const int NOT_IN_TOC;
 374
 375         /** true when the fragile commands in the paragraph need to be
 376             \protect'ed. */
 377         bool needprotect;
 378         /** true when the verbatim stuff of this layout needs to be
 379             \cprotect'ed. */
 380         bool needcprotect;
 381         /** true when specific commands in this paragraph need to be
 382             protected in an \mbox. */
 383         bool needmboxprotect;
 384         /// true when empty paragraphs should be kept.
 385         bool keepempty;
 386         /// Type of LaTeX object
 387         LatexType latextype;
 388         /// Does this object belong in the title part of the document?
 389         bool intitle;
 390         /// Is the content to go in the preamble rather than the body?
 391         bool inpreamble;
 392         /// Which counter to step
 393         docstring counter;
 394         /// Resume counter?
 395         bool resumecounter;
 396         /// Step parent counter?
 397         bool stepparentcounter;
 398         /// Prefix to use when creating labels
 399         docstring refprefix;
 400         /// Depth of XML command
 401         int commanddepth;
 402
 403         /// Return a pointer on a new layout suitable to describe a caption.
 404         /// FIXME: remove this eventually. This is only for tex2lyx
 405         /// until it has proper support for the caption inset (JMarc)
 406         static Layout * forCaption();
 407
 408         /// Is this spellchecked?
 409         bool spellcheck;
 410         /**
 411          * Should this layout definition always be written to the document preamble?
 412          * Possible values are:
 413          *   0: Do not enforce local layout
 414          * >=1: Enforce local layout with version forcelocal
 415          *  -1: Enforce local layout with infinite version
 416          * On reading, the forced local layout is only used if its version
 417          * number is greater than the version number of the same layout in the
 418          * document class. Otherwise, it is ignored.
 419          */
 420         int forcelocal;
 421
 422
 423 private:
 424         /// Reads a layout definition from file
 425         /// \return true on success.
 426         bool readIgnoreForcelocal(Lexer &, TextClass const &, bool validating);
 427         /// generates the default CSS for this layout
 428         void makeDefaultCSS() const;
 429         ///
 430         std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
 431         ///
 432         std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
 433
 434         /// Name of the layout/paragraph environment
 435         docstring name_;
 436
 437         /// LaTeX name for environment
 438         std::string latexname_;
 439
 440         /** Is this layout the default layout for an unknown layout? If
 441          * so, its name will be displayed as xxx (unknown).
 442          */
 443         bool unknown_;
 444
 445         /** Name of an layout that has replaced this layout.
 446             This is used to rename a layout, while keeping backward
 447             compatibility
 448         */
 449         docstring obsoleted_by_;
 450
 451         /** Name of an layout which preamble must come before this one
 452             This is used when the preamble snippet uses macros defined in
 453             another preamble
 454          */
 455         docstring depends_on_;
 456
 457         /// Label string. "Abstract", "Reference", "Caption"...
 458         docstring labelstring_;
 459         ///
 460         docstring endlabelstring_;
 461         /// Label string inside appendix. "Appendix", ...
 462         docstring labelstring_appendix_;
 463         /// LaTeX parameter for environment
 464         std::string latexparam_;
 465         /// Item command in lists
 466         std::string itemcommand_;
 467         /// Left delimiter of the content
 468         docstring leftdelim_;
 469         /// Right delimiter of the content
 470         docstring rightdelim_;
 471         /// Internal tag to use (e.g., <title></title> for sect header)
 472         std::string innertag_;
 473         /// Internal tag to use (e.g. to surround varentrylist label)
 474         std::string labeltag_;
 475         /// Internal tag to surround the item text in a list.
 476         std::string itemtag_;
 477         /// The interpretation of this tag varies depending upon the latextype.
 478         /// In an environment, it is the tag enclosing all content for this set of
 479         /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
 480         /// it would be: ul. (You get the idea.)
 481         ///
 482         /// For a command, it is the tag enclosing the content of the command.
 483         /// So, for section, it might be: h2.
 484         ///
 485         /// For the paragraph type, it is the tag that will enclose each paragraph.
 486         ///
 487         /// Defaults to "div".
 488         mutable std::string htmltag_;
 489         /// Additional attributes for inclusion with the start tag. Defaults
 490         /// to: class="layoutname".
 491         mutable std::string htmlattr_;
 492         /// Tag for individual paragraphs in an environment. In lists, this
 493         /// would be something like "li". But it also needs to be set for
 494         /// quotation, e.g., since the paragraphs in a quote need to be
 495         /// in "p" tags. Default is "div".
 496         /// Note that when I said "environment", I meant it: This has no
 497         /// effect for LATEX_PARAGRAPH type layouts.
 498         mutable std::string htmlitemtag_;
 499         /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
 500         mutable std::string htmlitemattr_;
 501         /// Tag for labels, of whatever sort. One use for this is in setting
 502         /// descriptions, in which case it would be: dt. Another use is to
 503         /// customize the display of, say, the auto-generated label for
 504         /// sections. Defaults to "span".
 505         /// If set to "NONE", this suppresses the printing of the label.
 506         mutable std::string htmllabeltag_;
 507         /// Attributes for the label. Defaults to: class="layoutname_label".
 508         mutable std::string htmllabelattr_;
 509         /// Whether to put the label before the item, or within the item.
 510         /// I.e., do we have (true):
 511         ///    <label>...</label><item>...</item>
 512         /// or instead (false):
 513         ///    <item><label>...</label>...</item>
 514         /// The latter is the default.
 515         bool htmllabelfirst_;
 516         /// CSS information needed by this layout.
 517         docstring htmlstyle_;
 518         /// DocBook tag corresponding to this layout.
 519         mutable std::string docbooktag_;
 520         /// Roles to add to docbooktag_, if any (default: none).
 521         mutable std::string docbookattr_;
 522         /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
 523         mutable std::string docbooktagtype_;
 524         /// DocBook inner tag corresponding to this layout.
 525         mutable std::string docbookinnertag_;
 526         /// Roles to add to docbookinnertag_, if any (default: none).
 527         mutable std::string docbookinnerattr_;
 528         /// DocBook inner-tag type corresponding to this layout (block, paragraph, or inline; default: block).
 529         mutable std::string docbookinnertagtype_;
 530         /// DocBook tag corresponding to this item (mainly for lists).
 531         mutable std::string docbookitemtag_;
 532         /// Roles to add to docbookitemtag_, if any (default: none).
 533         mutable std::string docbookitemattr_;
 534         /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
 535         mutable std::string docbookitemtagtype_;
 536         /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
 537         mutable std::string docbookitemwrappertag_;
 538         /// Roles to add to docbookitemwrappertag_, if any (default: none).
 539         mutable std::string docbookitemwrapperattr_;
 540         /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
 541         mutable std::string docbookitemwrappertagtype_;
 542         /// DocBook tag corresponding to this label (mostly for description lists;
 543         /// labels in the common sense do not exist with DocBook).
 544         mutable std::string docbookitemlabeltag_;
 545         /// Roles to add to docbooklabeltag_, if any (default: none).
 546         mutable std::string docbookitemlabelattr_;
 547         /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
 548         mutable std::string docbookitemlabeltagtype_;
 549         /// DocBook tag to add within the item, around its direct content (mainly for lists).
 550         mutable std::string docbookiteminnertag_;
 551         /// Roles to add to docbookiteminnertag_, if any (default: none).
 552         mutable std::string docbookiteminnerattr_;
 553         /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
 554         mutable std::string docbookiteminnertagtype_;
 555         /// DocBook tag corresponding to this wrapper around the main tag.
 556         mutable std::string docbookwrappertag_;
 557         /// Roles to add to docbookwrappertag_, if any (default: none).
 558         mutable std::string docbookwrapperattr_;
 559         /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
 560         mutable std::string docbookwrappertagtype_;
 561         /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
 562         bool docbookwrappermergewithprevious_;
 563         /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
 564         /// (default: section).
 565         mutable std::string docbooksectiontag_;
 566         /// Whether this element should be considered as a section-level element in DocBook.
 567         bool docbooksection_;
 568         /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
 569         mutable std::string docbookininfo_;
 570         /// Wehther this paragraph should be considered as abstract.
 571         bool docbookabstract_;
 572         /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
 573         /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
 574         /// held by this attribute
 575         mutable std::string docbookforceabstracttag_;
 576         /// Should we generate the default CSS for this layout, even if HTMLStyle
 577         /// has been given? Default is false.
 578         /// Note that the default CSS is output first, then the user CSS, so it is
 579         /// possible to override what one does not want.
 580         bool htmlforcecss_;
 581         /// A cache for the default style info so generated.
 582         mutable docstring htmldefaultstyle_;
 583         /// Any other info for the HTML header.
 584         docstring htmlpreamble_;
 585         /// Whether this is the <title> paragraph.
 586         bool htmltitle_;
 587         /// calculating this is expensive, so we cache it.
 588         mutable std::string defaultcssclass_;
 589         /// This is the `category' for this layout. The following are
 590         /// recommended basic categories: FrontMatter, BackMatter, MainText,
 591         /// Sectioning, Starred, List, Reasoning.
 592         docstring category_;
 593         /// Macro definitions needed for this layout
 594         docstring preamble_;
 595         /// Language dependent macro definitions needed for this layout
 596         docstring langpreamble_;
 597         /// Language and babel dependent macro definitions needed for this layout
 598         docstring babelpreamble_;
 599         /// Are adjacent paragraphs handled as one group?
 600         bool par_group_;
 601         /// Packages needed for this layout
 602         std::set<std::string> required_;
 603         /// Layouts that are by default nested after this one
 604         std::set<docstring> autonests_;
 605         /// Layouts that by auto-nest this one
 606         std::set<docstring> autonested_by_;
 607         ///
 608         LaTeXArgMap latexargs_;
 609         ///
 610         LaTeXArgMap postcommandargs_;
 611         ///
 612         LaTeXArgMap listpreamble_;
 613         ///
 614         LaTeXArgMap itemargs_;
 615         ///
 616         bool add_to_toc_;
 617         ///
 618         std::string toc_type_;
 619         ///
 620         bool is_toc_caption_;
 621 };
 622
 623
 624 } // namespace lyx
 625
 626 #endif