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