Computer components (#1915)

This adds a new mechanism for attaching additional objects to a
computer, allowing them to be queried by other mods. This is primarily
designed for mods which add external APIs, allowing them to add APIs
which depend on the computer's position or can interact with the turtle
inventory.

I will stress that the use-cases for custom APIs are few and far
between. Almost all the time a peripheral would be the better option,
and I am wary that this PR will encourage misuse of APIs. However, there
are some legitimate use-cases, and I think we should enable them.

 - Add a new "ComputerComponent" class, and several built-in components
   (for turtle, pocket and command computers).

 - Add a method to `IComputerSystem` to read a component from the
   computer. We also add methods to get the level and position of the
   computer.

 - Move all our existing APIs (built-in turtle, pocket, command) to use
   the public API.

projects/common-api/src/main/java/dan200/computercraft/api/ComputerCraftAPI.java

@@ -4,9 +4,11 @@
 
 package dan200.computercraft.api;
 
+import dan200.computercraft.api.component.ComputerComponent;
 import dan200.computercraft.api.filesystem.Mount;
 import dan200.computercraft.api.filesystem.WritableMount;
 import dan200.computercraft.api.lua.GenericSource;
+import dan200.computercraft.api.lua.IComputerSystem;
 import dan200.computercraft.api.lua.ILuaAPI;
 import dan200.computercraft.api.lua.ILuaAPIFactory;
 import dan200.computercraft.api.media.IMedia;
@@ -165,7 +167,20 @@ public static PacketNetwork getWirelessNetwork(MinecraftServer server) {
      * Register a custom {@link ILuaAPI}, which may be added onto all computers without requiring a peripheral.
      * <p>
      * Before implementing this interface, consider alternative methods of providing methods. It is generally preferred
-     * to use peripherals to provide functionality to users.
+     * to use peripherals to provide functionality to users. If an API is <em>required</em>, you may want to consider
+     * using {@link ILuaAPI#getModuleName()} to expose this library as a module instead of as a global.
+     * <p>
+     * This may be used with {@link IComputerSystem#getComponent(ComputerComponent)} to only attach APIs to specific
+     * computers. For example, one can add an additional API just to turtles with the following code:
+     *
+     * <pre>{@code
+     * ComputerCraftAPI.registerAPIFactory(computer -> {
+     *   // Read the turtle component.
+     *   var turtle = computer.getComponent(ComputerComponents.TURTLE);
+     *   // If present then add our API.
+     *   return turtle == null ? null : new MyCustomTurtleApi(turtle);
+     * });
+     * }</pre>
      *
      * @param factory The factory for your API subclass.
      * @see ILuaAPIFactory

projects/common-api/src/main/java/dan200/computercraft/api/component/AdminComputer.java

@@ -0,0 +1,24 @@
+// SPDX-FileCopyrightText: 2024 The CC: Tweaked Developers
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package dan200.computercraft.api.component;
+
+import net.minecraft.commands.CommandSourceStack;
+import org.jetbrains.annotations.ApiStatus;
+
+/**
+ * A computer which has permission to perform administrative/op commands, such as the command computer.
+ */
+@ApiStatus.NonExtendable
+public interface AdminComputer {
+    /**
+     * The permission level that this computer can operate at.
+     *
+     * @return The permission level for this computer.
+     * @see CommandSourceStack#hasPermission(int)
+     */
+    default int permissionLevel() {
+        return 2;
+    }
+}

projects/common-api/src/main/java/dan200/computercraft/api/component/ComputerComponent.java

@@ -0,0 +1,48 @@
+// SPDX-FileCopyrightText: 2024 The CC: Tweaked Developers
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package dan200.computercraft.api.component;
+
+import dan200.computercraft.api.lua.IComputerSystem;
+import dan200.computercraft.api.lua.ILuaAPIFactory;
+
+/**
+ * A component attached to a computer.
+ * <p>
+ * Components provide a mechanism to attach additional data to a computer, that can then be queried with
+ * {@link IComputerSystem#getComponent(ComputerComponent)}.
+ * <p>
+ * This is largely designed for {@linkplain ILuaAPIFactory custom APIs}, allowing APIs to read additional properties
+ * of the computer, such as its position.
+ *
+ * @param <T> The type of this component.
+ * @see ComputerComponents The built-in components.
+ */
+@SuppressWarnings("UnusedTypeParameter")
+public final class ComputerComponent<T> {
+    private final String id;
+
+    private ComputerComponent(String id) {
+        this.id = id;
+    }
+
+    /**
+     * Create a new computer component.
+     * <p>
+     * Mods typically will not need to create their own components.
+     *
+     * @param namespace The namespace of this component. This should be the mod id.
+     * @param id        The unique id of this component.
+     * @param <T>       The component
+     * @return The newly created component.
+     */
+    public static <T> ComputerComponent<T> create(String namespace, String id) {
+        return new ComputerComponent<>(namespace + ":" + id);
+    }
+
+    @Override
+    public String toString() {
+        return "ComputerComponent(" + id + ")";
+    }
+}

projects/common-api/src/main/java/dan200/computercraft/api/component/ComputerComponents.java

@@ -0,0 +1,29 @@
+// SPDX-FileCopyrightText: 2024 The CC: Tweaked Developers
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package dan200.computercraft.api.component;
+
+import dan200.computercraft.api.ComputerCraftAPI;
+import dan200.computercraft.api.pocket.IPocketAccess;
+import dan200.computercraft.api.turtle.ITurtleAccess;
+
+/**
+ * The {@link ComputerComponent}s provided by ComputerCraft.
+ */
+public class ComputerComponents {
+    /**
+     * The {@link ITurtleAccess} associated with a turtle.
+     */
+    public static final ComputerComponent<ITurtleAccess> TURTLE = ComputerComponent.create(ComputerCraftAPI.MOD_ID, "turtle");
+
+    /**
+     * The {@link IPocketAccess} associated with a pocket computer.
+     */
+    public static final ComputerComponent<IPocketAccess> POCKET = ComputerComponent.create(ComputerCraftAPI.MOD_ID, "pocket");
+
+    /**
+     * This component is only present on "command computers", and other computers with admin capabilities.
+     */
+    public static final ComputerComponent<AdminComputer> ADMIN_COMPUTER = ComputerComponent.create(ComputerCraftAPI.MOD_ID, "admin_computer");
+}

projects/common-api/src/main/java/dan200/computercraft/api/lua/IComputerSystem.java

@@ -4,7 +4,10 @@
 
 package dan200.computercraft.api.lua;
 
+import dan200.computercraft.api.component.ComputerComponent;
 import dan200.computercraft.api.peripheral.IComputerAccess;
+import net.minecraft.core.BlockPos;
+import net.minecraft.server.level.ServerLevel;
 import org.jetbrains.annotations.ApiStatus;
 
 import javax.annotation.Nullable;
@@ -15,11 +18,42 @@
  */
 @ApiStatus.NonExtendable
 public interface IComputerSystem extends IComputerAccess {
+    /**
+     * Get the level this computer is currently in.
+     * <p>
+     * This method is not guaranteed to remain the same (even for stationary computers).
+     *
+     * @return The computer's current level.
+     */
+    ServerLevel getLevel();
+
+    /**
+     * Get the position this computer is currently at.
+     * <p>
+     * This method is not guaranteed to remain the same (even for stationary computers).
+     *
+     * @return The computer's current position.
+     */
+    BlockPos getPosition();
+
     /**
      * Get the label for this computer.
      *
      * @return This computer's label, or {@code null} if it is not set.
      */
     @Nullable
     String getLabel();
+
+    /**
+     * Get a component attached to this computer.
+     * <p>
+     * No component is guaranteed to be on a computer, and so this method should always be guarded with a null check.
+     * <p>
+     * This method will always return the same value for a given component, and so may be cached.
+     *
+     * @param component The component to query.
+     * @param <T>       The type of the component.
+     * @return The component, if present.
+     */
+    <T> @Nullable T getComponent(ComputerComponent<T> component);
 }

projects/common/src/main/java/dan200/computercraft/impl/ApiFactories.java

@@ -14,7 +14,6 @@
 /**
  * The global factory for {@link ILuaAPIFactory}s.
  *
- * @see dan200.computercraft.core.ComputerContext.Builder#apiFactories(Collection)
  * @see dan200.computercraft.api.ComputerCraftAPI#registerAPIFactory(ILuaAPIFactory)
  */
 public final class ApiFactories {

projects/common/src/main/java/dan200/computercraft/shared/ModRegistry.java

@@ -6,6 +6,7 @@
 
 import com.mojang.brigadier.arguments.ArgumentType;
 import dan200.computercraft.api.ComputerCraftAPI;
+import dan200.computercraft.api.component.ComputerComponents;
 import dan200.computercraft.api.detail.DetailProvider;
 import dan200.computercraft.api.detail.VanillaDetailRegistries;
 import dan200.computercraft.api.media.IMedia;
@@ -23,6 +24,7 @@
 import dan200.computercraft.shared.common.ColourableRecipe;
 import dan200.computercraft.shared.common.DefaultBundledRedstoneProvider;
 import dan200.computercraft.shared.common.HeldItemMenu;
+import dan200.computercraft.shared.computer.apis.CommandAPI;
 import dan200.computercraft.shared.computer.blocks.CommandComputerBlock;
 import dan200.computercraft.shared.computer.blocks.ComputerBlock;
 import dan200.computercraft.shared.computer.blocks.ComputerBlockEntity;
@@ -64,6 +66,7 @@
 import dan200.computercraft.shared.platform.PlatformHelper;
 import dan200.computercraft.shared.platform.RegistrationHelper;
 import dan200.computercraft.shared.platform.RegistryEntry;
+import dan200.computercraft.shared.pocket.apis.PocketAPI;
 import dan200.computercraft.shared.pocket.items.PocketComputerItem;
 import dan200.computercraft.shared.pocket.peripherals.PocketModem;
 import dan200.computercraft.shared.pocket.peripherals.PocketSpeaker;
@@ -73,14 +76,17 @@
 import dan200.computercraft.shared.recipe.ImpostorShapedRecipe;
 import dan200.computercraft.shared.recipe.ImpostorShapelessRecipe;
 import dan200.computercraft.shared.turtle.FurnaceRefuelHandler;
+import dan200.computercraft.shared.turtle.apis.TurtleAPI;
 import dan200.computercraft.shared.turtle.blocks.TurtleBlock;
 import dan200.computercraft.shared.turtle.blocks.TurtleBlockEntity;
+import dan200.computercraft.shared.turtle.core.TurtleAccessInternal;
 import dan200.computercraft.shared.turtle.inventory.TurtleMenu;
 import dan200.computercraft.shared.turtle.items.TurtleItem;
 import dan200.computercraft.shared.turtle.recipes.TurtleOverlayRecipe;
 import dan200.computercraft.shared.turtle.recipes.TurtleRecipe;
 import dan200.computercraft.shared.turtle.recipes.TurtleUpgradeRecipe;
 import dan200.computercraft.shared.turtle.upgrades.*;
+import dan200.computercraft.shared.util.ComponentMap;
 import net.minecraft.commands.CommandSourceStack;
 import net.minecraft.commands.synchronization.ArgumentTypeInfo;
 import net.minecraft.commands.synchronization.SingletonArgumentInfo;
@@ -102,6 +108,7 @@
 import net.minecraft.world.level.material.MapColor;
 import net.minecraft.world.level.storage.loot.predicates.LootItemConditionType;
 
+import java.util.Objects;
 import java.util.function.BiFunction;
 import java.util.function.Predicate;
 
@@ -447,6 +454,22 @@ public static void register() {
             return null;
         });
 
+        ComputerCraftAPI.registerAPIFactory(computer -> {
+            var turtle = computer.getComponent(ComputerComponents.TURTLE);
+            var metrics = Objects.requireNonNull(computer.getComponent(ComponentMap.METRICS));
+            return turtle == null ? null : new TurtleAPI(metrics, (TurtleAccessInternal) turtle);
+        });
+
+        ComputerCraftAPI.registerAPIFactory(computer -> {
+            var pocket = computer.getComponent(ComputerComponents.POCKET);
+            return pocket == null ? null : new PocketAPI(pocket);
+        });
+
+        ComputerCraftAPI.registerAPIFactory(computer -> {
+            var admin = computer.getComponent(ComputerComponents.ADMIN_COMPUTER);
+            return admin == null ? null : new CommandAPI(computer, admin);
+        });
+
         VanillaDetailRegistries.ITEM_STACK.addProvider(ItemDetails::fill);
         VanillaDetailRegistries.BLOCK_IN_WORLD.addProvider(BlockDetails::fill);
     }

projects/common/src/main/java/dan200/computercraft/shared/computer/apis/CommandAPI.java

@@ -6,11 +6,11 @@
 
 import com.mojang.brigadier.tree.CommandNode;
 import com.mojang.brigadier.tree.LiteralCommandNode;
+import dan200.computercraft.api.component.AdminComputer;
 import dan200.computercraft.api.detail.BlockReference;
 import dan200.computercraft.api.detail.VanillaDetailRegistries;
 import dan200.computercraft.api.lua.*;
 import dan200.computercraft.core.Logging;
-import dan200.computercraft.shared.computer.core.ServerComputer;
 import dan200.computercraft.shared.util.NBTUtil;
 import net.minecraft.commands.CommandSource;
 import net.minecraft.commands.CommandSourceStack;
@@ -35,11 +35,13 @@
 public class CommandAPI implements ILuaAPI {
     private static final Logger LOG = LoggerFactory.getLogger(CommandAPI.class);
 
-    private final ServerComputer computer;
+    private final IComputerSystem computer;
+    private final AdminComputer admin;
     private final OutputReceiver receiver = new OutputReceiver();
 
-    public CommandAPI(ServerComputer computer) {
+    public CommandAPI(IComputerSystem computer, AdminComputer admin) {
         this.computer = computer;
+        this.admin = admin;
     }
 
     @Override
@@ -287,7 +289,7 @@ private CommandSourceStack getSource() {
 
         return new CommandSourceStack(receiver,
             Vec3.atCenterOf(computer.getPosition()), Vec2.ZERO,
-            computer.getLevel(), 2,
+            computer.getLevel(), admin.permissionLevel(),
             name, Component.literal(name),
             computer.getLevel().getServer(), null
         );

projects/common/src/main/java/dan200/computercraft/shared/computer/blocks/ComputerBlockEntity.java

@@ -12,6 +12,7 @@
 import dan200.computercraft.shared.computer.core.ServerComputer;
 import dan200.computercraft.shared.computer.inventory.ComputerMenuWithoutInventory;
 import dan200.computercraft.shared.config.Config;
+import dan200.computercraft.shared.util.ComponentMap;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.server.level.ServerLevel;
@@ -34,7 +35,8 @@ public ComputerBlockEntity(BlockEntityType<? extends ComputerBlockEntity> type,
     protected ServerComputer createComputer(int id) {
         return new ServerComputer(
             (ServerLevel) getLevel(), getBlockPos(), id, label,
-            getFamily(), Config.computerTermWidth, Config.computerTermHeight
+            getFamily(), Config.computerTermWidth, Config.computerTermHeight,
+            ComponentMap.empty()
         );
     }