X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FTextClass.h;h=a25338f111dab5169848338da9a133f03e0fc662;hb=55a3dd7b346d29a52ba305a4558e9e380ef50f47;hp=fd2b50bb9f0292d456f5cb4d4118d690b57ae535;hpb=d841355b7e95ae6971edee7dca18f6ab05f20938;p=lyx.git diff --git a/src/TextClass.h b/src/TextClass.h index fd2b50bb9f..a25338f111 100644 --- a/src/TextClass.h +++ b/src/TextClass.h @@ -16,6 +16,7 @@ #include "FontInfo.h" #include "Layout.h" #include "LayoutEnums.h" +#include "LayoutModuleList.h" #include "insets/InsetLayout.h" @@ -24,10 +25,11 @@ #include +#include #include #include +#include #include -#include namespace lyx { @@ -47,61 +49,59 @@ class ProtectCopy protected: ProtectCopy() {} ~ProtectCopy() {} - ProtectCopy(const ProtectCopy &) {}; + ProtectCopy(const ProtectCopy &) {} private: const ProtectCopy & operator=(const ProtectCopy &); }; -/// A TextClass represents a collection of layout information: At the +/// A TextClass represents a collection of layout information: At the /// moment, this includes Layout's and InsetLayout's. /// /// 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 +/// 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.) /// /// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file. -/// These are generally static objects---though they can be reloaded -/// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that +/// These are generally static objects---though they can be reloaded +/// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that /// they will never change. /// /// A DocumentClass (see below) represents the layout information that /// is associated with a given Buffer. These are static, in the sense /// that they will not themselves change, but which DocumentClass is -/// associated with a Buffer can change, as modules are loaded and +/// associated with a Buffer can change, as modules are loaded and /// unloaded, for example. /// class TextClass : protected ProtectCopy { public: /// - virtual ~TextClass() {}; + virtual ~TextClass() {} /////////////////////////////////////////////////////////////////// // typedefs /////////////////////////////////////////////////////////////////// - /// The individual paragraph layouts comprising the document class // NOTE Do NOT try to make this a container of Layout pointers, e.g., - // std::vector. This will lead to problems. The reason is - // that DocumentClass objects are generally created by copying a + // std::list. This will lead to problems. The reason is + // that DocumentClass objects are generally created by copying a // LayoutFile, which serves as a base for the DocumentClass. If the // LayoutList is a container of pointers, then every DocumentClass // that derives from a given LayoutFile (e.g., article) will SHARE // a basic set of layouts. So if one Buffer were to modify a layout // (say, Standard), that would modify that layout for EVERY Buffer - // that was based upon the same DocumentClass. (Of course, if you - // really, REALLY want to make LayoutList a vector, then - // you can implement custom assignment and copy constructors.) + // that was based upon the same DocumentClass. // // NOTE: Layout pointers are directly assigned to paragraphs so a // container that does not invalidate these pointers after insertion // is needed. + /// The individual paragraph layouts comprising the document class typedef std::list LayoutList; /// The inset layouts available to this class typedef std::map InsetLayouts; /// typedef LayoutList::const_iterator const_iterator; - + /////////////////////////////////////////////////////////////////// // Iterators /////////////////////////////////////////////////////////////////// @@ -120,29 +120,31 @@ public: docstring const & defaultLayoutName() const; /// bool isDefaultLayout(Layout const &) const; - /// + /// bool isPlainLayout(Layout const &) const; /// returns a special layout for use when we don't really want one, /// e.g., in table cells - Layout const & plainLayout() const - { return operator[](plain_layout_); }; + Layout const & plainLayout() const + { return operator[](plain_layout_); } /// the name of the plain layout - docstring const & plainLayoutName() const + docstring const & plainLayoutName() const { return plain_layout_; } /// Enumerate the paragraph styles. size_t layoutCount() const { return layoutlist_.size(); } /// bool hasLayout(docstring const & name) const; /// + bool hasInsetLayout(docstring const & name) const; + /// Layout const & operator[](docstring const & vname) const; /// Inset layouts of this doc class - InsetLayouts const & insetLayouts() const { return insetlayoutlist_; }; + InsetLayouts const & insetLayouts() const { return insetlayoutlist_; } /////////////////////////////////////////////////////////////////// // reading routines /////////////////////////////////////////////////////////////////// /// Enum used with TextClass::read - enum ReadType { + 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 @@ -151,19 +153,23 @@ public: /// return values for read() enum ReturnValues { OK, + OK_OLDFORMAT, ERROR, FORMAT_MISMATCH }; /// Performs the read of the layout file. /// \return true on success. + // FIXME Should return ReturnValues.... bool read(support::FileName const & filename, ReadType rt = BASECLASS); /// - bool read(std::string const & str, ReadType rt = BASECLASS); + ReturnValues read(std::string const & str, ReadType rt = MODULE); /// ReturnValues read(Lexer & lex, ReadType rt = BASECLASS); /// validates the layout information passed in str - static bool validate(std::string const & str); + static ReturnValues validate(std::string const & str); + /// + static std::string convert(std::string const & str); /////////////////////////////////////////////////////////////////// // loading @@ -181,25 +187,31 @@ public: // accessors /////////////////////////////////////////////////////////////////// /// - std::string const & name() const { return name_; }; + std::string const & name() const { return name_; } /// - std::string const & description() const { return description_; }; + std::string const & description() const { return description_; } /// std::string const & latexname() const { return latexname_; } + /// + std::string const & prerequisites() const; + /// Can be LaTeX, DocBook, etc. + OutputType outputType() const { return outputType_; } + /// Can be latex, docbook ... (the name of a format) + std::string outputFormat() const { return outputFormat_; } protected: /// Protect construction TextClass(); /// Layout & operator[](docstring const & name); /** Create an new, very basic layout for this textclass. This is used for - the Plain Layout common to all TextClass objects and also, in + the Plain Layout common to all TextClass objects and also, in DocumentClass, for the creation of new layouts `on the fly' when previously unknown layouts are encountered. - \param unknown Set to true if this layout is used to represent an + \param unknown Set to true if this layout is used to represent an unknown layout */ Layout createBasicLayout(docstring const & name, bool unknown = false) const; - + /////////////////////////////////////////////////////////////////// // non-const iterators /////////////////////////////////////////////////////////////////// @@ -230,7 +242,9 @@ protected: /// Has this layout file been loaded yet? mutable bool loaded_; /// Is the TeX class available? - bool texClassAvail_; + bool tex_class_avail_; + /// document class prerequisites + mutable std::string prerequisites_; /// std::string opt_fontsize_; /// @@ -247,12 +261,23 @@ protected: static const docstring plain_layout_; /// preamble text to support layout styles docstring preamble_; + /// same, but for HTML output + /// this is output as is to the header + docstring htmlpreamble_; + /// same, but specifically for CSS information + docstring htmlstyles_; + /// the paragraph style to use for TOCs, Bibliography, etc + mutable docstring html_toc_section_; /// latex packages loaded by document class. std::set provides_; /// latex packages requested by document class. std::set requires_; - /// modules wanted by document class - std::set usemod_; + /// default modules wanted by document class + LayoutModuleList default_modules_; + /// modules provided by document class + LayoutModuleList provided_modules_; + /// modules excluded by document class + LayoutModuleList excluded_modules_; /// unsigned int columns_; /// @@ -263,6 +288,8 @@ protected: int tocdepth_; /// Can be LaTeX, DocBook, etc. OutputType outputType_; + /// Can be latex, docbook ... (the name of a format) + std::string outputFormat_; /** 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 @@ -283,6 +310,10 @@ protected: int min_toclevel_; /// The maximal TocLevel of sectioning layouts int max_toclevel_; + /// Citation formatting information + std::map cite_formats_; + /// Citation macros + std::map cite_macros_; private: /////////////////////////////////////////////////////////////////// // helper routines for reading layout files @@ -291,6 +322,8 @@ private: bool deleteLayout(docstring const &); /// bool convertLayoutFormat(support::FileName const &, ReadType); + /// Reads the layout file without running layout2layout. + ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt); /// \return true for success. bool readStyle(Lexer &, Layout &) const; /// @@ -304,23 +337,25 @@ private: /// void readCharStyle(Lexer &, std::string const &); /// - void readFloat(Lexer &); + bool readFloat(Lexer &); + /// + void readCiteFormat(Lexer &); }; /// A DocumentClass represents the layout information associated with a /// Buffer. It is based upon a LayoutFile, but may be modified by loading -/// various Modules. -/// +/// various Modules. +/// /// In that regard, DocumentClass objects are "dynamic". But this is really /// an illusion, since DocumentClass objects are not (currently) changed /// when, say, a new Module is loaded. Rather, the old DocumentClass is /// discarded---actually, it's kept around in case something on the cut -/// stack needs it---and a new one is created from scratch. -/// +/// stack needs it---and a new one is created from scratch. +/// /// In the main LyX code, DocumentClass objects are created only by /// DocumentClassBundle, for which see below. -/// +/// class DocumentClass : public TextClass, boost::noncopyable { public: /// @@ -344,7 +379,8 @@ public: /// a plain inset layout for use as a default static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; } /// add a new layout \c name if it does not exist in layoutlist_ - void addLayoutIfNeeded(docstring const & name) const; + /// \return whether we had to add one. + bool addLayoutIfNeeded(docstring const & name) const; /////////////////////////////////////////////////////////////////// // accessors @@ -365,6 +401,13 @@ public: std::string const & pagestyle() const { return pagestyle_; } /// docstring const & preamble() const { return preamble_; } + /// + docstring const & htmlpreamble() const { return htmlpreamble_; } + /// + docstring const & htmlstyles() const { return htmlstyles_; } + /// the paragraph style to use for TOCs, Bibliography, etc + /// we will attempt to calculate this if it was not given + Layout const & htmlTOCLayout() const; /// is this feature already provided by the class? bool provides(std::string const & p) const; /// features required by the class? @@ -384,9 +427,9 @@ public: /// 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_; }; + TitleLatexType titletype() const { return titletype_; } /// The name of the title command - std::string const & titlename() const { return titlename_; }; + std::string const & titlename() const { return titlename_; } /// int size() const { return layoutlist_.size(); } /// The minimal TocLevel of sectioning layouts @@ -395,8 +438,10 @@ public: 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_; } + /// + std::string const & getCiteFormat(std::string const & entry_type) const; + /// + std::string const & getCiteMacro(std::string const & macro) const; protected: /// Constructs a DocumentClass based upon a LayoutFile. DocumentClass(LayoutFile const & tc); @@ -411,27 +456,31 @@ private: }; -/// DocumentClassBundle is a container for DocumentClass objects, so that +/// 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 +/// (or makeDocumentClass is called) whether the old DocumentClass is in use /// anywhere. /// -/// This is a singleton class. Its sole instance is accessed via +/// This is a singleton class. Its sole instance is accessed via /// DocumentClassBundle::get(). class DocumentClassBundle : boost::noncopyable { 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(); + /// \return A new DocumentClass based on baseClass, with info added + /// from the modules in modlist. + DocumentClass & makeDocumentClass(LayoutFile const & baseClass, + LayoutModuleList const & modlist); private: /// control instantiation DocumentClassBundle() {} /// clean up ~DocumentClassBundle(); + /// \return Reference to a new DocumentClass equal to baseClass + DocumentClass & newClass(LayoutFile const & baseClass); /// std::vector documentClasses_; }; @@ -440,6 +489,9 @@ private: /// convert page sides option to text 1 or 2 std::ostream & operator<<(std::ostream & os, PageSides p); +/// current format of layout files +extern int const LAYOUT_FORMAT; + } // namespace lyx