Parse the picture variant of \framebox correctly (part of bug #6449)

[lyx.git] / src / TextClass.h

diff --git a/src/TextClass.h b/src/TextClass.h
index 71382d43efaef6cfc580680421a14bbe58e18f42..c1e99e950ac16365e17eb464d41934cabd917eec 100644 (file)
--- a/src/TextClass.h
+++ b/src/TextClass.h
@@ -25,10 +25,11 @@
 
 #include <boost/noncopyable.hpp>
 
+#include <list>
 #include <map>
 #include <set>
+#include <string>
 #include <vector>
-#include <list>
 
 namespace lyx {
 
@@ -81,22 +82,20 @@ public:
        ///////////////////////////////////////////////////////////////////
        // 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;
@@ -154,19 +153,23 @@ public:
        /// return values for read()
        enum ReturnValues {
                OK,
+               OK_OLDFORMAT,
                ERROR,
                FORMAT_MISMATCH
        };
 
        /// Performs the read of the layout file.
        /// \return true on success.
+       // FIXME Should return ReturnValues....
        bool read(support::FileName const & filename, ReadType rt = BASECLASS);
        ///
-       bool read(std::string const & str, ReadType rt = BASECLASS);
+       ReturnValues read(std::string const & str, ReadType rt = MODULE);
        ///
        ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
        /// validates the layout information passed in str
-       static bool validate(std::string const & str);
+       static ReturnValues validate(std::string const & str);
+       ///
+       static std::string convert(std::string const & str);
 
        ///////////////////////////////////////////////////////////////////
        // loading
@@ -189,6 +192,8 @@ public:
        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)
@@ -237,7 +242,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_;
        ///
@@ -301,6 +308,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
@@ -322,7 +333,11 @@ private:
        ///
        void readClassOptions(Lexer &);
        ///
-       void readFloat(Lexer &);
+       void readCharStyle(Lexer &, std::string const &);
+       ///
+       bool readFloat(Lexer &);
+       ///
+       void readCiteFormat(Lexer &);
 };
 
 
@@ -362,7 +377,8 @@ public:
        /// 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;
+       /// \return whether we had to add one.
+       bool addLayoutIfNeeded(docstring const & name) const;
 
        ///////////////////////////////////////////////////////////////////
        // accessors
@@ -418,6 +434,10 @@ public:
        int max_toclevel() const { return max_toclevel_; }
        /// returns true if the class has a ToC structure
        bool hasTocLevels() const;
+       ///
+       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);
@@ -465,6 +485,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