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