-
-
Notifications
You must be signed in to change notification settings - Fork 664
/
itkMacro.h
1433 lines (1294 loc) · 75.3 KB
/
itkMacro.h
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*=========================================================================
*
* 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.
*
*=========================================================================*/
/**
* itkMacro.h defines standard system-wide macros, constants, and other
* parameters. One of its most important functions is to define macros used
* to interface to instance variables in a standard fashion. For example,
* these macros manage modified time, debugging information, and provide a
* standard interface to set and get instance variables. Macros are
* available for built-in types; for string classes; vector arrays;
* object pointers; and debug, warning, and error printout information.
*/
#ifndef itkMacro_h
#define itkMacro_h
#include "itkWin32Header.h"
#include "itkConfigure.h"
#include "ITKCommonExport.h"
#include <typeinfo>
#include <string>
#include <cstdlib>
#ifndef NDEBUG
# include <cassert>
# include "itkPrintHelper.h" // for ostream operator<<std::vector<T>
#endif
#include <sstream>
#include <type_traits> // For is_same, remove_const, and remove_reference.
/** \namespace itk
* \brief The "itk" namespace contains all Insight Segmentation and
* Registration Toolkit (ITK) classes. There are several nested namespaces
* within the itk:: namespace. */
namespace itk
{
// end namespace itk - this is here for documentation purposes
}
/** A convenience macro marks variables as not being used by a method,
* avoiding compile-time warnings. */
#define itkNotUsed(x)
// clang-format off
/** The `static_assert(true, "")` idiom is commonly employed for
* C++11 or greater to ensure that it is compile-time only
* check that can not be part of the binary file.
* This allows a macro to be used anywhere that a statement
* is expected, and to enforce consistent use of ; after
* a macro. The static_assert is a constexpr that can be used
* in places where raw statements (i.e. 'do{} while(0)') are
* not allowed (i.e. after class member function definitions).
* */
#define ITK_NOOP_STATEMENT static_assert(true, "")
#if defined(ITK_FUTURE_LEGACY_REMOVE)
# define ITK_MACROEND_NOOP_STATEMENT ITK_NOOP_STATEMENT
#else
/* NOTE: The ITK_MACROEND_NOOP_STATEMENT must be defined to nothing
* in order to maintain backwards compatibility with earlier macro
* uses that may or may not have ';' after the macro is used. */
/* Purposefully empty */
# define ITK_MACROEND_NOOP_STATEMENT
#endif
// clang-format on
// Define ITK_PRAGMA macro.
//
// It sets "#pragma" preprocessor directives without expecting the arguments
// to be quoted.
#define ITK_PRAGMA(x) _Pragma(#x)
// The GCC/Clang compilers have many useful non-default compiler warnings
// that tend to have a high false positive rate or are otherwise not always appropriate.
// The following set of defines allows us to suppress instances of said warnings.
// For GCC and Clang (Clang also identifies itself as GCC, and supports these pragmas):
#if defined(__GNUC__)
# define ITK_GCC_PRAGMA_PUSH ITK_PRAGMA(GCC diagnostic push)
# define ITK_GCC_PRAGMA_POP ITK_PRAGMA(GCC diagnostic pop)
# define ITK_GCC_SUPPRESS_Wfloat_equal ITK_PRAGMA(GCC diagnostic ignored "-Wfloat-equal")
# define ITK_GCC_SUPPRESS_Wformat_nonliteral ITK_PRAGMA(GCC diagnostic ignored "-Wformat-nonliteral")
#else
# define ITK_GCC_PRAGMA_PUSH
# define ITK_GCC_PRAGMA_POP
# define ITK_GCC_SUPPRESS_Wfloat_equal
# define ITK_GCC_SUPPRESS_Wformat_nonliteral
#endif
// For Clang only (and not GCC):
#if defined(__clang__) && defined(__has_warning)
# define CLANG_PRAGMA_PUSH ITK_PRAGMA(clang diagnostic push)
# define CLANG_PRAGMA_POP ITK_PRAGMA(clang diagnostic pop)
#else
# define CLANG_PRAGMA_PUSH
# define CLANG_PRAGMA_POP
#endif
#if !defined(ITK_LEGACY_REMOVE)
// Issue warning if deprecated preprocessor flag is used.
# define CLANG_SUPPRESS_Wcpp14_extensions \
[[deprecated("Remove deprecated CLANG_SUPPRESS_Wcpp14_extensions c++14 warning suppression")]] void * \
CLANG_SUPPRESS_Wcpp14_extensions = nullptr;
#endif
// Intel compiler convenience macros
#if defined(__INTEL_COMPILER)
# define INTEL_PRAGMA_WARN_PUSH ITK_PRAGMA(warning push)
# define INTEL_PRAGMA_WARN_POP ITK_PRAGMA(warning pop)
# define INTEL_SUPPRESS_warning_1292 ITK_PRAGMA(warning disable 1292)
#else
# define INTEL_PRAGMA_WARN_PUSH
# define INTEL_PRAGMA_WARN_POP
# define INTEL_SUPPRESS_warning_1292
#endif
// Define ITK_GCC_PRAGMA_DIAG(param1 [param2 [...]]) macro.
//
// This macro sets a pragma diagnostic
//
// Define ITK_GCC_PRAGMA_DIAG_(PUSH|POP) macros.
//
// These macros respectively push and pop the diagnostic context
//
#if defined(__GNUC__) && !defined(__INTEL_COMPILER)
# define ITK_GCC_PRAGMA_DIAG(x) ITK_PRAGMA(GCC diagnostic x)
# define ITK_GCC_PRAGMA_DIAG_PUSH() ITK_GCC_PRAGMA_DIAG(push)
# define ITK_GCC_PRAGMA_DIAG_POP() ITK_GCC_PRAGMA_DIAG(pop)
#else
# define ITK_GCC_PRAGMA_DIAG(x)
# define ITK_GCC_PRAGMA_DIAG_PUSH()
# define ITK_GCC_PRAGMA_DIAG_POP()
#endif
/*
* ITK only supports MSVC++ 14.2 and greater
* MSVC++ 14.2 _MSC_VER == 1920 (Visual Studio 2019 Version 16.0)
*/
#if defined(_MSC_VER) && (_MSC_VER < 1920)
# error "MSVC versions before Visual Studio 2019 are not supported under ITKv5.4"
#endif
#if defined(__SUNPRO_CC) && (__SUNPRO_CC < 0x5140)
# error "SUNPro C++ < 5.14.0 is not supported under ITKv5 and above"
#endif
#if defined(__CYGWIN__)
# error "The Cygwin compiler is not supported in ITKv4 and above"
#endif
#if defined(__BORLANDC__)
# error "The Borland C compiler is not supported in ITKv4 and above"
#endif
#if defined(__MWERKS__)
# error "The MetroWerks compiler is not supported in ITKv4 and above"
#endif
#if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER) && (__GNUC__ < 7)
# error "GCC < 7 is not supported under ITKv5.4"
#endif
#if defined(__sgi)
// This is true for IRIX 6.5.18m with MIPSPro 7.3.1.3m.
// TODO: At some future point, it may be necessary to
// define a minimum __sgi version that will work.
# error "The SGI compiler is not supported under ITKv4 and above"
#endif
#if defined(__APPLE__)
# if defined(__clang__) && (__cplusplus < 201703L)
# error "Apple LLVM compiling with a standard less than C++17 is not supported under ITKv5.4"
# endif
#elif defined(__clang__) && (__clang_major__ < 5)
# error "Clang < 5 is not supported under ITKv5.4"
#endif
#if defined(__INTEL_COMPILER) && (__INTEL_COMPILER < 1910)
# error "Intel C++ < 19.1 is not supported under ITKv5.4"
#endif
// Setup symbol exports
#if defined(_WIN32) || defined(WIN32)
# define ITK_ABI_IMPORT __declspec(dllimport)
# define ITK_ABI_EXPORT __declspec(dllexport)
# define ITK_ABI_HIDDEN
#else
# ifdef __GNUC__
# define ITK_ABI_IMPORT __attribute__((visibility("default")))
# define ITK_ABI_EXPORT __attribute__((visibility("default")))
# define ITK_ABI_HIDDEN __attribute__((visibility("hidden")))
# else
# define ITK_ABI_IMPORT
# define ITK_ABI_EXPORT
# define ITK_ABI_HIDDEN
# endif
#endif
// Setup symbol exports
#ifndef ITK_TEMPLATE_EXPORT
# ifdef ITK_TEMPLATE_VISIBILITY_DEFAULT
# define ITK_TEMPLATE_EXPORT __attribute__((visibility("default")))
# else
# define ITK_TEMPLATE_EXPORT
# endif
#endif
// Setup symbol exports
#ifdef ITK_TEMPLATE_VISIBILITY_DEFAULT
# define ITK_FORCE_EXPORT_MACRO(moduleName) __attribute__((visibility("default")))
#else
# define ITK_FORCE_EXPORT_MACRO(moduleName) moduleName##_EXPORT
#endif
#ifndef ITK_FORWARD_EXPORT
// If build with shared libraries, on MacOS, if USE_COMPILER_HIDDEN_VISIBILITY is ON
# if defined(__APPLE__) && defined(ITK_TEMPLATE_VISIBILITY_DEFAULT) && defined(ITK_BUILD_SHARED_LIBS) && \
defined(USE_COMPILER_HIDDEN_VISIBILITY)
# define ITK_FORWARD_EXPORT __attribute__((visibility("default")))
# else
# define ITK_FORWARD_EXPORT
# endif
#endif
//-*-*-*
// The following deprecations should be removed in ITKV6 and later
// NOTE DEPRECATED should be ITK_NOEXCEPT
#define ITK_NOEXCEPT_OR_THROW error "Replace ITK_NOEXCEPT_OR_THROW with ITK_NOEXCEPT"
// NOTE DEPRECATED! should be ITK_COMPILER_CXX_STATIC_ASSERT
#if !defined(ITK_LEGACY_REMOVE)
# define ITK_DELETE_FUNCTION = delete
#else
# define ITK_DELETE_FUNCTION error "Replace ITK_DELETE_FUNCTION with = delete"
#endif
//-*-*-*
// DEPRECATED: These macros are left here for compatibility with remote modules.
// Once they have been removed from all known remote modules, this code should
// be removed.
#if defined(ITK_FUTURE_LEGACY_REMOVE)
# define ITK_CONSTEXPR_FUNC "Replace ITK_CONSTEXPR_FUNC with constexpr"
# define ITK_CONSTEXPR_VAR "Replace ITK_CONSTEXPR_VAR with constexpr"
/** Exposes enum value as an int*/
# define itkExposeEnumValue(name) static_cast<int>(name)
// Future remove# define itkExposeEnumValue(name) "Replace type of " # name " with proper enumeration instead of
// integer."
#else
# define ITK_CONSTEXPR_FUNC constexpr
# define ITK_CONSTEXPR_VAR constexpr
/** Exposes enum value as an int*/
# define itkExposeEnumValue(name) static_cast<int>(name)
#endif
#if !defined(ITK_FUTURE_LEGACY_REMOVE)
# define ITK_FALLTHROUGH [[fallthrough]]
#else
# define ITK_FALLTHROUGH static_assert(false, "ERROR: ITK_FALLTHROUGH must be replaced with [[fallthrough]]")
#endif
/** Define two object creation methods. The first method, New(),
* creates an object from a class, potentially deferring to a factory.
* The second method, CreateAnother(), creates an object from an
* instance, potentially deferring to a factory. This second method
* allows you to create an instance of an object that is exactly the
* same type as the referring object. This is useful in cases where
* an object has been cast back to a base class.
*
* These creation methods first try asking the object factory to create
* an instance, and then default to the standard "new" operator if the
* factory fails.
*
* These routines assigns the raw pointer to a smart pointer and then call
* UnRegister() on the rawPtr to compensate for LightObject's constructor
* initializing an object's reference count to 1 (needed for proper
* initialization of process objects and data objects cycles).
*
* Break the methods into itkSimpleNewMacro and itkCreateAnotherMacro
* so we can selectively overload CreateAnother() without having to
* provide a definition for New(). */
#define itkNewMacro(x) \
itkSimpleNewMacro(x); \
itkCreateAnotherMacro(x); \
itkCloneMacro(x); \
ITK_MACROEND_NOOP_STATEMENT
#define itkSimpleNewMacro(x) \
static Pointer New() \
{ \
Pointer smartPtr = ::itk::ObjectFactory<x>::Create(); \
if (smartPtr == nullptr) \
{ \
smartPtr = new x(); \
} \
smartPtr->UnRegister(); \
return smartPtr; \
} \
ITK_MACROEND_NOOP_STATEMENT
#define itkCreateAnotherMacro(x) \
::itk::LightObject::Pointer CreateAnother() const override { return x::New().GetPointer(); } \
ITK_MACROEND_NOOP_STATEMENT
#define itkCloneMacro(x) \
Pointer Clone() const \
{ \
Pointer rval = dynamic_cast<x *>(this->InternalClone().GetPointer()); \
return rval; \
} \
ITK_MACROEND_NOOP_STATEMENT
/** Define an object creation method throwing an exception if the object
* is not created through the object factory, for use in base classes that
* do not fully implement a backend. */
#define itkFactoryOnlyNewMacro(x) \
itkSimpleFactoryOnlyNewMacro(x); \
itkCreateAnotherMacro(x); \
itkCloneMacro(x); \
ITK_MACROEND_NOOP_STATEMENT
#define itkSimpleFactoryOnlyNewMacro(x) \
static auto New()->Pointer \
{ \
Pointer smartPtr = ::itk::ObjectFactory<x>::Create(); \
if (smartPtr == nullptr) \
{ \
itkSpecializedMessageExceptionMacro(ExceptionObject, \
"Object factory failed to instantiate " << typeid(x).name()); \
} \
smartPtr->UnRegister(); \
return smartPtr; \
} \
ITK_MACROEND_NOOP_STATEMENT
/** Define two object creation methods. The first method, New(),
* creates an object from a class but does not defer to a factory.
* The second method, CreateAnother(), creates an object from an
* instance, again without deferring to a factory. This second method
* allows you to create an instance of an object that is exactly the
* same type as the referring object. This is useful in cases where
* an object has been cast back to a base class.
*
* These routines assigns the raw pointer to a smart pointer and then call
* UnRegister() on the rawPtr to compensate for LightObject's constructor
* initializing an object's reference count to 1 (needed for proper
* initialization of process objects and data objects cycles). */
#define itkFactorylessNewMacro(x) \
static Pointer New() \
{ \
x * rawPtr = new x(); \
Pointer smartPtr = rawPtr; \
rawPtr->UnRegister(); \
return smartPtr; \
} \
itkCreateAnotherMacro(x); \
ITK_MACROEND_NOOP_STATEMENT
//
// A macro to disallow the copy constructor, copy assignment,
// move constructor, and move assignment functions.
// This should be used in the public: declarations for a class
//
// ITK's paradigm for smart pointer and pipeline consistency
// prohibits the use of copy/move construction and copy/move assignment
// functions.
//
#define ITK_DISALLOW_COPY_AND_MOVE(TypeName) \
TypeName(const TypeName &) = delete; \
TypeName & operator=(const TypeName &) = delete; \
TypeName(TypeName &&) = delete; \
TypeName & operator=(TypeName &&) = delete
#if !defined(ITK_FUTURE_LEGACY_REMOVE)
# define ITK_DISALLOW_COPY_AND_ASSIGN(TypeName) ITK_DISALLOW_COPY_AND_MOVE(TypeName)
#else
# define ITK_DISALLOW_COPY_AND_ASSIGN(TypeName) \
static_assert(false, "Replace deprecated ITK_DISALLOW_COPY_AND_ASSIGN with modern ITK_DISALLOW_COPY_AND_MOVE")
#endif
// When ITK_EXPERIMENTAL_CXX20_REWRITTEN_UNEQUAL_OPERATOR is defined, ITK uses
// the ability for operator!= to be rewritten automatically in terms of
// operator==, as introduced with C++20. This macro is experimental. It may be
// modified, renamed, or removed without backward compatibility support.
#if __cplusplus >= 202002L
# define ITK_EXPERIMENTAL_CXX20_REWRITTEN_UNEQUAL_OPERATOR
#endif
// Note: The following macro, ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(TypeName),
// is only for internal use within the implementation of ITK. It may be
// modified, renamed, or removed without backward compatibility support.
#ifdef ITK_EXPERIMENTAL_CXX20_REWRITTEN_UNEQUAL_OPERATOR
// With C++20, operator!= is automatically rewritten in terms of the
// corresponding operator==.
# define ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(TypeName) ITK_MACROEND_NOOP_STATEMENT
#else
// For C++14 and C++17, this macro defines an operator!= member function that
// just calls the corresponding operator== member function.
# define ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(TypeName) \
bool operator!=(const TypeName & other) const { return !(this->operator==(other)); } \
ITK_MACROEND_NOOP_STATEMENT
#endif
// Internal macro (not part of the public ITK API), used to implement `GetNameOfClass()` member functions.
#define itkInternalGetNameOfClassImplementationMacro(thisClass) \
{ \
static_assert(std::is_same_v<thisClass, std::remove_const_t<std::remove_reference_t<decltype(*this)>>>, \
"The macro argument `" #thisClass \
"` appears incorrect! It should correspond with the name of this class!"); \
return #thisClass; \
} \
ITK_MACROEND_NOOP_STATEMENT
/** Macro's used to add `GetNameOfClass()` member functions to polymorphic ITK classes: `itkVirtualGetNameOfClassMacro`
* adds a virtual `GetNameOfClass()` member function to the class definition, and `itkOverrideGetNameOfClassMacro` adds
* a `GetNameOfClass()` override. */
#define itkVirtualGetNameOfClassMacro(thisClass) \
virtual const char * GetNameOfClass() const itkInternalGetNameOfClassImplementationMacro(thisClass)
#define itkOverrideGetNameOfClassMacro(thisClass) \
const char * GetNameOfClass() const override itkInternalGetNameOfClassImplementationMacro(thisClass)
#ifdef ITK_FUTURE_LEGACY_REMOVE
# define itkTypeMacro(thisClass, superclass) \
static_assert(false, \
"In a future revision of ITK, the macro `itkTypeMacro(thisClass, superclass)` will be removed. " \
"Please call `itkOverrideGetNameOfClassMacro(thisClass)` instead!")
# define itkTypeMacroNoParent(thisClass) \
static_assert(false, \
"In a future revision of ITK, the macro `itkTypeMacroNoParent(thisClass)` will be removed. " \
"Please call `itkVirtualGetNameOfClassMacro(thisClass)` instead!")
#else
/** Legacy macro's to add or override a `GetNameOfClass()` member function.
* \deprecated Instead of `itkTypeMacro`, it is preferred to call `itkOverrideGetNameOfClassMacro` (without `superclass`
* argument). Instead of `itkTypeMacroNoParent`, it is preferred to call `itkVirtualGetNameOfClassMacro`.
*/
# define itkTypeMacro(thisClass, superclass) itkOverrideGetNameOfClassMacro(thisClass)
# define itkTypeMacroNoParent(thisClass) itkVirtualGetNameOfClassMacro(thisClass)
#endif
namespace itk
{
/**
* The following is used to output debug, warning, and error messages.
* Use a global function which actually calls:
* OutputWindow::GetInstance()->DisplayText();
* This is to avoid Object \#include of OutputWindow
* while OutputWindow \#includes Object. */
extern ITKCommon_EXPORT void
OutputWindowDisplayText(const char *);
extern ITKCommon_EXPORT void
OutputWindowDisplayErrorText(const char *);
extern ITKCommon_EXPORT void
OutputWindowDisplayWarningText(const char *);
extern ITKCommon_EXPORT void
OutputWindowDisplayGenericOutputText(const char *);
extern ITKCommon_EXPORT void
OutputWindowDisplayDebugText(const char *);
} // end namespace itk
// The itkDebugStatement is to be used to protect code that is only used in the itkDebugMacro
/** This macro is used to print debug (or other information). They are
* also used to catch errors, etc. Requires that the caller implements
* the GetDebug() method (see itk::Object). Example usage looks like:
* itkDebugMacro("this is debug info" << this->SomeVariable); */
#if defined(NDEBUG)
# define itkDebugMacro(x) ITK_NOOP_STATEMENT
# define itkDebugStatement(x) ITK_NOOP_STATEMENT
#else
# define itkDebugMacro(x) \
do \
{ \
using namespace ::itk::print_helper; /* for ostream << std::vector<T> */ \
if (this->GetDebug() && ::itk::Object::GetGlobalWarningDisplay()) \
{ \
std::ostringstream itkmsg; \
itkmsg << "Debug: In " __FILE__ ", line " << __LINE__ << '\n' \
<< this->GetNameOfClass() << " (" << this << "): " x << "\n\n"; \
::itk::OutputWindowDisplayDebugText(itkmsg.str().c_str()); \
} \
} while (0)
// The itkDebugStatement is to be used to protect code that is only
// used in the itkDebugMacro
# define itkDebugStatement(x) x
#endif
/** This macro is used to print warning information (i.e., unusual circumstance
* but not necessarily fatal.) Example usage looks like:
* itkWarningMacro("this is warning info" << this->SomeVariable); */
#define itkWarningMacro(x) \
do \
{ \
if (::itk::Object::GetGlobalWarningDisplay()) \
{ \
std::ostringstream itkmsg; \
itkmsg << "WARNING: In " __FILE__ ", line " << __LINE__ << '\n' \
<< this->GetNameOfClass() << " (" << this << "): " x << "\n\n"; \
::itk::OutputWindowDisplayWarningText(itkmsg.str().c_str()); \
} \
} while (0)
#define itkWarningStatement(x) x
#if defined(ITK_CPP_FUNCTION)
# if defined(_WIN32) && !defined(__MINGW32__) && !defined(ITK_WRAPPING_PARSER)
# define ITK_LOCATION __FUNCSIG__
# elif defined(__GNUC__)
# define ITK_LOCATION __PRETTY_FUNCTION__
# else
# define ITK_LOCATION __FUNCTION__
# endif
#else
# define ITK_LOCATION "unknown"
#endif
#define itkDeclareExceptionMacro(newexcp, parentexcp, whatmessage) \
namespace itk \
{ \
class newexcp : public parentexcp \
{ \
public: \
/* default message provides backward compatibility for a given exception type */ \
static constexpr const char * const default_exception_message = whatmessage; \
/* Inherit the constructors from its base class. */ \
using parentexcp::parentexcp; \
itkOverrideGetNameOfClassMacro(newexcp); \
}; \
} \
ITK_MACROEND_NOOP_STATEMENT
#define itkSpecializedMessageExceptionMacro(ExceptionType, x) \
{ \
std::ostringstream exceptionDescriptionOutputStringStream; \
exceptionDescriptionOutputStringStream << "ITK ERROR: " x; \
throw ::itk::ExceptionType( \
std::string{ __FILE__ }, __LINE__, exceptionDescriptionOutputStringStream.str(), std::string{ ITK_LOCATION }); \
} \
ITK_MACROEND_NOOP_STATEMENT
#define itkSpecializedExceptionMacro(ExceptionType) \
itkSpecializedMessageExceptionMacro(ExceptionType, << ::itk::ExceptionType::default_exception_message)
/** The itkExceptionMacro macro is used to print error information (i.e., usually
* a condition that results in program failure). Example usage looks like:
* itkExceptionMacro("this is error info" << this->SomeVariable); */
#define itkExceptionMacro(x) \
itkSpecializedMessageExceptionMacro(ExceptionObject, << this->GetNameOfClass() << '(' << this << "): " x)
#define itkGenericExceptionMacro(x) itkSpecializedMessageExceptionMacro(ExceptionObject, x)
#define itkGenericOutputMacro(x) \
{ \
if (::itk::Object::GetGlobalWarningDisplay()) \
{ \
std::ostringstream itkmsg; \
itkmsg << "WARNING: In " __FILE__ ", line " << __LINE__ << "\n" x << "\n\n"; \
::itk::OutputWindowDisplayGenericOutputText(itkmsg.str().c_str()); \
} \
} \
ITK_MACROEND_NOOP_STATEMENT
//----------------------------------------------------------------------------
// Macros for simplifying the use of logging
//
#define itkLogMacro(x, y) \
{ \
if (this->GetLogger()) \
{ \
this->GetLogger()->Write(::itk::LoggerBase::x, y); \
} \
} \
ITK_MACROEND_NOOP_STATEMENT
#define itkLogMacroStatic(obj, x, y) \
{ \
if (obj->GetLogger()) \
{ \
obj->GetLogger()->Write(::itk::LoggerBase::x, y); \
} \
} \
ITK_MACROEND_NOOP_STATEMENT
//----------------------------------------------------------------------------
// Setup legacy code policy.
//
// CMake options:
// - When ITK_LEGACY_REMOVE:BOOL=ON, legacy code is hidden, thus causing compiler errors for code that depends on it
// - When ITK_LEGACY_REMOVE:BOOL=OFF, and ITK_LEGACY_SILENT:BOOL=ON, use
// of legacy code will not produce compiler warnings.
// - When ITK_LEGACY_REMOVE:BOOL=OFF, and ITK_LEGACY_SILENT:BOOL=OFF, use
// of legacy code will produce compiler warnings
//
// ITK_LEGACY_SILENT silently use legacy code. The default is to warn about legacy code use.
//
// Source files that test the legacy code may define ITK_LEGACY_TEST
// like this:
//
// #define ITK_LEGACY_TEST
// #include "itkClassWithDeprecatedMethod.h"
//
// in order to silence the warnings for calling deprecated methods.
// No other source files in ITK should call the methods since they are
// provided only for compatibility with older user code.
// Define itkLegacyMacro to mark legacy methods where they are
// declared in their class. Example usage:
//
// // \deprecated Replaced by MyOtherMethod() as of ITK 2.0.
// itkLegacyMacro(void MyMethod());
//
// See below for what to do for the method definition.
#if defined(ITK_LEGACY_REMOVE)
# define itkLegacyMacro(method) /* no ';' */
#else
# if defined(ITK_LEGACY_SILENT) || defined(ITK_LEGACY_TEST)
// Provide legacy methods with no warnings.
# define itkLegacyMacro(method) method
# else
// Request compile-time warnings for uses of deprecated methods.
# define itkLegacyMacro(method) [[deprecated]] method
# endif
#endif
// Macros to create runtime deprecation warning messages in function
// bodies. Example usage:
//
// #if !defined( ITK_LEGACY_REMOVE )
// void itkMyClass::MyOldMethod()
// {
// itkLegacyBodyMacro(itkMyClass::MyOldMethod, 2.0);
// }
//
// void itkMyClass::MyMethod()
// {
// itkLegacyReplaceBodyMacro(itkMyClass::MyMethod, 2.0,
// itkMyClass::MyOtherMethod);
// }
// #endif
//
// NOTE: These 4 macros itkLegacyBodyMacro, itkLegacyReplaceBodyMacro,
// itkGenericLegacyBodyMacro, and itkGenericLegacyReplaceBodyMacro
// are purposefully not defined when ITK_LEGACY_REMOVE is on,
// because these macros are only relevant inside code segments
// that are conditionally compiled only when ITK_LEGACY_REMOVE
// is off.
#if defined(ITK_LEGACY_SILENT)
# define itkLegacyBodyMacro(method, version) ITK_NOOP_STATEMENT
# define itkLegacyReplaceBodyMacro(method, version, replace) ITK_NOOP_STATEMENT
# define itkGenericLegacyBodyMacro(method, version) ITK_NOOP_STATEMENT
# define itkGenericLegacyReplaceBodyMacro(method, version, replace) ITK_NOOP_STATEMENT
#else
# define itkLegacyBodyMacro(method, version) \
itkWarningMacro(#method " was deprecated for ITK " #version " and will be removed in a future version.")
# define itkLegacyReplaceBodyMacro(method, version, replace) \
itkWarningMacro(#method " was deprecated for ITK " #version \
" and will be removed in a future version. Use " #replace " instead.")
# define itkGenericLegacyBodyMacro(method, version) \
itkGenericOutputMacro(#method " was deprecated for ITK " #version " and will be removed in a future version.")
# define itkGenericLegacyReplaceBodyMacro(method, version, replace) \
itkGenericOutputMacro(#method " was deprecated for ITK " #version \
" and will be removed in a future version. Use " #replace " instead.")
#endif
// Most modern x86 CPUs have 64 byte aligned blocks which are used for
// the cache lines. By aligning multi-threaded structures with the
// cache lines, false shared can be reduced, and performance
// increased.
#define ITK_CACHE_LINE_ALIGNMENT 64
//
// itkPadStruct will add padding to a structure to ensure a minimum size
// for ensuring that adjacent structures do not share CACHE lines.
// Each struct will take up some multiple of cacheline sizes.
// This is particularly useful for arrays of thread private variables.
//
#define itkPadStruct(mincachesize, oldtype, newtype) \
struct newtype : public oldtype \
{ \
char _StructPadding[mincachesize - (sizeof(oldtype) % mincachesize)]; \
};
//
// itkAlignedTypedef is a macro which creates a new type to make a
// data structure aligned.
//
#if defined(ITK_HAS_GNU_ATTRIBUTE_ALIGNED)
# define itkAlignedTypedef(alignment, oldtype, newtype) using newtype = oldtype __attribute__((aligned(alignment)))
#elif defined(_MSC_VER)
# define itkAlignedTypedef(alignment, oldtype, newtype) using newtype = __declspec(align(alignment)) oldtype
#else
# define itkAlignedTypedef(alignment, oldtype, newtype) using newtype = oldtype
#endif
#if defined(ITK_FUTURE_LEGACY_REMOVE)
//=============================================================================
/*
NOTE: DEPRECATED - This macro is not longer needed to support modern
compilers.
Define a common way of declaring a templated function as a friend inside a class.
- ITK_FRIEND_TEMPLATE_FUNCTION_ARGUMENTS(T)
The following templated function
template <T>
T add(const T & a, const T & b);
is declared as friend with
class A
{
public:
friend Self add<>( const Self & a, const Self & b );
}
*/
# define ITK_FRIEND_TEMPLATE_FUNCTION_ARGUMENT(T) < >
#else // LEGACY_REMOVE
# define ITK_FRIEND_TEMPLATE_FUNCTION_ARGUMENT(T) "Macro remove use C++11 compliant declaration of "
#endif
//--------------------------------------------------------------------------------
// Helper macros for Template Meta-Programming techniques of for-loops
// unrolling
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
// Macro that generates an unrolled for loop for assigning elements of one array
// to elements of another array The array are assumed to be of same length
// (dimension), and this is also assumed to be the value of NumberOfIterations.
// No verification of size is performed. Casting is performed as part of the
// assignment, by using the DestinationElementType as the casting type.
// Source and destination array types must have defined operator[] in their
// API.
#define itkForLoopAssignmentMacro( \
DestinationType, SourceType, DestinationElementType, DestinationArray, SourceArray, NumberOfIterations) \
for (unsigned int i = 0; i < NumberOfIterations; ++i) \
{ \
DestinationArray[i] = static_cast<DestinationElementType>(SourceArray[i]); \
}
//--------------------------------------------------------------------------------
// Macro that generates an unrolled for loop for rounding and assigning
// elements of one array to elements of another array The array are assumed to
// be of same length (dimension), and this is also assumed to be the value of
// NumberOfIterations. No verification of size is performed. Casting is
// performed as part of the assignment, by using the DestinationElementType as
// the casting type.
// Source and destination array types must have defined operator[] in their
// API.
#define itkForLoopRoundingAndAssignmentMacro( \
DestinationType, Sourcrnd_halfintup, DestinationElementType, DestinationArray, SourceArray, NumberOfIterations) \
for (unsigned int i = 0; i < NumberOfIterations; ++i) \
{ \
DestinationArray[i] = ::itk::Math::Round<DestinationElementType>(SourceArray[i]); \
}
// end of Template Meta Programming helper macros
#if !defined(NDEBUG) && !defined(ITK_WRAPPING)
# ifdef __GLIBC__
# define itkAssertInDebugOrThrowInReleaseMacro(msg) __assert_fail(msg, __FILE__, __LINE__, __ASSERT_FUNCTION);
# else
# define itkAssertInDebugOrThrowInReleaseMacro(msg) itkGenericExceptionMacro(<< msg);
# endif
#else
# define itkAssertInDebugOrThrowInReleaseMacro(msg) itkGenericExceptionMacro(<< msg);
#endif
#define itkAssertOrThrowMacro(test, message) \
if (!(test)) \
{ \
std::ostringstream msgstr; \
msgstr << message; \
itkAssertInDebugOrThrowInReleaseMacro(msgstr.str().c_str()); \
} \
ITK_MACROEND_NOOP_STATEMENT
#if !defined(NDEBUG) && !defined(ITK_WRAPPING)
# define itkAssertInDebugAndIgnoreInReleaseMacro(X) assert(X)
#else
# define itkAssertInDebugAndIgnoreInReleaseMacro(X) ITK_NOOP_STATEMENT
#endif
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
// !! The ITK Get/Set Macros for various types !!
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
#ifdef ITK_FUTURE_LEGACY_REMOVE
# define itkStaticConstMacro(name, type, value) \
"Replace itkStaticConstMacro(name, type, value) with `static constexpr type name = value`"
# define itkGetStaticConstMacro(name) "Replace itkGetStaticConstMacro(name) with `Self::name`"
#else
/** Portable definition of static constants.
*
* \pre \c type shall be an integral type (\c bool and enums are accepted as
* well). If using C++, float may be valid (see below).
*
* \warning If the compiler does not support in-class member initialization,
* the constants will be signed integers. You may observe warnings due to signed /
* unsigned comparisons.
*
* When using C++11 or greater, constexpr
* may be necessary for static const float initialization
* and is beneficial in other cases where a value can be constant.
*
* \ingroup ITKCommon */
# define itkStaticConstMacro(name, type, value) static constexpr type name = value
# define itkGetStaticConstMacro(name) (Self::name)
#endif
/** Set an input. This defines the Set"name"() method */
#define itkSetInputMacro(name, type) \
virtual void Set##name(const type * _arg) \
{ \
itkDebugMacro("setting input " #name " to " << _arg); \
if (_arg != itkDynamicCastInDebugMode<type *>(this->ProcessObject::GetInput(#name))) \
{ \
this->ProcessObject::SetInput(#name, const_cast<type *>(_arg)); \
this->Modified(); \
} \
} \
ITK_MACROEND_NOOP_STATEMENT
/** Get an input. This defines the Get"name"() method */
#define itkGetInputMacro(name, type) \
virtual const type * Get##name() const \
{ \
itkDebugMacro("returning input " << #name " of " << this->ProcessObject::GetInput(#name)); \
return itkDynamicCastInDebugMode<const type *>(this->ProcessObject::GetInput(#name)); \
} \
ITK_MACROEND_NOOP_STATEMENT
// clang-format off
/** Set a decorated input. This defines the Set"name"() and a Set"name"Input() method */
#define itkSetDecoratedInputMacro(name, type) \
virtual void Set##name##Input(const SimpleDataObjectDecorator<type> * _arg) \
{ \
itkDebugMacro("setting input " #name " to " << _arg); \
if (_arg != itkDynamicCastInDebugMode<SimpleDataObjectDecorator<type> *>(this->ProcessObject::GetInput(#name))) \
{ \
this->ProcessObject::SetInput(#name, const_cast<SimpleDataObjectDecorator<type> *>(_arg)); \
this->Modified(); \
} \
} \
virtual void Set##name(const SimpleDataObjectDecorator<type> * _arg) { this->Set##name##Input(_arg); } \
virtual void Set##name(const type & _arg) \
{ \
using DecoratorType = SimpleDataObjectDecorator<type>; \
itkDebugMacro("setting input " #name " to " << _arg); \
const DecoratorType * oldInput = \
itkDynamicCastInDebugMode<const DecoratorType *>(this->ProcessObject::GetInput(#name)); \
ITK_GCC_PRAGMA_PUSH \
ITK_GCC_SUPPRESS_Wfloat_equal \
if (oldInput && oldInput->Get() == _arg) \
{ \
return; \
} \
ITK_GCC_PRAGMA_POP \
auto newInput = DecoratorType::New(); \
newInput->Set(_arg); \
this->Set##name##Input(newInput); \
} \
ITK_MACROEND_NOOP_STATEMENT
// clang-format on
/** Set a decorated input. This defines the Set"name"() and Set"name"Input() method */
#define itkGetDecoratedInputMacro(name, type) \
virtual const SimpleDataObjectDecorator<type> * Get##name##Input() const \
{ \
itkDebugMacro("returning input " << #name " of " << this->ProcessObject::GetInput(#name)); \
return itkDynamicCastInDebugMode<const SimpleDataObjectDecorator<type> *>(this->ProcessObject::GetInput(#name)); \
} \
virtual const type & Get##name() const \
{ \
itkDebugMacro("Getting input " #name); \
using DecoratorType = SimpleDataObjectDecorator<type>; \
const DecoratorType * input = \
itkDynamicCastInDebugMode<const DecoratorType *>(this->ProcessObject::GetInput(#name)); \
if (input == nullptr) \
{ \
itkExceptionMacro("input" #name " is not set"); \
} \
return input->Get(); \
} \
ITK_MACROEND_NOOP_STATEMENT
/** Set a decorated input. This defines the Set"name"() and Set"name"Input() method
* and Get"name" and Get"name"Input methods */
#define itkSetGetDecoratedInputMacro(name, type) \
itkSetDecoratedInputMacro(name, type); \
itkGetDecoratedInputMacro(name, type)
/** Set a decorated input that derives from itk::Object, but not from
* itk::DataObject. This defines the Set"name"() and Set"name"Input
* methods.
*/
#define itkSetDecoratedObjectInputMacro(name, type) \
virtual void Set##name##Input(const DataObjectDecorator<type> * _arg) \
{ \
itkDebugMacro("setting input " #name " to " << _arg); \
if (_arg != itkDynamicCastInDebugMode<DataObjectDecorator<type> *>(this->ProcessObject::GetInput(#name))) \
{ \
this->ProcessObject::SetInput(#name, const_cast<DataObjectDecorator<type> *>(_arg)); \
this->Modified(); \
} \
} \
virtual void Set##name(const type * _arg) \
{ \
using DecoratorType = DataObjectDecorator<type>; \
itkDebugMacro("setting input " #name " to " << _arg); \
const DecoratorType * oldInput = \
itkDynamicCastInDebugMode<const DecoratorType *>(this->ProcessObject::GetInput(#name)); \
if (oldInput && oldInput->Get() == _arg) \
{ \
return; \
} \
auto newInput = DecoratorType::New(); \
newInput->Set(_arg); \
this->Set##name##Input(newInput); \
} \
ITK_MACROEND_NOOP_STATEMENT
/** Get a decorated input that derives from itk::Object, but not from
* itk::DataObject. This defines the Get"name"() and Get"name"Input
* methods.
*/
#define itkGetDecoratedObjectInputMacro(name, type) \
virtual const DataObjectDecorator<type> * Get##name##Input() const \
{ \
itkDebugMacro("returning input " << #name " of " << this->ProcessObject::GetInput(#name)); \
return itkDynamicCastInDebugMode<const DataObjectDecorator<type> *>(this->ProcessObject::GetInput(#name)); \
} \
virtual const type * Get##name() const \
{ \
itkDebugMacro("Getting input " #name); \
using DecoratorType = DataObjectDecorator<type>; \
const DecoratorType * input = \
itkDynamicCastInDebugMode<const DecoratorType *>(this->ProcessObject::GetInput(#name)); \
if (input == nullptr) \
{ \
return nullptr; \
} \
return input->Get(); \
} \
ITK_MACROEND_NOOP_STATEMENT
/** Set a decorated input. This defines the Set"name"() and Set"name"Input() method
* and Get"name" and Get"name"Input methods */
#define itkSetGetDecoratedObjectInputMacro(name, type) \
itkSetDecoratedObjectInputMacro(name, type); \
itkGetDecoratedObjectInputMacro(name, type)
/** Set built-in type or regular C++ type. Creates member Set"name"() (e.g., SetVisibility()); */
// clang-format off
#define itkSetMacro(name, type) \
virtual void Set##name(type _arg) \
{ \
itkDebugMacro("setting " #name " to " << _arg); \
ITK_GCC_PRAGMA_PUSH \
ITK_GCC_SUPPRESS_Wfloat_equal \
if (this->m_##name != _arg) \
{ \