[WIP] Holder Components

fabric-holder-component-api-v1/build.gradle

@@ -0,0 +1,14 @@
+version = getSubprojectVersion(project)
+
+loom {
+	accessWidenerPath = file("src/main/resources/fabric-holder-component-api-v1.classtweaker")
+}
+
+moduleDependencies(project, [
+	'fabric-api-base',
+	'fabric-networking-api-v1'
+])
+
+testDependencies(project, [
+	'fabric-command-api-v2'
+])

fabric-holder-component-api-v1/src/client/java/net/fabricmc/fabric/impl/client/holder/component/FabricRegistryDataCollector.java

@@ -0,0 +1,25 @@
+/*
+ * 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.impl.client.holder.component;
+
+import net.fabricmc.fabric.impl.holder.component.sync.ClientboundUpdateComponentsPayload;
+
+public interface FabricRegistryDataCollector {
+	default void fabric$appendComponents(ClientboundUpdateComponentsPayload payload) {
+		throw new IllegalStateException("Implemented via mixin.");
+	}
+}

fabric-holder-component-api-v1/src/client/java/net/fabricmc/fabric/impl/client/holder/component/HolderComponentClientEntrypoint.java

@@ -0,0 +1,65 @@
+/*
+ * 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.impl.client.holder.component;
+
+import java.util.List;
+
+import net.fabricmc.fabric.impl.holder.component.HolderComponentEntrypoint;
+
+import net.minecraft.client.multiplayer.RegistryDataCollector;
+import net.minecraft.core.component.DataComponentInitializers;
+
+import net.fabricmc.api.ClientModInitializer;
+import net.fabricmc.fabric.api.client.networking.v1.ClientConfigurationNetworking;
+import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
+import net.fabricmc.fabric.api.networking.v1.context.PacketContext;
+import net.fabricmc.fabric.impl.holder.component.sync.ClientboundUpdateComponentsPayload;
+import net.fabricmc.fabric.impl.holder.component.sync.HolderComponentSynchronization;
+import net.fabricmc.fabric.mixin.client.holder.component.ClientConfigurationPacketListenerImplAccessor;
+
+public class HolderComponentClientEntrypoint implements ClientModInitializer {
+	@Override
+	public void onInitializeClient() {
+		ClientConfigurationNetworking.registerGlobalReceiver(
+				ClientboundUpdateComponentsPayload.TYPE,
+				(payload, context) -> {
+					RegistryDataCollector collector = ((ClientConfigurationPacketListenerImplAccessor) context.packetListener()).getRegistryDataCollector();
+					FabricRegistryDataCollector fabricCollector = ((FabricRegistryDataCollector) collector);
+
+					fabricCollector.fabric$appendComponents(payload);
+				}
+		);
+
+		ClientPlayNetworking.registerGlobalReceiver(
+				ClientboundUpdateComponentsPayload.TYPE,
+				(payload, context) -> {
+					List<DataComponentInitializers.PendingComponents<?>> pending = HolderComponentSynchronization.deserialize(
+							payload,
+							context.packetContext().orElseThrow(PacketContext.REGISTRY_ACCESS)
+					);
+
+					// we already check for integrated server when sending, but anything could send a packet and applying it will cause serious issues.
+					if (context.packetContext().orElseThrow(PacketContext.CONNECTION).isMemoryConnection()) {
+						// RFC: Should this be a crash?
+						HolderComponentEntrypoint.LOGGER.warn("A ClientboundUpdateComponentsPayload was sent to the integrated server host. This is a bug, whichever mod sent this packet should check if the receiver is the server host before sending it.");
+					} else {
+						pending.forEach(DataComponentInitializers.PendingComponents::apply);
+					}
+				}
+		);
+	}
+}

fabric-holder-component-api-v1/src/client/java/net/fabricmc/fabric/mixin/client/holder/component/ClientConfigurationPacketListenerImplAccessor.java

@@ -0,0 +1,29 @@
+/*
+ * 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.mixin.client.holder.component;
+
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.gen.Accessor;
+
+import net.minecraft.client.multiplayer.ClientConfigurationPacketListenerImpl;
+import net.minecraft.client.multiplayer.RegistryDataCollector;
+
+@Mixin(ClientConfigurationPacketListenerImpl.class)
+public interface ClientConfigurationPacketListenerImplAccessor {
+	@Accessor
+	RegistryDataCollector getRegistryDataCollector();
+}

fabric-holder-component-api-v1/src/client/java/net/fabricmc/fabric/mixin/client/holder/component/RegistryDataCollectorMixin.java

@@ -0,0 +1,81 @@
+/*
+ * 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.mixin.client.holder.component;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import com.llamalad7.mixinextras.sugar.Local;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Unique;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
+
+import net.minecraft.client.multiplayer.RegistryDataCollector;
+import net.minecraft.core.RegistryAccess;
+import net.minecraft.core.RegistrySynchronization;
+import net.minecraft.core.component.DataComponentInitializers;
+import net.minecraft.resources.Identifier;
+import net.minecraft.server.packs.resources.ResourceProvider;
+
+import net.fabricmc.fabric.impl.client.holder.component.FabricRegistryDataCollector;
+import net.fabricmc.fabric.impl.holder.component.sync.ClientboundUpdateComponentsPayload;
+import net.fabricmc.fabric.impl.holder.component.sync.HolderComponentSynchronization;
+
+@Mixin(RegistryDataCollector.class)
+public class RegistryDataCollectorMixin implements FabricRegistryDataCollector {
+	@Unique
+	private final ClientboundUpdateComponentsPayload components = new ClientboundUpdateComponentsPayload(new HashMap<>());
+
+	@Override
+	public void fabric$appendComponents(ClientboundUpdateComponentsPayload payload) {
+		payload.registryToComponents().forEach((key, value) -> {
+			Map<Identifier, List<HolderComponentSynchronization.PackedComponentMap>> holderMaps =
+					components.registryToComponents()
+							.computeIfAbsent(key, _ -> new HashMap<>(value.size()));
+
+			value.forEach((holder, components) -> {
+				holderMaps.computeIfAbsent(holder, _ -> new ArrayList<>()).addAll(components);
+			});
+		});
+	}
+
+	@Inject(method = "collectGameRegistries", at = @At(value = "INVOKE", target = "Lnet/minecraft/client/multiplayer/RegistryDataCollector;updateComponents(Lnet/minecraft/core/RegistryAccess$Frozen;Z)V", shift = At.Shift.AFTER))
+	private void updateSyncedComponents(
+			ResourceProvider knownDataSource,
+			RegistryAccess.Frozen originalRegistries,
+			boolean tagsAndComponentsForSynchronizedRegistriesOnly,
+			CallbackInfoReturnable<RegistryAccess.Frozen> cir,
+			@Local(name = "frozenRegistries") RegistryAccess.Frozen frozenRegistries
+	) {
+		List<DataComponentInitializers.PendingComponents<?>> pending = HolderComponentSynchronization.deserialize(
+				components,
+				frozenRegistries
+		);
+
+		boolean includeSharedRegistries = !tagsAndComponentsForSynchronizedRegistriesOnly;
+
+		for (DataComponentInitializers.PendingComponents<?> prepared : pending) {
+			if (includeSharedRegistries || RegistrySynchronization.isNetworkable(prepared.key())) {
+				prepared.apply();
+			}
+		}
+	}
+}

fabric-holder-component-api-v1/src/client/resources/fabric-holder-component-api-v1.client.mixins.json

@@ -0,0 +1,17 @@
+{
+  "required": true,
+  "package": "net.fabricmc.fabric.mixin.client.holder.component",
+  "compatibilityLevel": "JAVA_25",
+  "client": [
+  ],
+  "injectors": {
+    "defaultRequire": 1
+  },
+  "overwrites": {
+    "requireAnnotations": true
+  },
+  "mixins": [
+    "ClientConfigurationPacketListenerImplAccessor",
+    "RegistryDataCollectorMixin"
+  ]
+}

fabric-holder-component-api-v1/src/main/java/net/fabricmc/fabric/api/holder/component/v1/FabricDataComponentHolder.java

@@ -0,0 +1,29 @@
+/*
+ * 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.holder.component.v1;
+
+import net.minecraft.core.component.DataComponentHolder;
+import net.minecraft.core.component.DataComponentMap;
+
+/// This interface is injected into several vanilla classes via mixin. Do not implement it yourself, implement [DataComponentHolder] instead.
+/// @see DataComponentHolder
+public interface FabricDataComponentHolder extends DataComponentHolder {
+	@Override
+	default DataComponentMap getComponents() {
+		throw new UnsupportedOperationException("Implemented via mixin.");
+	}
+}

fabric-holder-component-api-v1/src/main/java/net/fabricmc/fabric/api/holder/component/v1/FabricDataComponentInitializer.java

@@ -0,0 +1,35 @@
+/*
+ * 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.holder.component.v1;
+
+import net.minecraft.core.HolderLookup;
+import net.minecraft.core.component.DataComponentMap;
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.server.packs.resources.ResourceManager;
+
+/// Extended version of [net.minecraft.core.component.DataComponentInitializers.Initializer] that allows adding components to arbitrary holders instead of having to define what holders are to be given components at registration.
+@FunctionalInterface
+public interface FabricDataComponentInitializer {
+	void run(Context context);
+
+	interface Context {
+		HolderLookup.Provider lookupProvider();
+		ResourceManager resourceManager();
+
+		DataComponentMap.Builder builder(ResourceKey<?> key);
+	}
+}

fabric-holder-component-api-v1/src/main/java/net/fabricmc/fabric/api/holder/component/v1/FabricDataComponentInitializers.java

@@ -0,0 +1,44 @@
+/*
+ * 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.holder.component.v1;
+
+import net.minecraft.core.component.DataComponentInitializers;
+import net.minecraft.resources.Identifier;
+
+import net.fabricmc.fabric.impl.holder.component.FabricDataComponentInitializersImpl;
+
+/// Allows registration of custom [Data Component Initializers][DataComponentInitializers.Initializer].
+///
+/// [Data Component Initializers][DataComponentInitializers.Initializer] are used to add components to [Holders][net.minecraft.core.Holder]. They are run right before the end of a resource reload.
+/// @see DataComponentInitializers
+/// @see FabricDataComponentInitializer
+// TODO: Finish docs
+public final class FabricDataComponentInitializers {
+	/// @see FabricDataComponentInitializers#addInitializerOrdering(Identifier, Identifier)
+	public static final Identifier DATA_HOLDER_COMPONENTS = Identifier.fromNamespaceAndPath("fabric", "data_holder_components");
+
+	private FabricDataComponentInitializers() {
+	}
+
+	public static void registerInitializer(Identifier id, FabricDataComponentInitializer initializer) {
+		FabricDataComponentInitializersImpl.registerInitializer(id, initializer);
+	}
+
+	public static void addInitializerOrdering(Identifier first, Identifier second) {
+		FabricDataComponentInitializersImpl.addInitializerOrdering(first, second);
+	}
+}

fabric-holder-component-api-v1/src/main/java/net/fabricmc/fabric/api/holder/component/v1/FabricDataComponentMapBuilder.java

@@ -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.holder.component.v1;
+
+import net.minecraft.core.component.DataComponentMap;
+import net.minecraft.core.component.DataComponentPatch;
+
+/// Extensions for [DataComponentMap.Builder]. Implemented via interface injection, do not implement yourself!
+/// @see DataComponentMap.Builder
+public interface FabricDataComponentMapBuilder {
+	default DataComponentMap.Builder apply(DataComponentPatch patch) {
+		throw new UnsupportedOperationException("Implemented via mixin.");
+	}
+
+	default DataComponentMap.Builder clear() {
+		throw new UnsupportedOperationException("Implemented via mixin.");
+	}
+}