vtkResourceStream.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkResourceStream_h
#define vtkResourceStream_h

#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkSmartPointer.h" // For vtkSmartPointer

#include <cstdlib>   // for std::size_t
#include <memory>    // for std::unique_ptr
#include <streambuf> // for std::basic_streambuf

VTK_ABI_NAMESPACE_BEGIN

class VTKIOCORE_EXPORT vtkResourceStream : public vtkObject
{
  struct vtkInternals;

public:
  enum class SeekDirection
  {
    Begin = 0,
    Current = 1,
    End = 2
  };

  vtkTypeMacro(vtkResourceStream, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual std::size_t Read(void* buffer, std::size_t bytes) = 0;

  virtual bool EndOfStream() = 0;

  virtual vtkTypeInt64 Seek(vtkTypeInt64 pos, SeekDirection dir);

  virtual vtkTypeInt64 Tell();

  bool SupportSeek() const;

#ifndef __VTK_WRAP__

  std::unique_ptr<std::streambuf> ToStreambuf();
#endif

protected:
  vtkResourceStream(bool supportSeek);
  ~vtkResourceStream() override;
  vtkResourceStream(const vtkResourceStream&) = delete;
  vtkResourceStream& operator=(const vtkResourceStream&) = delete;

private:
  std::unique_ptr<vtkInternals> Impl;
};

VTK_ABI_NAMESPACE_END

#endif