Skip to content

COMP: Restore itkIndent.h without itkMacro.h and fail loudly on the include cycle #7028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hjmjohnson merged 1 commit into from
Oct 29, 2026
Merged

COMP: Restore itkIndent.h without itkMacro.h and fail loudly on the include cycle #7028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions Modules/Core/Common/include/itkIndent.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@
#ifndef itkIndent_h
#define itkIndent_h

// itkMacro.h includes itkPrintHelper.h, which includes this header: never include itkMacro.h here.
#include "ITKCommonExport.h"
#include "itkConfigure.h" // ITK_LEGACY_REMOVE

#include <iostream>

Expand All @@ -54,15 +56,18 @@ class ITKCommon_EXPORT Indent
using Self = Indent;

#ifndef ITK_LEGACY_REMOVE
// [[deprecated]] rather than itkLegacyMacro, which would require itkMacro.h.
/** Method for creation.
\deprecated Instead of calling `New()`, please simply create an indent by directly constructing the object. Indent is
default-constructible, so it can be allocated on the stack. */
itkLegacyMacro(static Self * New();)
[[deprecated]] static Self *
New();

/** Destroy this instance.
\deprecated Instead of calling `Delete()`, please use the C++ pattern RAII ("Resource Acquisition Is
Initialization"). */
itkLegacyMacro(void Delete())
[[deprecated]] void
Delete()
{
delete this;
}
Expand Down Expand Up @@ -94,4 +99,7 @@ class ITKCommon_EXPORT Indent
};
} // end namespace itk

// Tested by itkPrintHelper.h to detect the include cycle described above.
#define itkIndent_h_complete

#endif
3 changes: 3 additions & 0 deletions Modules/Core/Common/include/itkPrintHelper.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@

#include "itkMacro.h"
#include "itkIndent.h"
#ifndef itkIndent_h_complete
Comment thread
dzenanz marked this conversation as resolved.
Resolved
# error "itk::Indent incomplete: itkIndent.h must not include itkMacro.h (keep ITKCommonExport.h, itkConfigure.h)"
#endif

#include <array>
#include <iostream>
Expand Down
2 changes: 2 additions & 0 deletions Modules/Core/Common/test/itkPrintHelperGTest.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
*
*=========================================================================*/

// itkIndent.h first on purpose: it must compile before itkMacro.h is seen (issue #7025).
#include "itkIndent.h"
#include "itkPrintHelper.h"
#include "itkOffset.h"
#include "gtest/gtest.h"
Expand Down
Loading