Layered: Fixed NPE in polyline and spline edge routers. #587

Signed-off-by: le-cds <zephanya@web.de>
(cherry picked from commit 8d8470a)

Author: le-cds

plugins/org.eclipse.elk.alg.layered/src/org/eclipse/elk/alg/layered/p5edges/PolylineEdgeRouter.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010, 2015 Kiel University and others.
+ * Copyright (c) 2010, 2020 Kiel University and others.
  * 
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -76,9 +76,11 @@ public boolean apply(final LNode node) {
      *     - LABEL_DUMMY_INSERTER
      * 
      * Before phase 3:
+     *   - Always:
+     *     - INVERTED_PORT_PROCESSOR
+     *   
      *   - For non-free ports:
      *     - NORTH_SOUTH_PORT_PREPROCESSOR
-     *     - INVERTED_PORT_PROCESSOR
      *     
      *   - For edge labels:
      *     - LABEL_SIDE_SELECTOR
@@ -107,8 +109,8 @@ public boolean apply(final LNode node) {
      *     - END_LABEL_POSTPROCESSOR
      */
 
-    /** additional processor dependencies for graphs with possible inverted ports. */
-    private static final LayoutProcessorConfiguration<LayeredPhases, LGraph> INVERTED_PORT_PROCESSING_ADDITIONS =
+    /** baseline config. */
+    private static final LayoutProcessorConfiguration<LayeredPhases, LGraph> BASELINE_PROCESSOR_CONFIGURATION =
         LayoutProcessorConfiguration.<LayeredPhases, LGraph>create()
             .addBefore(LayeredPhases.P3_NODE_ORDERING, IntermediateProcessorStrategy.INVERTED_PORT_PROCESSOR);
 
@@ -149,18 +151,13 @@ public LayoutProcessorConfiguration<LayeredPhases, LGraph> getLayoutProcessorCon
 
         // Basic configuration
         LayoutProcessorConfiguration<LayeredPhases, LGraph> configuration =
-                LayoutProcessorConfiguration.<LayeredPhases, LGraph>create();
+                LayoutProcessorConfiguration.createFrom(BASELINE_PROCESSOR_CONFIGURATION);
 
         // Additional dependencies
-        if (graphProperties.contains(GraphProperties.NON_FREE_PORTS)
-                || graph.getProperty(LayeredOptions.FEEDBACK_EDGES)) {
-            
-            configuration.addAll(INVERTED_PORT_PROCESSING_ADDITIONS);
-
-            if (graphProperties.contains(GraphProperties.NORTH_SOUTH_PORTS)) {
-                configuration.addAll(NORTH_SOUTH_PORT_PROCESSING_ADDITIONS);
-            }
+        if (graphProperties.contains(GraphProperties.NORTH_SOUTH_PORTS)) {
+            configuration.addAll(NORTH_SOUTH_PORT_PROCESSING_ADDITIONS);
         }
+        
         if (graphProperties.contains(GraphProperties.SELF_LOOPS)) {
             configuration.addAll(SELF_LOOP_PROCESSING_ADDITIONS);
         }

plugins/org.eclipse.elk.alg.layered/src/org/eclipse/elk/alg/layered/p5edges/splines/SplineEdgeRouter.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010, 2018 Kiel University and others.
+ * Copyright (c) 2010, 2020 Kiel University and others.
  * 
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -84,7 +84,8 @@ public final class SplineEdgeRouter implements ILayoutPhase<LayeredPhases, LGrap
     private static final LayoutProcessorConfiguration<LayeredPhases, LGraph> BASELINE_PROCESSING_ADDITIONS =
             LayoutProcessorConfiguration.<LayeredPhases, LGraph>create()
                 .addAfter(LayeredPhases.P5_EDGE_ROUTING,
-                    IntermediateProcessorStrategy.FINAL_SPLINE_BENDPOINTS_CALCULATOR);
+                    IntermediateProcessorStrategy.FINAL_SPLINE_BENDPOINTS_CALCULATOR)
+                .addBefore(LayeredPhases.P3_NODE_ORDERING, IntermediateProcessorStrategy.INVERTED_PORT_PROCESSOR);
 
     /** additional processor dependencies for graphs with self-loops. */
     private static final LayoutProcessorConfiguration<LayeredPhases, LGraph> SELF_LOOP_PROCESSING_ADDITIONS =
@@ -103,11 +104,6 @@ public final class SplineEdgeRouter implements ILayoutPhase<LayeredPhases, LGrap
                 .addBefore(LayeredPhases.P4_NODE_PLACEMENT, IntermediateProcessorStrategy.LABEL_SIDE_SELECTOR)
                 .addAfter(LayeredPhases.P5_EDGE_ROUTING, IntermediateProcessorStrategy.LABEL_DUMMY_REMOVER);
 
-    /** additional processor dependencies for graphs with possible inverted ports. */
-    private static final LayoutProcessorConfiguration<LayeredPhases, LGraph> INVERTED_PORT_PROCESSING_ADDITIONS =
-            LayoutProcessorConfiguration.<LayeredPhases, LGraph>create()
-                .addBefore(LayeredPhases.P3_NODE_ORDERING, IntermediateProcessorStrategy.INVERTED_PORT_PROCESSOR);
-    
     /** additional processor dependencies for graphs with northern / southern non-free ports. */
     private static final LayoutProcessorConfiguration<LayeredPhases, LGraph> NORTH_SOUTH_PORT_PROCESSING_ADDITIONS =
             LayoutProcessorConfiguration.<LayeredPhases, LGraph>create()
@@ -140,14 +136,8 @@ public LayoutProcessorConfiguration<LayeredPhases, LGraph> getLayoutProcessorCon
             configuration.addAll(CENTER_EDGE_LABEL_PROCESSING_ADDITIONS);
         }
 
-        if (graphProperties.contains(GraphProperties.NON_FREE_PORTS)
-                || graph.getProperty(LayeredOptions.FEEDBACK_EDGES)) {
-            
-            configuration.addAll(INVERTED_PORT_PROCESSING_ADDITIONS);
-
-            if (graphProperties.contains(GraphProperties.NORTH_SOUTH_PORTS)) {
-                configuration.addAll(NORTH_SOUTH_PORT_PROCESSING_ADDITIONS);
-            }
+        if (graphProperties.contains(GraphProperties.NORTH_SOUTH_PORTS)) {
+            configuration.addAll(NORTH_SOUTH_PORT_PROCESSING_ADDITIONS);
         }
 
         if (graphProperties.contains(GraphProperties.END_LABELS)) {

test/org.eclipse.elk.alg.layered.test/src/org/eclipse/elk/alg/layered/issues/Issue587Test.java

@@ -0,0 +1,71 @@
+/*******************************************************************************
+ * Copyright (c) 2020 Kiel University and others.
+ * 
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+package org.eclipse.elk.alg.layered.issues;
+
+import java.util.List;
+
+import org.eclipse.elk.alg.layered.options.LayeredOptions;
+import org.eclipse.elk.alg.test.framework.LayoutTestRunner;
+import org.eclipse.elk.alg.test.framework.annotations.Configurator;
+import org.eclipse.elk.alg.test.framework.annotations.DefaultConfiguration;
+import org.eclipse.elk.alg.test.framework.annotations.GraphResourceProvider;
+import org.eclipse.elk.alg.test.framework.io.AbstractResourcePath;
+import org.eclipse.elk.alg.test.framework.io.FileNameFilter;
+import org.eclipse.elk.alg.test.framework.io.ModelResourcePath;
+import org.eclipse.elk.core.options.EdgeRouting;
+import org.eclipse.elk.graph.ElkNode;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import com.google.common.collect.Lists;
+
+/**
+ * Test for issue 587.
+ */
+@RunWith(LayoutTestRunner.class)
+@DefaultConfiguration()
+public class Issue587Test {
+
+    //////////////////////////////////////////////////////////////////////////////////////////////////////////////
+    // Sources
+
+    @GraphResourceProvider
+    public List<AbstractResourcePath> testGraphs() {
+        return Lists.newArrayList(
+                new ModelResourcePath("tickets/layered/**").withFilter(new FileNameFilter("587.+\\.elkt")));
+    }
+
+    //////////////////////////////////////////////////////////////////////////////////////////////////////////////
+    // Configurations
+
+    @Configurator
+    public void configureOrthogonalEdgeRouting(final ElkNode graph) {
+        graph.setProperty(LayeredOptions.EDGE_ROUTING, EdgeRouting.ORTHOGONAL);
+    }
+
+    @Configurator
+    public void configurePolylineEdgeRouting(final ElkNode graph) {
+        graph.setProperty(LayeredOptions.EDGE_ROUTING, EdgeRouting.POLYLINE);
+    }
+
+    @Configurator
+    public void configureSplineEdgeRouting(final ElkNode graph) {
+        graph.setProperty(LayeredOptions.EDGE_ROUTING, EdgeRouting.SPLINES);
+    }
+
+    //////////////////////////////////////////////////////////////////////////////////////////////////////////////
+    // Tests
+    
+    @Test
+    public void testNoException(final ElkNode graph) {
+        // The bug caused an exception; nothing particular to test here
+    }
+
+}