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/mmap.h>
  25 #include <apt-pkg/fileutl.h>
  26 #include <stdio.h>
  27
  28 class pkgTagSection
  29 {
  30    const char *Section;
  31    const char *Stop;
  32
  33    // We have a limit of 256 tags per section.
  34    unsigned int Indexes[256];
  35    unsigned int AlphaIndexes[0x100];
  36
  37    unsigned int TagCount;
  38
  39    public:
  40
  41    inline bool operator ==(const pkgTagSection &rhs) {return Section == rhs.Section;};
  42    inline bool operator !=(const pkgTagSection &rhs) {return Section != rhs.Section;};
  43
  44    bool Find(const char *Tag,const char *&Start, const char *&End) const;
  45    bool Find(const char *Tag,unsigned &Pos) const;
  46    string FindS(const char *Tag) const;
  47    signed int FindI(const char *Tag,signed long Default = 0) const ;
  48    bool FindFlag(const char *Tag,unsigned long &Flags,
  49                  unsigned long Flag) const;
  50    bool Scan(const char *Start,unsigned long MaxLength);
  51    inline unsigned long size() const {return Stop - Section;};
  52    void Trim();
  53
  54    inline unsigned int Count() const {return TagCount;};
  55    inline void Get(const char *&Start,const char *&Stop,unsigned int I) const
  56                    {Start = Section + Indexes[I]; Stop = Section + Indexes[I+1];}
  57
  58    inline void GetSection(const char *&Start,const char *&Stop) const
  59    {
  60       Start = Section;
  61       Stop = this->Stop;
  62    };
  63
  64    pkgTagSection() : Section(0), Stop(0) {};
  65 };
  66
  67 class pkgTagFile
  68 {
  69    FileFd &Fd;
  70    char *Buffer;
  71    char *Start;
  72    char *End;
  73    bool Done;
  74    unsigned long iOffset;
  75    MMap *Map;
  76
  77    bool Fill();
  78
  79    public:
  80
  81    bool Step(pkgTagSection &Section);
  82    inline unsigned long Offset() {return iOffset;};
  83    bool Jump(pkgTagSection &Tag,unsigned long Offset);
  84
  85    pkgTagFile(FileFd *F,unsigned long Size = 32*1024);
  86    ~pkgTagFile();
  87 };
  88
  89 /* This is the list of things to rewrite. The rewriter
  90    goes through and changes or adds each of these headers
  91    to suit. A zero forces the header to be erased, an empty string
  92    causes the old value to be used. (rewrite rule ignored) */
  93 struct TFRewriteData
  94 {
  95    const char *Tag;
  96    const char *Rewrite;
  97    const char *NewTag;
  98 };
  99 extern const char **TFRewritePackageOrder;
 100 extern const char **TFRewriteSourceOrder;
 101
 102 bool TFRewrite(FILE *Output,pkgTagSection const &Tags,const char *Order[],
 103                TFRewriteData *Rewrite);
 104
 105 #endif