vtkDelimitedTextReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov

#ifndef vtkDelimitedTextReader_h
#define vtkDelimitedTextReader_h

#include "vtkIOInfovisModule.h" // For export macro
#include "vtkStdString.h"       // Needed for vtkStdString
#include "vtkTableAlgorithm.h"

#include <memory>
#include <string>

VTK_ABI_NAMESPACE_BEGIN

class vtkTextCodec;

class VTKIOINFOVIS_EXPORT vtkDelimitedTextReader : public vtkTableAlgorithm
{
public:
  static vtkDelimitedTextReader* New();
  vtkTypeMacro(vtkDelimitedTextReader, vtkTableAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkGetFilePathMacro(FileName);
  vtkSetFilePathMacro(FileName);


  void SetInputString(const char* in);
  vtkGetStringMacro(InputString);
  void SetInputString(const char* in, int len);
  vtkGetMacro(InputStringLength, int);
  void SetInputString(const vtkStdString& input)
  {
    this->SetInputString(input.c_str(), static_cast<int>(input.length()));
  }


  vtkSetMacro(ReadFromInputString, vtkTypeBool);
  vtkGetMacro(ReadFromInputString, vtkTypeBool);
  vtkBooleanMacro(ReadFromInputString, vtkTypeBool);


  vtkGetStringMacro(UnicodeCharacterSet);
  vtkSetStringMacro(UnicodeCharacterSet);


  void SetUTF8RecordDelimiters(const char* delimiters);
  const char* GetUTF8RecordDelimiters();


  vtkSetStringMacro(FieldDelimiterCharacters);
  vtkGetStringMacro(FieldDelimiterCharacters);

  void SetUTF8FieldDelimiters(const char* delimiters);
  const char* GetUTF8FieldDelimiters();


  vtkGetMacro(StringDelimiter, char);
  vtkSetMacro(StringDelimiter, char);

  void SetUTF8StringDelimiters(const char* delimiters);
  const char* GetUTF8StringDelimiters();


  vtkSetMacro(UseStringDelimiter, bool);
  vtkGetMacro(UseStringDelimiter, bool);
  vtkBooleanMacro(UseStringDelimiter, bool);


  vtkGetMacro(HaveHeaders, bool);
  vtkSetMacro(HaveHeaders, bool);


  vtkSetMacro(MergeConsecutiveDelimiters, bool);
  vtkGetMacro(MergeConsecutiveDelimiters, bool);
  vtkBooleanMacro(MergeConsecutiveDelimiters, bool);


  vtkGetMacro(MaxRecords, vtkIdType);
  vtkSetMacro(MaxRecords, vtkIdType);


  vtkGetMacro(SkippedRecords, vtkIdType);
  vtkSetMacro(SkippedRecords, vtkIdType);


  vtkSetMacro(DetectNumericColumns, bool);
  vtkGetMacro(DetectNumericColumns, bool);
  vtkBooleanMacro(DetectNumericColumns, bool);


  vtkSetMacro(ForceDouble, bool);
  vtkGetMacro(ForceDouble, bool);
  vtkBooleanMacro(ForceDouble, bool);


  vtkSetMacro(TrimWhitespacePriorToNumericConversion, bool);
  vtkGetMacro(TrimWhitespacePriorToNumericConversion, bool);
  vtkBooleanMacro(TrimWhitespacePriorToNumericConversion, bool);


  vtkSetMacro(DefaultIntegerValue, int);
  vtkGetMacro(DefaultIntegerValue, int);


  vtkSetMacro(DefaultDoubleValue, double);
  vtkGetMacro(DefaultDoubleValue, double);


  vtkSetStringMacro(PedigreeIdArrayName);
  vtkGetStringMacro(PedigreeIdArrayName);


  vtkSetMacro(GeneratePedigreeIds, bool);
  vtkGetMacro(GeneratePedigreeIds, bool);
  vtkBooleanMacro(GeneratePedigreeIds, bool);


  vtkSetMacro(OutputPedigreeIds, bool);
  vtkGetMacro(OutputPedigreeIds, bool);
  vtkBooleanMacro(OutputPedigreeIds, bool);


  vtkSetMacro(AddTabFieldDelimiter, bool);
  vtkGetMacro(AddTabFieldDelimiter, bool);
  vtkBooleanMacro(AddTabFieldDelimiter, bool);

  vtkStdString GetLastError();


  vtkSetMacro(ReplacementCharacter, vtkTypeUInt32);
  vtkGetMacro(ReplacementCharacter, vtkTypeUInt32);

  vtkGetMacro(Preview, std::string);


  vtkSetMacro(PreviewNumberOfLines, vtkIdType);
  vtkGetMacro(PreviewNumberOfLines, vtkIdType);


  vtkGetMacro(CommentCharacters, std::string);
  vtkSetMacro(CommentCharacters, std::string);

protected:
  vtkDelimitedTextReader();
  ~vtkDelimitedTextReader() override;

  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  // Read the content of the input file.
  int ReadData(vtkTable* output_table);

  char* FileName = nullptr;
  vtkTypeBool ReadFromInputString = 0;
  char* InputString = nullptr;
  int InputStringLength = 0;
  char* UnicodeCharacterSet = nullptr;
  vtkIdType SkippedRecords = 0;
  vtkIdType MaxRecords = 0;
  std::string UnicodeRecordDelimiters = "\r\n";
  std::string UnicodeFieldDelimiters = ",";
  std::string UnicodeStringDelimiters = "\"";
  std::string UnicodeWhitespace = " \t\r\n\v\f";
  std::string UnicodeEscapeCharacter = "\\";
  std::string CommentCharacters = "#";
  bool DetectNumericColumns = false;
  bool ForceDouble = false;
  bool TrimWhitespacePriorToNumericConversion = false;
  int DefaultIntegerValue = 0;
  double DefaultDoubleValue = 0.;
  char* FieldDelimiterCharacters = nullptr;
  char StringDelimiter = '"';
  bool UseStringDelimiter = true;
  bool HaveHeaders = false;
  bool MergeConsecutiveDelimiters = false;
  char* PedigreeIdArrayName = nullptr;
  bool GeneratePedigreeIds = true;
  bool OutputPedigreeIds = false;
  bool AddTabFieldDelimiter = false;
  vtkStdString LastError = "";
  vtkTypeUInt32 ReplacementCharacter = 'x';

  std::string Preview;
  vtkIdType PreviewNumberOfLines = 0;

private:
  std::unique_ptr<std::istream> OpenStream();

  void ReadBOM(std::istream* stream);

  vtkTextCodec* CreateTextCodec(std::istream* input_stream);

  vtkDelimitedTextReader(const vtkDelimitedTextReader&) = delete;
  void operator=(const vtkDelimitedTextReader&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif