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
|
/****************************************************************************
**
** 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 "utils_global.h"
#include "optional.h"
#include "outputformat.h"
#include <QObject>
QT_BEGIN_NAMESPACE
class QPlainTextEdit;
class QTextCharFormat;
class QTextCursor;
QT_END_NAMESPACE
namespace Utils {
class FormattedText;
namespace Internal { class OutputFormatterPrivate; }
class QTCREATOR_UTILS_EXPORT AggregatingOutputFormatter;
class QTCREATOR_UTILS_EXPORT OutputFormatter : public QObject
{
friend class AggregatingOutputFormatter;
public:
OutputFormatter();
~OutputFormatter() override;
QPlainTextEdit *plainTextEdit() const;
void setPlainTextEdit(QPlainTextEdit *plainText);
void flush();
void appendMessage(const QString &text, OutputFormat format);
virtual bool handleLink(const QString &href);
void clear();
void setBoldFontEnabled(bool enabled);
// For unit testing only
void overrideTextCharFormat(const QTextCharFormat &fmt);
protected:
QTextCharFormat charFormat(OutputFormat format) const;
static QTextCharFormat linkFormat(const QTextCharFormat &inputFormat, const QString &href);
enum class Status { Done, InProgress, NotHandled };
class LinkSpec {
public:
LinkSpec() = default;
LinkSpec(int sp, int l, const QString &t) : startPos(sp), length(l), target(t) {}
int startPos = -1;
int length = -1;
QString target;
};
using LinkSpecs = QList<LinkSpec>;
class Result {
public:
Result(Status s, const LinkSpecs &l = {}, const optional<QString> &c = {})
: status(s), linkSpecs(l), newContent(c) {}
Status status;
LinkSpecs linkSpecs;
optional<QString> newContent; // Hard content override. Only to be used in extreme cases.
};
private:
// text contains at most one line feed character, and if it does occur, it's the last character.
// Either way, the input is to be considered "complete" for formatting purposes.
void doAppendMessage(const QString &text, OutputFormat format);
virtual Result handleMessage(const QString &text, OutputFormat format);
virtual void reset() {}
void append(const QString &text, const QTextCharFormat &format);
void initFormats();
void flushIncompleteLine();
void dumpIncompleteLine(const QString &line, OutputFormat format);
void clearLastLine();
QList<FormattedText> parseAnsi(const QString &text, const QTextCharFormat &format);
const QList<Utils::FormattedText> linkifiedText(const QList<FormattedText> &text,
const LinkSpecs &linkSpecs);
Internal::OutputFormatterPrivate *d;
};
class QTCREATOR_UTILS_EXPORT AggregatingOutputFormatter : public OutputFormatter
{
public:
AggregatingOutputFormatter();
~AggregatingOutputFormatter();
void setFormatters(const QList<OutputFormatter *> &formatters);
bool handleLink(const QString &href) override;
private:
Result handleMessage(const QString &text, OutputFormat format) override;
class Private;
Private * const d;
};
} // namespace Utils
|
