File: MethodDescriptor.java

package info (click to toggle)
openjdk-11 11.0.22%2B7-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 781,236 kB
  • sloc: java: 5,174,754; xml: 1,192,262; cpp: 1,133,036; ansic: 461,316; javascript: 162,554; sh: 16,859; objc: 13,683; python: 4,753; asm: 3,570; makefile: 2,894; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (207 lines) | stat: -rw-r--r-- 6,897 bytes parent folder | download | duplicates (19)
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*
 * Copyright (c) 2015, 2016, 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.
 *
 * 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 compiler.compilercontrol.share.method;

import jdk.test.lib.util.Triple;

import java.lang.reflect.Executable;
import java.util.function.Function;
import java.util.regex.Pattern;

/**
 * Method descriptor for Compiler Control commands.
 * It represents method pattern used for matching in Compiler Control
 * and CompileCommand option
 */
public class MethodDescriptor {
    public final ClassType aClass;         // Represents class and package
    public final MethodType aMethod;       // Represents method
    public final SignatureType aSignature; // Represents signature

    /**
     * Constructor
     *
     * @param method executable to build method descriptor from
     */
    public MethodDescriptor(Executable method) {
        aClass = new ClassType(method);
        aMethod = new MethodType(method);
        aSignature = new SignatureType(method);
    }

    /**
     * Sets signature separators for all elements
     */
    public void setSeparators(
            Triple<Separator, Separator, Separator> separators) {
        aClass.setSeparator(separators.getFirst());
        aMethod.setSeparator(separators.getSecond());
        aSignature.setSeparator(separators.getThird());
    }

    /**
     * Sets custom strings for each element
     */
    public void setStrings(Triple<String, String, String> strings) {
        aClass.setElement(strings.getFirst());
        aMethod.setElement(strings.getSecond());
        aSignature.setElement(strings.getThird());
    }

    /**
     * Sets patterns for all elements
     */
    public void setPatterns(
            Triple<PatternType, PatternType, PatternType> patterns) {
        aClass.setPattern(patterns.getFirst());
        aMethod.setPattern(patterns.getSecond());
        aSignature.setPattern(patterns.getThird());
    }

    /**
     * Separates elements in the MethodDescriptor
     */
    public static enum Separator {
        SLASH("/"),
        DOT("."),
        COMMA(","),
        DOUBLECOLON("::"),
        SPACE(" "),
        NONE("");

        public final String symbol;

        Separator(String symbol) {
            this.symbol = symbol;
        }

        /**
         * Validates method descriptor separators
         *
         * @param md method descriptor to validate
         * @return true if descriptor's separators are valid
         */
        public static boolean isValid(MethodDescriptor md) {
            Separator cls = md.getClassSeparator();
            Separator method = md.getMethodSeparator();
            Separator sign = md.getSignatureSeparator();
            if (sign == SPACE || sign == NONE || sign == COMMA) {
                // if it looks like java/lang/String.indexOf
                if ((cls == SLASH || cls == NONE)
                        // allow space and comma instead of dot
                        && (method == DOT || method == SPACE
                        || method == COMMA)) {
                    return true;
                }
                // if it looks like java.lang.String::indexOf
                if ((cls == DOT || cls == NONE) && method == DOUBLECOLON) {
                    return true;
                }
            }
            return false;
        }
    }

    /**
     * Type of the pattern
     */
    public static enum PatternType {
        PREFIX,
        ANY,
        SUFFIX,
        SUBSTRING,
        EXACT
    }

    public Separator getClassSeparator() {
        return aClass.getSeparator();
    }

    public Separator getMethodSeparator() {
        return aMethod.getSeparator();
    }

    public Separator getSignatureSeparator() {
        return aSignature.getSeparator();
    }

    /**
     * Gets regular expression to match methods
     *
     * @return string representation of the regular expression
     */
    public String getRegexp() {
        // regexp should have a . as a method separator
        // and / as a package/class separator
        return aClass.getRegexp().replaceAll("\\.", "/")
                .replaceAll("/\\*", ".*")
                + Pattern.quote(Separator.DOT.symbol)
                + aMethod.getRegexp() + aSignature.getRegexp();
    }

    /**
     * Gets method descriptor string representation.
     * This string is used as a pattern in CompilerControl and CompileCommand
     */
    public String getString() {
        return aClass.getElement() + getMethodSeparator().symbol
                + aMethod.getElement() + getSignatureSeparator().symbol
                + aSignature.getElement();
    }

    /**
     * Convert method descriptor to be regexp-compatible
     *
     * @return string representation of the method signature
     */
    public String getCanonicalString() {
        return aClass.getElement().replaceAll("\\.", "/") + Separator.DOT.symbol
                + aMethod.getElement() + aSignature.getElement();
    }

    /**
     * Shows if this descriptor is a valid pattern for CompilerControl
     *
     * @return true, if descriptor is valid, false otherwise
     */
    public boolean isValid() {
        return aClass.isValid() && aMethod.isValid() && aSignature.isValid()
                && Separator.isValid(this);
    }

    /**
     * Sets custom string from element mutate function
     * to the appropriate element of method descriptor
     */
    public void applyMutates(Triple<Function<String, String>,
                             Function<String, String>,
                             Function<String, String>> mutators) {
        String elementString = aClass.getElement();
        aClass.setElement(mutators.getFirst().apply(elementString));
        elementString = aMethod.getElement();
        aMethod.setElement(mutators.getSecond().apply(elementString));
        elementString = aSignature.getElement();
        aSignature.setElement(mutators.getThird().apply(elementString));
    }
}