aboutsummaryrefslogtreecommitdiff
path: root/src/jdk/nashorn/internal/ir/Location.java
blob: c8e01dd35f868b8511265589a4c9fb6e270fcaf9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.nashorn.internal.ir;

import java.util.Objects;
import jdk.nashorn.internal.parser.Token;
import jdk.nashorn.internal.parser.TokenType;
import jdk.nashorn.internal.runtime.Source;

/**
 * Used to locate an entity back to it's source file.
 *
 */

public class Location implements Cloneable {
    /** Source of entity. */
    private final Source source;

    /** Token descriptor. */
    private final long token;

    /**
     * Constructor
     *
     * @param source the source
     * @param token  token
     */
    public Location(final Source source, final long token) {
        this.source = source;
        this.token = token;
    }

    /**
     * Copy constructor
     *
     * @param location source node
     */
    protected Location(final Location location) {
        this.source = location.source;
        this.token = location.token;
    }

    @Override
    protected Object clone() {
        try {
            return super.clone();
        } catch(CloneNotSupportedException e) {
            throw new AssertionError(e);
        }
    }

    @Override
    public boolean equals(final Object other) {
        if (other == null) {
            return false;
        }

        if (other.getClass() != this.getClass()) {
            return false;
        }

        final Location loc = (Location)other;
        return token == loc.token && Objects.equals(source, loc.source);
    }

    @Override
    public int hashCode() {
        return Token.hashCode(token) ^ Objects.hashCode(source);
    }

    /**
     * Return token position from a token descriptor.
     *
     * @return Start position of the token in the source.
     */
    public int position() {
        return Token.descPosition(token);
    }

    /**
     * Return token length from a token descriptor.
     *
     * @return Length of the token.
     */
    public int length() {
        return Token.descLength(token);
    }

    /**
     * Return token tokenType from a token descriptor.
     *
     * @return Type of token.
     */
    public TokenType tokenType() {
        return Token.descType(token);
    }

    /**
     * Test token tokenType.
     *
     * @param type a type to check this token against
     * @return true if token types match.
     */
    public boolean isTokenType(final TokenType type) {
        return Token.descType(token) == type;
    }

    /**
     * Get the source for this location
     * @return the source
     */
    public Source getSource() {
        return source;
    }

    /**
     * Get the token for this location
     * @return the token
     */
    public long getToken() {
        return token;
    }
}