SHA1Calculator.hpp

Go to the documentation of this file.

//
// $Id: SHA1Calculator.hpp 1616 2009-12-11 21:26:54Z chambm $
//
//
// Original author: Darren Kessner <darren@proteowizard.org>
//
// Copyright 2007 Spielberg Family Center for Applied Proteomics 
//   Cedars-Sinai Medical Center, Los Angeles, California  90048
//
// Licensed under the Apache License, Version 2.0 (the "License"); 
// you may not use this file except in compliance with the License. 
// You may obtain a copy of the License at 
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software 
// distributed under the License is distributed on an "AS IS" BASIS, 
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
// See the License for the specific language governing permissions and 
// limitations under the License.
//


#ifndef _SHA1CALCULATOR_HPP_
#define _SHA1CALCULATOR_HPP_ 

#include "pwiz/utility/misc/Export.hpp"
#include "boost/shared_ptr.hpp"
#include <string>
#include <iostream>


namespace pwiz {
namespace util {


class PWIZ_API_DECL SHA1Calculator
{
    public:

    SHA1Calculator();

    /// resets hash 
    void reset();

    /// update hash with buffer of bytes
    void update(const unsigned char* buffer, size_t bufferSize);

    /// update hash with buffer of bytes
    void update(const std::string& buffer);

    /// finish the hash 
    void close();

    /// returns the current hash value 
    /// note: close() must be called first to retrieve final hash value
    std::string hash() const;
    
    /// returns projected final hash value as if close() were called first;
    /// hash remains open and update() may be called afterwards 
    std::string hashProjected() const;

    /// static function to calculate hash of a buffer
    static std::string hash(const std::string& buffer);

    /// static function to calculate hash of a buffer
    static std::string hash(const unsigned char* buffer, size_t bufferSize);

    /// static function to calculate hash of an input stream 
    static std::string hash(std::istream& is);

    /// static function to calculate hash of a file 
    static std::string hashFile(const std::string& filename);

    private:
    class Impl;
    boost::shared_ptr<Impl> impl_;
    SHA1Calculator(const SHA1Calculator&);
    SHA1Calculator& operator=(const SHA1Calculator&);
};


} // namespace util
} // namespace pwiz


#endif // _SHA1CALCULATOR_HPP_