Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-add backwards-compatible Getter methods to EventValues #7382

Merged
merged 6 commits into from
Jan 7, 2025
Merged

Re-add backwards-compatible Getter methods to EventValues #7382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2670595
init commit
Efnilite Jan 3, 2025
8fffdc0
Merge branch 'dev/feature' into fix-getter-usage-2
Efnilite Jan 3, 2025
89ac1f7
fix incorrect order of typed args in getter
Efnilite Jan 3, 2025
e4df9e1
Merge remote-tracking branch 'origin/fix-getter-usage-2' into fix-get…
Efnilite Jan 3, 2025
97eb39b
oops!
Efnilite Jan 4, 2025
be10a86
Merge branch 'dev/feature' into fix-getter-usage-2
Moderocky Jan 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/main/java/ch/njol/skript/expressions/base/EventValueExpression.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,17 +153,17 @@ public boolean init() {
hasValue = converters.get(event) != null;
continue;
}
if (EventValues.hasMultipleGetters(event, type, getTime()) == Kleenean.TRUE) {
if (EventValues.hasMultipleConverters(event, type, getTime()) == Kleenean.TRUE) {
Noun typeName = Classes.getExactClassInfo(componentType).getName();
log.printError("There are multiple " + typeName.toString(true) + " in " + Utils.a(getParser().getCurrentEventName()) + " event. " +
"You must define which " + typeName + " to use.");
return false;
}
Converter<?, ? extends T> converter;
if (exact) {
converter = EventValues.getExactEventValueGetter(event, type, getTime());
converter = EventValues.getExactEventValueConverter(event, type, getTime());
} else {
converter = EventValues.getEventValueGetter(event, type, getTime());
converter = EventValues.getEventValueConverter(event, type, getTime());
}
if (converter != null) {
converters.put(event, converter);
Expand Down
131 changes: 93 additions & 38 deletions src/main/java/ch/njol/skript/registrations/EventValues.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,28 +166,38 @@ public static <T, E extends Event> void registerEventValue(
* @return The event's value
* @see #registerEventValue(Class, Class, Converter, int)
*/
@Nullable
public static <T, E extends Event> T getEventValue(E e, Class<T> c, int time) {
@SuppressWarnings("unchecked")
Converter<? super E, ? extends T> getter = getEventValueGetter((Class<E>) e.getClass(), c, time);
if (getter == null)
public static <T, E extends Event> @Nullable T getEventValue(E e, Class<T> c, int time) {
//noinspection unchecked
Converter<? super E, ? extends T> converter = getEventValueConverter((Class<E>) e.getClass(), c, time);
if (converter == null)
return null;
return getter.convert(e);
return converter.convert(e);
}

/**
* @deprecated Use {@link #getExactEventValueConverter(Class, Class, int)} instead.
*/
@Nullable
@Deprecated(forRemoval = true)
@SuppressWarnings({"removal"})
public static <T, E extends Event> Getter<? extends T, ? super E> getExactEventValueGetter(Class<E> event, Class<T> c, int time) {
return toGetter(getExactEventValueConverter(event, c, time));
}

/**
* Checks that a getter exists for the exact type. No converting or subclass checking.
* Checks that a {@link Converter} exists for the exact type. No converting or subclass checking.
*
* @param event the event class the getter will be getting from
* @param c type of getter
* @param c type of {@link Converter}
* @param time the event-value's time
* @return A getter to get values for a given type of events
* @see #registerEventValue(Class, Class, Converter, int)
* @see EventValueExpression#EventValueExpression(Class)
*/
@Nullable
@SuppressWarnings("unchecked")
public static <T, E extends Event> Converter<? super E, ? extends T> getExactEventValueGetter(Class<E> event, Class<T> c, int time) {
public static <E extends Event, T> Converter<? super E, ? extends T> getExactEventValueConverter(
Class<E> event, Class<T> c, int time
) {
List<EventValueInfo<?, ?>> eventValues = getEventValuesList(time);
// First check for exact classes matching the parameters.
for (EventValueInfo<?, ?> eventValueInfo : eventValues) {
Expand All @@ -196,54 +206,78 @@ public static <T, E extends Event> T getEventValue(E e, Class<T> c, int time) {
if (!checkExcludes(eventValueInfo, event))
return null;
if (eventValueInfo.event.isAssignableFrom(event))
//noinspection unchecked
return (Converter<? super E, ? extends T>) eventValueInfo.converter;
}
return null;
}

/**
* Checks if an event has multiple getters, including default ones.
* @deprecated Use {@link #hasMultipleConverters(Class, Class, int)} instead.
*/
@Deprecated(forRemoval = true)
public static <T, E extends Event> Kleenean hasMultipleGetters(Class<E> event, Class<T> type, int time) {
return hasMultipleConverters(event, type, time);
}

/**
* Checks if an event has multiple {@link Converter}s, including default ones.
*
* @param event the event class the getter will be getting from.
* @param type type of getter.
* @param event the event class the {@link Converter} will be getting from.
* @param type type of {@link Converter}.
* @param time the event-value's time.
* @return true or false if the event and type have multiple getters.
* @return true or false if the event and type have multiple {@link Converter}s.
*/
public static <T, E extends Event> Kleenean hasMultipleGetters(Class<E> event, Class<T> type, int time) {
List<Converter<? super E, ? extends T>> getters = getEventValueGetters(event, type, time, true, false);
public static <T, E extends Event> Kleenean hasMultipleConverters(Class<E> event, Class<T> type, int time) {
List<Converter<? super E, ? extends T>> getters = getEventValueConverters(event, type, time, true, false);
if (getters == null)
return Kleenean.UNKNOWN;
return Kleenean.get(getters.size() > 1);
}

/**
* Returns a getter to get a value from in an event.
* @deprecated Use {@link #getEventValueConverter(Class, Class, int)} instead.
*/
@Nullable
@Deprecated(forRemoval = true)
@SuppressWarnings({"removal"})
public static <T, E extends Event> Getter<? extends T, ? super E> getEventValueGetter(Class<E> event, Class<T> type, int time) {
return toGetter(getEventValueConverter(event, type, time, true));
}

/**
* Returns a {@link Converter} to get a value from in an event.
* <p>
* Can print an error if the event value is blocked for the given event.
*
* @param event the event class the getter will be getting from.
* @param type type of getter.
* @param event the event class the {@link Converter} will be getting from.
* @param type type of {@link Converter}.
* @param time the event-value's time.
* @return A getter to get values for a given type of events.
* @see #registerEventValue(Class, Class, Converter, int)
* @see EventValueExpression#EventValueExpression(Class)
*/
@Nullable
public static <T, E extends Event> Converter<? super E, ? extends T> getEventValueGetter(Class<E> event, Class<T> type, int time) {
return getEventValueGetter(event, type, time, true);
public static <T, E extends Event> @Nullable Converter<? super E, ? extends T> getEventValueConverter(
Class<E> event, Class<T> type, int time
) {
return getEventValueConverter(event, type, time, true);
}

@Nullable
private static <T, E extends Event> Converter<? super E, ? extends T> getEventValueGetter(Class<E> event, Class<T> type, int time, boolean allowDefault) {
List<Converter<? super E, ? extends T>> list = getEventValueGetters(event, type, time, allowDefault);
private static <T, E extends Event> Converter<? super E, ? extends T> getEventValueConverter(
Class<E> event, Class<T> type, int time, boolean allowDefault
) {
List<Converter<? super E, ? extends T>> list = getEventValueConverters(event, type, time, allowDefault);
if (list == null || list.isEmpty())
return null;
return list.get(0);
}

@Nullable
private static <T, E extends Event> List<Converter<? super E, ? extends T>> getEventValueGetters(Class<E> event, Class<T> type, int time, boolean allowDefault) {
return getEventValueGetters(event, type, time, allowDefault, true);
private static <T, E extends Event> List<Converter<? super E, ? extends T>> getEventValueConverters(
Class<E> event, Class<T> type, int time, boolean allowDefault
) {
return getEventValueConverters(event, type, time, allowDefault, true);
}

/*
Expand All @@ -252,11 +286,14 @@ public static <T, E extends Event> Kleenean hasMultipleGetters(Class<E> event, C
*/
@Nullable
@SuppressWarnings("unchecked")
private static <T, E extends Event> List<Converter<? super E, ? extends T>> getEventValueGetters(Class<E> event, Class<T> type, int time, boolean allowDefault, boolean allowConverting) {
private static <T, E extends Event> List<Converter<? super E, ? extends T>> getEventValueConverters(
Class<E> event, Class<T> type, int time,
boolean allowDefault, boolean allowConverting
) {
List<EventValueInfo<?, ?>> eventValues = getEventValuesList(time);
List<Converter<? super E, ? extends T>> list = new ArrayList<>();
// First check for exact classes matching the parameters.
Converter<? super E, ? extends T> exact = getExactEventValueGetter(event, type, time);
Converter<? super E, ? extends T> exact = getExactEventValueConverter(event, type, time);
if (exact != null) {
list.add(exact);
return list;
Expand Down Expand Up @@ -312,13 +349,14 @@ public static <T, E extends Event> Kleenean hasMultipleGetters(Class<E> event, C
if (!event.equals(eventValueInfo.event))
continue;

Converter<? super E, ? extends T> getter = (Converter<? super E, ? extends T>) getConvertedGetter(eventValueInfo, type, false);
if (getter == null)
Converter<? super E, ? extends T> converter = (Converter<? super E, ? extends T>)
getConvertedConverter(eventValueInfo, type, false);
if (converter == null)
continue;

if (!checkExcludes(eventValueInfo, event))
return null;
list.add(getter);
list.add(converter);
continue;
}
if (!list.isEmpty())
Expand All @@ -329,20 +367,21 @@ public static <T, E extends Event> Kleenean hasMultipleGetters(Class<E> event, C
if (!event.isAssignableFrom(eventValueInfo.event))
continue;

Converter<? super E, ? extends T> getter = (Converter<? super E, ? extends T>) getConvertedGetter(eventValueInfo, type, true);
if (getter == null)
Converter<? super E, ? extends T> converter = (Converter<? super E, ? extends T>)
getConvertedConverter(eventValueInfo, type, true);
if (converter == null)
continue;

if (!checkExcludes(eventValueInfo, event))
return null;
list.add(getter);
list.add(converter);
continue;
}
if (!list.isEmpty())
return list;
// If the check should try again matching event values with a 0 time (most event values).
if (allowDefault && time != 0)
return getEventValueGetters(event, type, 0, false);
return getEventValueConverters(event, type, 0, false);
return null;
}

Expand Down Expand Up @@ -375,7 +414,9 @@ private static boolean checkExcludes(EventValueInfo<?, ?> info, Class<? extends
* @return The found Converter wrapped in a Getter object, or null if no Converter was found.
*/
@Nullable
private static <E extends Event, F, T> Converter<? super E, ? extends T> getConvertedGetter(EventValueInfo<E, F> info, Class<T> to, boolean checkInstanceOf) {
private static <E extends Event, F, T> Converter<? super E, ? extends T> getConvertedConverter(
EventValueInfo<E, F> info, Class<T> to, boolean checkInstanceOf
) {
Converter<? super F, ? extends T> converter = Converters.getConverter(info.c, to);

if (converter == null)
Expand All @@ -391,12 +432,26 @@ private static boolean checkExcludes(EventValueInfo<?, ?> info, Class<? extends
};
}

@Deprecated(forRemoval = true)
@SuppressWarnings({"removal"})
private static <A, B> Getter<B, A> toGetter(Converter<A, B> converter) {
if (converter == null)
return null;

return new Getter<>() {
@Override
public @Nullable B get(A arg) {
return converter.convert(arg);
}
};
}

public static boolean doesExactEventValueHaveTimeStates(Class<? extends Event> event, Class<?> c) {
return getExactEventValueGetter(event, c, TIME_PAST) != null || getExactEventValueGetter(event, c, TIME_FUTURE) != null;
return getExactEventValueConverter(event, c, TIME_PAST) != null || getExactEventValueConverter(event, c, TIME_FUTURE) != null;
}

public static boolean doesEventValueHaveTimeStates(Class<? extends Event> event, Class<?> c) {
return getEventValueGetter(event, c, TIME_PAST, false) != null || getEventValueGetter(event, c, TIME_FUTURE, false) != null;
return getEventValueConverter(event, c, TIME_PAST, false) != null || getEventValueConverter(event, c, TIME_FUTURE, false) != null;
}

private record EventValueInfo<E extends Event, T>(
Expand Down
Loading