Files
oemcrypto/util/include/buffer_reader.h
2025-05-22 16:33:29 -07:00

79 lines
2.4 KiB
C++

// Copyright 2018 Google LLC. All Rights Reserved. This file and proprietary
// source code may only be used and distributed under the Widevine License
// Agreement.
#ifndef WVCDM_UTIL_BUFFER_READER_H_
#define WVCDM_UTIL_BUFFER_READER_H_
#include <inttypes.h>
#include <string>
#include <vector>
#include "wv_class_utils.h"
namespace wvutil {
// Annotate a function indicating the caller must examine the return value.
// Use like:
// int foo() WARN_UNUSED_RESULT;
// To explicitly ignore a result, see |ignore_result()| in <base/basictypes.h>.
#if defined(COMPILER_GCC)
# define WARN_UNUSED_RESULT __attribute__((warn_unused_result))
#else
# define WARN_UNUSED_RESULT
#endif
class BufferReader {
public:
BufferReader() = delete;
WVCDM_DISALLOW_COPY_AND_MOVE(BufferReader);
BufferReader(const uint8_t* buf, size_t size)
: buf_(buf), size_(buf != nullptr ? size : 0) {}
// == Accessors ==
constexpr const uint8_t* data() const { return buf_; }
constexpr size_t size() const { return size_; }
constexpr size_t pos() const { return pos_; }
constexpr size_t BytesRemaining() const {
return size_ >= pos_ ? size_ - pos_ : 0;
}
constexpr bool HasBytes(size_t count) const {
return count <= BytesRemaining();
}
constexpr bool IsEof() const { return pos_ >= size_; }
// Read a value from the stream, performing endian correction,
// and advance the stream pointer.
bool Read1(uint8_t* v) WARN_UNUSED_RESULT;
bool Read2(uint16_t* v) WARN_UNUSED_RESULT;
bool Read2s(int16_t* v) WARN_UNUSED_RESULT;
bool Read4(uint32_t* v) WARN_UNUSED_RESULT;
bool Read4s(int32_t* v) WARN_UNUSED_RESULT;
bool Read8(uint64_t* v) WARN_UNUSED_RESULT;
bool Read8s(int64_t* v) WARN_UNUSED_RESULT;
bool ReadString(std::string* str, size_t count) WARN_UNUSED_RESULT;
bool ReadVec(std::vector<uint8_t>* t, size_t count) WARN_UNUSED_RESULT;
// These variants read a 4-byte integer of the corresponding signedness and
// store it in the 8-byte return type.
bool Read4Into8(uint64_t* v) WARN_UNUSED_RESULT;
bool Read4sInto8s(int64_t* v) WARN_UNUSED_RESULT;
// Advance the stream by this many bytes.
bool SkipBytes(size_t count) WARN_UNUSED_RESULT;
private:
const uint8_t* buf_ = nullptr;
size_t size_ = 0;
size_t pos_ = 0;
template <typename T>
bool Read(T* t) WARN_UNUSED_RESULT;
}; // class BufferReader
} // namespace wvutil
#endif // WVCDM_UTIL_BUFFER_READER_H_