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