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