apt-pkg/srcrecords.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 /* ######################################################################
   4
   5    Source Package Records - Allows access to source package records
   6
   7    Parses and allows access to the list of source records and searching by
   8    source name on that list.
   9
  10    ##################################################################### */
  11                                                                         /*}}}*/
  12 #ifndef PKGLIB_SRCRECORDS_H
  13 #define PKGLIB_SRCRECORDS_H
  14
  15 #include <apt-pkg/macros.h>
  16 #include <apt-pkg/hashes.h>
  17
  18 #include <string>
  19 #include <vector>
  20
  21 #ifndef APT_8_CLEANER_HEADERS
  22 using std::string;
  23 using std::vector;
  24 #endif
  25
  26 class pkgSourceList;
  27 class pkgIndexFile;
  28 class pkgSrcRecords
  29 {
  30    public:
  31
  32 APT_IGNORE_DEPRECATED_PUSH
  33    // Describes a single file
  34    struct File
  35    {
  36       APT_DEPRECATED_MSG("Use Hashes member instead of hardcoded hash algorithm") std::string MD5Hash;
  37       APT_DEPRECATED_MSG("Use FileSize member instead") unsigned long Size;
  38       std::string Path;
  39       std::string Type;
  40    };
  41    struct File2 : public File
  42    {
  43       unsigned long long FileSize;
  44       HashStringList Hashes;
  45    };
  46 APT_IGNORE_DEPRECATED_POP
  47
  48    // Abstract parser for each source record
  49    class Parser
  50    {
  51       void * const d;
  52       protected:
  53
  54       const pkgIndexFile *iIndex;
  55
  56       public:
  57
  58       enum BuildDep {BuildDepend=0x0,BuildDependIndep=0x1,
  59                      BuildConflict=0x2,BuildConflictIndep=0x3,
  60                      BuildDependArch=0x4,BuildConflictArch=0x5};
  61
  62       struct BuildDepRec
  63       {
  64          std::string Package;
  65          std::string Version;
  66          unsigned int Op;
  67          unsigned char Type;
  68       };
  69
  70       inline const pkgIndexFile &Index() const {return *iIndex;};
  71
  72       virtual bool Restart() = 0;
  73       virtual bool Step() = 0;
  74       virtual bool Jump(unsigned long const &Off) = 0;
  75       virtual unsigned long Offset() = 0;
  76       virtual std::string AsStr() = 0;
  77
  78       virtual std::string Package() const = 0;
  79       virtual std::string Version() const = 0;
  80       virtual std::string Maintainer() const = 0;
  81       virtual std::string Section() const = 0;
  82       virtual const char **Binaries() = 0;   // Ownership does not transfer
  83
  84       //FIXME: Add a parameter to specify which architecture to use for [wildcard] matching
  85       virtual bool BuildDepends(std::vector<BuildDepRec> &BuildDeps, bool const &ArchOnly, bool const &StripMultiArch = true) = 0;
  86       static const char *BuildDepType(unsigned char const &Type) APT_PURE;
  87
  88       virtual bool Files(std::vector<pkgSrcRecords::File> &F) = 0;
  89       bool Files2(std::vector<pkgSrcRecords::File2> &F);
  90
  91       explicit Parser(const pkgIndexFile *Index);
  92       virtual ~Parser();
  93    };
  94
  95    private:
  96    /** \brief dpointer placeholder (for later in case we need it) */
  97    void * const d;
  98
  99    // The list of files and the current parser pointer
 100    std::vector<Parser*> Files;
 101    std::vector<Parser *>::iterator Current;
 102
 103    public:
 104
 105    // Reset the search
 106    bool Restart();
 107
 108    // Step to the next SourcePackage and return pointer to the
 109    // next SourceRecord. The pointer is owned by libapt.
 110    const Parser* Step();
 111
 112    // Locate a package by name and return pointer to the Parser.
 113    // The pointer is owned by libapt.
 114    Parser* Find(const char *Package,bool const &SrcOnly = false);
 115
 116    explicit pkgSrcRecords(pkgSourceList &List);
 117    virtual ~pkgSrcRecords();
 118 };
 119
 120 #endif