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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/* $Id: UIRichTextString.cpp $ */
/** @file
* VBox Qt GUI - UIRichTextString class implementation.
*/
/*
* Copyright (C) 2015-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
/* Qt includes: */
#include <QApplication>
#include <QPalette>
#include <QRegExp>
/* GUI includes: */
#include "UIRichTextString.h"
/* Other VBox includes: */
#include "iprt/assert.h"
const QString UIRichTextString::s_strAny = QString("[\\s\\S]*");
const QMap<UIRichTextString::Type, QString> UIRichTextString::s_patterns = populatePatterns();
const QMap<UIRichTextString::Type, bool> UIRichTextString::s_doPatternHasMeta = populatePatternHasMeta();
UIRichTextString::UIRichTextString(Type enmType /* = Type_None */)
: m_enmType(enmType)
, m_strString(QString())
, m_strStringMeta(QString())
{
}
UIRichTextString::UIRichTextString(const QString &strString, Type enmType /* = Type_None */, const QString &strStringMeta /* = QString() */)
: m_enmType(enmType)
, m_strString(strString)
, m_strStringMeta(strStringMeta)
{
//printf("Creating new UIRichTextString with string=\"%s\" and string-meta=\"%s\"\n",
// m_strString.toUtf8().constData(), m_strStringMeta.toUtf8().constData());
parse();
}
UIRichTextString::~UIRichTextString()
{
/* Erase the map: */
qDeleteAll(m_strings.begin(), m_strings.end());
m_strings.clear();
}
QString UIRichTextString::toString() const
{
/* Add own string first: */
QString strString = m_strString;
/* Add all the strings of children finally: */
foreach (const int &iPosition, m_strings.keys())
strString.insert(iPosition, m_strings.value(iPosition)->toString());
/* Return result: */
return strString;
}
QVector<QTextLayout::FormatRange> UIRichTextString::formatRanges(int iShift /* = 0 */) const
{
/* Prepare format range list: */
QVector<QTextLayout::FormatRange> ranges;
/* Add own format range first: */
QTextLayout::FormatRange range;
range.start = iShift;
range.length = toString().size();
range.format = textCharFormat(m_enmType);
/* Enable anchor if present: */
if (!m_strAnchor.isNull())
{
range.format.setAnchorHref(m_strAnchor);
/* Highlight anchor if hovered: */
if (range.format.anchorHref() == m_strHoveredAnchor)
range.format.setForeground(qApp->palette().color(QPalette::Link));
}
ranges.append(range);
/* Add all the format ranges of children finally: */
foreach (const int &iPosition, m_strings.keys())
ranges.append(m_strings.value(iPosition)->formatRanges(iShift + iPosition));
/* Return result: */
return ranges;
}
void UIRichTextString::setHoveredAnchor(const QString &strHoveredAnchor)
{
/* Define own hovered anchor first: */
m_strHoveredAnchor = strHoveredAnchor;
/* Propagate hovered anchor to children finally: */
foreach (const int &iPosition, m_strings.keys())
m_strings.value(iPosition)->setHoveredAnchor(m_strHoveredAnchor);
}
void UIRichTextString::parse()
{
/* Assign the meta to anchor directly for now,
* will do a separate parsing when there will
* be more than one type of meta: */
if (!m_strStringMeta.isNull())
m_strAnchor = m_strStringMeta;
/* Parse the passed QString with all the known patterns: */
foreach (const Type &enmPattern, s_patterns.keys())
{
/* Get the current pattern: */
const QString strPattern = s_patterns.value(enmPattern);
/* Recursively parse the string: */
int iMaxLevel = 0;
do
{
/* Search for the maximum level of the current pattern: */
iMaxLevel = searchForMaxLevel(m_strString, strPattern, strPattern);
//printf(" Maximum level for the pattern \"%s\" is %d.\n",
// strPattern.toUtf8().constData(), iMaxLevel);
/* If current pattern of at least level 1 is found: */
if (iMaxLevel > 0)
{
/* Compose full pattern of the corresponding level: */
const QString strFullPattern = composeFullPattern(strPattern, strPattern, iMaxLevel);
//printf(" Full pattern: %s\n", strFullPattern.toUtf8().constData());
QRegExp regExp(strFullPattern);
regExp.setMinimal(true);
const int iPosition = regExp.indexIn(m_strString);
AssertReturnVoid(iPosition != -1);
if (iPosition != -1)
{
/* Cut the found string: */
m_strString.remove(iPosition, regExp.cap(0).size());
/* And paste that string as our child: */
const bool fPatterHasMeta = s_doPatternHasMeta.value(enmPattern);
const QString strSubString = !fPatterHasMeta ? regExp.cap(1) : regExp.cap(2);
const QString strSubMeta = !fPatterHasMeta ? QString() : regExp.cap(1);
m_strings.insert(iPosition, new UIRichTextString(strSubString, enmPattern, strSubMeta));
}
}
}
while (iMaxLevel > 0);
}
}
/* static */
QMap<UIRichTextString::Type, QString> UIRichTextString::populatePatterns()
{
QMap<Type, QString> patterns;
patterns.insert(Type_Anchor, QString("<a href=([^>]+)>(%1)</a>"));
patterns.insert(Type_Bold, QString("<b>(%1)</b>"));
patterns.insert(Type_Italic, QString("<i>(%1)</i>"));
return patterns;
}
/* static */
QMap<UIRichTextString::Type, bool> UIRichTextString::populatePatternHasMeta()
{
QMap<Type, bool> patternHasMeta;
patternHasMeta.insert(Type_Anchor, true);
patternHasMeta.insert(Type_Bold, false);
patternHasMeta.insert(Type_Italic, false);
return patternHasMeta;
}
/* static */
int UIRichTextString::searchForMaxLevel(const QString &strString, const QString &strPattern,
const QString &strCurrentPattern, int iCurrentLevel /* = 0 */)
{
QRegExp regExp(strCurrentPattern.arg(s_strAny));
regExp.setMinimal(true);
if (regExp.indexIn(strString) != -1)
return searchForMaxLevel(strString, strPattern,
strCurrentPattern.arg(s_strAny + strPattern + s_strAny),
iCurrentLevel + 1);
return iCurrentLevel;
}
/* static */
QString UIRichTextString::composeFullPattern(const QString &strPattern,
const QString &strCurrentPattern, int iCurrentLevel)
{
if (iCurrentLevel > 1)
return composeFullPattern(strPattern,
strCurrentPattern.arg(s_strAny + strPattern + s_strAny),
iCurrentLevel - 1);
return strCurrentPattern.arg(s_strAny);
}
/* static */
QTextCharFormat UIRichTextString::textCharFormat(Type enmType)
{
QTextCharFormat format;
switch (enmType)
{
case Type_Anchor:
{
format.setAnchor(true);
break;
}
case Type_Bold:
{
QFont font = format.font();
font.setBold(true);
format.setFont(font);
break;
}
case Type_Italic:
{
QFont font = format.font();
font.setItalic(true);
format.setFont(font);
break;
}
case Type_None: break; /* Shut up MSC */
}
return format;
}
|
