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