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