1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*=========================================================================
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);
//@}
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&) VTK_DELETE_FUNCTION;
const OutputIterator& operator=(const OutputIterator&) VTK_DELETE_FUNCTION;
};
/**
* 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;
/**
* convinience 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();
private:
vtkTextCodec(const vtkTextCodec &) VTK_DELETE_FUNCTION;
void operator=(const vtkTextCodec &) VTK_DELETE_FUNCTION;
};
#endif
|
