COMP: Avoid "message" naming conflicts when calling an exception macro

Replaced the very general term "message" inside the definition of `itkSpecializedMessageExceptionMacro` by a much more specific identifier, "exceptionDescriptionOutputStringStream", to avoid naming conflicts in user code. Removed the unnecessary `std::string{ ... }` construction for the result of `std::ostringstream::str()`, as it is an `std::string` already.
InsightSoftwareConsortium · Mar 15, 2021 · 3d35e43 · 3d35e43
1 parent 396c2a1
commit 3d35e43
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/Modules/Core/Common/include/itkMacro.h b/Modules/Core/Common/include/itkMacro.h
@@ -510,10 +510,10 @@ OutputWindowDisplayDebugText(const char *);
 
 #define itkSpecializedMessageExceptionMacro(ExceptionType, x)                                                          \
   {                                                                                                                    \
-    std::ostringstream message;                                                                                        \
-    message << "ITK ERROR: " x;                                                                                        \
+    std::ostringstream exceptionDescriptionOutputStringStream;                                                         \
+    exceptionDescriptionOutputStringStream << "ITK ERROR: " x;                                                         \
     throw ::itk::ExceptionType(                                                                                        \
-      std::string{ __FILE__ }, __LINE__, std::string{ message.str() }, std::string{ ITK_LOCATION });                   \
+      std::string{ __FILE__ }, __LINE__, exceptionDescriptionOutputStringStream.str(), std::string{ ITK_LOCATION });   \
   }                                                                                                                    \
   ITK_MACROEND_NOOP_STATEMENT
 

diff --git a/Modules/Core/Common/test/itkExceptionObjectGTest.cxx b/Modules/Core/Common/test/itkExceptionObjectGTest.cxx
@@ -41,26 +41,26 @@ TEST(ExceptionObject, TestDescriptionFromExceptionMacro)
     itkTypeMacroNoParent(TestClass);
 
     void
-    CallExceptionMacro(const std::string & testMessage) const
+    CallExceptionMacro(const std::string & message) const
     {
-      itkExceptionMacro(<< testMessage);
+      itkExceptionMacro(<< message);
     }
   };
 
-  const std::string testMessage = "test message";
+  const std::string message = "test message";
   const TestClass   testObject{};
 
   try
   {
-    testObject.CallExceptionMacro(testMessage);
+    testObject.CallExceptionMacro(message);
   }
   catch (const itk::ExceptionObject & exceptionObject)
   {
     const char * const actualDescription = exceptionObject.GetDescription();
     ASSERT_NE(actualDescription, nullptr);
 
     std::ostringstream expectedDescription;
-    expectedDescription << "ITK ERROR: " << testObject.GetNameOfClass() << "(" << &testObject << "): " << testMessage;
+    expectedDescription << "ITK ERROR: " << testObject.GetNameOfClass() << "(" << &testObject << "): " << message;
 
     EXPECT_EQ(actualDescription, expectedDescription.str());
   }