/
PrettyPrintXMLWriter.java
522 lines (423 loc) · 11.9 KB
/
PrettyPrintXMLWriter.java
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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
package org.codehaus.plexus.util.xml;
/*
* Copyright The Codehaus Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.io.PrintWriter;
import java.io.Writer;
import java.util.LinkedList;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.codehaus.plexus.util.StringUtils;
/**
* Implementation of XMLWriter which emits nicely formatted documents.
*
* @version $Id$
*/
public class PrettyPrintXMLWriter
implements XMLWriter
{
/** Line separator ("\n" on UNIX) */
protected static final String LS = System.getProperty( "line.separator" );
private PrintWriter writer;
private LinkedList<String> elementStack = new LinkedList<String>();
private boolean tagInProgress;
private int depth;
private String lineIndenter;
private String lineSeparator;
private String encoding;
private String docType;
private boolean readyForNewLine;
private boolean tagIsEmpty;
/**
* @param writer not null
* @param lineIndenter could be null, but the normal way is some spaces.
*/
public PrettyPrintXMLWriter( PrintWriter writer, String lineIndenter )
{
this( writer, lineIndenter, null, null );
}
/**
* @param writer not null
* @param lineIndenter could be null, but the normal way is some spaces.
*/
public PrettyPrintXMLWriter( Writer writer, String lineIndenter )
{
this( new PrintWriter( writer ), lineIndenter );
}
/**
* @param writer not null
*/
public PrettyPrintXMLWriter( PrintWriter writer )
{
this( writer, null, null );
}
/**
* @param writer not null
*/
public PrettyPrintXMLWriter( Writer writer )
{
this( new PrintWriter( writer ) );
}
/**
* @param writer not null
* @param lineIndenter could be null, but the normal way is some spaces.
* @param encoding could be null or invalid.
* @param doctype could be null.
*/
public PrettyPrintXMLWriter( PrintWriter writer, String lineIndenter, String encoding, String doctype )
{
this( writer, lineIndenter, LS, encoding, doctype );
}
/**
* @param writer not null
* @param lineIndenter could be null, but the normal way is some spaces.
* @param encoding could be null or invalid.
* @param doctype could be null.
*/
public PrettyPrintXMLWriter( Writer writer, String lineIndenter, String encoding, String doctype )
{
this( new PrintWriter( writer ), lineIndenter, encoding, doctype );
}
/**
* @param writer not null
* @param encoding could be null or invalid.
* @param doctype could be null.
*/
public PrettyPrintXMLWriter( PrintWriter writer, String encoding, String doctype )
{
this( writer, " ", encoding, doctype );
}
/**
* @param writer not null
* @param encoding could be null or invalid.
* @param doctype could be null.
*/
public PrettyPrintXMLWriter( Writer writer, String encoding, String doctype )
{
this( new PrintWriter( writer ), encoding, doctype );
}
/**
* @param writer not null
* @param lineIndenter could be null, but the normal way is some spaces.
* @param lineSeparator could be null, but the normal way is valid line separator ("\n" on UNIX).
* @param encoding could be null or invalid.
* @param doctype could be null.
*/
public PrettyPrintXMLWriter( PrintWriter writer, String lineIndenter, String lineSeparator, String encoding,
String doctype )
{
setWriter( writer );
setLineIndenter( lineIndenter );
setLineSeparator( lineSeparator );
setEncoding( encoding );
setDocType( doctype );
if ( doctype != null || encoding != null )
{
writeDocumentHeaders();
}
}
/** {@inheritDoc} */
public void startElement( String name )
{
tagIsEmpty = false;
finishTag();
write( "<" );
write( name );
elementStack.addLast( name );
tagInProgress = true;
setDepth( getDepth() + 1 );
readyForNewLine = true;
tagIsEmpty = true;
}
/** {@inheritDoc} */
public void writeText( String text )
{
writeText( text, true );
}
/** {@inheritDoc} */
public void writeMarkup( String text )
{
writeText( text, false );
}
private void writeText( String text, boolean escapeXml )
{
readyForNewLine = false;
tagIsEmpty = false;
finishTag();
if ( escapeXml )
{
text = escapeXml( text );
}
write( StringUtils.unifyLineSeparators( text, lineSeparator ) );
}
private static final Pattern amp = Pattern.compile( "&" );
private static final Pattern lt = Pattern.compile( "<" );
private static final Pattern gt = Pattern.compile( ">" );
private static final Pattern dqoute = Pattern.compile( "\"" );
private static final Pattern sqoute = Pattern.compile( "\'" );
private static String escapeXml( String text )
{
if ( text.indexOf( '&' ) >= 0 )
{
text = amp.matcher( text ).replaceAll( "&" );
}
if ( text.indexOf( '<' ) >= 0 )
{
text = lt.matcher( text ).replaceAll( "<" );
}
if ( text.indexOf( '>' ) >= 0 )
{
text = gt.matcher( text ).replaceAll( ">" );
}
if ( text.indexOf( '"' ) >= 0 )
{
text = dqoute.matcher( text ).replaceAll( """ );
}
if ( text.indexOf( '\'' ) >= 0 )
{
text = sqoute.matcher( text ).replaceAll( "'" );
}
return text;
}
private static final String crlf_str = "\r\n";
private static final Pattern crlf = Pattern.compile( crlf_str );
private static final Pattern lowers = Pattern.compile( "([\000-\037])" );
private static String escapeXmlAttribute( String text )
{
text = escapeXml( text );
// Windows
Matcher crlfmatcher = crlf.matcher( text );
if ( text.contains( crlf_str ) )
{
text = crlfmatcher.replaceAll( " " );
}
Matcher m = lowers.matcher( text );
StringBuffer b = new StringBuffer();
while ( m.find() )
{
m = m.appendReplacement( b, "&#" + Integer.toString( m.group( 1 ).charAt( 0 ) ) + ";" );
}
m.appendTail( b );
return b.toString();
}
/** {@inheritDoc} */
public void addAttribute( String key, String value )
{
write( " " );
write( key );
write( "=\"" );
write( escapeXmlAttribute( value ) );
write( "\"" );
}
/** {@inheritDoc} */
public void endElement()
{
setDepth( getDepth() - 1 );
if ( tagIsEmpty )
{
write( "/" );
readyForNewLine = false;
finishTag();
elementStack.removeLast();
}
else
{
finishTag();
// see issue #51: https://github.com/codehaus-plexus/plexus-utils/issues/51
// Rationale: replaced 1 write() with string concatenations with 3 write()
// (this avoids the string concatenation optimization bug detected in Java 7)
// TODO: change the below code to a more efficient expression when the library
// be ready to target Java 8.
write( "</" );
write( elementStack.removeLast() );
write( ">" );
}
readyForNewLine = true;
}
/**
* Write a string to the underlying writer
*
* @param str
*/
private void write( String str )
{
getWriter().write( str );
}
private void finishTag()
{
if ( tagInProgress )
{
write( ">" );
}
tagInProgress = false;
if ( readyForNewLine )
{
endOfLine();
}
readyForNewLine = false;
tagIsEmpty = false;
}
/**
* Get the string used as line indenter
*
* @return the line indenter
*/
protected String getLineIndenter()
{
return lineIndenter;
}
/**
* Set the string used as line indenter
*
* @param lineIndenter new line indenter, could be null, but the normal way is some spaces.
*/
protected void setLineIndenter( String lineIndenter )
{
this.lineIndenter = lineIndenter;
}
/**
* Get the string used as line separator or LS if not set.
*
* @return the line separator
* @see #LS
*/
protected String getLineSeparator()
{
return lineSeparator;
}
/**
* Set the string used as line separator
*
* @param lineSeparator new line separator, could be null but the normal way is valid line separator ("\n" on UNIX).
*/
protected void setLineSeparator( String lineSeparator )
{
this.lineSeparator = lineSeparator;
}
/**
* Write the end of line character (using specified line separator) and start new line with indentation
*
* @see #getLineIndenter()
* @see #getLineSeparator()
*/
protected void endOfLine()
{
write( getLineSeparator() );
for ( int i = 0; i < getDepth(); i++ )
{
write( getLineIndenter() );
}
}
private void writeDocumentHeaders()
{
write( "<?xml version=\"1.0\"" );
if ( getEncoding() != null )
{
write( " encoding=\"" + getEncoding() + "\"" );
}
write( "?>" );
endOfLine();
if ( getDocType() != null )
{
write( "<!DOCTYPE " );
write( getDocType() );
write( ">" );
endOfLine();
}
}
/**
* Set the underlying writer
*
* @param writer not null writer
*/
protected void setWriter( PrintWriter writer )
{
if ( writer == null )
{
throw new IllegalArgumentException( "writer could not be null" );
}
this.writer = writer;
}
/**
* Get the underlying writer
*
* @return the underlying writer
*/
protected PrintWriter getWriter()
{
return writer;
}
/**
* Set the depth in the xml indentation
*
* @param depth new depth
*/
protected void setDepth( int depth )
{
this.depth = depth;
}
/**
* Get the current depth in the xml indentation
*
* @return the current depth
*/
protected int getDepth()
{
return depth;
}
/**
* Set the encoding in the xml
*
* @param encoding new encoding
*/
protected void setEncoding( String encoding )
{
this.encoding = encoding;
}
/**
* Get the current encoding in the xml
*
* @return the current encoding
*/
protected String getEncoding()
{
return encoding;
}
/**
* Set the docType in the xml
*
* @param docType new docType
*/
protected void setDocType( String docType )
{
this.docType = docType;
}
/**
* Get the docType in the xml
*
* @return the current docType
*/
protected String getDocType()
{
return docType;
}
/**
* @return the current elementStack;
*/
protected LinkedList<String> getElementStack()
{
return elementStack;
}
}