Merge pull request #3055 from daykin/resource-opened-listener

Basic listener so interested parties can see who opened a given resource

Author: kasemir

app/display/representation/src/main/java/org/csstudio/display/builder/representation/ToolkitListener.java

@@ -44,4 +44,12 @@ public interface ToolkitListener
      *  @param value The value
      */
     default public void handleWrite(Widget widget, Object value) {};
+
+    /**
+     * A method was called from the UI that other listeners might be interested in.
+     * @param user_args Zero or more objects relevant to what was called.
+     *      Case-specific Implementations should expect and check these.
+     */
+    default public void handleMethodCalled(Object... user_args) {};
+
 }

app/display/representation/src/main/java/org/csstudio/display/builder/representation/ToolkitRepresentation.java

@@ -689,6 +689,20 @@ public void fireWrite(final Widget widget, final Object value)
         }
     }
 
+    public void fireMethodCall(Object... user_args) {
+        for (final ToolkitListener listener : listeners)
+        {
+            try
+            {
+                listener.handleMethodCalled(user_args);
+            }
+            catch (final Throwable ex)
+            {
+                logger.log(Level.WARNING, "Failure when firing method-call event for " + Thread.currentThread().getStackTrace()[1].getMethodName(), ex);
+            }
+        }
+    };
+
     /** Close the toolkit's "window" that displays a model
      *  @param model Model that has been represented in this toolkit
      *  @throws Exception on error

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/app/DisplayRuntimeInstance.java

@@ -11,6 +11,7 @@
 
 
 import java.awt.geom.Rectangle2D;
+import java.util.ArrayList;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.concurrent.Callable;
@@ -276,7 +277,7 @@ void close()
     }
 
     /** @return Current display info or <code>null</code> */
-    DisplayInfo getDisplayInfo()
+    public DisplayInfo getDisplayInfo()
     {
         return display_info.orElse(null);
     }
@@ -286,14 +287,19 @@ DisplayInfo getDisplayInfo()
      */
     public void loadDisplayFile(final DisplayInfo info)
     {
+        DisplayInfo old_info = display_info.orElse(null);
         // If already executing another display, shut it down
         disposeModel();
 
+        ArrayList<DisplayInfo> dst_src = new ArrayList<>();
+
         // Set input ASAP so that other requests to open this
         // resource will find this instance and not start
         // another instance
         dock_item.setInput(info.toURI());
 
+        StackTraceElement[] applicationThreadStackTrace = Thread.currentThread().getStackTrace();
+
         // Now that old model is no longer represented,
         // show info.
         // Showing this info before disposeModel()
@@ -322,6 +328,9 @@ public void loadDisplayFile(final DisplayInfo info)
                 {
                     representation.awaitRepresentation(30, TimeUnit.SECONDS);
                     representation_init.run();
+                    dst_src.add(info);
+                    dst_src.add(old_info);
+                    representation.fireMethodCall(dst_src, applicationThreadStackTrace);
                     logger.log(Level.FINE, "Done with representing model of " + info.getPath());
                 }
                 catch (TimeoutException | InterruptedException ex)