summaryrefslogtreecommitdiff
path: root/parser/html/javasrc/UTF16Buffer.java
blob: ec79185ec20efd99b6fd9f213ac4458c4074fc79 (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
/*
 * Copyright (c) 2008-2010 Mozilla Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a 
 * copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the 
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 */

package nu.validator.htmlparser.impl;

import nu.validator.htmlparser.annotation.NoLength;

/**
 * An UTF-16 buffer that knows the start and end indeces of its unconsumed
 * content.
 * 
 * @version $Id$
 * @author hsivonen
 */
public final class UTF16Buffer {

    /**
     * The backing store of the buffer. May be larger than the logical content
     * of this <code>UTF16Buffer</code>.
     */
    private final @NoLength char[] buffer;

    /**
     * The index of the first unconsumed character in the backing buffer.
     */
    private int start;

    /**
     * The index of the slot immediately after the last character in the backing
     * buffer that is part of the logical content of this
     * <code>UTF16Buffer</code>.
     */
    private int end;

    //[NOCPP[
    
    /**
     * Constructor for wrapping an existing UTF-16 code unit array.
     * 
     * @param buffer
     *            the backing buffer
     * @param start
     *            the index of the first character to consume
     * @param end
     *            the index immediately after the last character to consume
     */
    public UTF16Buffer(@NoLength char[] buffer, int start, int end) {
        this.buffer = buffer;
        this.start = start;
        this.end = end;
    }

    // ]NOCPP]
    
    /**
     * Returns the start index.
     * 
     * @return the start index
     */
    public int getStart() {
        return start;
    }

    /**
     * Sets the start index.
     * 
     * @param start
     *            the start index
     */
    public void setStart(int start) {
        this.start = start;
    }

    /**
     * Returns the backing buffer.
     * 
     * @return the backing buffer
     */
    public @NoLength char[] getBuffer() {
        return buffer;
    }

    /**
     * Returns the end index.
     * 
     * @return the end index
     */
    public int getEnd() {
        return end;
    }

    /**
     * Checks if the buffer has data left.
     * 
     * @return <code>true</code> if there's data left
     */
    public boolean hasMore() {
        return start < end;
    }

    /**
     * Returns <code>end - start</code>.
     *
     * @return <code>end - start</code>
     */
    public int getLength() {
        return end - start;
    }

    /**
     * Adjusts the start index to skip over the first character if it is a line
     * feed and the previous character was a carriage return.
     * 
     * @param lastWasCR
     *            whether the previous character was a carriage return
     */
    public void adjust(boolean lastWasCR) {
        if (lastWasCR && buffer[start] == '\n') {
            start++;
        }
    }

    /**
     * Sets the end index.
     * 
     * @param end
     *            the end index
     */
    public void setEnd(int end) {
        this.end = end;
    }
}