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