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