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
|
/* This file is part of KDevelop
Copyright 2018 Anton Anikin <anton@anikin.xyz>
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; either
version 2 of the License, or (at your option) any later version.
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; see the file COPYING. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include "utils.h"
// KDevPlatform
#include <interfaces/icore.h>
#include <interfaces/iproject.h>
#include <interfaces/iprojectcontroller.h>
// KF
#include <KLocalizedString>
// Qt
#include <QFile>
#include <QRegularExpression>
#include <QVector>
namespace Clazy
{
QString prettyPathName(const QUrl& path)
{
return KDevelop::ICore::self()->projectController()->prettyFileName(path, KDevelop::IProjectController::FormatPlain);
}
// Very simple Markdown parser/converter. Does not provide full Markdown language support and
// was tested only with Clazy documentation.
class MarkdownConverter
{
public:
MarkdownConverter()
{
tagStart.resize(STATE_COUNT);
tagEnd.resize(STATE_COUNT);
tagStart[EMPTY].clear();
tagEnd [EMPTY].clear();
tagStart[HEADING] = QStringLiteral("<b>");
tagEnd [HEADING] = QStringLiteral("</b>");
tagStart[PARAGRAPH] = QStringLiteral("<p>");
tagEnd [PARAGRAPH] = QStringLiteral("</p>");
tagStart[PREFORMATTED] = QStringLiteral("<pre>");
tagEnd [PREFORMATTED] = QStringLiteral("</pre>");
tagStart[LIST] = QStringLiteral("<ul><li>");
tagEnd [LIST] = QStringLiteral("</li></ul>");
}
~MarkdownConverter() = default;
QString toHtml(const QString& markdown)
{
const QRegularExpression hRE(QStringLiteral("(#+) (.+)"));
QRegularExpressionMatch match;
state = EMPTY;
html.clear();
html += QStringLiteral("<html>");
const auto lines = markdown.split(QLatin1Char('\n'));
for (auto line : lines) {
if (line.isEmpty()) {
setState(EMPTY);
continue;
}
if (line.startsWith(QLatin1Char('#'))) {
auto match = hRE.match(line);
if (match.hasMatch()) {
setState(HEADING);
html += match.captured(2);
setState(EMPTY);
if (match.capturedRef(1).size() == 1) {
html += QStringLiteral("<hr>");
}
}
continue;
}
if (line.startsWith(QLatin1String("```"))) {
setState((state == PREFORMATTED) ? EMPTY : PREFORMATTED);
continue;
}
if (line.startsWith(QLatin1String(" "))) {
if (state == EMPTY) {
setState(PREFORMATTED);
}
} else if (
line.startsWith(QLatin1String("- ")) ||
line.startsWith(QLatin1String("* "))) {
// force close and reopen list - this fixes cases when we don't have
// separator line between items
setState(EMPTY);
setState(LIST);
line.remove(0, 2);
}
if (state == EMPTY) {
setState(PARAGRAPH);
}
processLine(line);
}
setState(EMPTY);
html += QStringLiteral("</html>");
return html.join(QLatin1Char('\n'));
}
private:
enum STATE {
EMPTY,
HEADING,
PARAGRAPH,
PREFORMATTED,
LIST,
STATE_COUNT
};
void setState(int newState)
{
if (state == newState) {
return;
}
if (state != EMPTY) {
html += tagEnd[state];
}
if (newState != EMPTY) {
html += tagStart[newState];
}
state = newState;
}
void processLine(QString& line)
{
static const QRegularExpression ttRE(QStringLiteral("`([^`]+)`"));
static const QRegularExpression bdRE(QStringLiteral("\\*\\*([^\\*]+)\\*\\*"));
static const QRegularExpression itRE(QStringLiteral("[^\\*]\\*([^\\*]+)\\*[^\\*]"));
static auto applyRE = [](const QRegularExpression& re, QString& line, const QString& tag) {
auto i = re.globalMatch(line);
while (i.hasNext()) {
auto match = i.next();
line.replace(match.captured(0), QStringLiteral("<%1>%2</%1>").arg(tag, match.captured(1)));
}
};
if (state != PREFORMATTED) {
line.replace(QLatin1Char('&'), QLatin1String("&"));
line.replace(QLatin1Char('<'), QLatin1String("<"));
line.replace(QLatin1Char('>'), QLatin1String(">"));
line.replace(QLatin1Char('\"'), QLatin1String("""));
line.replace(QLatin1Char('\''), QLatin1String("'"));
applyRE(ttRE, line, QStringLiteral("tt"));
applyRE(bdRE, line, QStringLiteral("b"));
applyRE(itRE, line, QStringLiteral("i"));
}
html += line;
}
private:
int state;
QVector<QString> tagStart;
QVector<QString> tagEnd;
QStringList html;
};
QString markdown2html(const QByteArray& markdown)
{
MarkdownConverter converter;
return converter.toHtml(QString::fromUtf8(markdown));
}
}
|
