Consolidate/cleanup event cracking code; single out GdkEvents.

views/events/event.h

 // Copyright (c) 2011 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 VIEWS_EVENTS_EVENT_H_
 #define VIEWS_EVENTS_EVENT_H_
 #pragma once
 
 #include "base/basictypes.h"
 #include "base/time.h"
 #include "ui/base/events.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/gfx/point.h"
-#include "views/native_types.h"
 #include "views/views_export.h"
 
-#if defined(USE_X11)
-typedef union _XEvent XEvent;
-#endif
-
 namespace ui {
 class OSExchangeData;
 }
-using ui::OSExchangeData;
+
+#if defined(USE_AURA)
+namespace aura {
+class Event;
+}
+#endif
+
+// TODO(msw): Remove GTK support from views event code when possible.
+#if defined(TOOLKIT_USES_GTK)
+typedef union _GdkEvent GdkEvent;
+#endif
 
 namespace views {
 
+#if defined(USE_AURA)
+typedef aura::Event* NativeEvent;
+#else
+typedef ui::NativeEvent NativeEvent;
+#endif
+
 class View;
 
 namespace internal {
 class NativeWidgetView;
 class RootView;
 }
 
-#if defined(OS_WIN) || defined(USE_AURA)
-VIEWS_EXPORT bool IsClientMouseEvent(const views::NativeEvent& native_event);
-VIEWS_EXPORT bool IsNonClientMouseEvent(const views::NativeEvent& native_event);
-#endif
-
 ////////////////////////////////////////////////////////////////////////////////
 //
 // Event class
 //
 // An event encapsulates an input event that can be propagated into view
 // hierarchies. An event has a type, some flags and a time stamp.
 //
 // Each major event type has a corresponding Event subclass.
 //
 // Events are immutable but support copy
 //
 ////////////////////////////////////////////////////////////////////////////////
 class VIEWS_EXPORT Event {
  public:
-  // This type exists to distinguish between the NativeEvent and NativeEvent2
-  // constructors.
-  // TODO(beng): remove once we rid views of Gtk/Gdk.
-  struct FromNativeEvent2 {};
-
   const NativeEvent& native_event() const { return native_event_; }
-  const NativeEvent2& native_event_2() const { return native_event_2_; }
+#if defined(TOOLKIT_USES_GTK)
+  GdkEvent* gdk_event() const { return gdk_event_; }
+#endif
   ui::EventType type() const { return type_; }
   const base::Time& time_stamp() const { return time_stamp_; }
   int flags() const { return flags_; }
   void set_flags(int flags) { flags_ = flags; }
 
   // The following methods return true if the respective keys were pressed at
   // the time the event was created.
   bool IsShiftDown() const { return (flags_ & ui::EF_SHIFT_DOWN) != 0; }
   bool IsControlDown() const { return (flags_ & ui::EF_CONTROL_DOWN) != 0; }
   bool IsCapsLockDown() const { return (flags_ & ui::EF_CAPS_LOCK_DOWN) != 0; }
@@ skipping 10 matching lines @@
   }
 
   bool IsTouchEvent() const {
     return type_ == ui::ET_TOUCH_RELEASED ||
            type_ == ui::ET_TOUCH_PRESSED ||
            type_ == ui::ET_TOUCH_MOVED ||
            type_ == ui::ET_TOUCH_STATIONARY ||
            type_ == ui::ET_TOUCH_CANCELLED;
   }
 
-#if defined(OS_WIN) && !defined(USE_AURA)
-  // Returns the EventFlags in terms of windows flags.
-  int GetWindowsFlags() const;
-#elif defined(OS_LINUX)
-  // Get the views::Event flags from a native GdkEvent.
-  static int GetFlagsFromGdkEvent(NativeEvent native_event);
-#endif
-
  protected:
   Event(ui::EventType type, int flags);
-  Event(NativeEvent native_event, ui::EventType type, int flags);
-  // Because the world is complicated, sometimes we have two different kinds of
-  // NativeEvent in play in the same executable. See native_types.h for the tale
-  // of woe.
-  Event(NativeEvent2 native_event, ui::EventType type, int flags,
-        FromNativeEvent2);
+  Event(const NativeEvent& native_event, ui::EventType type, int flags);
+#if defined(TOOLKIT_USES_GTK)
+  Event(GdkEvent* gdk_event, ui::EventType type, int flags);
+#endif
 
   Event(const Event& model)
       : native_event_(model.native_event()),
-        native_event_2_(model.native_event_2()),
         type_(model.type()),
         time_stamp_(model.time_stamp()),
         flags_(model.flags()) {
   }
 
   void set_type(ui::EventType type) { type_ = type; }
 
  private:
   void operator=(const Event&);
 
-  // Safely initializes the native event members of this class.
-  void Init();
-  void InitWithNativeEvent(NativeEvent native_event);
-  void InitWithNativeEvent2(NativeEvent2 native_event_2, FromNativeEvent2);
-
   NativeEvent native_event_;
-  NativeEvent2 native_event_2_;
+#if defined(TOOLKIT_USES_GTK)
+  GdkEvent* gdk_event_;
+#endif
   ui::EventType type_;
   base::Time time_stamp_;
   int flags_;
 };
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // LocatedEvent class
 //
 // A generic event that is used for any events that is located at a specific
 // position in the screen.
 //
 ////////////////////////////////////////////////////////////////////////////////
 class VIEWS_EXPORT LocatedEvent : public Event {
  public:
   int x() const { return location_.x(); }
   int y() const { return location_.y(); }
   const gfx::Point& location() const { return location_; }
 
  protected:
-  explicit LocatedEvent(NativeEvent native_event);
-  LocatedEvent(NativeEvent2 native_event_2, FromNativeEvent2 from_native);
+  explicit LocatedEvent(const NativeEvent& native_event);
+#if defined(TOOLKIT_USES_GTK)
+  explicit LocatedEvent(GdkEvent* gdk_event);
+#endif
 
   // TODO(msw): Kill this legacy constructor when we update uses.
   // Simple initialization from cracked metadata.
   LocatedEvent(ui::EventType type, const gfx::Point& location, int flags);
 
   // Create a new LocatedEvent which is identical to the provided model.
   // If source / target views are provided, the model location will be converted
   // from |source| coordinate system to |target| coordinate system.
   LocatedEvent(const LocatedEvent& model, View* source, View* target);
 
   // This constructor is to allow converting the location of an event from the
   // widget's coordinate system to the RootView's coordinate system.
   LocatedEvent(const LocatedEvent& model, View* root);
 
   gfx::Point location_;
 };
 
 class TouchEvent;
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // MouseEvent class
 //
 // A mouse event is used for any input event related to the mouse.
 //
 ////////////////////////////////////////////////////////////////////////////////
 class VIEWS_EXPORT MouseEvent : public LocatedEvent {
  public:
-  explicit MouseEvent(NativeEvent native_event);
-  MouseEvent(NativeEvent2 native_event_2, FromNativeEvent2 from_native);
+  explicit MouseEvent(const NativeEvent& native_event);
+#if defined(TOOLKIT_USES_GTK)
+  explicit MouseEvent(GdkEvent* gdk_event);
+#endif
 
   // Create a new MouseEvent which is identical to the provided model.
   // If source / target views are provided, the model location will be converted
   // from |source| coordinate system to |target| coordinate system.
   MouseEvent(const MouseEvent& model, View* source, View* target);
 
   // Creates a new MouseEvent from a TouchEvent. The location of the TouchEvent
   // is the same as the MouseEvent. Other attributes (e.g. type, flags) are
   // mapped from the TouchEvent to appropriate MouseEvent attributes.
   // GestureManager uses this to convert TouchEvents that are not handled by any
   // view.
-  MouseEvent(const TouchEvent& touch, FromNativeEvent2 from_native);
+  explicit MouseEvent(const TouchEvent& touch);
 
   // TODO(msw): Kill this legacy constructor when we update uses.
   // Create a new mouse event
   MouseEvent(ui::EventType type, int x, int y, int flags)
       : LocatedEvent(type, gfx::Point(x, y), flags) {
   }
 
   // Conveniences to quickly test what button is down
   bool IsOnlyLeftMouseButton() const {
     return (flags() & ui::EF_LEFT_BUTTON_DOWN) &&
@@ skipping 38 matching lines @@
 //
 // TouchEvent class
 //
 // A touch event is generated by touch screen and advanced track
 // pad devices. There is a deliberate direct correspondence between
 // TouchEvent and PlatformTouchPoint.
 //
 ////////////////////////////////////////////////////////////////////////////////
 class VIEWS_EXPORT TouchEvent : public LocatedEvent {
  public:
-  TouchEvent(NativeEvent2 native_event_2, FromNativeEvent2 from_native);
+  explicit TouchEvent(const NativeEvent& native_event);
 
   // Create a new touch event.
   TouchEvent(ui::EventType type,
              int x,
              int y,
              int flags,
              int touch_id,
              float radius_x,
              float radius_y,
              float angle,
@@ skipping 37 matching lines @@
 };
 
 ////////////////////////////////////////////////////////////////////////////////
 // KeyEvent class
 //
 //  KeyEvent encapsulates keyboard input events - key press and release.
 //
 ////////////////////////////////////////////////////////////////////////////////
 class VIEWS_EXPORT KeyEvent : public Event {
  public:
-  explicit KeyEvent(NativeEvent native_event);
-  KeyEvent(NativeEvent2 native_event_2, FromNativeEvent2 from_native);
+  explicit KeyEvent(const NativeEvent& native_event);
+#if defined(TOOLKIT_USES_GTK)
+  explicit KeyEvent(GdkEvent* gdk_event);
+#endif
 
   // Creates a new KeyEvent synthetically (i.e. not in response to an input
   // event from the host environment). This is typically only used in testing as
   // some metadata obtainable from the underlying native event is not present.
   // It's also used by input methods to fabricate keyboard events.
   KeyEvent(ui::EventType type,
            ui::KeyboardCode key_code,
            int event_flags);
 
   ui::KeyboardCode key_code() const { return key_code_; }
@@ skipping 54 matching lines @@
 //
 // A MouseWheelEvent is used to propagate mouse wheel user events.
 // Note: e.GetOffset() > 0 means scroll up / left.
 //
 ////////////////////////////////////////////////////////////////////////////////
 class VIEWS_EXPORT MouseWheelEvent : public MouseEvent {
  public:
   // See |offset| for details.
   static const int kWheelDelta;
 
-  explicit MouseWheelEvent(NativeEvent native_event);
-  MouseWheelEvent(NativeEvent2 native_event_2, FromNativeEvent2 from_native);
+  explicit MouseWheelEvent(const NativeEvent& native_event);
+#if defined(TOOLKIT_USES_GTK)
+  explicit MouseWheelEvent(GdkEvent* gdk_event);
+#endif
 
   // The amount to scroll. This is in multiples of kWheelDelta.
   int offset() const { return offset_; }
 
  private:
   friend class internal::RootView;
   friend class internal::NativeWidgetView;
 
   MouseWheelEvent(const MouseWheelEvent& model, View* root)
       : MouseEvent(model, root),
         offset_(model.offset_) {
   }
 
   int offset_;
 
   DISALLOW_COPY_AND_ASSIGN(MouseWheelEvent);
 };
 
 ////////////////////////////////////////////////////////////////////////////////
 //
 // DropTargetEvent class
 //
 // A DropTargetEvent is sent to the view the mouse is over during a drag and
 // drop operation.
 //
 ////////////////////////////////////////////////////////////////////////////////
 class VIEWS_EXPORT DropTargetEvent : public LocatedEvent {
  public:
-  DropTargetEvent(const OSExchangeData& data,
+  DropTargetEvent(const ui::OSExchangeData& data,
                   int x,
                   int y,
                   int source_operations)
       : LocatedEvent(ui::ET_DROP_TARGET_EVENT, gfx::Point(x, y), 0),
         data_(data),
         source_operations_(source_operations) {
     // TODO(msw): Hook up key state flags for CTRL + drag and drop, etc.
   }
 
-  const OSExchangeData& data() const { return data_; }
+  const ui::OSExchangeData& data() const { return data_; }
   int source_operations() const { return source_operations_; }
 
  private:
   // Data associated with the drag/drop session.
-  const OSExchangeData& data_;
+  const ui::OSExchangeData& data_;
 
   // Bitmask of supported ui::DragDropTypes::DragOperation by the source.
   int source_operations_;
 
   DISALLOW_COPY_AND_ASSIGN(DropTargetEvent);
 };
 
 }  // namespace views
 
 #endif  // VIEWS_EVENTS_EVENT_H_