FabricMC/fabric
1
0
Fork 1
mirror of https://github.com/FabricMC/fabric.git synced 2024-11-14 19:25:23 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add a method to data generator entrypoints to register custom keys with priorities (#3087)

Browse source 
* Add JsonKeySortOrderCallback

* Use an entry point rather than an event for sort keys and priorities

* Resolve static imports

* Add a bit of javadoc

* Check if a key is null and modify the javadoc

* Add a field reference in the javadoc

* Rename JsonKeySortOrderAdder to JsonKeySortOrderCallback

(cherry picked from commit 0883a8d4d9)
This commit is contained in:
ErrorCraft 2023-09-18 17:11:50 +02:00 committed by modmuss50
parent 5c133856b8
commit bbae80faea
5 changed files with 67 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/api/datagen/v1/DataGeneratorEntrypoint.java
View file

@ -60,4 +60,11 @@ public interface DataGeneratorEntrypoint {
*/
default void buildRegistry(RegistryBuilder registryBuilder) {
}
/**
* Provides a callback for setting the sort priority of object keys in generated JSON files.
* @param callback a callback for setting the sort priority for a given key
*/
default void addJsonKeySortOrders(JsonKeySortOrderCallback callback) {
}
}

32
fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/api/datagen/v1/JsonKeySortOrderCallback.java Normal file
View file

@ -0,0 +1,32 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.fabricmc.fabric.api.datagen.v1;
/**
* Provides a callback for setting the sort priority of object keys in generated JSON files.
*/
@FunctionalInterface
public interface JsonKeySortOrderCallback {
/**
* Sets the sort priority for a given object key within generated JSON files.
* @param key the key to set priority for
* @param priority the priority for the key, where keys with lower priority are sorted before keys with higher priority
* @implNote The default priority is 2.
* @see net.minecraft.data.DataProvider#JSON_KEY_SORT_ORDER
*/
void add(String key, int priority);
}

16
fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/impl/datagen/FabricDataGenHelper.java
View file

@ -20,6 +20,7 @@ import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.IdentityHashMap;
import java.util.List;
import java.util.Map;
@ -28,11 +29,13 @@ import java.util.concurrent.CompletableFuture;
import com.mojang.logging.LogUtils;
import com.mojang.serialization.Lifecycle;
import it.unimi.dsi.fastutil.objects.Object2IntOpenHashMap;
import org.apache.commons.lang3.ArrayUtils;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import net.minecraft.data.DataProvider;
import net.minecraft.registry.BuiltinRegistries;
import net.minecraft.registry.DynamicRegistryManager;
import net.minecraft.registry.Registerable;
@ -107,6 +110,9 @@ public final class FabricDataGenHelper {
final List<DataGeneratorEntrypoint> entrypoints = dataGeneratorInitializers.stream().map(EntrypointContainer::getEntrypoint).toList();
CompletableFuture<RegistryWrapper.WrapperLookup> registriesFuture = CompletableFuture.supplyAsync(() -> createRegistryWrapper(entrypoints), Util.getMainWorkerExecutor());
Object2IntOpenHashMap<String> jsonKeySortOrders = (Object2IntOpenHashMap<String>) DataProvider.JSON_KEY_SORT_ORDER;
Object2IntOpenHashMap<String> defaultJsonKeySortOrders = new Object2IntOpenHashMap<>(jsonKeySortOrders);
for (EntrypointContainer<DataGeneratorEntrypoint> entrypointContainer : dataGeneratorInitializers) {
final String id = entrypointContainer.getProvider().getMetadata().getId();
@ -123,6 +129,13 @@ public final class FabricDataGenHelper {
final String effectiveModId = entrypoint.getEffectiveModId();
ModContainer modContainer = entrypointContainer.getProvider();
HashSet<String> keys = new HashSet<>();
entrypoint.addJsonKeySortOrders((key, value) -> {
Objects.requireNonNull(key, "Tried to register a priority for a null key");
jsonKeySortOrders.put(key, value);
keys.add(key);
});
if (effectiveModId != null) {
modContainer = FabricLoader.getInstance().getModContainer(effectiveModId).orElseThrow(() -> new RuntimeException("Failed to find effective mod container for mod id (%s)".formatted(effectiveModId)));
}
@ -130,6 +143,9 @@ public final class FabricDataGenHelper {
FabricDataGenerator dataGenerator = new FabricDataGenerator(outputDir, modContainer, STRICT_VALIDATION, registriesFuture);
entrypoint.onInitializeDataGenerator(dataGenerator);
dataGenerator.run();
jsonKeySortOrders.keySet().removeAll(keys);
jsonKeySortOrders.putAll(defaultJsonKeySortOrders);
} catch (Throwable t) {
throw new RuntimeException("Failed to run data generator from mod (%s)".formatted(id), t);
}

6
fabric-data-generation-api-v1/src/testmod/java/net/fabricmc/fabric/test/datagen/DataGeneratorTestEntrypoint.java
View file

@ -74,6 +74,7 @@ import net.fabricmc.api.EnvType;
import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;
import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput;
import net.fabricmc.fabric.api.datagen.v1.JsonKeySortOrderCallback;
import net.fabricmc.fabric.api.datagen.v1.provider.FabricAdvancementProvider;
import net.fabricmc.fabric.api.datagen.v1.provider.FabricBlockLootTableProvider;
import net.fabricmc.fabric.api.datagen.v1.provider.FabricDynamicRegistryProvider;
@ -92,6 +93,11 @@ public class DataGeneratorTestEntrypoint implements DataGeneratorEntrypoint {
private static final ConditionJsonProvider NEVER_LOADED = DefaultResourceConditions.allModsLoaded("a");
private static final ConditionJsonProvider ALWAYS_LOADED = DefaultResourceConditions.not(NEVER_LOADED);
@Override
public void addJsonKeySortOrders(JsonKeySortOrderCallback callback) {
callback.add("trigger", 0);
}
@Override
public void onInitializeDataGenerator(FabricDataGenerator dataGenerator) {
final FabricDataGenerator.Pack pack = dataGenerator.createPack();

6
fabric-data-generation-api-v1/src/testmodClient/java/net/fabricmc/fabric/test/datagen/client/DataGeneratorClientTestEntrypoint.java
View file

@ -30,10 +30,16 @@ import net.minecraft.util.Identifier;
import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;
import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput;
import net.fabricmc.fabric.api.datagen.v1.JsonKeySortOrderCallback;
import net.fabricmc.fabric.api.datagen.v1.provider.FabricCodecDataProvider;
@SuppressWarnings("unused")
public class DataGeneratorClientTestEntrypoint implements DataGeneratorEntrypoint {
@Override
public void addJsonKeySortOrders(JsonKeySortOrderCallback callback) {
callback.add("type", 100); // Force 'type' at the end
}
@Override
public void onInitializeDataGenerator(FabricDataGenerator dataGenerator) {
final FabricDataGenerator.Pack pack = dataGenerator.createBuiltinResourcePack(new Identifier(MOD_ID, "example_builtin"));