1 /*
2  * Copyright (c) 2015, 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 
26 package jdk.nashorn.api.tree;
27 
28 /**
29  * Provides methods to convert between character positions and line numbers
30  * for a compilation unit.
31  *
32  * @deprecated Nashorn JavaScript script engine and APIs, and the jjs tool
33  * are deprecated with the intent to remove them in a future release.
34  *
35  * @since 9
36  */
37 @Deprecated(since="11", forRemoval=true)
38 public interface LineMap {
39     /**
40      * Find the line containing a position; a line termination
41      * character is on the line it terminates.
42      *
43      * @param   pos  character offset of the position
44      * @return the line number of pos (first line is 1)
45      */
getLineNumber(long pos)46     long getLineNumber(long pos);
47 
48     /**
49      * Find the column for a character position.
50      * Tab characters preceding the position on the same line
51      * will be expanded when calculating the column number.
52      *
53      * @param  pos   character offset of the position
54      * @return       the tab-expanded column number of pos (first column is 1)
55      */
getColumnNumber(long pos)56     long getColumnNumber(long pos);
57 }
58