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 docbooknofontinside() const { return docbooknofontinside_; }
 255         ///
 256         bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
 257         ///
 258         bool isCommand() const { return latextype == LATEX_COMMAND; }
 259         ///
 260         bool isEnvironment() const {
 261                 return latextype == LATEX_ENVIRONMENT
 262                         || latextype == LATEX_BIB_ENVIRONMENT
 263                         || latextype == LATEX_ITEM_ENVIRONMENT
 264                         || latextype == LATEX_LIST_ENVIRONMENT;
 265         }
 266         /// Is this the kind of layout in which adjacent paragraphs
 267         /// are handled as one group?
 268         bool isParagraphGroup() const { return par_group_; }
 269         ///
 270         bool labelIsInline() const {
 271                 return labeltype == LABEL_STATIC
 272                         || labeltype == LABEL_SENSITIVE
 273                         || labeltype == LABEL_ENUMERATE
 274                         || labeltype == LABEL_ITEMIZE;
 275         }
 276         bool labelIsAbove() const {
 277                 return labeltype == LABEL_ABOVE
 278                         || labeltype == LABEL_CENTERED
 279                         || labeltype == LABEL_BIBLIO;
 280         }
 281         ///
 282         bool addToToc() const { return add_to_toc_; }
 283         ///
 284         std::string tocType() const { return toc_type_; }
 285         ///
 286         bool isTocCaption() const { return is_toc_caption_; }
 287
 288         ///
 289         bool operator==(Layout const &) const;
 290         ///
 291         bool operator!=(Layout const & rhs) const
 292                 { return !(*this == rhs); }
 293
 294         ////////////////////////////////////////////////////////////////
 295         // members
 296         ////////////////////////////////////////////////////////////////
 297         /** Default font for this layout/environment.
 298             The main font for this kind of environment. If an attribute has
 299             INHERITED_*, it means that the value is specified by
 300             the defaultfont for the entire layout. If we are nested, the
 301             font is inherited from the font in the environment one level
 302             up until the font is resolved. The values :IGNORE_*
 303             and FONT_TOGGLE are illegal here.
 304         */
 305         FontInfo font;
 306
 307         /** Default font for labels.
 308             Interpretation the same as for font above
 309         */
 310         FontInfo labelfont;
 311
 312         /** Resolved version of the font for this layout/environment.
 313             This is a resolved version the default font. The font is resolved
 314             against the defaultfont of the entire layout.
 315         */
 316         FontInfo resfont;
 317
 318         /** Resolved version of the font used for labels.
 319             This is a resolved version the label font. The font is resolved
 320             against the defaultfont of the entire layout.
 321         */
 322         FontInfo reslabelfont;
 323
 324         /// Text that dictates how wide the left margin is on the screen
 325         docstring leftmargin;
 326         /// Text that dictates how wide the right margin is on the screen
 327         docstring rightmargin;
 328         /// Text that dictates how much space to leave after a potential label
 329         docstring labelsep;
 330         /// Text that dictates how much space to leave before a potential label
 331         docstring labelindent;
 332         /// Text that dictates the width of the indentation of indented pars
 333         docstring parindent;
 334         ///
 335         double parskip;
 336         ///
 337         double itemsep;
 338         ///
 339         double topsep;
 340         ///
 341         double bottomsep;
 342         ///
 343         double labelbottomsep;
 344         ///
 345         double parsep;
 346         ///
 347         Spacing spacing;
 348         ///
 349         LyXAlignment align;
 350         ///
 351         LyXAlignment alignpossible;
 352         ///
 353         LabelType labeltype;
 354         ///
 355         EndLabelType endlabeltype;
 356         ///
 357         MarginType margintype;
 358         ///
 359         bool newline_allowed;
 360         ///
 361         bool nextnoindent;
 362         ///
 363         ToggleIndentation toggle_indent;
 364         ///
 365         bool free_spacing;
 366         ///
 367         bool pass_thru;
 368         /// Individual chars to be passed verbatim
 369         docstring pass_thru_chars;
 370         ///
 371         bool parbreak_is_newline;
 372         /// show this in toc
 373         int toclevel;
 374         /// special value of toclevel for non-section layouts
 375         static const int NOT_IN_TOC;
 376
 377         /** true when the fragile commands in the paragraph need to be
 378             \protect'ed. */
 379         bool needprotect;
 380         /** true when the verbatim stuff of this layout needs to be
 381             \cprotect'ed. */
 382         bool needcprotect;
 383         /** true when specific commands in this paragraph need to be
 384             protected in an \mbox. */
 385         bool needmboxprotect;
 386         /// true when empty paragraphs should be kept.
 387         bool keepempty;
 388         /// Type of LaTeX object
 389         LatexType latextype;
 390         /// Does this object belong in the title part of the document?
 391         bool intitle;
 392         /// Is the content to go in the preamble rather than the body?
 393         bool inpreamble;
 394         /// Which counter to step
 395         docstring counter;
 396         /// Resume counter?
 397         bool resumecounter;
 398         /// Step parent counter?
 399         bool stepparentcounter;
 400         /// Prefix to use when creating labels
 401         docstring refprefix;
 402         /// Depth of XML command
 403         int commanddepth;
 404
 405         /// Return a pointer on a new layout suitable to describe a caption.
 406         /// FIXME: remove this eventually. This is only for tex2lyx
 407         /// until it has proper support for the caption inset (JMarc)
 408         static Layout * forCaption();
 409
 410         /// Is this spellchecked?
 411         bool spellcheck;
 412         /**
 413          * Should this layout definition always be written to the document preamble?
 414          * Possible values are:
 415          *   0: Do not enforce local layout
 416          * >=1: Enforce local layout with version forcelocal
 417          *  -1: Enforce local layout with infinite version
 418          * On reading, the forced local layout is only used if its version
 419          * number is greater than the version number of the same layout in the
 420          * document class. Otherwise, it is ignored.
 421          */
 422         int forcelocal;
 423
 424
 425 private:
 426         /// Reads a layout definition from file
 427         /// \return true on success.
 428         bool readIgnoreForcelocal(Lexer &, TextClass const &, bool validating);
 429         /// generates the default CSS for this layout
 430         void makeDefaultCSS() const;
 431         ///
 432         std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; }
 433         ///
 434         std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
 435
 436         /// Name of the layout/paragraph environment
 437         docstring name_;
 438
 439         /// LaTeX name for environment
 440         std::string latexname_;
 441
 442         /** Is this layout the default layout for an unknown layout? If
 443          * so, its name will be displayed as xxx (unknown).
 444          */
 445         bool unknown_;
 446
 447         /** Name of an layout that has replaced this layout.
 448             This is used to rename a layout, while keeping backward
 449             compatibility
 450         */
 451         docstring obsoleted_by_;
 452
 453         /** Name of an layout which preamble must come before this one
 454             This is used when the preamble snippet uses macros defined in
 455             another preamble
 456          */
 457         docstring depends_on_;
 458
 459         /// Label string. "Abstract", "Reference", "Caption"...
 460         docstring labelstring_;
 461         ///
 462         docstring endlabelstring_;
 463         /// Label string inside appendix. "Appendix", ...
 464         docstring labelstring_appendix_;
 465         /// LaTeX parameter for environment
 466         std::string latexparam_;
 467         /// Item command in lists
 468         std::string itemcommand_;
 469         /// Left delimiter of the content
 470         docstring leftdelim_;
 471         /// Right delimiter of the content
 472         docstring rightdelim_;
 473         /// Internal tag to use (e.g., <title></title> for sect header)
 474         std::string innertag_;
 475         /// Internal tag to use (e.g. to surround varentrylist label)
 476         std::string labeltag_;
 477         /// Internal tag to surround the item text in a list.
 478         std::string itemtag_;
 479         /// The interpretation of this tag varies depending upon the latextype.
 480         /// In an environment, it is the tag enclosing all content for this set of
 481         /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize,
 482         /// it would be: ul. (You get the idea.)
 483         ///
 484         /// For a command, it is the tag enclosing the content of the command.
 485         /// So, for section, it might be: h2.
 486         ///
 487         /// For the paragraph type, it is the tag that will enclose each paragraph.
 488         ///
 489         /// Defaults to "div".
 490         mutable std::string htmltag_;
 491         /// Additional attributes for inclusion with the start tag. Defaults
 492         /// to: class="layoutname".
 493         mutable std::string htmlattr_;
 494         /// Tag for individual paragraphs in an environment. In lists, this
 495         /// would be something like "li". But it also needs to be set for
 496         /// quotation, e.g., since the paragraphs in a quote need to be
 497         /// in "p" tags. Default is "div".
 498         /// Note that when I said "environment", I meant it: This has no
 499         /// effect for LATEX_PARAGRAPH type layouts.
 500         mutable std::string htmlitemtag_;
 501         /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
 502         mutable std::string htmlitemattr_;
 503         /// Tag for labels, of whatever sort. One use for this is in setting
 504         /// descriptions, in which case it would be: dt. Another use is to
 505         /// customize the display of, say, the auto-generated label for
 506         /// sections. Defaults to "span".
 507         /// If set to "NONE", this suppresses the printing of the label.
 508         mutable std::string htmllabeltag_;
 509         /// Attributes for the label. Defaults to: class="layoutname_label".
 510         mutable std::string htmllabelattr_;
 511         /// Whether to put the label before the item, or within the item.
 512         /// I.e., do we have (true):
 513         ///    <label>...</label><item>...</item>
 514         /// or instead (false):
 515         ///    <item><label>...</label>...</item>
 516         /// The latter is the default.
 517         bool htmllabelfirst_;
 518         /// CSS information needed by this layout.
 519         docstring htmlstyle_;
 520         /// DocBook tag corresponding to this layout.
 521         mutable std::string docbooktag_;
 522         /// Roles to add to docbooktag_, if any (default: none).
 523         mutable std::string docbookattr_;
 524         /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
 525         mutable std::string docbooktagtype_;
 526         /// DocBook inner tag corresponding to this layout.
 527         mutable std::string docbookinnertag_;
 528         /// Roles to add to docbookinnertag_, if any (default: none).
 529         mutable std::string docbookinnerattr_;
 530         /// DocBook inner-tag type corresponding to this layout (block, paragraph, or inline; default: block).
 531         mutable std::string docbookinnertagtype_;
 532         /// DocBook tag corresponding to this item (mainly for lists).
 533         mutable std::string docbookitemtag_;
 534         /// Roles to add to docbookitemtag_, if any (default: none).
 535         mutable std::string docbookitemattr_;
 536         /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
 537         mutable std::string docbookitemtagtype_;
 538         /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
 539         mutable std::string docbookitemwrappertag_;
 540         /// Roles to add to docbookitemwrappertag_, if any (default: none).
 541         mutable std::string docbookitemwrapperattr_;
 542         /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
 543         mutable std::string docbookitemwrappertagtype_;
 544         /// DocBook tag corresponding to this label (mostly for description lists;
 545         /// labels in the common sense do not exist with DocBook).
 546         mutable std::string docbookitemlabeltag_;
 547         /// Roles to add to docbooklabeltag_, if any (default: none).
 548         mutable std::string docbookitemlabelattr_;
 549         /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
 550         mutable std::string docbookitemlabeltagtype_;
 551         /// DocBook tag to add within the item, around its direct content (mainly for lists).
 552         mutable std::string docbookiteminnertag_;
 553         /// Roles to add to docbookiteminnertag_, if any (default: none).
 554         mutable std::string docbookiteminnerattr_;
 555         /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
 556         mutable std::string docbookiteminnertagtype_;
 557         /// DocBook tag corresponding to this wrapper around the main tag.
 558         mutable std::string docbookwrappertag_;
 559         /// Roles to add to docbookwrappertag_, if any (default: none).
 560         mutable std::string docbookwrapperattr_;
 561         /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
 562         mutable std::string docbookwrappertagtype_;
 563         /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
 564         bool docbookwrappermergewithprevious_;
 565         /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
 566         /// (default: section).
 567         mutable std::string docbooksectiontag_;
 568         /// Whether this element should be considered as a section-level element in DocBook.
 569         bool docbooksection_;
 570         /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
 571         mutable std::string docbookininfo_;
 572         /// Wehther this paragraph should be considered as abstract.
 573         bool docbookabstract_;
 574         /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
 575         /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
 576         /// held by this attribute
 577         mutable std::string docbookforceabstracttag_;
 578         /// Whether font tags are allowed inside this tag.
 579         bool docbooknofontinside_ = false;
 580         /// Should we generate the default CSS for this layout, even if HTMLStyle
 581         /// has been given? Default is false.
 582         /// Note that the default CSS is output first, then the user CSS, so it is
 583         /// possible to override what one does not want.
 584         bool htmlforcecss_;
 585         /// A cache for the default style info so generated.
 586         mutable docstring htmldefaultstyle_;
 587         /// Any other info for the HTML header.
 588         docstring htmlpreamble_;
 589         /// Whether this is the <title> paragraph.
 590         bool htmltitle_;
 591         /// calculating this is expensive, so we cache it.
 592         mutable std::string defaultcssclass_;
 593         /// This is the `category' for this layout. The following are
 594         /// recommended basic categories: FrontMatter, BackMatter, MainText,
 595         /// Sectioning, Starred, List, Reasoning.
 596         docstring category_;
 597         /// Macro definitions needed for this layout
 598         docstring preamble_;
 599         /// Language dependent macro definitions needed for this layout
 600         docstring langpreamble_;
 601         /// Language and babel dependent macro definitions needed for this layout
 602         docstring babelpreamble_;
 603         /// Are adjacent paragraphs handled as one group?
 604         bool par_group_;
 605         /// Packages needed for this layout
 606         std::set<std::string> required_;
 607         /// Layouts that are by default nested after this one
 608         std::set<docstring> autonests_;
 609         /// Layouts that by auto-nest this one
 610         std::set<docstring> autonested_by_;
 611         ///
 612         LaTeXArgMap latexargs_;
 613         ///
 614         LaTeXArgMap postcommandargs_;
 615         ///
 616         LaTeXArgMap listpreamble_;
 617         ///
 618         LaTeXArgMap itemargs_;
 619         ///
 620         bool add_to_toc_;
 621         ///
 622         std::string toc_type_;
 623         ///
 624         bool is_toc_caption_;
 625 };
 626
 627
 628 } // namespace lyx
 629
 630 #endif