1 package net.mograsim.logic.model.serializing;
3 import java.io.IOException;
4 import java.util.Collection;
5 import java.util.HashMap;
7 import java.util.function.Function;
9 import com.google.gson.JsonElement;
11 import net.haspamelodica.swt.helper.swtobjectwrappers.Point;
12 import net.mograsim.logic.model.model.ViewModelModifiable;
13 import net.mograsim.logic.model.model.components.GUIComponent;
14 import net.mograsim.logic.model.model.components.submodels.SubmodelComponent;
15 import net.mograsim.logic.model.model.wires.GUIWire;
16 import net.mograsim.logic.model.model.wires.MovablePin;
17 import net.mograsim.logic.model.model.wires.Pin;
18 import net.mograsim.logic.model.serializing.LegacySubmodelComponentParams.LegacyInterfacePinParams;
19 import net.mograsim.logic.model.serializing.LegacySubmodelComponentParams.LegacySubmodelParameters;
20 import net.mograsim.logic.model.serializing.LegacySubmodelComponentParams.LegacySubmodelParameters.LegacyInnerComponentParams;
21 import net.mograsim.logic.model.serializing.LegacySubmodelComponentParams.LegacySubmodelParameters.LegacyInnerWireParams;
22 import net.mograsim.logic.model.serializing.LegacySubmodelComponentParams.LegacySubmodelParameters.LegacyInnerWireParams.LegacyInnerPinParams;
23 import net.mograsim.logic.model.snippets.HighLevelStateHandler;
24 import net.mograsim.logic.model.snippets.Renderer;
25 import net.mograsim.logic.model.snippets.SubmodelComponentSnippetSuppliers;
26 import net.mograsim.logic.model.util.JsonHandler;
29 * Creates {@link SubmodelComponent}s from {@link LegacySubmodelComponentParams}
31 * @author Fabian Stemmler
32 * @author Daniel Kirschten
34 public final class LegacySubmodelComponentSerializer
36 // convenience methods
39 * Like {@link #deserialize(ViewModelModifiable, LegacySubmodelComponentParams)}, but first reading the
40 * {@link LegacySubmodelComponentParams} from the given file path.
42 * @author Daniel Kirschten
44 public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath) throws IOException
46 return deserialize(model, JsonHandler.readJson(sourcePath, LegacySubmodelComponentParams.class));
50 * Like {@link #deserialize(ViewModelModifiable, LegacySubmodelComponentParams, String, JsonElement)}, but first reading the
51 * {@link LegacySubmodelComponentParams} from the given file path.
53 * @author Daniel Kirschten
55 public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String idForSerializingOverride,
56 JsonElement paramsForSerializingOverride) throws IOException
58 return deserialize(model, JsonHandler.readJson(sourcePath, LegacySubmodelComponentParams.class), idForSerializingOverride,
59 paramsForSerializingOverride);
63 * Like {@link #deserialize(ViewModelModifiable, LegacySubmodelComponentParams, String)}, but first reading the
64 * {@link LegacySubmodelComponentParams} from the given file path.
66 * @author Daniel Kirschten
68 public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String name) throws IOException
70 return deserialize(model, JsonHandler.readJson(sourcePath, LegacySubmodelComponentParams.class), name);
74 * Like {@link #deserialize(ViewModelModifiable, LegacySubmodelComponentParams, String, String, JsonElement)}, but first reading the
75 * {@link LegacySubmodelComponentParams} from the given file path.
77 * @author Daniel Kirschten
79 public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String name, String idForSerializingOverride,
80 JsonElement paramsForSerializingOverride) throws IOException
82 return deserialize(model, JsonHandler.readJson(sourcePath, LegacySubmodelComponentParams.class), name, idForSerializingOverride,
83 paramsForSerializingOverride);
87 * {@link #deserialize(ViewModelModifiable, LegacySubmodelComponentParams, String, String, JsonElement)} with no
88 * <code>idForSerializingOverride</code> set and using the default name.
90 * @author Daniel Kirschten
92 public static SubmodelComponent deserialize(ViewModelModifiable model, LegacySubmodelComponentParams params)
94 return deserialize(model, params, null, null, null);
98 * {@link #deserialize(ViewModelModifiable, LegacySubmodelComponentParams, String, String, JsonElement)} using the default name.
100 * @author Daniel Kirschten
102 public static SubmodelComponent deserialize(ViewModelModifiable model, LegacySubmodelComponentParams params,
103 String idForSerializingOverride, JsonElement paramsForSerializingOverride)
105 return deserialize(model, params, null, idForSerializingOverride, paramsForSerializingOverride);
109 * {@link #deserialize(ViewModelModifiable, LegacySubmodelComponentParams, String, String, JsonElement)} with no
110 * <code>idForSerializingOverride</code> set.
112 * @author Daniel Kirschten
114 public static SubmodelComponent deserialize(ViewModelModifiable model, LegacySubmodelComponentParams params, String name)
116 return deserialize(model, params, name, null, null);
120 * Like {@link #serialize(SubmodelComponent)}, but instead of returning the generated {@link LegacySubmodelComponentParams} they are
121 * written to a file at the given path.
123 * @author Daniel Kirschten
125 public static void serialize(SubmodelComponent comp, String targetPath) throws IOException
127 JsonHandler.writeJson(serialize(comp), targetPath);
131 * Like {@link #serialize(SubmodelComponent, Function)}, but instead of returning the generated {@link LegacySubmodelComponentParams}
132 * they are written to a file at the given path.
134 * @author Daniel Kirschten
136 public static void serialize(SubmodelComponent comp, IdentifierGetter idGetter, String targetPath) throws IOException
138 JsonHandler.writeJson(serialize(comp, idGetter), targetPath);
142 * {@link #serialize(SubmodelComponent, Function)} using a default {@link IdentifierGetter} (see <code>IdentifierGetter</code>'s
143 * {@link IdentifierGetter#IdentifierGetter() default constructor})
145 * @author Daniel Kirschten
147 public static LegacySubmodelComponentParams serialize(SubmodelComponent comp)
149 return serialize(comp, new IdentifierGetter());
154 * Creates a {@link SubmodelComponent} from the specified {@link LegacySubmodelComponentParams} with the given name.
156 * When serializing a <code>SubmodelComponent</code>, it is undesired for every subcomponent to be serialized with its complete inner
157 * structure. Instead, these sub-<code>SubmodelComponent</code>s should be serialized with the ID and params which were used to
158 * determine the <code>SubmodelComponentParams</code> defining the sub-<code>SubmodelComponent</code>. Because of this, it is possible
159 * to override the ID and params used in {@link #serialize(SubmodelComponent, Function) serialize(...)} to describe this subcomponent.
160 * See there for details.
162 * @author Fabian Stemmler
163 * @author Daniel Kirschten
165 @SuppressWarnings("unused") // for GUIWire being created
166 public static SubmodelComponent deserialize(ViewModelModifiable model, LegacySubmodelComponentParams params, String name,
167 String idForSerializingOverride, JsonElement paramsForSerializingOverride)
169 DeserializedSubmodelComponent comp = new DeserializedSubmodelComponent(model, name, idForSerializingOverride,
170 paramsForSerializingOverride);
171 comp.setSubmodelScale(params.submodel.innerScale);
172 comp.setSize(params.width, params.height);
173 for (LegacyInterfacePinParams iPinParams : params.interfacePins)
174 comp.addSubmodelInterface(
175 new MovablePin(comp, iPinParams.name, iPinParams.logicWidth, iPinParams.location.x, iPinParams.location.y));
176 LegacySubmodelParameters submodelParams = params.submodel;
177 ViewModelModifiable submodelModifiable = comp.getSubmodelModifiable();
178 Map<String, GUIComponent> componentsByName = submodelModifiable.getComponentsByName();
179 GUIComponent[] components = new GUIComponent[submodelParams.subComps.length];
180 for (int i = 0; i < components.length; i++)
182 LegacyInnerComponentParams cParams = submodelParams.subComps[i];
183 components[i] = IndirectGUIComponentCreator.createComponent(submodelModifiable, cParams.id, cParams.params, cParams.name);
184 components[i].moveTo(cParams.pos.x, cParams.pos.y);
187 for (int i = 0; i < submodelParams.innerWires.length; i++)
189 LegacyInnerWireParams innerWire = submodelParams.innerWires[i];
190 new GUIWire(submodelModifiable, innerWire.name, componentsByName.get(innerWire.pin1.compName).getPin(innerWire.pin1.pinName),
191 componentsByName.get(innerWire.pin2.compName).getPin(innerWire.pin2.pinName), innerWire.path);
193 comp.setSymbolRenderer(SubmodelComponentSnippetSuppliers.symbolRendererSupplier.getSnippetSupplier(params.symbolRendererSnippetID)
194 .create(comp, params.symbolRendererParams));
195 comp.setOutlineRenderer(SubmodelComponentSnippetSuppliers.outlineRendererSupplier
196 .getSnippetSupplier(params.outlineRendererSnippetID).create(comp, params.outlineRendererParams));
197 comp.setHighLevelStateHandler(SubmodelComponentSnippetSuppliers.highLevelStateHandlerSupplier
198 .getSnippetSupplier(params.highLevelStateHandlerSnippetID).create(comp, params.highLevelStateHandlerParams));
203 * Returns {@link LegacySubmodelComponentParams}, which describe this {@link SubmodelComponent}. <br>
204 * Subcomponents are serialized in the following way: <br>
205 * If a subcomponent is a <code>SubmodelComponent</code> which has been deserialized, and it has an
206 * {@link DeserializedSubmodelComponent#idForSerializingOverride idForSerializingOverride} set (e.g. non-null; see
207 * {@link #deserialize(ViewModelModifiable, LegacySubmodelComponentParams, String, String, JsonElement) deserialize(...)}), this ID and
208 * the component's {@link DeserializedSubmodelComponent#paramsForSerializingOverride paramsForSerializingOverride} are written.<br>
209 * If this case doesn't apply (e.g. if the subcomponent is not a <code>SubmodelComponent</code>; or it is a
210 * <code>SubmodelComponent</code>, but hasn't been deserialized; or it has no
211 * {@link DeserializedSubmodelComponent#idForSerializingOverride idForSerializingOverride} set), the ID defined by <code>idGetter</code>
212 * and the params obtained by {@link GUIComponent#getParamsForSerializing() getParams()} are written.<br>
213 * CodeSnippets are serialized using the ID defined by <code>idGetter</code> and the params obtained by the respective
214 * <coce>getParamsForSerializing</code> methods ({@link Renderer#getParamsForSerializing()}).
216 * @author Fabian Stemmler
217 * @author Daniel Kirschten
219 public static LegacySubmodelComponentParams serialize(SubmodelComponent comp, IdentifierGetter idGetter)
221 LegacySubmodelParameters submodelParams = new LegacySubmodelParameters();
222 submodelParams.innerScale = comp.getSubmodelScale();
224 Map<String, GUIComponent> components = new HashMap<>(comp.submodel.getComponentsByName());
225 components.remove(SubmodelComponent.SUBMODEL_INTERFACE_NAME);
226 LegacyInnerComponentParams[] componentParams = new LegacyInnerComponentParams[components.size()];
228 for (GUIComponent innerComponent : components.values())
230 LegacyInnerComponentParams innerComponentParams = new LegacyInnerComponentParams();
231 componentParams[i1] = innerComponentParams;
232 innerComponentParams.pos = new Point(innerComponent.getPosX(), innerComponent.getPosY());
233 DeserializedSubmodelComponent innerCompCasted;
234 if (innerComponent instanceof DeserializedSubmodelComponent
235 && (innerCompCasted = (DeserializedSubmodelComponent) innerComponent).idForSerializingOverride != null)
237 innerComponentParams.id = innerCompCasted.idForSerializingOverride;
238 innerComponentParams.params = innerCompCasted.paramsForSerializingOverride;
241 innerComponentParams.id = idGetter.componentIDs.apply(innerComponent);
242 innerComponentParams.params = innerComponent.getParamsForSerializing(idGetter);
244 innerComponentParams.name = innerComponent.name;
247 submodelParams.subComps = componentParams;
249 Collection<GUIWire> wires = comp.submodel.getWiresByName().values();
250 LegacyInnerWireParams wireParams[] = new LegacyInnerWireParams[wires.size()];
252 for (GUIWire innerWire : wires)
254 LegacyInnerWireParams innerWireParams = new LegacyInnerWireParams();
255 wireParams[i1] = innerWireParams;
256 LegacyInnerPinParams pin1Params = new LegacyInnerPinParams(), pin2Params = new LegacyInnerPinParams();
258 pin1Params.pinName = innerWire.getPin1().name;
259 pin1Params.compName = innerWire.getPin1().component.name;
260 pin2Params.pinName = innerWire.getPin2().name;
261 pin2Params.compName = innerWire.getPin2().component.name;
262 innerWireParams.name = innerWire.name;
263 innerWireParams.pin1 = pin1Params;
264 innerWireParams.pin2 = pin2Params;
265 innerWireParams.path = innerWire.getPath();
268 submodelParams.innerWires = wireParams;
270 LegacySubmodelComponentParams params = new LegacySubmodelComponentParams();
271 params.submodel = submodelParams;
273 params.width = comp.getWidth();
274 params.height = comp.getHeight();
276 LegacyInterfacePinParams[] iPins = new LegacyInterfacePinParams[comp.getPins().size()];
278 for (Pin p : comp.getPins().values())
280 LegacyInterfacePinParams iPinParams = new LegacyInterfacePinParams();
281 iPins[i] = iPinParams;
282 iPinParams.location = p.getRelPos();
283 iPinParams.name = p.name;
284 iPinParams.logicWidth = p.logicWidth;
287 params.interfacePins = iPins;
289 Renderer symbolRenderer = comp.getSymbolRenderer();
290 if (symbolRenderer != null)
292 params.symbolRendererSnippetID = idGetter.symbolRendererIDs.apply(symbolRenderer);
293 params.symbolRendererParams = symbolRenderer.getParamsForSerializingJSON(idGetter);
296 Renderer outlineRenderer = comp.getOutlineRenderer();
297 if (outlineRenderer != null)
299 params.outlineRendererSnippetID = idGetter.outlineRendererIDs.apply(outlineRenderer);
300 params.outlineRendererParams = outlineRenderer.getParamsForSerializingJSON(idGetter);
303 HighLevelStateHandler highLevelStateHandler = comp.getHighLevelStateHandler();
304 if (highLevelStateHandler != null)
306 params.highLevelStateHandlerSnippetID = idGetter.highLevelStateHandlerIDs.apply(highLevelStateHandler);
307 params.highLevelStateHandlerParams = highLevelStateHandler.getParamsForSerializingJSON(idGetter);