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