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