mirror of
https://github.com/Kitware/CMake.git
synced 2025-06-12 16:52:44 +08:00
bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6 enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
87 lines
2.6 KiB
C++
87 lines
2.6 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <cstddef>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <cm/string_view>
|
|
|
|
/**
|
|
* @brief Abstract base class for cryptographic hash generators
|
|
*/
|
|
class cmCryptoHash
|
|
{
|
|
public:
|
|
enum Algo
|
|
{
|
|
AlgoMD5,
|
|
AlgoSHA1,
|
|
AlgoSHA224,
|
|
AlgoSHA256,
|
|
AlgoSHA384,
|
|
AlgoSHA512,
|
|
AlgoSHA3_224,
|
|
AlgoSHA3_256,
|
|
AlgoSHA3_384,
|
|
AlgoSHA3_512
|
|
};
|
|
|
|
cmCryptoHash(Algo algo);
|
|
~cmCryptoHash();
|
|
|
|
cmCryptoHash(cmCryptoHash const&) = delete;
|
|
cmCryptoHash& operator=(cmCryptoHash const&) = delete;
|
|
|
|
/// @brief Returns a new hash generator of the requested type
|
|
/// @arg algo Hash type name. Supported hash types are
|
|
/// MD5, SHA1, SHA224, SHA256, SHA384, SHA512,
|
|
/// SHA3_224, SHA3_256, SHA3_384, SHA3_512
|
|
/// @return A valid auto pointer if algo is supported or
|
|
/// an invalid/NULL pointer otherwise
|
|
static std::unique_ptr<cmCryptoHash> New(cm::string_view algo);
|
|
|
|
/// @brief Converts a hex character to its binary value (4 bits)
|
|
/// @arg input Hex character [0-9a-fA-F].
|
|
/// @arg output Binary value of the input character (4 bits)
|
|
/// @return True if input was a valid hex character
|
|
static bool IntFromHexDigit(char input, char& output);
|
|
|
|
/// @brief Converts a byte hash to a sequence of hex character pairs
|
|
static std::string ByteHashToString(const std::vector<unsigned char>& hash);
|
|
|
|
/// @brief Calculates a binary hash from string input data
|
|
/// @return Binary hash vector
|
|
std::vector<unsigned char> ByteHashString(cm::string_view input);
|
|
|
|
/// @brief Calculates a binary hash from file content
|
|
/// @see ByteHashString()
|
|
/// @return Non empty binary hash vector if the file was read successfully.
|
|
/// An empty vector otherwise.
|
|
std::vector<unsigned char> ByteHashFile(const std::string& file);
|
|
|
|
/// @brief Calculates a hash string from string input data
|
|
/// @return Sequence of hex characters pairs for each byte of the binary hash
|
|
std::string HashString(cm::string_view input);
|
|
|
|
/// @brief Calculates a hash string from file content
|
|
/// @see HashString()
|
|
/// @return Non empty hash string if the file was read successfully.
|
|
/// An empty string otherwise.
|
|
std::string HashFile(const std::string& file);
|
|
|
|
void Initialize();
|
|
void Append(void const*, size_t);
|
|
void Append(cm::string_view input);
|
|
std::vector<unsigned char> Finalize();
|
|
std::string FinalizeHex();
|
|
|
|
private:
|
|
unsigned int Id;
|
|
struct rhash_context* CTX;
|
|
};
|