* GuiView.cpp:

[lyx.git] / src / TextClass.h

diff --git a/src/TextClass.h b/src/TextClass.h
index 71a2241a40ea0e083c24abf5fd486715a4c3ef27..254ee586fedcf64e9fded392de295a673e61eafd 100644 (file)
--- a/src/TextClass.h
+++ b/src/TextClass.h
@@ -24,10 +24,10 @@
 
 #include <boost/noncopyable.hpp>
 
-#include <list>
 #include <map>
 #include <set>
 #include <vector>
+#include <list>
 
 namespace lyx {
 
@@ -61,6 +61,18 @@ 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:
        ///
@@ -80,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;
        ///
@@ -105,7 +121,7 @@ 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 
@@ -151,6 +167,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
@@ -170,7 +189,12 @@ protected:
        TextClass();
        ///
        Layout & operator[](docstring const & vname);
-
+       /// Create an empty layout for this textclass.
+       /** \param unknown Set to true if this layout is a default layout used to
+        * represent an unknown layout
+        */
+       Layout createEmptyLayout(docstring const & name, bool unknown = false) const;
+       
        ///////////////////////////////////////////////////////////////////
        // non-const iterators
        ///////////////////////////////////////////////////////////////////
@@ -185,7 +209,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
@@ -259,7 +285,7 @@ private:
        ///
        bool convertLayoutFormat(support::FileName const &, ReadType);
        /// \return true for success.
-       bool readStyle(Lexer &, Layout &);
+       bool readStyle(Lexer &, Layout &) const;
        ///
        void readOutputType(Lexer &);
        ///
@@ -279,11 +305,17 @@ private:
 
 /// 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:
        ///
@@ -308,6 +340,8 @@ public:
        InsetLayout const & insetLayout(docstring const & name) const;
        /// an empty inset layout for use as a default
        static InsetLayout const & emptyInsetLayout() { return empty_insetlayout_; }
+       /// add an empty layout \c name if it does not exist in layoutlist_
+       void addLayoutIfNeeded(docstring const & name) const;
 
        ///////////////////////////////////////////////////////////////////
        // accessors
@@ -364,7 +398,7 @@ 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.
@@ -393,8 +427,10 @@ public:
 private:
        /// control instantiation
        DocumentClassBundle() {}
+       /// clean up
+       ~DocumentClassBundle();
        ///
-       std::list<DocumentClass *> tc_list_;
+       std::vector<DocumentClass *> documentClasses_;
 };