};
-/// A TextClass represents a collection of layout information: At the
+/// A TextClass represents a collection of layout information: At the
/// moment, this includes Layout's and InsetLayout's.
///
/// There are two major subclasses of TextClass: LayoutFile and
/// DocumentClass. These subclasses are what are actually used in LyX.
-/// Simple TextClass objects are not directly constructed in the main
+/// Simple TextClass objects are not directly constructed in the main
/// LyX code---the constructor is protected. (That said, in tex2lyx
/// there are what amount to simple TextClass objects.)
///
/// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file.
-/// These are generally static objects---though they can be reloaded
-/// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
+/// These are generally static objects---though they can be reloaded
+/// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
/// they will never change.
///
/// A DocumentClass (see below) represents the layout information that
/// is associated with a given Buffer. These are static, in the sense
/// that they will not themselves change, but which DocumentClass is
-/// associated with a Buffer can change, as modules are loaded and
+/// associated with a Buffer can change, as modules are loaded and
/// unloaded, for example.
///
class TextClass : protected ProtectCopy {
///////////////////////////////////////////////////////////////////
// NOTE Do NOT try to make this a container of Layout pointers, e.g.,
// std::list<Layout *>. This will lead to problems. The reason is
- // that DocumentClass objects are generally created by copying a
+ // 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
docstring const & defaultLayoutName() const;
///
bool isDefaultLayout(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 & plainLayout() const
+ Layout const & plainLayout() const
{ return operator[](plain_layout_); }
/// the name of the plain layout
- docstring const & plainLayoutName() const
+ docstring const & plainLayoutName() const
{ return plain_layout_; }
/// Enumerate the paragraph styles.
size_t layoutCount() const { return layoutlist_.size(); }
// reading routines
///////////////////////////////////////////////////////////////////
/// Enum used with TextClass::read
- enum ReadType {
+ enum ReadType {
BASECLASS, //>This is a base class, i.e., top-level layout file
MERGE, //>This is a file included in a layout file
MODULE, //>This is a layout module
/// 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
///
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
+ 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
+ \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
///////////////////////////////////////////////////////////////////
/// same, but for HTML output
/// this is output as is to the header
docstring htmlpreamble_;
+ /// same, but specifically for CSS information
+ docstring htmlstyles_;
/// the paragraph style to use for TOCs, Bibliography, etc
mutable docstring html_toc_section_;
/// latex packages loaded by document class.
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
///
void readCharStyle(Lexer &, std::string const &);
///
- void readFloat(Lexer &);
+ bool readFloat(Lexer &);
///
void readCiteFormat(Lexer &);
};
/// A DocumentClass represents the layout information associated with a
/// Buffer. It is based upon a LayoutFile, but may be modified by loading
-/// various Modules.
-///
+/// various Modules.
+///
/// 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
-/// stack needs it---and a new one is created from scratch.
-///
+/// 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, boost::noncopyable {
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
docstring const & preamble() const { return preamble_; }
///
docstring const & htmlpreamble() const { return htmlpreamble_; }
+ ///
+ docstring const & htmlstyles() const { return htmlstyles_; }
/// the paragraph style to use for TOCs, Bibliography, etc
/// we will attempt to calculate this if it was not given
Layout const & htmlTOCLayout() const;
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);
};
-/// DocumentClassBundle is a container for DocumentClass objects, so that
+/// DocumentClassBundle is a container for DocumentClass objects, so that
/// they stay in memory for use by Insets, CutAndPaste, and the like, even
/// when their associated Buffers are destroyed.
/// FIXME Some sort of garbage collection or reference counting wouldn't
/// be a bad idea here. It might be enough to check when a Buffer is closed
-/// (or makeDocumentClass is called) whether the old DocumentClass is in use
+/// (or makeDocumentClass is called) whether the old DocumentClass is in use
/// anywhere.
///
-/// This is a singleton class. Its sole instance is accessed via
+/// This is a singleton class. Its sole instance is accessed via
/// DocumentClassBundle::get().
class DocumentClassBundle : boost::noncopyable {
public:
static DocumentClassBundle & get();
/// \return A new DocumentClass based on baseClass, with info added
/// from the modules in modlist.
- DocumentClass & makeDocumentClass(LayoutFile const & baseClass,
+ DocumentClass & makeDocumentClass(LayoutFile const & baseClass,
LayoutModuleList const & modlist);
private:
/// control instantiation
/// 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