blob: 2dd98d3299df5e9b319ecb0db453f6d36a856c7a (
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
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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "textdocument.h"
#include "editormanager/editormanager.h"
#include <QDebug>
/*!
\class Core::BaseTextDocument
\inheaderfile coreplugin/textdocument.h
\inmodule QtCreator
\brief The BaseTextDocument class is a very general base class for
documents that work with text.
This class contains helper methods for saving and reading text files with encoding and
line ending settings.
\sa Utils::TextFileFormat
*/
enum { debug = 0 };
using namespace Utils;
namespace Core {
namespace Internal {
class TextDocumentPrivate
{
public:
TextFileFormat m_format;
bool m_supportsUtf8Bom = true;
bool m_hasDecodingError = false;
QByteArray m_decodingErrorSample;
};
} // namespace Internal
BaseTextDocument::BaseTextDocument(QObject *parent)
: IDocument(parent), d(new Internal::TextDocumentPrivate)
{
setEncoding(Core::EditorManager::defaultTextEncoding());
setLineTerminationMode(Core::EditorManager::defaultLineEnding());
}
BaseTextDocument::~BaseTextDocument()
{
delete d;
}
bool BaseTextDocument::hasDecodingError() const
{
return d->m_hasDecodingError;
}
QByteArray BaseTextDocument::decodingErrorSample() const
{
return d->m_decodingErrorSample;
}
/*!
Writes out the contents (\a data) of the text file \a filePath.
Uses the format obtained from the last read() of the file.
Returns whether the operation was successful.
*/
Result<> BaseTextDocument::write(const FilePath &filePath, const QString &data) const
{
return write(filePath, format(), data);
}
/*!
Writes out the contents (\a data) of the text file \a filePath.
Uses the custom format \a format.
Returns whether the operation was successful.
*/
Result<> BaseTextDocument::write(const FilePath &filePath,
const TextFileFormat &format,
const QString &data) const
{
if (debug)
qDebug() << Q_FUNC_INFO << this << filePath;
return format.writeFile(filePath, data);
}
void BaseTextDocument::setSupportsUtf8Bom(bool value)
{
d->m_supportsUtf8Bom = value;
}
void BaseTextDocument::setLineTerminationMode(TextFileFormat::LineTerminationMode mode)
{
d->m_format.lineTerminationMode = mode;
}
/*!
Autodetects file format and reads the text file specified by \a filePath.
Returns whether the operation was successful.
*/
BaseTextDocument::ReadResult BaseTextDocument::read(const FilePath &filePath)
{
ReadResult res = d->m_format.readFile(filePath, encoding());
d->m_hasDecodingError = res.code == TextFileFormat::ReadEncodingError;
d->m_decodingErrorSample = res.decodingErrorSample;
return res;
}
void BaseTextDocument::setEncoding(const TextEncoding &encoding)
{
if (debug)
qDebug() << Q_FUNC_INFO << this << encoding.name();
if (supportsEncoding(encoding))
d->m_format.setEncoding(encoding);
}
TextEncoding BaseTextDocument::encoding() const
{
return d->m_format.encoding();
}
bool BaseTextDocument::supportsEncoding(const TextEncoding &) const
{
return true;
}
void BaseTextDocument::switchUtf8Bom()
{
if (debug)
qDebug() << Q_FUNC_INFO << this << "UTF-8 BOM: " << !d->m_format.hasUtf8Bom;
d->m_format.hasUtf8Bom = !d->m_format.hasUtf8Bom;
}
bool BaseTextDocument::supportsUtf8Bom() const
{
return d->m_supportsUtf8Bom;
}
TextFileFormat::LineTerminationMode BaseTextDocument::lineTerminationMode() const
{
return d->m_format.lineTerminationMode;
}
/*!
Returns the format obtained from the last call to read().
*/
TextFileFormat BaseTextDocument::format() const
{
return d->m_format;
}
} // namespace Core
|
