style(itk-wasm): Add itkVirtualGetNameOfClassMacro + itkOverrideGetNameOfClassMacro

hjmjohnson · hjmjohnson · commit 626feddf56f3 · 2025-03-13T15:02:18.000-05:00
Added two new macro's, intended to replace the old 'itkTypeMacro' and 'itkTypeMacroNoParent'. The main aim is to be clearer about what those macro's do: add a virtual 'GetNameOfClass()' member function and override it. Unlike 'itkTypeMacro', 'itkOverrideGetNameOfClassMacro' does not have a 'superclass' parameter, as it was not used anyway. Note that originally 'itkTypeMacro' did not use its 'superclass' parameter either, looking at commit 699b66cb04d410e555656828e8892107add38ccb, Will Schroeder, June 27, 2001: https://github.com/InsightSoftwareConsortium/ITK/blob/699b66cb04d410e555656828e8892107add38ccb/Code/Common/itkMacro.h#L331-L337
diff --git a/include/itkImageToWasmImageFilter.h b/include/itkImageToWasmImageFilter.h
@@ -45,7 +45,7 @@ class ITK_TEMPLATE_EXPORT ImageToWasmImageFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(ImageToWasmImageFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(ImageToWasmImageFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkImportVectorImageFilter.h b/include/itkImportVectorImageFilter.h
@@ -64,7 +64,7 @@ class ITK_TEMPLATE_EXPORT ImportVectorImageFilter : public ImageSource<TOutputIm
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(ImportVectorImageFilter, ImageSource);
+  itkOverrideGetNameOfClassMacro(ImportVectorImageFilter);
 
   /** Index type alias support An index is used to access pixel values. */
   using IndexType = Index<OutputImageType::ImageDimension>;
diff --git a/include/itkMeshToWasmMeshFilter.h b/include/itkMeshToWasmMeshFilter.h
@@ -47,7 +47,7 @@ class ITK_TEMPLATE_EXPORT MeshToWasmMeshFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(MeshToWasmMeshFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(MeshToWasmMeshFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkPointSetToWasmPointSetFilter.h b/include/itkPointSetToWasmPointSetFilter.h
@@ -45,7 +45,7 @@ class ITK_TEMPLATE_EXPORT PointSetToWasmPointSetFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(PointSetToWasmPointSetFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(PointSetToWasmPointSetFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkPolyDataToWasmPolyDataFilter.h b/include/itkPolyDataToWasmPolyDataFilter.h
@@ -45,7 +45,7 @@ class ITK_TEMPLATE_EXPORT PolyDataToWasmPolyDataFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(PolyDataToWasmPolyDataFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(PolyDataToWasmPolyDataFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkTransformToWasmTransformFilter.h b/include/itkTransformToWasmTransformFilter.h
@@ -47,7 +47,7 @@ class ITK_TEMPLATE_EXPORT TransformToWasmTransformFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(TransformToWasmTransformFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(TransformToWasmTransformFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkWasmDataObject.h b/include/itkWasmDataObject.h
@@ -43,7 +43,7 @@ class WebAssemblyInterface_EXPORT WasmDataObject : public DataObject
   using Pointer = SmartPointer<Self>;
   using ConstPointer = SmartPointer<const Self>;
   itkNewMacro(Self);
-  itkTypeMacro(WasmDataObject, DataObject);
+  itkOverrideGetNameOfClassMacro(WasmDataObject);
 
   /** Get/Set the DataObject JSON representation. */
   itkSetStringMacro(JSON);
diff --git a/include/itkWasmImage.h b/include/itkWasmImage.h
@@ -51,7 +51,7 @@ class ITK_TEMPLATE_EXPORT WasmImage : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmImage, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmImage);
 
   using ImageType = TImage;
 
diff --git a/include/itkWasmImageIO.h b/include/itkWasmImageIO.h
@@ -51,7 +51,7 @@ class WebAssemblyInterface_EXPORT WasmImageIO: public StreamingImageIOBase
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmImageIO, StreamingImageIOBase);
+  itkOverrideGetNameOfClassMacro(WasmImageIO);
 
   /** The different types of ImageIO's can support data of varying
    * dimensionality. For example, some file formats are strictly 2D
diff --git a/include/itkWasmImageIOFactory.h b/include/itkWasmImageIOFactory.h
@@ -48,7 +48,7 @@ class WebAssemblyInterface_EXPORT WasmImageIOFactory: public ObjectFactoryBase
   itkFactorylessNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmImageIOFactory, ObjectFactoryBase);
+  itkOverrideGetNameOfClassMacro(WasmImageIOFactory);
 
   /** Register one factory of this type  */
   static void RegisterOneFactory(void)
diff --git a/include/itkWasmImageToImageFilter.h b/include/itkWasmImageToImageFilter.h
@@ -47,7 +47,7 @@ class ITK_TEMPLATE_EXPORT WasmImageToImageFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmImageToImageFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(WasmImageToImageFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkWasmMesh.h b/include/itkWasmMesh.h
@@ -53,7 +53,7 @@ class ITK_TEMPLATE_EXPORT WasmMesh : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmMesh, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmMesh);
 
   using MeshType = TMesh;
 
diff --git a/include/itkWasmMeshIO.h b/include/itkWasmMeshIO.h
@@ -53,7 +53,7 @@ class WebAssemblyInterface_EXPORT WasmMeshIO: public MeshIOBase
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmMeshIO, MeshIOBase);
+  itkOverrideGetNameOfClassMacro(WasmMeshIO);
 
   bool CanReadFile(const char *) override;
 
diff --git a/include/itkWasmMeshIOFactory.h b/include/itkWasmMeshIOFactory.h
@@ -48,7 +48,7 @@ class WebAssemblyInterface_EXPORT WasmMeshIOFactory: public ObjectFactoryBase
   itkFactorylessNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmMeshIOFactory, ObjectFactoryBase);
+  itkOverrideGetNameOfClassMacro(WasmMeshIOFactory);
 
   /** Register one factory of this type  */
   static void RegisterOneFactory()
diff --git a/include/itkWasmMeshToMeshFilter.h b/include/itkWasmMeshToMeshFilter.h
@@ -47,7 +47,7 @@ class ITK_TEMPLATE_EXPORT WasmMeshToMeshFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmMeshToMeshFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(WasmMeshToMeshFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkWasmPointSet.h b/include/itkWasmPointSet.h
@@ -50,7 +50,7 @@ class ITK_TEMPLATE_EXPORT WasmPointSet : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmPointSet, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmPointSet);
 
   using PointSetType = TPointSet;
 
diff --git a/include/itkWasmPointSetToPointSetFilter.h b/include/itkWasmPointSetToPointSetFilter.h
@@ -47,7 +47,7 @@ class ITK_TEMPLATE_EXPORT WasmPointSetToPointSetFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmPointSetToPointSetFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(WasmPointSetToPointSetFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkWasmPolyData.h b/include/itkWasmPolyData.h
@@ -55,7 +55,7 @@ class ITK_TEMPLATE_EXPORT WasmPolyData : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmPolyData, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmPolyData);
 
   using PolyDataType = TPolyData;
 
diff --git a/include/itkWasmPolyDataToPolyDataFilter.h b/include/itkWasmPolyDataToPolyDataFilter.h
@@ -47,7 +47,7 @@ class ITK_TEMPLATE_EXPORT WasmPolyDataToPolyDataFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmPolyDataToPolyDataFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(WasmPolyDataToPolyDataFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/include/itkWasmStringStream.h b/include/itkWasmStringStream.h
@@ -63,7 +63,7 @@ class WebAssemblyInterface_EXPORT WasmStringStream : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmStringStream, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmStringStream);
 
   void SetString(const std::string & string) {
     this->m_StringStream.str(string);
diff --git a/include/itkWasmTransform.h b/include/itkWasmTransform.h
@@ -57,7 +57,7 @@ class ITK_TEMPLATE_EXPORT WasmTransform : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmTransform, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmTransform);
 
   using TransformType = TTransform;
   using DecoratorType = DataObjectDecorator<TransformType>;
diff --git a/include/itkWasmTransformIO.h b/include/itkWasmTransformIO.h
@@ -62,7 +62,7 @@ class ITK_TEMPLATE_EXPORT WasmTransformIOTemplate : public TransformIOBaseTempla
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmTransformIOTemplate, TransformIOBaseTemplate);
+  itkOverrideGetNameOfClassMacro(WasmTransformIOTemplate);
 
   /** Reads the data from disk into the memory buffer provided. */
   void
diff --git a/include/itkWasmTransformIOFactory.h b/include/itkWasmTransformIOFactory.h
@@ -50,7 +50,7 @@ class WebAssemblyInterface_EXPORT WasmTransformIOFactory : public ObjectFactoryB
   itkFactorylessNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmTransformIOFactory, ObjectFactoryBase);
+  itkOverrideGetNameOfClassMacro(WasmTransformIOFactory);
 
   /** Register one factory of this type  */
   static void
diff --git a/include/itkWasmTransformToTransformFilter.h b/include/itkWasmTransformToTransformFilter.h
@@ -48,7 +48,7 @@ class ITK_TEMPLATE_EXPORT WasmTransformToTransformFilter : public ProcessObject
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmTransformToTransformFilter, ProcessObject);
+  itkOverrideGetNameOfClassMacro(WasmTransformToTransformFilter);
 
   using DataObjectIdentifierType = Superclass::DataObjectIdentifierType;
   using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType;
diff --git a/packages/dicom/gdcm/read-image-dicom-file-series.cxx b/packages/dicom/gdcm/read-image-dicom-file-series.cxx
@@ -63,7 +63,7 @@ class ITK_TEMPLATE_EXPORT QuickDICOMImageSeriesReader : public ImageSeriesReader
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(QuickDICOMImageSeriesReader, ImageSeriesReader);
+  itkOverrideGetNameOfClassMacro(QuickDICOMImageSeriesReader);
 
   /** The size of the output image. */
   using SizeType = typename TOutputImage::SizeType;
diff --git a/packages/image-io/itkWasmImageIOBase.h b/packages/image-io/itkWasmImageIOBase.h
@@ -53,7 +53,7 @@ class WebAssemblyInterface_EXPORT WasmImageIOBase : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmImageIOBase, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmImageIOBase);
 
   using DirectionContainerType = VectorContainer<SizeValueType, double>;
   using PixelDataContainerType = VectorContainer<SizeValueType, char>;
diff --git a/packages/image-io/itkWasmZstdImageIO.h b/packages/image-io/itkWasmZstdImageIO.h
@@ -50,7 +50,7 @@ class WebAssemblyInterface_EXPORT WasmZstdImageIO: public WasmImageIO
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmZstdImageIO, WasmImageIO);
+  itkOverrideGetNameOfClassMacro(WasmZstdImageIO);
 
   /** Determine the file type. Returns true if this ImageIO can read the
    * file specified. */
diff --git a/packages/mesh-io/itkWasmMeshIOBase.h b/packages/mesh-io/itkWasmMeshIOBase.h
@@ -55,7 +55,7 @@ class WebAssemblyInterface_EXPORT WasmMeshIOBase : public WasmPointSetIOBase
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmMeshIOBase, WasmPointSetIOBase);
+  itkOverrideGetNameOfClassMacro(WasmMeshIOBase);
 
   using DataContainerType = Superclass::DataContainerType;
 
