Changeset 296

Timestamp:

09/09/08 12:12:25 (16 years ago)

Author:

bjn8

Message:

3rd party agents can load themselves into expeditee agent collection at runtime

Location:

trunk/src/org/expeditee

Files:

• actions/Actions.java (modified) (9 diffs)
• gui/FrameGraphics.java (modified) (6 diffs)
• items/widgets/InteractiveWidget.java (modified) (7 diffs)

trunk/src/org/expeditee/actions/Actions.java

@@ -13 +13 @@
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Set;
 import java.util.jar.JarFile;
 import java.util.zip.ZipEntry;
@@ -63 +64 @@
         private static HashMap<String, String> _Fonts = new HashMap<String, String>();
 
-        // maps lower case JAG class names to capitalized JAG names
+        // maps lower case JAG class names to capitalized JAG full class names
         private static HashMap<String, String> _JAGs = new HashMap<String, String>();
 
@@ -207 +208 @@
                                 String name = classes[i].getSimpleName();
                                 // maps lower case name to correct capitalised name
-                                _JAGs.put(name.toLowerCase(), name);
+                                _JAGs.put(name.toLowerCase(), classes[i].getName());
                         }
 
@@ -254 +255 @@
 
         /**
+         * Temporary, if a plugin system is devised then this would porbably become redundant.
+         * For now this allows external agents to be included.
+         *
+         * @param fullClassNames
+         *              A set of full class names, that is, the class package and name. For example"
+         *              "org.myplugin.agents.SerializedSearch"
+         * 
+         * @return
+         *              A collection of classes their were omitted because either there was a name clash
+         *              with existing agents or did not exist.
+         *              i.e. is completely successful this will be empty. Never null.
+         * 
+         * @throws NullPointerException
+         *              If fullClassNames is null.
+         *              
+         */
+        public static Collection<String> addAgents(Set<String> fullClassNames) {
+                if (fullClassNames == null) throw new NullPointerException("fullClassNames");
+                
+                List<String> omittedAgents = new LinkedList<String>();
+                
+                for (String fullName : fullClassNames) {
+                        
+                        if (fullName == null || fullName.length() == 0) continue;
+                        
+                        boolean didAdd = false;
+                
+                        try {
+                                // Does the class even exist?
+                                Class c = Class.forName(fullName);
+                                
+                                String name = c.getSimpleName().toLowerCase();
+
+                                if (!_JAGs.containsKey(name)) {
+                                        
+                                        _JAGs.put(name, fullName);
+                                        didAdd = true;
+                                        
+                                }
+
+                        } catch (ClassNotFoundException e) { // Nope it does not exist
+                                e.printStackTrace();
+                        }
+                        
+                        if (!didAdd) omittedAgents.add(fullName);
+        
+                }
+                        
+        
+                return omittedAgents;
+        }
+        
+        /**
          * Loads all the Methods that meet the requirements checked by MethodCheck
          * into the hashtable.
@@ -413 +467 @@
                 String nameWithCorrectCase = name;
                 name = name.toLowerCase();
+                
+                String fullClassName = AGENTS_PACKAGE + name;
 
                 try {
                         // check for stored capitalisation
                         if (_JAGs.containsKey(name)) {
-                                name = _JAGs.get(name);
+                                fullClassName = _JAGs.get(name);
                         } else if (name.endsWith("tree")) {
                                 parameters = name.substring(0, name.length() - "tree".length())
                                                 + " " + parameters;
-                                name = "writetree";
+                                fullClassName = AGENTS_PACKAGE + "writetree";
+                                
                         } else if (name.endsWith("frame")) {
                                 parameters = name
                                                 .substring(0, name.length() - "frame".length())
                                                 + " " + parameters;
-                                name = "writeframe";
+                                fullClassName = AGENTS_PACKAGE + "writeframe";
                         }
 
                         // load the JAG class
-                        Class agentClass = Class.forName(AGENTS_PACKAGE + name);
+                        Class agentClass = Class.forName(fullClassName);
 
                         // get the constructor for the JAG class
@@ -491 +548 @@
 
                         // create the JAG
-                        _Agent = (Agent) con.newInstance(params);
-
+                        Agent toLaunch = (Agent) con.newInstance(params);
+                        
+                        LaunchAgent(toLaunch, source, clicked);
+
+                } catch (ClassNotFoundException cnf) {
+                        _Agent = null;
+                        throw new RuntimeException(nameWithCorrectCase
+                                        + "' is not an action or agent.");
+                } 
+        }
+        
+        /**
+         * Launches an agent from a aleady instantiated object.
+         * 
+         * @param agent
+         *              The agent to launch. Must not be null.
+         * 
+         * @param source
+         *              The calling frame that launched it. Must not be null.
+         * 
+         * @param itemParam
+         *              The item paremeter for the agent. Must not be null.
+         * 
+         * @throws NullPointerException
+         *              if any of the arguments are null.
+         */
+        public static void LaunchAgent(
+                        Agent agent, 
+                        Frame source, 
+                        Item itemParam) {
+                
+                if (agent == null) throw new NullPointerException("agent");
+                if (source == null) throw new NullPointerException("source");
+                if (itemParam == null) throw new NullPointerException("itemParam");
+                
+                String nameWithCorrectCase = agent.getClass().getSimpleName();
+                
+                try {
+        
+        
+                        // create the JAG
+                        _Agent = agent;
+        
                         Thread t = new Thread(_Agent);
                         t.setPriority(Thread.MIN_PRIORITY);
 
-                        Item itemParam = clicked;
                         if (FreeItems.textOnlyAttachedToCursor()) {
                                 itemParam = FreeItems.getItemAttachedToCursor();
                         }
-
+        
                         // check for errors during initialisation
                         if (!_Agent.initialise(source, itemParam)) {
@@ -507 +604 @@
                                                 + nameWithCorrectCase);
                         }
-
+        
                         // save the current frame (if necesssary)
                         // TODO make this nicer... ie. make Format an action rather than an
                         // agent and save frames only before running agents
-                        if (!name.equals("format") && !name.equals("sort")) {
+                        if (!nameWithCorrectCase.equalsIgnoreCase("format") && !nameWithCorrectCase.equalsIgnoreCase("sort")) {
                                 FrameUtils.LeavingFrame(source);
                         }
-
+        
                         if (_Agent.hasResultString()) {
                                 // Just run the agent on this thread... dont run it in the
@@ -535 +632 @@
                                 }
                         }
-                } catch (ClassNotFoundException cnf) {
-                        _Agent = null;
-                        throw new RuntimeException(nameWithCorrectCase
-                                        + "' is not an action or agent.");
                 } catch (Exception e) {
                         _Agent = null;
@@ -546 +639 @@
                 }
                 FrameGraphics.refresh(false);
