]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.h
InsetHyperlink.cpp: fix a bug I introduced in r26218
[lyx.git] / src / TextClass.h
index 174e12023fde702c7c3c562121b02f78d3977f45..36630238aed0abe171fb0cf7c1ce9d1898c6dec3 100644 (file)
@@ -27,6 +27,7 @@
 #include <map>
 #include <set>
 #include <vector>
+#include <list>
 
 namespace lyx {
 
@@ -91,7 +92,11 @@ public:
        // that was based upon the same DocumentClass. (Of course, if you 
        // really, REALLY want to make LayoutList a vector<Layout *>, then
        // you can implement custom assignment and copy constructors.)
-       typedef std::vector<Layout> LayoutList;
+       //
+       // NOTE: Layout pointers are directly assigned to paragraphs so a
+       // container that does not invalidate these pointers after insertion
+       // is needed.
+       typedef std::list<Layout> LayoutList;
        /// The inset layouts available to this class
        typedef std::map<docstring, InsetLayout> InsetLayouts;
        ///
@@ -116,20 +121,22 @@ 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;
        ///
        Layout const & operator[](docstring const & vname) const;
+       /// Inset layouts of this doc class
+       InsetLayouts const & insetLayouts() const { return insetlayoutlist_; };
 
        ///////////////////////////////////////////////////////////////////
        // reading routines
@@ -162,6 +169,9 @@ public:
        // 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
@@ -180,8 +190,16 @@ 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
        ///////////////////////////////////////////////////////////////////
@@ -196,7 +214,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
@@ -223,14 +243,16 @@ 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<std::string> provides_;
        /// latex packages requested by document class.
        std::set<std::string> requires_;
+       /// modules wanted by document class
+       std::set<std::string> usemod_;
        ///
        unsigned int columns_;
        ///
@@ -270,7 +292,7 @@ private:
        ///
        bool convertLayoutFormat(support::FileName const &, ReadType);
        /// \return true for success.
-       bool readStyle(Lexer &, Layout &);
+       bool readStyle(Lexer &, Layout &) const;
        ///
        void readOutputType(Lexer &);
        ///
@@ -313,8 +335,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:
@@ -323,8 +343,10 @@ 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_
+       void addLayoutIfNeeded(docstring const & name) const;
 
        ///////////////////////////////////////////////////////////////////
        // accessors
@@ -387,7 +409,7 @@ private:
        /// DocumentClassBundle, which calls the protected constructor.
        friend class DocumentClassBundle;
        ///
-       static InsetLayout empty_insetlayout_;
+       static InsetLayout plain_insetlayout_;
 };