src/CiteEnginesList.h

   1 // -*- C++ -*-
   2 /**
   3  * \file CiteEnginesList.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Richard Heck
   8  * \author Jürgen Spitzmüller
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef CITEENGINESLIST_H
  14 #define CITEENGINESLIST_H
  15
  16 #include "Citation.h"
  17
  18 #include <string>
  19 #include <vector>
  20
  21 namespace lyx {
  22
  23 /**
  24  *  This class represents a particular LyX "cite engine", which defines the features
  25  * of a particular citation backend such as natbib or biblatex. In that sense, it is more like
  26  *  a LaTeX package, where a layout file corresponds to a LaTeX class.
  27  *
  28  *  In general, a given cite engine can be used with any document class. That said,
  29  *  one cite engine may `require' another, or it may `exclude' some other cite engine.
  30  *  The requires and excludes are given in comments within the cite engine file,
  31  *  which must begin roughly so:
  32  *  # \DeclareLyXCiteEngine[natbib.sty]{Natbib}
  33  *  # DescriptionBegin
  34  *  #   Natbib supports a range of both author-year and numerical styles mainly
  35  *  #   aimed at the Humanities. It features automatic sorting and merging of
  36  *  #   numerical citations, annotations, capitalization of the `van' part of
  37  *  #   author names, shortened and full author lists, and more.
  38  *  # DescriptionEnd
  39  *  # Excludes: basic | jurabib
  40  *  The description will be used in the gui to give information to the user. The
  41  *  Requires and Excludes lines are read by the configuration script
  42  *  and written to a file citeengines.lst in the user configuration directory.
  43  *  That file is then read on startup to populate the CiteEnginesList, below.
  44  *
  45  *  Engines can also be "provided" or "excluded" by document classes, using
  46  *  the ProvidesEngine and ExcludesEngine tags.
  47  */
  48
  49 class LyXCiteEngine {
  50 public:
  51         ///
  52         LyXCiteEngine(std::string const & name, std::string const & id,
  53                       std::vector<std::string> const & enginetypes,
  54                       std::string const & cfm,
  55                       std::vector<std::string> const & defaultbiblios,
  56                       std::string const & description,
  57                       std::vector<std::string> const & packagelist);
  58         /// whether the required packages are available
  59         bool isAvailable() const;
  60         /// the missing prerequisites, if any
  61         std::vector<std::string> prerequisites() const;
  62         ///
  63         std::string const & getName() const { return name_; }
  64         ///
  65         std::string const & getID() const { return id_; }
  66         ///
  67         std::string const & getFilename() const { return filename_; }
  68         ///
  69         std::string const & getCiteFramework() const { return cite_framework_; }
  70         ///
  71         std::vector<std::string> const & getEngineType() const { return engine_types_; }
  72         ///
  73         bool hasEngineType(CiteEngineType const &) const;
  74         ///
  75         std::string getDefaultBiblio(CiteEngineType const &) const;
  76         ///
  77         bool isDefaultBiblio(std::string const &) const;
  78         ///
  79         std::string const & getDescription() const { return description_; }
  80         ///
  81         std::vector<std::string> const & getPackageList() const
  82                 { return package_list_; }
  83 private:
  84         /// what appears in the ui
  85         std::string name_;
  86         /// the engine's unique identifier
  87         /// at present, this is the filename, without the extension
  88         std::string id_;
  89         /// the filename
  90         std::string filename_;
  91         /// the engine type(s)
  92         std::vector<std::string> engine_types_;
  93         /// cite framework (bibtex, biblatex)
  94         std::string cite_framework_;
  95         /// default bibliography styles
  96         std::vector<std::string> default_biblios_;
  97         /// a short description for use in the ui
  98         std::string description_;
  99         /// the LaTeX packages on which this depends, if any
 100         std::vector<std::string> package_list_;
 101         // these are mutable because they are used to cache the results
 102         // or an otherwise const operation.
 103         ///
 104         mutable bool checked_;
 105         ///
 106         mutable bool available_;
 107         ///
 108         mutable std::vector<std::string> prerequisites_;
 109 };
 110
 111 typedef std::vector<LyXCiteEngine> LyXCiteEnginesList;
 112
 113 /**
 114  *  The CiteEnginesList represents the various LyXCiteEngine's that are available at
 115  *  present.
 116  */
 117 class CiteEnginesList {
 118 public:
 119         ///
 120         CiteEnginesList() {}
 121         ///
 122         std::string getTypeAsString(CiteEngineType const &) const;
 123         ///
 124         CiteEngineType getType(std::string const &) const;
 125         /// reads the engines from a file generated by configure.py
 126         bool read();
 127         ///
 128         LyXCiteEnginesList::const_iterator begin() const;
 129         ///
 130         LyXCiteEnginesList::iterator begin();
 131         ///
 132         LyXCiteEnginesList::const_iterator end() const;
 133         ///
 134         LyXCiteEnginesList::iterator end();
 135         ///
 136         bool empty() const { return englist_.empty(); }
 137         /// Returns a pointer to the LyXCiteEngine with filename str.
 138         /// Returns a null pointer if no such engine is found.
 139         LyXCiteEngine const * operator[](std::string const & str) const;
 140         ///
 141         LyXCiteEngine * operator[](std::string const & str);
 142         private:
 143         /// noncopyable
 144         CiteEnginesList(CiteEnginesList const &);
 145         ///
 146         void operator=(CiteEnginesList const &);
 147         /// add an engine to the list
 148         void addCiteEngine(std::string const &, std::string const &,
 149                 std::vector<std::string> const &, std::string const &,
 150                 std::vector<std::string> const &, std::string const &,
 151                 std::vector<std::string> const &);
 152         ///
 153         std::vector<LyXCiteEngine> englist_;
 154 };
 155
 156 extern CiteEnginesList theCiteEnginesList;
 157 }
 158 #endif