#ifndef CITEENGINESLIST_H
#define CITEENGINESLIST_H
+#include "Citation.h"
+
#include <string>
#include <vector>
* 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.
///
LyXCiteEngine(std::string const & name, std::string const & id,
std::vector<std::string> const & enginetypes,
+ std::string const & cfm,
+ std::vector<std::string> const & defaultbiblios,
std::string const & description,
- std::vector<std::string> const & packagelist,
- std::vector<std::string> const & requires,
- std::vector<std::string> const & excludes);
+ std::vector<std::string> const & packagelist);
/// whether the required packages are available
bool isAvailable() const;
/// the missing prerequisites, if any
///
std::string const & getFilename() const { return filename_; }
///
+ std::string const & getCiteFramework() const { return cite_framework_; }
+ ///
std::vector<std::string> 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<std::string> const & getPackageList() const
{ return package_list_; }
///
- std::vector<std::string> const & getRequiredEngines() const
- { return required_engines_; }
- /// Engines this one excludes: the list should be treated disjunctively
- std::vector<std::string> 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 requires(std::string const p) const;
private:
/// what appears in the ui
std::string name_;
std::string filename_;
/// the engine type(s)
std::vector<std::string> engine_types_;
+ /// cite framework (bibtex, biblatex)
+ std::string cite_framework_;
+ /// default bibliography styles
+ std::vector<std::string> default_biblios_;
/// a short description for use in the ui
std::string description_;
/// the LaTeX packages on which this depends, if any
std::vector<std::string> package_list_;
- /// Engines this one requires: at least one
- std::vector<std::string> required_engines_;
- /// Engines this one excludes: none of these
- std::vector<std::string> excluded_engines_;
// these are mutable because they are used to cache the results
// or an otherwise const operation.
///
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();
///
void operator=(CiteEnginesList const &);
/// add an engine to the list
void addCiteEngine(std::string const &, std::string const &,
- std::vector<std::string> const &, std::string const &, std::vector<std::string> const &,
- std::vector<std::string> const &, std::vector<std::string> const &);
+ std::vector<std::string> const &, std::string const &,
+ std::vector<std::string> const &, std::string const &,
+ std::vector<std::string> const &);
///
std::vector<LyXCiteEngine> englist_;
};
extern CiteEnginesList theCiteEnginesList;
-}
+} // namespace lyx
#endif