optimized system of getting block data from their ids

Author: Pesekjak

api/src/main/java/org/machinemc/api/world/BlockData.java

@@ -46,6 +46,12 @@ public static void finishRegistration() {
         BlockDataImpl.finishRegistration();
     }
 
+    /**
+     * Registers the block data to the block data registry.
+     */
+    @ApiStatus.Internal
+    protected abstract void register();
+
     /**
      * @return material of the block data
      */
@@ -54,14 +60,6 @@ public static void finishRegistration() {
     /**
      * Changes base material for the block data and all its
      * variants.
-     * <p>
-     * For example changing material for oak log block data would
-     * change the returned value of {@link #getMaterial()} for all
-     * rotations of the oak log.
-     * <p>
-     * This can lead to unexpected behaviour because then
-     * {@code Material.OAK_LOG.createBlockData().getMaterial()} would return
-     * different material than the one it was created from.
      * @param material new material
      * @return this
      */

api/src/main/java/org/machinemc/api/world/BlockDataImpl.java

@@ -29,8 +29,8 @@
 // This class is used by the code generators, edit with caution.
 class BlockDataImpl extends BlockData {
 
-    private static final Map<Integer, BlockDataImpl> REGISTRY = new TreeMap<>();
-    private static BlockDataImpl[] registryArray = new BlockDataImpl[0];
+    private static final Map<Integer, BlockDataImpl> TEMP_REGISTRY = new TreeMap<>();
+    private static BlockDataImpl[] registryArray;
 
     @Getter
     private Material material;
@@ -40,9 +40,11 @@ class BlockDataImpl extends BlockData {
      * Finishes the registration of the block data to materials.
      */
     public static void finishRegistration() {
-        registryArray = new BlockDataImpl[Iterables.getLast(REGISTRY.keySet()) + 1];
-        for (final Integer stateId : REGISTRY.keySet())
-            registryArray[stateId] = REGISTRY.get(stateId);
+        canRegister();
+        registryArray = new BlockDataImpl[Iterables.getLast(TEMP_REGISTRY.keySet()) + 1];
+        for (final Integer stateId : TEMP_REGISTRY.keySet())
+            registryArray[stateId] = TEMP_REGISTRY.get(stateId);
+        TEMP_REGISTRY.clear();
     }
 
     /**
@@ -55,7 +57,40 @@ public static void finishRegistration() {
         if (registryArray.length <= id) return null;
         final BlockDataImpl data = registryArray[id];
         if (data == null) return null;
-        return data.clone();
+        if (data.id != -1) return data.clone();
+
+        final BlockDataImpl clone = (BlockDataImpl) data.clone();
+        final Object[][] available = clone.getAcceptedProperties();
+        final int[] weights = new int[available.length];
+
+        for (int i = 0; i < weights.length; i++) {
+            int weight = 1;
+            for (int j = i + 1; j < available.length; j++)
+                weight *= available[j].length;
+            weights[i] = weight;
+        }
+
+        final Object[] newData = new Object[available.length];
+        for (int i = 0; i < newData.length; i++)
+            newData[i] = available[i][0];
+
+        int diff = id - clone.firstStateID();
+        int i = 0;
+        while (diff != 0) {
+            final Object[] properties = available[i];
+            for (final Object property : properties) {
+                newData[i] = property;
+                diff -= weights[i];
+                if (diff < 0) {
+                    diff += weights[i];
+                    break;
+                }
+            }
+            i++;
+        }
+
+        clone.loadProperties(newData);
+        return clone;
     }
 
     protected BlockDataImpl(final int id) {
@@ -67,26 +102,39 @@ protected BlockDataImpl() {
     }
 
     @Override
-    protected BlockDataImpl setMaterial(final Material material) {
-        this.material = material;
-        final Map<Integer, BlockData> stateMap = getIdMap();
-        for (final Integer stateId : stateMap.keySet()) {
-            final BlockData data = stateMap.get(stateId).clone();
-            if (!(data instanceof BlockDataImpl blockData))
-                throw new IllegalStateException();
-            blockData.material = material;
-            REGISTRY.put(stateId, blockData);
+    protected void register() {
+        canRegister();
+        if (id != -1) {
+            TEMP_REGISTRY.put(id, this);
+            return;
         }
-        return this;
+
+        int id = firstStateID();
+        final Object[][] available = getAcceptedProperties();
+
+        for (int i = 0; i < available.length; i++) {
+            int weight = 1;
+            for (int j = i + 1; j < available.length; j++)
+                weight *= available[j].length;
+            id += weight * (available[i].length - 1);
+        }
+
+        for (int i = firstStateID(); i < id; i++) TEMP_REGISTRY.put(i, this);
     }
 
     /**
-     * Returns id of the block data.
-     * @param blockData block data to get id from
-     * @return id of the given block data
+     * Checks whether registrations of new block data are allowed.
+     * @throws UnsupportedOperationException if registrations had already finished
      */
-    public static int getId(final BlockData blockData) {
-        return blockData.getId();
+    private static void canRegister() {
+        if (registryArray == null) return;
+        throw new UnsupportedOperationException("Registration has been already finished");
+    }
+
+    @Override
+    protected BlockDataImpl setMaterial(final Material material) {
+        this.material = material;
+        return this;
     }
 
     @Override
@@ -131,13 +179,6 @@ public int getId() {
         return Collections.unmodifiableMap(map);
     }
 
-    /**
-     * @return all block data states for material of this block data mapped to ids
-     */
-    protected @Unmodifiable Map<Integer, BlockData> getIdMap() {
-        return Map.of(id, this);
-    }
-
     /**
      * Returns all data used by the block data (block data properties)
      * in order of their names. {@link BlockDataImpl#getDataNames()}
@@ -182,6 +223,16 @@ protected int firstStateID() {
         return id;
     }
 
+    /**
+     * Loads properties to the block data, their order has to match
+     * the order of their keys, {@link BlockDataImpl#getDataNames()}.
+     * The array needs to provide all properties with correct types.
+     * @param properties properties to load
+     */
+    protected void loadProperties(final Object[] properties) {
+
+    }
+
     @Override
     public String toString() {
         if (getMaterial() != null)

code-generators/src/main/java/org/machinemc/generators/blockdata/BlockData.java

@@ -121,27 +121,21 @@ public byte[] generate() {
         for (final Property property : properties)
             interfaces.add(type(property.getInterfacePath()).getInternalName());
         cw.visit(Opcodes.V17,
-                Opcodes.ACC_PUBLIC,
+                Opcodes.ACC_PUBLIC | Opcodes.ACC_FINAL,
                 type(path).getInternalName(),
                 null,
                 type(BLOCKDATA_CLASS).getInternalName(),
                 interfaces.toArray(new String[0]));
         CodeGenerator.visitGeneratedAnnotation(cw, BlockDataLibGenerator.class);
 
         // Fields
-        FieldVisitor fv = cw.visitField(Opcodes.ACC_PRIVATE | Opcodes.ACC_STATIC | Opcodes.ACC_FINAL,
-                "BLOCKDATA_MAP",
-                Type.getType(HashMap.class).getDescriptor(),
-                "Ljava/util/HashMap<Ljava/lang/Integer;" + type(path).getDescriptor() + ">;",
-                null);
-        fv.visitEnd();
         for (final Property property : properties) {
             final String descriptor = switch (property.getType()) {
                 case BOOLEAN -> Type.BOOLEAN_TYPE.getDescriptor();
                 case NUMBER -> Type.INT_TYPE.getDescriptor();
                 case OTHER -> type(property.getPath()).getDescriptor();
             };
-            fv = cw.visitField(Opcodes.ACC_PRIVATE,
+            final FieldVisitor fv = cw.visitField(Opcodes.ACC_PRIVATE,
                     toCamelCase(property.getName(), false),
                     descriptor,
                     null,
@@ -286,86 +280,6 @@ public byte[] generate() {
         mv.visitEnd();
         cw.visitEnd();
 
-        // Static block
-        mv = cw.visitMethod(Opcodes.ACC_STATIC,
-                "<clinit>",
-                "()V",
-                null,
-                new String[0]);
-        mv.visitCode();
-        mv.visitTypeInsn(Opcodes.NEW, Type.getType(HashMap.class).getInternalName());
-        mv.visitInsn(Opcodes.DUP);
-        mv.visitMethodInsn(Opcodes.INVOKESPECIAL,
-                Type.getType(HashMap.class).getInternalName(),
-                "<init>",
-                "()V",
-                false);
-        mv.visitVarInsn(Opcodes.ASTORE, i);
-        mv.visitVarInsn(Opcodes.ALOAD, i);
-        mv.visitFieldInsn(Opcodes.PUTSTATIC,
-                type(path).getInternalName(),
-                "BLOCKDATA_MAP",
-                Type.getType(HashMap.class).getDescriptor());
-        mv.visitMethodInsn(Opcodes.INVOKESTATIC,
-                type(path).getInternalName(),
-                "initBlockDataMap",
-                "()V",
-                false);
-        mv.visitInsn(Opcodes.RETURN);
-        mv.visitMaxs(0, 0);
-        mv.visitEnd();
-        cw.visitEnd();
-
-        // Init block data map method
-        mv = cw.visitMethod(Opcodes.ACC_PROTECTED | Opcodes.ACC_STATIC,
-                "initBlockDataMap",
-                "()V",
-                null,
-                new String[0]);
-        mv.visitCode();
-        for (final Integer id : blockDataMap.keySet()) {
-            mv.visitFieldInsn(Opcodes.GETSTATIC,
-                    type(path).getInternalName(),
-                    "BLOCKDATA_MAP",
-                    Type.getType(HashMap.class).getDescriptor());
-            final StringBuilder stateKeyBuilder = new StringBuilder();
-            for (final Map.Entry<Property, String> property : blockDataMap.get(id))
-                stateKeyBuilder.append(property.getValue().toLowerCase()).append(";");
-            pushValue(mv, idMap.get(stateKeyBuilder.toString()));
-            mv.visitMethodInsn(Opcodes.INVOKESTATIC,
-                    Type.getType(Integer.class).getInternalName(),
-                    "valueOf",
-                    "(I)Ljava/lang/Integer;",
-                    false);
-            mv.visitTypeInsn(Opcodes.NEW, type(path).getInternalName());
-            mv.visitInsn(Opcodes.DUP);
-            for (final Map.Entry<Property, String> property : blockDataMap.get(id)) {
-                switch (property.getKey().getType()) {
-                    case BOOLEAN -> pushValue(mv, Boolean.parseBoolean(property.getValue()));
-                    case NUMBER -> pushValue(mv, Integer.parseInt(property.getValue()));
-                    case OTHER -> mv.visitFieldInsn(Opcodes.GETSTATIC,
-                            type(property.getKey().getPath()).getInternalName(),
-                            property.getValue().toUpperCase(),
-                            type(property.getKey().getPath()).getDescriptor());
-                }
-            }
-            mv.visitMethodInsn(Opcodes.INVOKESPECIAL,
-                    type(path).getInternalName(),
-                    "<init>",
-                    descriptorBuilder.toString(),
-                    false);
-            mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL,
-                    Type.getType(HashMap.class).getInternalName(),
-                    "put",
-                    "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;",
-                    false);
-            mv.visitInsn(Opcodes.POP);
-        }
-        mv.visitInsn(Opcodes.RETURN);
-        mv.visitMaxs(0, 0);
-        mv.visitEnd();
-        cw.visitEnd();
-
         // getData method
         mv = cw.visitMethod(Opcodes.ACC_PROTECTED,
                 "getData",
@@ -505,20 +419,56 @@ else if (property.getType() == Property.Type.NUMBER)
         mv.visitEnd();
         cw.visitEnd();
 
-        // getIdMap method
+        // loadProperties method
         mv = cw.visitMethod(Opcodes.ACC_PROTECTED,
-                "getIdMap",
-                "()" + Type.getType(Map.class).getDescriptor(),
+                "loadProperties",
+                "(" + Type.getType(Object[].class).getDescriptor() + ")V",
                 null,
                 new String[0]);
         mv.visitAnnotation(Type.getType(Override.class).getDescriptor(), true).visitEnd();
         mv.visitEnd();
         mv.visitCode();
-        mv.visitFieldInsn(Opcodes.GETSTATIC,
-                type(path).getInternalName(),
-                "BLOCKDATA_MAP",
-                Type.getType(HashMap.class).getDescriptor());
-        mv.visitInsn(Opcodes.ARETURN);
+
+        int j = 0;
+        for (final Property property : properties) {
+
+            mv.visitVarInsn(Opcodes.ALOAD, 0);
+            mv.visitVarInsn(Opcodes.ALOAD, 1);
+            pushValue(mv, j);
+            mv.visitInsn(Opcodes.AALOAD);
+            mv.visitTypeInsn(Opcodes.CHECKCAST, (
+                    switch (property.getType()) {
+                        case BOOLEAN -> Type.getType(Boolean.class);
+                        case NUMBER -> Type.getType(Integer.class);
+                        case OTHER -> type(property.getPath()); }
+            ).getInternalName());
+
+            if (property.getType() == Property.Type.BOOLEAN)
+                mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL,
+                        Type.getType(Boolean.class).getInternalName(),
+                        "booleanValue",
+                        "()Z",
+                        false);
+            else if (property.getType() == Property.Type.NUMBER)
+                mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL,
+                        Type.getType(Integer.class).getInternalName(),
+                        "intValue",
+                        "()I",
+                        false);
+
+            mv.visitFieldInsn(Opcodes.PUTFIELD,
+                    type(path).getInternalName(),
+                    toCamelCase(property.getName(), false), (
+                            switch (property.getType()) {
+                                case BOOLEAN -> Type.BOOLEAN_TYPE;
+                                case NUMBER -> Type.INT_TYPE;
+                                case OTHER -> type(property.getPath()); }
+                    ).getDescriptor());
+
+            j++;
+        }
+
+        mv.visitInsn(Opcodes.RETURN);
         mv.visitMaxs(0, 0);
         mv.visitEnd();
         cw.visitEnd();

code-generators/src/main/java/org/machinemc/generators/materials/MaterialsLibGenerator.java

@@ -153,7 +153,11 @@ public void generate() throws IOException {
                 "setMaterial",
                 "(" + type(path).getDescriptor() + ")" + type(iBlockDataPath).getDescriptor(),
                 false);
-        mv.visitInsn(Opcodes.POP);
+        mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL,
+                type(iBlockDataPath).getInternalName(),
+                "register",
+                "()V",
+                false);
         mv.visitJumpInsn(Opcodes.GOTO, end);
 
         mv.visitLabel(end);