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: 
mcimadamore@1113: import com.sun.tools.javac.parser.Tokens.*;
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:     /**
mcimadamore@1113:      * Consume the next token.
duke@1:      */
mcimadamore@1113:     void nextToken();
duke@1: 
duke@1:     /**
mcimadamore@1113:      * Return current token.
duke@1:      */
mcimadamore@1113:     Token token();
duke@1: 
duke@1:     /**
mcimadamore@1113:      * Return the last character position of the previous token.
duke@1:      */
mcimadamore@1113:     Token prevToken();
mcimadamore@1113: 
mcimadamore@1113:     /**
mcimadamore@1113:      * Splits the current token in two and return the first (splitted) token.
mcimadamore@1113:      * For instance '<<<' is splitted into two tokens '<' and '<<' respectively,
mcimadamore@1113:      * and the latter is returned.
mcimadamore@1113:      */
mcimadamore@1113:     Token split();
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: }