* apt-pkg/depcache.cc:
[ntk/apt.git] / apt-pkg / tagfile.h
CommitLineData
578bfd0a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
0852eaef 3// $Id: tagfile.h,v 1.20 2003/05/19 17:13:57 doogie Exp $
578bfd0a
AL
4/* ######################################################################
5
6 Fast scanner for RFC-822 type header information
7
8 This parser handles Debian package files (and others). Their form is
b2e465d6 9 RFC-822 type header fields in groups separated by a blank line.
578bfd0a 10
6fc33863 11 The parser reads the file and provides methods to step linearly
578bfd0a
AL
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 /*}}}*/
578bfd0a
AL
20#ifndef PKGLIB_TAGFILE_H
21#define PKGLIB_TAGFILE_H
22
6c139d6e 23
094a497d 24#include <apt-pkg/fileutl.h>
b2e465d6
AL
25#include <stdio.h>
26
578bfd0a
AL
27class pkgTagSection
28{
29 const char *Section;
578bfd0a
AL
30
31 // We have a limit of 256 tags per section.
495e5cb2
MV
32 unsigned int Indexes[256];
33 unsigned int AlphaIndexes[0x100];
c1a22377 34
578bfd0a 35 unsigned int TagCount;
c176c4d0
DK
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
81e9789b
MV
48 protected:
49 const char *Stop;
50
578bfd0a
AL
51 public:
52
53 inline bool operator ==(const pkgTagSection &rhs) {return Section == rhs.Section;};
54 inline bool operator !=(const pkgTagSection &rhs) {return Section != rhs.Section;};
55
b2e465d6
AL
56 bool Find(const char *Tag,const char *&Start, const char *&End) const;
57 bool Find(const char *Tag,unsigned &Pos) const;
58 string FindS(const char *Tag) const;
59 signed int FindI(const char *Tag,signed long Default = 0) const ;
500827ed
AL
60 bool FindFlag(const char *Tag,unsigned long &Flags,
61 unsigned long Flag) const;
0852eaef 62 bool Scan(const char *Start,unsigned long MaxLength);
b2e465d6
AL
63 inline unsigned long size() const {return Stop - Section;};
64 void Trim();
81e9789b 65 virtual void TrimRecord(bool BeforeRecord, const char* &End);
b2e465d6
AL
66
67 inline unsigned int Count() const {return TagCount;};
c176c4d0
DK
68 inline bool Exists(const char* const Tag) {return AlphaIndexes[AlphaHash(Tag)] != 0;}
69
b2e465d6 70 inline void Get(const char *&Start,const char *&Stop,unsigned int I) const
0e66b144
AL
71 {Start = Section + Indexes[I]; Stop = Section + Indexes[I+1];}
72
b2e465d6 73 inline void GetSection(const char *&Start,const char *&Stop) const
a05599f1
AL
74 {
75 Start = Section;
76 Stop = this->Stop;
77 };
78
578bfd0a
AL
79 pkgTagSection() : Section(0), Stop(0) {};
80};
81
82class pkgTagFile
83{
8e06abb2 84 FileFd &Fd;
578bfd0a
AL
85 char *Buffer;
86 char *Start;
87 char *End;
99c2e5ac 88 bool Done;
dcb79bae 89 unsigned long iOffset;
ad00ae81 90 unsigned long Size;
75c541fd 91
99c2e5ac 92 bool Fill();
75c541fd
MV
93 bool Resize();
94
578bfd0a
AL
95 public:
96
97 bool Step(pkgTagSection &Section);
dcb79bae 98 inline unsigned long Offset() {return iOffset;};
ad00ae81 99 bool Jump(pkgTagSection &Tag,unsigned long Offset);
29f7b36c 100
75c541fd 101 pkgTagFile(FileFd *F,unsigned long Size = 32*1024);
29f7b36c 102 ~pkgTagFile();
578bfd0a
AL
103};
104
b2e465d6
AL
105/* This is the list of things to rewrite. The rewriter
106 goes through and changes or adds each of these headers
107 to suit. A zero forces the header to be erased, an empty string
108 causes the old value to be used. (rewrite rule ignored) */
109struct TFRewriteData
110{
111 const char *Tag;
112 const char *Rewrite;
113 const char *NewTag;
114};
115extern const char **TFRewritePackageOrder;
116extern const char **TFRewriteSourceOrder;
117
118bool TFRewrite(FILE *Output,pkgTagSection const &Tags,const char *Order[],
119 TFRewriteData *Rewrite);
120
578bfd0a 121#endif