forked from qt-creator/qt-creator
bbde6ac9bf
Change-Id: Ie8c5fac09b45a54bcbe9a876044b653e7fccede5 Reviewed-by: Orgad Shaneh <orgads@gmail.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
126 lines
4.1 KiB
C++
126 lines
4.1 KiB
C++
/****************************************************************************
|
|
**
|
|
** 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 CommandLine;
|
|
class FilePath;
|
|
} // Utils
|
|
|
|
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;
|
|
QString displayName() const override;
|
|
|
|
int priorityInStatusBar() const override;
|
|
|
|
void clearContents() 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 Utils::FilePath &workingDir,
|
|
const Utils::CommandLine &command);
|
|
|
|
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 Utils::FilePath &workingDirectory,
|
|
const Utils::CommandLine &command);
|
|
|
|
// 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
|