It begins

Author: Kneelawk

javadoc-options.txt

@@ -0,0 +1 @@
+

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/GraphLib.java

@@ -0,0 +1,8 @@
+package com.kneelawk.graphlib.v3.api;
+
+/**
+ * GraphLib Public API.
+ */
+public final class GraphLib {
+    private GraphLib() {}
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/graph/user/GraphNode.java

@@ -0,0 +1,17 @@
+package com.kneelawk.graphlib.v3.api.graph.user;
+
+import com.mojang.serialization.MapCodec;
+
+/**
+ * Interface that all graph nodes should implement.
+ * <p>
+ * A graph node is a piece of immutable data that sits in a graph and can be used to allow utilities to determine which
+ * things are connected to which and how.
+ */
+public interface GraphNode {
+    // TODO: universe lookups
+    /**
+     * {@link GraphNode} map codec.
+     */
+    MapCodec<GraphNode> MAP_CODEC = MapCodec.unit(() -> {throw new AssertionError("Stub");});
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/graph/user/package-info.java

@@ -0,0 +1,12 @@
+/**
+ * User-implemented GraphLib interfaces.
+ */
+@ParametersAreNonnullByDefault
+@MethodsReturnNonnullByDefault
+@FieldsAreNonnullByDefault
+package com.kneelawk.graphlib.v3.api.graph.user;
+
+import javax.annotation.ParametersAreNonnullByDefault;
+
+import net.minecraft.FieldsAreNonnullByDefault;
+import net.minecraft.MethodsReturnNonnullByDefault;

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/package-info.java

@@ -0,0 +1,12 @@
+/**
+ * Root GraphLib API package.
+ */
+@ParametersAreNonnullByDefault
+@MethodsReturnNonnullByDefault
+@FieldsAreNonnullByDefault
+package com.kneelawk.graphlib.v3.api;
+
+import javax.annotation.ParametersAreNonnullByDefault;
+
+import net.minecraft.FieldsAreNonnullByDefault;
+import net.minecraft.MethodsReturnNonnullByDefault;

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/pos/BlockNodePos.java

@@ -0,0 +1,37 @@
+package com.kneelawk.graphlib.v3.api.pos;
+
+import com.mojang.serialization.MapCodec;
+import com.mojang.serialization.codecs.RecordCodecBuilder;
+
+import net.minecraft.core.BlockPos;
+
+import com.kneelawk.graphlib.v3.api.graph.user.GraphNode;
+
+import static com.kneelawk.graphlib.v3.impl.GLConstants.rl;
+
+/**
+ * Represents a node positioned in a specific block.
+ *
+ * @param pos       the block the node is in.
+ * @param dimension the dimension the node is in.
+ * @param node      the node itself.
+ */
+public record BlockNodePos(BlockPos pos, DimensionRef dimension, GraphNode node) implements NodePos {
+    /**
+     * {@link BlockNodePos} codec.
+     */
+    public static final MapCodec<BlockNodePos> MAP_CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group(
+        BlockPos.CODEC.fieldOf("pos").forGetter(BlockNodePos::pos),
+        DimensionRef.MAP_CODEC.codec().fieldOf("dim").forGetter(BlockNodePos::dimension),
+        GraphNode.MAP_CODEC.codec().fieldOf("node").forGetter(BlockNodePos::node)
+    ).apply(instance, BlockNodePos::new));
+    /**
+     * {@link BlockNodePos} codec.
+     */
+    public static final Type<BlockNodePos> TYPE = new Type<>(rl("block"), MAP_CODEC);
+
+    @Override
+    public Type<? extends NodePos> getType() {
+        return TYPE;
+    }
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/pos/DimensionRef.java

@@ -0,0 +1,31 @@
+package com.kneelawk.graphlib.v3.api.pos;
+
+import com.mojang.serialization.MapCodec;
+
+import net.minecraft.resources.ResourceLocation;
+
+/**
+ * A reference to a level or dimension type object. This can be a {@link net.minecraft.world.level.Level} or something
+ * with a custom implementation like a Create Contraption.
+ */
+public interface DimensionRef {
+    // TODO: Universe lookups
+    /**
+     * DimensionRef codec.
+     */
+    MapCodec<DimensionRef> MAP_CODEC = MapCodec.unit(() -> {throw new AssertionError("Stub");});
+
+    /**
+     * {@return this dimension ref's type}
+     */
+    Type<? extends DimensionRef> getType();
+
+    /**
+     * The type of a dimension reference.
+     *
+     * @param id    the id of this type of dimension reference within a given universe.
+     * @param codec the codec for encoding and decoding this dimension reference type.
+     * @param <T>   the type of dimension reference this type describes.
+     */
+    record Type<T extends DimensionRef>(ResourceLocation id, MapCodec<T> codec) {}
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/pos/LevelRef.java

@@ -0,0 +1,29 @@
+package com.kneelawk.graphlib.v3.api.pos;
+
+import com.mojang.serialization.MapCodec;
+
+import net.minecraft.resources.ResourceLocation;
+
+import static com.kneelawk.graphlib.v3.impl.GLConstants.rl;
+
+/**
+ * A reference to a specific {@link net.minecraft.world.level.Level}.
+ *
+ * @param level the name of the level, stored in the server.
+ */
+public record LevelRef(ResourceLocation level) implements DimensionRef {
+    /**
+     * LevelRef codec.
+     */
+    public static final MapCodec<LevelRef> MAP_CODEC =
+        ResourceLocation.CODEC.fieldOf("level").xmap(LevelRef::new, LevelRef::level);
+    /**
+     * LevelRef type.
+     */
+    public static final Type<LevelRef> TYPE = new Type<>(rl("level"), MAP_CODEC);
+
+    @Override
+    public Type<? extends DimensionRef> getType() {
+        return TYPE;
+    }
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/pos/NodePos.java

@@ -0,0 +1,44 @@
+package com.kneelawk.graphlib.v3.api.pos;
+
+import com.mojang.serialization.MapCodec;
+
+import net.minecraft.core.BlockPos;
+import net.minecraft.resources.ResourceLocation;
+
+import com.kneelawk.graphlib.v3.api.graph.user.GraphNode;
+
+/**
+ * Generic Node position. This can have different implementations, depending on what the node is actually attached to.
+ */
+public interface NodePos {
+    /**
+     * Utility method for creating a block node position.
+     *
+     * @param pos       the block position of the node.
+     * @param dimension the dimension the node is in.
+     * @param node      the node itself.
+     * @return the node pos for uniquely describing that node.
+     */
+    static NodePos block(BlockPos pos, ResourceLocation dimension, GraphNode node) {
+        return new BlockNodePos(pos, new LevelRef(dimension), node);
+    }
+
+    /**
+     * {@return the graph node of this node pos}
+     */
+    GraphNode node();
+
+    /**
+     * {@return this dimension ref's type}
+     */
+    Type<? extends NodePos> getType();
+
+    /**
+     * The type of a dimension reference.
+     *
+     * @param id    the id of this type of dimension reference within a given universe.
+     * @param codec the codec for encoding and decoding this dimension reference type.
+     * @param <T>   the type of node pos this type describes.
+     */
+    record Type<T extends NodePos>(ResourceLocation id, MapCodec<T> codec) {}
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/pos/package-info.java

@@ -0,0 +1,14 @@
+/**
+ * GraphLib positioning.
+ * <p>
+ * This the constructs for referencing a specific node in a graph.
+ */
+@ParametersAreNonnullByDefault
+@MethodsReturnNonnullByDefault
+@FieldsAreNonnullByDefault
+package com.kneelawk.graphlib.v3.api.pos;
+
+import javax.annotation.ParametersAreNonnullByDefault;
+
+import net.minecraft.FieldsAreNonnullByDefault;
+import net.minecraft.MethodsReturnNonnullByDefault;