-
-                return;
         }
 

trunk/src/org/expeditee/gui/FrameGraphics.java

@@ -38 +38 @@
 
         // Final passes to renderering the current frame
-        private static LinkedList<FinalFrameRenderPass> _finalPasses = new LinkedList<FinalFrameRenderPass>();
+        private static LinkedList<FrameRenderPass> _frameRenderPasses = new LinkedList<FrameRenderPass>();
 
         // modes
@@ -307 +307 @@
         public static void paintFrame(Frame toPaint, Area clip,
                         boolean isActualFrame, boolean createVolitile, Graphics2D bg) {
+                
+                // Prepare render passes
+                if (isActualFrame) {
+                        currentClip = clip;
+                        for (FrameRenderPass pass : _frameRenderPasses) {
+                                currentClip = pass.paintStarted(currentClip);
+                                clip = currentClip;
+                        }
+                }
+                
                 bg.setClip(clip);
 
@@ -479 +489 @@
                 // Repaint popups / drags... As well as final passes
                 if (isActualFrame) {
+                        for (FrameRenderPass pass : _frameRenderPasses) {
+                                pass.paintPreLayeredPanePass(bg);
+                        }
                         PopupManager.getInstance().paintLayeredPane(bg, clip);
-                        for (FinalFrameRenderPass pass : _finalPasses) {
-                                pass.paint(bg);
+                        for (FrameRenderPass pass : _frameRenderPasses) {
+                                pass.paintFinalPass(bg);
                         }
                 }
@@ -968 +981 @@
          *             If pass is null.
          */
-        public static void addFinalFrameRenderPass(FinalFrameRenderPass pass) {
+        public static void addFrameRenderPass(FrameRenderPass pass) {
                 if (pass == null)
                         throw new NullPointerException("pass");
 
-                if (!_finalPasses.contains(pass))
-                        _finalPasses.add(pass);
+                if (!_frameRenderPasses.contains(pass))
+                        _frameRenderPasses.add(pass);
         }
 
@@ -986 +999 @@
          * 
          */
-        public static void removeFinalFrameRenderPass(FinalFrameRenderPass pass) {
-                _finalPasses.remove(pass);
+        public static void removeFrameRenderPass(FrameRenderPass pass) {
+                _frameRenderPasses.remove(pass);
         }
 
@@ -1001 +1014 @@
          * frame painter then it is not garaunteed to be rendered very last.
          * 
-         * @see FrameGraphics#addFinalFrameRenderPass(org.expeditee.gui.FrameGraphics.FinalFrameRenderPass)
-         * @see FrameGraphics#removeFinalFrameRenderPass(org.expeditee.gui.FrameGraphics.FinalFrameRenderPass)
+         * @see FrameGraphics#addFinalFrameRenderPass(org.expeditee.gui.FrameGraphics.FrameRenderPass)
+         * @see FrameGraphics#removeFinalFrameRenderPass(org.expeditee.gui.FrameGraphics.FrameRenderPass)
          * 
          * @author Brook Novak
          */
-        public interface FinalFrameRenderPass {
-                void paint(Graphics g);
+        public interface FrameRenderPass {
+                
+                /**
+                 * 
+                 * @param currentClip
+                 * 
+                 * @return
+                 *              The clip that the pass should use instead.
+                 *              i.e. if there are any effects that cannot invladate prior to paint call.
+                 */
+                Area paintStarted(Area currentClip);
+                
+                void paintFinalPass(Graphics g);
+                
+                void paintPreLayeredPanePass(Graphics g);
         }
 

trunk/src/org/expeditee/items/widgets/InteractiveWidget.java

@@ -1261 +1261 @@
                 FrameGraphics.invalidateArea(dirty);
                 invalidateLink();
-                FrameGraphics.refresh(true);
+                //FrameGraphics.refresh(true);
         }
 
@@ -1454 +1454 @@
         }
 
+        protected void addDataIfCaseInsensitiveNotExists(String tag) {
+                if (tag == null) throw new NullPointerException("tag");
+                
+                List<String> data = getCurrentRepresentation().getData();
+                
+                if (data == null) {
+                        data = new LinkedList<String>();
+                }
+                
+                for (String s : data) {
+                        if (s != null && s.equalsIgnoreCase(tag)) {
+                                return;
+                        }
+                }
+                
+                data.add(tag);
+                getCurrentRepresentation().setData(data);
+        }
+
+        
         /**
          * Updates the data with a given tag. All data is removed that is prefixed
@@ -1506 +1526 @@
                 }
         }
+        
+        public boolean containsData(String str) {
+                assert(str != null);
+                if (getCurrentRepresentation().getData() != null) 
+                        return getCurrentRepresentation().getData().contains(str);
+                return false;
+        }
+        
+        public boolean containsDataTrimmedIgnoreCase(String str) {
+                assert(str != null);
+                if (getCurrentRepresentation().getData() != null) {
+                        for (String data : getCurrentRepresentation().getData()) {
+                                if (data != null && data.trim().equalsIgnoreCase(str)) {
+                                        return true;
+                                }
+                        }
+                }
+                        
+                return false;
+        }
 
         /**
@@ -1555 +1595 @@
 
                 if (FrameIO.isPositiveInteger(link)) { // relative - convert to
-                        // absolute
+                                                                                                // absolute
 
                         // Get the frameset of this item
@@ -1577 +1617 @@
                 return null;
         }
-
-        /**
-         * Sets the border color for the widget. That is, for the source (so it is
-         * remembered) and also for all the corners/edges.
+        
+        /**
+         * Sets the border color for the widget.
+         * That is, for the source (so it is remembered) and also for all the
+         * corners/edges.
          * 
          * @param c
-         *            The color to set.
+         *              The color to set.
          */
         public void setWidgetEdgeColor(Color c) {
-                for (Item i : _expediteeItems)
-                        i.setColor(c);
+                for (Item i : _expediteeItems) i.setColor(c);
                 // Above indirectly invokes setSourceBorderColor accordingly
         }
-
+        
         /**
          * Sets the thickness of the widget edge.
@@ -1597 +1637 @@
          * 
          * @param thickness
-         *            The new thickness to set.
+         *              The new thickness to set.
          */
         public void setWidgetEdgeThickness(float thickness) {
-                for (Item i : _expediteeItems)
-                        i.setThickness(thickness);
-                // Above indirectly invokes setSourceThickness accordingly
-        }
-
-        // TODO: Maybe rename setSource* .. to update* ... These should actually be
-        // friendly!
+                for (Item i : _expediteeItems) i.setThickness(thickness);
+//               Above indirectly invokes setSourceThickness accordingly
+        }
+
+        // TODO: Maybe rename setSource* ..  to update* ... These should actually be friendly!
         public void setSourceColor(Color c) {
                 _textRepresentation.setColor(c);
@@ -1628 +1666 @@
 
         protected Point getOrigin() {
-                return _d1.getPosition(); // BROOK: This flips around ... the origin
-                // can be any point
+                return _d1.getPosition(); // BROOK: This flips around ... the origin can be any point 
         }