lyx_mirror/src/TextClass.h

290 lines
7.2 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file TextClass.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* Full author contact details are available in file CREDITS.
*/
#ifndef LYXTEXTCLASS_H
#define LYXTEXTCLASS_H
#include "Color.h"
#include "Font.h"
#include "LayoutEnums.h"
#include "lyxlayout_ptr_fwd.h"
#include <boost/shared_ptr.hpp>
#include <vector>
#include <set>
#include <map>
namespace lyx {
namespace support { class FileName; }
class Layout;
class Lexer;
class Counters;
class FloatList;
///
class InsetLayout {
public:
std::string name;
std::string lyxtype;
docstring labelstring;
std::string decoration;
std::string latextype;
std::string latexname;
std::string latexparam;
Font font;
Font labelfont;
Color::color bgcolor;
std::string preamble;
};
/// List of inset layouts
typedef std::map<docstring, InsetLayout> InsetLayouts;
/// Stores the layout specification of a LyX document class.
class TextClass {
public:
/// The individual styles comprising the document class
typedef std::vector<LayoutPtr> LayoutList;
/// Enumerate the paragraph styles.
typedef LayoutList::const_iterator const_iterator;
/// Construct a layout with default values. Actual values loaded later.
explicit
TextClass(std::string const & = std::string(),
std::string const & = std::string(),
std::string const & = std::string(),
This is one of a series of patches that will merge the layout modules development in personal/branches/rgheck back into the tree. Design goal: Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes. Thus, one could have a module that defined certain character styles, environments, commands, or what have you, and include it in various documents, each of which uses a different document class, without having to modify the layout files themselves. For example, a theorems.module could be used with article.layout to provide support for theorem-type environments, without having to modify article.layout itself, and the same module could be used with book.layout, etc. This patch adds the backend. The ModuleList class holds a list of the available modules, which are retrieved from lyxmodules.lst, itself generated by configure.py. There are two LFUNs available: modules-clear and module-add, which do the obvious thing; you can test by typing these into the minibuffer, along with the name of one of the available modules: URL (a CharStyle), Endnote (a Custom Inset), and---with the spaces---End To Foot (View>LaTeX and look at the user preamble), which are themselves in lib/layouts. There are some others, too, that allow theorems to be added to classes like article and book. The GUI will come next. Issues: (i) The configure.py script could be improved. It'd be nice, for example, if it tested for the presence of the LaTeX packages a particular module needs. But this would mean re-working the LaTeX script, and I don't know how to do that. Note that at present, the packages are ignored. This will change shortly. (ii) I've used std::string in LyXModule, following what seemed to be a precedent in TextClass. If some of these should be docstrings, please let me know, and I'll change them. (iii) There is at present no distinction between LaTeX and DocBook modules. Should there be? That is: Should there be modules that are available when the document class is a LaTeX class and others that are available only when it is DocBook? Or should there just be one set of modules? Each module can of course indicate for what it is suitable in its description. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19893 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-29 17:59:49 +00:00
bool texClassAvail = false);
/// check whether the TeX class is available
bool isTeXClassAvailable() const;
/// paragraph styles begin iterator.
const_iterator begin() const { return layoutlist_.begin(); }
/// paragraph styles end iterator
const_iterator end() const { return layoutlist_.end(); }
This is one of a series of patches that will merge the layout modules development in personal/branches/rgheck back into the tree. Design goal: Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes. Thus, one could have a module that defined certain character styles, environments, commands, or what have you, and include it in various documents, each of which uses a different document class, without having to modify the layout files themselves. For example, a theorems.module could be used with article.layout to provide support for theorem-type environments, without having to modify article.layout itself, and the same module could be used with book.layout, etc. This patch adds the backend. The ModuleList class holds a list of the available modules, which are retrieved from lyxmodules.lst, itself generated by configure.py. There are two LFUNs available: modules-clear and module-add, which do the obvious thing; you can test by typing these into the minibuffer, along with the name of one of the available modules: URL (a CharStyle), Endnote (a Custom Inset), and---with the spaces---End To Foot (View>LaTeX and look at the user preamble), which are themselves in lib/layouts. There are some others, too, that allow theorems to be added to classes like article and book. The GUI will come next. Issues: (i) The configure.py script could be improved. It'd be nice, for example, if it tested for the presence of the LaTeX packages a particular module needs. But this would mean re-working the LaTeX script, and I don't know how to do that. Note that at present, the packages are ignored. This will change shortly. (ii) I've used std::string in LyXModule, following what seemed to be a precedent in TextClass. If some of these should be docstrings, please let me know, and I'll change them. (iii) There is at present no distinction between LaTeX and DocBook modules. Should there be? That is: Should there be modules that are available when the document class is a LaTeX class and others that are available only when it is DocBook? Or should there just be one set of modules? Each module can of course indicate for what it is suitable in its description. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19893 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-29 17:59:49 +00:00
///Enum used with TextClass::read
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
};
/// Performs the read of the layout file.
This is one of a series of patches that will merge the layout modules development in personal/branches/rgheck back into the tree. Design goal: Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes. Thus, one could have a module that defined certain character styles, environments, commands, or what have you, and include it in various documents, each of which uses a different document class, without having to modify the layout files themselves. For example, a theorems.module could be used with article.layout to provide support for theorem-type environments, without having to modify article.layout itself, and the same module could be used with book.layout, etc. This patch adds the backend. The ModuleList class holds a list of the available modules, which are retrieved from lyxmodules.lst, itself generated by configure.py. There are two LFUNs available: modules-clear and module-add, which do the obvious thing; you can test by typing these into the minibuffer, along with the name of one of the available modules: URL (a CharStyle), Endnote (a Custom Inset), and---with the spaces---End To Foot (View>LaTeX and look at the user preamble), which are themselves in lib/layouts. There are some others, too, that allow theorems to be added to classes like article and book. The GUI will come next. Issues: (i) The configure.py script could be improved. It'd be nice, for example, if it tested for the presence of the LaTeX packages a particular module needs. But this would mean re-working the LaTeX script, and I don't know how to do that. Note that at present, the packages are ignored. This will change shortly. (ii) I've used std::string in LyXModule, following what seemed to be a precedent in TextClass. If some of these should be docstrings, please let me know, and I'll change them. (iii) There is at present no distinction between LaTeX and DocBook modules. Should there be? That is: Should there be modules that are available when the document class is a LaTeX class and others that are available only when it is DocBook? Or should there just be one set of modules? Each module can of course indicate for what it is suitable in its description. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19893 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-29 17:59:49 +00:00
bool read(support::FileName const & filename, ReadType rt = BASECLASS);
///
void readOutputType(Lexer &);
///
void readTitleType(Lexer &);
///
void readMaxCounter(Lexer &);
///
void readClassOptions(Lexer &);
///
void readCharStyle(Lexer &, std::string const &);
///
void readInsetLayout(Lexer &, docstring const &);
///
void readFloat(Lexer &);
///
void readCounter(Lexer &);
///
bool hasLayout(docstring const & name) const;
///
LayoutPtr const & operator[](docstring const & vname) const;
/// Sees to that the textclass structure has been loaded
bool load(std::string const & path = std::string()) const;
/// Has this layout file been loaded yet?
bool loaded() const { return loaded_; }
/// the list of floats defined in the document class
FloatList & floats();
/// the list of floats defined in the document class
FloatList const & floats() const;
/// The Counters present in this document class.
Counters & counters() const;
/// Inset layouts of this doc class
InsetLayouts & insetlayouts() const { return insetlayoutlist_; };
///
InsetLayout const & insetlayout(docstring const & name) const;
///
docstring const & defaultLayoutName() const;
///
LayoutPtr const & defaultLayout() const;
///
std::string const & name() const;
///
docstring const & labelstring() const;
///
std::string const & latexname() const;
///
std::string const & description() const;
///
This is one of a series of patches that will merge the layout modules development in personal/branches/rgheck back into the tree. Design goal: Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes. Thus, one could have a module that defined certain character styles, environments, commands, or what have you, and include it in various documents, each of which uses a different document class, without having to modify the layout files themselves. For example, a theorems.module could be used with article.layout to provide support for theorem-type environments, without having to modify article.layout itself, and the same module could be used with book.layout, etc. This patch adds the backend. The ModuleList class holds a list of the available modules, which are retrieved from lyxmodules.lst, itself generated by configure.py. There are two LFUNs available: modules-clear and module-add, which do the obvious thing; you can test by typing these into the minibuffer, along with the name of one of the available modules: URL (a CharStyle), Endnote (a Custom Inset), and---with the spaces---End To Foot (View>LaTeX and look at the user preamble), which are themselves in lib/layouts. There are some others, too, that allow theorems to be added to classes like article and book. The GUI will come next. Issues: (i) The configure.py script could be improved. It'd be nice, for example, if it tested for the presence of the LaTeX packages a particular module needs. But this would mean re-working the LaTeX script, and I don't know how to do that. Note that at present, the packages are ignored. This will change shortly. (ii) I've used std::string in LyXModule, following what seemed to be a precedent in TextClass. If some of these should be docstrings, please let me know, and I'll change them. (iii) There is at present no distinction between LaTeX and DocBook modules. Should there be? That is: Should there be modules that are available when the document class is a LaTeX class and others that are available only when it is DocBook? Or should there just be one set of modules? Each module can of course indicate for what it is suitable in its description. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19893 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-29 17:59:49 +00:00
bool isModular() const { return modular_; }
/// Sets the layout as a modular one. There is never any
/// need to reset this.
void markAsModular() { modular_ = true; }
///
std::string const & opt_fontsize() const;
///
std::string const & opt_pagestyle() const;
///
std::string const & options() const;
///
std::string const & class_header() const;
///
std::string const & pagestyle() const;
///
docstring const & preamble() const;
/// is this feature already provided by the class?
bool provides(std::string const & p) const;
///
unsigned int columns() const;
///
enum PageSides {
///
OneSide,
///
TwoSides
};
///
PageSides sides() const;
///
int secnumdepth() const;
///
int tocdepth() const;
/// Can be LaTeX, DocBook, etc.
OutputType outputType() const;
///
Font const & defaultfont() const;
/// Text that dictates how wide the left margin is on the screen
docstring const & leftmargin() const;
/// Text that dictates how wide the right margin is on the screen
docstring const & rightmargin() const;
/// The type of command used to produce a title
TitleLatexType titletype() const;
/// The name of the title command
std::string const & titlename() const;
///
int size() const;
/// The minimal TocLevel of sectioning layouts
int min_toclevel() const;
/// The maximal TocLevel of sectioning layouts
int max_toclevel() const;
/// returns true if the class has a ToC structure
bool hasTocLevels() const;
private:
///
bool delete_layout(docstring const &);
///
bool do_readStyle(Lexer &, Layout &);
/// Layout file name
std::string name_;
/// document class name
std::string latexname_;
/// document class description
std::string description_;
This is one of a series of patches that will merge the layout modules development in personal/branches/rgheck back into the tree. Design goal: Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes. Thus, one could have a module that defined certain character styles, environments, commands, or what have you, and include it in various documents, each of which uses a different document class, without having to modify the layout files themselves. For example, a theorems.module could be used with article.layout to provide support for theorem-type environments, without having to modify article.layout itself, and the same module could be used with book.layout, etc. This patch adds the backend. The ModuleList class holds a list of the available modules, which are retrieved from lyxmodules.lst, itself generated by configure.py. There are two LFUNs available: modules-clear and module-add, which do the obvious thing; you can test by typing these into the minibuffer, along with the name of one of the available modules: URL (a CharStyle), Endnote (a Custom Inset), and---with the spaces---End To Foot (View>LaTeX and look at the user preamble), which are themselves in lib/layouts. There are some others, too, that allow theorems to be added to classes like article and book. The GUI will come next. Issues: (i) The configure.py script could be improved. It'd be nice, for example, if it tested for the presence of the LaTeX packages a particular module needs. But this would mean re-working the LaTeX script, and I don't know how to do that. Note that at present, the packages are ignored. This will change shortly. (ii) I've used std::string in LyXModule, following what seemed to be a precedent in TextClass. If some of these should be docstrings, please let me know, and I'll change them. (iii) There is at present no distinction between LaTeX and DocBook modules. Should there be? That is: Should there be modules that are available when the document class is a LaTeX class and others that are available only when it is DocBook? Or should there just be one set of modules? Each module can of course indicate for what it is suitable in its description. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19893 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-29 17:59:49 +00:00
/// whether this is a modular layout, i.e., whether it has been
/// modified by loading of layout modules.
bool modular_;
///
std::string opt_fontsize_;
///
std::string opt_pagestyle_;
This is one of a series of patches that will merge the layout modules development in personal/branches/rgheck back into the tree. Design goal: Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes. Thus, one could have a module that defined certain character styles, environments, commands, or what have you, and include it in various documents, each of which uses a different document class, without having to modify the layout files themselves. For example, a theorems.module could be used with article.layout to provide support for theorem-type environments, without having to modify article.layout itself, and the same module could be used with book.layout, etc. This patch adds the backend. The ModuleList class holds a list of the available modules, which are retrieved from lyxmodules.lst, itself generated by configure.py. There are two LFUNs available: modules-clear and module-add, which do the obvious thing; you can test by typing these into the minibuffer, along with the name of one of the available modules: URL (a CharStyle), Endnote (a Custom Inset), and---with the spaces---End To Foot (View>LaTeX and look at the user preamble), which are themselves in lib/layouts. There are some others, too, that allow theorems to be added to classes like article and book. The GUI will come next. Issues: (i) The configure.py script could be improved. It'd be nice, for example, if it tested for the presence of the LaTeX packages a particular module needs. But this would mean re-working the LaTeX script, and I don't know how to do that. Note that at present, the packages are ignored. This will change shortly. (ii) I've used std::string in LyXModule, following what seemed to be a precedent in TextClass. If some of these should be docstrings, please let me know, and I'll change them. (iii) There is at present no distinction between LaTeX and DocBook modules. Should there be? That is: Should there be modules that are available when the document class is a LaTeX class and others that are available only when it is DocBook? Or should there just be one set of modules? Each module can of course indicate for what it is suitable in its description. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19893 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-29 17:59:49 +00:00
/// Specific class options
std::string options_;
///
std::string pagestyle_;
///
std::string class_header_;
///
docstring defaultlayout_;
/// preamble text to support layout styles
docstring preamble_;
/// latex packages loaded by document class.
std::set<std::string> provides_;
///
unsigned int columns_;
///
PageSides sides_;
/// header depth to have numbering
int secnumdepth_;
/// header depth to appear in table of contents
int tocdepth_;
/// Can be LaTeX, DocBook, etc.
OutputType outputType_;
/** 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
extremely illegal.
*/
Font defaultfont_;
/// Text that dictates how wide the left margin is on the screen
docstring leftmargin_;
/// Text that dictates how wide the right margin is on the screen
docstring rightmargin_;
/// The type of command used to produce a title
TitleLatexType titletype_;
/// The name of the title command
std::string titlename_;
/// Paragraph styles used in this layout
LayoutList layoutlist_;
/// Input layouts available to this layout
mutable InsetLayouts insetlayoutlist_;
/// available types of float, eg. figure, algorithm.
boost::shared_ptr<FloatList> floatlist_;
/// Types of counters, eg. sections, eqns, figures, avail. in document class.
boost::shared_ptr<Counters> counters_;
/// Has this layout file been loaded yet?
mutable bool loaded_;
/// Is the TeX class available?
bool texClassAvail_;
/// The minimal TocLevel of sectioning layouts
int min_toclevel_;
/// The maximal TocLevel of sectioning layouts
int max_toclevel_;
};
/// convert page sides option to text 1 or 2
std::ostream & operator<<(std::ostream & os, TextClass::PageSides p);
/** Shared pointer for possibly modular layout. Needed so that paste,
* for example, will still be able to retain the pointer, even when
* the buffer itself is closed.
*/
typedef boost::shared_ptr<TextClass> TextClassPtr;
} // namespace lyx
#endif