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