X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.h;h=7255165c235c40a8afbb6cdbc8bc2ed3cd3f8ca1;hb=823e44822e6638824900eee2f7e2e7165af97f8d;hp=20181131543c52f6db23d28b4ace90a60dd0fa59;hpb=f401ce5d29cd83ace9d1925cc8c24ceb7a6a41e6;p=lyx.git diff --git a/src/TextClass.h b/src/TextClass.h index 2018113154..7255165c23 100644 --- a/src/TextClass.h +++ b/src/TextClass.h @@ -11,22 +11,24 @@ #define TEXTCLASS_H #include "ColorCode.h" +#include "Counters.h" +#include "FloatList.h" #include "FontInfo.h" #include "Layout.h" #include "LayoutEnums.h" -#include "LayoutPtr.h" +#include "LayoutModuleList.h" #include "insets/InsetLayout.h" #include "support/docstring.h" #include "support/types.h" -#include +#include -#include #include #include #include +#include namespace lyx { @@ -38,6 +40,19 @@ class Layout; class LayoutFile; class Lexer; +/// Based upon ideas in boost::noncopyable, inheriting from this +/// class effectively makes the copy constructor protected but the +/// assignment constructor private. +class ProtectCopy +{ +protected: + ProtectCopy() {} + ~ProtectCopy() {} + ProtectCopy(const ProtectCopy &) {}; +private: + const ProtectCopy & operator=(const ProtectCopy &); +}; + /// A TextClass represents a collection of layout information: At the /// moment, this includes Layout's and InsetLayout's. @@ -47,7 +62,19 @@ class Lexer; /// 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 { +/// +/// 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() {}; @@ -55,12 +82,27 @@ public: // typedefs /////////////////////////////////////////////////////////////////// /// The individual paragraph layouts comprising the document class - typedef std::vector LayoutList; + // 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 + // 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.) + // + // NOTE: Layout pointers are directly assigned to paragraphs so a + // container that does not invalidate these pointers after insertion + // is needed. + typedef std::list LayoutList; /// The inset layouts available to this class typedef std::map InsetLayouts; /// typedef LayoutList::const_iterator const_iterator; - + /////////////////////////////////////////////////////////////////// // Iterators /////////////////////////////////////////////////////////////////// @@ -80,20 +122,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 @@ -102,16 +148,33 @@ 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, + ERROR, + FORMAT_MISMATCH }; + /// Performs the read of the layout file. /// \return true on success. bool read(support::FileName const & filename, ReadType rt = BASECLASS); + /// + bool read(std::string const & str, ReadType rt = BASECLASS); + /// + ReturnValues read(Lexer & lex, ReadType rt = BASECLASS); + /// validates the layout information passed in str + static bool validate(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 @@ -121,17 +184,27 @@ 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_; } + /// Can be LaTeX, DocBook, etc. + OutputType outputType() const { return outputType_; } 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 /////////////////////////////////////////////////////////////////// @@ -146,7 +219,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 @@ -154,9 +229,9 @@ protected: /// document class description std::string description_; /// available types of float, eg. figure, algorithm. - boost::shared_ptr floatlist_; + mutable FloatList floatlist_; /// Types of counters, eg. sections, eqns, figures, avail. in document class. - boost::shared_ptr counters_; + mutable Counters counters_; /// Has this layout file been loaded yet? mutable bool loaded_; /// Is the TeX class available? @@ -173,14 +248,20 @@ 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_; /// 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_; /// @@ -206,7 +287,7 @@ protected: /// The name of the title command std::string titlename_; /// Input layouts available to this layout - mutable InsetLayouts insetlayoutlist_; + InsetLayouts insetlayoutlist_; /// The minimal TocLevel of sectioning layouts int min_toclevel_; /// The maximal TocLevel of sectioning layouts @@ -217,8 +298,12 @@ 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 &); + bool readStyle(Lexer &, Layout &) const; /// void readOutputType(Lexer &); /// @@ -231,19 +316,23 @@ private: void readCharStyle(Lexer &, std::string const &); /// void readFloat(Lexer &); - /// - void readCounter(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 { +/// +class DocumentClass : public TextClass, boost::noncopyable { public: /// virtual ~DocumentClass() {} @@ -255,8 +344,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 & 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: @@ -264,20 +351,19 @@ public: /// 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_; } + /// 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; /////////////////////////////////////////////////////////////////// // 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(); } + FloatList const & floats() const { return floatlist_; } + /// + Counters & counters() const { return counters_; } /// std::string const & opt_fontsize() const { return opt_fontsize_; } /// @@ -326,13 +412,13 @@ 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 private constructor. + /// DocumentClassBundle, which calls the protected constructor. friend class DocumentClassBundle; /// - static InsetLayout empty_insetlayout_; + static InsetLayout plain_insetlayout_; }; @@ -346,19 +432,23 @@ private: /// /// This is a singleton class. Its sole instance is accessed via /// DocumentClassBundle::get(). -class DocumentClassBundle { +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() {} - /// noncopyable - DocumentClassBundle(DocumentClassBundle const &); + /// clean up + ~DocumentClassBundle(); + /// \return Reference to a new DocumentClass equal to baseClass + DocumentClass & newClass(LayoutFile const & baseClass); /// - std::list tc_list_; + std::vector documentClasses_; };