Of *course* I managed to get this check backwards.

[apt.git] / apt-pkg / tagfile.h

diff --git a/apt-pkg/tagfile.h b/apt-pkg/tagfile.h
index 4718f5101171bf68f5e63e11830e0fb8e77b1f44..bd3b4d1ea91008007ef23bcd6ce6690ecd30131d 100644 (file)
--- a/apt-pkg/tagfile.h
+++ b/apt-pkg/tagfile.h
@@ -1,6 +1,5 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: tagfile.h,v 1.20 2003/05/19 17:13:57 doogie Exp $

 /* ######################################################################
 
    Fast scanner for RFC-822 type header information
 /* ######################################################################
 
    Fast scanner for RFC-822 type header information


@@ -20,106 +19,213 @@
 #ifndef PKGLIB_TAGFILE_H
 #define PKGLIB_TAGFILE_H
 
 #ifndef PKGLIB_TAGFILE_H
 #define PKGLIB_TAGFILE_H
 

+#include <apt-pkg/macros.h>
+

 #include <stdio.h>
 #include <stdio.h>

+#include <stdint.h>

 
 #include <string>
 
 #include <string>

+#include <vector>
+#include <list>
+#ifdef APT_PKG_EXPOSE_STRING_VIEW
+#include <apt-pkg/string_view.h>
+#endif

 
 #ifndef APT_8_CLEANER_HEADERS
 #include <apt-pkg/fileutl.h>
 #endif
 
 class FileFd;
 
 #ifndef APT_8_CLEANER_HEADERS
 #include <apt-pkg/fileutl.h>
 #endif
 
 class FileFd;

+class pkgTagSectionPrivate;
+class pkgTagFilePrivate;

 
 

+/** \class pkgTagSection parses a single deb822 stanza and provides various Find methods
+ * to extract the included values. It can also be used to modify and write a
+ * valid deb822 stanza optionally (re)ordering the fields inside the stanza.
+ *
+ * Beware: This class does \b NOT support (#-)comments in in- or output!
+ * If the input contains comments they have to be stripped first like pkgTagFile
+ * does with SUPPORT_COMMENTS flag set. */

 class pkgTagSection
 {
    const char *Section;
 class pkgTagSection
 {
    const char *Section;

-   // We have a limit of 256 tags per section.
-   unsigned int Indexes[256];
-   unsigned int AlphaIndexes[0x100];
-   unsigned int TagCount;
-   // dpointer placeholder (for later in case we need it)
-   void *d;
-
-   /* This very simple hash function for the last 8 letters gives
-      very good performance on the debian package files */
-   inline static unsigned long AlphaHash(const char *Text, const char *End = 0)
-   {
-      unsigned long Res = 0;
-      for (; Text != End && *Text != ':' && *Text != 0; Text++)
-        Res = ((unsigned long)(*Text) & 0xDF) ^ (Res << 1);
-      return Res & 0xFF;
-   }
+   unsigned int AlphaIndexes[128];
+   unsigned int BetaIndexes[128];
+
+   pkgTagSectionPrivate * const d;
+
+   APT_HIDDEN bool FindInternal(unsigned int Pos,const char *&Start, const char *&End) const;
+#if defined(APT_PKG_EXPOSE_STRING_VIEW)
+   APT_HIDDEN APT::StringView FindInternal(unsigned int Pos) const;
+   APT_HIDDEN APT::StringView FindRawInternal(unsigned int Pos) const;
+#endif
+   APT_HIDDEN signed int FindIInternal(unsigned int Pos,signed long Default = 0) const;
+   APT_HIDDEN bool FindBInternal(unsigned int Pos, bool Default = false) const;
+   APT_HIDDEN unsigned long long FindULLInternal(unsigned int Pos, unsigned long long const &Default = 0) const;
+   APT_HIDDEN bool FindFlagInternal(unsigned int Pos,uint8_t &Flags, uint8_t const Flag) const;
+   APT_HIDDEN bool FindFlagInternal(unsigned int Pos,unsigned long &Flags, unsigned long Flag) const;

 
    protected:
    const char *Stop;
 
    public:
 
    protected:
    const char *Stop;
 
    public:

-   
+

    inline bool operator ==(const pkgTagSection &rhs) {return Section == rhs.Section;};
    inline bool operator !=(const pkgTagSection &rhs) {return Section != rhs.Section;};
    inline bool operator ==(const pkgTagSection &rhs) {return Section == rhs.Section;};
    inline bool operator !=(const pkgTagSection &rhs) {return Section != rhs.Section;};

-   
+
+#if !defined(APT_PKG_EXPOSE_STRING_VIEW) || defined(APT_COMPILING_TAGFILE_COMPAT_CC)

    bool Find(const char *Tag,const char *&Start, const char *&End) const;
    bool Find(const char *Tag,unsigned int &Pos) const;
    bool Find(const char *Tag,const char *&Start, const char *&End) const;
    bool Find(const char *Tag,unsigned int &Pos) const;

-   std::string FindS(const char *Tag) const;
-   signed int FindI(const char *Tag,signed long Default = 0) const ;
+   signed int FindI(const char *Tag,signed long Default = 0) const;
+   bool FindB(const char *Tag, bool const &Default = false) const;

    unsigned long long FindULL(const char *Tag, unsigned long long const &Default = 0) const;
    unsigned long long FindULL(const char *Tag, unsigned long long const &Default = 0) const;

+   bool FindFlag(const char * const Tag,uint8_t &Flags,
+                uint8_t const Flag) const;

    bool FindFlag(const char *Tag,unsigned long &Flags,
                 unsigned long Flag) const;
    bool FindFlag(const char *Tag,unsigned long &Flags,
                 unsigned long Flag) const;

-   bool static const FindFlag(unsigned long &Flags, unsigned long Flag,
+   bool Exists(const char* const Tag) const;
+#endif
+   // TODO: Remove internally
+   std::string FindS(const char *Tag) const;
+   std::string FindRawS(const char *Tag) const;
+
+   // Functions for lookup with a perfect hash function
+   enum class Key;
+   APT_HIDDEN bool Find(Key key,const char *&Start, const char *&End) const;
+   APT_HIDDEN bool Find(Key key,unsigned int &Pos) const;
+   APT_HIDDEN signed int FindI(Key key,signed long Default = 0) const;
+   APT_HIDDEN bool FindB(Key key, bool Default = false) const;
+   APT_HIDDEN unsigned long long FindULL(Key key, unsigned long long const &Default = 0) const;
+   APT_HIDDEN bool FindFlag(Key key,uint8_t &Flags, uint8_t const Flag) const;
+   APT_HIDDEN bool FindFlag(Key key,unsigned long &Flags, unsigned long Flag) const;
+   APT_HIDDEN bool Exists(Key key) const;
+#ifdef APT_PKG_EXPOSE_STRING_VIEW
+   APT_HIDDEN APT::StringView Find(Key key) const;
+   APT_HIDDEN APT::StringView FindRaw(Key key) const;
+   APT_HIDDEN bool Find(APT::StringView Tag,const char *&Start, const char *&End) const;
+   APT_HIDDEN bool Find(APT::StringView Tag,unsigned int &Pos) const;
+   APT_HIDDEN APT::StringView Find(APT::StringView Tag) const;
+   APT_HIDDEN APT::StringView FindRaw(APT::StringView Tag) const;
+   APT_HIDDEN signed int FindI(APT::StringView Tag,signed long Default = 0) const;
+   APT_HIDDEN bool FindB(APT::StringView, bool Default = false) const;
+   APT_HIDDEN unsigned long long FindULL(APT::StringView Tag, unsigned long long const &Default = 0) const;
+
+   APT_HIDDEN bool FindFlag(APT::StringView Tag,uint8_t &Flags,
+                uint8_t const Flag) const;
+   APT_HIDDEN bool FindFlag(APT::StringView Tag,unsigned long &Flags,
+                unsigned long Flag) const;
+   APT_HIDDEN bool Exists(APT::StringView Tag) const;
+#endif
+
+   bool static FindFlag(uint8_t &Flags, uint8_t const Flag,
+                               const char* const Start, const char* const Stop);
+   bool static FindFlag(unsigned long &Flags, unsigned long Flag,

                                const char* Start, const char* Stop);
                                const char* Start, const char* Stop);

-   bool Scan(const char *Start,unsigned long MaxLength);
+
+   /** \brief searches the boundaries of the current section
+    *
+    * While parameter Start marks the beginning of the section, this method
+    * will search for the first double newline in the data stream which marks
+    * the end of the section. It also does a first pass over the content of
+    * the section parsing it as encountered for processing later on by Find
+    *
+    * @param Start is the beginning of the section
+    * @param MaxLength is the size of valid data in the stream pointed to by Start
+    * @param Restart if enabled internal state will be cleared, otherwise it is
+    *  assumed that now more data is available in the stream and the parsing will
+    *  start were it encountered insufficent data the last time.
+    *
+    * @return \b true if section end was found, \b false otherwise.
+    *  Beware that internal state will be inconsistent if \b false is returned!
+    */
+   APT_MUSTCHECK bool Scan(const char *Start, unsigned long MaxLength, bool const SupportComments);
+

    inline unsigned long size() const {return Stop - Section;};
    inline unsigned long size() const {return Stop - Section;};

-   void Trim();
-   virtual void TrimRecord(bool BeforeRecord, const char* &End);
-   
-   inline unsigned int Count() const {return TagCount;};
-   bool Exists(const char* const Tag);
- 
-   inline void Get(const char *&Start,const char *&Stop,unsigned int I) const
-                   {Start = Section + Indexes[I]; Stop = Section + Indexes[I+1];}
-           
+   void TrimRecord(bool BeforeRecord, const char* &End, bool SupportComments);
+
+   /** \brief amount of Tags in the current section
+    *
+    * Note: if a Tag is mentioned repeatly it will be counted multiple
+    * times, but only the last occurrence is available via Find methods.
+    */
+   unsigned int Count() const;
+
+   void Get(const char *&Start,const char *&Stop,unsigned int I) const;
+

    inline void GetSection(const char *&Start,const char *&Stop) const
    {
       Start = Section;
       Stop = this->Stop;
    };
    inline void GetSection(const char *&Start,const char *&Stop) const
    {
       Start = Section;
       Stop = this->Stop;
    };

-   
-   pkgTagSection() : Section(0), TagCount(0), Stop(0) {};
-   virtual ~pkgTagSection() {};
+
+   pkgTagSection();
+   virtual ~pkgTagSection();
+
+   struct Tag
+   {
+      enum ActionType { REMOVE, RENAME, REWRITE } Action;
+      std::string Name;
+      std::string Data;
+
+      static Tag Remove(std::string const &Name);
+      static Tag Rename(std::string const &OldName, std::string const &NewName);
+      static Tag Rewrite(std::string const &Name, std::string const &Data);
+      private:
+      Tag(ActionType const Action, std::string const &Name, std::string const &Data) :
+        Action(Action), Name(Name), Data(Data) {}
+   };
+
+   /** Write this section (with optional rewrites) to a file
+    *
+    * @param File to write the section to
+    * @param Order in which tags should appear in the file
+    * @param Rewrite is a set of tags to be renamed, rewritten and/or removed
+    * @return \b true if successful, otherwise \b false
+    */
+   bool Write(FileFd &File, char const * const * const Order = NULL, std::vector<Tag> const &Rewrite = std::vector<Tag>()) const;

 };
 
 };
 

