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