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