You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
118 lines
3.5 KiB
C++
118 lines
3.5 KiB
C++
/*=========================================================================
|
|
|
|
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.
|
|
-------------------------------------------------------------------------*/
|
|
/**
|
|
* @class vtkTextCodec
|
|
* @brief Virtual class to act as an interface for all text codecs
|
|
*
|
|
*
|
|
* A virtual class interface for codecs that readers/writers can rely on
|
|
*
|
|
* @par Thanks:
|
|
* Thanks to Tim Shed from Sandia National Laboratories for his work
|
|
* on the concepts and to Marcus Hanwell and Jeff Baumes of Kitware for
|
|
* keeping me out of the weeds
|
|
*
|
|
* @sa
|
|
* vtkTextCodecFactory
|
|
*
|
|
*/
|
|
|
|
#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);
|
|
|
|
//@{
|
|
/**
|
|
* The name this codec goes by - should match the string the factory will take
|
|
* to create it
|
|
*/
|
|
virtual const char* Name();
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
|
//@}
|
|
|
|
virtual bool CanHandle(const char* NameString);
|
|
|
|
/**
|
|
* is the given sample valid for this codec? The stream will not be advanced.
|
|
*/
|
|
virtual bool IsValid(istream& InputStream);
|
|
|
|
//@{
|
|
/**
|
|
* a base class that any output iterators need to derive from to use the first
|
|
* signature of to_unicode. Templates will not allow the vtable to
|
|
* re-reference to the correct class so even though we only need the interface
|
|
* we have to use derivation.
|
|
*/
|
|
class OutputIterator
|
|
{
|
|
public:
|
|
virtual OutputIterator& operator++(int) = 0;
|
|
virtual OutputIterator& operator*() = 0;
|
|
virtual OutputIterator& operator=(const vtkUnicodeString::value_type value) = 0;
|
|
//@}
|
|
|
|
OutputIterator() {}
|
|
virtual ~OutputIterator() {}
|
|
|
|
private:
|
|
OutputIterator(const OutputIterator&) = delete;
|
|
OutputIterator& operator=(const OutputIterator&) = delete;
|
|
};
|
|
|
|
/**
|
|
* Iterate through the sequence represented by the stream assigning the result
|
|
* to the output iterator. The stream will be advanced to its end so
|
|
* subsequent use would need to reset it.
|
|
*/
|
|
virtual void ToUnicode(istream& InputStream, vtkTextCodec::OutputIterator& output) = 0;
|
|
|
|
/**
|
|
* convenience method to take data from the stream and put it into a
|
|
* vtkUnicodeString.
|
|
*/
|
|
vtkUnicodeString ToUnicode(istream& inputStream);
|
|
|
|
/**
|
|
* Return the next code point from the sequence represented by the stream
|
|
* advancing the stream through however many places needed to assemble that
|
|
* code point.
|
|
*/
|
|
virtual vtkUnicodeString::value_type NextUnicode(istream& inputStream) = 0;
|
|
|
|
protected:
|
|
vtkTextCodec();
|
|
~vtkTextCodec() override;
|
|
|
|
private:
|
|
vtkTextCodec(const vtkTextCodec&) = delete;
|
|
void operator=(const vtkTextCodec&) = delete;
|
|
};
|
|
|
|
#endif
|