-
Notifications
You must be signed in to change notification settings - Fork 267
/
ModifiedPomXMLEventReader.java
594 lines (536 loc) · 14.9 KB
/
ModifiedPomXMLEventReader.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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
package org.codehaus.mojo.versions.rewriting;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.maven.model.Model;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.Characters;
import javax.xml.stream.events.XMLEvent;
import java.io.IOException;
import java.io.StringReader;
/**
* Represents the modified pom file. Note: implementations of the StAX API (JSR-173) are not good round-trip rewriting
* <b>while</b> keeping all unchanged bytes in the file as is. For example, the StAX API specifies that <code>CR</code>
* characters will be stripped. Current implementations do not keep " and ' characters consistent.
*
* @author Stephen Connolly
*/
public class ModifiedPomXMLEventReader
implements XMLEventReader
{
// ------------------------------ FIELDS ------------------------------
/**
* Field MAX_MARKS
*/
private static final int MAX_MARKS = 3;
/**
* Field pom
*/
private final StringBuilder pom;
/**
* Field modified
*/
private boolean modified = false;
/**
* Field factory
*/
private final XMLInputFactory factory;
/**
* Field nextStart
*/
private int nextStart = 0;
/**
* Field nextEnd
*/
private int nextEnd = 0;
/**
* Field markStart
*/
private int[] markStart = new int[MAX_MARKS];
/**
* Field markEnd
*/
private int[] markEnd = new int[MAX_MARKS];
/**
* Field markDelta
*/
private int[] markDelta = new int[MAX_MARKS];
/**
* Field lastStart
*/
private int lastStart = -1;
/**
* Field lastEnd
*/
private int lastEnd;
/**
* Field lastDelta
*/
private int lastDelta = 0;
/**
* Field next
*/
private XMLEvent next = null;
/**
* Field nextDelta
*/
private int nextDelta = 0;
/**
* Field backing
*/
private XMLEventReader backing;
// --------------------------- CONSTRUCTORS ---------------------------
/**
* Constructor ModifiedPomXMLEventReader creates a new ModifiedPomXMLEventReader instance.
*
* @param pom of type StringBuilder
* @param factory of type XMLInputFactory
* @throws XMLStreamException when
*/
public ModifiedPomXMLEventReader( StringBuilder pom, XMLInputFactory factory )
throws XMLStreamException
{
this.pom = pom;
this.factory = factory;
rewind();
}
/**
* Rewind to the start so we can run through again.
*
* @throws XMLStreamException when things go wrong.
*/
public void rewind()
throws XMLStreamException
{
backing = factory.createXMLEventReader( new StringReader( pom.toString() ) );
nextEnd = 0;
nextDelta = 0;
for ( int i = 0; i < MAX_MARKS; i++ )
{
markStart[i] = -1;
markEnd[i] = -1;
markDelta[i] = 0;
}
lastStart = -1;
lastEnd = -1;
lastDelta = 0;
next = null;
}
// --------------------- GETTER / SETTER METHODS ---------------------
/**
* Getter for property 'modified'.
*
* @return Value for property 'modified'.
*/
public boolean isModified()
{
return modified;
}
// ------------------------ INTERFACE METHODS ------------------------
// --------------------- Interface Iterator ---------------------
/**
* {@inheritDoc}
*/
public Object next()
{
try
{
return nextEvent();
}
catch ( XMLStreamException e )
{
return null;
}
}
/**
* {@inheritDoc}
*/
public void remove()
{
throw new UnsupportedOperationException();
}
// --------------------- Interface XMLEventReader ---------------------
/**
* {@inheritDoc}
*/
public XMLEvent nextEvent()
throws XMLStreamException
{
try
{
return next;
}
finally
{
next = null;
lastStart = nextStart;
lastEnd = nextEnd;
lastDelta = nextDelta;
}
}
/**
* {@inheritDoc}
*/
public XMLEvent peek()
throws XMLStreamException
{
return backing.peek();
}
/**
* {@inheritDoc}
*/
public String getElementText()
throws XMLStreamException
{
return backing.getElementText();
}
/**
* {@inheritDoc}
*/
public XMLEvent nextTag()
throws XMLStreamException
{
while ( hasNext() )
{
XMLEvent e = nextEvent();
if ( e.isCharacters() && !( (Characters) e ).isWhiteSpace() )
{
throw new XMLStreamException( "Unexpected text" );
}
if ( e.isStartElement() || e.isEndElement() )
{
return e;
}
}
throw new XMLStreamException( "Unexpected end of Document" );
}
/**
* {@inheritDoc}
*/
public Object getProperty( String name )
{
return backing.getProperty( name );
}
/**
* {@inheritDoc}
*/
public void close()
throws XMLStreamException
{
backing.close();
next = null;
backing = null;
}
// -------------------------- OTHER METHODS --------------------------
/**
* Returns a copy of the backing string buffer.
*
* @return a copy of the backing string buffer.
*/
public StringBuilder asStringBuilder()
{
return new StringBuilder( pom.toString() );
}
/**
* Clears the mark.
*
* @param index the mark to clear.
*/
public void clearMark( int index )
{
markStart[index] = -1;
}
/**
* the verbatim text of the current element when {@link #mark(int)} was called.
*
* @param index The mark index.
* @return the current element when {@link #mark(int)} was called.
*/
public String getMarkVerbatim( int index )
{
if ( hasMark( index ) )
{
return pom.substring( markDelta[index] + markStart[index], markDelta[index] + markEnd[index] );
}
return "";
}
/**
* Returns the verbatim text of the element returned by {@link #peek()}.
*
* @return the verbatim text of the element returned by {@link #peek()}.
*/
public String getPeekVerbatim()
{
if ( hasNext() )
{
return pom.substring( nextDelta + nextStart, nextDelta + nextEnd );
}
return "";
}
/**
* {@inheritDoc}
*/
public boolean hasNext()
{
if ( next != null )
{
// fast path
return true;
}
if ( !backing.hasNext() )
{
// fast path
return false;
}
try
{
next = backing.nextEvent();
nextStart = nextEnd;
if ( backing.hasNext() )
{
nextEnd = backing.peek().getLocation().getCharacterOffset();
}
if ( nextEnd != -1 )
{
if ( !next.isCharacters() )
{
while ( nextStart < nextEnd && nextStart < pom.length()
&& ( c( nextStart ) == '\n' || c( nextStart ) == '\r' ) )
{
nextStart++;
}
}
else
{
while ( nextEndIncludesNextEvent() || nextEndIncludesNextEndElement() )
{
nextEnd--;
}
}
}
return nextStart < pom.length();
}
catch ( XMLStreamException e )
{
return false;
}
}
/**
* Getter for property 'verbatim'.
*
* @return Value for property 'verbatim'.
*/
public String getVerbatim()
{
if ( lastStart >= 0 && lastEnd >= lastStart )
{
return pom.substring( lastDelta + lastStart, lastDelta + lastEnd );
}
return "";
}
/**
* Sets a mark to the current event.
*
* @param index the mark to set.
*/
public void mark( int index )
{
markStart[index] = lastStart;
markEnd[index] = lastEnd;
markDelta[index] = lastDelta;
}
/**
* Returns <code>true</code> if nextEnd is including the start of and end element.
*
* @return <code>true</code> if nextEnd is including the start of and end element.
*/
private boolean nextEndIncludesNextEndElement()
{
return ( nextEnd > nextStart + 2 && nextEnd - 2 < pom.length() && c( nextEnd - 2 ) == '<' );
}
/**
* Returns <code>true</code> if nextEnd is including the start of the next event.
*
* @return <code>true</code> if nextEnd is including the start of the next event.
*/
private boolean nextEndIncludesNextEvent()
{
return nextEnd > nextStart + 1 && nextEnd - 2 < pom.length()
&& ( c( nextEnd - 1 ) == '<' || c( nextEnd - 1 ) == '&' );
}
/**
* Gets the character at the index provided by the StAX parser.
*
* @param index the index.
* @return char The character.
*/
private char c( int index )
{
return pom.charAt( nextDelta + index );
}
/**
* Replaces the current element with the replacement text.
*
* @param replacement The replacement.
*/
public void replace( String replacement )
{
if ( lastStart < 0 || lastEnd < lastStart )
{
throw new IllegalStateException();
}
int start = lastDelta + lastStart;
int end = lastDelta + lastEnd;
if ( replacement.equals( pom.substring( start, end ) ) )
{
return;
}
pom.replace( start, end, replacement );
int delta = replacement.length() - lastEnd - lastStart;
nextDelta += delta;
for ( int i = 0; i < MAX_MARKS; i++ )
{
if ( hasMark( i ) && lastStart == markStart[i] && markEnd[i] == lastEnd )
{
markEnd[i] += delta;
}
}
lastEnd += delta;
modified = true;
}
/**
* Returns <code>true</code> if the specified mark is defined.
*
* @param index The mark.
* @return <code>true</code> if the specified mark is defined.
*/
public boolean hasMark( int index )
{
return markStart[index] != -1;
}
public String getBetween( int index1, int index2 )
{
if ( !hasMark( index1 ) || !hasMark( index2 ) || markStart[index1] > markStart[index2] )
{
throw new IllegalStateException();
}
int start = markDelta[index1] + markEnd[index1];
int end = markDelta[index2] + markStart[index2];
return pom.substring( start, end );
}
/**
* Replaces all content between marks index1 and index2 with the replacement text.
*
* @param index1 The event mark to replace after.
* @param index2 The event mark to replace before.
* @param replacement The replacement.
*/
public void replaceBetween( int index1, int index2, String replacement )
{
if ( !hasMark( index1 ) || !hasMark( index2 ) || markStart[index1] > markStart[index2] )
{
throw new IllegalStateException();
}
int start = markDelta[index1] + markEnd[index1];
int end = markDelta[index2] + markStart[index2];
if ( replacement.equals( pom.substring( start, end ) ) )
{
return;
}
pom.replace( start, end, replacement );
int delta = replacement.length() - ( end - start );
nextDelta += delta;
for ( int i = 0; i < MAX_MARKS; i++ )
{
if ( i == index1 || i == index2 || markStart[i] == -1 )
{
continue;
}
if ( markStart[i] > markStart[index2] )
{
markDelta[i] += delta;
}
else if ( markStart[i] == markEnd[index1] && markEnd[i] == markStart[index1] )
{
markDelta[i] += delta;
}
else if ( markStart[i] > markEnd[index1] || markEnd[i] < markStart[index2] )
{
markStart[i] = -1;
}
}
modified = true;
}
/**
* Replaces the specified marked element with the replacement text.
*
* @param index The mark.
* @param replacement The replacement.
*/
public void replaceMark( int index, String replacement )
{
if ( !hasMark( index ) )
{
throw new IllegalStateException();
}
int start = markDelta[index] + markStart[index];
int end = markDelta[index] + markEnd[index];
if ( replacement.equals( pom.substring( start, end ) ) )
{
return;
}
pom.replace( start, end, replacement );
int delta = replacement.length() - markEnd[index] - markStart[index];
nextDelta += delta;
if ( lastStart == markStart[index] && lastEnd == markEnd[index] )
{
lastEnd += delta;
}
else if ( lastStart > markStart[index] )
{
lastDelta += delta;
}
for ( int i = 0; i < MAX_MARKS; i++ )
{
if ( i == index || markStart[i] == -1 )
{
continue;
}
if ( markStart[i] > markStart[index] )
{
markDelta[i] += delta;
}
else if ( markStart[i] == markStart[index] && markEnd[i] == markEnd[index] )
{
markDelta[i] += delta;
}
}
markEnd[index] += delta;
modified = true;
}
public Model parse()
throws IOException, XmlPullParserException
{
MavenXpp3Reader reader = new MavenXpp3Reader();
return reader.read( new StringReader( pom.toString() ) );
}
}