doc: Fix fuzzy string regression

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

diff --git a/apt-pkg/indexfile.h b/apt-pkg/indexfile.h
index 2d433b60a4f92b29e3424ffd3941ca7c3ce2c776..68753a40af1e6362970b621466df70f52111947f 100644 (file)
--- a/apt-pkg/indexfile.h
+++ b/apt-pkg/indexfile.h
@@ -1,6 +1,5 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: indexfile.h,v 1.6.2.1 2003/12/24 23:09:17 mdz Exp $

 /* ######################################################################
 
    Index File - Abstraction for an index of archive/source file.
 /* ######################################################################
 
    Index File - Abstraction for an index of archive/source file.


@@ -10,52 +9,121 @@
    
    Binary index files 
    Binary translation files 
    
    Binary index files 
    Binary translation files 

-   Bianry index files decribing the local system
+   Binary index files describing the local system

    Source index files
    
    They are all bundled together here, and the interfaces for 
    sources.list, acquire, cache gen and record parsing all use this class
    Source index files
    
    They are all bundled together here, and the interfaces for 
    sources.list, acquire, cache gen and record parsing all use this class

-   to acess the underlying representation.
+   to access the underlying representation.

    
    ##################################################################### */
                                                                        /*}}}*/
 #ifndef PKGLIB_INDEXFILE_H
 #define PKGLIB_INDEXFILE_H
 
    
    ##################################################################### */
                                                                        /*}}}*/
 #ifndef PKGLIB_INDEXFILE_H
 #define PKGLIB_INDEXFILE_H
 

-
-#include <string>
-#include <apt-pkg/pkgcache.h>

 #include <apt-pkg/srcrecords.h>
 #include <apt-pkg/pkgrecords.h>
 #include <apt-pkg/srcrecords.h>
 #include <apt-pkg/pkgrecords.h>

+#include <apt-pkg/pkgcache.h>
+#include <apt-pkg/cacheiterators.h>

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

+#include <map>
+#include <string>
+

 #ifndef APT_8_CLEANER_HEADERS
 using std::string;
 #endif
 #ifndef APT_8_CLEANER_HEADERS
 using std::string;
 #endif

-
+#ifndef APT_10_CLEANER_HEADERS

 class pkgAcquire;
 class pkgAcquire;

+#endif
+

 class pkgCacheGenerator;
 class pkgCacheGenerator;

+class pkgCacheListParser;

 class OpProgress;
 
 class OpProgress;
 

