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