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
192
193
194
195
196
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "messagemanager.h"
#include "messageoutputwindow.h"
#include <extensionsystem/pluginmanager.h>
#include <utils/qtcassert.h>
#include <QFont>
#include <QThread>
#include <QTime>
/*!
\class Core::MessageManager
\inheaderfile coreplugin/messagemanager.h
\ingroup mainclasses
\inmodule QtCreator
\brief The MessageManager class is used to post messages in the
\uicontrol{General Messages} pane.
*/
namespace Core {
static MessageManager *m_instance = nullptr;
static Internal::MessageOutputWindow *m_messageOutputWindow = nullptr;
/*!
\internal
*/
MessageManager *MessageManager::instance()
{
return m_instance;
}
enum class Flag { Silent, Flash, Disrupt };
static void showOutputPane(Flag flags)
{
QTC_ASSERT(m_messageOutputWindow, return);
switch (flags) {
case Core::Flag::Silent:
break;
case Core::Flag::Flash:
m_messageOutputWindow->flash();
break;
case Core::Flag::Disrupt:
m_messageOutputWindow->popup(IOutputPane::ModeSwitch | IOutputPane::WithFocus);
break;
}
}
static void doWrite(const QString &text, Flag flags)
{
QTC_ASSERT(m_messageOutputWindow, return);
showOutputPane(flags);
m_messageOutputWindow->append(text + '\n');
}
static void write(const QString &text, Flag flags)
{
QTC_ASSERT(m_instance, return);
if (QThread::currentThread() == m_instance->thread())
doWrite(text, flags);
else
QMetaObject::invokeMethod(m_instance, [text, flags] {
doWrite(text, flags);
}, Qt::QueuedConnection);
}
/*!
\internal
*/
MessageManager::MessageManager()
{
m_instance = this;
m_messageOutputWindow = nullptr;
}
/*!
\internal
*/
MessageManager::~MessageManager()
{
if (m_messageOutputWindow) {
ExtensionSystem::PluginManager::removeObject(m_messageOutputWindow);
delete m_messageOutputWindow;
}
m_instance = nullptr;
}
/*!
\internal
*/
void MessageManager::init()
{
m_messageOutputWindow = new Internal::MessageOutputWindow;
ExtensionSystem::PluginManager::addObject(m_messageOutputWindow);
}
/*!
\internal
*/
void MessageManager::setFont(const QFont &font)
{
QTC_ASSERT(m_messageOutputWindow, return);
m_messageOutputWindow->setFont(font);
}
/*!
\internal
*/
void MessageManager::setWheelZoomEnabled(bool enabled)
{
QTC_ASSERT(m_messageOutputWindow, return);
m_messageOutputWindow->setWheelZoomEnabled(enabled);
}
/*!
Writes the \a message to the \uicontrol{General Messages} pane without
any further action.
This is the preferred method of posting messages, since it does not
interrupt the user.
\sa writeFlashing()
\sa writeDisrupting()
*/
void MessageManager::writeSilently(const QString &message)
{
Core::write(message, Flag::Silent);
}
/*!
Writes the \a message to the \uicontrol{General Messages} pane and flashes
the output pane button.
This notifies the user that something important has happened that might
require the user's attention. Use sparingly, since continually flashing the
button is annoying, especially if the condition is something the user might
not be able to fix.
\sa writeSilently()
\sa writeDisrupting()
*/
void MessageManager::writeFlashing(const QString &message)
{
Core::write(message, Flag::Flash);
}
/*!
Writes the \a message to the \uicontrol{General Messages} pane and brings
the pane to the front.
This might interrupt a user's workflow, so only use this as a direct
response to something a user did, like explicitly running a tool.
\sa writeSilently()
\sa writeFlashing()
*/
void MessageManager::writeDisrupting(const QString &message)
{
Core::write(message, Flag::Disrupt);
}
/*!
\overload writeSilently()
*/
void MessageManager::writeSilently(const QStringList &messages)
{
writeSilently(messages.join('\n'));
}
/*!
\overload writeFlashing()
*/
void MessageManager::writeFlashing(const QStringList &messages)
{
writeFlashing(messages.join('\n'));
}
/*!
\overload writeDisrupting()
*/
void MessageManager::writeDisrupting(const QStringList &messages)
{
writeDisrupting(messages.join('\n'));
}
} // namespace Core
|
