SteamWar/BauSystem/BauSystem_Main/src/de/steamwar/bausystem/region/RegionData.java

/*
 *   This file is a part of the SteamWar software.
 *
 *   Copyright (C) 2025 SteamWar.de-Serverteam
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *   GNU Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package de.steamwar.bausystem.region;

import de.steamwar.bausystem.region.flags.Flag;
import de.steamwar.sql.SchematicNode;
import lombok.NonNull;

import java.util.*;
import java.util.function.Function;
import java.util.stream.Stream;

public abstract class RegionData {

    protected RegionDataStore store;

    private final List<Property<?, ?>> properties = new ArrayList<>();

    protected final Map<Flag<?>, Flag.Value<?>> flagMap = new HashMap<>();
    // TODO: These should be turned into an ECS like System because not every Region has them or should have them!
    protected final Property<SchematicNode, Integer> testblockSchematic = new Property<>("testblockSchematic", SchematicNode::byId, SchematicNode::getId);

    protected RegionData(RegionDataStore store) {
        this.store = store;
        initialize();
        store.load(this);
    }

    public final void setStore(RegionDataStore store) {
        this.store = store;
        store.save();
    }

    protected void initialize() {
    }

    /**
     * All connected Regions are required to have the same type as their RegionData.
     */
    protected Stream<Region> connectedRegions() {
        return Stream.empty();
    }

    @NonNull
    public abstract <T extends Enum<T> & Flag.Value<T>> RegionFlagPolicy has(@NonNull Flag<T> flag);

    /**
     * Returns true if the flag was changed and did not already contain the provided value
     */
    public final <T extends Enum<T> & Flag.Value<T>> boolean set(@NonNull Flag<T> flag, @NonNull T value) {
        if (has(flag).isWritable()) {
            boolean needsSave = flagMap.put(flag, value) != value;
            if (needsSave) store.save();

            connectedRegions().forEach(region -> {
                if (region.getRegionData().flagMap.put(flag, value) != value) {
                    region.save();
                }
            });
            return needsSave;
        }
        return false;
    }

    @NonNull
    public final <T extends Enum<T> & Flag.Value<T>> FlagOptional<T> get(@NonNull Flag<T> flag) {
        return FlagOptional.of(flag, (T) flagMap.get(flag));
    }

    public final void clear() {
        Set<Flag> remove = new HashSet<>();
        for (Flag flag : Flag.getFlags()) {
            if (has(flag).isWritable()) {
                flagMap.remove(flag);
                remove.add(flag);
            }
        }
        initialize();
        properties.forEach(property -> property.set(null));
        store.save();

        connectedRegions().forEach(region -> {
            region.getRegionData().flagMap.keySet().removeAll(remove);
            region.getRegionData().initialize();
            region.getRegionData().properties.forEach(property -> property.set(null));
            region.save();
        });
    }

    /**
     * This method only copies all flags and properties from this into other without saving other afterward.
     * TODO: If {@link #connectedRegions()} is overridden this method will not work correctly!
     */
    public final void copyInto(RegionData other) {
        if (this == other) return;
        other.flagMap.clear();
        other.flagMap.putAll(flagMap);
        // TODO: This might not be correct, needs to be investigated
        other.properties.clear();
        other.properties.addAll(properties);
    }

    public final Map<Flag<?>, Flag.Value<?>> getBackedMap() {
        return flagMap;
    }

    public final List<Property<Object, Object>> getBackedProperties() {
        return (List) properties;
    }

    public final SchematicNode getTestblockSchematic() {
        return testblockSchematic.get();
    }

    public final void setTestblockSchematic(SchematicNode schematic) {
        testblockSchematic.set(schematic);
        store.save();
    }

    @Override
    public final String toString() {
        StringBuilder st = new StringBuilder();
        st.append(getClass().getSimpleName()).append("{");
        st.append("flagMap=").append(flagMap);
        for (Property<?, ?> p : properties) {
            st.append(p);
        }
        st.append("}");
        return st.toString();
    }

    public final class Property<T, K> {
        public final String field;
        public final Function<K, T> loader;
        public final Function<T, K> writer;

        private T value;

        private Property(String field, Function<K, T> loader, Function<T, K> writer) {
            this.field = field;
            this.loader = loader;
            this.writer = writer;
            properties.add(this);
        }

        public T get() {
            return value;
        }

        public void set(T value) {
            this.value = value;
        }

        @Override
        public String toString() {
            Object value = this.value;
            if (value != null) value = writer.apply((T) value);
            return ", " + field + "=" + value;
        }
    }
}