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 "Counters.h"
  15 #include "FloatList.h"
  16 #include "FontInfo.h"
  17 #include "Layout.h"
  18 #include "LayoutEnums.h"
  19 #include "LayoutModuleList.h"
  20
  21 #include "insets/InsetLayout.h"
  22
  23 #include "support/docstring.h"
  24 #include "support/types.h"
  25
  26 #include <boost/noncopyable.hpp>
  27
  28 #include <map>
  29 #include <set>
  30 #include <vector>
  31 #include <list>
  32
  33 namespace lyx {
  34
  35 namespace support { class FileName; }
  36
  37 class Counters;
  38 class FloatList;
  39 class Layout;
  40 class LayoutFile;
  41 class Lexer;
  42
  43 /// Based upon ideas in boost::noncopyable, inheriting from this
  44 /// class effectively makes the copy constructor protected but the
  45 /// assignment constructor private.
  46 class ProtectCopy
  47 {
  48 protected:
  49         ProtectCopy() {}
  50         ~ProtectCopy() {}
  51         ProtectCopy(const ProtectCopy &) {};
  52 private:
  53         const ProtectCopy & operator=(const ProtectCopy &);
  54 };
  55
  56
  57 /// A TextClass represents a collection of layout information: At the
  58 /// moment, this includes Layout's and InsetLayout's.
  59 ///
  60 /// There are two major subclasses of TextClass: LayoutFile and
  61 /// DocumentClass. These subclasses are what are actually used in LyX.
  62 /// Simple TextClass objects are not directly constructed in the main
  63 /// LyX code---the constructor is protected. (That said, in tex2lyx
  64 /// there are what amount to simple TextClass objects.)
  65 ///
  66 /// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file.
  67 /// These are generally static objects---though they can be reloaded
  68 /// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
  69 /// they will never change.
  70 ///
  71 /// A DocumentClass (see below) represents the layout information that
  72 /// is associated with a given Buffer. These are static, in the sense
  73 /// that they will not themselves change, but which DocumentClass is
  74 /// associated with a Buffer can change, as modules are loaded and
  75 /// unloaded, for example.
  76 ///
  77 class TextClass : protected ProtectCopy {
  78 public:
  79         ///
  80         virtual ~TextClass() {};
  81         ///////////////////////////////////////////////////////////////////
  82         // typedefs
  83         ///////////////////////////////////////////////////////////////////
  84         /// The individual paragraph layouts comprising the document class
  85         // NOTE Do NOT try to make this a container of Layout pointers, e.g.,
  86         // std::vector<Layout *>. This will lead to problems. The reason is
  87         // that DocumentClass objects are generally created by copying a
  88         // LayoutFile, which serves as a base for the DocumentClass. If the
  89         // LayoutList is a container of pointers, then every DocumentClass
  90         // that derives from a given LayoutFile (e.g., article) will SHARE
  91         // a basic set of layouts. So if one Buffer were to modify a layout
  92         // (say, Standard), that would modify that layout for EVERY Buffer
  93         // that was based upon the same DocumentClass. (Of course, if you
  94         // really, REALLY want to make LayoutList a vector<Layout *>, then
  95         // you can implement custom assignment and copy constructors.)
  96         //
  97         // NOTE: Layout pointers are directly assigned to paragraphs so a
  98         // container that does not invalidate these pointers after insertion
  99         // is needed.
 100         typedef std::list<Layout> LayoutList;
 101         /// The inset layouts available to this class
 102         typedef std::map<docstring, InsetLayout> InsetLayouts;
 103         ///
 104         typedef LayoutList::const_iterator const_iterator;
 105
 106         ///////////////////////////////////////////////////////////////////
 107         // Iterators
 108         ///////////////////////////////////////////////////////////////////
 109         ///
 110         const_iterator begin() const { return layoutlist_.begin(); }
 111         ///
 112         const_iterator end() const { return layoutlist_.end(); }
 113
 114
 115         ///////////////////////////////////////////////////////////////////
 116         // Layout Info
 117         ///////////////////////////////////////////////////////////////////
 118         ///
 119         Layout const & defaultLayout() const;
 120         ///
 121         docstring const & defaultLayoutName() const;
 122         ///
 123         bool isDefaultLayout(Layout const &) const;
 124         ///
 125         bool isPlainLayout(Layout const &) const;
 126         /// returns a special layout for use when we don't really want one,
 127         /// e.g., in table cells
 128         Layout const & plainLayout() const
 129                         { return operator[](plain_layout_); };
 130         /// the name of the plain layout
 131         docstring const & plainLayoutName() const
 132                         { return plain_layout_; }
 133         /// Enumerate the paragraph styles.
 134         size_t layoutCount() const { return layoutlist_.size(); }
 135         ///
 136         bool hasLayout(docstring const & name) const;
 137         ///
 138         bool hasInsetLayout(docstring const & name) const;
 139         ///
 140         Layout const & operator[](docstring const & vname) const;
 141         /// Inset layouts of this doc class
 142         InsetLayouts const & insetLayouts() const { return insetlayoutlist_; };
 143
 144         ///////////////////////////////////////////////////////////////////
 145         // reading routines
 146         ///////////////////////////////////////////////////////////////////
 147         /// Enum used with TextClass::read
 148         enum ReadType {
 149                 BASECLASS, //>This is a base class, i.e., top-level layout file
 150                 MERGE, //>This is a file included in a layout file
 151                 MODULE, //>This is a layout module
 152                 VALIDATION //>We're just validating
 153         };
 154         /// return values for read()
 155         enum ReturnValues {
 156                 OK,
 157                 ERROR,
 158                 FORMAT_MISMATCH
 159         };
 160
 161         /// Performs the read of the layout file.
 162         /// \return true on success.
 163         bool read(support::FileName const & filename, ReadType rt = BASECLASS);
 164         ///
 165         bool read(std::string const & str, ReadType rt = BASECLASS);
 166         ///
 167         ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
 168         /// validates the layout information passed in str
 169         static bool validate(std::string const & str);
 170
 171         ///////////////////////////////////////////////////////////////////
 172         // loading
 173         ///////////////////////////////////////////////////////////////////
 174         /// Sees to it the textclass structure has been loaded
 175         /// This function will search for $classname.layout in default directories
 176         /// and an optional path, but if path points to a file, it will be loaded
 177         /// directly.
 178         bool load(std::string const & path = std::string()) const;
 179         /// Has this layout file been loaded yet?
 180         /// Overridden by DocumentClass
 181         virtual bool loaded() const { return loaded_; }
 182
 183         ///////////////////////////////////////////////////////////////////
 184         // accessors
 185         ///////////////////////////////////////////////////////////////////
 186         ///
 187         std::string const & name() const { return name_; };
 188         ///
 189         std::string const & description() const {       return description_; };
 190         ///
 191         std::string const & latexname() const { return latexname_; }
 192 protected:
 193         /// Protect construction
 194         TextClass();
 195         ///
 196         Layout & operator[](docstring const & name);
 197         /** Create an new, very basic layout for this textclass. This is used for
 198             the Plain Layout common to all TextClass objects and also, in
 199             DocumentClass, for the creation of new layouts `on the fly' when
 200             previously unknown layouts are encountered.
 201             \param unknown Set to true if this layout is used to represent an
 202             unknown layout
 203          */
 204         Layout createBasicLayout(docstring const & name, bool unknown = false) const;
 205
 206         ///////////////////////////////////////////////////////////////////
 207         // non-const iterators
 208         ///////////////////////////////////////////////////////////////////
 209         ///
 210         typedef LayoutList::iterator iterator;
 211         ///
 212         iterator begin() { return layoutlist_.begin(); }
 213         ///
 214         iterator end() { return layoutlist_.end(); }
 215
 216         ///////////////////////////////////////////////////////////////////
 217         // members
 218         ///////////////////////////////////////////////////////////////////
 219         /// Paragraph styles used in this layout
 220         /// This variable is mutable because unknown layouts can be added
 221         /// to const textclass.
 222         mutable LayoutList layoutlist_;
 223         /// Layout file name
 224         std::string name_;
 225         /// document class name
 226         std::string latexname_;
 227         /// document class description
 228         std::string description_;
 229         /// available types of float, eg. figure, algorithm.
 230         mutable FloatList floatlist_;
 231         /// Types of counters, eg. sections, eqns, figures, avail. in document class.
 232         mutable Counters counters_;
 233         /// Has this layout file been loaded yet?
 234         mutable bool loaded_;
 235         /// Is the TeX class available?
 236         bool texClassAvail_;
 237         ///
 238         std::string opt_fontsize_;
 239         ///
 240         std::string opt_pagestyle_;
 241         /// Specific class options
 242         std::string options_;
 243         ///
 244         std::string pagestyle_;
 245         ///
 246         std::string class_header_;
 247         ///
 248         docstring defaultlayout_;
 249         /// name of plain layout
 250         static const docstring plain_layout_;
 251         /// preamble text to support layout styles
 252         docstring preamble_;
 253         /// latex packages loaded by document class.
 254         std::set<std::string> provides_;
 255         /// latex packages requested by document class.
 256         std::set<std::string> requires_;
 257         /// default modules wanted by document class
 258         LayoutModuleList default_modules_;
 259         /// modules provided by document class
 260         LayoutModuleList provided_modules_;
 261         /// modules excluded by document class
 262         LayoutModuleList excluded_modules_;
 263         ///
 264         unsigned int columns_;
 265         ///
 266         PageSides sides_;
 267         /// header depth to have numbering
 268         int secnumdepth_;
 269         /// header depth to appear in table of contents
 270         int tocdepth_;
 271         /// Can be LaTeX, DocBook, etc.
 272         OutputType outputType_;
 273         /** Base font. The paragraph and layout fonts are resolved against
 274             this font. This has to be fully instantiated. Attributes
 275             FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
 276             extremely illegal.
 277         */
 278         FontInfo defaultfont_;
 279         /// Text that dictates how wide the left margin is on the screen
 280         docstring leftmargin_;
 281         /// Text that dictates how wide the right margin is on the screen
 282         docstring rightmargin_;
 283         /// The type of command used to produce a title
 284         TitleLatexType titletype_;
 285         /// The name of the title command
 286         std::string titlename_;
 287         /// Input layouts available to this layout
 288         InsetLayouts insetlayoutlist_;
 289         /// The minimal TocLevel of sectioning layouts
 290         int min_toclevel_;
 291         /// The maximal TocLevel of sectioning layouts
 292         int max_toclevel_;
 293 private:
 294         ///////////////////////////////////////////////////////////////////
 295         // helper routines for reading layout files
 296         ///////////////////////////////////////////////////////////////////
 297         ///
 298         bool deleteLayout(docstring const &);
 299         ///
 300         bool convertLayoutFormat(support::FileName const &, ReadType);
 301         /// \return true for success.
 302         bool readStyle(Lexer &, Layout &) const;
 303         ///
 304         void readOutputType(Lexer &);
 305         ///
 306         void readTitleType(Lexer &);
 307         ///
 308         void readMaxCounter(Lexer &);
 309         ///
 310         void readClassOptions(Lexer &);
 311         ///
 312         void readCharStyle(Lexer &, std::string const &);
 313         ///
 314         void readFloat(Lexer &);
 315 };
 316
 317
 318 /// A DocumentClass represents the layout information associated with a
 319 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
 320 /// various Modules.
 321 ///
 322 /// In that regard, DocumentClass objects are "dynamic". But this is really
 323 /// an illusion, since DocumentClass objects are not (currently) changed
 324 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
 325 /// discarded---actually, it's kept around in case something on the cut
 326 /// stack needs it---and a new one is created from scratch.
 327 ///
 328 /// In the main LyX code, DocumentClass objects are created only by
 329 /// DocumentClassBundle, for which see below.
 330 ///
 331 class DocumentClass : public TextClass, boost::noncopyable {
 332 public:
 333         ///
 334         virtual ~DocumentClass() {}
 335
 336         ///////////////////////////////////////////////////////////////////
 337         // Layout Info
 338         ///////////////////////////////////////////////////////////////////
 339         /// \return true if there is a Layout with latexname lay
 340         bool hasLaTeXLayout(std::string const & lay) const;
 341         /// A DocumentClass nevers count as loaded, since it is dynamic
 342         virtual bool loaded() { return false; }
 343         /// \return the layout object of an inset given by name. If the name
 344         /// is not found as such, the part after the ':' is stripped off, and
 345         /// searched again. In this way, an error fallback can be provided:
 346         /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
 347         /// will invoke the layout object defined by name = 'CharStyle'.
 348         /// If that doesn't work either, an empty object returns (shouldn't
 349         /// happen).  -- Idea JMarc, comment MV
 350         InsetLayout const & insetLayout(docstring const & name) const;
 351         /// a plain inset layout for use as a default
 352         static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; }
 353         /// add a new layout \c name if it does not exist in layoutlist_
 354         void addLayoutIfNeeded(docstring const & name) const;
 355
 356         ///////////////////////////////////////////////////////////////////
 357         // accessors
 358         ///////////////////////////////////////////////////////////////////
 359         /// the list of floats defined in the document class
 360         FloatList const & floats() const { return floatlist_; }
 361         ///
 362         Counters & counters() const { return counters_; }
 363         ///
 364         std::string const & opt_fontsize() const { return opt_fontsize_; }
 365         ///
 366         std::string const & opt_pagestyle() const { return opt_pagestyle_; }
 367         ///
 368         std::string const & options() const { return options_; }
 369         ///
 370         std::string const & class_header() const { return class_header_; }
 371         ///
 372         std::string const & pagestyle() const { return pagestyle_; }
 373         ///
 374         docstring const & preamble() const { return preamble_; }
 375         /// is this feature already provided by the class?
 376         bool provides(std::string const & p) const;
 377         /// features required by the class?
 378         std::set<std::string> const & requires() const { return requires_; }
 379         ///
 380         unsigned int columns() const { return columns_; }
 381         ///
 382         PageSides sides() const { return sides_; }
 383         ///
 384         int secnumdepth() const { return secnumdepth_; }
 385         ///
 386         int tocdepth() const { return tocdepth_; }
 387         ///
 388         FontInfo const & defaultfont() const { return defaultfont_; }
 389         /// Text that dictates how wide the left margin is on the screen
 390         docstring const & leftmargin() const { return leftmargin_; }
 391         /// Text that dictates how wide the right margin is on the screen
 392         docstring const & rightmargin() const { return rightmargin_; }
 393         /// The type of command used to produce a title
 394         TitleLatexType titletype() const { return titletype_; };
 395         /// The name of the title command
 396         std::string const & titlename() const { return titlename_; };
 397         ///
 398         int size() const { return layoutlist_.size(); }
 399         /// The minimal TocLevel of sectioning layouts
 400         int min_toclevel() const { return min_toclevel_; }
 401         /// The maximal TocLevel of sectioning layouts
 402         int max_toclevel() const { return max_toclevel_; }
 403         /// returns true if the class has a ToC structure
 404         bool hasTocLevels() const;
 405         /// Can be LaTeX, DocBook, etc.
 406         OutputType outputType() const { return outputType_; }
 407 protected:
 408         /// Constructs a DocumentClass based upon a LayoutFile.
 409         DocumentClass(LayoutFile const & tc);
 410         /// Needed in tex2lyx
 411         DocumentClass() {}
 412 private:
 413         /// The only class that can create a DocumentClass is
 414         /// DocumentClassBundle, which calls the protected constructor.
 415         friend class DocumentClassBundle;
 416         ///
 417         static InsetLayout plain_insetlayout_;
 418 };
 419
 420
 421 /// DocumentClassBundle is a container for DocumentClass objects, so that
 422 /// they stay in memory for use by Insets, CutAndPaste, and the like, even
 423 /// when their associated Buffers are destroyed.
 424 /// FIXME Some sort of garbage collection or reference counting wouldn't
 425 /// be a bad idea here. It might be enough to check when a Buffer is closed
 426 /// (or makeDocumentClass is called) whether the old DocumentClass is in use
 427 /// anywhere.
 428 ///
 429 /// This is a singleton class. Its sole instance is accessed via
 430 /// DocumentClassBundle::get().
 431 class DocumentClassBundle : boost::noncopyable {
 432 public:
 433         /// \return The sole instance of this class.
 434         static DocumentClassBundle & get();
 435         /// \return A new DocumentClass based on baseClass, with info added
 436         /// from the modules in modlist.
 437         DocumentClass & makeDocumentClass(LayoutFile const & baseClass,
 438                         LayoutModuleList const & modlist);
 439 private:
 440         /// control instantiation
 441         DocumentClassBundle() {}
 442         /// clean up
 443         ~DocumentClassBundle();
 444         /// \return Reference to a new DocumentClass equal to baseClass
 445         DocumentClass & newClass(LayoutFile const & baseClass);
 446         ///
 447         std::vector<DocumentClass *> documentClasses_;
 448 };
 449
 450
 451 /// convert page sides option to text 1 or 2
 452 std::ostream & operator<<(std::ostream & os, PageSides p);
 453
 454
 455 } // namespace lyx
 456
 457 #endif