VTK  9.1.20211024
vtkByteSwap.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkByteSwap.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
24 #ifndef vtkByteSwap_h
25 #define vtkByteSwap_h
26 
27 #include "vtkCommonCoreModule.h" // For export macro
28 #include "vtkObject.h"
29 
30 class VTKCOMMONCORE_EXPORT vtkByteSwap : public vtkObject
31 {
32 public:
33  static vtkByteSwap* New();
34  vtkTypeMacro(vtkByteSwap, vtkObject);
35  void PrintSelf(ostream& os, vtkIndent indent) override;
36 
38 
43 #define VTK_BYTE_SWAP_DECL(T) \
44  static void SwapLE(T* p); \
45  static void SwapBE(T* p); \
46  static void SwapLERange(T* p, size_t num); \
47  static void SwapBERange(T* p, size_t num); \
48  static bool SwapLERangeWrite(const T* p, size_t num, FILE* file); \
49  static bool SwapBERangeWrite(const T* p, size_t num, FILE* file); \
50  static void SwapLERangeWrite(const T* p, size_t num, ostream* os); \
51  static void SwapBERangeWrite(const T* p, size_t num, ostream* os)
58  VTK_BYTE_SWAP_DECL(long long);
59  VTK_BYTE_SWAP_DECL(signed char);
60  VTK_BYTE_SWAP_DECL(unsigned char);
61  VTK_BYTE_SWAP_DECL(unsigned short);
62  VTK_BYTE_SWAP_DECL(unsigned int);
63  VTK_BYTE_SWAP_DECL(unsigned long);
64  VTK_BYTE_SWAP_DECL(unsigned long long);
65 #undef VTK_BYTE_SWAP_DECL
67 
69 
72  static void Swap2LE(void* p);
73  static void Swap4LE(void* p);
74  static void Swap8LE(void* p);
76 
78 
81  static void Swap2LERange(void* p, size_t num);
82  static void Swap4LERange(void* p, size_t num);
83  static void Swap8LERange(void* p, size_t num);
85 
87 
91  static bool SwapWrite2LERange(void const* p, size_t num, FILE* f);
92  static bool SwapWrite4LERange(void const* p, size_t num, FILE* f);
93  static bool SwapWrite8LERange(void const* p, size_t num, FILE* f);
94  static void SwapWrite2LERange(void const* p, size_t num, ostream* os);
95  static void SwapWrite4LERange(void const* p, size_t num, ostream* os);
96  static void SwapWrite8LERange(void const* p, size_t num, ostream* os);
98 
100 
103  static void Swap2BE(void* p);
104  static void Swap4BE(void* p);
105  static void Swap8BE(void* p);
107 
109 
112  static void Swap2BERange(void* p, size_t num);
113  static void Swap4BERange(void* p, size_t num);
114  static void Swap8BERange(void* p, size_t num);
116 
118 
122  static bool SwapWrite2BERange(void const* p, size_t num, FILE* f);
123  static bool SwapWrite4BERange(void const* p, size_t num, FILE* f);
124  static bool SwapWrite8BERange(void const* p, size_t num, FILE* f);
125  static void SwapWrite2BERange(void const* p, size_t num, ostream* os);
126  static void SwapWrite4BERange(void const* p, size_t num, ostream* os);
127  static void SwapWrite8BERange(void const* p, size_t num, ostream* os);
129 
134  static void SwapVoidRange(void* buffer, size_t numWords, size_t wordSize);
135 
136 protected:
138  ~vtkByteSwap() override;
139 
140 private:
141  vtkByteSwap(const vtkByteSwap&) = delete;
142  void operator=(const vtkByteSwap&) = delete;
143 };
144 
145 #endif
perform machine dependent byte swapping
Definition: vtkByteSwap.h:31
static void SwapWrite2LERange(void const *p, size_t num, ostream *os)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static bool SwapWrite4BERange(void const *p, size_t num, FILE *f)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void Swap2BERange(void *p, size_t num)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static bool SwapWrite2LERange(void const *p, size_t num, FILE *f)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
VTK_BYTE_SWAP_DECL(unsigned char)
VTK_BYTE_SWAP_DECL(float)
VTK_BYTE_SWAP_DECL(double)
static bool SwapWrite8BERange(void const *p, size_t num, FILE *f)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
VTK_BYTE_SWAP_DECL(unsigned short)
VTK_BYTE_SWAP_DECL(unsigned long long)
VTK_BYTE_SWAP_DECL(unsigned long)
static bool SwapWrite2BERange(void const *p, size_t num, FILE *f)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void SwapWrite8BERange(void const *p, size_t num, ostream *os)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void Swap8LE(void *p)
Swap 2, 4, or 8 bytes for storage as Little Endian.
VTK_BYTE_SWAP_DECL(short)
static void Swap4BERange(void *p, size_t num)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void Swap4BE(void *p)
Swap 2, 4, or 8 bytes for storage as Big Endian.
static void Swap4LE(void *p)
Swap 2, 4, or 8 bytes for storage as Little Endian.
static void Swap2LERange(void *p, size_t num)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
VTK_BYTE_SWAP_DECL(long)
static vtkByteSwap * New()
static void SwapWrite4BERange(void const *p, size_t num, ostream *os)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void Swap8BE(void *p)
Swap 2, 4, or 8 bytes for storage as Big Endian.
~vtkByteSwap() override
static void Swap2BE(void *p)
Swap 2, 4, or 8 bytes for storage as Big Endian.
static void SwapWrite4LERange(void const *p, size_t num, ostream *os)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void SwapWrite8LERange(void const *p, size_t num, ostream *os)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void Swap8LERange(void *p, size_t num)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static bool SwapWrite8LERange(void const *p, size_t num, FILE *f)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void Swap8BERange(void *p, size_t num)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
VTK_BYTE_SWAP_DECL(unsigned int)
static bool SwapWrite4LERange(void const *p, size_t num, FILE *f)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
static void Swap4LERange(void *p, size_t num)
Swap a block of 2-, 4-, or 8-byte segments for storage as Little Endian.
VTK_BYTE_SWAP_DECL(int)
static void SwapWrite2BERange(void const *p, size_t num, ostream *os)
Swap a block of 2-, 4-, or 8-byte segments for storage as Big Endian.
static void SwapVoidRange(void *buffer, size_t numWords, size_t wordSize)
Swaps the bytes of a buffer.
VTK_BYTE_SWAP_DECL(char)
VTK_BYTE_SWAP_DECL(signed char)
static void Swap2LE(void *p)
Swap 2, 4, or 8 bytes for storage as Little Endian.
VTK_BYTE_SWAP_DECL(long long)
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract base class for most VTK objects
Definition: vtkObject.h:82