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