events: Inlcude the event-phase and event-result in Event.

ui/base/events/event_dispatcher.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef UI_BASE_EVENTS_EVENT_DISPATCHER_H_
 #define UI_BASE_EVENTS_EVENT_DISPATCHER_H_
 
 #include "ui/base/events/event.h"
 #include "ui/base/events/event_constants.h"
 #include "ui/base/events/event_target.h"
@@ skipping 15 matching lines @@
   // Allows the subclass to add additional event handlers to the dispatch
   // sequence.
   virtual void ProcessPreTargetList(EventHandlerList* list) = 0;
   virtual void ProcessPostTargetList(EventHandlerList* list) = 0;
 
   template<class T>
   int ProcessEvent(EventTarget* target, T* event) {
     if (!target || !target->CanAcceptEvents())
       return ER_UNHANDLED;
 
     Event::DispatcherApi dispatcher(event);

[Ben Goodger (Google), 2012/09/10 18:07:14]

this variable name is short, but I find it a little confusing, since it's not
really a dispatcher.

[sadrul, 2012/09/10 18:35:24]

Renamed to dispatch_helper

     dispatcher.set_target(target);
 
     EventHandlerList list;
     target->GetPreTargetHandlers(&list);
     ProcessPreTargetList(&list);
+    dispatcher.set_phase(EP_PRETARGET);
     int result = DispatchEventToEventHandlers(list, event);
-    if (result & ER_CONSUMED)
+    if (result & ER_CONSUMED) {
+      dispatcher.set_phase(EP_COMPLETE);

[Ben Goodger (Google), 2012/09/10 18:07:14]

it would be nice to find a way to do this with a scoping object for safety.

[sadrul, 2012/09/10 18:35:24]

Done.

       return result;
+    }
 
     // If the event hasn't been consumed, trigger the default handler. Note that
     // even if the event has already been handled (i.e. return result has
     // ER_HANDLED set), that means that the event should still be processed at
     // this layer, however it should not be processed in the next layer of
     // abstraction.
     if (CanDispatchToTarget(target)) {
+      dispatcher.set_phase(EP_TARGET);
       result |= DispatchEventToSingleHandler(target, event);
-      if (result & ER_CONSUMED)
+      dispatcher.set_result(event->result() | result);
+      if (result & ER_CONSUMED) {
+        dispatcher.set_phase(EP_COMPLETE);
         return result;
+      }
     }
 
-    if (!CanDispatchToTarget(target))
+    if (!CanDispatchToTarget(target)) {
+      dispatcher.set_phase(EP_COMPLETE);
       return result;
+    }
 
     list.clear();
     target->GetPostTargetHandlers(&list);
     ProcessPostTargetList(&list);
+    dispatcher.set_phase(EP_POSTTARGET);
     result |= DispatchEventToEventHandlers(list, event);
+    dispatcher.set_phase(EP_COMPLETE);
     return result;
   }
 
  private:
   template<class T>
   int DispatchEventToEventHandlers(EventHandlerList& list, T* event) {
     int result = ER_UNHANDLED;
+    Event::DispatcherApi dispatcher(event);
     for (EventHandlerList::const_iterator it = list.begin(),
             end = list.end(); it != end; ++it) {
       result |= DispatchEventToSingleHandler((*it), event);
+      dispatcher.set_result(event->result() | result);
       if (result & ER_CONSUMED)
         return result;
     }
     return result;
   }
 
   EventResult DispatchEventToSingleHandler(EventHandler* handler,
                                            KeyEvent* event);
   EventResult DispatchEventToSingleHandler(EventHandler* handler,
                                            MouseEvent* event);
   EventResult DispatchEventToSingleHandler(EventHandler* handler,
                                            ScrollEvent* event);
   EventResult DispatchEventToSingleHandler(EventHandler* handler,
                                            TouchEvent* event);
   EventResult DispatchEventToSingleHandler(EventHandler* handler,
                                            GestureEvent* event);
 
   DISALLOW_COPY_AND_ASSIGN(EventDispatcher);
 };
 
 }  // namespace ui
 
 #endif  // UI_BASE_EVENTS_EVENT_DISPATCHER_H_