1 // -*- mode: cpp; mode: fold -*-
3 // $Id: tagfile.h,v 1.20 2003/05/19 17:13:57 doogie Exp $
4 /* ######################################################################
6 Fast scanner for RFC-822 type header information
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.
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.
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.
18 ##################################################################### */
20 #ifndef PKGLIB_TAGFILE_H
21 #define PKGLIB_TAGFILE_H
24 #include <apt-pkg/fileutl.h>
35 // We have a limit of 256 tags per section.
36 unsigned int Indexes[256];
37 unsigned int AlphaIndexes[0x100];
39 unsigned int TagCount;
43 inline bool operator ==(const pkgTagSection &rhs) {return Section == rhs.Section;};
44 inline bool operator !=(const pkgTagSection &rhs) {return Section != rhs.Section;};
46 bool Find(const char *Tag,const char *&Start, const char *&End) const;
47 bool Find(const char *Tag,unsigned &Pos) const;
48 string FindS(const char *Tag) const;
49 signed int FindI(const char *Tag,signed long Default = 0) const ;
50 bool FindFlag(const char *Tag,unsigned long &Flags,
51 unsigned long Flag) const;
52 bool Scan(const char *Start,unsigned long MaxLength);
53 inline unsigned long size() const {return Stop - Section;};
55 void TrimRecord(bool BeforeRecord, const char* &End);
57 inline unsigned int Count() const {return TagCount;};
58 inline void Get(const char *&Start,const char *&Stop,unsigned int I) const
59 {Start = Section + Indexes[I]; Stop = Section + Indexes[I+1];}
61 inline void GetSection(const char *&Start,const char *&Stop) const
67 pkgTagSection() : Section(0), Stop(0) {};
77 unsigned long iOffset;
85 bool Step(pkgTagSection &Section);
86 inline unsigned long Offset() {return iOffset;};
87 bool Jump(pkgTagSection &Tag,unsigned long Offset);
89 pkgTagFile(FileFd *F,unsigned long Size = 32*1024);
93 /* This is the list of things to rewrite. The rewriter
94 goes through and changes or adds each of these headers
95 to suit. A zero forces the header to be erased, an empty string
96 causes the old value to be used. (rewrite rule ignored) */
103 extern const char **TFRewritePackageOrder;
104 extern const char **TFRewriteSourceOrder;
106 bool TFRewrite(FILE *Output,pkgTagSection const &Tags,const char *Order[],
107 TFRewriteData *Rewrite);