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