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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#include "textdocument.h"
#include <coreplugin/editormanager/editormanager.h>
#include <QDebug>
#include <QTextCodec>
/*!
\class Core::TextDocument
\brief The TextDocument 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::TextFileUtils
*/
enum { debug = 0 };
namespace Core {
namespace Internal {
class TextDocumentPrivate
{
public:
TextDocumentPrivate() : m_readResult(Utils::TextFileFormat::ReadSuccess) {}
Utils::TextFileFormat m_format;
Utils::TextFileFormat::ReadResult m_readResult;
QByteArray m_decodingErrorSample;
};
} // namespace Internal
BaseTextDocument::BaseTextDocument(QObject *parent) :
IDocument(parent), d(new Internal::TextDocumentPrivate)
{
setCodec(Core::EditorManager::defaultTextCodec());
}
BaseTextDocument::~BaseTextDocument()
{
delete d;
}
bool BaseTextDocument::hasDecodingError() const
{
return d->m_readResult == Utils::TextFileFormat::ReadEncodingError;
}
QByteArray BaseTextDocument::decodingErrorSample() const
{
return d->m_decodingErrorSample;
}
/*!
Writes out text using the format obtained from the last read.
*/
bool BaseTextDocument::write(const QString &fileName, const QString &data, QString *errorMessage) const
{
return write(fileName, format(), data, errorMessage);
}
/*!
Writes out text using a custom \a format.
*/
bool BaseTextDocument::write(const QString &fileName, const Utils::TextFileFormat &format, const QString &data, QString *errorMessage) const
{
if (debug)
qDebug() << Q_FUNC_INFO << this << fileName;
return format.writeFile(fileName, data, errorMessage);
}
/*!
Autodetects format and reads in the text file specified by \a fileName.
*/
BaseTextDocument::ReadResult BaseTextDocument::read(const QString &fileName, QStringList *plainTextList, QString *errorString)
{
d->m_readResult =
Utils::TextFileFormat::readFile(fileName, codec(),
plainTextList, &d->m_format, errorString, &d->m_decodingErrorSample);
return d->m_readResult;
}
/*!
Autodetects format and reads in the text file specified by \a fileName.
*/
BaseTextDocument::ReadResult BaseTextDocument::read(const QString &fileName, QString *plainText, QString *errorString)
{
d->m_readResult =
Utils::TextFileFormat::readFile(fileName, codec(),
plainText, &d->m_format, errorString, &d->m_decodingErrorSample);
return d->m_readResult;
}
const QTextCodec *BaseTextDocument::codec() const
{
return d->m_format.codec;
}
void BaseTextDocument::setCodec(const QTextCodec *codec)
{
if (debug)
qDebug() << Q_FUNC_INFO << this << (codec ? codec->name() : QByteArray());
d->m_format.codec = codec;
}
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;
}
/*!
Returns the format obtained from the last call to \c read().
*/
Utils::TextFileFormat BaseTextDocument::format() const
{
return d->m_format;
}
} // namespace Core
|
