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
/* * @(#)LineNumberReader.java 1.23 06/04/07 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.io; /** * A buffered character-input stream that keeps track of line numbers. This * class defines methods {@link #setLineNumber(int)} and {@link * #getLineNumber()} for setting and getting the current line number * respectively. * * <p> By default, line numbering begins at 0. This number increments at every * <a href="#lt">line terminator</a> as the data is read, and can be changed * with a call to <tt>setLineNumber(int)</tt>. Note however, that * <tt>setLineNumber(int)</tt> does not actually change the current position in * the stream; it only changes the value that will be returned by * <tt>getLineNumber()</tt>. * * <p> A line is considered to be <a name="lt">terminated</a> by any one of a * line feed ('\n'), a carriage return ('\r'), or a carriage return followed * immediately by a linefeed. * * @version 1.23, 06/04/07 * @author Mark Reinhold * @since JDK1.1 */ public class LineNumberReader extends BufferedReader { /** The current line number */ private int lineNumber = 0; /** The line number of the mark, if any */ private int markedLineNumber; // Defaults to 0 /** If the next character is a line feed, skip it */ private boolean skipLF; /** The skipLF flag when the mark was set */ private boolean markedSkipLF; /** * Create a new line-numbering reader, using the default input-buffer * size. * * @param in * A Reader object to provide the underlying stream */ public LineNumberReader(Reader in) { super(in); } /** * Create a new line-numbering reader, reading characters into a buffer of * the given size. * * @param in * A Reader object to provide the underlying stream * * @param sz * An int specifying the size of the buffer */ public LineNumberReader(Reader in, int sz) { super(in, sz); } /** * Set the current line number. * * @param lineNumber * An int specifying the line number * * @see #getLineNumber */ public void setLineNumber(int lineNumber) { this.lineNumber = lineNumber; } /** * Get the current line number. * * @return The current line number * * @see #setLineNumber */ public int getLineNumber() { return lineNumber; } /** * Read a single character. <a href="#lt">Line terminators</a> are * compressed into single newline ('\n') characters. Whenever a line * terminator is read the current line number is incremented. * * @return The character read, or -1 if the end of the stream has been * reached * * @throws IOException * If an I/O error occurs */ public int read() throws IOException { synchronized (lock) { int c = super.read(); if (skipLF) { if (c == '\n') c = super.read(); skipLF = false; } switch (c) { case '\r': skipLF = true; case '\n': /* Fall through */ lineNumber++; return '\n'; } return c; } } /** * Read characters into a portion of an array. Whenever a <a * href="#lt">line terminator</a> is read the current line number is * incremented. * * @param cbuf * Destination buffer * * @param off * Offset at which to start storing characters * * @param len * Maximum number of characters to read * * @return The number of bytes read, or -1 if the end of the stream has * already been reached * * @throws IOException * If an I/O error occurs */ public int read(char cbuf[], int off, int len) throws IOException { synchronized (lock) { int n = super.read(cbuf, off, len); for (int i = off; i < off + n; i++) { int c = cbuf[i]; if (skipLF) { skipLF = false; if (c == '\n') continue; } switch (c) { case '\r': skipLF = true; case '\n': /* Fall through */ lineNumber++; break; } } return n; } } /** * Read a line of text. Whenever a <a href="#lt">line terminator</a> is * read the current line number is incremented. * * @return A String containing the contents of the line, not including * any <a href="#lt">line termination characters</a>, or * <tt>null</tt> if the end of the stream has been reached * * @throws IOException * If an I/O error occurs */ public String readLine() throws IOException { synchronized (lock) { String l = super.readLine(skipLF); skipLF = false; if (l != null) lineNumber++; return l; } } /** Maximum skip-buffer size */ private static final int maxSkipBufferSize = 8192; /** Skip buffer, null until allocated */ private char skipBuffer[] = null; /** * Skip characters. * * @param n * The number of characters to skip * * @return The number of characters actually skipped * * @throws IOException * If an I/O error occurs * * @throws IllegalArgumentException * If <tt>n</tt> is negative */ public long skip(long n) throws IOException { if (n < 0) throw new IllegalArgumentException("skip() value is negative"); int nn = (int) Math.min(n, maxSkipBufferSize); synchronized (lock) { if ((skipBuffer == null) || (skipBuffer.length < nn)) skipBuffer = new char[nn]; long r = n; while (r > 0) { int nc = read(skipBuffer, 0, (int) Math.min(r, nn)); if (nc == -1) break; r -= nc; } return n - r; } } /** * Mark the present position in the stream. Subsequent calls to reset() * will attempt to reposition the stream to this point, and will also reset * the line number appropriately. * * @param readAheadLimit * Limit on the number of characters that may be read while still * preserving the mark. After reading this many characters, * attempting to reset the stream may fail. * * @throws IOException * If an I/O error occurs */ public void mark(int readAheadLimit) throws IOException { synchronized (lock) { super.mark(readAheadLimit); markedLineNumber = lineNumber; markedSkipLF = skipLF; } } /** * Reset the stream to the most recent mark. * * @throws IOException * If the stream has not been marked, or if the mark has been * invalidated */ public void reset() throws IOException { synchronized (lock) { super.reset(); lineNumber = markedLineNumber; skipLF = markedSkipLF; } } }