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
|
// 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 TEXTSTREAM_H
#define TEXTSTREAM_H
#include <QtCore/QTextStream>
#include <QtCore/QString>
/// A text stream based on QTextStream with built-in indent.
class TextStream
{
public:
Q_DISABLE_COPY_MOVE(TextStream)
using ManipulatorFunc = void(TextStream &);
enum class Language
{
None, Cpp
};
enum class CharClass
{
Other, NewLine, Space, Hash, BackSlash
};
explicit TextStream(QIODevice *device, Language l = Language::None);
explicit TextStream(QString *string, Language l = Language::None);
explicit TextStream(QByteArray *array, Language l = Language::None);
virtual ~TextStream();
Language language() const { return m_language; }
void setLanguage(const Language &language) { m_language = language; }
bool isIndentationEnabled() const { return m_indentationEnabled; }
void setIndentationEnabled(bool m)
{ m_indentationEnabled = m; }
int tabWidth() const { return m_tabWidth; }
void setTabWidth(int tabWidth) { m_tabWidth = tabWidth; }
void setFieldWidth(int f) { m_str.setFieldWidth(f); }
int fieldWidth() const { return m_str.fieldWidth(); }
int indentation() const { return m_indentation; }
void setIndentation(int i);
void indent(int n = 1) { m_indentation += n; }
void outdent(int n = 1);
// QTextStream API
qint64 pos() const;
QTextStream::FieldAlignment fieldAlignment() const
{ return m_str.fieldAlignment(); }
void setFieldAlignment(QTextStream::FieldAlignment al)
{ m_str.setFieldAlignment(al); }
void setString(QString *string, QIODeviceBase::OpenMode openMode = QIODeviceBase::ReadWrite);
QString *string() const { return m_str.string(); }
void flush() { m_str.flush(); }
void setDevice(QIODevice *device) { m_str.setDevice(device); }
QIODevice *device() const { return m_str.device(); }
QTextStream &textStream() { return m_str; }
// Last character written, works only for streams on strings
QChar lastChar() const;
void putString(QStringView v);
void putChar(QChar c);
void putString(const char *s);
void putChar(char c);
void putInt(int t);
void putSizeType(qsizetype t);
void putRawString(const char *s) { m_str << s; }
void putRawChar(char c) { m_str << c; }
TextStream &operator<<(QStringView v) { putString(v); return *this; }
TextStream &operator<<(QChar c) { putChar(c); return *this; }
TextStream &operator<<(const char *s) { putString(s); return *this; }
TextStream &operator<<(char c) { putChar(c); return *this; }
TextStream &operator<<(int t) { putInt(t); return *this; }
#if QT_POINTER_SIZE != 4
TextStream &operator<<(qsizetype t) { putSizeType(t); return *this; }
#endif
inline TextStream &operator<<(QTextStreamManipulator m) { m_str << m; return *this; }
inline TextStream &operator<<(ManipulatorFunc f) { f(*this); return *this; }
void putRepetitiveChars(char c, int count);
void _setRstFormattingEnd();
protected:
void setLastCharClass(CharClass c);
private:
void writeIndent();
void checkIndent(CharClass upComingCharClass);
template <class Char>
void putCharHelper(Char c);
QTextStream m_str;
CharClass m_lastCharClass = CharClass::NewLine;
int m_tabWidth = 4;
int m_indentation = 0;
bool m_indentationEnabled = true;
bool m_rstFormattingEnd = false; // just past some **bla** where '\' needs to be enforced
Language m_language;
};
/// Stream into a string (cf std::ostringstream)
class StringStream : public TextStream
{
public:
StringStream(Language l = Language::None);
qsizetype size() const { return m_buffer.size(); }
void clear();
const QString &toString() const { return m_buffer; }
operator const QString &() const { return m_buffer; }
private:
QString m_buffer;
};
void indent(TextStream &s);
void outdent(TextStream &s);
void enableIndent(TextStream &s);
void disableIndent(TextStream &s);
// Works only for streams on strings
void ensureEndl(TextStream &s);
void rstBold(TextStream &s);
void rstBoldOff(TextStream &s);
void rstCode(TextStream &s);
void rstCodeOff(TextStream &s);
void rstItalic(TextStream &s);
void rstItalicOff(TextStream &s);
/// Format an aligned field
template <class T>
class AlignedField
{
public:
explicit AlignedField(T value, int fieldWidth,
QTextStream::FieldAlignment a = QTextStream::AlignLeft) :
m_value(value), m_fieldWidth(fieldWidth), m_alignment(a)
{
}
void put(TextStream &s) const
{
const int oldFieldWidth = s.fieldWidth();
const auto oldFieldAlignment = s.fieldAlignment();
s.setFieldWidth(m_fieldWidth);
s.setFieldAlignment(m_alignment);
const auto oldPos = s.pos();
s << m_value;
// Ensure something is written when an empty string is encountered
if (oldPos == s.pos() && m_fieldWidth > 0)
s << ' ';
s.setFieldAlignment(oldFieldAlignment);
s.setFieldWidth(oldFieldWidth);
}
private:
const T m_value;
const int m_fieldWidth;
const QTextStream::FieldAlignment m_alignment;
};
template <class T>
TextStream &operator<<(TextStream &str, const AlignedField<T> &fa)
{
fa.put(str);
return str;
}
class Indentation
{
public:
Q_DISABLE_COPY_MOVE(Indentation)
Indentation(TextStream &s, int n = 1) : m_s(s), m_n(n) { m_s.indent(m_n); }
~Indentation() { m_s.outdent(m_n); }
private:
TextStream &m_s;
const int m_n;
};
#endif // TEXTSTREAM_H
|
