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
119
120
121
122
123
124
125
126
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkBase64Utilities.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.
=========================================================================*/
// .NAME vtkBase64Utilities - base64 encode and decode utilities.
// .SECTION Description
// vtkBase64Utilities implements base64 encoding and decoding.
#ifndef vtkBase64Utilities_h
#define vtkBase64Utilities_h
#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"
class VTKIOCORE_EXPORT vtkBase64Utilities : public vtkObject
{
public:
static vtkBase64Utilities *New();
vtkTypeMacro(vtkBase64Utilities,vtkObject);
// Description:
// Encode 3 bytes into 4 bytes
static void EncodeTriplet(unsigned char i0,
unsigned char i1,
unsigned char i2,
unsigned char *o0,
unsigned char *o1,
unsigned char *o2,
unsigned char *o3);
// Description:
// Encode 2 bytes into 4 bytes
static void EncodePair(unsigned char i0,
unsigned char i1,
unsigned char *o0,
unsigned char *o1,
unsigned char *o2,
unsigned char *o3);
// Description:
// Encode 1 byte into 4 bytes
static void EncodeSingle(unsigned char i0,
unsigned char *o0,
unsigned char *o1,
unsigned char *o2,
unsigned char *o3);
// Description:
// Encode 'length' bytes from the input buffer and store the
// encoded stream into the output buffer. Return the length of
// the encoded stream. Note that the output buffer must be allocated
// by the caller (length * 1.5 should be a safe estimate).
// If 'mark_end' is true then an extra set of 4 bytes is added
// to the end of the stream if the input is a multiple of 3 bytes.
// These bytes are invalid chars and therefore they will stop the decoder
// thus enabling the caller to decode a stream without actually knowing
// how much data to expect (if the input is not a multiple of 3 bytes then
// the extra padding needed to complete the encode 4 bytes will stop the
// decoding anyway).
static unsigned long Encode(const unsigned char *input,
unsigned long length,
unsigned char *output,
int mark_end = 0);
// Description:
// Decode 4 bytes into 3 bytes.
// Return the number of bytes actually decoded (0 to 3, inclusive).
static int DecodeTriplet(unsigned char i0,
unsigned char i1,
unsigned char i2,
unsigned char i3,
unsigned char *o0,
unsigned char *o1,
unsigned char *o2);
// Description:
// Decode bytes from the input buffer and store the decoded stream
// into the output buffer until 'length' bytes have been decoded.
// Return the real length of the decoded stream (which should be equal to
// 'length'). Note that the output buffer must be allocated by the caller.
// If 'max_input_length' is not 0, then it specifies the number of
// encoded bytes that should be at most read from the input buffer. In
// that case the 'length' parameter is ignored. This enables the caller
// to decode a stream without actually knowing how much decoded data to
// expect (of course, the buffer must be large enough).
// \deprecated: This method can easily overrun its buffers, use DecodeSafely.
VTK_LEGACY(static unsigned long Decode(const unsigned char *input,
unsigned long length,
unsigned char *output,
unsigned long max_input_length = 0));
// Description:
// Decode 4 bytes at a time from the input buffer and store the decoded
// stream into the output buffer. The required output buffer size must be
// determined and allocated by the caller. The needed output space is
// always less than the input buffer size, so a good first order
// approximation is to allocate the same size. Base64 encoding is about
// 4/3 overhead, so a tighter bound is possible.
// Return the number of bytes atually placed into the output buffer.
static size_t DecodeSafely(const unsigned char *input,
size_t inputLen,
unsigned char *output,
size_t outputLen);
protected:
vtkBase64Utilities() {}
~vtkBase64Utilities() {}
private:
vtkBase64Utilities(const vtkBase64Utilities&); // Not implemented.
void operator=(const vtkBase64Utilities&); // Not implemented.
};
#endif
// VTK-HeaderTest-Exclude: vtkBase64Utilities.h
|
