apt-pkg/tagfile.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: tagfile.h,v 1.20 2003/05/19 17:13:57 doogie Exp $
   4 /* ######################################################################
   5
   6    Fast scanner for RFC-822 type header information
   7
   8    This parser handles Debian package files (and others). Their form is
   9    RFC-822 type header fields in groups separated by a blank line.
  10
  11    The parser reads the file and provides methods to step linearly
  12    over it or to jump to a pre-recorded start point and read that record.
  13
  14    A second class is used to perform pre-parsing of the record. It works
  15    by indexing the start of each header field and providing lookup
  16    functions for header fields.
  17
  18    ##################################################################### */
  19                                                                         /*}}}*/
  20 #ifndef PKGLIB_TAGFILE_H
  21 #define PKGLIB_TAGFILE_H
  22
  23
  24 #include <apt-pkg/fileutl.h>
  25 #include <stdio.h>
  26
  27 class pkgTagSection
  28 {
  29    const char *Section;
  30    // We have a limit of 256 tags per section.
  31    unsigned int Indexes[256];
  32    unsigned int AlphaIndexes[0x100];
  33    unsigned int TagCount;
  34    // dpointer placeholder (for later in case we need it)
  35    void *d;
  36
  37    /* This very simple hash function for the last 8 letters gives
  38       very good performance on the debian package files */
  39    inline static unsigned long AlphaHash(const char *Text, const char *End = 0)
  40    {
  41       unsigned long Res = 0;
  42       for (; Text != End && *Text != ':' && *Text != 0; Text++)
  43          Res = ((unsigned long)(*Text) & 0xDF) ^ (Res << 1);
  44       return Res & 0xFF;
  45    }
  46
  47    protected:
  48    const char *Stop;
  49
  50    public:
  51
  52    inline bool operator ==(const pkgTagSection &rhs) {return Section == rhs.Section;};
  53    inline bool operator !=(const pkgTagSection &rhs) {return Section != rhs.Section;};
  54
  55    bool Find(const char *Tag,const char *&Start, const char *&End) const;
  56    bool Find(const char *Tag,unsigned &Pos) const;
  57    string FindS(const char *Tag) const;
  58    signed int FindI(const char *Tag,signed long Default = 0) const ;
  59    unsigned long long FindULL(const char *Tag, unsigned long long const &Default = 0) const;
  60    bool FindFlag(const char *Tag,unsigned long &Flags,
  61                  unsigned long Flag) const;
  62    bool static const FindFlag(unsigned long &Flags, unsigned long Flag,
  63                                 const char* Start, const char* Stop);
  64    bool Scan(const char *Start,unsigned long MaxLength);
  65    inline unsigned long size() const {return Stop - Section;};
  66    void Trim();
  67    virtual void TrimRecord(bool BeforeRecord, const char* &End);
  68
  69    inline unsigned int Count() const {return TagCount;};
  70    inline bool Exists(const char* const Tag) {return AlphaIndexes[AlphaHash(Tag)] != 0;}
  71
  72    inline void Get(const char *&Start,const char *&Stop,unsigned int I) const
  73                    {Start = Section + Indexes[I]; Stop = Section + Indexes[I+1];}
  74
  75    inline void GetSection(const char *&Start,const char *&Stop) const
  76    {
  77       Start = Section;
  78       Stop = this->Stop;
  79    };
  80
  81    pkgTagSection() : Section(0), Stop(0) {};
  82    virtual ~pkgTagSection() {};
  83 };
  84
  85 class pkgTagFilePrivate;
  86 class pkgTagFile
  87 {
  88    pkgTagFilePrivate *d;
  89
  90    bool Fill();
  91    bool Resize();
  92
  93    public:
  94
  95    bool Step(pkgTagSection &Section);
  96    unsigned long Offset();
  97    bool Jump(pkgTagSection &Tag,unsigned long Offset);
  98
  99    pkgTagFile(FileFd *F,unsigned long Size = 32*1024);
 100    virtual ~pkgTagFile();
 101 };
 102
 103 /* This is the list of things to rewrite. The rewriter
 104    goes through and changes or adds each of these headers
 105    to suit. A zero forces the header to be erased, an empty string
 106    causes the old value to be used. (rewrite rule ignored) */
 107 struct TFRewriteData
 108 {
 109    const char *Tag;
 110    const char *Rewrite;
 111    const char *NewTag;
 112 };
 113 extern const char **TFRewritePackageOrder;
 114 extern const char **TFRewriteSourceOrder;
 115
 116 bool TFRewrite(FILE *Output,pkgTagSection const &Tags,const char *Order[],
 117                TFRewriteData *Rewrite);
 118
 119 #endif