python/cc/python_input_stream.h

// 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 TINK_PYTHON_CC_PYTHON_INPUT_STREAM_H_
#define TINK_PYTHON_CC_PYTHON_INPUT_STREAM_H_

#include <memory>

#include "tink/input_stream.h"
#include "tink/util/status.h"
#include "tink/util/statusor.h"
#include "tink/python/cc/python_file_object_adapter.h"

namespace crypto {
namespace tink {

// An InputStream that reads from a PythonFileObjectAdapter.
class PythonInputStream : public InputStream {
 public:
  // Constructs an InputStream that will read from the PythonFileObjectAdapter
  // specified via 'adapter', using a buffer of the specified size, if any
  // (if 'buffer_size' <= 0, a reasonable default will be used).
  explicit PythonInputStream(std::unique_ptr<PythonFileObjectAdapter> adapter,
                             int buffer_size = 0);

  ~PythonInputStream() override;

  util::StatusOr<int> Next(const void** data) override;

  void BackUp(int count) override;

  int64_t Position() const override;

 private:
  util::Status status_;
  std::unique_ptr<PythonFileObjectAdapter> adapter_;
  std::string buffer_;
  int64_t position_;  // current position in the file object (from the
                      // beginning)

  // Counters that describe the state of the data in buffer_.
  int count_in_buffer_;  // # of bytes available in buffer_
  int count_backedup_;   // # of bytes available in buffer_ that were backed up
  int buffer_offset_;    // offset at which the returned bytes start in buffer_
};

}  // namespace tink
}  // namespace crypto

#endif  // TINK_PYTHON_CC_PYTHON_INPUT_STREAM_H_