2012-07-22 18:02:13 +03:00
|
|
|
/*
|
|
|
|
* CInputStream.h, part of VCMI engine
|
|
|
|
*
|
|
|
|
* Authors: listed in file AUTHORS in main folder
|
|
|
|
*
|
|
|
|
* License: GNU General Public License v2.0 or later
|
|
|
|
* Full text of license available in license.txt file, in main folder
|
|
|
|
*
|
|
|
|
*/
|
2017-07-13 10:26:03 +02:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "CStream.h"
|
2012-07-22 18:02:13 +03:00
|
|
|
|
2022-07-26 15:07:42 +02:00
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
|
2012-07-22 18:02:13 +03:00
|
|
|
/**
|
|
|
|
* Abstract class which provides method definitions for reading from a stream.
|
|
|
|
*/
|
2015-08-08 16:30:19 +02:00
|
|
|
class DLL_LINKAGE CInputStream : public virtual CStream
|
2012-07-22 18:02:13 +03:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Reads n bytes from the stream into the data buffer.
|
|
|
|
*
|
|
|
|
* @param data A pointer to the destination data array.
|
|
|
|
* @param size The number of bytes to read.
|
|
|
|
* @return the number of bytes read actually.
|
|
|
|
*/
|
|
|
|
virtual si64 read(ui8 * data, si64 size) = 0;
|
|
|
|
|
|
|
|
/**
|
2013-07-28 17:49:50 +03:00
|
|
|
* @brief for convenience, reads whole stream at once
|
|
|
|
*
|
|
|
|
* @return pair, first = raw data, second = size of data
|
2012-07-22 18:02:13 +03:00
|
|
|
*/
|
2014-02-09 00:54:35 +03:00
|
|
|
std::pair<std::unique_ptr<ui8[]>, si64> readAll()
|
2013-07-28 17:49:50 +03:00
|
|
|
{
|
|
|
|
std::unique_ptr<ui8[]> data(new ui8[getSize()]);
|
|
|
|
|
2013-11-08 23:36:26 +03:00
|
|
|
seek(0);
|
2023-04-10 16:44:41 +02:00
|
|
|
[[maybe_unused]] auto readSize = read(data.get(), getSize());
|
2013-07-28 17:49:50 +03:00
|
|
|
assert(readSize == getSize());
|
|
|
|
|
|
|
|
return std::make_pair(std::move(data), getSize());
|
|
|
|
}
|
2013-11-08 23:36:26 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief calculateCRC32 calculates CRC32 checksum for the whole file
|
|
|
|
* @return calculated checksum
|
|
|
|
*/
|
|
|
|
virtual ui32 calculateCRC32()
|
|
|
|
{
|
|
|
|
si64 originalPos = tell();
|
|
|
|
|
|
|
|
boost::crc_32_type checksum;
|
|
|
|
auto data = readAll();
|
|
|
|
checksum.process_bytes(reinterpret_cast<const void *>(data.first.get()), data.second);
|
|
|
|
|
|
|
|
seek(originalPos);
|
|
|
|
|
|
|
|
return checksum.checksum();
|
|
|
|
}
|
2012-07-22 18:02:13 +03:00
|
|
|
};
|
2022-07-26 15:07:42 +02:00
|
|
|
|
|
|
|
VCMI_LIB_NAMESPACE_END
|