X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.h;h=c1e99e950ac16365e17eb464d41934cabd917eec;hb=1db7ad00fe02ca4ebba56a5e02c2b9856dc538db;hp=67293610ce67e44ed89c98dee94e7df06c9bf616;hpb=3882a0c759cf63136f319586843df119788ff98a;p=lyx.git diff --git a/src/TextClass.h b/src/TextClass.h index 67293610ce..c1e99e950a 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" @@ -27,6 +28,7 @@ #include #include #include +#include #include namespace lyx { @@ -47,7 +49,7 @@ class ProtectCopy protected: ProtectCopy() {} ~ProtectCopy() {} - ProtectCopy(const ProtectCopy &) {}; + ProtectCopy(const ProtectCopy &) {} private: const ProtectCopy & operator=(const ProtectCopy &); }; @@ -61,31 +63,45 @@ private: /// 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 +/// 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 +/// 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 + // 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.) - typedef std::vector LayoutList; + // 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 /////////////////////////////////////////////////////////////////// @@ -105,20 +121,24 @@ public: /// bool isDefaultLayout(Layout const &) const; /// - bool isEmptyLayout(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 & emptyLayout() const - { return operator[](emptylayout_); }; - /// the name of the empty layout - docstring const & emptyLayoutName() const - { return emptylayout_; } + Layout const & plainLayout() const + { return operator[](plain_layout_); } + /// the name of the plain layout + 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_; } /////////////////////////////////////////////////////////////////// // reading routines @@ -127,16 +147,37 @@ public: 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 + MODULE, //>This is a layout module + VALIDATION //>We're just validating + }; + /// 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); + /// + ReturnValues read(std::string const & str, ReadType rt = MODULE); + /// + ReturnValues read(Lexer & lex, ReadType rt = BASECLASS); + /// validates the layout information passed in str + static ReturnValues validate(std::string const & str); + /// + static std::string convert(std::string const & str); /////////////////////////////////////////////////////////////////// // loading /////////////////////////////////////////////////////////////////// /// Sees to it the textclass structure has been loaded + /// This function will search for $classname.layout in default directories + /// and an optional path, but if path points to a file, it will be loaded + /// directly. bool load(std::string const & path = std::string()) const; /// Has this layout file been loaded yet? /// Overridden by DocumentClass @@ -146,17 +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 & vname); - + 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 + 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 + unknown layout + */ + Layout createBasicLayout(docstring const & name, bool unknown = false) const; + /////////////////////////////////////////////////////////////////// // non-const iterators /////////////////////////////////////////////////////////////////// @@ -171,7 +226,9 @@ protected: // members /////////////////////////////////////////////////////////////////// /// Paragraph styles used in this layout - LayoutList layoutlist_; + /// This variable is mutable because unknown layouts can be added + /// to const textclass. + mutable LayoutList layoutlist_; /// Layout file name std::string name_; /// document class name @@ -185,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_; /// @@ -198,14 +257,25 @@ protected: std::string class_header_; /// docstring defaultlayout_; - /// name of empty layout - static const docstring emptylayout_; + /// name of plain layout + 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_; + /// 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_; + /// 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_; /// @@ -216,6 +286,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 @@ -236,14 +308,22 @@ 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 /////////////////////////////////////////////////////////////////// /// 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 &); + bool readStyle(Lexer &, Layout &) const; /// void readOutputType(Lexer &); /// @@ -255,19 +335,25 @@ private: /// void readCharStyle(Lexer &, std::string const &); /// - void readFloat(Lexer &); + bool readFloat(Lexer &); /// - void readCounter(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. It is thus a dynamic object, as opposed to LayoutFile's -/// which are pretty much static. -/// +/// 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. +/// /// In the main LyX code, DocumentClass objects are created only by /// DocumentClassBundle, for which see below. +/// class DocumentClass : public TextClass, boost::noncopyable { public: /// @@ -280,8 +366,6 @@ public: 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 const & 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: @@ -290,8 +374,11 @@ public: /// 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_; } + /// 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_ + /// \return whether we had to add one. + bool addLayoutIfNeeded(docstring const & name) const; /////////////////////////////////////////////////////////////////// // accessors @@ -312,6 +399,11 @@ public: std::string const & pagestyle() const { return pagestyle_; } /// docstring const & preamble() const { return preamble_; } + /// + docstring const & htmlpreamble() const { return htmlpreamble_; } + /// 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? @@ -331,9 +423,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 @@ -342,19 +434,21 @@ 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); /// Needed in tex2lyx - DocumentClass() {}; + DocumentClass() {} private: /// The only class that can create a DocumentClass is /// DocumentClassBundle, which calls the protected constructor. friend class DocumentClassBundle; /// - static InsetLayout empty_insetlayout_; + static InsetLayout plain_insetlayout_; }; @@ -370,21 +464,30 @@ private: /// 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::list tc_list_; + std::vector documentClasses_; }; /// 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