ENH: Adding a deprecation mechanism to gdcm via two MACRO and two config options

[gdcm.git] / src / gdcmDebug.h

diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h
index 5f834ce192c8373a0fe8d7c96b14320020bc932e..85eda8b3cae08ec08fdc3d24982d99946ff3af16 100644 (file)
--- a/src/gdcmDebug.h
+++ b/src/gdcmDebug.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.h,v $
   Language:  C++
-  Date:      $Date: 2005/06/21 14:05:06 $
-  Version:   $Revision: 1.35 $
+  Date:      $Date: 2005/07/19 14:43:48 $
+  Version:   $Revision: 1.36 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -190,4 +190,52 @@ public:
 }
 #endif //NDEBUG
 
+//-----------------------------------------------------------------------------
+//
+// Define GDCM_LEGACY macro to mark legacy methods where they are
+// declared in their class.  Example usage:
+//
+//   // @deprecated Replaced by MyOtherMethod() as of gdcm 2.0.
+//   GDCM_LEGACY(void MyMethod());
+#if defined(GDCM_LEGACY_REMOVE)
+  // Remove legacy methods completely.
+# define GDCM_LEGACY(method)
+#elif defined(GDCM_LEGACY_SILENT)
+  // Provide legacy methods with no warnings.
+# define GDCM_LEGACY(method) method
+#else
+  // Setup compile-time warnings for uses of deprecated methods if
+  // possible on this compiler.
+# if defined(__GNUC__) && !defined(__INTEL_COMPILER) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
+#  define GDCM_LEGACY(method) method __attribute__((deprecated))
+# elif defined(_MSC_VER) && _MSC_VER >= 1300
+#  define GDCM_LEGACY(method) __declspec(deprecated) method
+# else
+#  define GDCM_LEGACY(method) method
+# endif
+#endif
+
+// Macros to create runtime deprecation warning messages in function
+// bodies.  Example usage:
+//
+//   void MyClass::MyOldMethod()
+//   {
+//     GDCM_LEGACY_BODY(MyClass::MyOldMethod, 2.0);
+//   }
+//
+//   void MyClass::MyMethod()
+//   {
+//     GDCM_LEGACY_REPLACED_BODY(MyClass::MyMethod, 5.0,
+//                               MyClass::MyOtherMethod);
+//   }
+#if defined(GDCM_LEGACY_REMOVE) || defined(GDCM_LEGACY_SILENT)
+# define GDCM_LEGACY_BODY(method, version)
+# define GDCM_LEGACY_REPLACED_BODY(method, version, replace)
+#else
+# define GDCM_LEGACY_BODY(method, version) \
+  gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version.")
+# define GDCM_LEGACY_REPLACED_BODY(method, version, replace) \
+  gdcmWarningMacro(#method " was deprecated for gdcm" #version " and will be removed in a future version.  Use " #replace " instead.")
+#endif
+
 #endif