fix test/integration/test-apt-ftparchive-cachedb-lp1274466 in travis
[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
ce62f1de
DK
23#include <apt-pkg/macros.h>
24
b2e465d6 25#include <stdio.h>
1abbce9e 26
472ff00e
DK
27#include <string>
28
b9dadc24
DK
29#ifndef APT_8_CLEANER_HEADERS
30#include <apt-pkg/fileutl.h>
31#endif
32
472ff00e
DK
33class FileFd;
34
578bfd0a
AL
35class pkgTagSection
36{
37 const char *Section;
578bfd0a 38 // We have a limit of 256 tags per section.
495e5cb2
MV
39 unsigned int Indexes[256];
40 unsigned int AlphaIndexes[0x100];
578bfd0a 41 unsigned int TagCount;
43fb90dc
MV
42 // dpointer placeholder (for later in case we need it)
43 void *d;
c176c4d0
DK
44
45 /* This very simple hash function for the last 8 letters gives
46 very good performance on the debian package files */
47 inline static unsigned long AlphaHash(const char *Text, const char *End = 0)
48 {
49 unsigned long Res = 0;
50 for (; Text != End && *Text != ':' && *Text != 0; Text++)
51 Res = ((unsigned long)(*Text) & 0xDF) ^ (Res << 1);
52 return Res & 0xFF;
53 }
54
81e9789b
MV
55 protected:
56 const char *Stop;
57
578bfd0a
AL
58 public:
59
60 inline bool operator ==(const pkgTagSection &rhs) {return Section == rhs.Section;};
61 inline bool operator !=(const pkgTagSection &rhs) {return Section != rhs.Section;};
62
b2e465d6 63 bool Find(const char *Tag,const char *&Start, const char *&End) const;
c8b860fb 64 bool Find(const char *Tag,unsigned int &Pos) const;
8f3ba4e8 65 std::string FindS(const char *Tag) const;
b2e465d6 66 signed int FindI(const char *Tag,signed long Default = 0) const ;
e2c66de5 67 unsigned long long FindULL(const char *Tag, unsigned long long const &Default = 0) const;
500827ed
AL
68 bool FindFlag(const char *Tag,unsigned long &Flags,
69 unsigned long Flag) const;
d64e130a 70 bool static FindFlag(unsigned long &Flags, unsigned long Flag,
fe0f7911 71 const char* Start, const char* Stop);
0852eaef 72 bool Scan(const char *Start,unsigned long MaxLength);
b2e465d6
AL
73 inline unsigned long size() const {return Stop - Section;};
74 void Trim();
81e9789b 75 virtual void TrimRecord(bool BeforeRecord, const char* &End);
b2e465d6
AL
76
77 inline unsigned int Count() const {return TagCount;};
c8b860fb 78 bool Exists(const char* const Tag);
c176c4d0 79
b2e465d6 80 inline void Get(const char *&Start,const char *&Stop,unsigned int I) const
0e66b144
AL
81 {Start = Section + Indexes[I]; Stop = Section + Indexes[I+1];}
82
b2e465d6 83 inline void GetSection(const char *&Start,const char *&Stop) const
a05599f1
AL
84 {
85 Start = Section;
86 Stop = this->Stop;
87 };
88
b40394c0 89 pkgTagSection();
43fb90dc 90 virtual ~pkgTagSection() {};
578bfd0a
AL
91};
92
1abbce9e 93class pkgTagFilePrivate;
578bfd0a
AL
94class pkgTagFile
95{
1abbce9e 96 pkgTagFilePrivate *d;
75c541fd 97
ce62f1de
DK
98 APT_HIDDEN bool Fill();
99 APT_HIDDEN bool Resize();
100 APT_HIDDEN bool Resize(unsigned long long const newSize);
75c541fd 101
578bfd0a
AL
102 public:
103
104 bool Step(pkgTagSection &Section);
4b2746d5 105 unsigned long Offset();
650faab0 106 bool Jump(pkgTagSection &Tag,unsigned long long Offset);
29f7b36c 107
650faab0 108 pkgTagFile(FileFd *F,unsigned long long Size = 32*1024);
43fb90dc 109 virtual ~pkgTagFile();
578bfd0a
AL
110};
111
b2e465d6
AL
112/* This is the list of things to rewrite. The rewriter
113 goes through and changes or adds each of these headers
114 to suit. A zero forces the header to be erased, an empty string
115 causes the old value to be used. (rewrite rule ignored) */
116struct TFRewriteData
117{
118 const char *Tag;
119 const char *Rewrite;
120 const char *NewTag;
121};
122extern const char **TFRewritePackageOrder;
123extern const char **TFRewriteSourceOrder;
124
125bool TFRewrite(FILE *Output,pkgTagSection const &Tags,const char *Order[],
126 TFRewriteData *Rewrite);
127
578bfd0a 128#endif