kill off 0.10 deprecations

This commit is contained in:
FalsePattern committed 2023-07-16 12:56:20 +02:00
1 parent 29e0f58008
commit cc4d7d180e
6 files changed
-687

No files matched your search

@@ -1,391 +0,0 @@
/*
* Copyright (C) 2022-2023 FalsePattern
* All Rights Reserved
*
* The above copyright notice and this permission notice
* shall be included in all copies or substantial portions of the Software.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.falsepattern.lib.compat;
import com.falsepattern.lib.DeprecationDetails;
import com.falsepattern.lib.StableAPI;
import com.falsepattern.lib.util.MathUtil;
import java.util.Random;
/**
* Alert: This class will be removed in 0.11, migrate to {@link MathUtil}!
*/
@Deprecated
@DeprecationDetails(deprecatedSince = "0.10.0")
@StableAPI(since = "0.9.2")
public class MathHelper {
/**
* Though it looks like an array, this is really more like a mapping. Key (index of this array) is the upper 5 bits
* of the result of multiplying a 32-bit unsigned integer by the B(2, 5) De Bruijn sequence 0x077CB531. Value
* (value stored in the array) is the unique index (from the right) of the leftmost one-bit in a 32-bit unsigned
* integer that can cause the upper 5 bits to get that value. Used for highly optimized "find the log-base-2 of
* this number" calculations.
*/
private static final int[] multiplyDeBruijnBitPosition;
private static final float[] SIN_TABLE = new float[65536];
static {
for (int i = 0; i < 65536; ++i) {
SIN_TABLE[i] = (float) Math.sin((double) i * Math.PI * 2.0D / 65536.0D);
}
multiplyDeBruijnBitPosition =
new int[]{0, 1, 28, 2, 29, 14, 24, 3, 30, 22, 20, 15, 25, 17, 4, 8, 31, 27, 13, 23, 21, 19, 16, 7, 26,
12, 18, 6, 11, 5, 10, 9};
}
/**
* sin looked up in a table
*/
@StableAPI.Expose
public static float sin(float a) {
return SIN_TABLE[(int) (a * 10430.378F) & 65535];
}
/**
* cos looked up in the sin table with the appropriate offset
*/
@StableAPI.Expose
public static float cos(float a) {
return SIN_TABLE[(int) (a * 10430.378F + 16384.0F) & 65535];
}
@StableAPI.Expose
public static float sqrt_float(float a) {
return (float) Math.sqrt(a);
}
@StableAPI.Expose
public static float sqrt_double(double a) {
return (float) Math.sqrt(a);
}
/**
* Returns the greatest integer less than or equal to the float argument
*/
@StableAPI.Expose
public static int floor_float(float a) {
int i = (int) a;
return a < (float) i ? i - 1 : i;
}
/**
* returns par0 cast as an int, and no greater than Integer.MAX_VALUE-1024
*/
@StableAPI.Expose
public static int truncateDoubleToInt(double a) {
return (int) (a + 1024.0D) - 1024;
}
/**
* Returns the greatest integer less than or equal to the double argument
*/
@StableAPI.Expose
public static int floor_double(double a) {
int i = (int) a;
return a < (double) i ? i - 1 : i;
}
/**
* Long version of floor_double
*/
@StableAPI.Expose
public static long floor_double_long(double a) {
long i = (long) a;
return a < (double) i ? i - 1L : i;
}
@StableAPI.Expose
public static int absFloor(double a) {
return (int) (a >= 0.0D ? a : -a + 1.0D);
}
@StableAPI.Expose
public static float abs(float a) {
return a >= 0.0F ? a : -a;
}
/**
* Returns the unsigned value of an int.
*/
@StableAPI.Expose
public static int abs_int(int a) {
return a >= 0 ? a : -a;
}
@StableAPI.Expose
public static int ceiling_float_int(float a) {
int i = (int) a;
return a > (float) i ? i + 1 : i;
}
@StableAPI.Expose
public static int ceiling_double_int(double a) {
int i = (int) a;
return a > (double) i ? i + 1 : i;
}
/**
* Returns the value of the first parameter, clamped to be within the lower and upper limits given by the second and
* third parameters.
*/
@StableAPI.Expose
public static int clamp_int(int a, int min, int max) {
return a < min ? min : (Math.min(a, max));
}
/**
* Returns the value of the first parameter, clamped to be within the lower and upper limits given by the second and
* third parameters
*/
@StableAPI.Expose
public static float clamp_float(float a, float min, float max) {
return a < min ? min : Math.min(a, max);
}
@StableAPI.Expose
public static double clamp_double(double a, double min, double max) {
return a < min ? min : Math.min(a, max);
}
@StableAPI.Expose
public static double denormalizeClamp(double min, double max, double normalized) {
return normalized < 0.0D ? min : (normalized > 1.0D ? max : min + (max - min) * normalized);
}
/**
* Maximum of the absolute value of two numbers.
*/
@StableAPI.Expose
public static double abs_max(double a, double b) {
if (a < 0.0D) {
a = -a;
}
if (b < 0.0D) {
b = -b;
}
return Math.max(a, b);
}
/**
* Buckets an integer with specified bucket sizes. Args: i, bucketSize
*/
@StableAPI.Expose
public static int bucketInt(int i, int bucketSize) {
return i < 0 ? -((-i - 1) / bucketSize) - 1 : i / bucketSize;
}
/**
* Tests if a string is null or of length zero
*/
@StableAPI.Expose
public static boolean stringNullOrLengthZero(String str) {
return str == null || str.length() == 0;
}
@StableAPI.Expose
public static int getRandomIntegerInRange(Random rng, int min, int max) {
return min >= max ? min : rng.nextInt(max - min + 1) + min;
}
@StableAPI.Expose
public static float randomFloatClamp(Random rng, float min, float max) {
return min >= max ? min : rng.nextFloat() * (max - min) + min;
}
@StableAPI.Expose
public static double getRandomDoubleInRange(Random rng, double min, double max) {
return min >= max ? min : rng.nextDouble() * (max - min) + min;
}
@StableAPI.Expose
public static double average(long[] values) {
long i = 0L;
for (long l : values) {
i += l;
}
return (double) i / (double) values.length;
}
/**
* the angle is reduced to an angle between -180 and +180 by mod, and a 360 check
*/
@StableAPI.Expose
public static float wrapAngleTo180_float(float angle) {
angle %= 360.0F;
if (angle >= 180.0F) {
angle -= 360.0F;
}
if (angle < -180.0F) {
angle += 360.0F;
}
return angle;
}
/**
* the angle is reduced to an angle between -180 and +180 by mod, and a 360 check
*/
@StableAPI.Expose
public static double wrapAngleTo180_double(double angle) {
angle %= 360.0D;
if (angle >= 180.0D) {
angle -= 360.0D;
}
if (angle < -180.0D) {
angle += 360.0D;
}
return angle;
}
/**
* parses the string as integer or returns the second parameter if it fails
*/
@StableAPI.Expose
public static int parseIntWithDefault(String str, int def) {
try {
return Integer.parseInt(str);
} catch (Throwable throwable) {
return def;
}
}
/**
* parses the string as integer or returns the second parameter if it fails. this value is capped to par2
*/
@StableAPI.Expose
public static int parseIntWithDefaultAndMax(String str, int def, int min) {
int k;
try {
k = Integer.parseInt(str);
} catch (Throwable throwable) {
k = def;
}
if (k < min) {
k = min;
}
return k;
}
/**
* parses the string as double or returns the second parameter if it fails.
*/
@StableAPI.Expose
public static double parseDoubleWithDefault(String str, double def) {
double d1 = def;
try {
d1 = Double.parseDouble(str);
} catch (Throwable ignored) {
}
return d1;
}
@StableAPI.Expose
public static double parseDoubleWithDefaultAndMin(String str, double def, double min) {
double d2;
try {
d2 = Double.parseDouble(str);
} catch (Throwable throwable) {
d2 = def;
}
if (d2 < min) {
d2 = min;
}
return d2;
}
/**
* Returns the input value rounded up to the next highest power of two.
*/
@StableAPI.Expose
public static int roundUpToPowerOfTwo(int a) {
int j = a - 1;
j |= j >> 1;
j |= j >> 2;
j |= j >> 4;
j |= j >> 8;
j |= j >> 16;
return j + 1;
}
/**
* Is the given value a power of two? (1, 2, 4, 8, 16, ...)
*/
private static boolean isPowerOfTwo(int a) {
return a != 0 && (a & a - 1) == 0;
}
/**
* Uses a B(2, 5) De Bruijn sequence and a lookup table to efficiently calculate the log-base-two of the given
* value. Optimized for cases where the input value is a power-of-two. If the input value is not a power-of-two,
* then subtract 1 from the return value.
*/
private static int calculateLogBaseTwoDeBruijn(int a) {
a = isPowerOfTwo(a) ? a : roundUpToPowerOfTwo(a);
return multiplyDeBruijnBitPosition[(int) ((long) a * 125613361L >> 27) & 31];
}
/**
* Efficiently calculates the floor of the base-2 log of an integer value. This is effectively the index of the
* highest bit that is set. For example, if the number in binary is 0...100101, this will return 5.
*/
@StableAPI.Expose
public static int calculateLogBaseTwo(int a) {
/*
* Uses a B(2, 5) De Bruijn sequence and a lookup table to efficiently calculate the log-base-two of the given
* value. Optimized for cases where the input value is a power-of-two. If the input value is not a power-of-
* two, then subtract 1 from the return value.
*/
return calculateLogBaseTwoDeBruijn(a) - (isPowerOfTwo(a) ? 0 : 1);
}
@StableAPI.Expose
public static int roundUp(int a, int b) {
if (b == 0) {
return 0;
} else {
if (a < 0) {
b *= -1;
}
int k = a % b;
return k == 0 ? a : a + b - k;
}
}
}
@@ -121,37 +121,6 @@ public @interface Config {
@StableAPI.Expose int value();
}
/**
* The range of possible values a float config can have.
* Notice: float configs are deprecated! Use double configs instead!
*/
@Deprecated
@DeprecationDetails(deprecatedSince = "0.10.0")
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@StableAPI(since = "0.6.0")
@interface RangeFloat {
@StableAPI.Expose float min() default -Float.MAX_VALUE;
@StableAPI.Expose float max() default Float.MAX_VALUE;
}
/**
* The default value for a float field. Not having a default is deprecated since 0.10, and will be strongly
* enforced in 0.11+!
* Notice: float configs are deprecated! Use double configs instead!
*/
@Deprecated
@DeprecationDetails(deprecatedSince = "0.10.0")
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@StableAPI(since = "0.6.0")
@interface DefaultFloat {
@StableAPI.Expose float value();
}
/**
* The range of possible values a double config can have.
*/
@@ -102,21 +102,6 @@ public class ConfigurationManager {
}
}
/**
* Registers a configuration class to be loaded. This should be done early on.
*
* @param configClass The class to register.
*/
@Deprecated
@DeprecationDetails(deprecatedSince = "0.10.0")
@StableAPI.Expose
public static void registerConfig(Class<?> configClass) throws ConfigException {
Share.LOG
.warn("A mod is using the deprecated config registration method! The following exception contains the stacktrace.",
new Exception());
ConfigurationManagerImpl.registerLoadSaveConfig(configClass);
}
/**
* Process the configuration into a list of config elements usable in config GUI code.
*
@@ -37,7 +37,6 @@ import java.util.concurrent.CompletableFuture;
@DeprecationDetails(deprecatedSince = "0.11.0")
@StableAPI(since = "0.6.0")
public class DependencyLoader {
@StableAPI.Expose
public static void addMavenRepo(String url) {
DependencyLoaderImpl.addMavenRepo(url);
@@ -52,111 +51,4 @@ public class DependencyLoader {
public static void loadLibraries(Library... libraries) {
DependencyLoaderImpl.loadLibraries(libraries);
}
/**
* Deprecated, but will be kept here due to mod compat for an undetermined duration.
*/
@Deprecated
@DeprecationDetails(deprecatedSince = "0.10.0")
@StableAPI.Expose
public static void loadLibrary(@NonNull String loadingModId, @NonNull String groupId, @NonNull String artifactId, @NonNull Version minVersion, Version maxVersion, @NonNull Version preferredVersion, String regularSuffix, String devSuffix) {
DependencyLoaderImpl.loadLibrary(loadingModId, groupId, artifactId, minVersion, maxVersion, preferredVersion,
regularSuffix, devSuffix);
}
@DeprecationDetails(deprecatedSince = "0.10.0")
@StableAPI.Expose
@Deprecated
public static VoidBuilder builder() {
return new VoidBuilder();
}
@Deprecated
@DeprecationDetails(deprecatedSince = "0.10.0")
@StableAPI(since = "0.6.0")
public static class VoidBuilder {
private String loadingModId;
private String groupId;
private String artifactId;
private Version minVersion;
private Version maxVersion;
private Version preferredVersion;
private String regularSuffix;
private String devSuffix;
@Deprecated
VoidBuilder() {
}
@StableAPI.Expose
@Deprecated
public VoidBuilder loadingModId(@NonNull String loadingModId) {
this.loadingModId = loadingModId;
return this;
}
@StableAPI.Expose
@Deprecated
public VoidBuilder groupId(@NonNull String groupId) {
this.groupId = groupId;
return this;
}
@StableAPI.Expose
@Deprecated
public VoidBuilder artifactId(@NonNull String artifactId) {
this.artifactId = artifactId;
return this;
}
@StableAPI.Expose
@Deprecated
public VoidBuilder minVersion(@NonNull Version minVersion) {
this.minVersion = minVersion;
return this;
}
@StableAPI.Expose
@Deprecated
public VoidBuilder maxVersion(Version maxVersion) {
this.maxVersion = maxVersion;
return this;
}
@StableAPI.Expose
@Deprecated
public VoidBuilder preferredVersion(@NonNull Version preferredVersion) {
this.preferredVersion = preferredVersion;
return this;
}
@StableAPI.Expose
@Deprecated
public VoidBuilder regularSuffix(String regularSuffix) {
this.regularSuffix = regularSuffix;
return this;
}
@StableAPI.Expose
@Deprecated
public VoidBuilder devSuffix(String devSuffix) {
this.devSuffix = devSuffix;
return this;
}
@StableAPI.Expose
@Deprecated
public void build() {
DependencyLoader.loadLibrary(loadingModId, groupId, artifactId, minVersion, maxVersion, preferredVersion,
regularSuffix, devSuffix);
}
@Override
public String toString() {
return "DependencyLoader.VoidBuilder(loadingModId=" + this.loadingModId + ", groupId=" + this.groupId +
", artifactId=" + this.artifactId + ", minVersion=" + this.minVersion + ", maxVersion=" +
this.maxVersion + ", preferredVersion=" + this.preferredVersion + ", regularSuffix=" +
this.regularSuffix + ", devSuffix=" + this.devSuffix + ")";
}
}
}
@@ -28,7 +28,6 @@ import com.falsepattern.lib.internal.impl.config.fields.BooleanListConfigField;
import com.falsepattern.lib.internal.impl.config.fields.DoubleConfigField;
import com.falsepattern.lib.internal.impl.config.fields.DoubleListConfigField;
import com.falsepattern.lib.internal.impl.config.fields.EnumConfigField;
import com.falsepattern.lib.internal.impl.config.fields.FloatConfigField;
import com.falsepattern.lib.internal.impl.config.fields.IntConfigField;
import com.falsepattern.lib.internal.impl.config.fields.IntListConfigField;
import com.falsepattern.lib.internal.impl.config.fields.StringConfigField;
@@ -45,7 +44,6 @@ import java.io.DataOutput;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
@@ -64,8 +62,6 @@ public class ParsedConfiguration {
constructors.put(boolean.class, BooleanConfigField::new);
constructors.put(Integer.class, IntConfigField::new);
constructors.put(int.class, IntConfigField::new);
constructors.put(Float.class, FloatConfigField::new);
constructors.put(float.class, FloatConfigField::new);
constructors.put(Double.class, DoubleConfigField::new);
constructors.put(double.class, DoubleConfigField::new);
constructors.put(String.class, StringConfigField::new);
@@ -1,138 +0,0 @@
/*
* Copyright (C) 2022-2023 FalsePattern
* All Rights Reserved
*
* The above copyright notice and this permission notice
* shall be included in all copies or substantial portions of the Software.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.falsepattern.lib.internal.impl.config.fields;
import com.falsepattern.lib.config.Config;
import com.falsepattern.lib.config.event.ConfigValidationFailureEvent;
import com.falsepattern.lib.internal.Share;
import com.falsepattern.lib.util.MathUtil;
import lombok.SneakyThrows;
import lombok.val;
import net.minecraftforge.common.config.Configuration;
import net.minecraftforge.common.config.Property;
import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.lang.reflect.Field;
import java.util.Optional;
@SuppressWarnings("DeprecatedIsStillUsed")
@Deprecated
public class FloatConfigField extends AConfigField<Float> {
private final boolean primitive;
private final float defaultValue;
private final boolean hasMinMax;
private final float min;
private final float max;
public FloatConfigField(Field field, Configuration configuration, String category) {
super(field, configuration, category, Property.Type.STRING);
Share.LOG
.warn("Warning: float configuration properties are DEPRECATED! Use doubles instead!\n" +
"Field name: " + field.getName() + ", location: " + field.getDeclaringClass().getName());
primitive = field.getType().isPrimitive();
val range = Optional.ofNullable(field.getAnnotation(Config.RangeFloat.class));
hasMinMax = range.isPresent();
min = hasMinMax ? range.map(Config.RangeFloat::min).orElse(-Float.MAX_VALUE) : 0;
max = hasMinMax ? range.map(Config.RangeFloat::max).orElse(Float.MAX_VALUE) : 0;
defaultValue = Optional.ofNullable(field.getAnnotation(Config.DefaultFloat.class))
.map(Config.DefaultFloat::value)
.orElseGet(() -> {
try {
return field.getType().isPrimitive() ? field.getFloat(null)
: (Float) field.get(null);
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
}
});
property.setDefaultValue(defaultValue);
property.setMinValue(min);
property.setMaxValue(max);
property.comment += "\n[range: " + min + " ~ " + max + ", default: " + defaultValue + "]";
}
@SneakyThrows
@Override
protected Float getField() {
return primitive ? field.getFloat(null) : (Integer) field.get(null);
}
@SneakyThrows
@Override
protected void putField(Float value) {
if (primitive) {
field.setFloat(null, value);
} else {
field.set(null, value);
}
}
@Override
protected Float getConfig() {
try {
return MathUtil.clamp(Float.parseFloat(property.getString()), min, max);
} catch (NumberFormatException e) {
return defaultValue;
}
}
@Override
protected void putConfig(Float value) {
property.set(Float.toString(value));
}
@Override
protected Float getDefault() {
return defaultValue;
}
@SneakyThrows
@Override
public boolean validateField() {
if (!primitive && field.get(null) == null) {
ConfigValidationFailureEvent.fieldIsNull(field, -1);
return false;
}
if (hasMinMax) {
val value = (float) getField();
if (value >= min && value <= max) {
return true;
}
ConfigValidationFailureEvent.postNumericRangeOutOfBounds(field, -1, Float.toString(value),
Float.toString(min), Float.toString(max));
return false;
} else {
return true;
}
}
@Override
public void transmit(DataOutput output) throws IOException {
output.writeFloat(getField());
}
@Override
public void receive(DataInput input) throws IOException {
putField(input.readFloat());
}
}