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
|
/*
SPDX-FileCopyrightText: 2016 Pino Toscano <pino@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "grantleeformatter.h"
#include "docentry.h"
#include "glossary.h"
#include "khc_debug.h"
#include <KTextTemplate/Context>
#include <KTextTemplate/Engine>
#include <KTextTemplate/Template>
#include <KTextTemplate/TemplateLoader>
#include <KLocalizedString>
#include <QStandardPaths>
using namespace KHC;
class PlainOutputStream : public KTextTemplate::OutputStream
{
public:
explicit PlainOutputStream(QTextStream *stream)
: KTextTemplate::OutputStream(stream)
{
}
QString escape(const QString &input) const override
{
return input;
}
QSharedPointer<OutputStream> clone(QTextStream *stream) const override
{
return QSharedPointer<OutputStream>(new PlainOutputStream(stream));
}
};
struct GrantleeFormatter::Private {
QString format(KTextTemplate::Template t, KTextTemplate::Context *ctx);
KTextTemplate::Engine engine;
};
QString GrantleeFormatter::Private::format(KTextTemplate::Template t, KTextTemplate::Context *ctx)
{
QString result;
QTextStream textStream(&result);
PlainOutputStream stream(&textStream);
t->render(&stream, ctx);
if (t->error()) {
qCWarning(KHC_LOG) << "GrantleeFormatter rendering error:" << t->errorString();
}
return result;
}
GrantleeFormatter::GrantleeFormatter()
: d(new Private)
{
QSharedPointer<KTextTemplate::FileSystemTemplateLoader> loader(new KTextTemplate::FileSystemTemplateLoader);
loader->setTemplateDirs(QStandardPaths::locateAll(QStandardPaths::AppDataLocation, QStringLiteral("templates"), QStandardPaths::LocateDirectory));
d->engine.addTemplateLoader(loader);
}
GrantleeFormatter::~GrantleeFormatter()
{
delete d;
}
QString GrantleeFormatter::formatOverview(const QString &title, const QString &name, const QString &content)
{
KTextTemplate::Template t = d->engine.loadByName(QStringLiteral("index.html"));
KTextTemplate::Context ctx;
ctx.insert(QStringLiteral("title"), title);
ctx.insert(QStringLiteral("name"), name);
ctx.insert(QStringLiteral("content"), content);
return d->format(t, &ctx);
}
QString GrantleeFormatter::formatGlossaryEntry(const GlossaryEntry &entry)
{
KTextTemplate::Template t = d->engine.loadByName(QStringLiteral("glossary.html"));
KTextTemplate::Context ctx;
const GlossaryEntryXRef::List entrySeeAlso = entry.seeAlso();
QStringList seeAlso;
seeAlso.reserve(entrySeeAlso.count());
for (const GlossaryEntryXRef &xref : entrySeeAlso) {
seeAlso += QStringLiteral("<a href=\"glossentry:%1\">%2</a>").arg(xref.id(), xref.term());
}
ctx.insert(QStringLiteral("htmltitle"), i18nc("%1 is a glossary term", "KDE Glossary: %1", entry.term()));
ctx.insert(QStringLiteral("title"), i18n("KDE Glossary"));
ctx.insert(QStringLiteral("term"), entry.term());
ctx.insert(QStringLiteral("definition"), entry.definition());
ctx.insert(QStringLiteral("seeAlsoCount"), seeAlso.count());
ctx.insert(QStringLiteral("seeAlso"), i18n("See also: %1", seeAlso.join(QLatin1String(", "))));
return d->format(t, &ctx);
}
QString GrantleeFormatter::formatSearchResults(const QString &words, const QList<QPair<DocEntry *, QString>> &results)
{
KTextTemplate::Template t = d->engine.loadByName(QStringLiteral("search.html"));
KTextTemplate::Context ctx;
typedef QPair<DocEntry *, QString> Iter;
QVariantList list;
list.reserve(results.count());
for (const Iter &it : results) {
QVariantHash h;
h.insert(QStringLiteral("title"), it.first->name());
h.insert(QStringLiteral("content"), it.second);
list += h;
}
ctx.insert(QStringLiteral("htmltitle"), i18n("Search Results"));
ctx.insert(QStringLiteral("title"), i18n("Search Results for '%1':", words.toHtmlEscaped()));
ctx.insert(QStringLiteral("results"), list);
return d->format(t, &ctx);
}
|
