ENH: Use a macro to print boolean objects

[jhlegarreta]

Use a macro to print boolean objects. Avoids boilerplate code.

Appearances of the form:

os << indent << "{name}: " << (m_{name} ? "On" : "Off") << std::endl;

and

os << indent << "{name}: " << (this->m_{name} ? "On" : "Off") << std::endl;

are substituted by `itkPrintBooleanMacro({name});. The cases where the
statement is broken into multiple lines were also considered.

Add the script used to perform automatically the substitution.

PR Checklist

• No API changes were made (or the changes have been approved)
• No major design changes were made (or the changes have been approved)

[dzenanz]

Of course, the instances should be found and replaced 😄

[jhlegarreta]

The expression
os << indent << "(.*): " << \(m_([a-zA-z]+) \? "On" : "Off"\)((\r\n|\r|\n).*| )<< std::endl;\n
works correctly in https://regex101.com/ to capture the relevant variable names in

  os << indent << "ForwardAzimuthElevationToPhysical: " << (m_ForwardAzimuthElevationToPhysical ? "On" : "Off")
     << std::endl;
  os << indent << "Minimize: " << (m_Minimize ? "On" : "Off") << std::endl;

But I cannot figure out how to get the multi-line case using sed or perl:
https://github.com/InsightSoftwareConsortium/ITK/blob/7b29032604fb04ce1b8107b260b71825007d1d60/Utilities/Maintenance/ReplaceBooleanPrintMacro.sh

This one works for both cases without capturing works:

perl -0777 -pe 's/os << indent << "ForwardAzimuthElevationToPhysical: " << \(m_ForwardAzimuthElevationToPhysical \? "On" : "Off"\)((\r\n|\r|\n).*| )<< std::endl;/replacetext/g' input.txt

But then again I cannot figure out how to capture the variable names into groups.

I could fix the multi-line ones manually, but I prefer to have a solution. Suggestions on the regex are welcome.

Edit: OK, this seems to work for both cases:

perl -0777 -pe 's/os << indent << "(.*): " << \(m_([a-zA-z]+) \? "On" : "Off"\)((\r\n|\r|\n).*| )<< std::endl;/itkPrintBooleanMacro\(\2\);/g' input.txt

Will use it in the script and see what happens when applying to the code.

[hjmjohnson]

@jhlegarreta Is this ready to be pushed forward ?

[jhlegarreta]

@hjmjohnson Will give it a try over the weekend.

[jhlegarreta]

@hjmjohnson @seanm After all the no-op, semicolon, etc. discussions and changes lately, before I make the changes, is the macro correctly defined as is now?
https://github.com/InsightSoftwareConsortium/ITK/pull/3908/files#diff-635df68290f802f4b0b60c34e44e1c4b57dfc0c623a6c29efd9919624d31e399R1276

Is the ending semicolon after the macro correct in?
https://github.com/InsightSoftwareConsortium/ITK/pull/3908/files#diff-35939c01a094d5166fd7dd2dfc6ed059ec0e6f7184b3c0100ccbb2b7cbf80182R38

[jhlegarreta]

@hjmjohnson I have the script working locally, tested on an example file. Please have a look at the questions in #3908 (comment) so that I can make the appropriate changes to the macro and the replacement statement if needed. Once those made, and #4763 merged, I will run the script and force push.

[jhlegarreta]

Went on and made the changes. If CIs come green this is ready to go.

[jhlegarreta]

Well, I included the file where the macro definition dwells just in case:
https://github.com/InsightSoftwareConsortium/ITK/pull/3908/files#diff-60c38f29d2b7fdf51351001d8746684f22860e7eda2a7efea0405c6d0445bbc5R35

But it does not solve the issue:
https://open.cdash.org/viewBuildError.php?buildid=9734250

Both ivars are declared in itkProcessObject.h. Also I do not understand why this does not happen for all the rest of *.hxx/*.cxx files or in the appearances of itkPrintSelfObjectMacro. The definition of the macro should be replaced when the code is compiled, so the names of the identifiers should be changed to m_{name} in the statements and the compiler should not complain as far as I understand.