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=d98d4c980d96d6d3d472ece2c2db099f3d93e3a6;hpb=74f82a58865d948fa700efbc185a8d057e4a0175;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 d98d4c98..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,30 +1,22 @@ package net.mograsim.logic.model.serializing; import java.io.IOException; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.function.Function; +import java.util.Arrays; +import java.util.Comparator; -import com.google.gson.Gson; 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.components.submodels.SimpleRectangularSubmodelComponent; +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.snippets.symbolrenderers.SimpleRectangularLikeSymbolRenderer.SimpleRectangularLikeParams; import net.mograsim.logic.model.util.JsonHandler; +import net.mograsim.logic.model.util.Version; /** * Creates {@link SubmodelComponent}s from {@link SubmodelComponentParams} @@ -34,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, @@ -61,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, @@ -85,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); } @@ -129,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, Function getIdentifier, String targetPath) throws IOException + public static void serialize(SubmodelComponent comp, IdentifyParams idParams, String targetPath) throws IOException { - JsonHandler.writeJson(serialize(comp, getIdentifier), targetPath); + JsonHandler.writeJson(serialize(comp, idParams), targetPath); } /** - * {@link #serialize(SubmodelComponent, Function)} using "class:" concatenated with a component's complete (canonical) - * class name for the ID of a component. + * {@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, c -> "class:" + c.getClass().getCanonicalName()); + return serialize(comp, new IdentifyParams()); } // "core" methods @@ -157,116 +152,54 @@ 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.setOutlineRenderer(SubmodelComponentSnippetSuppliers.outlineRendererSupplier - .getSnippetSupplier(params.outlineRendererSnippetID).create(comp, params.outlineRendererParams)); + comp.setSubmodelScale(params.innerScale); + comp.setSize(params.width, params.height); + for (InterfacePinParams iPinParams : params.interfacePins) + // 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 + .getSnippetSupplier(params.outlineRendererSnippetID).create(comp, params.outlineRendererParams)); comp.setHighLevelStateHandler(SubmodelComponentSnippetSuppliers.highLevelStateHandlerSupplier .getSnippetSupplier(params.highLevelStateHandlerSnippetID).create(comp, params.highLevelStateHandlerParams)); - 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, componentsByName.get(innerWire.pin1.compName).getPin(innerWire.pin1.pinName), - componentsByName.get(innerWire.pin2.compName).getPin(innerWire.pin2.pinName), innerWire.path); - } return comp; } /** * 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 returned by - * getIdentifier 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, Function getIdentifier) + 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[] comps = new InnerComponentParams[components.size()]; - int i1 = 0; - for (GUIComponent innerComp : components.values()) - { - InnerComponentParams innerParams = new InnerComponentParams(); - comps[i1] = innerParams; - innerParams.pos = new Point(innerComp.getPosX(), innerComp.getPosY()); - DeserializedSubmodelComponent innerCompCasted; - if (innerComp instanceof DeserializedSubmodelComponent - && (innerCompCasted = (DeserializedSubmodelComponent) innerComp).idForSerializingOverride != null) - { - innerParams.id = innerCompCasted.idForSerializingOverride; - innerParams.params = innerCompCasted.paramsForSerializingOverride; - } else - { - innerParams.id = getIdentifier.apply(innerComp); - innerParams.params = innerComp.getParamsForSerializing(); - } - innerParams.name = innerComp.name; - i1++; - } - submodelParams.subComps = comps; - - List wireList = comp.submodel.getWires(); - InnerWireParams wires[] = new InnerWireParams[wireList.size()]; - i1 = 0; - for (GUIWire wire : wireList) - { - InnerWireParams inner = new InnerWireParams(); - wires[i1] = inner; - InnerPinParams pin1Params = new InnerPinParams(), pin2Params = new InnerPinParams(); - - pin1Params.pinName = wire.getPin1().name; - pin1Params.compName = wire.getPin1().component.name; - pin2Params.pinName = wire.getPin2().name; - pin2Params.compName = wire.getPin2().component.name; - inner.pin1 = pin1Params; - inner.pin2 = pin2Params; - inner.path = wire.getPath(); - i1++; - } - submodelParams.innerWires = wires; - - 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(); @@ -280,24 +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)); - // TODO does this code belong here? - if (comp instanceof SimpleRectangularSubmodelComponent) + Renderer symbolRenderer = comp.getSymbolRenderer(); + if (symbolRenderer != null) { - SimpleRectangularSubmodelComponent compCasted = (SimpleRectangularSubmodelComponent) comp; + params.symbolRendererSnippetID = symbolRenderer.getIDForSerializing(idParams); + params.symbolRendererParams = symbolRenderer.getParamsForSerializingJSON(idParams); + } - SimpleRectangularLikeParams symbolRendererParams = new SimpleRectangularLikeParams(); - symbolRendererParams.centerText = compCasted.label; - symbolRendererParams.centerTextHeight = SimpleRectangularSubmodelComponent.labelFontHeight; - symbolRendererParams.horizontalComponentCenter = compCasted.getWidth() / 2; - symbolRendererParams.pinLabelHeight = SimpleRectangularSubmodelComponent.pinNameFontHeight; - symbolRendererParams.pinLabelMargin = SimpleRectangularSubmodelComponent.pinNameMargin; + Renderer outlineRenderer = comp.getOutlineRenderer(); + if (outlineRenderer != null) + { + params.outlineRendererSnippetID = outlineRenderer.getIDForSerializing(idParams); + params.outlineRendererParams = outlineRenderer.getParamsForSerializingJSON(idParams); + } - params.symbolRendererSnippetID = "simpleRectangularLike"; - params.symbolRendererParams = new Gson().toJsonTree(symbolRendererParams); + HighLevelStateHandler highLevelStateHandler = comp.getHighLevelStateHandler(); + if (highLevelStateHandler != null) + { + params.highLevelStateHandlerSnippetID = highLevelStateHandler.getIDForSerializing(idParams); + params.highLevelStateHandlerParams = highLevelStateHandler.getParamsForSerializingJSON(idParams); } return params;