a8729c027ac197d8b863b90f8ce86ebddb991915
[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 then clear the children to avoid inserting the UIDs twice
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
216         diagram.addCells(cells);
217     }
218
219     /*
220      * Block and Annotation management
221      */
222
223     /**
224      * Instantiate a new block with the specified interface function.
225      *
226      * @param func
227      *            the interface function
228      * @return A new instance of a block.
229      */
230     public static BasicBlock createBlock(BlockInterFunction func) {
231         return createBlock(func, func.name());
232     }
233
234     /**
235      * Instantiate a new block with the specified UID value and interface function
236      *
237      * @param uid
238      *            The associated UID value
239      * @param interfaceFunction
240      *            the interface function
241      * @return A new instance of a block.
242      */
243     public static BasicBlock createBlock(String interfaceFunction) {
244         Optional<BlockInterFunction> func = EnumSet.allOf(BlockInterFunction.class).stream().filter(f -> f.name().equals(interfaceFunction)).findFirst();
245
246         final BasicBlock block;
247         if (func.isPresent()) {
248             block = createBlock(func.get());
249         } else {
250             block = createBlock(BlockInterFunction.BASIC_BLOCK, interfaceFunction);
251         }
252         block.setStyle(interfaceFunction);
253
254         return block;
255     }
256
257     private static BasicBlock createBlock(BlockInterFunction func, String interfaceFunction) {
258         return createBlock(new JavaController(), func, interfaceFunction);
259     }
260
261     private static BasicBlock createBlock(final JavaController controller, BlockInterFunction func, String interfaceFunction) {
262         BasicBlock block;
263         try {
264             ScicosObjectOwner last;
265
266             if (BlockInterFunction.BASIC_BLOCK.name().equals(interfaceFunction)) {
267                 // deliver all the MVC speed for the casual case
268                 last = new ScicosObjectOwner(controller.createObject(Kind.BLOCK), Kind.BLOCK);
269             } else {
270                 // allocate an empty block that will be filled later
271                 synchronousScilabExec("xcosCellCreated(" + interfaceFunction + "(\"define\")); ");
272                 last = getLastCreated();
273             }
274
275             // defensive programming
276             if (last == null) {
277                 System.err.println("XcosCellFactory#createBlock : unable to allocate " + interfaceFunction);
278                 return null;
279             }
280
281             if (EnumSet.of(Kind.BLOCK, Kind.ANNOTATION).contains(last.getKind())) {
282                 block = createBlock(controller, func, interfaceFunction, last.getUID());
283             } else {
284                 block = null;
285             }
286         } catch (InterpreterException e) {
287             block = null;
288         }
289
290         return block;
291     }
292
293     private static BasicBlock createBlock(final JavaController controller, long uid, Kind kind) {
294         String[] interfaceFunction = new String[1];
295         if (kind == Kind.BLOCK) {
296             controller.getObjectProperty(uid, kind, ObjectProperties.INTERFACE_FUNCTION, interfaceFunction);
297         } else { // ANNOTATION
298             interfaceFunction[0] = "TEXT_f";
299         }
300
301         final BlockInterFunction func = lookForInterfunction(interfaceFunction[0]);
302
303         return createBlock(controller, func, interfaceFunction[0], uid);
304     }
305
306     public static BlockInterFunction lookForInterfunction(String interfaceFunction) {
307         Optional<BlockInterFunction> optFunc = EnumSet.allOf(BlockInterFunction.class).stream().filter(f -> f.name().equals(interfaceFunction)).findFirst();
308
309         final BlockInterFunction func;
310         if (optFunc.isPresent()) {
311             func = optFunc.get();
312         } else {
313             func = BlockInterFunction.BASIC_BLOCK;
314         }
315         return func;
316     }
317
318     /**
319      * Instantiate a new block with the specified interface function and uid.
320      *
321      * @param controller
322      *            the Java controller to use
323      * @param func
324      *            the interface function as an enum
325      * @param interfaceFunction
326      *            the interface function name
327      * @param uid
328      *            the allocated uid
329      * @return A new instance of a block.
330      */
331     public static BasicBlock createBlock(final JavaController controller, BlockInterFunction func, String interfaceFunction, long uid) {
332         BasicBlock block = null;
333         try {
334             block = func.getKlass().getConstructor(Long.TYPE).newInstance(uid);
335         } catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException | NoSuchMethodException
336                      | SecurityException e) {
337             // Something goes wrong, print it.
338             e.printStackTrace();
339             return block;
340         }
341
342         /*
343          * Synchronize model information back to the JGraphX data
344          *
345          * Annotations have no inputs/outputs
346          */
347         EnumMap<ObjectProperties, Integer> properties = new EnumMap<>(ObjectProperties.class);
348         properties.put(ObjectProperties.INPUTS, 0);
349         properties.put(ObjectProperties.OUTPUTS, 0);
350         properties.put(ObjectProperties.EVENT_INPUTS, 0);
351         properties.put(ObjectProperties.EVENT_OUTPUTS, 0);
352         if (block.getKind() == Kind.BLOCK) {
353             insertPortChildren(controller, properties, block);
354         }
355
356         String[] strUID = new String[1];
357         controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.UID, strUID);
358
359         String[] style = new String[1];
360         controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.STYLE, style);
361         if (style[0].isEmpty()) {
362             block.setStyle(interfaceFunction);
363         } else {
364             block.setStyle(style[0]);
365         }
366
367         String value;
368         if (block.getKind() == Kind.ANNOTATION) {
369             String[] description = new String[1];
370             controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.DESCRIPTION, description);
371             value = description[0];
372         } else { // BLOCK
373             String[] label = new String[1];
374             controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.LABEL, label);
375             value = label[0];
376         }
377         block.setValue(value);
378
379         VectorOfDouble geom = new VectorOfDouble(4);
380         controller.getObjectProperty(block.getUID(), block.getKind(), ObjectProperties.GEOMETRY, geom);
381
382         double x = geom.get(0);
383         double y = geom.get(1);
384         double w = geom.get(2);
385         double h = geom.get(3);
386
387         /*
388          * Compatibility to ease user definition :
389          *   * split are not updated as they have an hard-coded fixed-size
390          *   * round blocks : ports globally layout around the block
391          *   * generic case : layout the ports per kind per block-side
392          */
393         boolean convertGeometry;
394         if ((block instanceof SplitBlock)) {
395             convertGeometry = false;
396         } else if (block instanceof RoundBlock) {
397             int numberOfPorts = properties.get(ObjectProperties.INPUTS) +
398                                 properties.get(ObjectProperties.OUTPUTS) +
399                                 properties.get(ObjectProperties.EVENT_INPUTS) +
400                                 properties.get(ObjectProperties.EVENT_OUTPUTS);
401             convertGeometry = (2 * w + 2 * h) < (numberOfPorts * BasicPort.DEFAULT_PORTSIZE);
402         } else {
403             convertGeometry = w < (properties.get(ObjectProperties.INPUTS) * BasicPort.DEFAULT_PORTSIZE) |
404                               w < (properties.get(ObjectProperties.OUTPUTS) * BasicPort.DEFAULT_PORTSIZE) |
405                               h < (properties.get(ObjectProperties.EVENT_INPUTS) * BasicPort.DEFAULT_PORTSIZE) |
406                               h < (properties.get(ObjectProperties.EVENT_OUTPUTS) * BasicPort.DEFAULT_PORTSIZE);
407         }
408
409         if (convertGeometry) {
410             w = w * DEFAULT_SIZE_FACTOR;
411             h = h * DEFAULT_SIZE_FACTOR;
412
413             /*
414              * Invert the y-axis value and translate it.
415              */
416             y = -y - h;
417         }
418
419
420         block.setGeometry(new mxGeometry(x, y, w, h));
421
422         return block;
423     }
424
425     /**
426      * Instantiate a new block for an already created MVC object
427      *
428      * @param lastCreated the owned MVC object
429      * @return a block or null
430      */
431     public static BasicBlock createBlock(final JavaController controller, ScicosObjectOwner lastCreated) {
432         // pre-condition
433         if (lastCreated.getKind() != Kind.ANNOTATION && lastCreated.getKind() != Kind.BLOCK) {
434             return null;
435         }
436
437         String[] interfaceFunction = new String[1];
438         BlockInterFunction func = lookForInterfunction(interfaceFunction[0]);
439
440         return createBlock(controller, func, interfaceFunction[0], lastCreated.getUID());
441     }
442
443     /*
444      * Port management
445      */
446
447     /**
448      * Helper used to create port children on a parent block.
449      *
450      * This method does not manage the model transaction and should be used to preset the children of a block out of an {@link XcosDiagram}.
451      *
452      * @param controller
453      *            is the shared controller instance
454      * @param properties
455      *            specify the kind of port to insert and should be some of :
456      *            <UL>
457      *            <LI>{@link ObjectProperties#INPUTS}
458      *            <LI>{@link ObjectProperties#OUTPUTS}
459      *            <LI>{@link ObjectProperties#EVENT_INPUTS}
460      *            <LI>{@link ObjectProperties#EVENT_OUTPUTS}
461      *            </UL>
462      *            This method will fill the value with the number of added ports
463      * @param parent
464      *            is the parent {@link mxCell} to modify
465      */
466     private static void insertPortChildren(final JavaController controller, final EnumMap<ObjectProperties, Integer> properties, final XcosCell parent) {
467         for (ObjectProperties property : properties.keySet()) {
468             properties.put(property, insertPortChildren(controller, property, parent));
469         }
470     }
471
472     /**
473      * Helper used to create port children on a parent block.
474      *
475      * This method does not manage the model transaction and should be used to preset the children of a block out of an {@link XcosDiagram}.
476      *
477      * @param controller
478      *            is the shared controller instance
479      * @param property
480      *            specify the kind of port to insert and should be one of :
481      *            <UL>
482      *            <LI>{@link ObjectProperties#INPUTS}
483      *            <LI>{@link ObjectProperties#OUTPUTS}
484      *            <LI>{@link ObjectProperties#EVENT_INPUTS}
485      *            <LI>{@link ObjectProperties#EVENT_OUTPUTS}
486      * @param parent
487      *            is the parent {@link mxCell} to modify
488      * @return the number of inserted children
489      */
490     private static int insertPortChildren(final JavaController controller, final ObjectProperties property, final XcosCell parent) {
491         VectorOfScicosID modelChildren = new VectorOfScicosID();
492         controller.getObjectProperty(parent.getUID(), parent.getKind(), property, modelChildren);
493
494         XcosCell[] children = new XcosCell[modelChildren.size()];
495         for (int i = 0; i < children.length; i++) {
496             XcosCell child = createPort(controller, modelChildren.get(i), property);
497             children[i] = child;
498         }
499
500         Arrays.stream(children).forEach(c -> parent.insert(c));
501
502         return children.length;
503     }
504
505     /**
506      * Create a port for a specific uid
507      *
508      * @param controller
509      *            is the shared controller instance
510      * @param uid
511      *            represent the allocated UID on the MVC
512      * @param property
513      *            specify the kind of port to create and should be one of :
514      *            <UL>
515      *            <LI>{@link ObjectProperties#INPUTS}
516      *            <LI>{@link ObjectProperties#OUTPUTS}
517      *            <LI>{@link ObjectProperties#EVENT_INPUTS}
518      *            <LI>{@link ObjectProperties#EVENT_OUTPUTS}
519      * @return a newly allocated port
520      */
521     private static final BasicPort createPort(final JavaController controller, long uid, final ObjectProperties property) {
522         BasicPort port;
523         boolean[] isImplicit = { false };
524
525         switch (property) {
526             case INPUTS:
527                 controller.getObjectProperty(uid, Kind.PORT, ObjectProperties.IMPLICIT, isImplicit);
528                 if (isImplicit[0]) {
529                     port = new ImplicitInputPort(uid);
530                 } else {
531                     port = new ExplicitInputPort(uid);
532                 }
533                 break;
534             case OUTPUTS:
535                 controller.getObjectProperty(uid, Kind.PORT, ObjectProperties.IMPLICIT, isImplicit);
536                 if (isImplicit[0]) {
537                     port = new ImplicitOutputPort(uid);
538                 } else {
539                     port = new ExplicitOutputPort(uid);
540                 }
541                 break;
542             case EVENT_INPUTS:
543                 port = new ControlPort(uid);
544                 break;
545             case EVENT_OUTPUTS:
546                 port = new CommandPort(uid);
547                 break;
548             default:
549                 return null;
550         }
551
552         /*
553          * Setup JGraphX properties
554          */
555
556         String[] childUID = new String[1];
557         controller.getObjectProperty(port.getUID(), port.getKind(), ObjectProperties.UID, childUID);
558         if (!childUID[0].isEmpty()) {
559             port.setId(childUID[0]);
560         }
561
562         return port;
563     }
564
565     /*
566      * Link management
567      */
568
569     private static BasicLink createLink(JavaController controller, long uid, Kind kind) {
570         int[] type = new int[1];
571         controller.getObjectProperty(uid, kind, ObjectProperties.KIND, type);
572
573         BasicLink link;
574         switch (type[0]) {
575             case -1:
576                 link = new CommandControlLink(uid);
577                 break;
578             case 1:
579                 link = new ExplicitLink(uid);
580                 break;
581             case 2:
582                 link = new ImplicitLink(uid);
583                 break;
584             default:
585                 return null;
586         }
587
588         /*
589          * Synchronize model information back to the JGraphX data
590          */
591
592         String[] strUID = new String[1];
593         controller.getObjectProperty(uid, kind, ObjectProperties.UID, strUID);
594         if (!strUID[0].isEmpty()) {
595             link.setId(strUID[0]);
596         }
597
598         VectorOfDouble controlPoints = new VectorOfDouble();
599         controller.getObjectProperty(uid, kind, ObjectProperties.CONTROL_POINTS, controlPoints);
600         final int pointsLen = controlPoints.size() / 2;
601
602         mxGeometry geom = new mxGeometry();
603
604         // as the link is supposed to be connected and accordingly to the JGraphX rules : do not add the origin and destination point
605         ArrayList<mxPoint> points = new ArrayList<>();
606         int i = 0;
607         // ignore origin
608         i++;
609         // loop for points
610         for (; i < pointsLen - 1; i++) {
611             points.add(new mxPoint(controlPoints.get(2 * i), controlPoints.get(2 * i + 1)));
612         }
613         // ignore destination
614         i++;
615
616         geom.setPoints(points);
617         link.setGeometry(geom);
618         return link;
619     }
620
621 }