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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include "vcsbase_global.h"
#include <coreplugin/ioutputpane.h>
namespace Utils { class FileName; }
namespace VcsBase {
namespace Internal { class VcsPlugin; }
class VCSBASE_EXPORT VcsOutputWindow : public Core::IOutputPane
{
Q_OBJECT
Q_PROPERTY(QString repository READ repository WRITE setRepository)
public:
QWidget *outputWidget(QWidget *parent) override;
QList<QWidget *> toolBarWidgets() const override;
QString displayName() const override;
int priorityInStatusBar() const override;
void clearContents() override;
void visibilityChanged(bool visible) override;
void setFocus() override;
bool hasFocus() const override;
bool canFocus() const override;
bool canNavigate() const override;
bool canNext() const override;
bool canPrevious() const override;
void goToNext() override;
void goToPrev() override;
static VcsOutputWindow *instance();
QString repository() const;
// Helper to consistently format log entries for commands as
// 'Executing <dir>: <cmd> <args>'. Hides well-known password option
// arguments.
static QString msgExecutionLogEntry(const QString &workingDir,
const Utils::FileName &executable,
const QStringList &arguments);
enum MessageStyle {
None,
Error, // Red error text
Warning, // Dark yellow warning text
Command, // A bold command with timestamp "10:00 " + "Executing: vcs -diff"
Message, // A blue message text (e.g. "command has finished successfully")
};
public slots:
static void setRepository(const QString &);
static void clearRepository();
// Set the whole text.
static void setText(const QString &text);
// Set text from QProcess' output data using the Locale's converter.
static void setData(const QByteArray &data);
// Append text with a certain style (none by default),
// and maybe pop up (silent by default)
static void append(const QString &text, MessageStyle style = None, bool silently = false);
// Silently append text, do not pop up.
static void appendSilently(const QString &text);
// Append red error text and pop up.
static void appendError(const QString &text);
// Append dark-yellow warning text and pop up.
static void appendWarning(const QString &text);
// Append a command, prepended by a log time stamp. "Executing: vcs -diff"
// will result in "10:00 Executing: vcs -diff" in bold
// Filter passwords from URLs while doing this.
static void appendShellCommandLine(const QString &text);
// Append a standard-formatted entry for command execution
// (see msgExecutionLogEntry).
static void appendCommand(const QString &workingDirectory,
const Utils::FileName &binary,
const QStringList &args);
// Append a blue message text and pop up.
static void appendMessage(const QString &text);
private:
friend class Internal::VcsPlugin;
static void destroy();
VcsOutputWindow();
~VcsOutputWindow() override;
};
} // namespace VcsBase
|
