Add more to structure

Author: Kneelawk

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

@@ -1,72 +1,98 @@
 package com.kneelawk.graphlib.v3.api.graph;
 
-import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import com.mojang.serialization.Codec;
 import com.mojang.serialization.DataResult;
 
 import net.minecraft.resources.ResourceLocation;
+import net.minecraft.world.level.Level;
 
 import com.kneelawk.codextra.api.attach.AttachmentKey;
 import com.kneelawk.graphlib.v3.api.GraphLib;
+import com.kneelawk.graphlib.v3.api.graph.backend.DimensionManager;
+import com.kneelawk.graphlib.v3.api.graph.backend.NodeSpace;
 import com.kneelawk.graphlib.v3.api.graph.user.GraphNodeType;
 import com.kneelawk.graphlib.v3.api.graph.user.LinkKeyType;
+import com.kneelawk.graphlib.v3.api.pos.DimensionRef;
+import com.kneelawk.graphlib.v3.api.pos.NodePos;
 
 /**
  * Manages all graphs and graph accessories.
  */
-public final class GraphUniverse {
-
+public interface GraphUniverse {
     /**
      * Graph-Universe attachment key for use in codecs.
      */
-    public static final AttachmentKey<GraphUniverse> ATTACHMENT_KEY = AttachmentKey.ofStaticFieldName();
-
+    AttachmentKey<GraphUniverse> ATTACHMENT_KEY = AttachmentKey.ofStaticFieldName();
     /**
      * Codec for referencing a graph universe.
      */
-    public static final Codec<GraphUniverse> REF_CODEC = ResourceLocation.CODEC.comapFlatMap(id -> {
+    Codec<GraphUniverse> REF_CODEC = ResourceLocation.CODEC.comapFlatMap(id -> {
         if (!GraphLib.universeExists(id))
             return DataResult.error(() -> "The graph universe '" + id + "' does not exist");
         return DataResult.success(GraphLib.getUniverseOrThrow(id));
     }, GraphUniverse::getId);
 
-    private final ResourceLocation id;
-
-    private GraphUniverse(ResourceLocation id) {
-        this.id = id;
-    }
-
     /**
      * Gets the unique id of this universe.
      *
      * @return this universe's unique id.
      */
-    public ResourceLocation getId() {
-        return id;
-    }
+    ResourceLocation getId();
+
+    /**
+     * {@return the graph world associated with the currently running minecraft server}
+     * <p>
+     * If no minecraft server is currently running (e.g. no game is running, this is a client connected to a remote
+     * server), this will return {@code null}.
+     */
+    @Nullable GraphWorld getGraphWorld();
 
     /**
      * Gets the graph node type for the given type id.
      *
      * @param typeId the type id of the graph node type.
      * @return the graph node type for the given type id.
      */
-    @Nullable
-    public GraphNodeType getNodeType(@NotNull ResourceLocation typeId) {
-        throw new AssertionError("Stub");
-    }
+    @Nullable GraphNodeType getNodeType(@NotNull ResourceLocation typeId);
 
     /**
      * Gets the link key type for the given type id.
      *
      * @param typeId the type id of the link key type.
      * @return the link key type for the given type id.
      */
-    @Nullable
-    public LinkKeyType getLinkKeyType(@NotNull ResourceLocation typeId) {
-        throw new AssertionError("Stub");
+    @Nullable LinkKeyType getLinkKeyType(@NotNull ResourceLocation typeId);
+
+    /**
+     * Gets the node space for the given type of node pos if it has been registered.
+     *
+     * @param type the type of node pos that the node space is associated with.
+     * @return the node space associated with the given node pos type.
+     */
+    @Nullable NodeSpace getNodeSpace(NodePos.Type<?> type);
+
+    /**
+     * Gets the dimension manager for the given type of dimension ref if it has been registered.
+     *
+     * @param type the type of dimension ref that the dimension manager is for.
+     * @param <R>  the type of dimension ref to get the dimension manager of.
+     * @return the dimension manager for the given type of dimension ref.
+     */
+    @Nullable <R extends DimensionRef> DimensionManager<R> getDimensionManager(DimensionRef.Type<R> type);
+
+    /**
+     * Gets a {@link Level} for the given dimension ref, if one is available.
+     *
+     * @param dimensionRef the dimension reference that the level is associated with.
+     * @return the level associated with the given dimension reference.
+     */
+    @SuppressWarnings("unchecked")
+    default @Nullable Level getLevel(DimensionRef dimensionRef) {
+        DimensionManager<?> manager = getDimensionManager(dimensionRef.getType());
+        if (manager == null) return null;
+        return ((DimensionManager<DimensionRef>) manager).getLevel(dimensionRef);
     }
 }

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

@@ -0,0 +1,24 @@
+package com.kneelawk.graphlib.v3.api.graph;
+
+import org.jetbrains.annotations.Nullable;
+
+import net.minecraft.world.level.Level;
+
+import com.kneelawk.graphlib.v3.api.pos.DimensionRef;
+
+/**
+ * An immutable view of all graphs in a save (across all levels).
+ */
+public interface GraphView {
+    /**
+     * {@return whether this graph view is on the logical client}
+     */
+    default boolean isClient() {
+        return true;
+    }
+
+    /**
+     * {@return the graph universe associated with this graph view}
+     */
+    GraphUniverse getUniverse();
+}

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

@@ -0,0 +1,11 @@
+package com.kneelawk.graphlib.v3.api.graph;
+
+/**
+ * Mutable access to all graphs in a save (across all levels).
+ */
+public interface GraphWorld extends GraphView {
+    @Override
+    default boolean isClient() {
+        return false;
+    }
+}

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

@@ -0,0 +1,9 @@
+package com.kneelawk.graphlib.v3.api.graph;
+
+import com.kneelawk.graphlib.v3.api.graph.user.GraphNode;
+
+/**
+ * Provides access to a single connected set of {@link GraphNode}s.
+ */
+public interface ImmutableGraph extends Iterable<GraphNode> {
+}

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

@@ -0,0 +1,84 @@
+package com.kneelawk.graphlib.v3.api.graph;
+
+import org.jetbrains.annotations.Nullable;
+
+import net.minecraft.core.BlockPos;
+import net.minecraft.world.level.Level;
+import net.minecraft.world.level.block.entity.BlockEntity;
+import net.minecraft.world.level.block.state.BlockState;
+
+import com.kneelawk.graphlib.v3.api.graph.user.GraphNode;
+import com.kneelawk.graphlib.v3.api.pos.DimensionRef;
+import com.kneelawk.graphlib.v3.api.pos.NodePos;
+
+/**
+ * Holds a graph node and all associated information.
+ */
+public interface NodeHolder {
+    /**
+     * {@return the node pos}
+     */
+    NodePos pos();
+
+    /**
+     * {@return the graph view that this node holder is from}
+     */
+    GraphView graphView();
+
+    /**
+     * {@return the graph node within the node pos}
+     */
+    default GraphNode node() {
+        return pos().node();
+    }
+
+    /**
+     * {@return the dimension reference associated with the node, if any}
+     */
+    @Nullable
+    default DimensionRef dimensionRef() {
+        return pos().dimension();
+    }
+
+    /**
+     * {@return the level associated with this node, if any}
+     */
+    @Nullable
+    default Level level() {
+        DimensionRef ref = dimensionRef();
+        if (ref == null) return null;
+        return graphView().getUniverse().getLevel(ref);
+    }
+
+    /**
+     * {@return the block pos associated with this node, if any}
+     */
+    @Nullable
+    default BlockPos blockPos() {
+        return pos().blockPos();
+    }
+
+    /**
+     * {@return the block state at the position of this node, if this node even has a block position}
+     */
+    @Nullable
+    default BlockState blockState() {
+        Level level = level();
+        if (level == null) return null;
+        BlockPos pos = blockPos();
+        if (pos == null) return null;
+        return level.getBlockState(pos);
+    }
+
+    /**
+     * {@return the block entity at the position of this node, if any}
+     */
+    @Nullable
+    default BlockEntity blockEntity() {
+        Level level = level();
+        if (level == null) return null;
+        BlockPos pos = blockPos();
+        if (pos == null) return null;
+        return level.getBlockEntity(pos);
+    }
+}

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

@@ -0,0 +1,36 @@
+package com.kneelawk.graphlib.v3.api.graph.backend;
+
+import org.jetbrains.annotations.Nullable;
+
+import net.minecraft.world.level.Level;
+
+import com.kneelawk.graphlib.v3.api.pos.DimensionRef;
+
+/**
+ * Manages all nodes for a given type of {@link com.kneelawk.graphlib.v3.api.pos.DimensionRef}.
+ *
+ * @param <R> the type of dimension ref this manager manages.
+ */
+public interface DimensionManager<R extends DimensionRef> {
+    /**
+     * Gets the node dimension for the given dimension reference, if the dimension reference actually references a
+     * valid node dimension that exists.
+     *
+     * @param ref the dimension ref that references the given node dimension.
+     * @return the node dimension referenced by the given dimension ref.
+     */
+    @Nullable NodeDimension getDimension(R ref);
+
+    /**
+     * Gets the level associated with the given dimension reference if the dimension reference actually references a
+     * concrete level.
+     *
+     * @param ref the dimension reference of the level to lookup.
+     * @return the level associated with the given dimension reference.
+     */
+    default @Nullable Level getLevel(R ref) {
+        NodeDimension dimension = getDimension(ref);
+        if (dimension == null) return null;
+        return dimension.getLevel();
+    }
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/graph/backend/DimensionManager.java

@@ -0,0 +1,15 @@
+package com.kneelawk.graphlib.v3.api.graph.backend;
+
+import org.jetbrains.annotations.Nullable;
+
+import net.minecraft.world.level.Level;
+
+/**
+ * Handles nodes for a single node dimension.
+ */
+public interface NodeDimension {
+    /**
+     * {@return the level associated with this node dimension, if this dimension is actually associated with a concrete level}
+     */
+    @Nullable Level getLevel();
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/graph/backend/NodeDimension.java

@@ -0,0 +1,7 @@
+package com.kneelawk.graphlib.v3.api.graph.backend;
+
+/**
+ * Provides access to nodes based on where they are.
+ */
+public interface NodeSpace {
+}

modules/core-xplat/src/main/java/com/kneelawk/graphlib/v3/api/graph/backend/NodeSpace.java

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