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