]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.h
Fix bug #7212: Paragraph::forToc has to include the labelString.
[lyx.git] / src / TextClass.h
index 60cc25a83020f475ef352bf69389fef05465cbd6..f3d2197278b4617562ceea27195ef2acd25a94fd 100644 (file)
 
 #include <boost/noncopyable.hpp>
 
+#include <list>
 #include <map>
 #include <set>
+#include <string>
 #include <vector>
-#include <list>
 
 namespace lyx {
 
@@ -48,7 +49,7 @@ class ProtectCopy
 protected:
        ProtectCopy() {}
        ~ProtectCopy() {}
-       ProtectCopy(const ProtectCopy &) {};
+       ProtectCopy(const ProtectCopy &) {}
 private:
        const ProtectCopy & operator=(const ProtectCopy &);
 };
@@ -77,26 +78,24 @@ private:
 class TextClass : protected ProtectCopy {
 public:
        ///
-       virtual ~TextClass() {};
+       virtual ~TextClass() {}
        ///////////////////////////////////////////////////////////////////
        // 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<Layout *>. This will lead to problems. The reason is
+       // std::list<Layout *>. 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<Layout *>, 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<Layout> LayoutList;
        /// The inset layouts available to this class
        typedef std::map<docstring, InsetLayout> InsetLayouts;
@@ -126,7 +125,7 @@ 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[](plain_layout_); };
+                       { return operator[](plain_layout_); }
        /// the name of the plain layout
        docstring const & plainLayoutName() const 
                        { return plain_layout_; }
@@ -139,7 +138,7 @@ public:
        ///
        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
@@ -184,11 +183,17 @@ 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_; }
+       ///
+       std::string const & prerequisites() const;
+       /// 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();
@@ -233,7 +238,9 @@ 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
+       mutable std::string prerequisites_;
        ///
        std::string opt_fontsize_;
        ///
@@ -250,6 +257,11 @@ protected:
        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_;
+       /// the paragraph style to use for TOCs, Bibliography, etc
+       mutable docstring html_toc_section_;
        /// latex packages loaded by document class.
        std::set<std::string> provides_;
        /// latex packages requested by document class.
@@ -270,6 +282,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
@@ -290,6 +304,10 @@ protected:
        int min_toclevel_;
        /// The maximal TocLevel of sectioning layouts
        int max_toclevel_;
+       /// Citation formatting information
+       std::map<std::string, std::string> cite_formats_;
+       /// Citation macros
+       std::map<std::string, std::string> cite_macros_;
 private:
        ///////////////////////////////////////////////////////////////////
        // helper routines for reading layout files
@@ -313,7 +331,9 @@ private:
        ///
        void readCharStyle(Lexer &, std::string const &);
        ///
-       void readFloat(Lexer &);
+       bool readFloat(Lexer &);
+       ///
+       void readCiteFormat(Lexer &);
 };
 
 
@@ -374,6 +394,11 @@ public:
        std::string const & pagestyle() const { return pagestyle_; }
        ///
        docstring const & preamble() const { return preamble_; }
+       ///
+       docstring const & htmlpreamble() const { return htmlpreamble_; }
+       /// the paragraph style to use for TOCs, Bibliography, etc
+       /// we will attempt to calculate this if it was not given
+       Layout const & htmlTOCLayout() const;
        /// is this feature already provided by the class?
        bool provides(std::string const & p) const;
        /// features required by the class?
@@ -393,9 +418,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
@@ -404,8 +429,10 @@ 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_; }
+       ///
+       std::string const & getCiteFormat(std::string const & entry_type) const;
+       ///
+       std::string const & getCiteMacro(std::string const & macro) const;
 protected:
        /// Constructs a DocumentClass based upon a LayoutFile.
        DocumentClass(LayoutFile const & tc);
@@ -453,6 +480,9 @@ private:
 /// 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