src/lyxtextclass.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lyxtextclass.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 LYXTEXTCLASS_H
  11 #define LYXTEXTCLASS_H
  12
  13 #include "lyxlayout.h"
  14 #include "LString.h"
  15 #include "lyxlayout_ptr_fwd.h"
  16
  17 #include "support/types.h"
  18
  19 #include <boost/shared_ptr.hpp>
  20
  21 #include <vector>
  22
  23 class LyXLex;
  24 class Counters;
  25 class FloatList;
  26
  27 /// Stores the layout specification of a LyX document class.
  28 class LyXTextClass {
  29 public:
  30         /// The individual styles comprising the document class
  31         typedef std::vector<LyXLayout_ptr> LayoutList;
  32         /// Enumerate the paragraph styles.
  33         typedef LayoutList::const_iterator const_iterator;
  34         /// Construct a layout with default values. Actual values loaded later.
  35         explicit
  36         LyXTextClass(string const & = string(),
  37                      string const & = string(),
  38                      string const & = string());
  39
  40         /// paragraph styles begin iterator.
  41         const_iterator begin() const { return layoutlist_.begin(); }
  42         /// paragraph styles end iterator
  43         const_iterator end() const { return layoutlist_.end(); }
  44
  45         /// Performs the read of the layout file.
  46         bool Read(string const & filename, bool merge = false);
  47         ///
  48         void readOutputType(LyXLex &);
  49         ///
  50         void readTitleType(LyXLex &);
  51         ///
  52         void readMaxCounter(LyXLex &);
  53         ///
  54         void readClassOptions(LyXLex &);
  55         ///
  56         void readFloat(LyXLex &);
  57         ///
  58         void readCounter(LyXLex &);
  59         ///
  60         bool hasLayout(string const & name) const;
  61
  62         ///
  63         LyXLayout_ptr const & operator[](string const & vname) const;
  64         ///
  65         LyXLayout_ptr const & getEnv(string const & vname) const;
  66
  67         /// Sees to that the textclass structure has been loaded
  68         bool load() const;
  69
  70         /// the list of floats defined in the document class
  71         FloatList & floats();
  72         /// the list of floats defined in the document class
  73         FloatList const & floats() const;
  74         /// The Counters present in this document class.
  75         Counters & counters() const;
  76         ///
  77         string const & defaultLayoutName() const;
  78         ///
  79         LyXLayout_ptr const & defaultLayout() const;
  80         ///
  81         string const & name() const;
  82         ///
  83         string const & latexname() const;
  84         ///
  85         string const & description() const;
  86         ///
  87         string const & opt_fontsize() const;
  88         ///
  89         string const & opt_pagestyle() const;
  90         ///
  91         string const & options() const;
  92         ///
  93         string const & pagestyle() const;
  94         ///
  95         string const & preamble() const;
  96
  97         /// Packages that are already loaded by the class
  98         enum Provides {
  99                 ///
 100                 nothing = 0,
 101                 ///
 102                 amsmath = 1,
 103                 ///
 104                 makeidx = 2,
 105                 ///
 106                 url = 4,
 107                 ///
 108                 natbib = 8
 109         };
 110         ///
 111         bool provides(Provides p) const;
 112
 113         ///
 114         unsigned int columns() const;
 115         ///
 116         enum PageSides {
 117                 ///
 118                 OneSide,
 119                 ///
 120                 TwoSides
 121         };
 122         ///
 123         PageSides sides() const;
 124         ///
 125         int secnumdepth() const;
 126         ///
 127         int tocdepth() const;
 128
 129         /// Can be LaTeX, LinuxDoc, etc.
 130         OutputType outputType() const;
 131
 132         ///
 133         LyXFont const & defaultfont() const;
 134
 135         /// Text that dictates how wide the left margin is on the screen
 136         string const & leftmargin() const;
 137
 138         /// Text that dictates how wide the right margin is on the screen
 139         string const & rightmargin() const;
 140         ///
 141         int maxcounter() const;
 142
 143         /// The type of command used to produce a title
 144         LYX_TITLE_LATEX_TYPES titletype() const;
 145         /// The name of the title command
 146         string const & titlename() const;
 147
 148         ///
 149         int size() const;
 150 private:
 151         ///
 152         bool delete_layout(string const &);
 153         ///
 154         bool delete_env(string const &);
 155         ///
 156         bool do_readStyle(LyXLex &, LyXLayout &);
 157         /// Layout file name
 158         string name_;
 159         /// document class name
 160         string latexname_;
 161         /// document class description
 162         string description_;
 163         /// Specific class options
 164         string opt_fontsize_;
 165         ///
 166         string opt_pagestyle_;
 167         ///
 168         string options_;
 169         ///
 170         string pagestyle_;
 171         ///
 172         string defaultlayout_;
 173         /// preamble text to support layout styles
 174         string preamble_;
 175         /// latex packages loaded by document class.
 176         Provides provides_;
 177         ///
 178         unsigned int columns_;
 179         ///
 180         PageSides sides_;
 181         /// header depth to have numbering
 182         int secnumdepth_;
 183         /// header depth to appear in table of contents
 184         int tocdepth_;
 185         /// Can be LaTeX, LinuxDoc, etc.
 186         OutputType outputType_;
 187         /** Base font. The paragraph and layout fonts are resolved against
 188             this font. This has to be fully instantiated. Attributes
 189             LyXFont::INHERIT, LyXFont::IGNORE, and LyXFont::TOGGLE are
 190             extremely illegal.
 191         */
 192         LyXFont defaultfont_;
 193         /// Text that dictates how wide the left margin is on the screen
 194         string leftmargin_;
 195
 196         /// Text that dictates how wide the right margin is on the screen
 197         string rightmargin_;
 198         /// highest header level used in this layout.
 199         int maxcounter_; // add approp. signedness
 200
 201         /// The type of command used to produce a title
 202         LYX_TITLE_LATEX_TYPES titletype_;
 203         /// The name of the title command
 204         string titlename_;
 205
 206         /// Paragraph styles used in this layout
 207         LayoutList layoutlist_;
 208
 209         /// Environment styles used in this layout
 210         LayoutList envlist_;
 211
 212         /// available types of float, eg. figure, algorithm.
 213         boost::shared_ptr<FloatList> floatlist_;
 214
 215         /// Types of counters, eg. sections, eqns, figures, avail. in document class.
 216         boost::shared_ptr<Counters> ctrs_;
 217
 218         /// Has this layout file been loaded yet?
 219         mutable bool loaded;
 220 };
 221
 222
 223 /// Merge two different provides flags into one bit field record
 224 inline
 225 void operator|=(LyXTextClass::Provides & p1, LyXTextClass::Provides p2)
 226 {
 227         p1 = static_cast<LyXTextClass::Provides>(p1 | p2);
 228 }
 229
 230
 231 /// convert page sides option to text 1 or 2
 232 std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p);
 233
 234 #endif