#include "FontInfo.h"
#include "Layout.h"
#include "LayoutEnums.h"
+#include "LayoutModuleList.h"
#include "insets/InsetLayout.h"
#include <map>
#include <set>
#include <vector>
+#include <list>
namespace lyx {
// 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;
///
typedef LayoutList::const_iterator const_iterator;
-
+
///////////////////////////////////////////////////////////////////
// Iterators
///////////////////////////////////////////////////////////////////
///
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
- { return operator[](emptylayout_); };
- /// the name of the empty layout
- docstring const & emptyLayoutName() const
- { return emptylayout_; }
+ Layout const & plainLayout() const
+ { return operator[](plain_layout_); };
+ /// the name of the plain layout
+ docstring const & plainLayoutName() const
+ { 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_; };
///////////////////////////////////////////////////////////////////
// reading routines
// 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
// 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_; }
protected:
/// Protect construction
TextClass();
///
- Layout & operator[](docstring const & vname);
-
+ 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 createBasicLayout(docstring const & name, bool unknown = false) const;
+
///////////////////////////////////////////////////////////////////
// non-const iterators
///////////////////////////////////////////////////////////////////
// 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
std::string class_header_;
///
docstring defaultlayout_;
- /// name of empty layout
- static const docstring emptylayout_;
+ /// name of plain layout
+ static const docstring plain_layout_;
/// preamble text to support layout styles
docstring preamble_;
/// latex packages loaded by document class.
std::set<std::string> provides_;
/// latex packages requested by document class.
std::set<std::string> requires_;
+ /// 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_;
///
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 &);
+ bool readStyle(Lexer &, Layout &) const;
///
void readOutputType(Lexer &);
///
void readCharStyle(Lexer &, std::string const &);
///
void readFloat(Lexer &);
- ///
- void readCounter(Lexer &);
};
bool hasLaTeXLayout(std::string const & lay) const;
/// A DocumentClass nevers count as loaded, since it is dynamic
virtual bool loaded() { return false; }
- /// Inset layouts of this doc class
- InsetLayouts const & insetLayouts() const { return insetlayoutlist_; };
/// \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:
/// If that doesn't work either, an empty object returns (shouldn't
/// happen). -- Idea JMarc, comment MV
InsetLayout const & insetLayout(docstring const & name) const;
- /// an empty inset layout for use as a default
- static InsetLayout const & emptyInsetLayout() { return empty_insetlayout_; }
+ /// 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;
///////////////////////////////////////////////////////////////////
// accessors
/// DocumentClassBundle, which calls the protected constructor.
friend class DocumentClassBundle;
///
- static InsetLayout empty_insetlayout_;
+ static InsetLayout plain_insetlayout_;
};
/// 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_;
};
projects / lyx.git / blobdiff