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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
/*=========================================================================
*
* Portions of this file are subject to the VTK Toolkit Version 3 copyright.
*
* Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
*
* For complete copyright, license and disclaimer of warranty information
* please refer to the NOTICE file at the top of the ITK source tree.
*
*=========================================================================*/
#ifndef itkByteSwapper_h
#define itkByteSwapper_h
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkIntTypes.h"
namespace itk
{
/** \class ByteSwapper
* \brief Perform machine dependent byte swapping.
*
* ByteSwapper is used by I/O classes to perform machine dependent byte
* swapping. Byte swapping is often used when reading or writing binary
* files. Files can either be Big Endian (BE) or Little Endian (LE).
*
* \ingroup IOFilters
* \ingroup OSSystemObjects
* \ingroup ITKCommon
*/
template <typename T>
class ITK_TEMPLATE_EXPORT ByteSwapper : public Object
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ByteSwapper);
/** Standard class type aliases. */
using Self = ByteSwapper;
using Superclass = Object;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Work around MSVC bug (including ByteSwapper.h in a templated class). */
using OStreamType = std::ostream;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ByteSwapper);
/** Query the machine Endian-ness. */
static bool
SystemIsBigEndian();
static bool
SystemIsBE()
{
return SystemIsBigEndian();
}
static bool
SystemIsLittleEndian();
static bool
SystemIsLE()
{
return SystemIsLittleEndian();
}
/** Generic swap method handles type T. The swapping is
* done in-place. 2, 4 and 8 byte swapping
* can be handled. Single byte types are not swapped;
* others raise an exception. The method is used to
* swap to and from Big Endian. */
static void
SwapFromSystemToBigEndian(T * p);
/** Type for representing large buffers, including those in 64bits
* architectures */
using BufferSizeType = SizeValueType;
/** Generic swap method handles type T. The swapping is
* done in-place. 2, 4 and 8 byte swapping
* can be handled. Single byte types are not swapped;
* others raise an exception. The method is used to
* swap to and from Big Endian. */
static void
SwapRangeFromSystemToBigEndian(T * p, BufferSizeType num);
/** Generic swap method handles type T. The data is
* swapped and written (in binary) to the ostream
* given. A total of num values of type T are written
* and swapped. 2, 4 and 8 byte swapping
* can be handled. Single byte types are not swapped;
* others raise an exception. The method is used to
* swap to and from Big Endian. */
static void
SwapWriteRangeFromSystemToBigEndian(const T * p, int num, OStreamType * fp);
/** Generic swap method handles type T. The swapping is
* done in-place. 2, 4 and 8 byte swapping
* can be handled. Single byte types are not swapped;
* others raise an exception. The method is used to
* swap to and from Little Endian. */
static void
SwapFromSystemToLittleEndian(T * p);
/** Generic swap method handles type T. The swapping is
* done in-place. 2, 4 and 8 byte swapping
* can be handled. Single byte types are not swapped;
* others raise an exception. The method is used to
* swap to and from Little Endian. */
static void
SwapRangeFromSystemToLittleEndian(T * p, BufferSizeType num);
/** Generic swap method handles type T. The data is
* swapped and written (in binary) to the ostream
* given. A total of num values of type T are written
* and swapped. 2, 4 and 8 byte swapping
* can be handled. Single byte types are not swapped;
* others raise an exception. The method is used to
* swap to and from Little Endian. */
static void
SwapWriteRangeFromSystemToLittleEndian(const T * p, int num, OStreamType * fp);
protected:
ByteSwapper() = default;
~ByteSwapper() override = default;
/** Swap 2 bytes. */
static void
Swap2(void * pin);
/** Swap a range of two-byte words. Num is the number of two-byte
* words to swap. */
static void
Swap2Range(void * ptr, BufferSizeType num);
/** Swap and write a range of two-byte words. Num is the number of two-byte
* words to swap and write. */
static void
SwapWrite2Range(const void * ptr, BufferSizeType num, OStreamType * fp);
/** Swap four bytes. */
static void
Swap4(void * ptr);
/** Swap a range of four-byte words. Num is the number of four-byte words
* to swap. */
static void
Swap4Range(void * ptr, BufferSizeType num);
/** Swap and write a range of four-byte words. Num is the number of four-byte
* words to swap and write. */
static void
SwapWrite4Range(const void * ptr, BufferSizeType num, OStreamType * fp);
/** Swap 8 bytes. */
static void
Swap8(void * ptr);
/** Swap a range of 8-byte words. Num is the number of four-byte words
* to swap. */
static void
Swap8Range(void * ptr, BufferSizeType num);
/** Swap and write a range of 8-byte words. Num is the number of four-byte
* words to swap and write. */
static void
SwapWrite8Range(const void * ptr, BufferSizeType num, OStreamType * fp);
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkByteSwapper.hxx"
#endif
#endif
|
