Index: /trunk/autoquest-plugin-jfc/src/main/java/de/ugoe/cs/autoquest/plugin/jfc/commands/CMDgenerateJacaretoReplay.java =================================================================== --- /trunk/autoquest-plugin-jfc/src/main/java/de/ugoe/cs/autoquest/plugin/jfc/commands/CMDgenerateJacaretoReplay.java (revision 1855) +++ /trunk/autoquest-plugin-jfc/src/main/java/de/ugoe/cs/autoquest/plugin/jfc/commands/CMDgenerateJacaretoReplay.java (revision 1856) @@ -50,51 +50,4 @@ import de.ugoe.cs.util.console.GlobalDataContainer; -// helper class for the tree like structure part within a Jacareto file -class StructureNode { - public static int nextRef = 0; - - public String content; - public ArrayList children; - - public StructureNode(String type) { - setContent(type); - children = new ArrayList(); - } - - public StructureNode() { - content = ""; - children = new ArrayList(); - } - - public void setContent(String type) { - content = ""; - } - - public StructureNode add(String type) { - StructureNode node = new StructureNode(type); - children.add(node); - return node; - } - - public void addRecordable() { - children.add(new StructureNode()); - } - - @Override - public String toString() { - String separator = System.getProperty("line.separator"); - String result = content + separator; - - for (StructureNode child : children) { - result += child.toString(); - } - - if (content.endsWith("/>")) { - return result; - } - return result + "" + separator; - } -} - /** *

