X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.h;h=fd8011328bfd160750d571180c188eb2f4458078;hb=4d5bef1bdcbe7a20d67613a793acb89f0e583bf6;hp=f007bb23744b822aa468de35da3549525a8e0c7f;hpb=cf8646083f038ebcca32aec577594a52d70198e4;p=lyx.git diff --git a/src/TextClass.h b/src/TextClass.h index f007bb2374..fd8011328b 100644 --- a/src/TextClass.h +++ b/src/TextClass.h @@ -10,8 +10,10 @@ #ifndef TEXTCLASS_H #define TEXTCLASS_H +#include "Citation.h" #include "ColorCode.h" #include "Counters.h" +#include "DocumentClassPtr.h" #include "FloatList.h" #include "FontInfo.h" #include "Layout.h" @@ -23,12 +25,11 @@ #include "support/docstring.h" #include "support/types.h" -#include - +#include #include #include +#include #include -#include namespace lyx { @@ -54,24 +55,24 @@ private: }; -/// 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 { @@ -81,22 +82,20 @@ public: /////////////////////////////////////////////////////////////////// // 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; @@ -121,14 +120,14 @@ 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 + 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(); } @@ -145,7 +144,7 @@ public: // 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 @@ -154,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 @@ -190,7 +193,7 @@ public: /// std::string const & latexname() const { return latexname_; } /// - std::string const & prerequisites() const { return prerequisites_; } + std::string const & prerequisites() const; /// Can be LaTeX, DocBook, etc. OutputType outputType() const { return outputType_; } /// Can be latex, docbook ... (the name of a format) @@ -201,14 +204,14 @@ protected: /// 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 /////////////////////////////////////////////////////////////////// @@ -239,9 +242,11 @@ 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 - std::string prerequisites_; + mutable std::string prerequisites_; + /// The possible cite engine types + std::string opt_enginetype_; /// std::string opt_fontsize_; /// @@ -261,6 +266,8 @@ protected: /// 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. @@ -305,6 +312,16 @@ 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_; + /// The default BibTeX bibliography style file + std::string cite_default_biblio_style_; + /// Whether full author lists are supported + bool cite_full_author_list_; + /// The possible citation styles + std::map > cite_styles_; private: /////////////////////////////////////////////////////////////////// // helper routines for reading layout files @@ -328,24 +345,30 @@ private: /// void readCharStyle(Lexer &, std::string const &); /// - void readFloat(Lexer &); + bool readFloat(Lexer &); + /// + bool readCiteEngine(Lexer &); + /// + int readCiteEngineType(Lexer &) const; + /// + bool 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 { +/// +class DocumentClass : public TextClass { public: /// virtual ~DocumentClass() {} @@ -368,7 +391,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 @@ -378,6 +402,8 @@ public: /// Counters & counters() const { return counters_; } /// + std::string const & opt_enginetype() const { return opt_enginetype_; } + /// std::string const & opt_fontsize() const { return opt_fontsize_; } /// std::string const & opt_pagestyle() const { return opt_pagestyle_; } @@ -391,6 +417,8 @@ public: 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; @@ -424,6 +452,20 @@ public: int max_toclevel() const { return max_toclevel_; } /// returns true if the class has a ToC structure bool hasTocLevels() const; + /// + std::string const & getCiteFormat(CiteEngineType const & type, + std::string const & entry, std::string const & fallback = "") const; + /// + std::string const & getCiteMacro(CiteEngineType const & type, + std::string const & macro) const; + /// + std::vector const citeCommands(CiteEngineType const &) const; + /// + std::vector const & citeStyles(CiteEngineType const &) const; + /// + std::string const & defaultBiblioStyle() const { return cite_default_biblio_style_; } + /// + bool const & fullAuthorList() const { return cite_full_author_list_; } protected: /// Constructs a DocumentClass based upon a LayoutFile. DocumentClass(LayoutFile const & tc); @@ -432,45 +474,26 @@ protected: private: /// The only class that can create a DocumentClass is /// DocumentClassBundle, which calls the protected constructor. - friend class DocumentClassBundle; + friend DocumentClassPtr + getDocumentClass(LayoutFile const &, LayoutModuleList const &); /// static InsetLayout plain_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 : boost::noncopyable { -public: - /// \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, +/// The only way to make a DocumentClass is to call this function. +/// The shared_ptr is needed because DocumentClass objects can be kept +/// in memory long after their associated Buffer is destroyed, mostly +/// on the CutStack. +DocumentClassPtr getDocumentClass(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_; -}; - /// 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