Mercurial > hg > graal-compiler

annotate graal/com.oracle.truffle.api/src/com/oracle/truffle/api/source/LineLocation.java @ 18986:50b22daf6d53

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle/Source: add default comparator for LineLocation
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Tue, 27 Jan 2015 20:25:26 -0800
parents e3c95cbbb50c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16068
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
1 /*
18986
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
2 * Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
16068
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
4 *
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
10 *
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
15 * accompanied this code).
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
16 *
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
20 *
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
23 * questions.
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
24 */
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
25 package com.oracle.truffle.api.source;
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
26
18986
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
27 import java.util.*;
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
28
16068
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
29 /**
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
30 * A specification for a location in guest language source, expressed as a line number in a specific
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
31 * instance of {@link Source}, suitable for hash table keys with equality defined in terms of
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
32 * content.
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
33 */
16130
6f7d3f3703d3 Truffle/Source:
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 16068
diff changeset
34 public interface LineLocation {
16068
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
35
18163
c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings
Doug Simon <doug.simon@oracle.com>
parents: 16130
diff changeset
36 Source getSource();
16068
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
37
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
38 /**
18163
c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings
Doug Simon <doug.simon@oracle.com>
parents: 16130
diff changeset
39 * Gets the 1-based number of a line in the source.
16068
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
40 */
18163
c88ab4f1f04a re-enabled Checkstyle with the release of 6.0 that supports Java 8; fixed existing Checkstyle warnings
Doug Simon <doug.simon@oracle.com>
parents: 16130
diff changeset
41 int getLineNumber();
16068
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
42
18485
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests.
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18163
diff changeset
43 String getShortDescription();
e3c95cbbb50c Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests.
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18163
diff changeset
44
18986
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
45 /**
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
46 * Default comparator by (1) textual path name, (2) line number.
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
47 */
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
48 Comparator<LineLocation> COMPARATOR = new Comparator<LineLocation>() {
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
49
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
50 public int compare(LineLocation l1, LineLocation l2) {
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
51 final int sourceResult = l1.getSource().getPath().compareTo(l2.getSource().getPath());
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
52 if (sourceResult != 0) {
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
53 return sourceResult;
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
54 }
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
55 return Integer.compare(l1.getLineNumber(), l2.getLineNumber());
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
56 }
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
57
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
58 };
50b22daf6d53 Truffle/Source: add default comparator for LineLocation
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents: 18485
diff changeset
59
16068
74e142bd2b12 Truffle/Source: major API revision
Michael Van De Vanter <michael.van.de.vanter@oracle.com>
parents:
diff changeset
60 }