travis: Add coverage testing using codecov.io

[apt.git] / apt-pkg / contrib / hashes.h

diff --git a/apt-pkg/contrib/hashes.h b/apt-pkg/contrib/hashes.h
index e2e2138551d62ba6a7cbc387ed9ffd5f9df31562..1fe0afc0099cf3147bce8235e4b7e93406d25db8 100644 (file)
--- a/apt-pkg/contrib/hashes.h
+++ b/apt-pkg/contrib/hashes.h
@@ -55,6 +55,8 @@ class HashString
    // get hash type used
    std::string HashType() const { return Type; };
    std::string HashValue() const { return Hash; };
    // get hash type used
    std::string HashType() const { return Type; };
    std::string HashValue() const { return Hash; };

+   APT_DEPRECATED_MSG("method was const-ified") std::string HashType() { return Type; };
+   APT_DEPRECATED_MSG("method was const-ified") std::string HashValue() { return Hash; };

 
    // verify the given filename against the currently loaded hash
    bool VerifyFile(std::string filename) const;
 
    // verify the given filename against the currently loaded hash
    bool VerifyFile(std::string filename) const;


@@ -66,6 +68,7 @@ class HashString
    // helper
    std::string toStr() const;                    // convert to str as "type:hash"
    bool empty() const;
    // helper
    std::string toStr() const;                    // convert to str as "type:hash"
    bool empty() const;

+   bool usable() const;

    bool operator==(HashString const &other) const;
    bool operator!=(HashString const &other) const;
 
    bool operator==(HashString const &other) const;
    bool operator!=(HashString const &other) const;
 


@@ -85,6 +88,22 @@ class HashStringList
     */
    HashString const * find(char const * const type) const;
    HashString const * find(std::string const &type) const { return find(type.c_str()); }
     */
    HashString const * find(char const * const type) const;
    HashString const * find(std::string const &type) const { return find(type.c_str()); }

+
+   /** finds the filesize hash and returns it as number
+    *
+    * @return beware: if the size isn't known we return \b 0 here,
+    * just like we would do for an empty file. If that is a problem
+    * for you have to get the size manually out of the list.
+    */
+   unsigned long long FileSize() const;
+
+   /** sets the filesize hash
+    *
+    * @param Size of the file
+    * @return @see #push_back
+    */
+   bool FileSize(unsigned long long const Size);
+

    /** check if the given hash type is supported
     *
     * @param type to check
    /** check if the given hash type is supported
     *
     * @param type to check


@@ -101,7 +120,7 @@ class HashStringList
    /** @return size of the list of HashStrings */
    size_t size() const { return list.size(); }
 
    /** @return size of the list of HashStrings */
    size_t size() const { return list.size(); }
 

-   /** take the 'best' hash and verify file with it
+   /** verify file against all hashes in the list

     *
     * @param filename to verify
     * @return true if the file matches the hashsum, otherwise false
     *
     * @param filename to verify
     * @return true if the file matches the hashsum, otherwise false


@@ -164,40 +183,47 @@ class HashStringList
 class PrivateHashes;
 class Hashes
 {
 class PrivateHashes;
 class Hashes
 {

-   PrivateHashes *d;
+   PrivateHashes * const d;

 
    public:
    /* those will disappear in the future as it is hard to add new ones this way.
     * Use Add* to build the results and get them via GetHashStringList() instead */
 
    public:
    /* those will disappear in the future as it is hard to add new ones this way.
     * Use Add* to build the results and get them via GetHashStringList() instead */

-   APT_DEPRECATED MD5Summation MD5;
-   APT_DEPRECATED SHA1Summation SHA1;
-   APT_DEPRECATED SHA256Summation SHA256;
-   APT_DEPRECATED SHA512Summation SHA512;
+   APT_DEPRECATED_MSG("Use general .Add* and .GetHashStringList methods instead of hardcoding specific hashes") MD5Summation MD5;
+   APT_DEPRECATED_MSG("Use general .Add* and .GetHashStringList methods instead of hardcoding specific hashes") SHA1Summation SHA1;
+   APT_DEPRECATED_MSG("Use general .Add* and .GetHashStringList methods instead of hardcoding specific hashes") SHA256Summation SHA256;
+   APT_DEPRECATED_MSG("Use general .Add* and .GetHashStringList methods instead of hardcoding specific hashes") SHA512Summation SHA512;

 
    static const int UntilEOF = 0;
 
 
    static const int UntilEOF = 0;
 

