Thu, 31 Aug 2017 15:17:03 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.source.tree; |
aoqi@0 | 27 | |
aoqi@0 | 28 | /** |
aoqi@0 | 29 | * Provides methods to convert between character positions and line numbers |
aoqi@0 | 30 | * for a compilation unit. |
aoqi@0 | 31 | * |
aoqi@0 | 32 | * @since 1.6 |
aoqi@0 | 33 | */ |
aoqi@0 | 34 | @jdk.Exported |
aoqi@0 | 35 | public interface LineMap { |
aoqi@0 | 36 | /** |
aoqi@0 | 37 | * Find the start position of a line. |
aoqi@0 | 38 | * |
aoqi@0 | 39 | * @param line line number (beginning at 1) |
aoqi@0 | 40 | * @return position of first character in line |
aoqi@0 | 41 | * @throws IndexOutOfBoundsException |
aoqi@0 | 42 | * if {@code lineNumber < 1} |
aoqi@0 | 43 | * if {@code lineNumber > no. of lines} |
aoqi@0 | 44 | */ |
aoqi@0 | 45 | long getStartPosition(long line); |
aoqi@0 | 46 | |
aoqi@0 | 47 | /** |
aoqi@0 | 48 | * Find the position corresponding to a (line,column). |
aoqi@0 | 49 | * |
aoqi@0 | 50 | * @param line line number (beginning at 1) |
aoqi@0 | 51 | * @param column tab-expanded column number (beginning 1) |
aoqi@0 | 52 | * |
aoqi@0 | 53 | * @return position of character |
aoqi@0 | 54 | * @throws IndexOutOfBoundsException |
aoqi@0 | 55 | * if {@code line < 1} |
aoqi@0 | 56 | * if {@code line > no. of lines} |
aoqi@0 | 57 | */ |
aoqi@0 | 58 | long getPosition(long line, long column); |
aoqi@0 | 59 | |
aoqi@0 | 60 | /** |
aoqi@0 | 61 | * Find the line containing a position; a line termination |
aoqi@0 | 62 | * character is on the line it terminates. |
aoqi@0 | 63 | * |
aoqi@0 | 64 | * @param pos character offset of the position |
aoqi@0 | 65 | * @return the line number of pos (first line is 1) |
aoqi@0 | 66 | */ |
aoqi@0 | 67 | long getLineNumber(long pos); |
aoqi@0 | 68 | |
aoqi@0 | 69 | /** |
aoqi@0 | 70 | * Find the column for a character position. |
aoqi@0 | 71 | * Tab characters preceding the position on the same line |
aoqi@0 | 72 | * will be expanded when calculating the column number. |
aoqi@0 | 73 | * |
aoqi@0 | 74 | * @param pos character offset of the position |
aoqi@0 | 75 | * @return the tab-expanded column number of pos (first column is 1) |
aoqi@0 | 76 | */ |
aoqi@0 | 77 | long getColumnNumber(long pos); |
aoqi@0 | 78 | |
aoqi@0 | 79 | } |