@@ -106,22 +59,222 @@ */ public class CMDgenerateJacaretoReplay implements Command { + + /** + *

+ * Helper class for the tree like structure part within a Jacareto file. + *

+ */ + private static class StructureNode { + + /** + *

+ * Keeps track of the next structure node id. + *

+ */ + public static int nextRef = 0; + + /** + *

+ * The node's type packaged into an XML string. + *

+ */ + public String content; + + /** + *

+ * This node's children. + *

+ */ + public ArrayList children; + + /** + *

+ * Constructor. Creates a new StructureNode of a specified type and builds its Jacareto XML + * representation. + *

+ * + * @param type + * the type of this StructureNode, for example: 'MouseDownEvent' + */ + public StructureNode(String type) { + setContent(type); + children = new ArrayList(); + } + + /** + *

+ * Constructor. Creates a StructureNode of type 'Recordable' with a valid id and builds its + * Jacareto XML representation. + *

+ */ + public StructureNode() { + content = ""; + children = new ArrayList(); + } + + /** + *

+ * Builds the XML representation of a Jacareto structure type. + *

+ * + * @param type + * the type of this StructureNode, for example: 'MouseDownEvent' + */ + public void setContent(String type) { + content = ""; + } + + /** + *

+ * Adds a new StructureNode as a child of this node. + *

+ * + * @param type + * the type of the child node, for example: 'MouseDownEvent' + */ + public StructureNode add(String type) { + StructureNode node = new StructureNode(type); + children.add(node); + return node; + } + + /** + *

+ * Builds the XML representation of a Jacareto structure type. + *

+ * + * @param type + * the type of this StructureNode, for example: 'MouseDownEvent' + */ + public void addRecordable() { + children.add(new StructureNode()); + } + + /** + *

+ * Returns a Jacareto XML representation of this StructureNode, includin all its children. + *

+ */ + @Override + public String toString() { + String separator = System.getProperty("line.separator"); + String result = content + separator; + + for (StructureNode child : children) { + result += child.toString(); + } + + if (content.endsWith("/>")) { + return result; + } + return result + "" + separator; + } + } + + /** + *

+ * The time it takes for Jacareto to replay an event in ms. + *

+ */ private static final int EVENT_DURATION = 150; + + /** + *

+ * The time it takes for Jacareto to replay each part of a double click event in ms. + *

+ */ private static final int DOUBLE_CLICK_DURATION = 50; + + /** + *

+ * Application startup time in ms. The application needs to be fully initialized before Jacareto + * can start replaying. + *

+ */ private static final int STARTUP_DELAY = 10000; + /** + *

+ * The GUI element which is currently focused. + *

+ */ private JFCGUIElement currentFocus; + + /** + *

+ * A tree of StructureNodes which represents the structure part inside a Jacareto XML file. + *

+ */ private StructureNode structure; + /** + *

+ * XML structure for key events modeled as StructureNodes. + *

+ */ private StructureNode lastKeySequenceEvent; + + /** + *

+ * XML structure for key events modeled as StructureNodes. + *

+ */ private StructureNode lastKeyTypedEvent; + + /** + *

+ * Bitmask which represents currently used key modifiers (such as shift etc). + *

+ */ private int currentKeyModifiers; + /** + *

+ * Maps VirtualKey objects for modifier keys back to AWT Event codes. + *

+ */ private HashMap modifiers; + /** + *

+ * XML structure for mouse events modeled as StructureNodes. + *

+ */ private StructureNode lastMouseClickEvent; + + /** + *

+ * XML structure for focus events modeled as StructureNodes. + *

+ */ private StructureNode lastFocusChangeEvent; + + /** + *

+ * XML structure for item and action events modeled as StructureNodes. + *

+ */ private StructureNode lastItemActionEvent; + + /** + *

+ * The target of the last mouseDownEvent. It is necessary to save this because mouse down and up + * targets can differ. + *

+ */ private IEventTarget lastMouseDownTarget; + + /** + *

+ * Associates the name of a menu element with its corresponding JFCGUIElement. + *

+ */ private HashMap menuElements; + + /** + *

+ * The menu hierarchy. + *

+ */ private List menuList; @@ -184,15 +337,7 @@ sequences = (Collection>) dataObject; - menuElements = new HashMap<>(); - - // map which maps VirtualKeys back to awt key modifier codes - modifiers = new HashMap<>(); - modifiers.put(VirtualKey.SHIFT, 1); - modifiers.put(VirtualKey.CONTROL, 2); - modifiers.put(VirtualKey.ALT, 8); - modifiers.put(VirtualKey.ALT_GRAPH, 32); + modifiers = createModifierMap(); currentKeyModifiers = 0; - StructureNode.nextRef = 0; @@ -200,4 +345,31 @@ } + /** + *

+ * Associates keyboard modifier keys with their AWT event codes. + *

+ */ + private HashMap createModifierMap() { + HashMap result = new HashMap<>(); + + result.put(VirtualKey.SHIFT, 1); + result.put(VirtualKey.CONTROL, 2); + result.put(VirtualKey.ALT, 8); + result.put(VirtualKey.ALT_GRAPH, 32); + + return result; + } + + /** + *

+ * Writes a line and creates a new line. + *

+ * + * @param writer + * the BufferedWriter which writes the XML + * @param line + * the line to write + * + */ private void writeLine(BufferedWriter writer, String line) throws IOException { writer.write(line); @@ -205,4 +377,20 @@ } + /** + *

+ * Writes the Jacareto XML head part. This mainly contains information about the state of the + * system when the replay was captured. + * + * @param writer + * the BufferedWriter which writes the XML + * @param classname + * name of the main class of the program that will be replayed + * @param basepath + * a basepath that is prepended to all paths specified in classpathext + * @param classpathext + * additional required resources (e.g. jar files) + * + *

+ */ private void writeJacaretoHead(BufferedWriter writer, String classname, @@ -251,4 +439,15 @@ } + /** + *

+ * Writes Jacareto XML code for all events within the Autoquest sequences. + *

+ * + * @param writer + * the BufferedWriter which writes the XML + * @param sequences + * the Autoquest sequences + * + */ private void writeJacaretoEvents(BufferedWriter writer, Collection> sequences) throws IOException @@ -267,30 +466,11 @@ if (event.getType() instanceof MouseButtonDown) { - handleMouseDown(writer, event, "MouseClick"); + handleMouseButtonDown(writer, event); } else if (event.getType() instanceof MouseButtonUp) { - handleMouseUp(writer, event); + handleMouseButtonUp(writer, event); } else if (event.getType() instanceof MouseDoubleClick) { - StructureNode multiClick = structure.add("MultipleMouseClick"); - - // first click - lastMouseClickEvent = multiClick.add("MouseClick"); - writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), - DOUBLE_CLICK_DURATION, 501); - writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), - DOUBLE_CLICK_DURATION, 502); - writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), - DOUBLE_CLICK_DURATION, 500); - // second click - lastMouseClickEvent = multiClick.add("MouseClick"); - writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), - DOUBLE_CLICK_DURATION, 501); - writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), - DOUBLE_CLICK_DURATION, 502); - writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), - DOUBLE_CLICK_DURATION, 500); - - lastMouseClickEvent = null; + handleMouseDoubleClick(writer, event); } else if (event.getType() instanceof MouseClick) { @@ -315,58 +495,8 @@ } - lastKeySequenceEvent = null; - - if (lastMouseClickEvent != null) { - if (lastMouseDownTarget == event.getTarget()) { - // this is the standard case: - // mouseDown, mouseUp and mouseClick sequence - // was triggered on this target - - writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), - EVENT_DURATION, 500); - writeItemActionEvent(writer, event); - - if (lastFocusChangeEvent == null) { - // write structure sequentially - structure.children.add(lastMouseClickEvent); - structure.children.add(lastItemActionEvent); - } - else { - // with nested structure - structure.children.add(lastItemActionEvent); - lastItemActionEvent.children.add(0, lastFocusChangeEvent); - lastFocusChangeEvent.children.add(0, lastMouseClickEvent); - - lastFocusChangeEvent = null; - lastMouseClickEvent = null; - } - } - else { - // target of mouseDown and mouseClick are different - // -> this is, for example, a click on a menu item - // within a condensed sequence - commitFocusEvent(); - - // finish the last click on the old target - writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), - EVENT_DURATION, 500); - structure.children.add(lastMouseClickEvent); - - // and generate a new one - generateFullClick(writer, event, (JFCGUIElement) event.getTarget()); - } - } - else { - // a target was clicked repeatedly: - // the condensed sequence contains no mouseDowns or - // mouseUps anymore - // -> just generate another full click - generateFullClick(writer, event, (JFCGUIElement) event.getTarget()); - } + handleMouseClick(writer, event); } else if (event.getType() instanceof KeyboardFocusChange) { - lastKeySequenceEvent = null; - - writeFocusChangeEvent(writer, event); + handleKeyboardFocusChange(writer, event); } else if (event.getType() instanceof MouseDragAndDrop) { @@ -390,16 +520,98 @@ } - private void handleMouseDown(BufferedWriter writer, Event event, String structureName) - throws IOException - { + // EVENT HANDLERS + + private void handleMouseClick(BufferedWriter writer, Event event) throws IOException { + lastKeySequenceEvent = null; + + if (lastMouseClickEvent != null) { + if (lastMouseDownTarget == event.getTarget()) { + // this is the standard case: + // mouseDown, mouseUp and mouseClick sequence + // was triggered on this target + + writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), + EVENT_DURATION, 500); + writeItemActionEvent(writer, event); + + if (lastFocusChangeEvent == null) { + // write structure sequentially + structure.children.add(lastMouseClickEvent); + structure.children.add(lastItemActionEvent); + } + else { + // with nested structure + structure.children.add(lastItemActionEvent); + lastItemActionEvent.children.add(0, lastFocusChangeEvent); + lastFocusChangeEvent.children.add(0, lastMouseClickEvent); + + lastFocusChangeEvent = null; + lastMouseClickEvent = null; + } + } + else { + // target of mouseDown and mouseClick are different + // -> this is, for example, a click on a menu item + // within a condensed sequence + commitFocusEvent(); + + // finish the last click on the old target + writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), + EVENT_DURATION, 500); + structure.children.add(lastMouseClickEvent); + + // and generate a new one + generateFullClick(writer, event, (JFCGUIElement) event.getTarget()); + } + } + else { + // a target was clicked repeatedly: + // the condensed sequence contains no mouseDowns or + // mouseUps anymore + // -> just generate another full click + generateFullClick(writer, event, (JFCGUIElement) event.getTarget()); + } + + } + + private void handleMouseDoubleClick(BufferedWriter writer, Event event) throws IOException { + StructureNode multiClick = structure.add("MultipleMouseClick"); + + // first click + lastMouseClickEvent = multiClick.add("MouseClick"); + writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), + DOUBLE_CLICK_DURATION, 501); + writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), + DOUBLE_CLICK_DURATION, 502); + writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), + DOUBLE_CLICK_DURATION, 500); + // second click + lastMouseClickEvent = multiClick.add("MouseClick"); + writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), + DOUBLE_CLICK_DURATION, 501); + writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), + DOUBLE_CLICK_DURATION, 502); + writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), + DOUBLE_CLICK_DURATION, 500); + + lastMouseClickEvent = null; + + } + + private void handleKeyboardFocusChange(BufferedWriter writer, Event event) throws IOException { + lastKeySequenceEvent = null; + writeFocusChangeEvent(writer, event); + } + + private void handleMouseButtonDown(BufferedWriter writer, Event event) throws IOException { commitFocusEvent(); lastKeySequenceEvent = null; - lastMouseClickEvent = new StructureNode(structureName); + lastMouseClickEvent = new StructureNode("MouseClick"); lastMouseDownTarget = event.getTarget(); writeMouseClickEvent(writer, event, (JFCGUIElement) event.getTarget(), EVENT_DURATION, 501); } - private void handleMouseUp(BufferedWriter writer, Event event) throws IOException { + private void handleMouseButtonUp(BufferedWriter writer, Event event) throws IOException { lastKeySequenceEvent = null;