Xcos load: do not duplicate children
[scilab.git] / scilab / modules / xcos / src / java / org / scilab / modules / xcos / graph / model / XcosCellFactory.java
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2015-2015 - Scilab Enterprises - Clement DAVID
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10  *
11  */
12
13 package org.scilab.modules.xcos.graph.model;
14
15 import static org.scilab.modules.action_binding.highlevel.ScilabInterpreterManagement.buildCall;
16 import static org.scilab.modules.action_binding.highlevel.ScilabInterpreterManagement.synchronousScilabExec;
17
18 import java.lang.reflect.InvocationTargetException;
19 import java.util.ArrayList;
20 import java.util.Arrays;
21 import java.util.EnumSet;
22 import java.util.HashMap;
23 import java.util.Optional;
24 import java.util.logging.Logger;
25
26 import org.scilab.modules.action_binding.highlevel.ScilabInterpreterManagement.InterpreterException;
27 import org.scilab.modules.graph.utils.ScilabExported;
28 import org.scilab.modules.xcos.JavaController;
29 import org.scilab.modules.xcos.Kind;
30 import org.scilab.modules.xcos.ObjectProperties;
31 import org.scilab.modules.xcos.VectorOfDouble;
32 import org.scilab.modules.xcos.VectorOfScicosID;
33 import org.scilab.modules.xcos.Xcos;
34 import org.scilab.modules.xcos.XcosView;
35 import org.scilab.modules.xcos.block.BasicBlock;
36 import org.scilab.modules.xcos.graph.XcosDiagram;
37 import org.scilab.modules.xcos.link.BasicLink;
38 import org.scilab.modules.xcos.link.CommandControlLink;
39 import org.scilab.modules.xcos.link.ExplicitLink;
40 import org.scilab.modules.xcos.link.ImplicitLink;
41 import org.scilab.modules.xcos.port.BasicPort;
42 import org.scilab.modules.xcos.port.command.CommandPort;
43 import org.scilab.modules.xcos.port.control.ControlPort;
44 import org.scilab.modules.xcos.port.input.ExplicitInputPort;
45 import org.scilab.modules.xcos.port.input.ImplicitInputPort;
46 import org.scilab.modules.xcos.port.output.ExplicitOutputPort;
47 import org.scilab.modules.xcos.port.output.ImplicitOutputPort;
48 import org.scilab.modules.xcos.utils.BlockPositioning;
49
50 import com.mxgraph.model.mxCell;
51 import com.mxgraph.model.mxGeometry;
52 import com.mxgraph.util.mxPoint;
53 import java.util.EnumMap;
54 import org.scilab.modules.xcos.block.SplitBlock;
55 import org.scilab.modules.xcos.block.positionning.RoundBlock;
56 ;
57
58 /**
59  * Ease the creation of any {@link Kind} of graphical object
60  */
61 public final class XcosCellFactory {
62
63     /** Size compatibility for user defined blocks */
64     private static final double DEFAULT_SIZE_FACTOR = 20.0;
65     private static final Logger LOG = Logger.getLogger(XcosCellFactory.class.getName());
66
67     /** Default singleton constructor */
68     private XcosCellFactory() {
69         // This class is a static singleton
70     }
71
72     /**
73      * This is a notify method mapped as a Scilab gateway used to alert with the loaded UID
74      *
75      * @param uid
76      *            the loaded UID
77      * @param kind
78      *            the kind of the created object (as an int)
79      */
80     @ScilabExported(module = "xcos", filename = "XcosCellFactory.giws.xml")
81     public static synchronized void created(long uid, int kind) {
82         lastCreated = new ScicosObjectOwner(uid, Kind.values()[kind]);
83
84     }
85
86     private static ScicosObjectOwner lastCreated = null;
87
88     /**
89      * Retrieve and clear the last created object (<pre>xcosCellCreated</pre> call)
90      * @return the last created object
91      */
92     public static synchronized ScicosObjectOwner getLastCreated() {
93         ScicosObjectOwner last = lastCreated;
94         lastCreated = null;
95         return last;
96     }
97
98     /*
99      * Diagram management
100      */
101
102     /**
103      * Allocate a Java XcosDiagram from a COSF file.
104      *
105      * This method execute the file and register a
106      *
107      * @param controller
108      *            the controller
109      * @param filename
110      *            the file to execute
111      * @return an allocated XcosDiagram
112      */
113     public static XcosDiagram createDiagramFromCOSF(final JavaController controller, String filename) {
114         XcosView view = (XcosView) JavaController.lookup_view(Xcos.class.getName());
115         JavaController.unregister_view(view);
116
117         XcosDiagram diagram;
118         try {
119             synchronousScilabExec(
120                 "function f(), " + buildCall("exec", filename, -1) + "; " + buildCall("xcosCellCreated", "scs_m".toCharArray()) + "endfunction; f();");
121
122             ScicosObjectOwner last = getLastCreated();
123             if (last.getKind() == Kind.DIAGRAM) {
124                 diagram = new XcosDiagram(last.getUID(), last.getKind());
125                 insertChildren(controller, diagram);
126             } else {
127                 diagram = null;
128             }
129         } catch (InterpreterException e) {
130             diagram = null;
131         } finally {
132             JavaController.register_view(Xcos.class.getName(), view);
133         }
134
135         return diagram;
136     }
137
138     /**
139      * Insert the diagram MVC children into the JGraphX model
140      *
141      * @param controller
142      *            the shared controller
143      * @param diagram
144      *            the current diagram instance
145      */
146     public static void insertChildren(JavaController controller, XcosDiagram diagram) {
147         /*
148          * Retrieve the children
149          */
150         VectorOfScicosID children = new VectorOfScicosID();
151         controller.getObjectProperty(diagram.getUID(), diagram.getKind(), ObjectProperties.CHILDREN, children);
152         final int childrenLen = children.size();
153
154         /*
155          * Allocation some pre-sized stash data
156          */
157         final ArrayList<BasicLink> links = new ArrayList<>(childrenLen / 2);
158         final HashMap<Long, BasicPort> ports = new HashMap<>(childrenLen);
159
160         /*
161          * Create the XcosCell objects and store some of them for later use
162          */
163         XcosCell[] cells = new XcosCell[childrenLen];
164         for (int i = 0; i < childrenLen; i++) {
165             final long uid = children.get(i);
166             final Kind kind = controller.getKind(uid);
167
168             switch (kind) {
169                 case ANNOTATION:
170                 case BLOCK:
171                     BasicBlock b = createBlock(controller, uid, kind);
172                     cells[i] = b;
173                     BlockPositioning.updatePortsPosition(diagram, b);
174                     b.getTypedChildrenIndexes(BasicPort.class).stream()
175                     .map(index -> b.getChildAt(index))
176                     .filter(c -> c instanceof BasicPort)
177                     .map(c -> (BasicPort) c)
178                     .forEach(c -> ports.put(c.getUID(), c));
179                     break;
180                 case LINK:
181                     BasicLink l = createLink(controller, uid, kind);
182                     cells[i] = l;
183                     links.add(l);
184                     break;
185                 default:
186                     break;
187             }
188         }
189
190         /*
191          * Relink the links on the XcosCell part
192          */
193         for (BasicLink l : links) {
194             long[] src = new long[1];
195             controller.getObjectProperty(l.getUID(), l.getKind(), ObjectProperties.SOURCE_PORT, src);
196
197             long[] dest = new long[1];
198             controller.getObjectProperty(l.getUID(), l.getKind(), ObjectProperties.DESTINATION_PORT, dest);
199
200             BasicPort srcPort = ports.get(src[0]);
201             if (srcPort != null) {
202                 l.setSource(srcPort);
203             } else {
204                 LOG.severe("Unable to connect link " + l.getId() + " : invalid source " + src[0]);
205             }
206
207             BasicPort destPort = ports.get(dest[0]);
208             if (destPort != null) {
209                 l.setTarget(destPort);
210             } else {
211                 LOG.severe("Unable to connect link " + l.getId() + " : invalid target " + dest[0]);
212             }
213         }
214
215         // re-add the children cells without duplicating them
216         children.clear();
217         controller.setObjectProperty(diagram.getUID(), diagram.getKind(), ObjectProperties.CHILDREN, children);
218
219         diagram.addCells(cells);
220
221         // each cell has been referenced twice (CHILDREN insert and addCells), derefence them all by one
222         Arrays.stream(cells).forEach(c -> controller.deleteObject(c.getUID()));
223     }
224
225     /*
226      * Block and Annotation management
227      */
228
229     /**
230      * Instantiate a new block with the specified interface function.
231      *
232      * @param func
233      *            the interface function
234      * @return A new instance of a block.
235      */
236     public static BasicBlock createBlock(BlockInterFunction func) {
237         return createBlock(func, func.name());
238     }
239
240     /**
241      * Instantiate a new block with the specified UID value and interface function
242      *
243      * @param uid
244      *            The associated UID value
245      * @param interfaceFunction
246      *            the interface function
247      * @return A new instance of a block.
248      */
249     public static BasicBlock createBlock(String interfaceFunction) {
250         Optional<BlockInterFunction> func = EnumSet.allOf(BlockInterFunction.class).stream().filter(f -> f.name().equals(interfaceFunction)).findFirst();
251
252         final BasicBlock block;
253         if (func.isPresent()) {
254             block = createBlock(func.get());
255         } else {
256             block = createBlock(BlockInterFunction.BASIC_BLOCK, interfaceFunction);
257         }
258         block.setStyle(interfaceFunction);
259
260         return block;
261     }
262
263     private static BasicBlock createBlock(BlockInterFunction func, String interfaceFunction) {
264         return createBlock(new JavaController(), func, interfaceFunction);
265     }
266
267     private static BasicBlock createBlock(final JavaController controller, BlockInterFunction func, String interfaceFunction) {
268         BasicBlock block;
269         try {
270             ScicosObjectOwner last;
271
272             if (BlockInterFunction.BASIC_BLOCK.name().equals(interfaceFunction)) {
273                 // deliver all the MVC speed for the casual case
274                 last = new ScicosObjectOwner(controller.createObject(Kind.BLOCK), Kind.BLOCK);
275             } else {
276                 // allocate an empty block that will be filled later
277                 synchronousScilabExec("xcosCellCreated(" + interfaceFunction + "(\"define\")); ");
278                 last = getLastCreated();
279             }
280
281             // defensive programming
282             if (last == null) {
283                 System.err.println("XcosCellFactory#createBlock : unable to allocate " + interfaceFunction);
284                 return null;
285             }
286
287             if (EnumSet.of(Kind.BLOCK, Kind.ANNOTATION).contains(last.getKind())) {
288                 block = createBlock(controller, func, interfaceFunction, last.getUID());
289             } else {
290                 block = null;
291             }
292         } catch (InterpreterException e) {
293             block = null;
294         }
295
296         return block;
297     }
298
299     private static BasicBlock createBlock(final JavaController controller, long uid, Kind kind) {
300         String[] interfaceFunction = new String[1];
301         if (kind == Kind.BLOCK) {
302             controller.getObjectProperty(uid, kind, ObjectProperties.INTERFACE_FUNCTION, interfaceFunction);
303         } else { // ANNOTATION
304             interfaceFunction[0] = "TEXT_f";
305         }
306
307         final BlockInterFunction func = lookForInterfunction(interfaceFunction[0]);
308
309         return createBlock(controller, func, interfaceFunction[0], uid);
310     }
311
312     public static BlockInterFunction lookForInterfunction(String interfaceFunction) {
313         Optional<BlockInterFunction> optFunc = EnumSet.allOf(BlockInterFunction.class).stream().filter(f -> f.name().equals(interfaceFunction)).findFirst();
314
315         final BlockInterFunction func;
316         if (optFunc.isPresent()) {
317             func = optFunc.get();
318         } else {
319             func = BlockInterFunction.BASIC_BLOCK;
320         }
321         return func;
322     }
323
324     /**
325      * Instantiate a new block with the specified interface function and uid.
326      *
327      * @param controller
328      *            the Java controller to use
329      * @param func
330      *            the interface function as an enum
331      * @param interfaceFunction
332      *            the interface function name
333      * @param uid
334      *            the allocated uid
335      * @return A new instance of a block.
336      */
337     public static BasicBlock createBlock(final JavaController controller, BlockInterFunction func, String interfaceFunction, long uid) {
338         BasicBlock block = null;
339         try {
340             block = func.getKlass().getConstructor(Long.TYPE).newInstance(uid);
341         } catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException | NoSuchMethodException
342                      | SecurityException e) {
343             // Something goes wrong, print it.
344             e.printStackTrace();
345             return block;
346         }
347
348         /*
349          * Synchronize model information back to the JGraphX data
350          *
351          * Annotations have no inputs/outputs
352          */
353         EnumMap<ObjectProperties, Integer> properties = new EnumMap<>(ObjectProperties.class);
354         properties.put(ObjectProperties.INPUTS, 0);
355         properties.put(ObjectProperties.OUTPUTS, 0);
356         properties.put(ObjectProperties.EVENT_INPUTS, 0);
357         properties.put(ObjectProperties.EVENT_OUTPUTS, 0);
358         if (block.getKind() == Kind.BLOCK) {
359             insertPortChildren(controller, properties, block);
360         }
361
362         String[] strUID = new String[1];
363         controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.UID, strUID);
364
365         String[] style = new String[1];
366         controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.STYLE, style);
367         if (style[0].isEmpty()) {
368             block.setStyle(interfaceFunction);
369         } else {
370             block.setStyle(style[0]);
371         }
372
373         String value;
374         if (block.getKind() == Kind.ANNOTATION) {
375             String[] description = new String[1];
376             controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.DESCRIPTION, description);
377             value = description[0];
378         } else { // BLOCK
379             String[] label = new String[1];
380             controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.LABEL, label);
381             value = label[0];
382         }
383         block.setValue(value);
384
385         VectorOfDouble geom = new VectorOfDouble(4);
386         controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.GEOMETRY, geom);
387
388         double x = geom.get(0);
389         double y = geom.get(1);
390         double w = geom.get(2);
391         double h = geom.get(3);
392
393         /*
394          * Compatibility to ease user definition :
395          *   * split are not updated as they have an hard-coded fixed-size
396          *   * round blocks : ports globally layout around the block
397          *   * generic case : layout the ports per kind per block-side
398          */
399         boolean convertGeometry;
400         if ((block instanceof SplitBlock)) {
401             convertGeometry = false;
402         } else if (block instanceof RoundBlock) {
403             int numberOfPorts = properties.get(ObjectProperties.INPUTS) +
404                                 properties.get(ObjectProperties.OUTPUTS) +
405                                 properties.get(ObjectProperties.EVENT_INPUTS) +
406                                 properties.get(ObjectProperties.EVENT_OUTPUTS);
407             convertGeometry = (2 * w + 2 * h) < (numberOfPorts * BasicPort.DEFAULT_PORTSIZE);
408         } else {
409             convertGeometry = w < (properties.get(ObjectProperties.INPUTS) * BasicPort.DEFAULT_PORTSIZE) |
410                               w < (properties.get(ObjectProperties.OUTPUTS) * BasicPort.DEFAULT_PORTSIZE) |
411                               h < (properties.get(ObjectProperties.EVENT_INPUTS) * BasicPort.DEFAULT_PORTSIZE) |
412                               h < (properties.get(ObjectProperties.EVENT_OUTPUTS) * BasicPort.DEFAULT_PORTSIZE);
413         }
414
415         if (convertGeometry) {
416             w = w * DEFAULT_SIZE_FACTOR;
417             h = h * DEFAULT_SIZE_FACTOR;
418
419             /*
420              * Invert the y-axis value and translate it.
421              */
422             y = -y - h;
423         }
424
425
426         block.setGeometry(new mxGeometry(x, y, w, h));
427
428         return block;
429     }
430
431     /**
432      * Instantiate a new block for an already created MVC object
433      *
434      * @param lastCreated the owned MVC object
435      * @return a block or null
436      */
437     public static BasicBlock createBlock(final JavaController controller, ScicosObjectOwner lastCreated) {
438         // pre-condition
439         if (lastCreated.getKind() != Kind.ANNOTATION && lastCreated.getKind() != Kind.BLOCK) {
440             return null;
441         }
442
443         String[] interfaceFunction = new String[1];
444         BlockInterFunction func = lookForInterfunction(interfaceFunction[0]);
445
446         return createBlock(controller, func, interfaceFunction[0], lastCreated.getUID());
447     }
448
449     /*
450      * Port management
451      */
452
453     /**
454      * Helper used to create port children on a parent block.
455      *
456      * This method does not manage the model transaction and should be used to preset the children of a block out of an {@link XcosDiagram}.
457      *
458      * @param controller
459      *            is the shared controller instance
460      * @param properties
461      *            specify the kind of port to insert and should be some of :
462      *            <UL>
463      *            <LI>{@link ObjectProperties#INPUTS}
464      *            <LI>{@link ObjectProperties#OUTPUTS}
465      *            <LI>{@link ObjectProperties#EVENT_INPUTS}
466      *            <LI>{@link ObjectProperties#EVENT_OUTPUTS}
467      *            </UL>
468      *            This method will fill the value with the number of added ports
469      * @param parent
470      *            is the parent {@link mxCell} to modify
471      */
472     private static void insertPortChildren(final JavaController controller, final EnumMap<ObjectProperties, Integer> properties, final XcosCell parent) {
473         for (ObjectProperties property : properties.keySet()) {
474             properties.put(property, insertPortChildren(controller, property, parent));
475         }
476     }
477
478     /**
479      * Helper used to create port children on a parent block.
480      *
481      * This method does not manage the model transaction and should be used to preset the children of a block out of an {@link XcosDiagram}.
482      *
483      * @param controller
484      *            is the shared controller instance
485      * @param property
486      *            specify the kind of port to insert and should be one of :
487      *            <UL>
488      *            <LI>{@link ObjectProperties#INPUTS}
489      *            <LI>{@link ObjectProperties#OUTPUTS}
490      *            <LI>{@link ObjectProperties#EVENT_INPUTS}
491      *            <LI>{@link ObjectProperties#EVENT_OUTPUTS}
492      * @param parent
493      *            is the parent {@link mxCell} to modify
494      * @return the number of inserted children
495      */
496     private static int insertPortChildren(final JavaController controller, final ObjectProperties property, final XcosCell parent) {
497         VectorOfScicosID modelChildren = new VectorOfScicosID();
498         controller.getObjectProperty(parent.getUID(), parent.getKind(), property, modelChildren);
499
500         XcosCell[] children = new XcosCell[modelChildren.size()];
501         for (int i = 0; i < children.length; i++) {
502             XcosCell child = createPort(controller, modelChildren.get(i), property);
503             children[i] = child;
504         }
505
506         modelChildren.clear();
507         controller.setObjectProperty(parent.getUID(), parent.getKind(), property, modelChildren);
508
509         Arrays.stream(children).forEach(c -> {
510             parent.insert(c);
511             controller.deleteObject(c.getUID());
512         });
513
514         return children.length;
515     }
516
517     /**
518      * Create a port for a specific uid
519      *
520      * @param controller
521      *            is the shared controller instance
522      * @param uid
523      *            represent the allocated UID on the MVC
524      * @param property
525      *            specify the kind of port to create and should be one of :
526      *            <UL>
527      *            <LI>{@link ObjectProperties#INPUTS}
528      *            <LI>{@link ObjectProperties#OUTPUTS}
529      *            <LI>{@link ObjectProperties#EVENT_INPUTS}
530      *            <LI>{@link ObjectProperties#EVENT_OUTPUTS}
531      * @return a newly allocated port
532      */
533     private static final BasicPort createPort(final JavaController controller, long uid, final ObjectProperties property) {
534         BasicPort port;
535         boolean[] isImplicit = { false };
536
537         switch (property) {
538             case INPUTS:
539                 controller.getObjectProperty(uid, Kind.PORT, ObjectProperties.IMPLICIT, isImplicit);
540                 if (isImplicit[0]) {
541                     port = new ImplicitInputPort(uid);
542                 } else {
543                     port = new ExplicitInputPort(uid);
544                 }
545                 break;
546             case OUTPUTS:
547                 controller.getObjectProperty(uid, Kind.PORT, ObjectProperties.IMPLICIT, isImplicit);
548                 if (isImplicit[0]) {
549                     port = new ImplicitOutputPort(uid);
550                 } else {
551                     port = new ExplicitOutputPort(uid);
552                 }
553                 break;
554             case EVENT_INPUTS:
555                 port = new ControlPort(uid);
556                 break;
557             case EVENT_OUTPUTS:
558                 port = new CommandPort(uid);
559                 break;
560             default:
561                 return null;
562         }
563
564         /*
565          * Setup JGraphX properties
566          */
567
568         String[] childUID = new String[1];
569         controller.getObjectProperty(port.getUID(), port.getKind(), ObjectProperties.UID, childUID);
570         if (!childUID[0].isEmpty()) {
571             port.setId(childUID[0]);
572         }
573
574         return port;
575     }
576
577     /*
578      * Link management
579      */
580
581     private static BasicLink createLink(JavaController controller, long uid, Kind kind) {
582         int[] type = new int[1];
583         controller.getObjectProperty(uid, kind, ObjectProperties.KIND, type);
584
585         BasicLink link;
586         switch (type[0]) {
587             case -1:
588                 link = new CommandControlLink(uid);
589                 break;
590             case 1:
591                 link = new ExplicitLink(uid);
592                 break;
593             case 2:
594                 link = new ImplicitLink(uid);
595                 break;
596             default:
597                 return null;
598         }
599
600         /*
601          * Synchronize model information back to the JGraphX data
602          */
603
604         String[] strUID = new String[1];
605         controller.getObjectProperty(uid, kind, ObjectProperties.UID, strUID);
606         if (!strUID[0].isEmpty()) {
607             link.setId(strUID[0]);
608         }
609
610         VectorOfDouble controlPoints = new VectorOfDouble();
611         controller.getObjectProperty(uid, kind, ObjectProperties.CONTROL_POINTS, controlPoints);
612         final int pointsLen = controlPoints.size() / 2;
613
614         mxGeometry geom = new mxGeometry();
615
616         // as the link is supposed to be connected and accordingly to the JGraphX rules : do not add the origin and destination point
617         ArrayList<mxPoint> points = new ArrayList<>();
618         int i = 0;
619         // ignore origin
620         i++;
621         // loop for points
622         for (; i < pointsLen - 1; i++) {
623             points.add(new mxPoint(controlPoints.get(2 * i), controlPoints.get(2 * i + 1)));
624         }
625         // ignore destination
626         i++;
627
628         geom.setPoints(points);
629         link.setGeometry(geom);
630         return link;
631     }
632
633 }