vtkResourceParser.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 vtkResourceParser_h
#define vtkResourceParser_h
 
#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkResourceStream.h" // For SeekDirection and vtkResourceStream
#include "vtkSmartPointer.h"   // For vtkSmartPointer
 
#include <array>       // for std::array
#include <cstdint>     // for std::int32_t
#include <cstdlib>     // for std::size_t
#include <functional>  // for std::function
#include <limits>      // for std::numeric_limits
#include <memory>      // for std::unique_ptr
#include <string>      // for std::string
#include <type_traits> // for SFINAE helpers
 
VTK_ABI_NAMESPACE_BEGIN
 
#ifndef __VTK_WRAP__ // do not wrap

enum class vtkParseResult : std::int32_t
{
  Error = -1,      // Value not parsed because of type or formatting error
  Ok = 0,          // Value parsed successfully, no special status
  EndOfStream = 1, // No value parsed, stream reached its end
  EndOfLine = 2,   // No value parsed, this is an end of line
  Limit = 3,       // Value parsed successfully, limit has been reached
};

class VTKIOCORE_EXPORT vtkResourceParser : public vtkObject
{
public:
  using PredicateType = std::function<bool(char c)>;


  static const PredicateType DiscardNone;
  static const PredicateType DiscardWhitespace;
  static const PredicateType DiscardNonAlphaNumeric;

  using DataReceiverType = std::function<void(const char* data, std::size_t size)>;
 
  static constexpr std::size_t NoLimit = (std::numeric_limits<std::size_t>::max)();
 
private:
  class vtkInternals;

  class VTKIOCORE_EXPORT vtkParserContext
  {
  public:
    vtkParserContext();
    ~vtkParserContext();
    vtkParserContext(const vtkParserContext&) = delete;
    vtkParserContext& operator=(const vtkParserContext&) = delete;

    void SetStream(vtkResourceStream* stream);
    vtkResourceStream* GetStream() const;

    bool GetStopOnNewLine() const;
    void SetStopOnNewLine(bool on);

    vtkTypeInt64 Seek(vtkTypeInt64 pos, vtkResourceStream::SeekDirection dir);
    vtkTypeInt64 Tell();
    std::size_t Read(char* output, std::size_t size);
    void Reset();

    template <typename T>