Test invalid sanitizeLatexOption() input as well

[lyx.git] / src / TextClass.h

diff --git a/src/TextClass.h b/src/TextClass.h
index fd8011328bfd160750d571180c188eb2f4458078..0a075dd6c588c778f5ff8ec407729072c64a3513 100644 (file)
--- a/src/TextClass.h
+++ b/src/TextClass.h
@@ -11,7 +11,6 @@
 #define TEXTCLASS_H
 
 #include "Citation.h"
-#include "ColorCode.h"
 #include "Counters.h"
 #include "DocumentClassPtr.h"
 #include "FloatList.h"
@@ -189,11 +188,13 @@ public:
        ///
        std::string const & name() const { return name_; }
        ///
+       std::string const & category() const { return category_; }
+       ///
        std::string const & description() const { return description_; }
        ///
        std::string const & latexname() const { return latexname_; }
        ///
-       std::string const & prerequisites() const;
+       std::string const & prerequisites(std::string const & sep = "\n\t") const;
        /// Can be LaTeX, DocBook, etc.
        OutputType outputType() const { return outputType_; }
        /// Can be latex, docbook ... (the name of a format)
@@ -231,6 +232,8 @@ protected:
        mutable LayoutList layoutlist_;
        /// Layout file name
        std::string name_;
+       /// Class category
+       std::string category_;
        /// document class name
        std::string latexname_;
        /// document class description
@@ -274,6 +277,8 @@ protected:
        std::set<std::string> provides_;
        /// latex packages requested by document class.
        std::set<std::string> requires_;
+       ///
+       std::map<std::string, std::string> package_options_;
        /// default modules wanted by document class
        LayoutModuleList default_modules_;
        /// modules provided by document class
@@ -329,6 +334,8 @@ private:
        ///
        bool deleteLayout(docstring const &);
        ///
+       bool deleteInsetLayout(docstring const &);
+       ///
        bool convertLayoutFormat(support::FileName const &, ReadType);
        /// Reads the layout file without running layout2layout.
        ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
@@ -362,12 +369,8 @@ private:
 /// 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
+/// discarded---actually, it will be kept around if 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 {
 public:
        ///
@@ -379,7 +382,7 @@ public:
        /// \return true if there is a Layout with latexname lay
        bool hasLaTeXLayout(std::string const & lay) const;
        /// A DocumentClass nevers count as loaded, since it is dynamic
-       virtual bool loaded() { return false; }
+       virtual bool loaded() const { return false; }
        /// \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:
@@ -393,6 +396,8 @@ public:
        /// add a new layout \c name if it does not exist in layoutlist_
        /// \return whether we had to add one.
        bool addLayoutIfNeeded(docstring const & name) const;
+       /// Forced layouts in layout file syntax
+       std::string forcedLayouts() const;
 
        ///////////////////////////////////////////////////////////////////
        // accessors
@@ -419,6 +424,10 @@ public:
        docstring const & htmlpreamble() const { return htmlpreamble_; }
        ///
        docstring const & htmlstyles() const { return htmlstyles_; }
+       /// Looks for the layout of "highest level", other than Part (or other
+       /// layouts with a negative toc number), for use in constructing TOCs and 
+       /// similar information.
+       Layout const & getTOCLayout() const;
        /// the paragraph style to use for TOCs, Bibliography, etc
        /// we will attempt to calculate this if it was not given
        Layout const & htmlTOCLayout() const;
@@ -426,6 +435,9 @@ public:
        bool provides(std::string const & p) const;
        /// features required by the class?
        std::set<std::string> const & requires() const { return requires_; }
+       /// package options to write to LaTeX file
+       std::map<std::string, std::string> const & packageOptions() const
+               { return package_options_; }
        ///
        unsigned int columns() const { return columns_; }
        ///
@@ -472,10 +484,10 @@ protected:
        /// Needed in tex2lyx
        DocumentClass() {}
 private:
-       /// The only class that can create a DocumentClass is
-       /// DocumentClassBundle, which calls the protected constructor.
+       /// The only way to make a DocumentClass is to call this function.
        friend DocumentClassPtr
-               getDocumentClass(LayoutFile const &, LayoutModuleList const &);
+               getDocumentClass(LayoutFile const &, LayoutModuleList const &,
+                                bool const clone);
        ///
        static InsetLayout plain_insetlayout_;
 };
@@ -486,7 +498,8 @@ private:
 /// in memory long after their associated Buffer is destroyed, mostly
 /// on the CutStack.
 DocumentClassPtr getDocumentClass(LayoutFile const & baseClass,
-                       LayoutModuleList const & modlist);
+                       LayoutModuleList const & modlist,
+                       bool const clone = false);
 
 /// convert page sides option to text 1 or 2
 std::ostream & operator<<(std::ostream & os, PageSides p);