1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkOutputWindow.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkOutputWindow
* @brief base class for writing debug output to a console
*
* This class is used to encapsulate all text output, so that it will work
* with operating systems that have a stdout and stderr, and ones that
* do not. (i.e windows does not). Sub-classes can be provided which can
* redirect the output to a window.
*/
#ifndef vtkOutputWindow_h
#define vtkOutputWindow_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDebugLeaksManager.h" // Must be included before singletons
#include "vtkDeprecation.h" // For `VTK_DEPRECATED_IN_9_3_0`
#include "vtkObject.h"
VTK_ABI_NAMESPACE_BEGIN
class VTK_DEPRECATED_IN_9_3_0(
"`vtkOutputWindowCleanup` is no longer necessary") VTKCOMMONCORE_EXPORT vtkOutputWindowCleanup
{
public:
vtkOutputWindowCleanup() = default;
~vtkOutputWindowCleanup() = default;
private:
vtkOutputWindowCleanup(const vtkOutputWindowCleanup& other) = delete;
vtkOutputWindowCleanup& operator=(const vtkOutputWindowCleanup& rhs) = delete;
};
class vtkOutputWindowPrivateAccessor;
class VTKCOMMONCORE_EXPORT vtkOutputWindow : public vtkObject
{
public:
// Methods from vtkObject
vtkTypeMacro(vtkOutputWindow, vtkObject);
/**
* Print ObjectFactor to stream.
*/
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Creates a new instance of vtkOutputWindow. Note this *will* create a new
* instance using the vtkObjectFactory. If you want to access the global
* instance, use `GetInstance` instead.
*/
static vtkOutputWindow* New();
/**
* Return the singleton instance with no reference counting.
*/
static vtkOutputWindow* GetInstance();
/**
* Supply a user defined output window. Call ->Delete() on the supplied
* instance after setting it.
*/
static void SetInstance(vtkOutputWindow* instance);
///@{
/**
* Display the text. Four virtual methods exist, depending on the type of
* message to display. This allows redirection or reformatting of the
* messages. The default implementation uses DisplayText for all.
* Consequently, subclasses can simply override DisplayText and use
* `GetCurrentMessageType` to determine the type of message that's being reported.
*/
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*);
///@}
///@{
/**
* If PromptUser is set to true then each time a line of text
* is displayed, the user is asked if they want to keep getting
* messages.
*
* Note that PromptUser has not effect of messages displayed by directly
* calling `DisplayText`. The prompt is never shown for such messages.
*
*/
vtkBooleanMacro(PromptUser, bool);
vtkSetMacro(PromptUser, bool);
///@}
///@{
/**
* Flag indicates how the vtkOutputWindow handles displaying of text to
* `stderr` / `stdout`. Default is `DEFAULT` except in
* `vtkWin32OutputWindow` where on non dashboard runs, the default is
* `NEVER`.
*
* `NEVER` indicates that the messages should never be forwarded to the
* standard output/error streams.
*
* `ALWAYS` will result in error/warning/debug messages being posted to the
* standard error stream, while text messages to standard output stream.
*
* `ALWAYS_STDERR` will result in all messages being posted to the standard
* error stream (this was default behavior in VTK 8.1 and earlier).
*
* `DEFAULT` is similar to `ALWAYS` except when logging is enabled. If
* logging is enabled, messages posted to the output window using VTK error/warning macros such as
* `vtkErrorMacro`, `vtkWarningMacro` etc. will not posted on any of the output streams. This is
* done to avoid duplicate messages on these streams since these macros also result in add items
* to the log.
*
* @note vtkStringOutputWindow does not result this flag as is never forwards
* any text to the output streams.
*/
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
};
/**
* Returns the current message type. Useful in subclasses that simply want to
* override `DisplayText` and also know what type of message is being
* processed.
*/
vtkGetMacro(CurrentMessageType, MessageTypes);
enum class StreamType
{
Null,
StdOutput,
StdError,
};
/**
* Returns the standard output stream to post the message of the given type
* on.
*/
virtual StreamType GetDisplayStream(MessageTypes msgType) const;
bool PromptUser;
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;
private:
vtkOutputWindow(const vtkOutputWindow&) = delete;
void operator=(const vtkOutputWindow&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
