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 & description,
  55                       std::vector<std::string> const & packagelist,
  56                       std::vector<std::string> const & requires,
  57                       std::vector<std::string> const & excludes);
  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::vector<std::string> const & getEngineType() const { return engine_types_; }
  70         ///
  71         bool hasEngineType(CiteEngineType const &) const;
  72         ///
  73         std::string const & getDescription() const { return description_; }
  74         ///
  75         std::vector<std::string> const & getPackageList() const
  76                 { return package_list_; }
  77         ///
  78         std::vector<std::string> const & getRequiredEngines() const
  79                 { return required_engines_; }
  80         /// Engines this one excludes: the list should be treated disjunctively
  81         std::vector<std::string> const & getExcludedEngines() const
  82                 { return excluded_engines_; }
  83         /// \return true if the engine is compatible with this one, i.e.,
  84         /// it does not exclude us and we do not exclude it.
  85         /// this will also return true if cename is unknown and we do not
  86         /// exclude it, since in that case we cannot check its exclusions.
  87         bool isCompatible(std::string const & cename) const;
  88         ///
  89         static bool areCompatible(std::string const & eng1, std::string const & eng2);
  90 private:
  91         /// what appears in the ui
  92         std::string name_;
  93         /// the engine's unique identifier
  94         /// at present, this is the filename, without the extension
  95         std::string id_;
  96         /// the filename
  97         std::string filename_;
  98         /// the engine type(s)
  99         std::vector<std::string> engine_types_;
 100         /// a short description for use in the ui
 101         std::string description_;
 102         /// the LaTeX packages on which this depends, if any
 103         std::vector<std::string> package_list_;
 104         /// Engines this one requires: at least one
 105         std::vector<std::string> required_engines_;
 106         /// Engines this one excludes: none of these
 107         std::vector<std::string> excluded_engines_;
 108         // these are mutable because they are used to cache the results
 109         // or an otherwise const operation.
 110         ///
 111         mutable bool checked_;
 112         ///
 113         mutable bool available_;
 114         ///
 115         mutable std::vector<std::string> prerequisites_;
 116 };
 117
 118 typedef std::vector<LyXCiteEngine> LyXCiteEnginesList;
 119
 120 /**
 121  *  The CiteEnginesList represents the various LyXCiteEngine's that are available at
 122  *  present.
 123  */
 124 class CiteEnginesList {
 125 public:
 126         ///
 127         CiteEnginesList() {}
 128         ///
 129         std::string getTypeAsString(CiteEngineType const &) const;
 130         ///
 131         CiteEngineType getType(std::string const &) const;
 132         /// reads the engines from a file generated by configure.py
 133         bool read();
 134         ///
 135         LyXCiteEnginesList::const_iterator begin() const;
 136         ///
 137         LyXCiteEnginesList::iterator begin();
 138         ///
 139         LyXCiteEnginesList::const_iterator end() const;
 140         ///
 141         LyXCiteEnginesList::iterator end();
 142         ///
 143         bool empty() const { return englist_.empty(); }
 144         /// Returns a pointer to the LyXCiteEngine with filename str.
 145         /// Returns a null pointer if no such engine is found.
 146         LyXCiteEngine const * operator[](std::string const & str) const;
 147         ///
 148         LyXCiteEngine * operator[](std::string const & str);
 149         private:
 150         /// noncopyable
 151         CiteEnginesList(CiteEnginesList const &);
 152         ///
 153         void operator=(CiteEnginesList const &);
 154         /// add an engine to the list
 155         void addCiteEngine(std::string const &, std::string const &,
 156                 std::vector<std::string> const &, std::string const &, std::vector<std::string> const &,
 157                 std::vector<std::string> const &, std::vector<std::string> const &);
 158         ///
 159         std::vector<LyXCiteEngine> englist_;
 160 };
 161
 162 extern CiteEnginesList theCiteEnginesList;
 163 }
 164 #endif