forked from KyoriPowered/adventure-platform
-
Notifications
You must be signed in to change notification settings - Fork 0
/
MinecraftReflection.java
590 lines (532 loc) · 20.5 KB
/
MinecraftReflection.java
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
/*
* This file is part of adventure-platform, licensed under the MIT License.
*
* Copyright (c) 2018-2020 KyoriPowered
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.kyori.adventure.platform.bukkit;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.MethodType;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.Arrays;
import org.bukkit.Bukkit;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import static java.util.Objects.requireNonNull;
/**
* Reflection utilities for accessing {@code net.minecraft.server}.
*/
@SuppressWarnings("FilteringWriteTag") // NON-API, no compatibility information needs tracking
final class MinecraftReflection {
private MinecraftReflection() {
}
private static final MethodHandles.Lookup LOOKUP = MethodHandles.lookup();
private static final String PREFIX_NMS = "net.minecraft.server";
private static final String PREFIX_MC = "net.minecraft.";
private static final String PREFIX_CRAFTBUKKIT = "org.bukkit.craftbukkit";
private static final String CRAFT_SERVER = "CraftServer";
private static final @Nullable String VERSION;
static {
final Class<?> serverClass = Bukkit.getServer().getClass(); // TODO: use reflection here too?
if (!serverClass.getSimpleName().equals(CRAFT_SERVER)) {
VERSION = null;
} else if (serverClass.getName().equals(PREFIX_CRAFTBUKKIT + "." + CRAFT_SERVER)) {
VERSION = ".";
} else {
String name = serverClass.getName();
name = name.substring(PREFIX_CRAFTBUKKIT.length());
name = name.substring(0, name.length() - CRAFT_SERVER.length());
VERSION = name;
}
}
/**
* Gets a class by the first name available.
*
* @param classNames an array of class names to try in order
* @return a class or {@code null} if not found
*/
public static @Nullable Class<?> findClass(final @Nullable String@NotNull... classNames) {
for (final String clazz : classNames) {
if (clazz == null) continue;
try {
final Class<?> classObj = Class.forName(clazz);
return classObj;
} catch (final ClassNotFoundException e) {
}
}
return null;
}
/**
* Gets a {@code net.minecraft} class.
*
* @param className a class name, without the {@code net.minecraft} prefix
* @return a class
* @throws NullPointerException if the class was not found
*/
public static @NotNull Class<?> needClass(final @Nullable String@NotNull... className) {
return requireNonNull(findClass(className), "Could not find class from candidates" + Arrays.toString(className));
}
/**
* Gets whether a class is available.
*
* @param classNames an array of class names to try in order
* @return if the class is loaded
*/
public static boolean hasClass(final @NotNull String... classNames) {
return findClass(classNames) != null;
}
/**
* Gets a handle for a class method.
*
* @param holderClass a class
* @param methodName a method name
* @param returnClass a method return class
* @param parameterClasses an array of method parameter classes
* @return a method handle or {@code null} if not found
*/
public static @Nullable MethodHandle findMethod(final @Nullable Class<?> holderClass, final String methodName, final @Nullable Class<?> returnClass, final Class<?>... parameterClasses) {
return findMethod(holderClass, new String[] {methodName}, returnClass, parameterClasses);
}
/**
* Gets a handle for a class method.
*
* @param holderClass a class
* @param methodNames a method name
* @param returnClass a method return class
* @param parameterClasses an array of method parameter classes
* @return a method handle or {@code null} if not found
*/
public static @Nullable MethodHandle findMethod(final @Nullable Class<?> holderClass, final @Nullable String@NotNull[] methodNames, final @Nullable Class<?> returnClass, final Class<?>... parameterClasses) {
if (holderClass == null || returnClass == null) return null;
for (final Class<?> parameterClass : parameterClasses) {
if (parameterClass == null) return null;
}
for (final String methodName : methodNames) {
if (methodName == null) continue;
try {
return LOOKUP.findVirtual(holderClass, methodName, MethodType.methodType(returnClass, parameterClasses));
} catch (final NoSuchMethodException | IllegalAccessException e) {
}
}
return null;
}
/**
* Search a handle for a class method.
*
* @param holderClass a class
* @param modifier method modifiers
* @param methodName a method name
* @param returnClass a method return class
* @param parameterClasses an array of method parameter classes
* @return a method handle or {@code null} if not found
*/
public static MethodHandle searchMethod(final @Nullable Class<?> holderClass, final @Nullable Integer modifier, final String methodName, final @Nullable Class<?> returnClass, final Class<?>... parameterClasses) {
return searchMethod(holderClass, modifier, new String[] {methodName}, returnClass, parameterClasses);
}
/**
* Search a handle for a class method.
*
* @param holderClass a class
* @param modifier method modifiers
* @param methodNames a method names
* @param returnClass a method return class
* @param parameterClasses an array of method parameter classes
* @return a method handle or {@code null} if not found
*/
public static MethodHandle searchMethod(final @Nullable Class<?> holderClass, final @Nullable Integer modifier, final @Nullable String@NotNull[] methodNames, final @Nullable Class<?> returnClass, final Class<?>... parameterClasses) {
if (holderClass == null || returnClass == null) return null;
for (final Class<?> parameterClass : parameterClasses) {
if (parameterClass == null) return null;
}
for (final String methodName : methodNames) {
if (methodName == null) continue;
try {
if (modifier != null && Modifier.isStatic(modifier)) {
return LOOKUP.findStatic(holderClass, methodName, MethodType.methodType(returnClass, parameterClasses));
} else {
return LOOKUP.findVirtual(holderClass, methodName, MethodType.methodType(returnClass, parameterClasses));
}
} catch (final NoSuchMethodException | IllegalAccessException e) {
}
}
for (final Method method : holderClass.getDeclaredMethods()) {
if ((modifier == null || (method.getModifiers() & modifier) == 0)
|| !Arrays.equals(method.getParameterTypes(), parameterClasses)) continue;
try {
if (Modifier.isStatic(modifier)) {
return LOOKUP.findStatic(holderClass, method.getName(), MethodType.methodType(returnClass, parameterClasses));
} else {
return LOOKUP.findVirtual(holderClass, method.getName(), MethodType.methodType(returnClass, parameterClasses));
}
} catch (final NoSuchMethodException | IllegalAccessException e) {
}
}
return null;
}
/**
* Gets a handle for a class method.
*
* @param holderClass a class
* @param methodNames a method name
* @param returnClass a method return class
* @param parameterClasses an array of method parameter classes
* @return a method handle or {@code null} if not found
*/
public static @Nullable MethodHandle findStaticMethod(final @Nullable Class<?> holderClass, final String methodNames, final @Nullable Class<?> returnClass, final Class<?>... parameterClasses) {
return findStaticMethod(holderClass, new String[]{methodNames}, returnClass, parameterClasses);
}
/**
* Gets a handle for a class method.
*
* @param holderClass a class
* @param methodNames a method name
* @param returnClass a method return class
* @param parameterClasses an array of method parameter classes
* @return a method handle or {@code null} if not found
*/
public static @Nullable MethodHandle findStaticMethod(final @Nullable Class<?> holderClass, final String[] methodNames, final @Nullable Class<?> returnClass, final Class<?>... parameterClasses) {
if (holderClass == null || returnClass == null) return null;
for (final Class<?> parameterClass : parameterClasses) {
if (parameterClass == null) return null;
}
for (final String methodName : methodNames) {
try {
return LOOKUP.findStatic(holderClass, methodName, MethodType.methodType(returnClass, parameterClasses));
} catch (final NoSuchMethodException | IllegalAccessException e) {
}
}
return null;
}
/**
* Gets whether a class has a method.
*
* @param holderClass a class
* @param names field name candidates, will be checked in order
* @param type the field type
* @return if the method exists
*/
public static boolean hasField(final @Nullable Class<?> holderClass, final Class<?> type, final String... names) {
if (holderClass == null) return false;
for (final String name : names) {
try {
final Field field = holderClass.getDeclaredField(name);
if (field.getType() == type) return true;
} catch (final NoSuchFieldException e) {
// continue
}
}
return false;
}
/**
* Gets whether a class has a method.
*
* @param holderClass a class
* @param methodName a method name
* @param parameterClasses an array of method parameter classes
* @return if the method exists
*/
public static boolean hasMethod(final @Nullable Class<?> holderClass, final String methodName, final Class<?>... parameterClasses) {
return hasMethod(holderClass, new String[] {methodName}, parameterClasses);
}
/**
* Gets whether a class has a method.
*
* @param holderClass a class
* @param methodNames a method name
* @param parameterClasses an array of method parameter classes
* @return if the method exists
*/
public static boolean hasMethod(final @Nullable Class<?> holderClass, final String[] methodNames, final Class<?>... parameterClasses) {
if (holderClass == null) return false;
for (final Class<?> parameterClass : parameterClasses) {
if (parameterClass == null) return false;
}
for (final String methodName : methodNames) {
try {
holderClass.getMethod(methodName, parameterClasses);
return true;
} catch (final NoSuchMethodException e) {
}
}
return false;
}
/**
* Gets a handle for a class constructor.
*
* @param holderClass a class
* @param parameterClasses an array of method parameter classes
* @return a method handle or {@code null} if not found
*/
public static @Nullable MethodHandle findConstructor(final @Nullable Class<?> holderClass, final @Nullable Class<?>... parameterClasses) {
if (holderClass == null) return null;
for (final Class<?> parameterClass : parameterClasses) {
if (parameterClass == null) return null;
}
try {
return LOOKUP.findConstructor(holderClass, MethodType.methodType(void.class, parameterClasses));
} catch (final NoSuchMethodException | IllegalAccessException e) {
return null;
}
}
/**
* Gets a class field and makes it accessible.
*
* @param holderClass a class
* @param fieldName a field name
* @return an accessible field
* @throws NoSuchFieldException when thrown by {@link Class#getDeclaredField(String)}
*/
public static @NotNull Field needField(final @NotNull Class<?> holderClass, final @NotNull String fieldName) throws NoSuchFieldException {
final Field field = holderClass.getDeclaredField(fieldName);
field.setAccessible(true);
return field;
}
/**
* Gets a class field if possible and makes it accessible.
*
* @param holderClass a class
* @param fieldName a field name
* @return an accessible field
*/
public static @Nullable Field findField(final @Nullable Class<?> holderClass, final @NotNull String... fieldName) {
return findField(holderClass, null, fieldName);
}
/**
* Gets a class field if it exists and is of the appropriate type and makes it accessible.
*
* @param holderClass a class
* @param expectedType the expected type of the field
* @param fieldNames a field name
* @return an accessible field
*/
public static @Nullable Field findField(final @Nullable Class<?> holderClass, final @Nullable Class<?> expectedType, final @NotNull String... fieldNames) {
if (holderClass == null) return null;
Field field;
for (final String fieldName : fieldNames) {
try {
field = holderClass.getDeclaredField(fieldName);
} catch (final NoSuchFieldException ex) {
continue;
}
field.setAccessible(true);
if (expectedType != null && !expectedType.isAssignableFrom(field.getType())) {
continue;
}
return field;
}
return null;
}
/**
* Return a method handle that can set the value of the provided field.
*
* @param field the field to set
* @return a handle, if accessible
*/
public static @Nullable MethodHandle findSetterOf(final @Nullable Field field) {
if (field == null) return null;
try {
return LOOKUP.unreflectSetter(field);
} catch (final IllegalAccessException e) {
return null;
}
}
/**
* Return a method handle that can get the value of the provided field.
*
* @param field the field to get
* @return a handle, if accessible
*/
public static @Nullable MethodHandle findGetterOf(final @Nullable Field field) {
if (field == null) return null;
try {
return LOOKUP.unreflectGetter(field);
} catch (final IllegalAccessException e) {
return null;
}
}
/**
* Gets an enum value.
*
* @param enumClass an enum class
* @param enumName an enum name
* @return an enum value or {@code null} if not found
*/
public static @Nullable Object findEnum(final @Nullable Class<?> enumClass, final @NotNull String enumName) {
return findEnum(enumClass, enumName, Integer.MAX_VALUE);
}
/**
* Gets an enum value.
*
* @param enumClass an enum class
* @param enumName an enum name
* @param enumFallbackOrdinal an enum ordinal, when the name is not found
* @return an enum value or {@code null} if not found
*/
@SuppressWarnings("unchecked")
public static @Nullable Object findEnum(final @Nullable Class<?> enumClass, final @NotNull String enumName, final int enumFallbackOrdinal) {
if (enumClass == null || !Enum.class.isAssignableFrom(enumClass)) {
return null;
}
try {
return Enum.valueOf(enumClass.asSubclass(Enum.class), enumName);
} catch (final IllegalArgumentException e) {
final Object[] constants = enumClass.getEnumConstants();
if (constants.length > enumFallbackOrdinal) {
return constants[enumFallbackOrdinal];
}
}
return null;
}
/**
* Gets whether CraftBukkit is available.
*
* @return if CraftBukkit is available
*/
public static boolean isCraftBukkit() {
return VERSION != null;
}
/**
* Gets a {@code org.bukkit.craftbukkit} class name.
*
* @param className a class name, without the {@code org.bukkit.craftbukkit} prefix
* @return a class name or {@code null} if not found
*/
public static @Nullable String findCraftClassName(final @NotNull String className) {
return isCraftBukkit() ? PREFIX_CRAFTBUKKIT + VERSION + className : null;
}
/**
* Gets a {@code org.bukkit.craftbukkit} class.
*
* @param className a class name, without the {@code org.bukkit.craftbukkit} prefix
* @return a class or {@code null} if not found
*/
public static @Nullable Class<?> findCraftClass(final @NotNull String className) {
final String craftClassName = findCraftClassName(className);
if (craftClassName == null) {
return null;
}
return findClass(craftClassName);
}
/**
* Gets a {@code org.bukkit.craftbukkit} class.
*
* @param className a class name, without the {@code org.bukkit.craftbukkit} prefix
* @param superClass a super class
* @param <T> a super type
* @return a class or {@code null} if not found
*/
public static <T> @Nullable Class<? extends T> findCraftClass(final @NotNull String className, final @NotNull Class<T> superClass) {
final Class<?> craftClass = findCraftClass(className);
if (craftClass == null || !requireNonNull(superClass, "superClass").isAssignableFrom(craftClass)) {
return null;
}
return craftClass.asSubclass(superClass);
}
/**
* Gets a {@code org.bukkit.craftbukkit} class.
*
* @param className a class name, without the {@code org.bukkit.craftbukkit} prefix
* @return a class
* @throws NullPointerException if the class was not found
*/
public static @NotNull Class<?> needCraftClass(final @NotNull String className) {
return requireNonNull(findCraftClass(className), "Could not find org.bukkit.craftbukkit class " + className);
}
/**
* Gets a {@code net.minecraft.server} class name.
*
* @param className a class name, without the {@code net.minecraft.server} prefix
* @return a class name or {@code null} if not found
*/
public static @Nullable String findNmsClassName(final @NotNull String className) {
return isCraftBukkit() ? PREFIX_NMS + VERSION + className : null;
}
/**
* Get a {@code net.minecraft.server} class.
*
* @param className a class name, without the {@code net.minecraft.server} prefix
* @return a class name or {@code null} if not found
*/
public static @Nullable Class<?> findNmsClass(final @NotNull String className) {
final String nmsClassName = findNmsClassName(className);
if (nmsClassName == null) {
return null;
}
return findClass(nmsClassName);
}
/**
* Gets a {@code net.minecraft.server} class.
*
* @param className a class name, without the {@code org.bukkit.craftbukkit} prefix
* @return a class
* @throws NullPointerException if the class was not found
*/
public static @NotNull Class<?> needNmsClass(final @NotNull String className) {
return requireNonNull(findNmsClass(className), "Could not find net.minecraft.server class " + className);
}
/**
* Gets a {@code net.minecraft} class name.
*
* @param className a class name, without the {@code net.minecraft} prefix
* @return a class name or {@code null} if not found
*/
public static @Nullable String findMcClassName(final @NotNull String className) {
return isCraftBukkit() ? PREFIX_MC + className : null;
}
/**
* Get a {@code net.minecraft} class.
*
* @param classNames a class name, without the {@code net.minecraft} prefix
* @return a class name or {@code null} if not found
*/
public static @Nullable Class<?> findMcClass(final @NotNull String... classNames) {
for (final String clazz : classNames) {
final String nmsClassName = findMcClassName(clazz);
if (nmsClassName != null) {
final Class<?> candidate = findClass(nmsClassName);
if (candidate != null) {
return candidate;
}
}
}
return null;
}
/**
* Gets a {@code net.minecraft} class.
*
* @param className a class name, without the {@code net.minecraft} prefix
* @return a class
* @throws NullPointerException if the class was not found
*/
public static @NotNull Class<?> needMcClass(final @NotNull String... className) {
return requireNonNull(findMcClass(className), "Could not find net.minecraft class from candidates" + Arrays.toString(className));
}
/**
* Gets the singleton method handle lookup.
*
* @return the method handle lookup
*/
public static MethodHandles.@NotNull Lookup lookup() {
return LOOKUP;
}
}