1/* 2 * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package com.sun.tools.javac.parser; 27 28import com.sun.tools.javac.parser.Tokens.*; 29import com.sun.tools.javac.util.Position.LineMap; 30 31/** 32 * The lexical analyzer maps an input stream consisting of ASCII 33 * characters and Unicode escapes into a token sequence. 34 * 35 * <p><b>This is NOT part of any supported API. 36 * If you write code that depends on this, you do so at your own risk. 37 * This code and its internal interfaces are subject to change or 38 * deletion without notice.</b> 39 */ 40public interface Lexer { 41 42 /** 43 * Consume the next token. 44 */ 45 void nextToken(); 46 47 /** 48 * Return current token. 49 */ 50 Token token(); 51 52 /** 53 * Return token with given lookahead. 54 */ 55 Token token(int lookahead); 56 57 /** 58 * Return the last character position of the previous token. 59 */ 60 Token prevToken(); 61 62 /** 63 * Splits the current token in two and return the first (splitted) token. 64 * For instance {@literal '<<<'} is split into two tokens 65 * {@literal '<'} and {@literal '<<'} respectively, 66 * and the latter is returned. 67 */ 68 Token split(); 69 70 /** 71 * Return the position where a lexical error occurred; 72 */ 73 int errPos(); 74 75 /** 76 * Set the position where a lexical error occurred; 77 */ 78 void errPos(int pos); 79 80 /** 81 * Build a map for translating between line numbers and 82 * positions in the input. 83 * 84 * @return a LineMap 85 */ 86 LineMap getLineMap(); 87} 88