BUG: Use GDCM as private dependency in ITKIOGDCM

Make the third partly library a private dependency, for the ITK GDCM ImageIO modules. This follows best practices of data encapsulation. Move the implementation of the destructor to the cxx file as a best practice as it ensure intonation of the vtable in the library.
InsightSoftwareConsortium · Apr 14, 2020 · ca1913c · ca1913c
1 parent a476fa9
commit ca1913c
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 9 deletions.
diff --git a/Modules/IO/GDCM/ITKKWStyleOverwrite.txt b/Modules/IO/GDCM/ITKKWStyleOverwrite.txt
@@ -0,0 +1 @@
+itkGDCMSeriesFileNames\.h Namespace Disable
diff --git a/Modules/IO/GDCM/include/itkGDCMSeriesFileNames.h b/Modules/IO/GDCM/include/itkGDCMSeriesFileNames.h
@@ -22,9 +22,14 @@
 #include "itkObjectFactory.h"
 #include "itkMacro.h"
 #include <vector>
-#include "gdcmSerieHelper.h"
 #include "ITKIOGDCMExport.h"
 
+// forward declaration, to remove compile dependency on GDCM library
+namespace gdcm
+{
+class SerieHelper;
+}
+
 namespace itk
 {
 /**
@@ -162,10 +167,7 @@ class ITKIOGDCM_EXPORT GDCMSeriesFileNames : public ProcessObject
    * \warning User need to set SetUseSeriesDetails(true)
    */
   void
-  AddSeriesRestriction(const std::string & tag)
-  {
-    m_SerieHelper->AddRestriction(tag);
-  }
+  AddSeriesRestriction(const std::string & tag);
 
   /** Parse any sequences in the DICOM file. Defaults to false
    *  to skip sequences. This makes loading DICOM files faster when
@@ -184,8 +186,8 @@ class ITKIOGDCM_EXPORT GDCMSeriesFileNames : public ProcessObject
   itkBooleanMacro(LoadPrivateTags);
 
 protected:
-  GDCMSeriesFileNames() = default;
-  ~GDCMSeriesFileNames() override { delete m_SerieHelper; }
+  GDCMSeriesFileNames();
+  ~GDCMSeriesFileNames() override;
   void
   PrintSelf(std::ostream & os, Indent indent) const override;
 
@@ -201,7 +203,7 @@ class ITKIOGDCM_EXPORT GDCMSeriesFileNames : public ProcessObject
   FileNamesContainerType m_OutputFileNames;
 
   /** Internal structure to order serie from one directory */
-  gdcm::SerieHelper * m_SerieHelper = new gdcm::SerieHelper();
+  std::unique_ptr<gdcm::SerieHelper> m_SerieHelper;
 
   /** Internal structure to keep the list of series UIDs */
   SeriesUIDContainerType m_SeriesUIDs;

diff --git a/Modules/IO/GDCM/itk-module.cmake b/Modules/IO/GDCM/itk-module.cmake
@@ -6,8 +6,9 @@ itk_module(ITKIOGDCM
   ENABLE_SHARED
   DEPENDS
     ITKCommon
-    ITKGDCM
     ITKIOImageBase
+  PRIVATE_DEPENDS
+    ITKGDCM
   TEST_DEPENDS
     ITKTestKernel
     ITKGDCM

diff --git a/Modules/IO/GDCM/src/itkGDCMSeriesFileNames.cxx b/Modules/IO/GDCM/src/itkGDCMSeriesFileNames.cxx
@@ -21,9 +21,19 @@
 #include "itkGDCMSeriesFileNames.h"
 #include "itksys/SystemTools.hxx"
 #include "itkProgressReporter.h"
+#include "gdcmSerieHelper.h"
 
 namespace itk
 {
+
+
+GDCMSeriesFileNames::GDCMSeriesFileNames()
+  : m_SerieHelper{ new gdcm::SerieHelper() }
+{}
+
+GDCMSeriesFileNames::~GDCMSeriesFileNames() = default;
+
+
 void
 GDCMSeriesFileNames::SetInputDirectory(const char * name)
 {
@@ -35,6 +45,12 @@ GDCMSeriesFileNames::SetInputDirectory(const char * name)
   this->SetInputDirectory(fname);
 }
 
+void
+GDCMSeriesFileNames::AddSeriesRestriction(const std::string & tag)
+{
+  m_SerieHelper->AddRestriction(tag);
+}
+
 void
 GDCMSeriesFileNames::SetInputDirectory(std::string const & name)
 {