apt-pkg/tagfile.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: tagfile.h,v 1.14 1999/07/03 06:45:40 jgg 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 seperated 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 // Header section: pkglib
  21 #ifndef PKGLIB_TAGFILE_H
  22 #define PKGLIB_TAGFILE_H
  23
  24 #ifdef __GNUG__
  25 #pragma interface "apt-pkg/tagfile.h"
  26 #endif
  27
  28 #include <apt-pkg/fileutl.h>
  29
  30 class pkgTagSection
  31 {
  32    const char *Section;
  33    const char *Stop;
  34
  35    // We have a limit of 256 tags per section.
  36    unsigned short Indexes[256];
  37    unsigned short AlphaIndexes[26 + 26*26];
  38
  39    unsigned int TagCount;
  40
  41    public:
  42
  43    inline bool operator ==(const pkgTagSection &rhs) {return Section == rhs.Section;};
  44    inline bool operator !=(const pkgTagSection &rhs) {return Section != rhs.Section;};
  45
  46    bool Find(const char *Tag,const char *&Start, const char *&End);
  47    string FindS(const char *Tag);
  48    signed int FindI(const char *Tag,signed long Default = 0);
  49    bool pkgTagSection::FindFlag(const char *Tag,unsigned long &Flags,
  50                                 unsigned long Flag);
  51    bool Scan(const char *Start,unsigned long MaxLength);
  52    inline unsigned long size() {return Stop - Section;};
  53
  54    inline unsigned int Count() {return TagCount;};
  55    inline void Get(const char *&Start,const char *&Stop,unsigned int I)
  56                    {Start = Section + Indexes[I]; Stop = Section + Indexes[I+1];}
  57
  58    inline void GetSection(const char *&Start,const char *&Stop)
  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    unsigned long Left;
  74    unsigned long iOffset;
  75    unsigned long Size;
  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 #endif