net.mograsim.logic.model/src/net/mograsim/logic/model/serializing/SubmodelComponentSerializer.java

   1 package net.mograsim.logic.model.serializing;
   2
   3 import java.io.IOException;
   4 import java.util.Arrays;
   5 import java.util.Comparator;
   6
   7 import com.google.gson.JsonElement;
   8
   9 import net.mograsim.logic.model.model.ViewModelModifiable;
  10 import net.mograsim.logic.model.model.components.submodels.SubmodelComponent;
  11 import net.mograsim.logic.model.model.wires.MovablePin;
  12 import net.mograsim.logic.model.model.wires.Pin;
  13 import net.mograsim.logic.model.model.wires.PinUsage;
  14 import net.mograsim.logic.model.serializing.SubmodelComponentParams.InterfacePinParams;
  15 import net.mograsim.logic.model.snippets.HighLevelStateHandler;
  16 import net.mograsim.logic.model.snippets.Renderer;
  17 import net.mograsim.logic.model.snippets.SubmodelComponentSnippetSuppliers;
  18 import net.mograsim.logic.model.util.JsonHandler;
  19 import net.mograsim.logic.model.util.Version;
  20
  21 /**
  22  * Creates {@link SubmodelComponent}s from {@link SubmodelComponentParams}
  23  *
  24  * @author Fabian Stemmler
  25  * @author Daniel Kirschten
  26  */
  27 public final class SubmodelComponentSerializer
  28 {
  29         // TODO set pin usages of existing components
  30         public static final Version JSON_VERSION_CURRENT_SERIALIZING = Version.parseSemver("0.1.5");
  31         public static final Version JSON_VERSION_LATEST_SUPPORTED_DESERIALIZING = Version.parseSemver("0.1.5");
  32         public static final Version JSON_VERSION_EARLIEST_WITH_USAGE_SERIALIZED = Version.parseSemver("0.1.4");
  33         // convenience methods
  34
  35         /**
  36          * Like {@link #deserialize(ViewModelModifiable, SubmodelComponentParams)}, but first reading the {@link SubmodelComponentParams} from
  37          * the given file path.
  38          *
  39          * @author Daniel Kirschten
  40          */
  41         public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath) throws IOException
  42         {
  43                 return deserialize(model, JsonHandler.readJson(sourcePath, SubmodelComponentParams.class));
  44         }
  45
  46         /**
  47          * Like {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, JsonElement)}, but first reading the
  48          * {@link SubmodelComponentParams} from the given file path.
  49          *
  50          * @author Daniel Kirschten
  51          */
  52         public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String idForSerializingOverride,
  53                         JsonElement paramsForSerializingOverride) throws IOException
  54         {
  55                 return deserialize(model, JsonHandler.readJson(sourcePath, SubmodelComponentParams.class), idForSerializingOverride,
  56                                 paramsForSerializingOverride);
  57         }
  58
  59         /**
  60          * Like {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String)}, but first reading the
  61          * {@link SubmodelComponentParams} from the given file path.
  62          *
  63          * @author Daniel Kirschten
  64          */
  65         public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String name) throws IOException
  66         {
  67                 return deserialize(model, JsonHandler.readJson(sourcePath, SubmodelComponentParams.class), name);
  68         }
  69
  70         /**
  71          * Like {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement)}, but first reading the
  72          * {@link SubmodelComponentParams} from the given file path.
  73          *
  74          * @author Daniel Kirschten
  75          */
  76         public static SubmodelComponent deserialize(ViewModelModifiable model, String sourcePath, String name, String idForSerializingOverride,
  77                         JsonElement paramsForSerializingOverride) throws IOException
  78         {
  79                 return deserialize(model, JsonHandler.readJson(sourcePath, SubmodelComponentParams.class), name, idForSerializingOverride,
  80                                 paramsForSerializingOverride);
  81         }
  82
  83         /**
  84          * {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement)} with no
  85          * <code>idForSerializingOverride</code> set and using the default name.
  86          *
  87          * @author Daniel Kirschten
  88          */
  89         public static SubmodelComponent deserialize(ViewModelModifiable model, SubmodelComponentParams params)
  90         {
  91                 return deserialize(model, params, null, null, null);
  92         }
  93
  94         /**
  95          * {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement)} using the default name.
  96          *
  97          * @author Daniel Kirschten
  98          */
  99         public static SubmodelComponent deserialize(ViewModelModifiable model, SubmodelComponentParams params, String idForSerializingOverride,
 100                         JsonElement paramsForSerializingOverride)
 101         {
 102                 return deserialize(model, params, null, idForSerializingOverride, paramsForSerializingOverride);
 103         }
 104
 105         /**
 106          * {@link #deserialize(ViewModelModifiable, SubmodelComponentParams, String, String, JsonElement)} with no
 107          * <code>idForSerializingOverride</code> set.
 108          *
 109          * @author Daniel Kirschten
 110          */
 111         public static SubmodelComponent deserialize(ViewModelModifiable model, SubmodelComponentParams params, String name)
 112         {
 113                 return deserialize(model, params, name, null, null);
 114         }
 115
 116         /**
 117          * Like {@link #serialize(SubmodelComponent)}, but instead of returning the generated {@link SubmodelComponentParams} they are written
 118          * to a file at the given path.
 119          *
 120          * @author Daniel Kirschten
 121          */
 122         public static void serialize(SubmodelComponent comp, String targetPath) throws IOException
 123         {
 124                 JsonHandler.writeJson(serialize(comp), targetPath);
 125         }
 126
 127         /**
 128          * Like {@link #serialize(SubmodelComponent, IdentifierGetter)}, but instead of returning the generated {@link SubmodelComponentParams}
 129          * they are written to a file at the given path.
 130          *
 131          * @author Daniel Kirschten
 132          */
 133         public static void serialize(SubmodelComponent comp, IdentifierGetter idGetter, String targetPath) throws IOException
 134         {
 135                 JsonHandler.writeJson(serialize(comp, idGetter), targetPath);
 136         }
 137
 138         /**
 139          * {@link #serialize(SubmodelComponent, IdentifierGetter)} using a default {@link IdentifierGetter} (see <code>IdentifierGetter</code>'s
 140          * {@link IdentifierGetter#IdentifierGetter() default constructor})
 141          *
 142          * @author Daniel Kirschten
 143          */
 144         public static SubmodelComponentParams serialize(SubmodelComponent comp)
 145         {
 146                 return serialize(comp, new IdentifierGetter());
 147         }
 148
 149         // "core" methods
 150         /**
 151          * Creates a {@link SubmodelComponent} from the specified {@link SubmodelComponentParams} with the given name.
 152          * <p>
 153          * When serializing a <code>SubmodelComponent</code>, it is undesired for every subcomponent to be serialized with its complete inner
 154          * structure. Instead, these sub-<code>SubmodelComponent</code>s should be serialized with the ID and params which were used to
 155          * determine the <code>SubmodelComponentParams</code> defining the sub-<code>SubmodelComponent</code>. Because of this, it is possible
 156          * to override the ID and params used in {@link #serialize(SubmodelComponent, IdentifierGetter) serialize(...)} to describe this
 157          * subcomponent. See there for details.
 158          *
 159          * @author Fabian Stemmler
 160          * @author Daniel Kirschten
 161          */
 162         @SuppressWarnings("unused") // for GUIWire being created
 163         public static SubmodelComponent deserialize(ViewModelModifiable model, SubmodelComponentParams params, String name,
 164                         String idForSerializingOverride, JsonElement paramsForSerializingOverride)
 165         {
 166                 Version version = params.version;
 167                 if (version.compareTo(JSON_VERSION_LATEST_SUPPORTED_DESERIALIZING) > 0)
 168                         throw new IllegalArgumentException("JSON version " + version + " not supported yet");
 169                 boolean hasUsageSerialized = version.compareTo(JSON_VERSION_EARLIEST_WITH_USAGE_SERIALIZED) > 0;
 170                 DeserializedSubmodelComponent comp = new DeserializedSubmodelComponent(model, name, idForSerializingOverride,
 171                                 paramsForSerializingOverride);
 172                 comp.setSubmodelScale(params.innerScale);
 173                 comp.setSize(params.width, params.height);
 174                 for (InterfacePinParams iPinParams : params.interfacePins)
 175                         // TRISTATE because we don't have a better choice
 176                         comp.addSubmodelInterface(new MovablePin(comp, iPinParams.name, iPinParams.logicWidth,
 177                                         hasUsageSerialized ? iPinParams.usage : PinUsage.TRISTATE, iPinParams.location.x, iPinParams.location.y));
 178                 ViewModelModifiable submodelModifiable = comp.getSubmodelModifiable();
 179                 ViewModelSerializer.deserialize(comp.getSubmodelModifiable(), params.submodel);
 180                 comp.setSymbolRenderer(SubmodelComponentSnippetSuppliers.symbolRendererSupplier.getSnippetSupplier(params.symbolRendererSnippetID)
 181                                 .create(comp, params.symbolRendererParams));
 182                 comp.setOutlineRenderer(SubmodelComponentSnippetSuppliers.outlineRendererSupplier
 183                                 .getSnippetSupplier(params.outlineRendererSnippetID).create(comp, params.outlineRendererParams));
 184                 comp.setHighLevelStateHandler(SubmodelComponentSnippetSuppliers.highLevelStateHandlerSupplier
 185                                 .getSnippetSupplier(params.highLevelStateHandlerSnippetID).create(comp, params.highLevelStateHandlerParams));
 186                 return comp;
 187         }
 188
 189         /**
 190          * Returns {@link SubmodelComponentParams}, which describe this {@link SubmodelComponent}. <br>
 191          * See {@link ViewModelSerializer#serialize(net.mograsim.logic.model.model.ViewModel, IdentifierGetter)
 192          * ViewModelSerializer.serialize(...)} for how subcomponents are serialized.<br>
 193          * CodeSnippets are serialized using the ID defined by <code>idGetter</code> and the params obtained by the respective
 194          * <coce>getParamsForSerializing</code> methods ({@link Renderer#getParamsForSerializing()}).
 195          *
 196          * @author Fabian Stemmler
 197          * @author Daniel Kirschten
 198          */
 199         public static SubmodelComponentParams serialize(SubmodelComponent comp, IdentifierGetter idGetter)
 200         {
 201                 SubmodelComponentParams params = new SubmodelComponentParams(JSON_VERSION_CURRENT_SERIALIZING);
 202                 params.innerScale = comp.getSubmodelScale();
 203                 params.submodel = ViewModelSerializer.serialize(comp.submodel, idGetter);
 204
 205                 params.width = comp.getWidth();
 206                 params.height = comp.getHeight();
 207
 208                 InterfacePinParams[] iPins = new InterfacePinParams[comp.getPins().size()];
 209                 int i = 0;
 210                 for (Pin p : comp.getPins().values())
 211                 {
 212                         InterfacePinParams iPinParams = new InterfacePinParams();
 213                         iPins[i] = iPinParams;
 214                         iPinParams.location = p.getRelPos();
 215                         iPinParams.name = p.name;
 216                         iPinParams.logicWidth = p.logicWidth;
 217                         iPinParams.usage = p.usage;
 218                         i++;
 219                 }
 220                 params.interfacePins = iPins;
 221                 Arrays.sort(params.interfacePins, Comparator.comparing(p -> p.name));
 222
 223                 Renderer symbolRenderer = comp.getSymbolRenderer();
 224                 if (symbolRenderer != null)
 225                 {
 226                         params.symbolRendererSnippetID = idGetter.symbolRendererIDs.apply(symbolRenderer);
 227                         params.symbolRendererParams = symbolRenderer.getParamsForSerializingJSON(idGetter);
 228                 }
 229
 230                 Renderer outlineRenderer = comp.getOutlineRenderer();
 231                 if (outlineRenderer != null)
 232                 {
 233                         params.outlineRendererSnippetID = idGetter.outlineRendererIDs.apply(outlineRenderer);
 234                         params.outlineRendererParams = outlineRenderer.getParamsForSerializingJSON(idGetter);
 235                 }
 236
 237                 HighLevelStateHandler highLevelStateHandler = comp.getHighLevelStateHandler();
 238                 if (highLevelStateHandler != null)
 239                 {
 240                         params.highLevelStateHandlerSnippetID = idGetter.highLevelStateHandlerIDs.apply(highLevelStateHandler);
 241                         params.highLevelStateHandlerParams = highLevelStateHandler.getParamsForSerializingJSON(idGetter);
 242                 }
 243
 244                 return params;
 245         }
 246 }