src/TextClass.h

   1 // -*- C++ -*-
   2 /**
   3  * \file TextClass.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * Full author contact details are available in file CREDITS.
   8  */
   9
  10 #ifndef TEXTCLASS_H
  11 #define TEXTCLASS_H
  12
  13 #include "ColorCode.h"
  14 #include "FontInfo.h"
  15 #include "LayoutEnums.h"
  16 #include "LayoutPtr.h"
  17
  18 #include "insets/InsetLayout.h"
  19
  20 #include "support/docstring.h"
  21 #include "support/types.h"
  22
  23 #include <boost/shared_ptr.hpp>
  24
  25 #include <vector>
  26 #include <set>
  27 #include <map>
  28
  29 namespace lyx {
  30
  31 namespace support { class FileName; }
  32
  33 class Layout;
  34 class Lexer;
  35 class Counters;
  36 class FloatList;
  37
  38 /// List of inset layouts
  39 typedef std::map<docstring, InsetLayout> InsetLayouts;
  40
  41 /// Stores the layout specification of a LyX document class.
  42 class TextClass {
  43 public:
  44         /// The individual styles comprising the document class
  45         typedef std::vector<LayoutPtr> LayoutList;
  46         /// Enumerate the paragraph styles.
  47         typedef LayoutList::const_iterator const_iterator;
  48         /// Construct a layout with default values. Actual values loaded later.
  49         explicit
  50         TextClass(std::string const & = std::string(),
  51                      std::string const & = std::string(),
  52                      std::string const & = std::string(),
  53                      bool texClassAvail = false);
  54
  55         /// check whether the TeX class is available
  56         bool isTeXClassAvailable() const;
  57
  58         /// paragraph styles begin iterator.
  59         const_iterator begin() const { return layoutlist_.begin(); }
  60         /// paragraph styles end iterator
  61         const_iterator end() const { return layoutlist_.end(); }
  62
  63         ///Enum used with TextClass::read
  64         enum ReadType {
  65                 BASECLASS, //>This is a base class, i.e., top-level layout file
  66                 MERGE, //>This is a file included in a layout file
  67                 MODULE //>This is a layout module
  68         };
  69         /// Performs the read of the layout file.
  70         /// \return true on success.
  71         bool read(support::FileName const & filename, ReadType rt = BASECLASS);
  72         ///
  73         void readOutputType(Lexer &);
  74         ///
  75         void readTitleType(Lexer &);
  76         ///
  77         void readMaxCounter(Lexer &);
  78         ///
  79         void readClassOptions(Lexer &);
  80         ///
  81         void readCharStyle(Lexer &, std::string const &);
  82         ///
  83         void readFloat(Lexer &);
  84         ///
  85         void readCounter(Lexer &);
  86         ///
  87         bool hasLayout(docstring const & name) const;
  88
  89         ///
  90         LayoutPtr const & operator[](docstring const & vname) const;
  91
  92         /// Sees to that the textclass structure has been loaded
  93         bool load(std::string const & path = std::string()) const;
  94         /// Has this layout file been loaded yet?
  95         bool loaded() const { return loaded_; }
  96
  97         /// the list of floats defined in the document class
  98         FloatList & floats();
  99         /// the list of floats defined in the document class
 100         FloatList const & floats() const;
 101         /// The Counters present in this document class.
 102         Counters & counters() const;
 103         /// Inset layouts of this doc class
 104         InsetLayouts & insetlayouts() const { return insetlayoutlist_; };
 105         ///
 106         InsetLayout const & insetlayout(docstring const & name) const;
 107         ///
 108         docstring const & defaultLayoutName() const;
 109         ///
 110         LayoutPtr const & defaultLayout() const;
 111         /// returns a special layout for use when we don't really want one,
 112         /// e.g., in table cells
 113         LayoutPtr const & emptyLayout() const
 114                         { return operator[](emptylayout_); };
 115         ///
 116         docstring const & emptyLayoutName() const
 117                         { return emptylayout_; }
 118         ///
 119         std::string const & name() const;
 120         ///
 121         docstring const & labelstring() const;
 122         ///
 123         std::string const & latexname() const;
 124         ///
 125         std::string const & description() const;
 126         ///
 127         bool isModular() const { return modular_; }
 128         /// Sets the layout as a modular one. There is never any
 129         /// need to reset this.
 130         void markAsModular() { modular_ = true; }
 131         ///
 132         std::string const & opt_fontsize() const;
 133         ///
 134         std::string const & opt_pagestyle() const;
 135         ///
 136         std::string const & options() const;
 137         ///
 138         std::string const & class_header() const;
 139         ///
 140         std::string const & pagestyle() const;
 141         ///
 142         docstring const & preamble() const;
 143
 144         /// is this feature already provided by the class?
 145         bool provides(std::string const & p) const;
 146         /// features required by the class?
 147         std::set<std::string> const & requires() const { return requires_; }
 148
 149         ///
 150         unsigned int columns() const;
 151         ///
 152         PageSides sides() const;
 153         ///
 154         int secnumdepth() const;
 155         ///
 156         int tocdepth() const;
 157
 158         /// Can be LaTeX, DocBook, etc.
 159         OutputType outputType() const;
 160
 161         ///
 162         FontInfo const & defaultfont() const;
 163
 164         /// Text that dictates how wide the left margin is on the screen
 165         docstring const & leftmargin() const;
 166
 167         /// Text that dictates how wide the right margin is on the screen
 168         docstring const & rightmargin() const;
 169
 170         /// The type of command used to produce a title
 171         TitleLatexType titletype() const;
 172         /// The name of the title command
 173         std::string const & titlename() const;
 174
 175         ///
 176         int size() const;
 177         /// The minimal TocLevel of sectioning layouts
 178         int min_toclevel() const;
 179         /// The maximal TocLevel of sectioning layouts
 180         int max_toclevel() const;
 181         /// returns true if the class has a ToC structure
 182         bool hasTocLevels() const;
 183         ///
 184         static InsetLayout const & emptyInsetLayout() { return empty_insetlayout_; }
 185 private:
 186         ///
 187         bool deleteLayout(docstring const &);
 188         /// \return true for success.
 189         bool readStyle(Lexer &, Layout &);
 190         /// Layout file name
 191         std::string name_;
 192         /// document class name
 193         std::string latexname_;
 194         /// document class description
 195         std::string description_;
 196         /// whether this is a modular layout, i.e., whether it has been
 197         /// modified by loading of layout modules.
 198         bool modular_;
 199         ///
 200         std::string opt_fontsize_;
 201         ///
 202         std::string opt_pagestyle_;
 203         /// Specific class options
 204         std::string options_;
 205         ///
 206         std::string pagestyle_;
 207         ///
 208         std::string class_header_;
 209         ///
 210         docstring defaultlayout_;
 211         /// name of empty layout
 212         static const docstring emptylayout_;
 213         /// preamble text to support layout styles
 214         docstring preamble_;
 215         /// latex packages loaded by document class.
 216         std::set<std::string> provides_;
 217         /// latex packages requested by document class.
 218         std::set<std::string> requires_;
 219         ///
 220         unsigned int columns_;
 221         ///
 222         PageSides sides_;
 223         /// header depth to have numbering
 224         int secnumdepth_;
 225         /// header depth to appear in table of contents
 226         int tocdepth_;
 227         /// Can be LaTeX, DocBook, etc.
 228         OutputType outputType_;
 229         /** Base font. The paragraph and layout fonts are resolved against
 230             this font. This has to be fully instantiated. Attributes
 231             FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
 232             extremely illegal.
 233         */
 234         FontInfo defaultfont_;
 235         /// Text that dictates how wide the left margin is on the screen
 236         docstring leftmargin_;
 237
 238         /// Text that dictates how wide the right margin is on the screen
 239         docstring rightmargin_;
 240
 241         /// The type of command used to produce a title
 242         TitleLatexType titletype_;
 243         /// The name of the title command
 244         std::string titlename_;
 245
 246         /// Paragraph styles used in this layout
 247         LayoutList layoutlist_;
 248
 249         /// Input layouts available to this layout
 250         mutable InsetLayouts insetlayoutlist_;
 251
 252         /// available types of float, eg. figure, algorithm.
 253         boost::shared_ptr<FloatList> floatlist_;
 254
 255         /// Types of counters, eg. sections, eqns, figures, avail. in document class.
 256         boost::shared_ptr<Counters> counters_;
 257
 258         /// Has this layout file been loaded yet?
 259         mutable bool loaded_;
 260
 261         /// Is the TeX class available?
 262         bool texClassAvail_;
 263
 264         /// The minimal TocLevel of sectioning layouts
 265         int min_toclevel_;
 266         /// The maximal TocLevel of sectioning layouts
 267         int max_toclevel_;
 268         ///
 269         static InsetLayout empty_insetlayout_;
 270 };
 271
 272
 273 /// convert page sides option to text 1 or 2
 274 std::ostream & operator<<(std::ostream & os, PageSides p);
 275
 276 } // namespace lyx
 277
 278 #endif