-class pkgTagFilePrivate;
+
+/** \class pkgTagFile reads and prepares a deb822 formatted file for parsing
+ * via #pkgTagSection. The default mode tries to be as fast as possible and
+ * assumes perfectly valid (machine generated) files like Packages. Support
+ * for comments e.g. needs to be enabled explicitly. */

 class pkgTagFile
 {
 class pkgTagFile
 {

-   pkgTagFilePrivate *d;
+   pkgTagFilePrivate * const d;

 
 

-   bool Fill();
-   bool Resize();
-
-   public:
+public:

 
    bool Step(pkgTagSection &Section);
    unsigned long Offset();
    bool Jump(pkgTagSection &Tag,unsigned long long Offset);
 
 
    bool Step(pkgTagSection &Section);
    unsigned long Offset();
    bool Jump(pkgTagSection &Tag,unsigned long long Offset);
 

-   pkgTagFile(FileFd *F,unsigned long long Size = 32*1024);
+   enum Flags
+   {
+      STRICT = 0,
+      SUPPORT_COMMENTS = 1 << 0,
+   };
+
+   void Init(FileFd * const F, pkgTagFile::Flags const Flags);
+   void Init(FileFd * const F);
+
+   pkgTagFile(FileFd * const F, pkgTagFile::Flags const Flags);
+   pkgTagFile(FileFd * const F);

    virtual ~pkgTagFile();
 };
 
    virtual ~pkgTagFile();
 };
 

