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