vtkTextCodec.h

Go to the documentation of this file.

/*=========================================================================
 
Program:   Visualization Toolkit
Module:    vtkTextCodec.h
 
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
#ifndef vtkTextCodec_h
#define vtkTextCodec_h
 
#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkUnicodeString.h" // for the value type and for function return.
 
class VTKIOCORE_EXPORT vtkTextCodec : public vtkObject
{
public:
  vtkTypeMacro(vtkTextCodec, vtkObject);
 
 
  virtual const char* Name();
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual bool CanHandle(const char* NameString);
 
  virtual bool IsValid(istream& InputStream);
 
 
  // FIXME(#18327): This class should be migrated to do UTF-8-based processing.
  // Currently it works based on `vtkUnicodeString` due to the `vtkTypeUInt32`
  // item type.
  class OutputIterator
  {
  public:
    virtual OutputIterator& operator++(int) { return *this; }
    virtual OutputIterator& operator*() { return *this; }
    virtual OutputIterator& operator=(const vtkTypeUInt32& value) = 0;
 
    OutputIterator() = default;
    virtual ~OutputIterator() = default;
 
  private:
    OutputIterator(const OutputIterator&) = delete;
    OutputIterator& operator=(const OutputIterator&) = delete;
  };
 
  virtual void ToUnicode(istream& inputStream, vtkTextCodec::OutputIterator& output);
 
  std::string ToString(istream& inputStream);
  VTK_DEPRECATED_IN_9_1_0("Use std::string ToString(istream& inputStream)")
  vtkUnicodeString ToUnicode(istream& inputStream);
 
  virtual vtkTypeUInt32 NextUTF32CodePoint(istream& inputStream) = 0;
  VTK_DEPRECATED_IN_9_1_0("Use vtkTypeUInt32 NextUTF32CodePoint(istream& inputStream)")
  vtkUnicodeString::value_type NextUnicode(istream& inputStream);
 
protected:
  vtkTextCodec();
  ~vtkTextCodec() override;
 
private:
  vtkTextCodec(const vtkTextCodec&) = delete;
  void operator=(const vtkTextCodec&) = delete;
};
 
#endif