forked from audacity/audacity
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathXMLWriter.cpp
More file actions
431 lines (362 loc) · 10.6 KB
/
Copy pathXMLWriter.cpp
File metadata and controls
431 lines (362 loc) · 10.6 KB
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
/**********************************************************************
Audacity: A Digital Audio Editor
XMLWriter.cpp
Leland Lucius
*******************************************************************//**
\class XMLWriter
\brief Base class for XMLFileWriter and XMLStringWriter that provides
the general functionality for creating XML in UTF8 encoding.
*//****************************************************************//**
\class XMLFileWriter
\brief Wrapper to output XML data to files.
*//****************************************************************//**
\class XMLStringWriter
\brief Wrapper to output XML data to strings.
*//*******************************************************************/
#include "../Audacity.h"
#include "XMLWriter.h"
#include <wx/defs.h>
#include <wx/ffile.h>
#include <wx/intl.h>
#include <string.h>
//table for xml encoding compatibility with expat decoding
//see wxWidgets-2.8.12/src/expat/lib/xmltok_impl.h
//and wxWidgets-2.8.12/src/expat/lib/asciitab.h
static int charXMLCompatiblity[] =
{
/* 0x00 */ 0, 0, 0, 0,
/* 0x04 */ 0, 0, 0, 0,
/* 0x08 */ 0, 1, 1, 0,
/* 0x0C */ 0, 1, 0, 0,
/* 0x10 */ 0, 0, 0, 0,
/* 0x14 */ 0, 0, 0, 0,
/* 0x18 */ 0, 0, 0, 0,
/* 0x1C */ 0, 0, 0, 0,
};
// These are used by XMLEsc to handle surrogate pairs and filter invalid characters outside the ASCII range.
#define MIN_HIGH_SURROGATE static_cast<wxUChar>(0xD800)
#define MAX_HIGH_SURROGATE static_cast<wxUChar>(0xDBFF)
#define MIN_LOW_SURROGATE static_cast<wxUChar>(0xDC00)
#define MAX_LOW_SURROGATE static_cast<wxUChar>(0xDFFF)
// Unicode defines other noncharacters, but only these two are invalid in XML.
#define NONCHARACTER_FFFE static_cast<wxUChar>(0xFFFE)
#define NONCHARACTER_FFFF static_cast<wxUChar>(0xFFFF)
///
/// XMLWriter base class
///
XMLWriter::XMLWriter()
{
mDepth = 0;
mInTag = false;
mHasKids.push_back(false);
}
XMLWriter::~XMLWriter()
{
}
void XMLWriter::StartTag(const wxString &name)
// may throw
{
int i;
if (mInTag) {
Write(wxT(">\n"));
mInTag = false;
}
for (i = 0; i < mDepth; i++) {
Write(wxT("\t"));
}
Write(wxString::Format(wxT("<%s"), name));
mTagstack.insert(mTagstack.begin(), name);
mHasKids[0] = true;
mHasKids.insert(mHasKids.begin(), false);
mDepth++;
mInTag = true;
}
void XMLWriter::EndTag(const wxString &name)
// may throw
{
int i;
if (mTagstack.size() > 0) {
if (mTagstack[0] == name) {
if (mHasKids[1]) { // There will always be at least 2 at this point
if (mInTag) {
Write(wxT("/>\n"));
}
else {
for (i = 0; i < mDepth - 1; i++) {
Write(wxT("\t"));
}
Write(wxString::Format(wxT("</%s>\n"), name));
}
}
else {
Write(wxT(">\n"));
}
mTagstack.erase( mTagstack.begin() );
mHasKids.erase(mHasKids.begin());
}
}
mDepth--;
mInTag = false;
}
void XMLWriter::WriteAttr(const wxString &name, const wxString &value)
// may throw from Write()
{
Write(wxString::Format(wxT(" %s=\"%s\""),
name,
XMLEsc(value)));
}
void XMLWriter::WriteAttr(const wxString &name, const wxChar *value)
// may throw from Write()
{
WriteAttr(name, wxString(value));
}
void XMLWriter::WriteAttr(const wxString &name, int value)
// may throw from Write()
{
Write(wxString::Format(wxT(" %s=\"%d\""),
name,
value));
}
void XMLWriter::WriteAttr(const wxString &name, bool value)
// may throw from Write()
{
Write(wxString::Format(wxT(" %s=\"%d\""),
name,
value));
}
void XMLWriter::WriteAttr(const wxString &name, long value)
// may throw from Write()
{
Write(wxString::Format(wxT(" %s=\"%ld\""),
name,
value));
}
void XMLWriter::WriteAttr(const wxString &name, long long value)
// may throw from Write()
{
Write(wxString::Format(wxT(" %s=\"%lld\""),
name,
value));
}
void XMLWriter::WriteAttr(const wxString &name, size_t value)
// may throw from Write()
{
Write(wxString::Format(wxT(" %s=\"%lld\""),
name,
(long long) value));
}
void XMLWriter::WriteAttr(const wxString &name, float value, int digits)
// may throw from Write()
{
Write(wxString::Format(wxT(" %s=\"%s\""),
name,
Internat::ToString(value, digits)));
}
void XMLWriter::WriteAttr(const wxString &name, double value, int digits)
// may throw from Write()
{
Write(wxString::Format(wxT(" %s=\"%s\""),
name,
Internat::ToString(value, digits)));
}
void XMLWriter::WriteData(const wxString &value)
// may throw from Write()
{
int i;
for (i = 0; i < mDepth; i++) {
Write(wxT("\t"));
}
Write(XMLEsc(value));
}
void XMLWriter::WriteSubTree(const wxString &value)
// may throw from Write()
{
if (mInTag) {
Write(wxT(">\n"));
mInTag = false;
mHasKids[0] = true;
}
Write(value);
}
// See http://www.w3.org/TR/REC-xml for reference
wxString XMLWriter::XMLEsc(const wxString & s)
{
wxString result;
int len = s.length();
for(int i=0; i<len; i++) {
wxUChar c = s.GetChar(i);
switch (c) {
case wxT('\''):
result += wxT("'");
break;
case wxT('"'):
result += wxT(""");
break;
case wxT('&'):
result += wxT("&");
break;
case wxT('<'):
result += wxT("<");
break;
case wxT('>'):
result += wxT(">");
break;
default:
if (sizeof(c) == 2 && c >= MIN_HIGH_SURROGATE && c <= MAX_HIGH_SURROGATE && i < len - 1) {
// If wxUChar is 2 bytes, then supplementary characters (those greater than U+FFFF) are represented
// with a high surrogate (U+D800..U+DBFF) followed by a low surrogate (U+DC00..U+DFFF).
// Handle those here.
wxUChar c2 = s.GetChar(++i);
if (c2 >= MIN_LOW_SURROGATE && c2 <= MAX_LOW_SURROGATE) {
// Surrogate pair found; simply add it to the output string.
result += c;
result += c2;
}
else {
// That high surrogate isn't paired, so ignore it.
i--;
}
}
else if (!wxIsprint(c)) {
//ignore several characters such ase eot (0x04) and stx (0x02) because it makes expat parser bail
//see xmltok.c in expat checkCharRefNumber() to see how expat bails on these chars.
//also see wxWidgets-2.8.12/src/expat/lib/asciitab.h to see which characters are nonxml compatible
//post decode (we can still encode '&' and '<' with this table, but it prevents us from encoding eot)
//everything is compatible past ascii 0x20 except for surrogates and the noncharacters U+FFFE and U+FFFF,
//so we don't check the compatibility table higher than this.
if((c> 0x1F || charXMLCompatiblity[c]!=0) &&
(c < MIN_HIGH_SURROGATE || c > MAX_LOW_SURROGATE) &&
c != NONCHARACTER_FFFE && c != NONCHARACTER_FFFF)
result += wxString::Format(wxT("&#x%04x;"), c);
}
else {
result += c;
}
break;
}
}
return result;
}
///
/// XMLFileWriter class
///
XMLFileWriter::XMLFileWriter(
const FilePath &outputPath, const TranslatableString &caption, bool keepBackup )
: mOutputPath{ outputPath }
, mCaption{ caption }
, mKeepBackup{ keepBackup }
// may throw
{
auto tempPath = wxFileName::CreateTempFileName( outputPath );
if (!wxFFile::Open(tempPath, wxT("wb")) || !IsOpened())
ThrowException( outputPath, mCaption );
if (mKeepBackup) {
int index = 0;
wxString backupName;
do {
wxFileName outputFn{ mOutputPath };
index++;
mBackupName =
outputFn.GetPath() + wxFILE_SEP_PATH +
outputFn.GetName() + wxT("_bak") +
wxString::Format(wxT("%d"), index) + wxT(".") +
outputFn.GetExt();
} while( ::wxFileExists( mBackupName ) );
// Open the backup file to be sure we can write it and reserve it
// until committing
if (! mBackupFile.Open( mBackupName, "wb" ) || ! mBackupFile.IsOpened() )
ThrowException( mBackupName, mCaption );
}
}
XMLFileWriter::~XMLFileWriter()
{
// Don't let a destructor throw!
GuardedCall( [&] {
if (!mCommitted) {
auto fileName = GetName();
if ( IsOpened() )
CloseWithoutEndingTags();
::wxRemoveFile( fileName );
}
} );
}
void XMLFileWriter::Commit()
// may throw
{
PreCommit();
PostCommit();
}
void XMLFileWriter::PreCommit()
// may throw
{
while (mTagstack.size()) {
EndTag(mTagstack[0]);
}
CloseWithoutEndingTags();
}
void XMLFileWriter::PostCommit()
// may throw
{
FilePath tempPath = GetName();
if (mKeepBackup) {
if (! mBackupFile.Close() ||
! wxRenameFile( mOutputPath, mBackupName ) )
ThrowException( mBackupName, mCaption );
}
else {
if ( wxFileName::FileExists( mOutputPath ) &&
! wxRemoveFile( mOutputPath ) )
ThrowException( mOutputPath, mCaption );
}
// Now we have vacated the file at the output path and are committed.
// But not completely finished with steps of the commit operation.
// If this step fails, we haven't lost the successfully written data,
// but just failed to put it in the right place.
if (! wxRenameFile( tempPath, mOutputPath ) )
throw FileException{
FileException::Cause::Rename, tempPath, mCaption, mOutputPath
};
mCommitted = true;
}
void XMLFileWriter::CloseWithoutEndingTags()
// may throw
{
// Before closing, we first flush it, because if Flush() fails because of a
// "disk full" condition, we can still at least try to close the file.
if (!wxFFile::Flush())
{
wxFFile::Close();
ThrowException( GetName(), mCaption );
}
// Note that this should never fail if flushing worked.
if (!wxFFile::Close())
ThrowException( GetName(), mCaption );
}
void XMLFileWriter::Write(const wxString &data)
// may throw
{
if (!wxFFile::Write(data, wxConvUTF8) || Error())
{
// When writing fails, we try to close the file before throwing the
// exception, so it can at least be deleted.
wxFFile::Close();
ThrowException( GetName(), mCaption );
}
}
///
/// XMLStringWriter class
///
XMLStringWriter::XMLStringWriter(size_t initialSize)
{
if (initialSize)
{
reserve(initialSize);
}
}
XMLStringWriter::~XMLStringWriter()
{
}
void XMLStringWriter::Write(const wxString &data)
{
Append(data);
}