* Full author contact details are available in file CREDITS.
*/
-#ifndef LYXTEXTCLASS_H
-#define LYXTEXTCLASS_H
+#ifndef TEXTCLASS_H
+#define TEXTCLASS_H
-#include "Layout.h"
-#include "lyxlayout_ptr_fwd.h"
+#include "ColorCode.h"
+#include "FontInfo.h"
+#include "LayoutEnums.h"
+#include "LayoutPtr.h"
+
+#include "insets/InsetLayout.h"
+
+#include "support/docstring.h"
+#include "support/types.h"
#include <boost/shared_ptr.hpp>
-#include <vector>
-#include <set>
+#include <list>
#include <map>
+#include <set>
+#include <vector>
namespace lyx {
namespace support { class FileName; }
-class Lexer;
class Counters;
class FloatList;
+class Layout;
+class LayoutFile;
+class Lexer;
+/// A TextClass represents a collection of layout information: At the
+/// moment, this includes Layout's and InsetLayout's.
///
-class InsetLayout {
-public:
- std::string name;
- std::string lyxtype;
- docstring labelstring;
- std::string decoration;
- std::string latextype;
- std::string latexname;
- std::string latexparam;
- Font font;
- Font labelfont;
- Color::color bgcolor;
- std::string preamble;
-};
-
-
-/// List of semantically defined character style insets
-typedef std::vector<InsetLayout> CharStyles;
-
-/// List of inset layouts
-typedef std::map<docstring, InsetLayout> InsetLayouts;
-
-/// Stores the layout specification of a LyX document class.
+/// There are two major subclasses of TextClass: LayoutFile and
+/// DocumentClass. These subclasses are what are actually used in LyX.
+/// Simple TextClass objects are not directly constructed in the main
+/// LyX code---the constructor is protected. (That said, in tex2lyx
+/// there are what amount to simple TextClass objects.)
class TextClass {
public:
- /// The individual styles comprising the document class
+ ///
+ virtual ~TextClass() {};
+ ///////////////////////////////////////////////////////////////////
+ // typedefs
+ ///////////////////////////////////////////////////////////////////
+ /// The individual paragraph layouts comprising the document class
typedef std::vector<LayoutPtr> LayoutList;
- /// Enumerate the paragraph styles.
- typedef LayoutList::const_iterator const_iterator;
- /// Construct a layout with default values. Actual values loaded later.
- explicit
- TextClass(std::string const & = std::string(),
- std::string const & = std::string(),
- std::string const & = std::string(),
- bool = false);
-
- /// check whether the TeX class is available
- bool isTeXClassAvailable() const;
+ /// The inset layouts available to this class
+ typedef std::map<docstring, InsetLayout> InsetLayouts;
- /// paragraph styles begin iterator.
- const_iterator begin() const { return layoutlist_.begin(); }
- /// paragraph styles end iterator
- const_iterator end() const { return layoutlist_.end(); }
-
- /// Performs the read of the layout file.
- bool read(support::FileName const & filename, bool merge = false);
- ///
- void readOutputType(Lexer &);
- ///
- void readTitleType(Lexer &);
- ///
- void readMaxCounter(Lexer &);
+ ///////////////////////////////////////////////////////////////////
+ // Layout Info
+ ///////////////////////////////////////////////////////////////////
///
- void readClassOptions(Lexer &);
- ///
- void readCharStyle(Lexer &, std::string const &);
- ///
- void readInsetLayout(Lexer &, docstring const &);
- ///
- void readFloat(Lexer &);
+ LayoutPtr const & defaultLayout() const;
///
- void readCounter(Lexer &);
+ docstring const & defaultLayoutName() const;
+ /// returns a special layout for use when we don't really want one,
+ /// e.g., in table cells
+ LayoutPtr const & emptyLayout() const
+ { return operator[](emptylayout_); };
+ /// the name of the empty layout
+ docstring const & emptyLayoutName() const
+ { return emptylayout_; }
+ /// Enumerate the paragraph styles.
+ size_t layoutCount() const { return layoutlist_.size(); }
+ /// Access the paragraph styles.
+ LayoutPtr const & layout(size_t index) const { return layoutlist_[index]; }
///
bool hasLayout(docstring const & name) const;
-
///
LayoutPtr const & operator[](docstring const & vname) const;
- /// Sees to that the textclass structure has been loaded
- bool load(std::string const & path = std::string()) const;
- /// Has this layout file been loaded yet?
- bool loaded() const { return loaded_; }
-
- /// the list of floats defined in the document class
- FloatList & floats();
- /// the list of floats defined in the document class
- FloatList const & floats() const;
- /// The Counters present in this document class.
- Counters & counters() const;
- /// CharStyles of this doc class
- CharStyles & charstyles() const { return charstylelist_; };
- /// Inset layouts of this doc class
- InsetLayouts & insetlayouts() const { return insetlayoutlist_; };
- ///
- InsetLayout const & insetlayout(docstring const & name) const;
- ///
- docstring const & defaultLayoutName() const;
- ///
- LayoutPtr const & defaultLayout() const;
- ///
- std::string const & name() const;
- ///
- docstring const & labelstring() const;
- ///
- std::string const & latexname() const;
- ///
- std::string const & description() const;
- ///
- std::string const & opt_fontsize() const;
- ///
- std::string const & opt_pagestyle() const;
- ///
- std::string const & options() const;
- ///
- std::string const & class_header() const;
- ///
- std::string const & pagestyle() const;
- ///
- docstring const & preamble() const;
-
- /// is this feature already provided by the class?
- bool provides(std::string const & p) const;
-
- ///
- unsigned int columns() const;
- ///
- enum PageSides {
- ///
- OneSide,
- ///
- TwoSides
+ ///////////////////////////////////////////////////////////////////
+ // reading routines
+ ///////////////////////////////////////////////////////////////////
+ /// Enum used with TextClass::read
+ enum ReadType {
+ BASECLASS, //>This is a base class, i.e., top-level layout file
+ MERGE, //>This is a file included in a layout file
+ MODULE //>This is a layout module
};
- ///
- PageSides sides() const;
- ///
- int secnumdepth() const;
- ///
- int tocdepth() const;
-
- /// Can be LaTeX, DocBook, etc.
- OutputType outputType() const;
-
- ///
- Font const & defaultfont() const;
-
- /// Text that dictates how wide the left margin is on the screen
- docstring const & leftmargin() const;
-
- /// Text that dictates how wide the right margin is on the screen
- docstring const & rightmargin() const;
+ /// Performs the read of the layout file.
+ /// \return true on success.
+ bool read(support::FileName const & filename, ReadType rt = BASECLASS);
- /// The type of command used to produce a title
- LYX_TITLE_LATEX_TYPES titletype() const;
- /// The name of the title command
- std::string const & titlename() const;
+ ///////////////////////////////////////////////////////////////////
+ // loading
+ ///////////////////////////////////////////////////////////////////
+ /// Sees to it the textclass structure has been loaded
+ bool load(std::string const & path = std::string()) const;
+ /// Has this layout file been loaded yet?
+ /// Overridden by DocumentClass
+ virtual bool loaded() const { return loaded_; }
+ ///////////////////////////////////////////////////////////////////
+ // accessors
+ ///////////////////////////////////////////////////////////////////
///
- int size() const;
- /// The minimal TocLevel of sectioning layouts
- int min_toclevel() const;
- /// The maximal TocLevel of sectioning layouts
- int max_toclevel() const;
- /// returns true if the class has a ToC structure
- bool hasTocLevels() const;
-private:
+ std::string const & name() const { return name_; };
///
- bool delete_layout(docstring const &);
+ std::string const & description() const { return description_; };
///
- bool do_readStyle(Lexer &, Layout &);
+ std::string const & latexname() const { return latexname_; }
+protected:
+ /// Protect construction
+ TextClass();
+ ///////////////////////////////////////////////////////////////////
+ // members
+ ///////////////////////////////////////////////////////////////////
+ /// Paragraph styles used in this layout
+ LayoutList layoutlist_;
/// Layout file name
std::string name_;
/// document class name
std::string latexname_;
/// document class description
std::string description_;
- /// Specific class options
+ /// available types of float, eg. figure, algorithm.
+ boost::shared_ptr<FloatList> floatlist_;
+ /// Types of counters, eg. sections, eqns, figures, avail. in document class.
+ boost::shared_ptr<Counters> counters_;
+ /// Has this layout file been loaded yet?
+ mutable bool loaded_;
+ /// Is the TeX class available?
+ bool texClassAvail_;
+ ///
std::string opt_fontsize_;
///
std::string opt_pagestyle_;
- ///
+ /// Specific class options
std::string options_;
///
std::string pagestyle_;
std::string class_header_;
///
docstring defaultlayout_;
+ /// name of empty layout
+ static const docstring emptylayout_;
/// preamble text to support layout styles
docstring preamble_;
/// latex packages loaded by document class.
std::set<std::string> provides_;
+ /// latex packages requested by document class.
+ std::set<std::string> requires_;
///
unsigned int columns_;
///
OutputType outputType_;
/** Base font. The paragraph and layout fonts are resolved against
this font. This has to be fully instantiated. Attributes
- Font::INHERIT, Font::IGNORE, and Font::TOGGLE are
+ FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
extremely illegal.
*/
- Font defaultfont_;
+ FontInfo defaultfont_;
/// Text that dictates how wide the left margin is on the screen
docstring leftmargin_;
-
/// Text that dictates how wide the right margin is on the screen
docstring rightmargin_;
-
/// The type of command used to produce a title
- LYX_TITLE_LATEX_TYPES titletype_;
+ TitleLatexType titletype_;
/// The name of the title command
std::string titlename_;
-
- /// Paragraph styles used in this layout
- LayoutList layoutlist_;
- /// CharStyles available to this layout
- mutable CharStyles charstylelist_;
-
/// Input layouts available to this layout
mutable InsetLayouts insetlayoutlist_;
+ /// The minimal TocLevel of sectioning layouts
+ int min_toclevel_;
+ /// The maximal TocLevel of sectioning layouts
+ int max_toclevel_;
+private:
+ ///////////////////////////////////////////////////////////////////
+ // helper routines for reading layout files
+ ///////////////////////////////////////////////////////////////////
+ ///
+ bool deleteLayout(docstring const &);
+ /// \return true for success.
+ bool readStyle(Lexer &, Layout &);
+ ///
+ void readOutputType(Lexer &);
+ ///
+ void readTitleType(Lexer &);
+ ///
+ void readMaxCounter(Lexer &);
+ ///
+ void readClassOptions(Lexer &);
+ ///
+ void readCharStyle(Lexer &, std::string const &);
+ ///
+ void readFloat(Lexer &);
+ ///
+ void readCounter(Lexer &);
+};
- /// available types of float, eg. figure, algorithm.
- boost::shared_ptr<FloatList> floatlist_;
-
- /// Types of counters, eg. sections, eqns, figures, avail. in document class.
- boost::shared_ptr<Counters> counters_;
- /// Has this layout file been loaded yet?
- mutable bool loaded_;
-
- /// Is the TeX class available?
- bool texClassAvail_;
+/// A DocumentClass represents the layout information associated with a
+/// Buffer. It is based upon a LayoutFile, but may be modified by loading
+/// various Modules. It is thus a dynamic object, as opposed to LayoutFile's
+/// which are pretty much static.
+///
+/// In the main LyX code, DocumentClass objects are created only by
+/// DocumentClassBundle, for which see below.
+class DocumentClass : public TextClass {
+public:
+ ///
+ virtual ~DocumentClass() {}
+ ///////////////////////////////////////////////////////////////////
+ // Layout Info
+ ///////////////////////////////////////////////////////////////////
+ /// \return true if there is a Layout with latexname lay
+ bool hasLaTeXLayout(std::string const & lay) const;
+ /// A DocumentClass nevers count as loaded, since it is dynamic
+ virtual bool loaded() { return false; }
+ /// Inset layouts of this doc class
+ InsetLayouts & insetLayouts() const { return insetlayoutlist_; };
+ /// \return the layout object of an inset given by name. If the name
+ /// is not found as such, the part after the ':' is stripped off, and
+ /// searched again. In this way, an error fallback can be provided:
+ /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
+ /// will invoke the layout object defined by name = 'CharStyle'.
+ /// If that doesn't work either, an empty object returns (shouldn't
+ /// happen). -- Idea JMarc, comment MV
+ ///
+ InsetLayout const & insetLayout(docstring const & name) const;
+ /// an empty inset layout for use as a default
+ static InsetLayout const & emptyInsetLayout() { return empty_insetlayout_; }
+
+ ///////////////////////////////////////////////////////////////////
+ // accessors
+ ///////////////////////////////////////////////////////////////////
+ /// the list of floats defined in the document class
+ FloatList & floats() { return *floatlist_.get(); }
+ /// the list of floats defined in the document class
+ FloatList const & floats() const { return *floatlist_.get(); }
+ /// The Counters present in this document class.
+ Counters & counters() const { return *counters_.get(); }
+ ///
+ std::string const & opt_fontsize() const { return opt_fontsize_; }
+ ///
+ std::string const & opt_pagestyle() const { return opt_pagestyle_; }
+ ///
+ std::string const & options() const { return options_; }
+ ///
+ std::string const & class_header() const { return class_header_; }
+ ///
+ std::string const & pagestyle() const { return pagestyle_; }
+ ///
+ docstring const & preamble() const { return preamble_; }
+ /// is this feature already provided by the class?
+ bool provides(std::string const & p) const;
+ /// features required by the class?
+ std::set<std::string> const & requires() const { return requires_; }
+ ///
+ unsigned int columns() const { return columns_; }
+ ///
+ PageSides sides() const { return sides_; }
+ ///
+ int secnumdepth() const { return secnumdepth_; }
+ ///
+ int tocdepth() const { return tocdepth_; }
+ ///
+ FontInfo const & defaultfont() const { return defaultfont_; }
+ /// Text that dictates how wide the left margin is on the screen
+ docstring const & leftmargin() const { return leftmargin_; }
+ /// Text that dictates how wide the right margin is on the screen
+ docstring const & rightmargin() const { return rightmargin_; }
+ /// The type of command used to produce a title
+ TitleLatexType titletype() const { return titletype_; };
+ /// The name of the title command
+ std::string const & titlename() const { return titlename_; };
+ ///
+ int size() const { return layoutlist_.size(); }
/// The minimal TocLevel of sectioning layouts
- int min_toclevel_;
+ int min_toclevel() const { return min_toclevel_; }
/// The maximal TocLevel of sectioning layouts
- int max_toclevel_;
+ int max_toclevel() const { return max_toclevel_; }
+ /// returns true if the class has a ToC structure
+ bool hasTocLevels() const;
+ /// Can be LaTeX, DocBook, etc.
+ OutputType outputType() const { return outputType_; }
+protected:
+ /// Constructs a DocumentClass based upon a LayoutFile.
+ DocumentClass(LayoutFile const & tc);
+ /// Needed in tex2lyx
+ DocumentClass() {};
+private:
+ /// The only class that can create a DocumentClass is
+ /// DocumentClassBundle, which calls the private constructor.
+ friend class DocumentClassBundle;
+ ///
+ static InsetLayout empty_insetlayout_;
+};
+
+
+/// DocumentClassBundle is a container for DocumentClass objects, so that
+/// they stay in memory for use by Insets, CutAndPaste, and the like, even
+/// when their associated Buffers are destroyed.
+/// FIXME Some sort of garbage collection or reference counting wouldn't
+/// be a bad idea here. It might be enough to check when a Buffer is closed
+/// (or makeDocumentClass is called) whether the old DocumentClass is in use
+/// anywhere.
+///
+/// This is a singleton class. Its sole instance is accessed via
+/// DocumentClassBundle::get().
+class DocumentClassBundle {
+public:
+ /// \return Pointer to a new class equal to baseClass
+ DocumentClass & newClass(LayoutFile const & baseClass);
+ /// \return The sole instance of this class.
+ static DocumentClassBundle & get();
+private:
+ /// control instantiation
+ DocumentClassBundle() {}
+ /// noncopyable
+ DocumentClassBundle(DocumentClassBundle const &);
+ ///
+ std::list<DocumentClass> tc_list_;
};
/// convert page sides option to text 1 or 2
-std::ostream & operator<<(std::ostream & os, TextClass::PageSides p);
+std::ostream & operator<<(std::ostream & os, PageSides p);
} // namespace lyx