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