+class IndexTarget                                                      /*{{{*/
+/** \brief Information about an index file. */
+{
+   public:
+   /** \brief A URI from which the index file can be downloaded. */
+   std::string URI;
+
+   /** \brief A description of the index file. */
+   std::string Description;
+
+   /** \brief A shorter description of the index file. */
+   std::string ShortDesc;
+
+   /** \brief The key by which this index file should be
+       looked up within the meta index file. */
+   std::string MetaKey;
+
+   /** \brief Is it okay if the file isn't found in the meta index */
+   bool IsOptional;
+
+   /** \brief If the file is downloaded compressed, do not unpack it */
+   bool KeepCompressed;
+
+   /** \brief options with which this target was created
+       Prefer the usage of #Option if at all possible.
+       Beware: Not all of these options are intended for public use */
+   std::map<std::string, std::string> Options;
+
+   IndexTarget(std::string const &MetaKey, std::string const &ShortDesc,
+        std::string const &LongDesc, std::string const &URI, bool const IsOptional,
+        bool const KeepCompressed, std::map<std::string, std::string> const &Options);
+
+   enum OptionKeys {
+      SITE,
+      RELEASE,
+      COMPONENT,
+      LANGUAGE,
+      ARCHITECTURE,
+      BASE_URI,
+      REPO_URI,
+      CREATED_BY,
+      TARGET_OF,
+      FILENAME,
+      EXISTING_FILENAME,
+      PDIFFS,
+      COMPRESSIONTYPES,
+      DEFAULTENABLED,
+      SOURCESENTRY,
+      BY_HASH,
+      KEEPCOMPRESSEDAS,
+      FALLBACK_OF,
+      IDENTIFIER,
+      ALLOW_INSECURE,
+      ALLOW_WEAK,
+      ALLOW_DOWNGRADE_TO_INSECURE,
+   };
+   std::string Option(OptionKeys const Key) const;
+   bool OptionBool(OptionKeys const Key) const;
+   std::string Format(std::string format) const;
+};
+                                                                       /*}}}*/
+

 class pkgIndexFile
 {
 class pkgIndexFile
 {

+   void * const d;

    protected:
    bool Trusted;
    protected:
    bool Trusted;

-     
+

    public:
 
    class Type
    {
       public:
    public:
 
    class Type
    {
       public:

-      
+

       // Global list of Items supported
       static Type **GlobalList;
       static unsigned long GlobalListLen;
       // Global list of Items supported
       static Type **GlobalList;
       static unsigned long GlobalListLen;

-      static Type *GetType(const char *Type);
+      static Type *GetType(const char * const Type) APT_PURE;

 
       const char *Label;
 
 
       const char *Label;
 

-      virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator /*File*/) const {return 0;};
+      virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator const &/*File*/) const {return 0;};
+      virtual pkgSrcRecords::Parser *CreateSrcPkgParser(std::string const &/*File*/) const {return 0;};

       Type();
       virtual ~Type() {};
    };
       Type();
       virtual ~Type() {};
    };


@@ -63,13 +131,13 @@ class pkgIndexFile
    virtual const Type *GetType() const = 0;
    
    // Return descriptive strings of various sorts
    virtual const Type *GetType() const = 0;
    
    // Return descriptive strings of various sorts

-   virtual std::string ArchiveInfo(pkgCache::VerIterator Ver) const;
+   virtual std::string ArchiveInfo(pkgCache::VerIterator const &Ver) const;

    virtual std::string SourceInfo(pkgSrcRecords::Parser const &Record,
                             pkgSrcRecords::File const &File) const;
    virtual std::string SourceInfo(pkgSrcRecords::Parser const &Record,
                             pkgSrcRecords::File const &File) const;

-   virtual std::string Describe(bool Short = false) const = 0;   
+   virtual std::string Describe(bool const Short = false) const = 0;

 
    // Interface for acquire
 
    // Interface for acquire

-   virtual std::string ArchiveURI(std::string /*File*/) const {return std::string();};
+   virtual std::string ArchiveURI(std::string const &/*File*/) const {return std::string();};

 
    // Interface for the record parsers
    virtual pkgSrcRecords::Parser *CreateSrcParser() const {return 0;};
 
    // Interface for the record parsers
    virtual pkgSrcRecords::Parser *CreateSrcParser() const {return 0;};


@@ -78,22 +146,82 @@ class pkgIndexFile
    virtual bool Exists() const = 0;
    virtual bool HasPackages() const = 0;
    virtual unsigned long Size() const = 0;
    virtual bool Exists() const = 0;
    virtual bool HasPackages() const = 0;
    virtual unsigned long Size() const = 0;

-   virtual bool Merge(pkgCacheGenerator &Gen, OpProgress* Prog) const { return false; };
-   __deprecated virtual bool Merge(pkgCacheGenerator &Gen, OpProgress &Prog) const
-      { return Merge(Gen, &Prog); };
-   virtual bool MergeFileProvides(pkgCacheGenerator &Gen,OpProgress* Prog) const {return true;};
-   __deprecated virtual bool MergeFileProvides(pkgCacheGenerator &Gen, OpProgress &Prog) const
-      {return MergeFileProvides(Gen, &Prog);};
+   virtual bool Merge(pkgCacheGenerator &/*Gen*/, OpProgress* const /*Prog*/) { return true; };

    virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const;
 
    virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const;
 

