]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.h
Reorder a bit status messages, but they are still cleared at the end of LyXFunc
[lyx.git] / src / TextClass.h
index 5090a9ecfa17c2b21289d4228f1f340f54409133..67acd5848c4a1a913dd21b9a5795b4c714b37b64 100644 (file)
@@ -16,6 +16,7 @@
 #include "FontInfo.h"
 #include "Layout.h"
 #include "LayoutEnums.h"
+#include "LayoutModuleList.h"
 
 #include "insets/InsetLayout.h"
 
@@ -47,7 +48,7 @@ class ProtectCopy
 protected:
        ProtectCopy() {}
        ~ProtectCopy() {}
-       ProtectCopy(const ProtectCopy &) {};
+       ProtectCopy(const ProtectCopy &) {}
 private:
        const ProtectCopy & operator=(const ProtectCopy &);
 };
@@ -76,7 +77,7 @@ private:
 class TextClass : protected ProtectCopy {
 public:
        ///
-       virtual ~TextClass() {};
+       virtual ~TextClass() {}
        ///////////////////////////////////////////////////////////////////
        // typedefs
        ///////////////////////////////////////////////////////////////////
@@ -101,7 +102,7 @@ public:
        typedef std::map<docstring, InsetLayout> InsetLayouts;
        ///
        typedef LayoutList::const_iterator const_iterator;
-       
+
        ///////////////////////////////////////////////////////////////////
        // Iterators
        ///////////////////////////////////////////////////////////////////
@@ -125,18 +126,20 @@ public:
        /// returns a special layout for use when we don't really want one,
        /// e.g., in table cells
        Layout const & plainLayout() const 
-                       { return operator[](emptylayout_); };
+                       { return operator[](plain_layout_); }
        /// the name of the plain layout
        docstring const & plainLayoutName() const 
-                       { return emptylayout_; }
+                       { 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_; };
+       InsetLayouts const & insetLayouts() const { return insetlayoutlist_; }
 
        ///////////////////////////////////////////////////////////////////
        // reading routines
@@ -181,21 +184,28 @@ 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_; }
+       /// Can be latex, docbook ... (the name of a format)
+       std::string outputFormat() const { return outputFormat_; }
 protected:
        /// Protect construction
        TextClass();
        ///
-       Layout & operator[](docstring const & vname);
-       /// Create an new, empty layout for this textclass.
-       /** \param unknown Set to true if this layout is an empty layout used to
-        * represent an unknown layout
+       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 createEmptyLayout(docstring const & name, bool unknown = false) const;
+       Layout createBasicLayout(docstring const & name, bool unknown = false) const;
        
        ///////////////////////////////////////////////////////////////////
        // non-const iterators
@@ -241,15 +251,22 @@ protected:
        ///
        docstring defaultlayout_;
        /// name of plain layout
-       static const docstring emptylayout_;
+       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_;
        /// 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_;
+       /// 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_;
        ///
@@ -260,6 +277,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
@@ -288,6 +307,8 @@ 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 &) const;
        ///
@@ -302,8 +323,6 @@ private:
        void readCharStyle(Lexer &, std::string const &);
        ///
        void readFloat(Lexer &);
-       ///
-       void readCounter(Lexer &);
 };
 
 
@@ -341,8 +360,8 @@ public:
        /// happen).  -- Idea JMarc, comment MV
        InsetLayout const & insetLayout(docstring const & name) const;
        /// a plain inset layout for use as a default
-       static InsetLayout const & plainInsetLayout() { return empty_insetlayout_; }
-       /// add a new, empty layout \c name if it does not exist in layoutlist_
+       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;
 
        ///////////////////////////////////////////////////////////////////
@@ -364,6 +383,8 @@ public:
        std::string const & pagestyle() const { return pagestyle_; }
        ///
        docstring const & preamble() const { return preamble_; }
+       ///
+       docstring const & htmlpreamble() const { return htmlpreamble_; }
        /// is this feature already provided by the class?
        bool provides(std::string const & p) const;
        /// features required by the class?
@@ -383,9 +404,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
@@ -394,8 +415,6 @@ 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_; }
 protected:
        /// Constructs a DocumentClass based upon a LayoutFile.
        DocumentClass(LayoutFile const & tc);
@@ -406,7 +425,7 @@ private:
        /// DocumentClassBundle, which calls the protected constructor.
        friend class DocumentClassBundle;
        ///
-       static InsetLayout empty_insetlayout_;
+       static InsetLayout plain_insetlayout_;
 };
 
 
@@ -422,15 +441,19 @@ 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::vector<DocumentClass *> documentClasses_;
 };