+ * This class defines rules for the generation of MFC events. + *
+ * + * @version 1.0 + * @author Steffen Herbold, Patrick Harms + */ +class EventGenerationRule { + + /** + *+ * Namespace used for parsing the rule. + *
+ */ + private Namespace namespace; + + /** + *+ * Name of the rule. + *
+ */ + private String name; + + /** + *+ * List of conditions for the rule to be matched. + *
+ */ + private List+ * List of parameters to be provided to the generated event. + *
+ */ + private List+ * List of replay message generation rules. + *
+ */ + private List+ * Constructor. Creates a new EventGenerationRule. + *
+ * + * @param ruleElement + * the JDOM element that descripes the rule + * @param rulesNamespace + * the XML namespace the rule is defined in + */ + @SuppressWarnings("unchecked") + EventGenerationRule(Element ruleElement, Namespace rulesNamespace) { + this.namespace = rulesNamespace; + + this.name = ruleElement.getAttributeValue("name"); + + this.messageConditions = new ArrayList+ * Returns the name of the rule. + *
+ * + * @return the name + */ + String getName() { + return name; + } + + /** + *+ * Returns the conditions on the matched messages defined by this rule. + *
+ * + * @return the message conditions + */ + List+ * Returns the parameters of the event generated by this rule. + *
+ * + * @return the event parameters + */ + List+ * Returns the replay specification defined by this rule. + *
+ * + * @return the replay specification + */ + List+ * Helper class that describes conditions on the message sequence when matching this rule. + *
+ * + * @version 1.0 + * @author Steffen Herbold, Patrick Harms + */ + class MessageCondition { + + /** + *+ * True, if the condition defines to match several conditions + *
+ */ + private boolean matchMultiple; + + /** + *+ * Type of the message matched by the condition + *
+ */ + private WindowsMessageType messageType; + + /** + *+ * Term conditions associated with the rule condition + *
+ */ + private List+ * List of messages to be stored, if the message matches, for continuing the rule + * application + *
+ */ + private ArrayList+ * Constructor. Creates a new MessageCondition. + *
+ * + * @param msgChild + * JDOM element that describes the message condition + */ + @SuppressWarnings("unchecked") + private MessageCondition(Element msgChild) { + this.matchMultiple = "true".equals(msgChild.getAttributeValue("multiple")); + this.messageType = + WindowsMessageType.parseMessageType(msgChild.getAttributeValue("type")); + + this.attributeConditions = new ArrayList+ * Returns whether a single message is matched to the condition or a whole sequence can be + * matched. + *
+ * + * @return true if multiple message shall be matched, false if only a single message is + * matched + */ + boolean matchMultiple() { + return matchMultiple; + } + + /** + *+ * Returns the type of the matched messages. + *
+ * + * @return the message type + */ + WindowsMessageType getMessageType() { + return messageType; + } + + /** + *+ * Returns the attribute conditions of the message condition. + *
+ * + * @return the attribute conditions + */ + List+ * Returns messages, that have eventually been stored as part of the condition. + *
+ * + * @return the stored messages + */ + ArrayList+ * Helper class that defines attribute conditions for matching messages. + *
+ * + * @version 1.0 + * @author Steffen Herbold, Patrick Harms + */ + class AttributeCondition { + + /** + *+ * Left hand side of the condition. + *
+ */ + private Term leftHandSide; + + /** + *+ * Reft hand side of the condition. + *
+ */ + private Term rightHandSide; + + /** + *+ * Constructor. Creates a new AttributeCondition. + *
+ * + * @param conditionElement + * JDOM element that describes the condition + */ + private AttributeCondition(Element conditionElement) { + this.leftHandSide = new Term((Element) conditionElement.getChildren().get(0)); + this.rightHandSide = new Term((Element) conditionElement.getChildren().get(1)); + } + + /** + *+ * Returns the left hand side of the condition. + *
+ * + * @return the left hand side + */ + Term getLeftHandSide() { + return leftHandSide; + } + + /** + *+ * Returns the right hand side of the condition. + *
+ * + * @return the right hand side + */ + Term getRightHandSide() { + return rightHandSide; + } + + } + + /** + *+ * Helper class that defines terms to define conditions. + *
+ * + * @version 1.0 + * @author Steffen Herbold, Patrick Harms + */ + class Term { + + /** + *+ * Name of the term. + *
+ */ + private String name; + + /** + *+ * Value of the term, if it is a constValue; null otherwise. + *
+ */ + private String value; + + /** + *+ * Variable name of the object, i.e. a message, of which a parameter is identified if the + * term is a winInfoValue or a msgInfoValue; null otherwise. + *
+ */ + private String messageId; + + /** + *+ * Name of the parameter of the object, i.e., a message, of which a parameter is identified + * if the term is a paramValue; null otherwise. + *
+ */ + private String messageParameterName; + + /** + *+ * Variable name of the message sequence denoted by the term in case of a seqValue; null + * otherwise. + *
+ */ + private String sequenceId; + + /** + *+ * Name of the parameter of the sequence of which a parameter is identified if the term is a + * seqValue; null otherwise. + *
+ */ + private String sequenceParameterName; + + /** + *+ * Name of the parameter of the window of the object, e.g. a message, of which a parameter + * is identified if the term is a winInfoValue; null otherwise. + *
+ */ + private String windowParameterName; + + /** + *+ * Name of the info of the message of which a parameter is identified if the term is a + * msgInfoValue; null otherwise. + *
+ */ + private String messageInfoName; + + /** + *+ * Name of the parameter of the message into which a value shall be stored if the term is a + * resolveHwnd, null otherwise + *
+ */ + private String storeParameterName; + + /** + *+ * List of handles to be resolved in case the term is a store or storeSeq; null otherwise. + *
+ */ + private List+ * Constructor. Creates a new Term. + *
+ * + * @param termElement + * JDOM element that describes the term + */ + @SuppressWarnings("unchecked") + private Term(Element termElement) { + this.name = termElement.getName(); + + if ("constValue".equals(name)) { + this.value = termElement.getAttributeValue("value"); + } + else if ("paramValue".equals(name)) { + this.messageId = termElement.getAttributeValue("obj"); + this.messageParameterName = termElement.getAttributeValue("param"); + } + else if ("winInfoValue".equals(name)) { + this.messageId = termElement.getAttributeValue("obj"); + this.windowParameterName = termElement.getAttributeValue("winParam"); + } + else if ("msgInfoValue".equals(name)) { + this.messageId = termElement.getAttributeValue("obj"); + this.messageInfoName = termElement.getAttributeValue("msgParam"); + } + else if ("seqValue".equals(name)) { + this.sequenceId = termElement.getAttributeValue("seqObj"); + this.sequenceParameterName = termElement.getAttributeValue("param"); + } + else if ("store".equals(name)) { + this.messageId = termElement.getAttributeValue("var"); + if ((termElement.getChildren() != null) && (termElement.getChildren().size() > 0)) { + this.resolveHandles = new ArrayList+ * Returns the name of the term. + *
+ * + * @return the name + */ + String getName() { + return name; + } + + /** + *+ * Returns the value of the term. + *
+ * + * @return the value + */ + String getValue() { + return value; + } + + /** + *+ * Returns the object Id of the message, which is resolved as part of this term. + *
+ * + * @return the object Id + */ + String getMessageId() { + return messageId; + } + + /** + *+ * Returns the name of the message parameter that is resolved as part of this term. + *
+ * + * @return the message parameter name + */ + String getMessageParameterName() { + return messageParameterName; + } + + /** + *+ * Returns the object Id of the message sequence, which is resolved as part of this term. + *
+ * + * @return the object Id + */ + String getSequenceId() { + return sequenceId; + } + + /** + *+ * Returns the name of the message parameter that is resolved as part of this term. + *
+ * + * @return the sequenceParameter + */ + String getSequenceParameterName() { + return sequenceParameterName; + } + + /** + *+ * Returns the window parameter name that is resolved as part of this term. + *
+ * + * @return the name of the window parameter + */ + String getWindowParameterName() { + return windowParameterName; + } + + /** + *+ * Returns the name of the message info value that is resolved as part of this term. + *
+ * + * @return the name of the message info value + */ + String getMessageInfoName() { + return messageInfoName; + } + + /** + *+ * Returns the object Id under which a message will be stored. + *
+ * + * @return the object Id + */ + String getStoreParameterName() { + return storeParameterName; + } + + /** + *+ * Returns all terms that are responsible to resolve HWNDs. + *
+ * + * @return the terms + */ + List+ * Helper class that defines the replay specification part of rules. + *
+ * + * @version 1.0 + * @author Steffen Herbold, Patrick Harms + */ + class ReplayMessageSpec { + + /** + *+ * Determines if this specification defines one, or a sequence of messages. + *
+ */ + private boolean generateSingleMessage; + + /** + *+ * Object Id of a concrete message of message sequence to be replayed as is. + *
+ */ + private String replayObjectId; + + /** + *+ * Term describing the type of the generated message. + *
+ */ + private Term type; + + /** + *+ * Term describing the target of the generated message. + *
+ */ + private Term target; + + /** + *+ * Term describing the LO word of the LParam of the generated message. + *
+ */ + private Term lparamLoWord; + + /** + *+ * Term describing the HI word of the LParam of the generated message. + *
+ */ + private Term lparamHiWord; + + /** + *+ * Term describing the LParam of the generated message. + *
+ */ + private Term lparam; + + /** + *+ * Term describing the LO word of the WParam of the generated message. + *
+ */ + private Term wparamLoWord; + + /** + *+ * Term describing the HI word of the WParam of the generated message. + *
+ */ + private Term wparamHiWord; + + /** + *+ * Term describing the WParam of the generated message. + *
+ */ + private Term wparam; + + /** + *+ * Value in milliseconds that the replay waits until the the next message is replayed. + *
+ */ + private int delay; + + /** + *+ * Constructor. Creates a new ReplayMessageSpec. + *
+ * + * @param replayMessageSpecElement + * JDOM element that describes the replay message specification + */ + @SuppressWarnings("unchecked") + private ReplayMessageSpec(Element replayMessageSpecElement) { + List+ * Determines if this specification defines one, or a sequence of messages. + *
+ * + * @return true if only a single message is generated; false if a sequence is generated + */ + boolean generateSingleMessage() { + return generateSingleMessage; + } + + /** + *+ * Returns the object Id from which the message is generated. + *
+ * + * @return the object Id + */ + String getReplayObjectId() { + return replayObjectId; + } + + /** + *+ * Returns the term that describes the type of the generated message. + *
+ * + * @return the type term + */ + Term getType() { + return type; + } + + /** + *+ * Returns the term that describes the target of the generated message. + *
+ * + * @return the target term + */ + Term getTarget() { + return target; + } + + /** + *+ * Returns the term that describes the LO word of the LParam of the generated message. + *
+ * + * @return the LParam LO word term + */ + Term getLparamLoWord() { + return lparamLoWord; + } + + /** + *+ * Returns the term that describes the HI word of the LParam of the generated message. + *
+ * + * @return the LParam HI word term + */ + Term getLparamHiWord() { + return lparamHiWord; + } + + /** + *+ * Returns the term that describes the LParam of the generated message. + *
+ * + * @return the LParam term + */ + Term getLparam() { + return lparam; + } + + /** + *+ * Returns the term that describes the LO word of the WParam of the generated message. + *
+ * + * @return the WParam LO word term + */ + Term getWparamLoWord() { + return wparamLoWord; + } + + /** + *+ * Returns the term that describes the HI word of the WParam of the generated message. + *
+ * + * @return the WParam HI word term + */ + Term getWparamHiWord() { + return wparamHiWord; + } + + /** + *+ * Returns the term that describes the WParam of the generated message. + *
+ * + * @return the WParam term + */ + Term getWparam() { + return wparam; + } + + /** + *+ * Returns the delay during the replay after this message is sent. + *
+ * + * @return the delay + */ + int getDelay() { + return delay; + } + + } +} Index: trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/EventGenerator.java =================================================================== --- trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/EventGenerator.java (revision 922) +++ trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/EventGenerator.java (revision 922) @@ -0,0 +1,1114 @@ +package de.ugoe.cs.autoquest.plugin.mfc; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.ListIterator; +import java.util.Map; +import java.util.NoSuchElementException; +import java.util.logging.Level; + +import org.jdom.Document; +import org.jdom.Element; +import org.jdom.JDOMException; +import org.jdom.Namespace; +import org.jdom.input.SAXBuilder; + +import de.ugoe.cs.autoquest.eventcore.Event; +import de.ugoe.cs.autoquest.eventcore.IEventType; +import de.ugoe.cs.autoquest.plugin.mfc.EventGenerationRule.Term; +import de.ugoe.cs.autoquest.plugin.mfc.eventcore.MFCEventTypeFactory; +import de.ugoe.cs.autoquest.plugin.mfc.eventcore.ReplayWindowsMessage; +import de.ugoe.cs.autoquest.plugin.mfc.eventcore.WindowsMessage; +import de.ugoe.cs.autoquest.plugin.mfc.eventcore.WindowsMessageType; +import de.ugoe.cs.autoquest.plugin.mfc.guimodel.MFCGUIElement; +import de.ugoe.cs.autoquest.plugin.mfc.guimodel.WindowTree; +import de.ugoe.cs.util.console.Console; + +/** + *+ * Translates sequences of windows messages into {@link Event}s that can be used by the + * QUEST core libraries. + *
+ * + * @version 1.0 + * @author Steffen Herbold, Patrick Harms + */ +public class EventGenerator { + + /** + *+ * the list of all event generation rules available + *
+ */ + private List+ * Name and path of the XML files containing the rules. + *
+ */ + private String rulesFile; + + /** + *+ * Iterator used for the current sequence. + *
+ */ + private ListIterator+ * Token that is currently being generated. + *
+ */ + private Event currentEvent; + + /** + *+ * Event type of the current token. Stored as a member to be able to update it during the + * parsing of the idinfo tag. + *
+ */ + private IEventType currentType; + + /** + *+ * + *
+ */ + private MFCGUIElement currentTarget; + + /** + *+ * Reference to the ul:rules namespace. + *
+ */ + private static Namespace rulesNamespace; + + /** + *+ * The name of the rule that is currently being evaluated. + *
+ */ + private String currentRuleName; + + /** + *
+ * Internal message storage. Used to implement the {@literal and
+ * {@literal tags.
+ *
+ * reference to the window tree created during parsing + *
+ */ + private WindowTree windowTree; + + /** + *+ * Creates a new EventGenerator. Sets "data/rules.xml" as default file for the rules. + *
+ */ + public EventGenerator(WindowTree windowTree) { + rulesFile = "data/rules.xml"; + this.windowTree = windowTree; + } + + /** + *+ * Tries to match the rules to the given sequence to generate an {@link Event}. + *
+ *+ * The rules are matched the order, in which they are defined in the XML file. Therefore, the + * order of the rules in the file defines priorities, when multiple rules could be matched to + * the same sequence. + *
+ * + * @param sequence + * sequence of message for which an event will be generated + * @return event that matches the messages; null, if no rule can be matched + */ + public Event generateEvent(List+ * Evaluates whether the current message sequence matches a given rule. + *
+ * + * @param currentRule rule that is matched + * @return true if the message sequence matches the rule; false otherwise + */ + private boolean evaluateMessageConditions(EventGenerationRule currentRule) { + boolean isMatch = true; + List+ * Handles msg-nodes where multiple is not true, i.e., not a sequences. + *
+ * + * @param messageElement + * {@link Element} representing the msg-node + * @return true, if a match is found; false otherwise + */ + private boolean matchSingleMessage(EventGenerationRule.MessageCondition condition) { + boolean isMatch = false; + WindowsMessage currentMessage = null; + + WindowsMessageType type = condition.getMessageType(); + + while (!isMatch && sequenceIterator.hasNext()) { + /* + * traverses the messages from the current position forward till a message with the + * correct type is found + */ + currentMessage = sequenceIterator.next(); + if (type == currentMessage.getType()) { + // message with the correct type found + // eval child nodes for further matching/storing + isMatch = evaluateMessageCondition(currentMessage, condition); + + // in case the message is a match, eval storage children + if (isMatch) { + handleStorage(condition, currentMessage); + currentTarget = currentMessage.getTarget(); + // TODO currentToken.setTargetShort(currentMessage.getParentNames()); + } + } + } + + return isMatch; + } + + /** + *+ * Handles msg-nodes where multiple is true, i.e., sequences. Requires knowledge about the next + * msg-node to determine the end of the sequence. + *
+ * + * @param messageElement + * {@link Element} representing the msg-node + * @param nextMessageElement + * {@link Element} representing the next msg-node; {@code null} if the current node + * is the last one + * @return true, if a sequence is matched; false otherwise + */ + private boolean matchMultipleConditions(EventGenerationRule.MessageCondition condition, + EventGenerationRule.MessageCondition nextCondition) + { + boolean isMatch = false; + boolean isCurrentMatch = false; + boolean nextMatchFound = false; + WindowsMessage currentMessage = null; + WindowsMessage nextMessage = null; + + WindowsMessageType type = condition.getMessageType(); + + WindowsMessageType nextType = null; + if (nextCondition != null) { + nextType = nextCondition.getMessageType(); + } + + while (!nextMatchFound && sequenceIterator.hasNext()) { + currentMessage = sequenceIterator.next(); + if (type == currentMessage.getType()) { + isCurrentMatch = evaluateMessageCondition(currentMessage, condition); + isMatch = isMatch || isCurrentMatch; + + if (isCurrentMatch) { + handleStorage(condition, currentMessage); + currentTarget = currentMessage.getTarget(); + // TODO currentToken.setTargetShort(currentMessage.getParentNames()); + } + } + if (nextCondition != null && isMatch) { + // peek next message to check if the sequence ends and the next + // match is found + if (!sequenceIterator.hasNext()) { + return false; // sequence is over, but not all messages are + // found + } + nextMessage = sequenceIterator.next(); + sequenceIterator.previous(); + + if (nextType == nextMessage.getType()) { + nextMatchFound = evaluateMessageCondition(nextMessage, nextCondition); + } + + } + } + + return isMatch; + } + + /** + *+ * Handles equals-nodes. + *
+ * + * @param currentMessage + * {@link Element} representing the msg-node the equals-node belongs to + * @param messageElement + * {@link Element} representing the equals-node to be evaluated + * @return true, if constraint is fulfilled; false otherwise + */ + private boolean evaluateMessageCondition(WindowsMessage currentMessage, + EventGenerationRule.MessageCondition condition) + { + boolean isMatch = true; + for (int i = 0; isMatch && (i < condition.getAttributeConditions().size()); i++) + { + EventGenerationRule.AttributeCondition attrCond = + condition.getAttributeConditions().get(i); + + // the size 2 of termElements is guaranteed by the XML schema + Object value1 = getTermValue(currentMessage, attrCond.getLeftHandSide(), Object.class); + Object value2 = getTermValue(currentMessage, attrCond.getRightHandSide(), Object.class); + if (value1 == null || value2 == null) { + isMatch = false; + } + else { + isMatch = isMatch && value1.equals(value2); + } + } +// for (Element childElement : (List+ * Handles store-nodes and storeSeq-nodes. + *
+ * + * @param messageElement + * {@link Element} representing the msg-node that is currently being evaluated + * @param currentMessage + * current message in the message sequence that is matched; this is the message that + * is stored + */ + @SuppressWarnings("unchecked") + private void handleStorage(EventGenerationRule.MessageCondition messageCondition, + WindowsMessage currentMessage) + { + for (Term valueToStore : messageCondition.getMessagesToStore()) + { + if (valueToStore.getMessageId() != null) { + ReplayWindowsMessage replayMessage = new ReplayWindowsMessage(currentMessage); + messageStorage.put(valueToStore.getMessageId(), replayMessage); + resolveHwnd(replayMessage, valueToStore.getResolveHandles()); + } + else if (valueToStore.getSequenceId() != null) { + Object tmp = messageStorage.get(valueToStore.getSequenceId()); + ReplayWindowsMessage replayMessage = new ReplayWindowsMessage(currentMessage); + List+ * Resolves a parameter that contains a HWND of a message to the target string of the HWND and + * stores it. + *
+ * + * @param currentMessage + * message whose HWND is resolved + * @param list + * child element of the store node that represents the resolve + */ + private void resolveHwnd(ReplayWindowsMessage currentMessage, List+ * Handles genMsg-nodes and adds the replay to the {@link Event} that is generated. + *
+ * + * @param genMsgElement + * {@link Element} representing the genMsg-node + */ + private void generateReplayMessage(EventGenerationRule.ReplayMessageSpec messageSpec) { + ReplayWindowsMessage generatedMessage = null; + if (messageSpec.getReplayObjectId() != null) { // replay stored message without change + generatedMessage = getStoredMessageVariable(null, messageSpec.getReplayObjectId()); + } + else { // generate message according to the rule + generatedMessage = new ReplayWindowsMessage + (getTermValue(messageSpec.getType(), WindowsMessageType.class)); + generatedMessage.setTargetXML(getTermValue(messageSpec.getTarget(), String.class)); + + if ((messageSpec.getLparamHiWord() != null) || + (messageSpec.getLparamLoWord() != null)) + { + generatedMessage.setLPARAM + (loHiWord(messageSpec.getLparamLoWord(), messageSpec.getLparamHiWord())); + } + else if (messageSpec.getLparam() != null) { + try { + generatedMessage.setLPARAM(getTermValue(messageSpec.getLparam(), Long.class)); + } + catch (IllegalArgumentException e) { + generatedMessage.setLPARAMasWindowDesc + (getTermValue(messageSpec.getLparam(), String.class)); + } + } + + if ((messageSpec.getWparamHiWord() != null) || + (messageSpec.getWparamLoWord() != null)) + { + generatedMessage.setWPARAM + (loHiWord(messageSpec.getWparamLoWord(), messageSpec.getWparamHiWord())); + } + else if (messageSpec.getWparam() != null) { + try { + generatedMessage.setWPARAM(getTermValue(messageSpec.getWparam(), Long.class)); + } + catch (IllegalArgumentException e) { + generatedMessage.setWPARAMasWindowDesc + (getTermValue(messageSpec.getWparam(), String.class)); + } + } + + + } + + generatedMessage.setDelay(messageSpec.getDelay()); + + currentEvent.addReplayable(generatedMessage); + } + + /** + * Handles genMsgSeq-nodes and adds the replay to the {@link Event} that is generated. + * + * @param genMsgElement + * {@link Element} representing the genMsgSeq-node. + */ + private void generateReplaySequence(EventGenerationRule.ReplayMessageSpec messageSpec) + { + List+ * Creates the targets for replay sequences generated with genMsgSeq-nodes. + *
+ * + * @param generatedMessageSeq + * list of the messages that is being generated + * @param msgsGenerated + * boolean stating if the list of messages is already generated or if the generation + * has to be handles by this method + * @param constMsgType + * a constant message type that is used for message generation, in case the list of + * message is generated by this method + * @param termElement + * {@link Element} representing the term-node describing the target + * @return true, if the list of message is generated after calling this method; false otherwise + * @throws NoSuchElementException + * thrown if the seqVar referred to in the termElement contains a different number + * of messages than is contained in messageSeq + */ + private void createSequenceTarget(List+ * Creates the LPARAMs for replay sequences generated with genMsgSeq-nodes. + *
+ * + * @param generatedMessageSeq + * list of the messages that is being generated + * @param msgsGenerated + * boolean stating if the list of messages is already generated or if the generation + * has to be handles by this method + * @param constMsgType + * a constant message type that is used for message generation, in case the list of + * message is generated by this method + * @param termElement + * {@link Element} representing the term-node describing the LPARAM + * @return true, if the list of message is generated after calling this method; false otherwise + * @throws NoSuchElementException + * thrown if the seqVar referred to in the termElement contains a different number + * of messages than is contained in messageSeq + */ + private void createSequenceLParam(List+ * Creates the WPARAMs for replay sequences generated with genMsgSeq-nodes. + *
+ * + * @param generatedMessageSeq + * list of the messages that is being generated + * @param msgsGenerated + * boolean stating if the list of messages is already generated or if the generation + * has to be handles by this method + * @param constMsgType + * a constant message type that is used for message generation, in case the list of + * message is generated by this method + * @param termElement + * {@link Element} representing the term-node describing the WPARAM + * @return true, if the list of message is generated after calling this method; false otherwise + * @throws NoSuchElementException + * thrown if the seqVar referred to in the termElement contains a different number + * of messages than is contained in messageSeq + */ + private void createSequenceWParam(List+ * Resolves the parameters described by {@link Term}s. + *
+ * + * @param eventParameters terms whose parameters are resolved + * @return resolved parameters + */ + private Map+ * Retrieves a message from the storage for, e.g., comparison or replay. "this" is used to refer + * to the current message. + *
+ * + * @param currentMessage + * current message during the parsing; passed to handle "this" + * @param obj + * object identifier in the storage + * @return message retrieved from the storage + * @throws IllegalArgumentException + * thrown in case of invalid uses of "this" or if no message with the identifier obj + * is found in the storage + */ + private ReplayWindowsMessage getStoredMessageVariable(WindowsMessage currentMessage, String obj) + throws IllegalArgumentException + { + ReplayWindowsMessage varMessage = null; + if (obj.equals("this")) { + if (currentMessage == null) { + throw new IllegalArgumentException("Failure obtaining term value for rule " + + currentRuleName + + ": \"this\" is not a valid name for generating runtime messages."); + } + varMessage = new ReplayWindowsMessage(currentMessage); + } + else { + Object tmp = messageStorage.get(obj); + if (tmp instanceof ReplayWindowsMessage) { + varMessage = (ReplayWindowsMessage) tmp; + } + else { + throw new IllegalArgumentException("Failure obtaining term value for rule " + + currentRuleName + ": No message \"" + obj + "\" stored."); + } + } + return varMessage; + } + + /** + *+ * Retrieves a stored message sequence from the storage. + *
+ * + * @param obj + * object identifier in the storage + * @return message sequence retrieved from the storage + * @throws IllegalArgumentException + * thrown if no message sequences with the identifier obj is found in the storage + */ + @SuppressWarnings("unchecked") + private List+ * convenience method for {@link #getTermValue(WindowsMessage, Term)} with current message is + * null. + *
+ * + * @param termElement + * {@link Element} representing the term node + * @return value of the term or {@code null} of the term node could not be evaluated + */ + private+ * Handles term-nodes and returns the value of the described term. + *
+ * + * @param currentMessage + * current message during the parsing; required to resolve references to "this" in a + * term + * @param termElement + * {@link Element} representing the term node + * @return value of the term or {@code null} of the term node could not be evaluated + */ + private+ * Convenience method for {@link #getTermValueAsList(WindowsMessage, Term)} with current + * message is null. + *
+ * + * @param termElement + * {@link Element} representing the term node + * @return value of the term or {@code null} of the term node could not be evaluated + */ + private+ * Handles term-nodes and returns the value of the described term. + *
+ * + * @param currentMessage + * current message during the parsing; required to resolve references to "this" in a + * term + * @param termElement + * {@link Element} representing the term node + * @return value of the term or {@code null} of the term node could not be evaluated + */ + private+ * Resolves term values. + *
+ * + * @param value value to be resolved + * @param expectedType class defining the expected type + * @return resolved value + */ + @SuppressWarnings("unchecked") + private+ * Handles LOWORD and HIWORD child nodes of LPARAM and WPARAM nodes. The returned value is the + * LPARAM/WPARAM value based on the LOWORD and HIWORD. + *
+ * + * @param param + * {@link Element} representing the LPARAM/WPARAM node + * @return value of the LPARAM/WPARAM + */ + private long loHiWord(EventGenerationRule.Term lword, EventGenerationRule.Term hword) { + return MAKEPARAM(getTermValue(lword, Short.class), getTermValue(hword, Short.class)); + } + + /** + *+ * Takes to short integers and combines them into the high and low order bits of an integer. + *
+ * + * @param loword + * low word + * @param hiword + * high word + * @return combined integer + */ + private static int MAKEPARAM(short loword, short hiword) { + return loword | ((int) hiword) << Short.SIZE; + } + + /** + *+ * Parses the rules. + *
+ * + */ + @SuppressWarnings("unchecked") + private void parseGenerationRules() { + SAXBuilder builder = new SAXBuilder(); + Document doc = null; + + try { + doc = builder.build(rulesFile); + rulesNamespace = Namespace.getNamespace("ul:rules"); + } + catch (JDOMException e) { + Console.printerrln("Invalid rules file."); + Console.logException(e); + return; + } + catch (IOException e) { + Console.printerrln("Invalid rules file."); + Console.logException(e); + return; + } + + Element rulesRoot = doc.getRootElement(); + + List+ * Message handler for {@code WM_CREATE} messages. The handler maintains the {@link WindowTree}. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class HandlerCreate extends MessageHandler { + + /** + *+ * Constructor. Creates a new HandlerCreate. + *
+ * + * @param windowTree the tree of GUI element specifications to be created and adapted during + * parsing + */ + public HandlerCreate(WindowTree windowTree) { + super(windowTree); + } + + /** + *+ * Name of the created window. + *
+ */ + private String windowName; + + /** + *+ * HWND of the created window. + *
+ */ + private long hwnd; + + /** + *+ * HWND of the created window's parent. + *
+ */ + private long parentHwnd; + + /** + *+ * Resource Id of the created window. + *
+ */ + private int resourceId; + + /** + *+ * Window class of the created window. + *
+ */ + private String className; + + /** + *+ * Modality of the created window. + *
+ */ + private boolean isModal; + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onEndElement() + */ + @Override + public void onEndElement() { + if (hwnd != 0) { + super.getWindowTree().add(parentHwnd, hwnd, windowName, resourceId, className, isModal); + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onParameter(java.lang.String , + * java.lang.String) + */ + @Override + public void onParameter(String name, String value) { + if (name.equals("window.hwnd")) { + hwnd = Long.parseLong(value); + } + else if (name.equals("window.name")) { + windowName = value; + } + else if (name.equals("window.parent.hwnd")) { + parentHwnd = Long.parseLong(value); + } + else if (name.equals("window.resourceId")) { + resourceId = Integer.parseInt(value); + } + else if (name.equals("window.class")) { + if (value.startsWith("Afx:")) { + className = "Afx:"; + } + else { + className = value; + } + } + else if (name.equals("window.ismodal")) { + if (value.equals("true") || value.equals("1")) { + isModal = true; + } + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onStartElement() + */ + @Override + public void onStartElement() { + windowName = ""; + hwnd = 0; + parentHwnd = 0; + resourceId = 0; + className = ""; + isModal = false; + } + +} Index: trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/HandlerDestroy.java =================================================================== --- trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/HandlerDestroy.java (revision 922) +++ trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/HandlerDestroy.java (revision 922) @@ -0,0 +1,69 @@ +package de.ugoe.cs.autoquest.plugin.mfc; + +import de.ugoe.cs.autoquest.plugin.mfc.guimodel.WindowTree; + +/** + *+ * Handler for {@code WM_DESTROY} message. The handler maintains the {@link WindowTree}. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class HandlerDestroy extends MessageHandler { + + /** + *+ * Constructor. Creates a new HandlerDestroy. + *
+ * + * @param windowTree + * the tree of GUI element specifications to be created and adapted during parsing + */ + public HandlerDestroy(WindowTree windowTree) { + super(windowTree); + } + + /** + *+ * HWND of the window that is destroyed. + *
+ */ + private long hwnd; + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onEndElement() + */ + @Override + public void onEndElement() { + if (hwnd != 0) { + super.getWindowTree().remove(hwnd); + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onParameter(java.lang.String , + * java.lang.String) + */ + @Override + public void onParameter(String name, String value) { + if (name.equals("window.hwnd")) { + hwnd = Long.parseLong(value); + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onStartElement() + */ + @Override + public void onStartElement() { + hwnd = 0; + } + +} Index: trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/HandlerSetText.java =================================================================== --- trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/HandlerSetText.java (revision 922) +++ trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/HandlerSetText.java (revision 922) @@ -0,0 +1,79 @@ +package de.ugoe.cs.autoquest.plugin.mfc; + +import de.ugoe.cs.autoquest.plugin.mfc.guimodel.WindowTree; + +/** + *+ * Handles {@code WM_SETTEXT} messages. Handler maintains the {@link WindowTree}. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class HandlerSetText extends MessageHandler { + + /** + *+ * Constructor. Creates a new HanderSetText. + *
+ * + * @param windowTree + * the tree of GUI element specifications to be created and adapted during parsing + */ + public HandlerSetText(WindowTree windowTree) { + super(windowTree); + } + + /** + *+ * New name of the window. + *
+ */ + private String windowName; + + /** + *+ * HWND of the window. + *
+ */ + private long hwnd; + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onEndElement() + */ + @Override + public void onEndElement() { + if (hwnd != 0) { + super.getWindowTree().setName(hwnd, windowName); + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onParameter(java.lang.String , + * java.lang.String) + */ + @Override + public void onParameter(String name, String value) { + if (name.equals("window.hwnd")) { + hwnd = Long.parseLong(value); + } + else if (name.equals("window.newText")) { + windowName = value; + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.mfc.MessageHandler#onStartElement() + */ + @Override + public void onStartElement() { + windowName = ""; + hwnd = 0; + } +} Index: trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/LogPreprocessor.java =================================================================== --- trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/LogPreprocessor.java (revision 922) +++ trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/LogPreprocessor.java (revision 922) @@ -0,0 +1,221 @@ +package de.ugoe.cs.autoquest.plugin.mfc; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.OutputStreamWriter; +import java.util.logging.Level; + +import org.apache.commons.codec.binary.Base64; + +import de.ugoe.cs.util.FileTools; +import de.ugoe.cs.util.StringTools; +import de.ugoe.cs.util.console.Console; + +/** + *+ * Pre-processes log files generated by the EventBench's MFCUsageMonitor. It + * decodes Base64 encoding into UTF-16. It removes all lines of the log file, + * that do not start with the prefix "UL:", end everything before the prefix and + * the prefix itself. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class LogPreprocessor { + + /** + *+ * Internal flag that monitors whether there is an open session-node in the + * XML file to ensure that there is a closing session-node for each opening + * session node and, thereby, ensure that the XML file is well formed. + *
+ */ + private boolean sessionOpen = false; + + /** + *+ * Internal flag that monitors whether a message node is longer than one + * line, as the prefix handling is different in this case. + *
+ */ + private boolean msgIncomplete = false; + + /** + *+ * Flag that marks whether the log file is Base64 encoded. + *
+ */ + private boolean base64; + + /** + *+ * Constructor. Creates a new LogPreprocessor that does not decode Base64. + *
+ */ + public LogPreprocessor() { + this(false); + } + + /** + *+ * Constructor. Creates a new LogPreprocessor. + *
+ * + * @param base64 + * if true, Base64 will be decoded. + */ + public LogPreprocessor(boolean base64) { + this.base64 = base64; + } + + /** + *+ * Pre-processes a single log file. + *
+ * + * @param source + * name and path of the source file + * @param target + * name and path of the target file + * @throws IOException + * thrown if there is a problem with reading from or writing to + * the source, respectively target file + * @throws FileNotFoundException + * thrown if the source file is not found + */ + public void convertToXml(String source, String target) throws IOException, + FileNotFoundException { + OutputStreamWriter targetFile = new OutputStreamWriter( + new FileOutputStream(target), "UTF-8"); + targetFile.write("" + + StringTools.ENDLINE); + targetFile.write("+ * Pre-processes all files in a given source folder. + *
+ * + * @param path + * path of the source folder + * @param target + * name and path of the target file + * @throws IOException + * thrown if there is a problem with reading from or writing to + * the source, respectively target file + * @throws FileNotFoundException + * thrown if the source file is not found + */ + public void convertDirToXml(String path, String target) throws IOException, + FileNotFoundException { + OutputStreamWriter targetFile = new OutputStreamWriter( + new FileOutputStream(target), "UTF-8"); + targetFile.write("" + + StringTools.ENDLINE); + targetFile.write("+ * Internal function that pre-processes a log file. + *
+ * + * @param source + * name and path of the source file + * @param target + * name and path of the target file + * @throws IOException + * thrown if there is a problem with reading from or writing to + * the source, respectively target file + * @throws FileNotFoundException + * thrown if the source file is not found + */ + private void processFile(String source, OutputStreamWriter targetFile) + throws FileNotFoundException, IOException { + String[] lines = FileTools.getLinesFromFile(source, false); + String incompleteLine = ""; + for (String currentLine : lines) { + if (currentLine.contains("UL:+ * This class provides functionality to parse XML log files generated by the MFCUsageMonitor of + * EventBench. The result of parsing a file is a collection of event sequences. It uses the + * {@link SequenceSplitter} and the {@link EventGenerator} as well as custom defined + * {@link MessageHandler} for the parsing. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class MFCLogParser extends DefaultHandler { + + /** + *+ * If a custom message handler is used, this field contains its handle. Otherwise this field is + * {@code null}. + *
+ */ + private MessageHandler currentHandler; + + /** + *+ * internal handle to the current window tree + *
+ */ + private WindowTree currentWindowTree; + + /** + *+ * the type of the currently parsed message + *
+ */ + private WindowsMessageType currentMessageType; + + /** + *+ * the parameters of the currently parsed message + *
+ */ + private Map+ * {@link SequenceSplitter} instance used by the {@link MFCLogParser}. + *
+ */ + private SequenceSplitter sequenceSplitter; + + /** + *+ * Collection of message sequences that is contained in the log file, which is parsed. + *
+ */ + private Collection+ * Debugging variable that allows the analysis which message type occurs how often in the log + * file. Can be used to enhance the message filter. + *
+ */ + private SortedMap+ * Debugging variable that enables the counting of the occurrences of each message. Used in + * combination with {@link #typeCounter}. + *
+ */ + private boolean countMessageOccurences; + + /** + *+ * Constructor. Creates a new LogParser that does not count message occurrences. + *
+ */ + public MFCLogParser() { + this(false); + } + + /** + *+ * Constructor. Creates a new LogParser. + *
+ * + * @param countMessageOccurences + * if true, the occurrences of each message type in the log is counted. + */ + public MFCLogParser(boolean countMessageOccurences) { + sequences = new LinkedList+ * Parses a log file written by the MFCMonitor and creates a collection of event sequences. + *
+ * + * @param filename + * name and path of the log file + */ + public void parseFile(String filename) { + if (filename == null) { + throw new IllegalArgumentException("filename must not be null"); + } + + parseFile(new File(filename)); + } + + /** + *+ * Parses a log file written by the MFCMonitor and creates a collection of event sequences. + *
+ * + * @param file + * name and path of the log file + */ + public void parseFile(File file) { + if (file == null) { + throw new IllegalArgumentException("file must not be null"); + } + + SAXParserFactory spf = SAXParserFactory.newInstance(); + spf.setValidating(true); + + SAXParser saxParser = null; + InputSource inputSource = null; + try { + saxParser = spf.newSAXParser(); + inputSource = new InputSource(new InputStreamReader(new FileInputStream(file), "UTF-8")); + } + catch (UnsupportedEncodingException e) { + Console.printerr("Error parsing file " + file.getName()); + Console.logException(e); + } + catch (ParserConfigurationException e) { + Console.printerr("Error parsing file " + file.getName()); + Console.logException(e); + } + catch (SAXException e) { + Console.printerr("Error parsing file " + file.getName()); + Console.logException(e); + } + catch (FileNotFoundException e) { + Console.printerr("Error parsing file " + file.getName()); + Console.logException(e); + } + + if (inputSource != null) { + inputSource.setSystemId("file://" + file.getAbsolutePath()); + try { + if (saxParser == null) { + throw new RuntimeException("SAXParser creation failed"); + } + saxParser.parse(inputSource, this); + } + catch (SAXParseException e) { + Console.printerrln("Failure parsing file in line " + e.getLineNumber() + + ", column " + e.getColumnNumber() + "."); + Console.logException(e); + } + catch (SAXException e) { + Console.printerr("Error parsing file " + file.getName()); + Console.logException(e); + } + catch (IOException e) { + Console.printerr("Error parsing file " + file.getName()); + Console.logException(e); + } + } + + if (countMessageOccurences) { + Console.println("Message statistics:"); + Console.println + (typeCounter.toString().replace(" ", StringTools.ENDLINE).replaceAll("[\\{\\}]", "")); + } + } + + /** + *+ * Returns the collection of event sequences that is obtained from parsing log files. + *
+ * + * @return collection of event sequences + */ + public Collection+ * Returns the gui model that is obtained from parsing log files. + *
+ * + * @return collection of event sequences + */ + public GUIModel getGuiModel() { + if( currentWindowTree!=null ) { + return currentWindowTree.getGUIModel(); + } else { + return null; + } + } + + /* + * (non-Javadoc) + * + * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, + * java.lang.String, org.xml.sax.Attributes) + */ + @Override + public void startElement(String uri, String localName, String qName, Attributes atts) + throws SAXException + { + if (qName.equals("session")) { + Console.traceln(Level.FINE, "start of session"); + // in some logs, the session end may be marked in between the log. This is because + // of thread problems. So instead of creating a new GUI model, preserve it. + if (currentWindowTree == null) { + currentWindowTree = new WindowTree(); + } + sequenceSplitter = new SequenceSplitter(currentWindowTree); + } + else if (qName.equals("msg")) { + currentMessageType = WindowsMessageType.parseMessageType(atts.getValue("type")); + + if (countMessageOccurences) { + Integer currentCount = typeCounter.get(currentMessageType); + if (currentCount == null) { + typeCounter.put(currentMessageType, 1); + } + else { + typeCounter.put(currentMessageType, currentCount + 1); + } + } + + if (currentMessageType == WindowsMessageType.WM_CREATE) { + currentHandler = new HandlerCreate(currentWindowTree); + currentHandler.onStartElement(); + } + else if (currentMessageType == WindowsMessageType.WM_DESTROY) { + currentHandler = new HandlerDestroy(currentWindowTree); + currentHandler.onStartElement(); + } + else if (currentMessageType == WindowsMessageType.WM_SETTEXT) { + currentHandler = new HandlerSetText(currentWindowTree); + currentHandler.onStartElement(); + } + } + else if (qName.equals("param")) { + if (currentHandler != null) { + currentHandler.onParameter(atts.getValue("name"), atts.getValue("value")); + } + else { + // provide the parameters directly in the correct type + String paramName = atts.getValue("name"); + if (("window.hwnd".equals(paramName)) || + ("source".equals(paramName)) || + ("LPARAM".equals(paramName)) || + ("WPARAM".equals(paramName)) || + ("scrollPos".equals(paramName)) || + ("scrollBarHandle".equals(paramName))) + { + Long paramValue = Long.parseLong(atts.getValue("value")); + currentMessageParameters.put(paramName, paramValue); + } + else { + currentMessageParameters.put(paramName, atts.getValue("value")); + } + } + } + } + + /* + * (non-Javadoc) + * + * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String, + * java.lang.String) + */ + @Override + public void endElement(String uri, String localName, String qName) throws SAXException { + if (qName.equals("msg")) { + if (currentHandler != null) { + currentHandler.onEndElement(); + currentHandler = null; + } + else { + try { + long hwnd = (Long) currentMessageParameters.get("window.hwnd"); + MFCGUIElement target = currentWindowTree.find(hwnd); + + WindowsMessage message = new WindowsMessage + (currentMessageType, target, currentMessageParameters); + + sequenceSplitter.addMessage(message); + } + catch (IllegalArgumentException e) { + Console.traceln(Level.WARNING, e.getMessage() + " WindowsMessage " + currentMessageType + + " ignored."); + } + } + } + else if (qName.equals("session")) { + sequenceSplitter.endSession(); + List+ * Identifier class for the QUEST MFC plug-in. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class MFCPlugin implements QuestPlugin { + + /** + *+ * The command packages of this plug-in. + *
+ */ + private final static String[] commandPackages = new String[] { "de.ugoe.cs.autoquest.plugin.mfc.commands" }; + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.QuestPlugin#getTitle() + */ + @Override + public String getTitle() { + return "MFC-Plugin"; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.plugin.QuestPlugin#getCommandPackages() + */ + @Override + public List+ * {@link IReplayDecorator} for replay generated for EventBench's MFCReplay tool. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class MFCReplayDecorator implements IReplayDecorator { + + /** + *+ * Id for object serialization. + *
+ */ + private static final long serialVersionUID = 1L; + + /** + *+ * The instance of the {@link MFCReplayDecorator} (implemented as + * singleton). + *
+ */ + transient private static MFCReplayDecorator theInstance; + + /** + *+ * Constructor. Private to guarantee that only one instance of the replay + * generator exists. + *
+ */ + private MFCReplayDecorator() { + }; + + /** + *+ * Returns the instance of the MFCReplayDecorator. + *
+ * + * @return instance of the MFCReplayDecorator. + */ + public static MFCReplayDecorator getInstance() { + if (theInstance == null) { + theInstance = new MFCReplayDecorator(); + } + return theInstance; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.IReplayDecorator#getHeader() + */ + @Override + public String getHeader() { + return "" + + StringTools.ENDLINE + "+ * Base class to define custom message handlers, for messages that shall be handled differently + * during the parsing of usage logs. It provides dummy implementations for all required methods, + * such that implementations can only overwrite the parts they actually require and ignore the rest. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class MessageHandler { + + /** + *+ * during parsing, a tree of GUI elements is created and adapted. + * This is the reference to it. + *
+ */ + private WindowTree windowTree; + + /** + *+ * Constructor. Protected to prohibit initialization of the base class itself. + *
+ * + * @param windowTree the tree of GUI element specifications to be created and adapted during + * parsing + */ + protected MessageHandler(WindowTree windowTree) { + this.windowTree = windowTree; + } + + /** + *+ * Called in the startElement() method of the {@link MFCLogParser} when a msg-node begins. + *
+ */ + public void onStartElement() {} + + /** + *+ * Called by the {@link MFCLogParser} to handle param-nodes. + *
+ * + * @param name + * name (type) of the parameter + * @param value + * value of the parameter + */ + public void onParameter(String name, String value) {} + + /** + *+ * Called in the endElement() method of {@link MFCLogParser} when a msg-node ends. + *
+ */ + public void onEndElement() {} + + /** + * @return the window tree created and adapted during parsing + */ + protected WindowTree getWindowTree() { + return windowTree; + } + +} Index: trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/SequenceSplitter.java =================================================================== --- trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/SequenceSplitter.java (revision 922) +++ trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/SequenceSplitter.java (revision 922) @@ -0,0 +1,175 @@ +package de.ugoe.cs.autoquest.plugin.mfc; + +import java.util.LinkedList; +import java.util.List; +import java.util.logging.Level; + +import de.ugoe.cs.autoquest.eventcore.Event; +import de.ugoe.cs.autoquest.plugin.mfc.eventcore.WindowsMessage; +import de.ugoe.cs.autoquest.plugin.mfc.eventcore.WindowsMessageType; +import de.ugoe.cs.autoquest.plugin.mfc.guimodel.WindowTree; +import de.ugoe.cs.util.console.Console; + +/** + *+ * Responsible to split sequences into subsequences, such that each subsequences contains exactly + * one event. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class SequenceSplitter { + + /** + *+ * Contains the current subsequence. + *
+ */ + private List+ * Number of messages in the current sequences, that signal that a key or mouse button has been + * pressed down to which not yet a message has been found, that signals that the button has been + * released. + *
+ */ + private int openDowns; + + /** + *+ * Internal flag that signals if {@link #currentSequence} needs to be initialized. + *
+ */ + private boolean initMessages; + + /** + *+ * The {@link EventGenerator} used to convert the subsequences into {@link Event}s + *
+ */ + private EventGenerator tokenGenerator; + + /** + *+ * The event sequence generated. + *
+ */ + private List+ * Type of the previous message. + *
+ */ + private WindowsMessageType prevMsg; + + /** + *+ * Constructor. Creates a new SequenceSplitter. + *
+ */ + public SequenceSplitter(WindowTree windowTree) { + currentSequence = new LinkedList+ * Called by the {@link MFCLogParser} every time a message is parsed. + *
+ * + * @param msg + * message to be added + */ + public void addMessage(WindowsMessage msg) { + if (startOfSequence(msg)) { + if (!initMessages) { + Event currentAction = tokenGenerator.generateEvent(currentSequence); + if (currentAction != null) { + actionSequence.add(currentAction); + } + if (msg.getType().isKeyMessage() && openDowns > 0) { + Console.traceln(Level.SEVERE, "Key message found with open down mouse " + + "messages - will probabably result in a faulty sequence."); + } + } + else { + initMessages = false; + } + currentSequence = new LinkedList+ * Returns the event sequence generated from the message that have been added. + *
+ * + * @return generated event sequence + */ + public List+ * Called when a session in the log file is finished, i.e., a closing session-node is found. + *
+ */ + public void endSession() { + Event currentAction = tokenGenerator.generateEvent(currentSequence); + if (currentAction != null) { + actionSequence.add(currentAction); + } + } + + /** + *+ * Checks if the message starts a new subsequence and returns the result. + *
+ * + * @param msg + * message that is checked + * @return true, if a new subsequence begins + */ + private boolean startOfSequence(WindowsMessage msg) { + boolean isStart = false; + WindowsMessageType msgType = msg.getType(); + if (msgType.isKeyMessage()) { + isStart = true; + } + if (msgType.isDownMessage()) { + openDowns++; + if (openDowns == 1) { + isStart = true; + } + } + if (msgType.isDblclkMessage()) { + openDowns++; + } + return isStart; + } + +} Index: trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/commands/CMDconvertDirToXml.java =================================================================== --- trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/commands/CMDconvertDirToXml.java (revision 922) +++ trunk/autoquest-plugin-mfc/src/main/java/de/ugoe/cs/autoquest/plugin/mfc/commands/CMDconvertDirToXml.java (revision 922) @@ -0,0 +1,58 @@ +package de.ugoe.cs.autoquest.plugin.mfc.commands; + +import java.io.FileNotFoundException; +import java.io.IOException; +import java.util.List; + +import de.ugoe.cs.autoquest.plugin.mfc.LogPreprocessor; +import de.ugoe.cs.util.console.Command; +import de.ugoe.cs.util.console.Console; + +/** + *+ * Command to pre-process all files in a folder. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class CMDconvertDirToXml implements Command { + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.util.console.Command#help() + */ + @Override + public String help() { + return "convertDirToXml