diff --git a/packages/mesh-io/itkWasmPointSetIOBase.h b/packages/mesh-io/itkWasmPointSetIOBase.h
@@ -53,7 +53,7 @@ class WebAssemblyInterface_EXPORT WasmPointSetIOBase : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmPointSetIOBase, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmPointSetIOBase);
 
   using DataContainerType = VectorContainer<SizeValueType, char>;
 
diff --git a/packages/mesh-io/itkWasmZstdMeshIO.h b/packages/mesh-io/itkWasmZstdMeshIO.h
@@ -50,7 +50,7 @@ class WebAssemblyInterface_EXPORT WasmZstdMeshIO: public WasmMeshIO
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmZstdMeshIO, WasmMeshIO);
+  itkOverrideGetNameOfClassMacro(WasmZstdMeshIO);
 
   /** Determine the file type. Returns true if this MeshIO can read the
    * file specified. */
diff --git a/packages/transform-io/itkWasmTransformIOBase.h b/packages/transform-io/itkWasmTransformIOBase.h
@@ -67,7 +67,7 @@ class WebAssemblyInterface_EXPORT WasmTransformIOBase : public WasmDataObject
 
   itkNewMacro(Self);
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmTransformIOBase, WasmDataObject);
+  itkOverrideGetNameOfClassMacro(WasmTransformIOBase);
 
   void SetTransformIO(TransformIOBaseType * transformIO, bool readTransform = true)
   {
diff --git a/packages/transform-io/itkWasmZstdTransformIO.h b/packages/transform-io/itkWasmZstdTransformIO.h
@@ -52,7 +52,7 @@ class ITK_TEMPLATE_EXPORT WasmZstdTransformIOTemplate: public WasmTransformIOTem
   itkNewMacro(Self);
 
   /** Run-time type information (and related methods). */
-  itkTypeMacro(WasmZstdTransformIOTemplate, WasmTransformIOTemplate);
+  itkOverrideGetNameOfClassMacro(WasmZstdTransformIOTemplate);
 
   /** Determine the file type. Returns true if this TransformIO can read the
    * file specified. */
