X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.h;h=b84179fb9a0ff3baf2c56c54e8f2c579bae5f6b5;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=cc8ed45ad25b6ba90b4868ae36e1f6cd5b388704;hpb=5d95df6e39ff02786f724a9652d76b80fb6df05b;p=lyx.git diff --git a/src/TextClass.h b/src/TextClass.h index cc8ed45ad2..b84179fb9a 100644 --- a/src/TextClass.h +++ b/src/TextClass.h @@ -10,24 +10,29 @@ #ifndef TEXTCLASS_H #define TEXTCLASS_H -#include "ColorCode.h" +#include "Citation.h" #include "Counters.h" +#include "DocumentClassPtr.h" #include "FloatList.h" #include "FontInfo.h" #include "Layout.h" #include "LayoutEnums.h" +#include "LayoutModuleList.h" #include "insets/InsetLayout.h" #include "support/docstring.h" #include "support/types.h" -#include - +#include #include #include +#include #include -#include + +#ifdef ERROR +#undef ERROR +#endif namespace lyx { @@ -47,61 +52,59 @@ class ProtectCopy protected: ProtectCopy() {} ~ProtectCopy() {} - ProtectCopy(const ProtectCopy &) {}; + ProtectCopy(const ProtectCopy &) {} private: const ProtectCopy & operator=(const ProtectCopy &); }; -/// A TextClass represents a collection of layout information: At the +/// A TextClass represents a collection of layout information: At the /// moment, this includes Layout's and InsetLayout's. /// /// There are two major subclasses of TextClass: LayoutFile and /// DocumentClass. These subclasses are what are actually used in LyX. -/// Simple TextClass objects are not directly constructed in the main +/// Simple TextClass objects are not directly constructed in the main /// LyX code---the constructor is protected. (That said, in tex2lyx /// there are what amount to simple TextClass objects.) /// /// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file. -/// These are generally static objects---though they can be reloaded -/// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that +/// These are generally static objects---though they can be reloaded +/// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that /// they will never change. /// /// A DocumentClass (see below) represents the layout information that /// is associated with a given Buffer. These are static, in the sense /// that they will not themselves change, but which DocumentClass is -/// associated with a Buffer can change, as modules are loaded and +/// associated with a Buffer can change, as modules are loaded and /// unloaded, for example. /// class TextClass : protected ProtectCopy { public: /// - virtual ~TextClass() {}; + virtual ~TextClass() {} /////////////////////////////////////////////////////////////////// // typedefs /////////////////////////////////////////////////////////////////// - /// The individual paragraph layouts comprising the document class // NOTE Do NOT try to make this a container of Layout pointers, e.g., - // std::vector. This will lead to problems. The reason is - // that DocumentClass objects are generally created by copying a + // std::list. This will lead to problems. The reason is + // that DocumentClass objects are generally created by copying a // LayoutFile, which serves as a base for the DocumentClass. If the // LayoutList is a container of pointers, then every DocumentClass // that derives from a given LayoutFile (e.g., article) will SHARE // a basic set of layouts. So if one Buffer were to modify a layout // (say, Standard), that would modify that layout for EVERY Buffer - // that was based upon the same DocumentClass. (Of course, if you - // really, REALLY want to make LayoutList a vector, then - // you can implement custom assignment and copy constructors.) + // that was based upon the same DocumentClass. // // NOTE: Layout pointers are directly assigned to paragraphs so a // container that does not invalidate these pointers after insertion // is needed. + /// The individual paragraph layouts comprising the document class typedef std::list LayoutList; /// The inset layouts available to this class typedef std::map InsetLayouts; /// typedef LayoutList::const_iterator const_iterator; - + /////////////////////////////////////////////////////////////////// // Iterators /////////////////////////////////////////////////////////////////// @@ -120,50 +123,58 @@ public: docstring const & defaultLayoutName() const; /// bool isDefaultLayout(Layout const &) const; - /// + /// bool isPlainLayout(Layout const &) const; /// returns a special layout for use when we don't really want one, /// e.g., in table cells - Layout const & emptyLayout() const - { return operator[](emptylayout_); }; - /// the name of the empty layout - docstring const & emptyLayoutName() const - { return emptylayout_; } + Layout const & plainLayout() const + { return operator[](plain_layout_); } + /// the name of the plain layout + docstring const & plainLayoutName() const + { return plain_layout_; } /// Enumerate the paragraph styles. size_t layoutCount() const { return layoutlist_.size(); } /// bool hasLayout(docstring const & name) const; /// + bool hasInsetLayout(docstring const & name) const; + /// Layout const & operator[](docstring const & vname) const; /// Inset layouts of this doc class - InsetLayouts const & insetLayouts() const { return insetlayoutlist_; }; + InsetLayouts const & insetLayouts() const { return insetlayoutlist_; } /////////////////////////////////////////////////////////////////// // reading routines /////////////////////////////////////////////////////////////////// /// Enum used with TextClass::read - enum ReadType { + enum ReadType { BASECLASS, //>This is a base class, i.e., top-level layout file MERGE, //>This is a file included in a layout file MODULE, //>This is a layout module + CITE_ENGINE, //>This is a cite engine VALIDATION //>We're just validating }; /// return values for read() enum ReturnValues { OK, + OK_OLDFORMAT, ERROR, FORMAT_MISMATCH }; /// Performs the read of the layout file. /// \return true on success. + // FIXME Should return ReturnValues.... bool read(support::FileName const & filename, ReadType rt = BASECLASS); /// - bool read(std::string const & str, ReadType rt = BASECLASS); + ReturnValues read(std::string const & str, ReadType rt = MODULE); /// ReturnValues read(Lexer & lex, ReadType rt = BASECLASS); /// validates the layout information passed in str - static bool validate(std::string const & str); + static ReturnValues validate(std::string const & str); + /// \return the conversion of \param str to the latest layout format + /// compatible with the lyx format. + static std::string convert(std::string const & str); /////////////////////////////////////////////////////////////////// // loading @@ -181,22 +192,39 @@ public: // accessors /////////////////////////////////////////////////////////////////// /// - std::string const & name() const { return name_; }; + std::string const & name() const { return name_; } + /// + std::string const & path() const { return path_; } /// - std::string const & description() const { return description_; }; + std::string const & category() const { return category_; } + /// + std::string const & description() const { return description_; } /// std::string const & latexname() const { return latexname_; } + /// + std::string const & prerequisites(std::string const & sep = "\n\t") const; + /// Can be LaTeX, DocBook, etc. + OutputType outputType() const { return outputType_; } + /// Can be latex, docbook ... (the name of a format) + std::string outputFormat() const { return outputFormat_; } + /// Return the non-localised names for the toc types. + std::map const & + outlinerNames() const { return outliner_names_; } + protected: /// Protect construction TextClass(); /// - Layout & operator[](docstring const & vname); - /// Create an empty layout for this textclass. - /** \param unknown Set to true if this layout is a default layout used to - * represent an unknown layout + Layout & operator[](docstring const & name); + /** Create an new, very basic layout for this textclass. This is used for + the Plain Layout common to all TextClass objects and also, in + DocumentClass, for the creation of new layouts `on the fly' when + previously unknown layouts are encountered. + \param unknown Set to true if this layout is used to represent an + unknown layout */ - Layout createEmptyLayout(docstring const & name, bool unknown = false) const; - + Layout createBasicLayout(docstring const & name, bool unknown = false) const; + /////////////////////////////////////////////////////////////////// // non-const iterators /////////////////////////////////////////////////////////////////// @@ -216,6 +244,10 @@ protected: mutable LayoutList layoutlist_; /// Layout file name std::string name_; + /// Layout file path (empty for system layout files) + std::string path_; + /// Class category + std::string category_; /// document class name std::string latexname_; /// document class description @@ -227,7 +259,13 @@ protected: /// Has this layout file been loaded yet? mutable bool loaded_; /// Is the TeX class available? - bool texClassAvail_; + bool tex_class_avail_; + /// document class prerequisites + mutable std::string prerequisites_; + /// The possible cite engine types + std::string opt_enginetype_; + /// The cite framework (bibtex, biblatex) + std::string citeframework_; /// std::string opt_fontsize_; /// @@ -240,16 +278,29 @@ protected: std::string class_header_; /// docstring defaultlayout_; - /// name of empty layout - static const docstring emptylayout_; + /// name of plain layout + static const docstring plain_layout_; /// preamble text to support layout styles docstring preamble_; + /// same, but for HTML output + /// this is output as is to the header + docstring htmlpreamble_; + /// same, but specifically for CSS information + docstring htmlstyles_; + /// the paragraph style to use for TOCs, Bibliography, etc + mutable docstring html_toc_section_; /// latex packages loaded by document class. std::set provides_; /// latex packages requested by document class. std::set requires_; - /// modules wanted by document class - std::set usemod_; + /// + std::map package_options_; + /// default modules wanted by document class + LayoutModuleList default_modules_; + /// modules provided by document class + LayoutModuleList provided_modules_; + /// modules excluded by document class + LayoutModuleList excluded_modules_; /// unsigned int columns_; /// @@ -260,6 +311,8 @@ protected: int tocdepth_; /// Can be LaTeX, DocBook, etc. OutputType outputType_; + /// Can be latex, docbook ... (the name of a format) + std::string outputFormat_; /** Base font. The paragraph and layout fonts are resolved against this font. This has to be fully instantiated. Attributes FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are @@ -280,6 +333,22 @@ protected: int min_toclevel_; /// The maximal TocLevel of sectioning layouts int max_toclevel_; + /// Citation formatting information + std::map > cite_formats_; + /// Citation macros + std::map > cite_macros_; + /// The default BibTeX bibliography style file + std::map cite_default_biblio_style_; + /// Citation command aliases + std::map cite_command_aliases_; + /// The maximum number of citations before "et al." + size_t maxcitenames_; + /// Whether full author lists are supported + bool cite_full_author_list_; + /// The possible citation styles + std::map > cite_styles_; + /// + std::map outliner_names_; private: /////////////////////////////////////////////////////////////////// // helper routines for reading layout files @@ -287,7 +356,11 @@ private: /// bool deleteLayout(docstring const &); /// + bool deleteInsetLayout(docstring const &); + /// bool convertLayoutFormat(support::FileName const &, ReadType); + /// Reads the layout file without running layout2layout. + ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt); /// \return true for success. bool readStyle(Lexer &, Layout &) const; /// @@ -301,26 +374,28 @@ private: /// void readCharStyle(Lexer &, std::string const &); /// - void readFloat(Lexer &); + bool readFloat(Lexer &); + /// + bool readCiteEngine(Lexer &); + /// + int readCiteEngineType(Lexer &) const; + /// + bool readCiteFormat(Lexer &); /// - void readCounter(Lexer &); + bool readOutlinerName(Lexer &); }; /// A DocumentClass represents the layout information associated with a /// Buffer. It is based upon a LayoutFile, but may be modified by loading -/// various Modules. -/// +/// various Modules. +/// /// In that regard, DocumentClass objects are "dynamic". But this is really /// an illusion, since DocumentClass objects are not (currently) changed /// when, say, a new Module is loaded. Rather, the old DocumentClass is -/// discarded---actually, it's kept around in case something on the cut -/// stack needs it---and a new one is created from scratch. -/// -/// In the main LyX code, DocumentClass objects are created only by -/// DocumentClassBundle, for which see below. -/// -class DocumentClass : public TextClass, boost::noncopyable { +/// discarded---actually, it will be kept around if something on the cut +/// stack needs it---and a new one is created from scratch. +class DocumentClass : public TextClass { public: /// virtual ~DocumentClass() {} @@ -331,7 +406,7 @@ public: /// \return true if there is a Layout with latexname lay bool hasLaTeXLayout(std::string const & lay) const; /// A DocumentClass nevers count as loaded, since it is dynamic - virtual bool loaded() { return false; } + virtual bool loaded() const { return false; } /// \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: @@ -340,10 +415,13 @@ public: /// If that doesn't work either, an empty object returns (shouldn't /// happen). -- Idea JMarc, comment MV InsetLayout const & insetLayout(docstring const & name) const; - /// an empty inset layout for use as a default - static InsetLayout const & emptyInsetLayout() { return empty_insetlayout_; } - /// add an empty layout \c name if it does not exist in layoutlist_ - void addLayoutIfNeeded(docstring const & name) const; + /// a plain inset layout for use as a default + static InsetLayout const & plainInsetLayout(); + /// add a new layout \c name if it does not exist in layoutlist_ + /// \return whether we had to add one. + bool addLayoutIfNeeded(docstring const & name) const; + /// Forced layouts in layout file syntax + std::string forcedLayouts() const; /////////////////////////////////////////////////////////////////// // accessors @@ -353,6 +431,10 @@ public: /// Counters & counters() const { return counters_; } /// + std::string const & opt_enginetype() const { return opt_enginetype_; } + /// + std::string const & citeFramework() const { return citeframework_; } + /// std::string const & opt_fontsize() const { return opt_fontsize_; } /// std::string const & opt_pagestyle() const { return opt_pagestyle_; } @@ -364,10 +446,24 @@ public: std::string const & pagestyle() const { return pagestyle_; } /// docstring const & preamble() const { return preamble_; } + /// + docstring const & htmlpreamble() const { return htmlpreamble_; } + /// + docstring const & htmlstyles() const { return htmlstyles_; } + /// Looks for the layout of "highest level", other than Part (or other + /// layouts with a negative toc number), for use in constructing TOCs and + /// similar information. + Layout const & getTOCLayout() const; + /// the paragraph style to use for TOCs, Bibliography, etc + /// we will attempt to calculate this if it was not given + Layout const & htmlTOCLayout() const; /// is this feature already provided by the class? bool provides(std::string const & p) const; /// features required by the class? std::set const & requires() const { return requires_; } + /// package options to write to LaTeX file + std::map const & packageOptions() const + { return package_options_; } /// unsigned int columns() const { return columns_; } /// @@ -383,9 +479,9 @@ public: /// Text that dictates how wide the right margin is on the screen docstring const & rightmargin() const { return rightmargin_; } /// The type of command used to produce a title - TitleLatexType titletype() const { return titletype_; }; + TitleLatexType titletype() const { return titletype_; } /// The name of the title command - std::string const & titlename() const { return titlename_; }; + std::string const & titlename() const { return titlename_; } /// int size() const { return layoutlist_.size(); } /// The minimal TocLevel of sectioning layouts @@ -394,51 +490,59 @@ public: int max_toclevel() const { return max_toclevel_; } /// returns true if the class has a ToC structure bool hasTocLevels() const; - /// Can be LaTeX, DocBook, etc. - OutputType outputType() const { return outputType_; } + /// + std::string const getCiteFormat(CiteEngineType const & type, + std::string const & entry, bool const punct = true, + std::string const & fallback = "") const; + /// + std::string const & getCiteMacro(CiteEngineType const & type, + std::string const & macro) const; + /// + std::vector const citeCommands(CiteEngineType const &) const; + /// + std::vector const & citeStyles(CiteEngineType const &) const; + /// + std::map const & defaultBiblioStyle() const + { return cite_default_biblio_style_; } + /// + std::map const & citeCommandAliases() const + { return cite_command_aliases_; } + /// The maximum number of citations before "et al." + size_t max_citenames() const { return maxcitenames_; } + /// + bool const & fullAuthorList() const { return cite_full_author_list_; } protected: /// Constructs a DocumentClass based upon a LayoutFile. DocumentClass(LayoutFile const & tc); /// Needed in tex2lyx DocumentClass() {} private: - /// The only class that can create a DocumentClass is - /// DocumentClassBundle, which calls the protected constructor. - friend class DocumentClassBundle; - /// - static InsetLayout empty_insetlayout_; + /// The only way to make a DocumentClass is to call this function. + friend DocumentClassPtr + getDocumentClass(LayoutFile const &, LayoutModuleList const &, + LayoutModuleList const &, + bool const clone); }; -/// DocumentClassBundle is a container for DocumentClass objects, so that -/// they stay in memory for use by Insets, CutAndPaste, and the like, even -/// when their associated Buffers are destroyed. -/// FIXME Some sort of garbage collection or reference counting wouldn't -/// be a bad idea here. It might be enough to check when a Buffer is closed -/// (or makeDocumentClass is called) whether the old DocumentClass is in use -/// anywhere. -/// -/// This is a singleton class. Its sole instance is accessed via -/// DocumentClassBundle::get(). -class DocumentClassBundle : boost::noncopyable { -public: - /// \return Pointer to a new class equal to baseClass - DocumentClass & newClass(LayoutFile const & baseClass); - /// \return The sole instance of this class. - static DocumentClassBundle & get(); -private: - /// control instantiation - DocumentClassBundle() {} - /// clean up - ~DocumentClassBundle(); - /// - std::vector documentClasses_; -}; - +/// 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, + LayoutModuleList const & modlist, + LayoutModuleList const & celist, + bool const clone = false); /// convert page sides option to text 1 or 2 std::ostream & operator<<(std::ostream & os, PageSides p); +/// current format of layout files +extern int const LAYOUT_FORMAT; +/// layout format for the current lyx file format (usually equal to +/// LAYOUT_FORMAT) +extern int const LYXFILE_LAYOUT_FORMAT; + } // namespace lyx