blob: 8af7671fb809d4c080b11a72b01bb4973248368f (
plain)
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
|
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#ifndef RSTFORMAT_H
#define RSTFORMAT_H
#include <textstream.h>
#include <QtCore/QByteArray>
#include <QtCore/QString>
#include <QtCore/QTextStream>
#include <QtCore/QVersionNumber>
struct rstVersionAdded
{
explicit rstVersionAdded(const QVersionNumber &v) : m_version(v) {}
const QVersionNumber m_version;
};
inline TextStream &operator<<(TextStream &s, const rstVersionAdded &v)
{
s << ".. versionadded:: "<< v.m_version.toString() << "\n\n";
return s;
}
inline QByteArray rstDeprecationNote(const char *what)
{
return QByteArrayLiteral(".. note:: This ")
+ what + QByteArrayLiteral(" is deprecated.\n\n");
}
template <class String>
inline int writeEscapedRstText(TextStream &str, const String &s)
{
int escaped = 0;
for (const QChar &c : s) {
switch (c.unicode()) {
case '*':
case '`':
case '_':
case '\\':
str << '\\';
++escaped;
break;
}
str << c;
}
return s.size() + escaped;
}
class escape
{
public:
explicit escape(QStringView s) : m_string(s) {}
void write(TextStream &str) const { writeEscapedRstText(str, m_string); }
private:
const QStringView m_string;
};
inline TextStream &operator<<(TextStream &str, const escape &e)
{
e.write(str);
return str;
}
// RST anchor string: Anything else but letters, numbers, '_' or '.' replaced by '-'
inline bool isValidRstLabelChar(QChar c)
{
return c.isLetterOrNumber() || c == u'_' || c == u'.';
}
inline QString toRstLabel(QString s)
{
for (int i = 0, size = s.size(); i < size; ++i) {
if (!isValidRstLabelChar(s.at(i)))
s[i] = u'-';
}
return s;
}
class rstLabel
{
public:
explicit rstLabel(const QString &l) : m_label(l) {}
friend TextStream &operator<<(TextStream &str, const rstLabel &a)
{
str << ".. _" << toRstLabel(a.m_label) << ":\n\n";
return str;
}
private:
const QString &m_label;
};
#endif // RSTFORMAT_H
|