-/* This is the list of things to rewrite. The rewriter
-   goes through and changes or adds each of these headers
-   to suit. A zero forces the header to be erased, an empty string
-   causes the old value to be used. (rewrite rule ignored) */
-struct TFRewriteData
+extern const char **TFRewritePackageOrder;
+extern const char **TFRewriteSourceOrder;
+
+APT_IGNORE_DEPRECATED_PUSH
+struct APT_DEPRECATED_MSG("Use pkgTagSection::Tag and pkgTagSection::Write() instead") TFRewriteData

 {
    const char *Tag;
    const char *Rewrite;
    const char *NewTag;
 };
 {
    const char *Tag;
    const char *Rewrite;
    const char *NewTag;
 };

-extern const char **TFRewritePackageOrder;
-extern const char **TFRewriteSourceOrder;
-
-bool TFRewrite(FILE *Output,pkgTagSection const &Tags,const char *Order[],
+APT_DEPRECATED_MSG("Use pkgTagSection::Tag and pkgTagSection::Write() instead") bool TFRewrite(FILE *Output,pkgTagSection const &Tags,const char *Order[],

               TFRewriteData *Rewrite);
               TFRewriteData *Rewrite);

+APT_IGNORE_DEPRECATED_POP

 
 #endif
 
 #endif