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