X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.h;h=570e67f8d4e3edaef3717ae7d0aa98cc2ff0fea0;hb=7950ace3d96543e3099aa3bde823f970a1ce6a86;hp=a6ffed902ae0c1aec9f10c2e8433e07e18a70608;hpb=936ec661247e0997fbedbb9a6bab5ba7e19f2715;p=lyx.git diff --git a/src/TextClass.h b/src/TextClass.h index a6ffed902a..570e67f8d4 100644 --- a/src/TextClass.h +++ b/src/TextClass.h @@ -151,6 +151,7 @@ public: 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() @@ -171,7 +172,8 @@ public: ReturnValues read(Lexer & lex, ReadType rt = BASECLASS); /// validates the layout information passed in 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); /////////////////////////////////////////////////////////////////// @@ -192,6 +194,8 @@ public: /// std::string const & name() const { return name_; } /// + std::string const & path() const { return path_; } + /// std::string const & category() const { return category_; } /// std::string const & description() const { return description_; } @@ -203,8 +207,12 @@ public: OutputType outputType() const { return outputType_; } /// Can be latex, docbook ... (the name of a format) std::string outputFormat() const { return outputFormat_; } - /// - docstring outlinerName(std::string const & type) const; + /// Does this class redefine the output format? + bool hasOutputFormat() const { return has_output_format_; } + /// Return the non-localised names for the toc types. + std::map const & + outlinerNames() const { return outliner_names_; } + protected: /// Protect construction TextClass(); @@ -238,6 +246,8 @@ 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 @@ -256,6 +266,8 @@ protected: 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_; /// @@ -303,6 +315,8 @@ protected: OutputType outputType_; /// Can be latex, docbook ... (the name of a format) std::string outputFormat_; + /// Does this class redefine the output format? + bool has_output_format_; /** 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 @@ -328,7 +342,11 @@ protected: /// Citation macros std::map > cite_macros_; /// The default BibTeX bibliography style file - std::string cite_default_biblio_style_; + 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 @@ -402,7 +420,7 @@ public: /// happen). -- Idea JMarc, comment MV InsetLayout const & insetLayout(docstring const & name) const; /// a plain inset layout for use as a default - static InsetLayout const & plainInsetLayout() { return plain_insetlayout_; } + 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; @@ -419,6 +437,8 @@ public: /// 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_; } @@ -435,7 +455,7 @@ public: /// 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 + /// 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 @@ -475,8 +495,9 @@ public: /// returns true if the class has a ToC structure bool hasTocLevels() const; /// - std::string const & getCiteFormat(CiteEngineType const & type, - std::string const & entry, std::string const & fallback = "") const; + 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; @@ -485,7 +506,13 @@ public: /// std::vector const & citeStyles(CiteEngineType const &) const; /// - std::string const & defaultBiblioStyle() const { return cite_default_biblio_style_; } + 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: @@ -497,9 +524,8 @@ private: /// The only way to make a DocumentClass is to call this function. friend DocumentClassPtr getDocumentClass(LayoutFile const &, LayoutModuleList const &, + LayoutModuleList const &, bool const clone); - /// - static InsetLayout plain_insetlayout_; }; @@ -509,6 +535,7 @@ private: /// 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 @@ -516,6 +543,9 @@ 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