VTK  9.0.20201125
vtkType.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkType.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 =========================================================================*/
15 #ifndef vtkType_h
16 #define vtkType_h
17 
18 #include "vtkCompiler.h" // for VTK_USE_EXTERN_TEMPLATE
19 #include "vtkLegacy.h" // For VTK_LEGACY_REMOVE
20 #include "vtkOptions.h" // for VTK_USE_64BIT_IDS and VTK_USE_64BIT_TIMESTAMPS
21 #include "vtk_kwiml.h"
22 
23 #define VTK_SIZEOF_CHAR KWIML_ABI_SIZEOF_CHAR
24 #define VTK_SIZEOF_SHORT KWIML_ABI_SIZEOF_SHORT
25 #define VTK_SIZEOF_INT KWIML_ABI_SIZEOF_INT
26 #define VTK_SIZEOF_LONG KWIML_ABI_SIZEOF_LONG
27 #define VTK_SIZEOF_LONG_LONG KWIML_ABI_SIZEOF_LONG_LONG
28 #define VTK_SIZEOF_FLOAT KWIML_ABI_SIZEOF_FLOAT
29 #define VTK_SIZEOF_DOUBLE KWIML_ABI_SIZEOF_DOUBLE
30 #define VTK_SIZEOF_VOID_P KWIML_ABI_SIZEOF_DATA_PTR
31 
32 /* Whether type "char" is signed (it may be signed or unsigned). */
33 #if defined(KWIML_ABI_CHAR_IS_SIGNED)
34 #define VTK_TYPE_CHAR_IS_SIGNED 1
35 #else
36 #define VTK_TYPE_CHAR_IS_SIGNED 0
37 #endif
38 
39 /*--------------------------------------------------------------------------*/
40 /* Define a unique integer identifier for each native scalar type. */
41 
42 /* These types are returned by GetDataType to indicate pixel type. */
43 #define VTK_VOID 0
44 #define VTK_BIT 1
45 #define VTK_CHAR 2
46 #define VTK_SIGNED_CHAR 15
47 #define VTK_UNSIGNED_CHAR 3
48 #define VTK_SHORT 4
49 #define VTK_UNSIGNED_SHORT 5
50 #define VTK_INT 6
51 #define VTK_UNSIGNED_INT 7
52 #define VTK_LONG 8
53 #define VTK_UNSIGNED_LONG 9
54 #define VTK_FLOAT 10
55 #define VTK_DOUBLE 11
56 #define VTK_ID_TYPE 12
57 
58 /* These types are not currently supported by GetDataType, but are for
59  completeness. */
60 #define VTK_STRING 13
61 #define VTK_OPAQUE 14
62 
63 #define VTK_LONG_LONG 16
64 #define VTK_UNSIGNED_LONG_LONG 17
65 
66 /* These types are required by vtkVariant and vtkVariantArray */
67 #define VTK_VARIANT 20
68 #define VTK_OBJECT 21
69 
70 /* Storage for Unicode strings */
71 #define VTK_UNICODE_STRING 22
72 
73 /*--------------------------------------------------------------------------*/
74 /* Define a unique integer identifier for each vtkDataObject type. */
75 /* When adding a new data type here, make sure to update */
76 /* vtkDataObjectTypes as well. */
77 #define VTK_POLY_DATA 0
78 #define VTK_STRUCTURED_POINTS 1
79 #define VTK_STRUCTURED_GRID 2
80 #define VTK_RECTILINEAR_GRID 3
81 #define VTK_UNSTRUCTURED_GRID 4
82 #define VTK_PIECEWISE_FUNCTION 5
83 #define VTK_IMAGE_DATA 6
84 #define VTK_DATA_OBJECT 7
85 #define VTK_DATA_SET 8
86 #define VTK_POINT_SET 9
87 #define VTK_UNIFORM_GRID 10
88 #define VTK_COMPOSITE_DATA_SET 11
89 #define VTK_MULTIGROUP_DATA_SET 12
90 #define VTK_MULTIBLOCK_DATA_SET 13
91 #define VTK_HIERARCHICAL_DATA_SET 14
92 #define VTK_HIERARCHICAL_BOX_DATA_SET 15
93 #define VTK_GENERIC_DATA_SET 16
94 #define VTK_HYPER_OCTREE 17
95 #define VTK_TEMPORAL_DATA_SET 18
96 #define VTK_TABLE 19
97 #define VTK_GRAPH 20
98 #define VTK_TREE 21
99 #define VTK_SELECTION 22
100 #define VTK_DIRECTED_GRAPH 23
101 #define VTK_UNDIRECTED_GRAPH 24
102 #define VTK_MULTIPIECE_DATA_SET 25
103 #define VTK_DIRECTED_ACYCLIC_GRAPH 26
104 #define VTK_ARRAY_DATA 27
105 #define VTK_REEB_GRAPH 28
106 #define VTK_UNIFORM_GRID_AMR 29
107 #define VTK_NON_OVERLAPPING_AMR 30
108 #define VTK_OVERLAPPING_AMR 31
109 #define VTK_HYPER_TREE_GRID 32
110 #define VTK_MOLECULE 33
111 #define VTK_PISTON_DATA_OBJECT 34
112 #define VTK_PATH 35
113 #define VTK_UNSTRUCTURED_GRID_BASE 36
114 #define VTK_PARTITIONED_DATA_SET 37
115 #define VTK_PARTITIONED_DATA_SET_COLLECTION 38
116 #define VTK_UNIFORM_HYPER_TREE_GRID 39
117 #define VTK_EXPLICIT_STRUCTURED_GRID 40
118 
119 /*--------------------------------------------------------------------------*/
120 /* Define a casting macro for use by the constants below. */
121 #if defined(__cplusplus)
122 #define VTK_TYPE_CAST(T, V) static_cast<T>(V)
123 #else
124 #define VTK_TYPE_CAST(T, V) ((T)(V))
125 #endif
126 
127 /*--------------------------------------------------------------------------*/
128 /* Define min/max constants for each type. */
129 #define VTK_BIT_MIN 0
130 #define VTK_BIT_MAX 1
131 #if VTK_TYPE_CHAR_IS_SIGNED
132 #define VTK_CHAR_MIN VTK_TYPE_CAST(char, 0x80)
133 #define VTK_CHAR_MAX VTK_TYPE_CAST(char, 0x7f)
134 #else
135 #define VTK_CHAR_MIN VTK_TYPE_CAST(char, 0u)
136 #define VTK_CHAR_MAX VTK_TYPE_CAST(char, 0xffu)
137 #endif
138 #define VTK_SIGNED_CHAR_MIN VTK_TYPE_CAST(signed char, 0x80)
139 #define VTK_SIGNED_CHAR_MAX VTK_TYPE_CAST(signed char, 0x7f)
140 #define VTK_UNSIGNED_CHAR_MIN VTK_TYPE_CAST(unsigned char, 0u)
141 #define VTK_UNSIGNED_CHAR_MAX VTK_TYPE_CAST(unsigned char, 0xffu)
142 #define VTK_SHORT_MIN VTK_TYPE_CAST(short, 0x8000)
143 #define VTK_SHORT_MAX VTK_TYPE_CAST(short, 0x7fff)
144 #define VTK_UNSIGNED_SHORT_MIN VTK_TYPE_CAST(unsigned short, 0u)
145 #define VTK_UNSIGNED_SHORT_MAX VTK_TYPE_CAST(unsigned short, 0xffffu)
146 #define VTK_INT_MIN VTK_TYPE_CAST(int, ~(~0u >> 1))
147 #define VTK_INT_MAX VTK_TYPE_CAST(int, ~0u >> 1)
148 #define VTK_UNSIGNED_INT_MIN VTK_TYPE_CAST(unsigned int, 0)
149 #define VTK_UNSIGNED_INT_MAX VTK_TYPE_CAST(unsigned int, ~0u)
150 #define VTK_LONG_MIN VTK_TYPE_CAST(long, ~(~0ul >> 1))
151 #define VTK_LONG_MAX VTK_TYPE_CAST(long, ~0ul >> 1)
152 #define VTK_UNSIGNED_LONG_MIN VTK_TYPE_CAST(unsigned long, 0ul)
153 #define VTK_UNSIGNED_LONG_MAX VTK_TYPE_CAST(unsigned long, ~0ul)
154 #define VTK_FLOAT_MIN VTK_TYPE_CAST(float, -1.0e+38f)
155 #define VTK_FLOAT_MAX VTK_TYPE_CAST(float, 1.0e+38f)
156 #define VTK_DOUBLE_MIN VTK_TYPE_CAST(double, -1.0e+299)
157 #define VTK_DOUBLE_MAX VTK_TYPE_CAST(double, 1.0e+299)
158 #define VTK_LONG_LONG_MIN VTK_TYPE_CAST(long long, ~(~0ull >> 1))
159 #define VTK_LONG_LONG_MAX VTK_TYPE_CAST(long long, ~0ull >> 1)
160 #define VTK_UNSIGNED_LONG_LONG_MIN VTK_TYPE_CAST(unsigned long long, 0ull)
161 #define VTK_UNSIGNED_LONG_LONG_MAX VTK_TYPE_CAST(unsigned long long, ~0ull)
162 
163 /*--------------------------------------------------------------------------*/
164 /* Define named types and constants corresponding to specific integer
165  and floating-point sizes and signedness. */
166 
167 /* Select an 8-bit integer type. */
168 #if VTK_SIZEOF_CHAR == 1
169 typedef unsigned char vtkTypeUInt8;
170 typedef signed char vtkTypeInt8;
171 #define VTK_TYPE_UINT8 VTK_UNSIGNED_CHAR
172 #define VTK_TYPE_UINT8_MIN VTK_UNSIGNED_CHAR_MIN
173 #define VTK_TYPE_UINT8_MAX VTK_UNSIGNED_CHAR_MAX
174 #if VTK_TYPE_CHAR_IS_SIGNED
175 #define VTK_TYPE_INT8 VTK_CHAR
176 #define VTK_TYPE_INT8_MIN VTK_CHAR_MIN
177 #define VTK_TYPE_INT8_MAX VTK_CHAR_MAX
178 #else
179 #define VTK_TYPE_INT8 VTK_SIGNED_CHAR
180 #define VTK_TYPE_INT8_MIN VTK_SIGNED_CHAR_MIN
181 #define VTK_TYPE_INT8_MAX VTK_SIGNED_CHAR_MAX
182 #endif
183 #else
184 #error "No native data type can represent an 8-bit integer."
185 #endif
186 
187 /* Select a 16-bit integer type. */
188 #if VTK_SIZEOF_SHORT == 2
189 typedef unsigned short vtkTypeUInt16;
190 typedef signed short vtkTypeInt16;
191 #define VTK_TYPE_UINT16 VTK_UNSIGNED_SHORT
192 #define VTK_TYPE_UINT16_MIN VTK_UNSIGNED_SHORT_MIN
193 #define VTK_TYPE_UINT16_MAX VTK_UNSIGNED_SHORT_MAX
194 #define VTK_TYPE_INT16 VTK_SHORT
195 #define VTK_TYPE_INT16_MIN VTK_SHORT_MIN
196 #define VTK_TYPE_INT16_MAX VTK_SHORT_MAX
197 #elif VTK_SIZEOF_INT == 2
198 typedef unsigned int vtkTypeUInt16;
199 typedef signed int vtkTypeInt16;
200 #define VTK_TYPE_UINT16 VTK_UNSIGNED_INT
201 #define VTK_TYPE_UINT16_MIN VTK_UNSIGNED_INT_MIN
202 #define VTK_TYPE_UINT16_MAX VTK_UNSIGNED_INT_MAX
203 #define VTK_TYPE_INT16 VTK_INT
204 #define VTK_TYPE_INT16_MIN VTK_INT_MIN
205 #define VTK_TYPE_INT16_MAX VTK_INT_MAX
206 #else
207 #error "No native data type can represent a 16-bit integer."
208 #endif
209 
210 /* Select a 32-bit integer type. */
211 #if VTK_SIZEOF_INT == 4
212 typedef unsigned int vtkTypeUInt32;
213 typedef signed int vtkTypeInt32;
214 #define VTK_TYPE_UINT32 VTK_UNSIGNED_INT
215 #define VTK_TYPE_UINT32_MIN VTK_UNSIGNED_INT_MIN
216 #define VTK_TYPE_UINT32_MAX VTK_UNSIGNED_INT_MAX
217 #define VTK_TYPE_INT32 VTK_INT
218 #define VTK_TYPE_INT32_MIN VTK_INT_MIN
219 #define VTK_TYPE_INT32_MAX VTK_INT_MAX
220 #elif VTK_SIZEOF_LONG == 4
221 typedef unsigned long vtkTypeUInt32;
222 typedef signed long vtkTypeInt32;
223 #define VTK_TYPE_UINT32 VTK_UNSIGNED_LONG
224 #define VTK_TYPE_UINT32_MIN VTK_UNSIGNED_LONG_MIN
225 #define VTK_TYPE_UINT32_MAX VTK_UNSIGNED_LONG_MAX
226 #define VTK_TYPE_INT32 VTK_LONG
227 #define VTK_TYPE_INT32_MIN VTK_LONG_MIN
228 #define VTK_TYPE_INT32_MAX VTK_LONG_MAX
229 #else
230 #error "No native data type can represent a 32-bit integer."
231 #endif
232 
233 /* Select a 64-bit integer type. */
234 #if VTK_SIZEOF_LONG_LONG == 8
235 typedef unsigned long long vtkTypeUInt64;
236 typedef signed long long vtkTypeInt64;
237 #define VTK_TYPE_UINT64 VTK_UNSIGNED_LONG_LONG
238 #define VTK_TYPE_UINT64_MIN VTK_UNSIGNED_LONG_LONG_MIN
239 #define VTK_TYPE_UINT64_MAX VTK_UNSIGNED_LONG_LONG_MAX
240 #define VTK_TYPE_INT64 VTK_LONG_LONG
241 #define VTK_TYPE_INT64_MIN VTK_LONG_LONG_MIN
242 #define VTK_TYPE_INT64_MAX VTK_LONG_LONG_MAX
243 #elif VTK_SIZEOF_LONG == 8
244 typedef unsigned long vtkTypeUInt64;
245 typedef signed long vtkTypeInt64;
246 #define VTK_TYPE_UINT64 VTK_UNSIGNED_LONG
247 #define VTK_TYPE_UINT64_MIN VTK_UNSIGNED_LONG_MIN
248 #define VTK_TYPE_UINT64_MAX VTK_UNSIGNED_LONG_MAX
249 #define VTK_TYPE_INT64 VTK_LONG
250 #define VTK_TYPE_INT64_MIN VTK_LONG_MIN
251 #define VTK_TYPE_INT64_MAX VTK_LONG_MAX
252 #else
253 #error "No native data type can represent a 64-bit integer."
254 #endif
255 
256 #if !defined(VTK_LEGACY_REMOVE)
257 // Provide this define to facilitate apps that need to support older
258 // versions that do not have vtkMTimeType
259 #define VTK_HAS_MTIME_TYPE
260 #endif
261 
262 // If this is a 64-bit platform, or the user has indicated that 64-bit
263 // timestamps should be used, select an unsigned 64-bit integer type
264 // for use in MTime values. If possible, use 'unsigned long' as we have
265 // historically.
266 #if defined(VTK_USE_64BIT_TIMESTAMPS) || VTK_SIZEOF_VOID_P == 8
267 #if VTK_SIZEOF_LONG == 8
268 typedef unsigned long vtkMTimeType;
269 #define VTK_MTIME_TYPE_IMPL VTK_UNSIGNED_LONG
270 #define VTK_MTIME_MIN VTK_UNSIGNED_LONG_MIN
271 #define VTK_MTIME_MAX VTK_UNSIGNED_LONG_MAX
272 #else
273 typedef vtkTypeUInt64 vtkMTimeType;
274 #define VTK_MTIME_TYPE_IMPL VTK_TYPE_UINT64
275 #define VTK_MTIME_MIN VTK_TYPE_UINT64_MIN
276 #define VTK_MTIME_MAX VTK_TYPE_UINT64_MAX
277 #endif
278 #else
279 #if VTK_SIZEOF_LONG == 4
280 typedef unsigned long vtkMTimeType;
281 #define VTK_MTIME_TYPE_IMPL VTK_UNSIGNED_LONG
282 #define VTK_MTIME_MIN VTK_UNSIGNED_LONG_MIN
283 #define VTK_MTIME_MAX VTK_UNSIGNED_LONG_MAX
284 #else
285 typedef vtkTypeUInt32 vtkMTimeType;
286 #define VTK_MTIME_TYPE_IMPL VTK_TYPE_UINT32
287 #define VTK_MTIME_MIN VTK_TYPE_UINT32_MIN
288 #define VTK_MTIME_MAX VTK_TYPE_UINT32_MAX
289 #endif
290 #endif
291 
292 /* Select a 32-bit floating point type. */
293 #if VTK_SIZEOF_FLOAT == 4
294 typedef float vtkTypeFloat32;
295 #define VTK_TYPE_FLOAT32 VTK_FLOAT
296 #else
297 #error "No native data type can represent a 32-bit floating point value."
298 #endif
299 
300 /* Select a 64-bit floating point type. */
301 #if VTK_SIZEOF_DOUBLE == 8
302 typedef double vtkTypeFloat64;
303 #define VTK_TYPE_FLOAT64 VTK_DOUBLE
304 #else
305 #error "No native data type can represent a 64-bit floating point value."
306 #endif
307 
308 /*--------------------------------------------------------------------------*/
309 /* Choose an implementation for vtkIdType. */
310 #define VTK_HAS_ID_TYPE
311 #ifdef VTK_USE_64BIT_IDS
312 #if VTK_SIZEOF_LONG_LONG == 8
313 typedef long long vtkIdType;
314 #define VTK_ID_TYPE_IMPL VTK_LONG_LONG
315 #define VTK_SIZEOF_ID_TYPE VTK_SIZEOF_LONG_LONG
316 #define VTK_ID_MIN VTK_LONG_LONG_MIN
317 #define VTK_ID_MAX VTK_LONG_LONG_MAX
318 #define VTK_ID_TYPE_PRId "lld"
319 #elif VTK_SIZEOF_LONG == 8
320 typedef long vtkIdType;
321 #define VTK_ID_TYPE_IMPL VTK_LONG
322 #define VTK_SIZEOF_ID_TYPE VTK_SIZEOF_LONG
323 #define VTK_ID_MIN VTK_LONG_MIN
324 #define VTK_ID_MAX VTK_LONG_MAX
325 #define VTK_ID_TYPE_PRId "ld"
326 #else
327 #error "VTK_USE_64BIT_IDS is ON but no 64-bit integer type is available."
328 #endif
329 #else
330 typedef int vtkIdType;
331 #define VTK_ID_TYPE_IMPL VTK_INT
332 #define VTK_SIZEOF_ID_TYPE VTK_SIZEOF_INT
333 #define VTK_ID_MIN VTK_INT_MIN
334 #define VTK_ID_MAX VTK_INT_MAX
335 #define VTK_ID_TYPE_PRId "d"
336 #endif
337 
338 #ifndef __cplusplus
339 // Make sure that when VTK headers are used by the C compiler we make
340 // sure to define the bool type. This is possible when using IO features
341 // like vtkXMLWriterC.h
342 #include "stdbool.h"
343 #endif
344 
345 /*--------------------------------------------------------------------------*/
346 /* If not already defined, define vtkTypeBool. When VTK was started, some */
347 /* compilers did not yet support the bool type, and so VTK often used int, */
348 /* or more rarely unsigned int, where it should have used bool. */
349 /* Eventually vtkTypeBool will switch to real bool. */
350 #ifndef VTK_TYPE_BOOL_TYPEDEFED
351 #define VTK_TYPE_BOOL_TYPEDEFED
352 #if 1
353 typedef int vtkTypeBool;
354 typedef unsigned int vtkTypeUBool;
355 #else
356 typedef bool vtkTypeBool;
357 typedef bool vtkTypeUBool;
358 #endif
359 #endif
360 
361 #if defined(__cplusplus)
362 /* Description:
363  * Returns true if data type tags a and b point to the same data type. This
364  * is intended to handle vtkIdType, which does not have the same tag as its
365  * underlying data type.
366  * @note This method is only available when included from a C++ source file. */
367 inline vtkTypeBool vtkDataTypesCompare(int a, int b)
368 {
369  return (a == b ||
370  ((a == VTK_ID_TYPE || a == VTK_ID_TYPE_IMPL) && (b == VTK_ID_TYPE || b == VTK_ID_TYPE_IMPL)));
371 }
372 #endif
373 
374 /*--------------------------------------------------------------------------*/
376 #define vtkInstantiateTemplateMacro(decl) \
377  decl<float>; \
378  decl<double>; \
379  decl<char>; \
380  decl<signed char>; \
381  decl<unsigned char>; \
382  decl<short>; \
383  decl<unsigned short>; \
384  decl<int>; \
385  decl<unsigned int>; \
386  decl<long>; \
387  decl<unsigned long>; \
388  decl<long long>; \
389  decl<unsigned long long>
390 
392 #ifdef VTK_USE_EXTERN_TEMPLATE
393 #define vtkExternTemplateMacro(decl) vtkInstantiateTemplateMacro(decl)
394 #else
395 #define vtkExternTemplateMacro(decl)
396 #endif
397 
398 #endif
399 // VTK-HeaderTest-Exclude: vtkType.h
vtkIdType
int vtkIdType
Definition: vtkType.h:330
vtkTypeUBool
unsigned int vtkTypeUBool
Definition: vtkType.h:354
vtkCompiler.h
VTK_ID_TYPE_IMPL
#define VTK_ID_TYPE_IMPL
Definition: vtkType.h:331
VTK_ID_TYPE
#define VTK_ID_TYPE
Definition: vtkType.h:56
vtkTypeBool
int vtkTypeBool
Definition: vtkType.h:353
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:285