-   bool Add(const unsigned char * const Data, unsigned long long const Size, unsigned int const Hashes = ~0);
-   inline bool Add(const char * const Data)
+   bool Add(const unsigned char * const Data, unsigned long long const Size) APT_NONNULL(2);
+   APT_DEPRECATED_MSG("Construct accordingly instead of choosing hashes while adding") bool Add(const unsigned char * const Data, unsigned long long const Size, unsigned int const Hashes) APT_NONNULL(2);
+   inline bool Add(const char * const Data) APT_NONNULL(2)

    {return Add((unsigned char const * const)Data,strlen(Data));};
    {return Add((unsigned char const * const)Data,strlen(Data));};

-   inline bool Add(const unsigned char * const Beg,const unsigned char * const End)
+   inline bool Add(const unsigned char * const Beg,const unsigned char * const End) APT_NONNULL(2,3)

    {return Add(Beg,End-Beg);};
 
    enum SupportedHashes { MD5SUM = (1 << 0), SHA1SUM = (1 << 1), SHA256SUM = (1 << 2),
       SHA512SUM = (1 << 3) };
    {return Add(Beg,End-Beg);};
 
    enum SupportedHashes { MD5SUM = (1 << 0), SHA1SUM = (1 << 1), SHA256SUM = (1 << 2),
       SHA512SUM = (1 << 3) };

-   bool AddFD(int const Fd,unsigned long long Size = 0, unsigned int const Hashes = ~0);
-   bool AddFD(FileFd &Fd,unsigned long long Size = 0, unsigned int const Hashes = ~0);
+   bool AddFD(int const Fd,unsigned long long Size = 0);
+   APT_DEPRECATED_MSG("Construct accordingly instead of choosing hashes while adding") bool AddFD(int const Fd,unsigned long long Size, unsigned int const Hashes);
+   bool AddFD(FileFd &Fd,unsigned long long Size = 0);
+   APT_DEPRECATED_MSG("Construct accordingly instead of choosing hashes while adding") bool AddFD(FileFd &Fd,unsigned long long Size, unsigned int const Hashes);

 
    HashStringList GetHashStringList();
 
 
    HashStringList GetHashStringList();
 

-#if __GNUC__ >= 4
-       #pragma GCC diagnostic push
-       #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
-#endif
+APT_IGNORE_DEPRECATED_PUSH
+   /** create a Hashes object to calculate all supported hashes
+    *
+    * If ALL is too much, you can limit which Hashes are calculated
+    * with the following other constructors which mention explicitly
+    * which hashes to generate. */

    Hashes();
    Hashes();

+   /** @param Hashes bitflag composed of #SupportedHashes */
+   Hashes(unsigned int const Hashes);
+   /** @param Hashes is a list of hashes */
+   Hashes(HashStringList const &Hashes);

    virtual ~Hashes();
    virtual ~Hashes();

-#if __GNUC__ >= 4
-       #pragma GCC diagnostic pop
-#endif
+APT_IGNORE_DEPRECATED_POP

 
    private:
    APT_HIDDEN APT_CONST inline unsigned int boolsToFlag(bool const addMD5, bool const addSHA1, bool const addSHA256, bool const addSHA512)
 
    private:
    APT_HIDDEN APT_CONST inline unsigned int boolsToFlag(bool const addMD5, bool const addSHA1, bool const addSHA256, bool const addSHA512)


@@ -211,15 +237,16 @@ class Hashes
    }
 
    public:
    }
 
    public:

-   APT_DEPRECATED bool AddFD(int const Fd, unsigned long long Size, bool const addMD5,
+APT_IGNORE_DEPRECATED_PUSH
+   APT_DEPRECATED_MSG("Construct accordingly instead of choosing hashes while adding") bool AddFD(int const Fd, unsigned long long Size, bool const addMD5,

         bool const addSHA1, bool const addSHA256, bool const addSHA512) {
       return AddFD(Fd, Size, boolsToFlag(addMD5, addSHA1, addSHA256, addSHA512));
    };
         bool const addSHA1, bool const addSHA256, bool const addSHA512) {
       return AddFD(Fd, Size, boolsToFlag(addMD5, addSHA1, addSHA256, addSHA512));
    };

-
-   APT_DEPRECATED bool AddFD(FileFd &Fd, unsigned long long Size, bool const addMD5,
+   APT_DEPRECATED_MSG("Construct accordingly instead of choosing hashes while adding") bool AddFD(FileFd &Fd, unsigned long long Size, bool const addMD5,

         bool const addSHA1, bool const addSHA256, bool const addSHA512) {
       return AddFD(Fd, Size, boolsToFlag(addMD5, addSHA1, addSHA256, addSHA512));
    };
         bool const addSHA1, bool const addSHA256, bool const addSHA512) {
       return AddFD(Fd, Size, boolsToFlag(addMD5, addSHA1, addSHA256, addSHA512));
    };

+APT_IGNORE_DEPRECATED_POP

 };
 
 #endif
 };
 
 #endif