itkOutputWindow.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 itkOutputWindow_h
#define itkOutputWindow_h
 
#include <atomic>
#include <mutex>
#include "itkObject.h"
 
namespace itk
{
 
struct OutputWindowGlobals;

class ITKCommon_EXPORT OutputWindow : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(OutputWindow);

  using Self = OutputWindow;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(OutputWindow);

  static Pointer
  New();

  static Pointer
  GetInstance();

  static void
  SetInstance(OutputWindow * instance);

  virtual void
  DisplayText(const char *);

  virtual void
  DisplayErrorText(const char * t)
  {
    this->DisplayText(t);
  }

  virtual void
  DisplayWarningText(const char * t)
  {
    this->DisplayText(t);
  }

  virtual void
  DisplayGenericOutputText(const char * t)
  {
    this->DisplayText(t);
  }

  virtual void
  DisplayDebugText(const char * t)
  {
    this->DisplayText(t);
  }

  virtual void
  DisplayDebugText(const char * file,
                   unsigned int line,
                   const char * className,
                   const void * objectAddress,
                   const char * message);

  virtual void
  DisplayWarningText(const char * file,
                     unsigned int line,
                     const char * className,
                     const void * objectAddress,
                     const char * message);

  virtual void
  DisplayErrorText(const char * file,
                   unsigned int line,
                   const char * className,
                   const void * objectAddress,
                   const char * message);
 

  virtual void
  DisplayGenericOutputText(const char * file, unsigned int line, const char * message);

  itkSetMacro(PromptUser, bool);
  itkGetConstMacro(PromptUser, bool);
  itkBooleanMacro(PromptUser);
protected:
  OutputWindow();
  ~OutputWindow() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  itkGetGlobalDeclarationMacro(OutputWindowGlobals, PimplGlobals);
 
  std::atomic<bool>            m_PromptUser{};
  std::mutex                   m_cerrMutex{};
  static OutputWindowGlobals * m_PimplGlobals;
};
} // end namespace itk
 
#endif