src/insets/InsetLayout.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetLayout.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Martin Vermeer
   8  * \author Richard Heck
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSET_LAYOUT_H
  14 #define INSET_LAYOUT_H
  15
  16 #include "ColorCode.h"
  17 #include "FontInfo.h"
  18 #include "Layout.h"
  19
  20 #include "support/docstring.h"
  21
  22 #include <set>
  23 #include <string>
  24
  25 namespace lyx {
  26
  27 class Lexer;
  28 class TextClass;
  29
  30 ///
  31 class InsetLayout {
  32 public:
  33         ///
  34         InsetLayout();
  35         ///
  36         enum InsetDecoration {
  37                 CLASSIC,
  38                 MINIMALISTIC,
  39                 CONGLOMERATE,
  40                 DEFAULT
  41         };
  42         ///
  43         enum InsetLyXType {
  44                 NOLYXTYPE,
  45                 CHARSTYLE,
  46                 CUSTOM,
  47                 END,
  48                 STANDARD
  49         };
  50         ///
  51         enum InsetLaTeXType {
  52                 NOLATEXTYPE,
  53                 COMMAND,
  54                 ENVIRONMENT,
  55                 ILT_ERROR
  56         };
  57         ///
  58         bool read(Lexer & lexrc, TextClass const & tclass,
  59                         bool validating = false);
  60         ///
  61         docstring name() const { return name_; }
  62         ///
  63         void setName(docstring const & n) { name_ = n; }
  64         ///
  65         InsetLyXType lyxtype() const { return lyxtype_; }
  66         ///
  67         docstring labelstring() const { return labelstring_; }
  68         ///
  69         docstring menustring() const { return menustring_; }
  70         ///
  71         bool contentaslabel() const { return contentaslabel_; }
  72         ///
  73         InsetDecoration decoration() const { return decoration_; }
  74         ///
  75         InsetLaTeXType latextype() const { return latextype_; }
  76         ///
  77         std::string latexname() const { return latexname_; }
  78         ///
  79         std::string latexparam() const { return latexparam_; }
  80         ///
  81         docstring leftdelim() const { return leftdelim_; }
  82         ///
  83         docstring rightdelim() const { return rightdelim_; }
  84         ///
  85         FontInfo font() const { return font_; }
  86         ///
  87         FontInfo labelfont() const { return labelfont_; }
  88         ///
  89         ColorCode bgcolor() const { return bgcolor_; }
  90         ///
  91         Layout::LaTeXArgMap const & latexargs() const { return latexargs_; }
  92         ///
  93         Layout::LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
  94         /// Returns latexargs() + postcommandargs().
  95         /// But note that it returns a *copy*, not a reference, so do not do
  96         /// anything like:
  97         ///   Layout::LaTeXArgMap::iterator it = args().begin();
  98         ///   Layout::LaTeXArgMap::iterator en = args().end();
  99         /// Those are iterators for different containers.
 100         Layout::LaTeXArgMap args() const;
 101         ///
 102         unsigned int optArgs() const;
 103         ///
 104         unsigned int requiredArgs() const;
 105         ///
 106         docstring preamble() const { return preamble_; }
 107         /// Get language dependent macro definitions needed for this inset
 108         docstring const langpreamble() const { return langpreamble_; }
 109         /// Get language and babel dependent macro definitions needed for
 110         /// this inset
 111         docstring const babelpreamble() const { return babelpreamble_; }
 112         ///
 113         bool fixedwidthpreambleencoding() const { return fixedwidthpreambleencoding_; }
 114         ///
 115         docstring counter() const { return counter_; }
 116         ///
 117         docstring refprefix() const { return refprefix_; }
 118         /// The tag enclosing all the material in this inset. Default is "span".
 119         std::string const & htmltag() const;
 120         /// Additional attributes for inclusion with the start tag. Default (if
 121         /// a tag is provided) is: class="name".
 122         std::string const & htmlattr() const;
 123         /// Tag for individual paragraphs in the inset. Default is none.
 124         std::string const & htmlinnertag() const { return htmlinnertag_; }
 125         /// Attributes for that tag. Default (if a tag is provided) is:
 126         /// class="name_inner".
 127         std::string const & htmlinnerattr() const;
 128         /// A label for this environment, possibly including a reference
 129         /// to a counter. E.g., for footnote, it might be:
 130         ///    \arabic{footnote}
 131         /// No default.
 132         /// FIXME Could we get this from the layout?
 133         std::string const & htmllabel() const { return htmllabel_; }
 134         ///
 135         inline std::string htmllabeltag() const { return "span"; }
 136         ///
 137         std::string htmllabelattr() const
 138                 { return "class=\"" + defaultCSSClass() + "_label\""; }
 139         /// CSS associated with this inset.
 140         docstring htmlstyle() const;
 141         /// Additional material for the header.
 142         docstring htmlpreamble() const { return htmlpreamble_; }
 143         /// Whether this inset represents a "block" of material, i.e., a set
 144         /// of paragraphs of its own (true), or should be run into the previous
 145         /// paragraph (false). Examples:
 146         ///   For branches, this is false.
 147         ///   For footnotes, this is true.
 148         /// Defaults to true.
 149         bool htmlisblock() const { return htmlisblock_; }
 150         ///
 151         std::string docbooktag() const { return docbooktag_; }
 152         ///
 153         std::string docbookattr() const { return docbookattr_; }
 154         ///
 155         std::set<std::string> required() const { return required_; }
 156         ///
 157         bool isMultiPar() const { return multipar_; }
 158         ///
 159         bool forcePlainLayout() const { return forceplain_; }
 160         ///
 161         bool allowParagraphCustomization() const { return custompars_; }
 162         ///
 163         bool isPassThru() const { return passthru_; }
 164         ///
 165         docstring passThruChars() const { return passthru_chars_; }
 166         ///
 167         std::string newlineCmd() const { return newline_cmd_; }
 168         ///
 169         bool parbreakIsNewline() const { return parbreakisnewline_; }
 170         ///
 171         bool parbreakIgnored() const { return parbreakignored_; }
 172         ///
 173         bool isNeedProtect() const { return needprotect_; }
 174         ///
 175         bool needsCProtect() const { return needcprotect_; }
 176         /// Protection of some elements such as \ref and \cite
 177         /// in \mbox (needed by commands building on soul or ulem)
 178         bool isNeedMBoxProtect() const { return needmboxprotect_; }
 179         ///
 180         bool isFreeSpacing() const { return freespacing_; }
 181         ///
 182         bool isKeepEmpty() const { return keepempty_; }
 183         ///
 184         bool forceLTR() const { return forceltr_; }
 185         ///
 186         bool forceOwnlines() const { return forceownlines_; }
 187         ///
 188         bool isInToc() const { return intoc_; }
 189         ///
 190         bool spellcheck() const { return spellcheck_; }
 191         ///
 192         bool resetsFont() const { return resetsfont_; }
 193         ///
 194         bool isDisplay() const { return display_; }
 195         ///
 196         bool forcelocalfontswitch() const { return forcelocalfontswitch_; }
 197         ///
 198         docstring const & obsoleted_by() const { return obsoleted_by_; }
 199         ///
 200         bool addToToc() const { return add_to_toc_; }
 201         ///
 202         std::string tocType() const { return toc_type_; }
 203         ///
 204         bool isTocCaption() const { return is_toc_caption_; }
 205         ///
 206         bool editExternally () const { return edit_external_; }
 207 private:
 208         ///
 209         void makeDefaultCSS() const;
 210         ///
 211         std::string defaultCSSClass() const;
 212         ///
 213         void readArgument(Lexer &);
 214         ///
 215         docstring name_;
 216         /**
 217                 * This is only used (at present) to decide where to put them on the menus.
 218                 * Values are 'charstyle', 'custom' (things that by default look like a
 219                 * footnote), 'standard'.
 220                 */
 221         InsetLyXType lyxtype_;
 222         ///
 223         docstring labelstring_;
 224         ///
 225         docstring menustring_;
 226         ///
 227         bool contentaslabel_;
 228         ///
 229         InsetDecoration decoration_;
 230         ///
 231         InsetLaTeXType latextype_;
 232         ///
 233         std::string latexname_;
 234         ///
 235         std::string latexparam_;
 236         ///
 237         docstring leftdelim_;
 238         ///
 239         docstring rightdelim_;
 240         ///
 241         FontInfo font_;
 242         ///
 243         FontInfo labelfont_;
 244         ///
 245         ColorCode bgcolor_;
 246         ///
 247         docstring counter_;
 248         ///
 249         docstring preamble_;
 250         /// Language dependent macro definitions needed for this inset
 251         docstring langpreamble_;
 252         /// Language and babel dependent macro definitions needed for this inset
 253         docstring babelpreamble_;
 254         ///
 255         bool fixedwidthpreambleencoding_;
 256         ///
 257         docstring refprefix_;
 258         ///
 259         mutable std::string htmltag_;
 260         ///
 261         mutable std::string htmlattr_;
 262         ///
 263         std::string htmlinnertag_;
 264         ///
 265         mutable std::string htmlinnerattr_;
 266         ///
 267         std::string htmllabel_;
 268         ///
 269         docstring htmlstyle_;
 270         /// Cache for default CSS info for this inset.
 271         mutable docstring htmldefaultstyle_;
 272         /// Cache for default CSS class.
 273         mutable std::string defaultcssclass_;
 274         /// Whether to force generation of default CSS even if some is given.
 275         /// False by default.
 276         bool htmlforcecss_;
 277         ///
 278         docstring htmlpreamble_;
 279         ///
 280         bool htmlisblock_;
 281         ///
 282         std::string docbooktag_;
 283         ///
 284         std::string docbookattr_;
 285         ///
 286         std::set<std::string> required_;
 287         ///
 288         bool multipar_;
 289         ///
 290         bool custompars_;
 291         ///
 292         bool forceplain_;
 293         ///
 294         bool passthru_;
 295         ///
 296         docstring passthru_chars_;
 297         ///
 298         std::string newline_cmd_;
 299         ///
 300         bool parbreakisnewline_;
 301         ///
 302         bool parbreakignored_;
 303         ///
 304         bool freespacing_;
 305         ///
 306         bool keepempty_;
 307         ///
 308         bool forceltr_;
 309         ///
 310         bool forceownlines_;
 311         ///
 312         bool needprotect_;
 313         ///
 314         bool needcprotect_;
 315         ///
 316         bool needmboxprotect_;
 317         /// should the contents be written to TOC strings?
 318         bool intoc_;
 319         /// check spelling of this inset?
 320         bool spellcheck_;
 321         ///
 322         bool resetsfont_;
 323         ///
 324         bool display_;
 325         ///
 326         bool forcelocalfontswitch_;
 327         /** Name of an insetlayout that has replaced this insetlayout.
 328             This is used to rename an insetlayout, while keeping backward
 329             compatibility
 330         */
 331         docstring obsoleted_by_;
 332         ///
 333         Layout::LaTeXArgMap latexargs_;
 334         ///
 335         Layout::LaTeXArgMap postcommandargs_;
 336         ///
 337         bool add_to_toc_;
 338         ///
 339         std::string toc_type_;
 340         ///
 341         bool is_toc_caption_;
 342         ///
 343         bool edit_external_;
 344 };
 345
 346 ///
 347 InsetLayout::InsetLyXType translateLyXType(std::string const & str);
 348 InsetLayout::InsetDecoration translateDecoration(std::string const & str);
 349
 350 } // namespace lyx
 351
 352 #endif