2001-12-28 13:26:54 +00:00
|
|
|
// -*- C++ -*-
|
2002-11-07 19:51:22 +00:00
|
|
|
/**
|
2007-04-29 19:53:54 +00:00
|
|
|
* \file TextClass.h
|
2002-11-07 19:51:22 +00:00
|
|
|
* This file is part of LyX, the document processor.
|
|
|
|
* Licence details can be found in the file COPYING.
|
2002-03-21 17:27:08 +00:00
|
|
|
*
|
2003-08-23 00:17:00 +00:00
|
|
|
* Full author contact details are available in file CREDITS.
|
2002-11-07 19:51:22 +00:00
|
|
|
*/
|
2001-12-28 13:26:54 +00:00
|
|
|
|
2007-11-04 09:51:26 +00:00
|
|
|
#ifndef TEXTCLASS_H
|
|
|
|
#define TEXTCLASS_H
|
2001-12-28 13:26:54 +00:00
|
|
|
|
2012-03-01 00:41:30 +00:00
|
|
|
#include "Citation.h"
|
2008-03-07 03:41:12 +00:00
|
|
|
#include "Counters.h"
|
2012-03-13 16:13:31 +00:00
|
|
|
#include "DocumentClassPtr.h"
|
2008-03-07 03:41:12 +00:00
|
|
|
#include "FloatList.h"
|
2007-10-28 18:51:54 +00:00
|
|
|
#include "FontInfo.h"
|
2008-03-06 20:01:30 +00:00
|
|
|
#include "Layout.h"
|
2007-09-29 20:02:32 +00:00
|
|
|
#include "LayoutEnums.h"
|
2009-02-11 23:22:10 +00:00
|
|
|
#include "LayoutModuleList.h"
|
2001-12-28 13:26:54 +00:00
|
|
|
|
2007-11-07 22:31:07 +00:00
|
|
|
#include "insets/InsetLayout.h"
|
|
|
|
|
2007-10-25 12:41:02 +00:00
|
|
|
#include "support/docstring.h"
|
2007-11-07 23:25:08 +00:00
|
|
|
#include "support/types.h"
|
2007-10-25 12:41:02 +00:00
|
|
|
|
2010-03-29 18:37:25 +00:00
|
|
|
#include <list>
|
2007-08-13 12:13:17 +00:00
|
|
|
#include <map>
|
2008-02-25 19:31:31 +00:00
|
|
|
#include <set>
|
2010-03-29 18:37:25 +00:00
|
|
|
#include <string>
|
2008-02-25 19:31:31 +00:00
|
|
|
#include <vector>
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
|
|
namespace lyx {
|
|
|
|
|
2006-11-26 21:30:39 +00:00
|
|
|
namespace support { class FileName; }
|
|
|
|
|
2002-09-06 14:48:01 +00:00
|
|
|
class Counters;
|
2002-09-11 07:39:55 +00:00
|
|
|
class FloatList;
|
2008-02-28 01:42:02 +00:00
|
|
|
class Layout;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
class LayoutFile;
|
2008-02-28 01:42:02 +00:00
|
|
|
class Lexer;
|
2001-12-28 13:26:54 +00:00
|
|
|
|
2008-03-06 23:31:40 +00:00
|
|
|
/// Based upon ideas in boost::noncopyable, inheriting from this
|
|
|
|
/// class effectively makes the copy constructor protected but the
|
|
|
|
/// assignment constructor private.
|
|
|
|
class ProtectCopy
|
|
|
|
{
|
|
|
|
protected:
|
|
|
|
ProtectCopy() {}
|
|
|
|
~ProtectCopy() {}
|
2009-12-10 18:12:35 +00:00
|
|
|
ProtectCopy(const ProtectCopy &) {}
|
2008-03-06 23:31:40 +00:00
|
|
|
private:
|
|
|
|
const ProtectCopy & operator=(const ProtectCopy &);
|
|
|
|
};
|
|
|
|
|
2003-11-12 14:38:26 +00:00
|
|
|
|
2011-12-03 22:15:11 +00:00
|
|
|
/// A TextClass represents a collection of layout information: At the
|
2008-02-25 19:31:31 +00:00
|
|
|
/// moment, this includes Layout's and InsetLayout's.
|
|
|
|
///
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// There are two major subclasses of TextClass: LayoutFile and
|
|
|
|
/// DocumentClass. These subclasses are what are actually used in LyX.
|
2011-12-03 22:15:11 +00:00
|
|
|
/// Simple TextClass objects are not directly constructed in the main
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// LyX code---the constructor is protected. (That said, in tex2lyx
|
|
|
|
/// there are what amount to simple TextClass objects.)
|
2008-07-08 17:57:20 +00:00
|
|
|
///
|
|
|
|
/// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file.
|
2011-12-03 22:15:11 +00:00
|
|
|
/// These are generally static objects---though they can be reloaded
|
|
|
|
/// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
|
2008-07-08 17:57:20 +00:00
|
|
|
/// 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
|
2011-12-03 22:15:11 +00:00
|
|
|
/// associated with a Buffer can change, as modules are loaded and
|
2008-07-08 17:57:20 +00:00
|
|
|
/// unloaded, for example.
|
|
|
|
///
|
2008-03-06 23:31:40 +00:00
|
|
|
class TextClass : protected ProtectCopy {
|
2001-12-28 13:26:54 +00:00
|
|
|
public:
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///
|
2009-12-10 18:12:35 +00:00
|
|
|
virtual ~TextClass() {}
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// typedefs
|
|
|
|
///////////////////////////////////////////////////////////////////
|
2008-03-13 01:09:41 +00:00
|
|
|
// NOTE Do NOT try to make this a container of Layout pointers, e.g.,
|
2010-03-29 18:37:25 +00:00
|
|
|
// std::list<Layout *>. This will lead to problems. The reason is
|
2011-12-03 22:15:11 +00:00
|
|
|
// that DocumentClass objects are generally created by copying a
|
2008-03-13 01:09:41 +00:00
|
|
|
// 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
|
2010-03-29 18:37:25 +00:00
|
|
|
// that was based upon the same DocumentClass.
|
2008-07-11 02:43:02 +00:00
|
|
|
//
|
|
|
|
// NOTE: Layout pointers are directly assigned to paragraphs so a
|
|
|
|
// container that does not invalidate these pointers after insertion
|
|
|
|
// is needed.
|
2010-03-29 18:37:25 +00:00
|
|
|
/// The individual paragraph layouts comprising the document class
|
2008-07-11 02:43:02 +00:00
|
|
|
typedef std::list<Layout> LayoutList;
|
2008-02-25 19:31:31 +00:00
|
|
|
/// The inset layouts available to this class
|
|
|
|
typedef std::map<docstring, InsetLayout> InsetLayouts;
|
2008-03-06 05:59:21 +00:00
|
|
|
///
|
|
|
|
typedef LayoutList::const_iterator const_iterator;
|
2008-12-16 16:11:15 +00:00
|
|
|
|
2008-03-06 05:59:21 +00:00
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// Iterators
|
|
|
|
///////////////////////////////////////////////////////////////////
|
2008-03-06 20:01:30 +00:00
|
|
|
///
|
2008-03-06 05:59:21 +00:00
|
|
|
const_iterator begin() const { return layoutlist_.begin(); }
|
|
|
|
///
|
|
|
|
const_iterator end() const { return layoutlist_.end(); }
|
|
|
|
|
2001-12-28 13:26:54 +00:00
|
|
|
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// Layout Info
|
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
///
|
2008-03-06 20:01:30 +00:00
|
|
|
Layout const & defaultLayout() const;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///
|
|
|
|
docstring const & defaultLayoutName() const;
|
2008-03-06 20:01:30 +00:00
|
|
|
///
|
|
|
|
bool isDefaultLayout(Layout const &) const;
|
2011-12-03 22:15:11 +00:00
|
|
|
///
|
2008-07-10 17:41:52 +00:00
|
|
|
bool isPlainLayout(Layout const &) const;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// returns a special layout for use when we don't really want one,
|
|
|
|
/// e.g., in table cells
|
2011-12-03 22:15:11 +00:00
|
|
|
Layout const & plainLayout() const
|
2009-12-10 18:12:35 +00:00
|
|
|
{ return operator[](plain_layout_); }
|
2008-08-01 20:57:27 +00:00
|
|
|
/// the name of the plain layout
|
2011-12-03 22:15:11 +00:00
|
|
|
docstring const & plainLayoutName() const
|
2008-08-01 21:03:45 +00:00
|
|
|
{ return plain_layout_; }
|
2008-02-23 16:45:38 +00:00
|
|
|
/// Enumerate the paragraph styles.
|
|
|
|
size_t layoutCount() const { return layoutlist_.size(); }
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///
|
|
|
|
bool hasLayout(docstring const & name) const;
|
|
|
|
///
|
2008-12-16 16:11:15 +00:00
|
|
|
bool hasInsetLayout(docstring const & name) const;
|
|
|
|
///
|
2008-03-06 20:01:30 +00:00
|
|
|
Layout const & operator[](docstring const & vname) const;
|
2008-07-28 15:14:37 +00:00
|
|
|
/// Inset layouts of this doc class
|
2009-12-10 18:12:35 +00:00
|
|
|
InsetLayouts const & insetLayouts() const { return insetlayoutlist_; }
|
2002-03-21 17:27:08 +00:00
|
|
|
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// reading routines
|
|
|
|
///////////////////////////////////////////////////////////////////
|
2008-02-23 16:45:38 +00:00
|
|
|
/// Enum used with TextClass::read
|
2011-12-03 22:15:11 +00:00
|
|
|
enum ReadType {
|
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
|
|
|
BASECLASS, //>This is a base class, i.e., top-level layout file
|
|
|
|
MERGE, //>This is a file included in a layout file
|
2008-03-24 12:31:07 +00:00
|
|
|
MODULE, //>This is a layout module
|
|
|
|
VALIDATION //>We're just validating
|
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
|
|
|
};
|
2008-03-24 12:31:07 +00:00
|
|
|
/// return values for read()
|
|
|
|
enum ReturnValues {
|
|
|
|
OK,
|
2011-05-08 00:54:17 +00:00
|
|
|
OK_OLDFORMAT,
|
2008-03-24 12:31:07 +00:00
|
|
|
ERROR,
|
|
|
|
FORMAT_MISMATCH
|
|
|
|
};
|
|
|
|
|
2002-11-07 19:51:22 +00:00
|
|
|
/// Performs the read of the layout file.
|
2008-02-14 03:38:08 +00:00
|
|
|
/// \return true on success.
|
2011-05-08 00:54:17 +00:00
|
|
|
// FIXME Should return ReturnValues....
|
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);
|
2008-03-24 12:31:07 +00:00
|
|
|
///
|
2011-05-08 00:54:17 +00:00
|
|
|
ReturnValues read(std::string const & str, ReadType rt = MODULE);
|
2008-03-24 12:31:07 +00:00
|
|
|
///
|
|
|
|
ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
|
|
|
|
/// validates the layout information passed in str
|
2011-05-08 00:54:17 +00:00
|
|
|
static ReturnValues validate(std::string const & str);
|
|
|
|
///
|
|
|
|
static std::string convert(std::string const & str);
|
2001-12-28 13:26:54 +00:00
|
|
|
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// loading
|
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
/// Sees to it the textclass structure has been loaded
|
2008-07-11 02:43:02 +00:00
|
|
|
/// 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.
|
2006-10-20 22:17:16 +00:00
|
|
|
bool load(std::string const & path = std::string()) const;
|
2004-03-30 16:19:50 +00:00
|
|
|
/// Has this layout file been loaded yet?
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// Overridden by DocumentClass
|
|
|
|
virtual bool loaded() const { return loaded_; }
|
2001-12-28 13:26:54 +00:00
|
|
|
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// accessors
|
|
|
|
///////////////////////////////////////////////////////////////////
|
2007-08-25 07:46:42 +00:00
|
|
|
///
|
2009-04-10 11:06:53 +00:00
|
|
|
std::string const & name() const { return name_; }
|
2001-12-28 13:26:54 +00:00
|
|
|
///
|
2012-10-09 05:17:36 +00:00
|
|
|
std::string const & category() const { return category_; }
|
|
|
|
///
|
2009-04-10 11:06:53 +00:00
|
|
|
std::string const & description() const { return description_; }
|
2008-02-21 16:31:59 +00:00
|
|
|
///
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
std::string const & latexname() const { return latexname_; }
|
2010-03-22 12:25:16 +00:00
|
|
|
///
|
2012-10-09 05:17:36 +00:00
|
|
|
std::string const & prerequisites(std::string const & sep = "\n\t") const;
|
2009-04-10 11:06:53 +00:00
|
|
|
/// Can be LaTeX, DocBook, etc.
|
|
|
|
OutputType outputType() const { return outputType_; }
|
2009-05-28 08:59:25 +00:00
|
|
|
/// Can be latex, docbook ... (the name of a format)
|
|
|
|
std::string outputFormat() const { return outputFormat_; }
|
2008-02-28 21:25:57 +00:00
|
|
|
protected:
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// Protect construction
|
|
|
|
TextClass();
|
2008-03-06 20:01:30 +00:00
|
|
|
///
|
2008-08-01 21:13:03 +00:00
|
|
|
Layout & operator[](docstring const & name);
|
|
|
|
/** Create an new, very basic layout for this textclass. This is used for
|
2011-12-03 22:15:11 +00:00
|
|
|
the Plain Layout common to all TextClass objects and also, in
|
2008-08-01 21:13:03 +00:00
|
|
|
DocumentClass, for the creation of new layouts `on the fly' when
|
|
|
|
previously unknown layouts are encountered.
|
2011-12-03 22:15:11 +00:00
|
|
|
\param unknown Set to true if this layout is used to represent an
|
2008-08-01 21:13:03 +00:00
|
|
|
unknown layout
|
2008-07-15 17:51:57 +00:00
|
|
|
*/
|
2008-08-01 21:13:03 +00:00
|
|
|
Layout createBasicLayout(docstring const & name, bool unknown = false) const;
|
2011-12-03 22:15:11 +00:00
|
|
|
|
2008-03-06 20:01:30 +00:00
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// non-const iterators
|
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
///
|
|
|
|
typedef LayoutList::iterator iterator;
|
|
|
|
///
|
|
|
|
iterator begin() { return layoutlist_.begin(); }
|
|
|
|
///
|
|
|
|
iterator end() { return layoutlist_.end(); }
|
|
|
|
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// members
|
|
|
|
///////////////////////////////////////////////////////////////////
|
2008-02-28 21:25:57 +00:00
|
|
|
/// Paragraph styles used in this layout
|
2008-07-11 02:43:02 +00:00
|
|
|
/// This variable is mutable because unknown layouts can be added
|
|
|
|
/// to const textclass.
|
|
|
|
mutable LayoutList layoutlist_;
|
2002-11-07 19:51:22 +00:00
|
|
|
/// Layout file name
|
2003-10-06 15:43:21 +00:00
|
|
|
std::string name_;
|
2012-10-09 05:17:36 +00:00
|
|
|
/// Class category
|
|
|
|
std::string category_;
|
2002-11-07 19:51:22 +00:00
|
|
|
/// document class name
|
2003-10-06 15:43:21 +00:00
|
|
|
std::string latexname_;
|
2002-11-07 19:51:22 +00:00
|
|
|
/// document class description
|
2003-10-06 15:43:21 +00:00
|
|
|
std::string description_;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// available types of float, eg. figure, algorithm.
|
2008-03-07 03:41:12 +00:00
|
|
|
mutable FloatList floatlist_;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// Types of counters, eg. sections, eqns, figures, avail. in document class.
|
2008-03-07 03:41:12 +00:00
|
|
|
mutable Counters counters_;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// Has this layout file been loaded yet?
|
|
|
|
mutable bool loaded_;
|
|
|
|
/// Is the TeX class available?
|
2010-03-23 14:16:02 +00:00
|
|
|
bool tex_class_avail_;
|
2010-03-22 12:25:16 +00:00
|
|
|
/// document class prerequisites
|
2010-03-25 00:44:15 +00:00
|
|
|
mutable std::string prerequisites_;
|
2012-03-01 00:41:30 +00:00
|
|
|
/// The possible cite engine types
|
|
|
|
std::string opt_enginetype_;
|
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
|
|
|
///
|
2003-10-06 15:43:21 +00:00
|
|
|
std::string opt_fontsize_;
|
2001-12-28 13:26:54 +00:00
|
|
|
///
|
2003-10-06 15:43:21 +00:00
|
|
|
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
|
2003-10-06 15:43:21 +00:00
|
|
|
std::string options_;
|
2001-12-28 13:26:54 +00:00
|
|
|
///
|
2003-10-06 15:43:21 +00:00
|
|
|
std::string pagestyle_;
|
2001-12-28 13:26:54 +00:00
|
|
|
///
|
2003-11-27 16:57:12 +00:00
|
|
|
std::string class_header_;
|
|
|
|
///
|
2007-07-11 13:39:08 +00:00
|
|
|
docstring defaultlayout_;
|
2008-08-01 20:57:27 +00:00
|
|
|
/// name of plain layout
|
2008-08-01 21:03:45 +00:00
|
|
|
static const docstring plain_layout_;
|
2002-11-07 19:51:22 +00:00
|
|
|
/// preamble text to support layout styles
|
2006-11-08 17:22:44 +00:00
|
|
|
docstring preamble_;
|
2009-06-05 17:26:30 +00:00
|
|
|
/// same, but for HTML output
|
2009-06-05 19:42:56 +00:00
|
|
|
/// this is output as is to the header
|
2009-06-05 17:26:30 +00:00
|
|
|
docstring htmlpreamble_;
|
2011-12-06 22:38:46 +00:00
|
|
|
/// same, but specifically for CSS information
|
|
|
|
docstring htmlstyles_;
|
2010-01-12 19:38:31 +00:00
|
|
|
/// the paragraph style to use for TOCs, Bibliography, etc
|
|
|
|
mutable docstring html_toc_section_;
|
2002-11-07 19:51:22 +00:00
|
|
|
/// latex packages loaded by document class.
|
2007-04-06 09:02:23 +00:00
|
|
|
std::set<std::string> provides_;
|
2008-01-07 16:59:10 +00:00
|
|
|
/// latex packages requested by document class.
|
2008-02-01 15:12:04 +00:00
|
|
|
std::set<std::string> requires_;
|
2008-10-23 00:27:03 +00:00
|
|
|
/// default modules wanted by document class
|
2009-02-11 23:22:10 +00:00
|
|
|
LayoutModuleList default_modules_;
|
2008-10-23 00:27:03 +00:00
|
|
|
/// modules provided by document class
|
2009-02-11 23:22:10 +00:00
|
|
|
LayoutModuleList provided_modules_;
|
2008-10-23 00:27:03 +00:00
|
|
|
/// modules excluded by document class
|
2009-02-11 23:22:10 +00:00
|
|
|
LayoutModuleList excluded_modules_;
|
2001-12-28 13:26:54 +00:00
|
|
|
///
|
|
|
|
unsigned int columns_;
|
|
|
|
///
|
|
|
|
PageSides sides_;
|
2002-11-07 19:51:22 +00:00
|
|
|
/// header depth to have numbering
|
2001-12-28 13:26:54 +00:00
|
|
|
int secnumdepth_;
|
2002-11-07 19:51:22 +00:00
|
|
|
/// header depth to appear in table of contents
|
2001-12-28 13:26:54 +00:00
|
|
|
int tocdepth_;
|
2006-08-23 12:43:46 +00:00
|
|
|
/// Can be LaTeX, DocBook, etc.
|
2001-12-28 13:26:54 +00:00
|
|
|
OutputType outputType_;
|
2009-05-28 08:59:25 +00:00
|
|
|
/// Can be latex, docbook ... (the name of a format)
|
|
|
|
std::string outputFormat_;
|
2001-12-28 13:26:54 +00:00
|
|
|
/** Base font. The paragraph and layout fonts are resolved against
|
|
|
|
this font. This has to be fully instantiated. Attributes
|
2007-10-28 18:51:54 +00:00
|
|
|
FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
|
2001-12-28 13:26:54 +00:00
|
|
|
extremely illegal.
|
|
|
|
*/
|
2007-10-28 18:51:54 +00:00
|
|
|
FontInfo defaultfont_;
|
2001-12-28 13:26:54 +00:00
|
|
|
/// Text that dictates how wide the left margin is on the screen
|
2007-08-18 13:21:12 +00:00
|
|
|
docstring leftmargin_;
|
2001-12-28 13:26:54 +00:00
|
|
|
/// Text that dictates how wide the right margin is on the screen
|
2007-08-18 13:21:12 +00:00
|
|
|
docstring rightmargin_;
|
2003-02-13 17:49:09 +00:00
|
|
|
/// The type of command used to produce a title
|
2007-09-29 20:02:32 +00:00
|
|
|
TitleLatexType titletype_;
|
2003-02-13 17:49:09 +00:00
|
|
|
/// The name of the title command
|
2003-10-06 15:43:21 +00:00
|
|
|
std::string titlename_;
|
2007-08-13 12:13:17 +00:00
|
|
|
/// Input layouts available to this layout
|
2008-03-07 03:41:12 +00:00
|
|
|
InsetLayouts insetlayoutlist_;
|
2005-05-12 10:16:04 +00:00
|
|
|
/// The minimal TocLevel of sectioning layouts
|
|
|
|
int min_toclevel_;
|
|
|
|
/// The maximal TocLevel of sectioning layouts
|
|
|
|
int max_toclevel_;
|
2010-03-29 18:37:25 +00:00
|
|
|
/// Citation formatting information
|
2012-03-01 00:41:30 +00:00
|
|
|
std::map<CiteEngineType, std::map<std::string, std::string> > cite_formats_;
|
2010-03-29 20:01:28 +00:00
|
|
|
/// Citation macros
|
2012-03-01 00:41:30 +00:00
|
|
|
std::map<CiteEngineType, std::map<std::string, std::string> > cite_macros_;
|
|
|
|
/// The default BibTeX bibliography style file
|
|
|
|
std::string cite_default_biblio_style_;
|
|
|
|
/// Whether full author lists are supported
|
|
|
|
bool cite_full_author_list_;
|
|
|
|
/// The possible citation styles
|
|
|
|
std::map<CiteEngineType, std::vector<CitationStyle> > cite_styles_;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
private:
|
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// helper routines for reading layout files
|
|
|
|
///////////////////////////////////////////////////////////////////
|
2008-02-21 16:31:59 +00:00
|
|
|
///
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
bool deleteLayout(docstring const &);
|
2008-03-24 12:31:07 +00:00
|
|
|
///
|
2013-02-09 19:31:26 +00:00
|
|
|
bool deleteInsetLayout(docstring const &);
|
|
|
|
///
|
2008-03-24 12:31:07 +00:00
|
|
|
bool convertLayoutFormat(support::FileName const &, ReadType);
|
2009-02-17 20:25:56 +00:00
|
|
|
/// Reads the layout file without running layout2layout.
|
|
|
|
ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// \return true for success.
|
2008-07-11 02:43:02 +00:00
|
|
|
bool readStyle(Lexer &, Layout &) const;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///
|
|
|
|
void readOutputType(Lexer &);
|
|
|
|
///
|
|
|
|
void readTitleType(Lexer &);
|
|
|
|
///
|
|
|
|
void readMaxCounter(Lexer &);
|
|
|
|
///
|
|
|
|
void readClassOptions(Lexer &);
|
|
|
|
///
|
2010-01-14 23:45:53 +00:00
|
|
|
void readCharStyle(Lexer &, std::string const &);
|
|
|
|
///
|
2010-04-18 21:06:38 +00:00
|
|
|
bool readFloat(Lexer &);
|
2010-03-29 18:37:25 +00:00
|
|
|
///
|
2012-03-01 00:41:30 +00:00
|
|
|
bool readCiteEngine(Lexer &);
|
|
|
|
///
|
|
|
|
int readCiteEngineType(Lexer &) const;
|
|
|
|
///
|
|
|
|
bool readCiteFormat(Lexer &);
|
2001-12-28 13:26:54 +00:00
|
|
|
};
|
|
|
|
|
2002-03-02 16:39:54 +00:00
|
|
|
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// A DocumentClass represents the layout information associated with a
|
|
|
|
/// Buffer. It is based upon a LayoutFile, but may be modified by loading
|
2011-12-03 22:15:11 +00:00
|
|
|
/// various Modules.
|
|
|
|
///
|
2008-07-08 18:13:47 +00:00
|
|
|
/// 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
|
2011-12-03 22:15:11 +00:00
|
|
|
/// stack needs it---and a new one is created from scratch.
|
|
|
|
///
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// In the main LyX code, DocumentClass objects are created only by
|
|
|
|
/// DocumentClassBundle, for which see below.
|
2011-12-03 22:15:11 +00:00
|
|
|
///
|
2012-03-13 16:13:31 +00:00
|
|
|
class DocumentClass : public TextClass {
|
2008-02-28 21:25:57 +00:00
|
|
|
public:
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///
|
|
|
|
virtual ~DocumentClass() {}
|
|
|
|
|
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// Layout Info
|
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
/// \return true if there is a Layout with latexname lay
|
2008-02-28 21:25:57 +00:00
|
|
|
bool hasLaTeXLayout(std::string const & lay) const;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// A DocumentClass nevers count as loaded, since it is dynamic
|
2013-05-02 14:38:25 +00:00
|
|
|
virtual bool loaded() const { return false; }
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// \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:
|
|
|
|
/// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
|
|
|
|
/// will invoke the layout object defined by name = 'CharStyle'.
|
|
|
|
/// If that doesn't work either, an empty object returns (shouldn't
|
|
|
|
/// happen). -- Idea JMarc, comment MV
|
|
|
|
InsetLayout const & insetLayout(docstring const & name) const;
|
2008-08-01 20:57:27 +00:00
|
|
|
/// a plain inset layout for use as a default
|
2008-08-01 21:13:03 +00:00
|
|
|
static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; }
|
|
|
|
/// add a new layout \c name if it does not exist in layoutlist_
|
2011-06-08 00:12:57 +00:00
|
|
|
/// \return whether we had to add one.
|
|
|
|
bool addLayoutIfNeeded(docstring const & name) const;
|
2013-05-15 05:19:49 +00:00
|
|
|
/// Forced layouts in layout file syntax
|
|
|
|
std::string forcedLayouts() const;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
|
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
// accessors
|
|
|
|
///////////////////////////////////////////////////////////////////
|
|
|
|
/// the list of floats defined in the document class
|
2008-03-07 03:41:12 +00:00
|
|
|
FloatList const & floats() const { return floatlist_; }
|
|
|
|
///
|
|
|
|
Counters & counters() const { return counters_; }
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///
|
2012-03-01 00:41:30 +00:00
|
|
|
std::string const & opt_enginetype() const { return opt_enginetype_; }
|
|
|
|
///
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
std::string const & opt_fontsize() const { return opt_fontsize_; }
|
|
|
|
///
|
|
|
|
std::string const & opt_pagestyle() const { return opt_pagestyle_; }
|
|
|
|
///
|
|
|
|
std::string const & options() const { return options_; }
|
|
|
|
///
|
|
|
|
std::string const & class_header() const { return class_header_; }
|
|
|
|
///
|
|
|
|
std::string const & pagestyle() const { return pagestyle_; }
|
|
|
|
///
|
|
|
|
docstring const & preamble() const { return preamble_; }
|
2009-06-05 17:26:30 +00:00
|
|
|
///
|
|
|
|
docstring const & htmlpreamble() const { return htmlpreamble_; }
|
2011-12-06 22:38:46 +00:00
|
|
|
///
|
|
|
|
docstring const & htmlstyles() const { return htmlstyles_; }
|
2012-07-21 18:14:12 +00:00
|
|
|
///
|
|
|
|
Layout const & getTOCLayout() const;
|
2010-01-12 19:38:31 +00:00
|
|
|
/// the paragraph style to use for TOCs, Bibliography, etc
|
|
|
|
/// we will attempt to calculate this if it was not given
|
|
|
|
Layout const & htmlTOCLayout() const;
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// is this feature already provided by the class?
|
|
|
|
bool provides(std::string const & p) const;
|
|
|
|
/// features required by the class?
|
|
|
|
std::set<std::string> const & requires() const { return requires_; }
|
|
|
|
///
|
|
|
|
unsigned int columns() const { return columns_; }
|
|
|
|
///
|
|
|
|
PageSides sides() const { return sides_; }
|
|
|
|
///
|
|
|
|
int secnumdepth() const { return secnumdepth_; }
|
|
|
|
///
|
|
|
|
int tocdepth() const { return tocdepth_; }
|
|
|
|
///
|
|
|
|
FontInfo const & defaultfont() const { return defaultfont_; }
|
|
|
|
/// Text that dictates how wide the left margin is on the screen
|
|
|
|
docstring const & leftmargin() const { return leftmargin_; }
|
|
|
|
/// 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
|
2009-12-10 18:12:35 +00:00
|
|
|
TitleLatexType titletype() const { return titletype_; }
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
/// The name of the title command
|
2009-12-10 18:12:35 +00:00
|
|
|
std::string const & titlename() const { return titlename_; }
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///
|
|
|
|
int size() const { return layoutlist_.size(); }
|
|
|
|
/// The minimal TocLevel of sectioning layouts
|
|
|
|
int min_toclevel() const { return min_toclevel_; }
|
|
|
|
/// The maximal TocLevel of sectioning layouts
|
|
|
|
int max_toclevel() const { return max_toclevel_; }
|
|
|
|
/// returns true if the class has a ToC structure
|
|
|
|
bool hasTocLevels() const;
|
2010-03-29 18:37:25 +00:00
|
|
|
///
|
2012-03-01 00:41:30 +00:00
|
|
|
std::string const & getCiteFormat(CiteEngineType const & type,
|
|
|
|
std::string const & entry, std::string const & fallback = "") const;
|
|
|
|
///
|
|
|
|
std::string const & getCiteMacro(CiteEngineType const & type,
|
|
|
|
std::string const & macro) const;
|
|
|
|
///
|
|
|
|
std::vector<std::string> const citeCommands(CiteEngineType const &) const;
|
|
|
|
///
|
|
|
|
std::vector<CitationStyle> const & citeStyles(CiteEngineType const &) const;
|
|
|
|
///
|
|
|
|
std::string const & defaultBiblioStyle() const { return cite_default_biblio_style_; }
|
2010-03-29 20:01:28 +00:00
|
|
|
///
|
2012-03-01 00:41:30 +00:00
|
|
|
bool const & fullAuthorList() const { return cite_full_author_list_; }
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
protected:
|
|
|
|
/// Constructs a DocumentClass based upon a LayoutFile.
|
|
|
|
DocumentClass(LayoutFile const & tc);
|
|
|
|
/// Needed in tex2lyx
|
2008-04-16 21:23:45 +00:00
|
|
|
DocumentClass() {}
|
2008-02-28 01:42:02 +00:00
|
|
|
private:
|
|
|
|
/// The only class that can create a DocumentClass is
|
2008-03-06 23:31:40 +00:00
|
|
|
/// DocumentClassBundle, which calls the protected constructor.
|
2012-03-13 16:13:31 +00:00
|
|
|
friend DocumentClassPtr
|
|
|
|
getDocumentClass(LayoutFile const &, LayoutModuleList const &);
|
This is the last of the commits that hopes to enforce the distinction between "layout files" and "document classes" that was introduced by the modules code. For the most part, these changes just refactor code from TextClass between: (a) a TextClass base class; (b) a LayoutFile subclass, which represents the information in a .layout file; and (c) a DocumentClass subclass, which represents the layout information associated with a Buffer---a LayoutFile plus Modules. Methods from TextClass have been apportioned between the three classes depending upon what is needed where, and signatures have been changed where necessary so that the right kind of class is required.
At this point, there are no simple TextClass objects in the main LyX code, and it is impossible to create them, since the TextClass constructor is protected. Only LayoutFile and DocumentClass objects can be constructed, and for the most part these are constructed only by their respective containers: BaseClassList and DocumentClassBundle. There is an exception: LayoutFile does have a public default constructor, but if anyone knows how to make it go away, please do.
There will be one or two more commits along these lines, but these will be simple renamings. For example, BaseClassList should be LayoutFileList.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23343 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-29 02:45:33 +00:00
|
|
|
///
|
2008-08-01 21:13:03 +00:00
|
|
|
static InsetLayout plain_insetlayout_;
|
2008-02-28 01:42:02 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2012-03-13 16:13:31 +00:00
|
|
|
/// The only way to make a DocumentClass is to call this function.
|
|
|
|
/// The shared_ptr is needed because DocumentClass objects can be kept
|
|
|
|
/// in memory long after their associated Buffer is destroyed, mostly
|
|
|
|
/// on the CutStack.
|
|
|
|
DocumentClassPtr getDocumentClass(LayoutFile const & baseClass,
|
2009-02-11 23:22:10 +00:00
|
|
|
LayoutModuleList const & modlist);
|
2008-02-25 19:31:31 +00:00
|
|
|
|
2002-11-07 19:51:22 +00:00
|
|
|
/// convert page sides option to text 1 or 2
|
2007-11-07 23:25:08 +00:00
|
|
|
std::ostream & operator<<(std::ostream & os, PageSides p);
|
2006-10-21 00:16:43 +00:00
|
|
|
|
2010-07-18 11:58:38 +00:00
|
|
|
/// current format of layout files
|
|
|
|
extern int const LAYOUT_FORMAT;
|
|
|
|
|
2008-02-25 19:31:31 +00:00
|
|
|
|
2006-10-21 00:16:43 +00:00
|
|
|
} // namespace lyx
|
|
|
|
|
2001-12-28 13:26:54 +00:00
|
|
|
#endif
|