-   static bool TranslationsAvailable();
-   static bool CheckLanguageCode(const char *Lang);
-   static std::string LanguageCode();
+   APT_DEPRECATED_MSG("These methods make no sense anymore with multi-language support") static bool TranslationsAvailable();
+   /* No intern need for this method anymore as the check for correctness
+      is already done in getLanguages(). Note also that this check is
+      rather bad (doesn't take three character like ast into account).*/
+   APT_DEPRECATED_MSG("These methods make no sense anymore with multi-language support") static bool CheckLanguageCode(const char * const Lang);
+   /* As we have now possibly more than one LanguageCode this method is
+      superseeded by a) private classmembers or b) getLanguages() */
+   APT_DEPRECATED_MSG("These methods make no sense anymore with multi-language support") static std::string LanguageCode();

 
    bool IsTrusted() const { return Trusted; };
 
    bool IsTrusted() const { return Trusted; };

-   
-   pkgIndexFile(bool Trusted): Trusted(Trusted) {};
-   virtual ~pkgIndexFile() {};
+
+   explicit pkgIndexFile(bool const Trusted);
+   virtual ~pkgIndexFile();
+};
+
+class pkgDebianIndexFile : public pkgIndexFile
+{
+protected:
+   virtual std::string IndexFileName() const = 0;
+   virtual std::string GetComponent() const = 0;
+   virtual std::string GetArchitecture() const = 0;
+   virtual std::string GetProgressDescription() const = 0;
+   virtual uint8_t GetIndexFlags() const = 0;
+   virtual bool OpenListFile(FileFd &Pkg, std::string const &FileName) = 0;
+   APT_HIDDEN virtual pkgCacheListParser * CreateListParser(FileFd &Pkg);
+
+public:
+   virtual bool Merge(pkgCacheGenerator &Gen, OpProgress* const Prog) APT_OVERRIDE;
+   virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const APT_OVERRIDE;
+
+   explicit pkgDebianIndexFile(bool const Trusted);
+   virtual ~pkgDebianIndexFile();
+};
+
+class pkgDebianIndexTargetFile : public pkgDebianIndexFile
+{
+   void * const d;
+protected:
+   IndexTarget const Target;
+
+   virtual std::string IndexFileName() const APT_OVERRIDE;
+   virtual std::string GetComponent() const APT_OVERRIDE;
+   virtual std::string GetArchitecture() const APT_OVERRIDE;
+   virtual std::string GetProgressDescription() const APT_OVERRIDE;
+   virtual bool OpenListFile(FileFd &Pkg, std::string const &FileName) APT_OVERRIDE;
+
+public:
+   virtual std::string ArchiveURI(std::string const &File) const APT_OVERRIDE;
+   virtual std::string Describe(bool const Short = false) const APT_OVERRIDE;
+   virtual bool Exists() const APT_OVERRIDE;
+   virtual unsigned long Size() const APT_OVERRIDE;
+
+   pkgDebianIndexTargetFile(IndexTarget const &Target, bool const Trusted);
+   virtual ~pkgDebianIndexTargetFile();
+};
+
+class pkgDebianIndexRealFile : public pkgDebianIndexFile
+{
+   void * const d;
+protected:
+   std::string File;
+
+   virtual std::string IndexFileName() const APT_OVERRIDE;
+   virtual std::string GetProgressDescription() const APT_OVERRIDE;
+   virtual bool OpenListFile(FileFd &Pkg, std::string const &FileName) APT_OVERRIDE;
+public:
+   virtual std::string Describe(bool const /*Short*/ = false) const APT_OVERRIDE;
+   virtual bool Exists() const APT_OVERRIDE;
+   virtual unsigned long Size() const APT_OVERRIDE;
+   virtual std::string ArchiveURI(std::string const &/*File*/) const APT_OVERRIDE;
+
+   pkgDebianIndexRealFile(std::string const &File, bool const Trusted);
+   virtual ~pkgDebianIndexRealFile();

 };
 
 #endif
 };
 
 #endif