itkIndent.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#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>
 
namespace itk
{
 
class ITKCommon_EXPORT Indent
{
public:
  using Self = Indent;
 
#ifndef ITK_LEGACY_REMOVE
  // [[deprecated]] rather than itkLegacyMacro, which would require itkMacro.h.
  [[deprecated]] static Self *
  New();

  [[deprecated]] void
  Delete()
  {
    delete this;
  }
#endif

  Indent(int ind = 0)
    : m_Indent(ind)
  {}

  static const char *
  GetNameOfClass()
  {
    return "Indent";
  }

  [[nodiscard]] Indent
  GetNextIndent() const;

  friend ITKCommon_EXPORT std::ostream &
                          operator<<(std::ostream & os, const Indent & ind);
 
private:
  int m_Indent;
};
} // end namespace itk
 
// Tested by itkPrintHelper.h to detect the include cycle described above.
#define itkIndent_h_complete
 
#endif