#include "FontInfo.h"
#include "Layout.h"
#include "LayoutEnums.h"
+#include "LayoutModuleList.h"
#include "insets/InsetLayout.h"
#include <boost/noncopyable.hpp>
+#include <list>
#include <map>
#include <set>
+#include <string>
#include <vector>
-#include <list>
namespace lyx {
protected:
ProtectCopy() {}
~ProtectCopy() {}
- ProtectCopy(const ProtectCopy &) {};
+ ProtectCopy(const ProtectCopy &) {}
private:
const ProtectCopy & operator=(const ProtectCopy &);
};
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;
///
typedef LayoutList::const_iterator const_iterator;
-
+
///////////////////////////////////////////////////////////////////
// Iterators
///////////////////////////////////////////////////////////////////
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
/// 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
// 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();
///
- Layout & operator[](docstring const & vname);
- /// Create an empty layout for this textclass.
- /** \param unknown Set to true if this layout is a default 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
/// 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_;
///
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_;
+ /// 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.
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_;
///
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
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
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;
///
///
void readCharStyle(Lexer &, std::string const &);
///
- void readFloat(Lexer &);
+ bool readFloat(Lexer &);
///
- void readCounter(Lexer &);
+ void readCiteFormat(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_; }
- /// add an empty layout \c name if it does not exist in layoutlist_
- void addLayoutIfNeeded(docstring const & name) const;
+ /// 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_
+ /// \return whether we had to add one.
+ bool addLayoutIfNeeded(docstring const & name) const;
///////////////////////////////////////////////////////////////////
// accessors
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?
/// 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
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);
/// 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_;
};
/// 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
projects / lyx.git / blobdiff