lyx_mirror/src/lyxtextclass.h

271 lines
6.5 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file lyxtextclass.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 "lyxlayout.h"
#include "lyxlayout_ptr_fwd.h"
#include <boost/shared_ptr.hpp>
#include <vector>
class LyXLex;
class Counters;
class FloatList;
///
class CharStyle {
public:
std::string name;
std::string latextype;
std::string latexname;
std::string latexparam;
LyXFont font;
LyXFont labelfont;
std::string preamble;
};
/// List of semantically defined character style insets
typedef std::vector<CharStyle> CharStyles;
/// Stores the layout specification of a LyX document class.
class LyXTextClass {
public:
/// The individual styles comprising the document class
typedef std::vector<LyXLayout_ptr> LayoutList;
/// Enumerate the paragraph styles.
typedef LayoutList::const_iterator const_iterator;
/// Construct a layout with default values. Actual values loaded later.
explicit
LyXTextClass(std::string const & = std::string(),
std::string const & = std::string(),
std::string const & = std::string(),
bool = 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(); }
/// Performs the read of the layout file.
bool read(std::string const & filename, bool merge = false);
///
void readOutputType(LyXLex &);
///
void readTitleType(LyXLex &);
///
void readMaxCounter(LyXLex &);
///
void readClassOptions(LyXLex &);
///
void readCharStyle(LyXLex &, std::string const &);
///
void readFloat(LyXLex &);
///
void readCounter(LyXLex &);
///
bool hasLayout(std::string const & name) const;
///
LyXLayout_ptr const & operator[](std::string const & vname) const;
/// Sees to that the textclass structure has been loaded
bool load(std::string const & path=".") 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;
/// CharStyles of this doc class
CharStyles & charstyles() const { return charstylelist_; };
/// Retrieve element of name s:
CharStyles::iterator charstyle(std::string const & s) const;
///
std::string const & defaultLayoutName() const;
///
LyXLayout_ptr const & defaultLayout() const;
///
std::string const & name() const;
///
std::string const & latexname() const;
///
std::string const & description() const;
///
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;
///
std::string const & preamble() const;
/// Packages that are already loaded by the class
enum Provides {
///
nothing = 0,
///
amsmath = 1,
///
makeidx = 2,
///
url = 4,
///
natbib = 8
};
///
bool provides(Provides p) const;
///
unsigned int columns() const;
///
enum PageSides {
///
OneSide,
///
TwoSides
};
///
PageSides sides() const;
///
int secnumdepth() const;
///
int tocdepth() const;
/// Can be LaTeX, LinuxDoc, etc.
OutputType outputType() const;
///
LyXFont const & defaultfont() const;
/// Text that dictates how wide the left margin is on the screen
std::string const & leftmargin() const;
/// Text that dictates how wide the right margin is on the screen
std::string const & rightmargin() const;
/// The type of command used to produce a title
LYX_TITLE_LATEX_TYPES 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(std::string const &);
///
bool do_readStyle(LyXLex &, LyXLayout &);
/// Layout file name
std::string name_;
/// document class name
std::string latexname_;
/// document class description
std::string description_;
/// Specific class options
std::string opt_fontsize_;
///
std::string opt_pagestyle_;
///
std::string options_;
///
std::string pagestyle_;
///
std::string class_header_;
///
std::string defaultlayout_;
/// preamble text to support layout styles
std::string preamble_;
/// latex packages loaded by document class.
Provides 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, LinuxDoc, etc.
OutputType outputType_;
/** Base font. The paragraph and layout fonts are resolved against
this font. This has to be fully instantiated. Attributes
LyXFont::INHERIT, LyXFont::IGNORE, and LyXFont::TOGGLE are
extremely illegal.
*/
LyXFont defaultfont_;
/// Text that dictates how wide the left margin is on the screen
std::string leftmargin_;
/// Text that dictates how wide the right margin is on the screen
std::string rightmargin_;
/// The type of command used to produce a title
LYX_TITLE_LATEX_TYPES titletype_;
/// The name of the title command
std::string titlename_;
/// Paragraph styles used in this layout
LayoutList layoutlist_;
/// CharStyles available to this layout
mutable CharStyles charstylelist_;
/// 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> ctrs_;
/// 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_;
};
/// Merge two different provides flags into one bit field record
inline
void operator|=(LyXTextClass::Provides & p1, LyXTextClass::Provides p2)
{
p1 = static_cast<LyXTextClass::Provides>(p1 | p2);
}
/// convert page sides option to text 1 or 2
std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p);
#endif