1 /* 2 * Copyright (c) 2020, 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 27 package jdk.incubator.jextract; 28 29 import java.nio.file.Path; 30 31 /** 32 * Instances of this class model are used to model source code positions. 33 */ 34 public interface Position { 35 36 /** 37 * The input file to which this position refers to. 38 * @return The input file to which this position refers to. 39 */ 40 Path path(); 41 42 /** 43 * The line number associated with this position. 44 * @return The line number associated with this position. 45 */ 46 int line(); 47 48 /** 49 * The column number associated with this position. 50 * @return The column number associated with this position. 51 */ 52 int col(); 53 54 /** 55 * An empty position instance; this can be used to model <em>synthetic</em> program elements which are not 56 * defined in any input file. 57 */ 58 Position NO_POSITION = new Position() { 59 @Override 60 public Path path() { 61 return null; 62 } 63 64 @Override 65 public int line() { 66 return 0; 67 } 68 69 @Override 70 public int col() { 71 return 0; 72 } 73 }; 74 }