]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.h
Natbib authoryear uses (Ref1; Ref2) by default.
[lyx.git] / src / TextClass.h
index b3354898d553c40de46c313e53dc7df18323dde9..9475b621e573786ebbaacaf66679859c1a3dba5e 100644 (file)
 #ifndef TEXTCLASS_H
 #define TEXTCLASS_H
 
+#include "Citation.h"
 #include "ColorCode.h"
 #include "Counters.h"
+#include "DocumentClassPtr.h"
 #include "FloatList.h"
 #include "FontInfo.h"
 #include "Layout.h"
@@ -23,8 +25,6 @@
 #include "support/docstring.h"
 #include "support/types.h"
 
-#include <boost/noncopyable.hpp>
-
 #include <list>
 #include <map>
 #include <set>
@@ -189,11 +189,13 @@ public:
        ///
        std::string const & name() const { return name_; }
        ///
+       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() const;
+       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)
@@ -231,6 +233,8 @@ protected:
        mutable LayoutList layoutlist_;
        /// Layout file name
        std::string name_;
+       /// Class category
+       std::string category_;
        /// document class name
        std::string latexname_;
        /// document class description
@@ -245,6 +249,8 @@ protected:
        bool tex_class_avail_;
        /// document class prerequisites
        mutable std::string prerequisites_;
+       /// The possible cite engine types
+       std::string opt_enginetype_;
        ///
        std::string opt_fontsize_;
        ///
@@ -264,6 +270,8 @@ protected:
        /// 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.
@@ -309,9 +317,15 @@ protected:
        /// The maximal TocLevel of sectioning layouts
        int max_toclevel_;
        /// Citation formatting information
-       std::map<std::string, std::string> cite_formats_;
+       std::map<CiteEngineType, std::map<std::string, std::string> > cite_formats_;
        /// Citation macros
-       std::map<std::string, std::string> cite_macros_;
+       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_;
 private:
        ///////////////////////////////////////////////////////////////////
        // helper routines for reading layout files
@@ -319,6 +333,8 @@ 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);
@@ -337,7 +353,11 @@ private:
        ///
        bool readFloat(Lexer &);
        ///
-       void readCiteFormat(Lexer &);
+       bool readCiteEngine(Lexer &);
+       ///
+       int readCiteEngineType(Lexer &) const;
+       ///
+       bool readCiteFormat(Lexer &);
 };
 
 
@@ -354,7 +374,7 @@ private:
 /// In the main LyX code, DocumentClass objects are created only by
 /// DocumentClassBundle, for which see below.
 ///
-class DocumentClass : public TextClass, boost::noncopyable {
+class DocumentClass : public TextClass {
 public:
        ///
        virtual ~DocumentClass() {}
@@ -365,7 +385,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:
@@ -388,6 +408,8 @@ public:
        ///
        Counters & counters() const { return counters_; }
        ///
+       std::string const & opt_enginetype() const { return opt_enginetype_; }
+       ///
        std::string const & opt_fontsize() const { return opt_fontsize_; }
        ///
        std::string const & opt_pagestyle() const { return opt_pagestyle_; }
@@ -401,6 +423,10 @@ public:
        docstring const & preamble() const { return preamble_; }
        ///
        docstring const & htmlpreamble() const { return htmlpreamble_; }
+       ///
+       docstring const & htmlstyles() const { return htmlstyles_; }
+       ///
+       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;
@@ -435,9 +461,19 @@ public:
        /// returns true if the class has a ToC structure
        bool hasTocLevels() const;
        ///
-       std::string const & getCiteFormat(std::string const & entry_type) const;
+       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::string const & getCiteMacro(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_; }
+       ///
+       bool const & fullAuthorList() const { return cite_full_author_list_; }
 protected:
        /// Constructs a DocumentClass based upon a LayoutFile.
        DocumentClass(LayoutFile const & tc);
@@ -446,41 +482,19 @@ protected:
 private:
        /// The only class that can create a DocumentClass is
        /// DocumentClassBundle, which calls the protected constructor.
-       friend class DocumentClassBundle;
+       friend DocumentClassPtr
+               getDocumentClass(LayoutFile const &, LayoutModuleList const &);
        ///
        static InsetLayout plain_insetlayout_;
 };
 
 
-/// 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 The sole instance of this class.
-       static DocumentClassBundle & get();
-       /// \return A new DocumentClass based on baseClass, with info added
-       /// from the modules in modlist.
-       DocumentClass & makeDocumentClass(LayoutFile const & baseClass,
+/// 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);
-private:
-       /// control instantiation
-       DocumentClassBundle() {}
-       /// clean up
-       ~DocumentClassBundle();
-       /// \return Reference to a new DocumentClass equal to baseClass
-       DocumentClass & newClass(LayoutFile const & baseClass);
-       ///
-       std::vector<DocumentClass *> documentClasses_;
-};
-
 
 /// convert page sides option to text 1 or 2
 std::ostream & operator<<(std::ostream & os, PageSides p);