X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.model%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fmodel%2Fserializing%2FSubmodelComponentSerializer.java;h=cf139885360b3445394b71e822fdf912583f0ed6;hb=8bed58cd47f4e53a0a83e066d38864aa6875502f;hp=077c591a9a80d72a92cd3678595ae10c039c54d1;hpb=3977f16649531ca3ba345c9cd5ec365e0b804783;p=Mograsim.git diff --git a/net.mograsim.logic.model/src/net/mograsim/logic/model/serializing/SubmodelComponentSerializer.java b/net.mograsim.logic.model/src/net/mograsim/logic/model/serializing/SubmodelComponentSerializer.java index 077c591a..cf139885 100644 --- a/net.mograsim.logic.model/src/net/mograsim/logic/model/serializing/SubmodelComponentSerializer.java +++ b/net.mograsim.logic.model/src/net/mograsim/logic/model/serializing/SubmodelComponentSerializer.java @@ -1,29 +1,22 @@ package net.mograsim.logic.model.serializing; import java.io.IOException; -import java.util.Collection; -import java.util.HashMap; -import java.util.Map; -import java.util.function.Function; +import java.util.Arrays; +import java.util.Comparator; import com.google.gson.JsonElement; -import net.haspamelodica.swt.helper.swtobjectwrappers.Point; -import net.mograsim.logic.model.model.ViewModelModifiable; -import net.mograsim.logic.model.model.components.GUIComponent; +import net.mograsim.logic.model.model.LogicModelModifiable; import net.mograsim.logic.model.model.components.submodels.SubmodelComponent; -import net.mograsim.logic.model.model.wires.GUIWire; import net.mograsim.logic.model.model.wires.MovablePin; import net.mograsim.logic.model.model.wires.Pin; +import net.mograsim.logic.model.model.wires.PinUsage; import net.mograsim.logic.model.serializing.SubmodelComponentParams.InterfacePinParams; -import net.mograsim.logic.model.serializing.SubmodelComponentParams.SubmodelParameters; -import net.mograsim.logic.model.serializing.SubmodelComponentParams.SubmodelParameters.InnerComponentParams; -import net.mograsim.logic.model.serializing.SubmodelComponentParams.SubmodelParameters.InnerWireParams; -import net.mograsim.logic.model.serializing.SubmodelComponentParams.SubmodelParameters.InnerWireParams.InnerPinParams; import net.mograsim.logic.model.snippets.HighLevelStateHandler; import net.mograsim.logic.model.snippets.Renderer; import net.mograsim.logic.model.snippets.SubmodelComponentSnippetSuppliers; import net.mograsim.logic.model.util.JsonHandler; +import net.mograsim.logic.model.util.Version; /** * Creates {@link SubmodelComponent}s from {@link SubmodelComponentParams} @@ -33,26 +26,29 @@ import net.mograsim.logic.model.util.JsonHandler; */ public final class SubmodelComponentSerializer { + public static final Version JSON_VERSION_CURRENT_SERIALIZING = Version.parseSemver("0.1.5"); + public static final Version JSON_VERSION_LATEST_SUPPORTED_DESERIALIZING = Version.parseSemver("0.1.5"); + public static final Version JSON_VERSION_EARLIEST_WITH_USAGE_SERIALIZED = Version.parseSemver("0.1.5"); // convenience methods /** - * Like {@link #deserialize(ViewModelModifiable, SubmodelComponentParams)}, but first reading the {@link SubmodelComponentParams} from + * Like {@link #deserialize(LogicModelModifiable, SubmodelComponentParams)}, but first reading the {@link SubmodelComponentParams} from * the given file path. * * @author Daniel Kirschten */ - public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath) throws IOException + public static SubmodelComponent deserialize(LogicModelModifiable model, String sourcePath) throws IOException { return deserialize(model, JsonHandler.readJson(sourcePath, SubmodelComponentParams.class)); } /** - * Like {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, JsonElement)}, but first reading the + * Like {@link #deserialize(LogicModelModifiable, SubmodelComponentParams, String, JsonElement)}, but first reading the * {@link SubmodelComponentParams} from the given file path. * * @author Daniel Kirschten */ - public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String idForSerializingOverride, + public static SubmodelComponent deserialize(LogicModelModifiable model, String sourcePath, String idForSerializingOverride, JsonElement paramsForSerializingOverride) throws IOException { return deserialize(model, JsonHandler.readJson(sourcePath, SubmodelComponentParams.class), idForSerializingOverride, @@ -60,23 +56,23 @@ public final class SubmodelComponentSerializer } /** - * Like {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String)}, but first reading the + * Like {@link #deserialize(LogicModelModifiable, SubmodelComponentParams, String)}, but first reading the * {@link SubmodelComponentParams} from the given file path. * * @author Daniel Kirschten */ - public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String name) throws IOException + public static SubmodelComponent deserialize(LogicModelModifiable model, String sourcePath, String name) throws IOException { return deserialize(model, JsonHandler.readJson(sourcePath, SubmodelComponentParams.class), name); } /** - * Like {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement)}, but first reading the + * Like {@link #deserialize(LogicModelModifiable, SubmodelComponentParams, String, String, JsonElement)}, but first reading the * {@link SubmodelComponentParams} from the given file path. * * @author Daniel Kirschten */ - public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String name, String idForSerializingOverride, + public static SubmodelComponent deserialize(LogicModelModifiable model, String sourcePath, String name, String idForSerializingOverride, JsonElement paramsForSerializingOverride) throws IOException { return deserialize(model, JsonHandler.readJson(sourcePath, SubmodelComponentParams.class), name, idForSerializingOverride, @@ -84,34 +80,34 @@ public final class SubmodelComponentSerializer } /** - * {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement)} with no + * {@link #deserialize(LogicModelModifiable, SubmodelComponentParams, String, String, JsonElement)} with no * idForSerializingOverride set and using the default name. * * @author Daniel Kirschten */ - public static SubmodelComponent deserialize(ViewModelModifiable model, SubmodelComponentParams params) + public static SubmodelComponent deserialize(LogicModelModifiable model, SubmodelComponentParams params) { return deserialize(model, params, null, null, null); } /** - * {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement)} using the default name. + * {@link #deserialize(LogicModelModifiable, SubmodelComponentParams, String, String, JsonElement)} using the default name. * * @author Daniel Kirschten */ - public static SubmodelComponent deserialize(ViewModelModifiable model, SubmodelComponentParams params, String idForSerializingOverride, + public static SubmodelComponent deserialize(LogicModelModifiable model, SubmodelComponentParams params, String idForSerializingOverride, JsonElement paramsForSerializingOverride) { return deserialize(model, params, null, idForSerializingOverride, paramsForSerializingOverride); } /** - * {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement)} with no + * {@link #deserialize(LogicModelModifiable, SubmodelComponentParams, String, String, JsonElement)} with no * idForSerializingOverride set. * * @author Daniel Kirschten */ - public static SubmodelComponent deserialize(ViewModelModifiable model, SubmodelComponentParams params, String name) + public static SubmodelComponent deserialize(LogicModelModifiable model, SubmodelComponentParams params, String name) { return deserialize(model, params, name, null, null); } @@ -128,25 +124,25 @@ public final class SubmodelComponentSerializer } /** - * Like {@link #serialize(SubmodelComponent, Function)}, but instead of returning the generated {@link SubmodelComponentParams} they are - * written to a file at the given path. + * Like {@link #serialize(SubmodelComponent, IdentifyParams)}, but instead of returning the generated {@link SubmodelComponentParams} + * they are written to a file at the given path. * * @author Daniel Kirschten */ - public static void serialize(SubmodelComponent comp, IdentifierGetter idGetter, String targetPath) throws IOException + public static void serialize(SubmodelComponent comp, IdentifyParams idParams, String targetPath) throws IOException { - JsonHandler.writeJson(serialize(comp, idGetter), targetPath); + JsonHandler.writeJson(serialize(comp, idParams), targetPath); } /** - * {@link #serialize(SubmodelComponent, Function)} using a default {@link IdentifierGetter} (see IdentifierGetter's - * {@link IdentifierGetter#IdentifierGetter() default constructor}) + * {@link #serialize(SubmodelComponent, IdentifyParams)} using the default {@link IdentifyParams} (see IdentifyParams's + * {@link IdentifyParams#IdentifyParams() default constructor}) * * @author Daniel Kirschten */ public static SubmodelComponentParams serialize(SubmodelComponent comp) { - return serialize(comp, new IdentifierGetter()); + return serialize(comp, new IdentifyParams()); } // "core" methods @@ -156,40 +152,30 @@ public final class SubmodelComponentSerializer * When serializing a SubmodelComponent, it is undesired for every subcomponent to be serialized with its complete inner * structure. Instead, these sub-SubmodelComponents should be serialized with the ID and params which were used to * determine the SubmodelComponentParams defining the sub-SubmodelComponent. Because of this, it is possible - * to override the ID and params used in {@link #serialize(SubmodelComponent, Function) serialize(...)} to describe this subcomponent. - * See there for details. + * to override the ID and params used in {@link #serialize(SubmodelComponent, IdentifyParams) serialize(...)} to describe this + * subcomponent. See there for details. * * @author Fabian Stemmler * @author Daniel Kirschten */ - @SuppressWarnings("unused") // for GUIWire being created - public static SubmodelComponent deserialize(ViewModelModifiable model, SubmodelComponentParams params, String name, + @SuppressWarnings("unused") // for ModelWire being created + public static SubmodelComponent deserialize(LogicModelModifiable model, SubmodelComponentParams params, String name, String idForSerializingOverride, JsonElement paramsForSerializingOverride) { + Version version = params.version; + if (version.compareTo(JSON_VERSION_LATEST_SUPPORTED_DESERIALIZING) > 0) + throw new IllegalArgumentException("JSON version " + version + " not supported yet"); + boolean hasUsageSerialized = version.compareTo(JSON_VERSION_EARLIEST_WITH_USAGE_SERIALIZED) >= 0; DeserializedSubmodelComponent comp = new DeserializedSubmodelComponent(model, name, idForSerializingOverride, paramsForSerializingOverride); - comp.setSubmodelScale(params.submodel.innerScale); + comp.setSubmodelScale(params.innerScale); comp.setSize(params.width, params.height); for (InterfacePinParams iPinParams : params.interfacePins) - comp.addSubmodelInterface( - new MovablePin(comp, iPinParams.name, iPinParams.logicWidth, iPinParams.location.x, iPinParams.location.y)); - SubmodelParameters submodelParams = params.submodel; - ViewModelModifiable submodelModifiable = comp.getSubmodelModifiable(); - Map componentsByName = submodelModifiable.getComponentsByName(); - GUIComponent[] components = new GUIComponent[submodelParams.subComps.length]; - for (int i = 0; i < components.length; i++) - { - InnerComponentParams cParams = submodelParams.subComps[i]; - components[i] = IndirectGUIComponentCreator.createComponent(submodelModifiable, cParams.id, cParams.params, cParams.name); - components[i].moveTo(cParams.pos.x, cParams.pos.y); - } - - for (int i = 0; i < submodelParams.innerWires.length; i++) - { - InnerWireParams innerWire = submodelParams.innerWires[i]; - new GUIWire(submodelModifiable, innerWire.name, componentsByName.get(innerWire.pin1.compName).getPin(innerWire.pin1.pinName), - componentsByName.get(innerWire.pin2.compName).getPin(innerWire.pin2.pinName), innerWire.path); - } + // TRISTATE because we don't have a better choice + comp.addSubmodelInterface(new MovablePin(model, comp, iPinParams.name, iPinParams.logicWidth, + hasUsageSerialized ? iPinParams.usage : PinUsage.TRISTATE, iPinParams.location.x, iPinParams.location.y)); + LogicModelModifiable submodelModifiable = comp.getSubmodelModifiable(); + LogicModelSerializer.deserialize(comp.getSubmodelModifiable(), params.submodel); comp.setSymbolRenderer(SubmodelComponentSnippetSuppliers.symbolRendererSupplier.getSnippetSupplier(params.symbolRendererSnippetID) .create(comp, params.symbolRendererParams)); comp.setOutlineRenderer(SubmodelComponentSnippetSuppliers.outlineRendererSupplier @@ -201,74 +187,19 @@ public final class SubmodelComponentSerializer /** * Returns {@link SubmodelComponentParams}, which describe this {@link SubmodelComponent}.
- * Subcomponents are serialized in the following way:
- * If a subcomponent is a SubmodelComponent which has been deserialized, and it has an - * {@link DeserializedSubmodelComponent#idForSerializingOverride idForSerializingOverride} set (e.g. non-null; see - * {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement) deserialize(...)}), this ID and the - * component's {@link DeserializedSubmodelComponent#paramsForSerializingOverride paramsForSerializingOverride} are written.
- * If this case doesn't apply (e.g. if the subcomponent is not a SubmodelComponent; or it is a - * SubmodelComponent, but hasn't been deserialized; or it has no - * {@link DeserializedSubmodelComponent#idForSerializingOverride idForSerializingOverride} set), the ID defined by idGetter - * and the params obtained by {@link GUIComponent#getParamsForSerializing() getParams()} are written.
+ * See {@link LogicModelSerializer#serialize(net.mograsim.logic.model.model.LogicModel, IdentifierGetter) + * LogicModelSerializer.serialize(...)} for how subcomponents are serialized.
* CodeSnippets are serialized using the ID defined by idGetter and the params obtained by the respective * getParamsForSerializing methods ({@link Renderer#getParamsForSerializing()}). * * @author Fabian Stemmler * @author Daniel Kirschten */ - public static SubmodelComponentParams serialize(SubmodelComponent comp, IdentifierGetter idGetter) + public static SubmodelComponentParams serialize(SubmodelComponent comp, IdentifyParams idParams) { - SubmodelParameters submodelParams = new SubmodelParameters(); - submodelParams.innerScale = comp.getSubmodelScale(); - - Map components = new HashMap<>(comp.submodel.getComponentsByName()); - components.remove(SubmodelComponent.SUBMODEL_INTERFACE_NAME); - InnerComponentParams[] componentParams = new InnerComponentParams[components.size()]; - int i1 = 0; - for (GUIComponent innerComponent : components.values()) - { - InnerComponentParams innerComponentParams = new InnerComponentParams(); - componentParams[i1] = innerComponentParams; - innerComponentParams.pos = new Point(innerComponent.getPosX(), innerComponent.getPosY()); - DeserializedSubmodelComponent innerCompCasted; - if (innerComponent instanceof DeserializedSubmodelComponent - && (innerCompCasted = (DeserializedSubmodelComponent) innerComponent).idForSerializingOverride != null) - { - innerComponentParams.id = innerCompCasted.idForSerializingOverride; - innerComponentParams.params = innerCompCasted.paramsForSerializingOverride; - } else - { - innerComponentParams.id = idGetter.componentIDs.apply(innerComponent); - innerComponentParams.params = innerComponent.getParamsForSerializing(idGetter); - } - innerComponentParams.name = innerComponent.name; - i1++; - } - submodelParams.subComps = componentParams; - - Collection wires = comp.submodel.getWiresByName().values(); - InnerWireParams wireParams[] = new InnerWireParams[wires.size()]; - i1 = 0; - for (GUIWire innerWire : wires) - { - InnerWireParams innerWireParams = new InnerWireParams(); - wireParams[i1] = innerWireParams; - InnerPinParams pin1Params = new InnerPinParams(), pin2Params = new InnerPinParams(); - - pin1Params.pinName = innerWire.getPin1().name; - pin1Params.compName = innerWire.getPin1().component.name; - pin2Params.pinName = innerWire.getPin2().name; - pin2Params.compName = innerWire.getPin2().component.name; - innerWireParams.name = innerWire.name; - innerWireParams.pin1 = pin1Params; - innerWireParams.pin2 = pin2Params; - innerWireParams.path = innerWire.getPath(); - i1++; - } - submodelParams.innerWires = wireParams; - - SubmodelComponentParams params = new SubmodelComponentParams(); - params.submodel = submodelParams; + SubmodelComponentParams params = new SubmodelComponentParams(JSON_VERSION_CURRENT_SERIALIZING); + params.innerScale = comp.getSubmodelScale(); + params.submodel = LogicModelSerializer.serialize(comp.submodel, idParams); params.width = comp.getWidth(); params.height = comp.getHeight(); @@ -282,29 +213,31 @@ public final class SubmodelComponentSerializer iPinParams.location = p.getRelPos(); iPinParams.name = p.name; iPinParams.logicWidth = p.logicWidth; + iPinParams.usage = p.usage; i++; } params.interfacePins = iPins; + Arrays.sort(params.interfacePins, Comparator.comparing(p -> p.name)); Renderer symbolRenderer = comp.getSymbolRenderer(); if (symbolRenderer != null) { - params.symbolRendererSnippetID = idGetter.symbolRendererIDs.apply(symbolRenderer); - params.symbolRendererParams = symbolRenderer.getParamsForSerializingJSON(idGetter); + params.symbolRendererSnippetID = symbolRenderer.getIDForSerializing(idParams); + params.symbolRendererParams = symbolRenderer.getParamsForSerializingJSON(idParams); } Renderer outlineRenderer = comp.getOutlineRenderer(); if (outlineRenderer != null) { - params.outlineRendererSnippetID = idGetter.outlineRendererIDs.apply(outlineRenderer); - params.outlineRendererParams = outlineRenderer.getParamsForSerializingJSON(idGetter); + params.outlineRendererSnippetID = outlineRenderer.getIDForSerializing(idParams); + params.outlineRendererParams = outlineRenderer.getParamsForSerializingJSON(idParams); } HighLevelStateHandler highLevelStateHandler = comp.getHighLevelStateHandler(); if (highLevelStateHandler != null) { - params.highLevelStateHandlerSnippetID = idGetter.highLevelStateHandlerIDs.apply(highLevelStateHandler); - params.highLevelStateHandlerParams = highLevelStateHandler.getParamsForSerializingJSON(idGetter); + params.highLevelStateHandlerSnippetID = highLevelStateHandler.getIDForSerializing(idParams); + params.highLevelStateHandlerParams = highLevelStateHandler.getParamsForSerializingJSON(idParams); } return params;