vtkOutputWindow.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkOutputWindow_h
#define vtkOutputWindow_h

#include "vtkCommonCoreModule.h"  // For export macro
#include "vtkDebugLeaksManager.h" // Must be included before singletons
#include "vtkObject.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkOutputWindowPrivateAccessor;
class VTKCOMMONCORE_EXPORT vtkOutputWindow : public vtkObject
{
public:
  // Methods from vtkObject
  vtkTypeMacro(vtkOutputWindow, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkOutputWindow* New();

  static vtkOutputWindow* GetInstance();
  static void SetInstance(vtkOutputWindow* instance);


  virtual void DisplayText(const char*);
  virtual void DisplayErrorText(const char*);
  virtual void DisplayWarningText(const char*);
  virtual void DisplayGenericWarningText(const char*);
  virtual void DisplayDebugText(const char*);


  vtkBooleanMacro(PromptUser, bool);
  vtkSetMacro(PromptUser, bool);


  vtkBooleanMacro(ShowWindow, bool);
  vtkSetMacro(ShowWindow, bool);


  enum DisplayModes
  {
    DEFAULT = -1,
    NEVER = 0,
    ALWAYS = 1,
    ALWAYS_STDERR = 2
  };
  vtkSetClampMacro(DisplayMode, int, DEFAULT, ALWAYS_STDERR);
  vtkGetMacro(DisplayMode, int);
  void SetDisplayModeToDefault() { this->SetDisplayMode(vtkOutputWindow::DEFAULT); }
  void SetDisplayModeToNever() { this->SetDisplayMode(vtkOutputWindow::NEVER); }
  void SetDisplayModeToAlways() { this->SetDisplayMode(vtkOutputWindow::ALWAYS); }
  void SetDisplayModeToAlwaysStdErr() { this->SetDisplayMode(vtkOutputWindow::ALWAYS_STDERR); }
protected:
  vtkOutputWindow();
  ~vtkOutputWindow() override;

  enum MessageTypes
  {
    MESSAGE_TYPE_TEXT,
    MESSAGE_TYPE_ERROR,
    MESSAGE_TYPE_WARNING,
    MESSAGE_TYPE_GENERIC_WARNING,
    MESSAGE_TYPE_DEBUG
  };

  vtkGetMacro(CurrentMessageType, MessageTypes);

  enum class StreamType
  {
    Null,
    StdOutput,
    StdError,
  };

  virtual StreamType GetDisplayStream(MessageTypes msgType) const;

  bool PromptUser;
  bool ShowWindow = true;

private:
  std::atomic<MessageTypes> CurrentMessageType;
  int DisplayMode;
  std::atomic<int> InStandardMacros; // used to suppress display to output streams from standard
                                     // macros when logging is enabled.

  friend class vtkOutputWindowPrivateAccessor;

  vtkOutputWindow(const vtkOutputWindow&) = delete;
  void operator=(const vtkOutputWindow&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif