X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCiteEnginesList.h;h=2979f004bce6e46085bc4449da017ea2e25af4c9;hb=26ba2a65838731ce639a09539f617cb0f0be3b22;hp=0e6d119128be2744da6641d858e1a3124226251c;hpb=97aea7e5b1707d662d6d7146d53adc97045c44c9;p=lyx.git diff --git a/src/CiteEnginesList.h b/src/CiteEnginesList.h index 0e6d119128..2979f004bc 100644 --- a/src/CiteEnginesList.h +++ b/src/CiteEnginesList.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Richard Heck + * \author Richard Kimberly Heck * \author Jürgen Spitzmüller * * Full author contact details are available in file CREDITS. @@ -13,6 +13,8 @@ #ifndef CITEENGINESLIST_H #define CITEENGINESLIST_H +#include "Citation.h" + #include #include @@ -20,8 +22,7 @@ namespace lyx { /** * This class represents a particular LyX "cite engine", which defines the features - * of a particular citation backend such as natbib or biblatex. In that sense, it is more like - * a LaTeX package, where a layout file corresponds to a LaTeX class. + * of a particular citation backend such as natbib or biblatex. * * In general, a given cite engine can be used with any document class. That said, * one cite engine may `require' another, or it may `exclude' some other cite engine. @@ -29,13 +30,13 @@ namespace lyx { * which must begin roughly so: * # \DeclareLyXCiteEngine[natbib.sty]{Natbib} * # DescriptionBegin - * # Loads the LaTeX package natbib, a citation engine. Natbib supports - * # both author-year and numerical styles for citations, automatic sorting - * # and merging of numerical citations, annotations, capitalization of the - * # `van' part of author names, shortened and full author lists, and more. + * # Natbib supports a range of both author-year and numerical styles mainly + * # aimed at the Humanities. It features automatic sorting and merging of + * # numerical citations, annotations, capitalization of the `van' part of + * # author names, shortened and full author lists, and more. * # DescriptionEnd * # Excludes: basic | jurabib - * The description might be used in the gui to give information to the user. The + * The description will be used in the gui to give information to the user. The * Requires and Excludes lines are read by the configuration script * and written to a file citeengines.lst in the user configuration directory. * That file is then read on startup to populate the CiteEnginesList, below. @@ -49,10 +50,10 @@ public: /// LyXCiteEngine(std::string const & name, std::string const & id, std::vector const & enginetypes, + std::string const & cfm, + std::vector const & defaultbiblios, std::string const & description, - std::vector const & packagelist, - std::vector const & requires, - std::vector const & excludes); + std::vector const & packagelist); /// whether the required packages are available bool isAvailable() const; /// the missing prerequisites, if any @@ -64,25 +65,22 @@ public: /// std::string const & getFilename() const { return filename_; } /// + std::string const & getCiteFramework() const { return cite_framework_; } + /// std::vector const & getEngineType() const { return engine_types_; } /// + bool hasEngineType(CiteEngineType const &) const; + /// + std::string getDefaultBiblio(CiteEngineType const &) const; + /// + bool isDefaultBiblio(std::string const &) const; + /// std::string const & getDescription() const { return description_; } /// std::vector const & getPackageList() const { return package_list_; } /// - std::vector const & getRequiredEngines() const - { return required_engines_; } - /// Engines this one excludes: the list should be treated disjunctively - std::vector const & getExcludedEngines() const - { return excluded_engines_; } - /// \return true if the engine is compatible with this one, i.e., - /// it does not exclude us and we do not exclude it. - /// this will also return true if cename is unknown and we do not - /// exclude it, since in that case we cannot check its exclusions. - bool isCompatible(std::string const & cename) const; - /// - static bool areCompatible(std::string const & eng1, std::string const & eng2); + bool required(std::string const & p) const; private: /// what appears in the ui std::string name_; @@ -93,16 +91,16 @@ private: std::string filename_; /// the engine type(s) std::vector engine_types_; + /// cite framework (bibtex, biblatex) + std::string cite_framework_; + /// default bibliography styles + std::vector default_biblios_; /// a short description for use in the ui std::string description_; /// the LaTeX packages on which this depends, if any std::vector package_list_; - /// Engines this one requires: at least one - std::vector required_engines_; - /// Engines this one excludes: none of these - std::vector excluded_engines_; // these are mutable because they are used to cache the results - // or an otherwise const operation. + // of an otherwise const operation. /// mutable bool checked_; /// @@ -121,6 +119,10 @@ class CiteEnginesList { public: /// CiteEnginesList() {} + /// + std::string getTypeAsString(CiteEngineType const &) const; + /// + CiteEngineType getType(std::string const &) const; /// reads the engines from a file generated by configure.py bool read(); /// @@ -145,12 +147,13 @@ public: void operator=(CiteEnginesList const &); /// add an engine to the list void addCiteEngine(std::string const &, std::string const &, - std::vector const &, std::string const &, std::vector const &, - std::vector const &, std::vector const &); + std::vector const &, std::string const &, + std::vector const &, std::string const &, + std::vector const &); /// std::vector englist_; }; extern CiteEnginesList theCiteEnginesList; -} +} // namespace lyx #endif