1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
|
/*
* Copyright 2017 The Native Object Protocols Authors
*
* 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 LIBNOP_INCLUDE_NOP_UTILITY_BOUNDED_READER_H_
#define LIBNOP_INCLUDE_NOP_UTILITY_BOUNDED_READER_H_
#include <cstddef>
#include <cstdint>
#include <iterator>
#include <nop/base/encoding.h>
#include <nop/base/handle.h>
#include <nop/base/utility.h>
namespace nop {
// BoundedReader is a reader type that wraps another reader pointer and tracks
// the number of bytes read. Reader operations are transparently passed to the
// underlying reader unless the requested operation would exceed the size limit
// set at construction. BufferReader can also skip padding remaining in the
// input up to the size limit in situations that require specific input payload
// size.
template <typename Reader>
class BoundedReader {
public:
constexpr BoundedReader() = default;
constexpr BoundedReader(const BoundedReader&) = default;
constexpr BoundedReader(Reader* reader, std::size_t size)
: reader_{reader}, size_{size} {}
constexpr BoundedReader& operator=(const BoundedReader&) = default;
constexpr Status<void> Ensure(std::size_t size) {
if (size_ - index_ < size)
return ErrorStatus::ReadLimitReached;
else
return reader_->Ensure(size);
}
constexpr Status<void> Read(std::uint8_t* byte) {
if (index_ < size_) {
auto status = reader_->Read(byte);
if (!status)
return status;
index_ += 1;
return {};
} else {
return ErrorStatus::ReadLimitReached;
}
}
template <typename T, typename Enable = EnableIfArithmetic<T>>
constexpr Status<void> Read(T* begin, T* end) {
const std::size_t element_size = sizeof(T);
const std::size_t length = end - begin;
const std::size_t length_bytes = length * element_size;
if (length_bytes > (size_ - index_))
return ErrorStatus::ReadLimitReached;
auto status = reader_->Read(begin, end);
if (!status)
return status;
index_ += length_bytes;
return {};
}
constexpr Status<void> Skip(std::size_t padding_bytes) {
if (padding_bytes > (size_ - index_))
return ErrorStatus::ReadLimitReached;
auto status = reader_->Skip(padding_bytes);
if (!status)
return status;
index_ += padding_bytes;
return {};
}
// Skips any bytes remaining in the limit set at construction.
constexpr Status<void> ReadPadding() {
const std::size_t padding_bytes = size_ - index_;
auto status = reader_->Skip(padding_bytes);
if (!status)
return status;
index_ += padding_bytes;
return {};
}
template <typename HandleType>
constexpr Status<HandleType> GetHandle(HandleReference handle_reference) {
return reader_->GetHandle(handle_reference);
}
constexpr bool empty() const { return index_ == size_; }
constexpr std::size_t size() const { return index_; }
constexpr std::size_t capacity() const { return size_; }
private:
Reader* reader_{nullptr};
std::size_t size_{0};
std::size_t index_{0};
};
} // namespace nop
#endif // LIBNOP_INCLUDE_NOP_UTILITY_BOUNDED_READER_H_
|