duke@1: /*
ohair@554:  * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javac.parser;
duke@1: 
duke@1: import com.sun.tools.javac.util.*;
duke@1: import com.sun.tools.javac.util.Position.LineMap;
duke@1: 
duke@1: /**
duke@1:  * The lexical analyzer maps an input stream consisting of ASCII
duke@1:  * characters and Unicode escapes into a token sequence.
duke@1:  *
jjg@581:  * <p><b>This is NOT part of any supported API.
duke@1:  * If you write code that depends on this, you do so at your own risk.
duke@1:  * This code and its internal interfaces are subject to change or
duke@1:  * deletion without notice.</b>
duke@1:  */
duke@1: public interface Lexer {
duke@1: 
duke@1:     /**
duke@1:      * Has a @deprecated been encountered in last doc comment?
duke@1:      * This needs to be reset by client with resetDeprecatedFlag.
duke@1:      */
duke@1:     boolean deprecatedFlag();
duke@1: 
duke@1:     void resetDeprecatedFlag();
duke@1: 
duke@1:     /**
duke@1:      * Returns the documentation string of the current token.
duke@1:      */
duke@1:     String docComment();
duke@1: 
duke@1:     /**
duke@1:      * Return the last character position of the current token.
duke@1:      */
duke@1:     int endPos();
duke@1: 
duke@1:     /**
duke@1:      * Return the position where a lexical error occurred;
duke@1:      */
duke@1:     int errPos();
duke@1: 
duke@1:     /**
duke@1:      * Set the position where a lexical error occurred;
duke@1:      */
duke@1:     void errPos(int pos);
duke@1: 
duke@1:     /**
duke@1:      * Build a map for translating between line numbers and
duke@1:      * positions in the input.
duke@1:      *
duke@1:      * @return a LineMap
duke@1:      */
duke@1:     LineMap getLineMap();
duke@1: 
duke@1:     /**
duke@1:      * Returns a copy of the input buffer, up to its inputLength.
duke@1:      * Unicode escape sequences are not translated.
duke@1:      */
duke@1:     char[] getRawCharacters();
duke@1: 
duke@1:     /**
duke@1:      * Returns a copy of a character array subset of the input buffer.
duke@1:      * The returned array begins at the <code>beginIndex</code> and
duke@1:      * extends to the character at index <code>endIndex - 1</code>.
duke@1:      * Thus the length of the substring is <code>endIndex-beginIndex</code>.
duke@1:      * This behavior is like
duke@1:      * <code>String.substring(beginIndex, endIndex)</code>.
duke@1:      * Unicode escape sequences are not translated.
duke@1:      *
duke@1:      * @param beginIndex the beginning index, inclusive.
duke@1:      * @param endIndex the ending index, exclusive.
duke@1:      * @throws IndexOutOfBounds if either offset is outside of the
duke@1:      *         array bounds
duke@1:      */
duke@1:     char[] getRawCharacters(int beginIndex, int endIndex);
duke@1: 
duke@1:     /**
duke@1:      * Return the name of an identifier or token for the current token.
duke@1:      */
duke@1:     Name name();
duke@1: 
duke@1:     /**
duke@1:      * Read token.
duke@1:      */
duke@1:     void nextToken();
duke@1: 
duke@1:     /**
duke@1:      * Return the current token's position: a 0-based
duke@1:      *  offset from beginning of the raw input stream
duke@1:      *  (before unicode translation)
duke@1:      */
duke@1:     int pos();
duke@1: 
duke@1:     /**
duke@1:      * Return the last character position of the previous token.
duke@1:      */
duke@1:     int prevEndPos();
duke@1: 
duke@1:     /**
duke@1:      * Return the radix of a numeric literal token.
duke@1:      */
duke@1:     int radix();
duke@1: 
duke@1:     /**
duke@1:      * The value of a literal token, recorded as a string.
duke@1:      *  For integers, leading 0x and 'l' suffixes are suppressed.
duke@1:      */
duke@1:     String stringVal();
duke@1: 
duke@1:     /**
duke@1:      * Return the current token, set by nextToken().
duke@1:      */
duke@1:     Token token();
duke@1: 
duke@1:     /**
duke@1:      * Sets the current token.
duke@1:      */
duke@1:     void token(Token token);
duke@1: }