/*
 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
 *           (C) 2001 Dirk Mueller (mueller@kde.org)
 * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights
 * reserved.
 * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
 * Copyright (C) 2009 Torch Mobile Inc. All rights reserved.
 * (http://www.torchmobile.com/)
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef EventDispatcher_h
#define EventDispatcher_h

#include "core/dom/SimulatedClickOptions.h"
#include "core/events/EventDispatchResult.h"
#include "platform/heap/Handle.h"
#include "wtf/PassRefPtr.h"
#include "wtf/RefPtr.h"

namespace blink {

class Event;
class EventDispatchMediator;
class FrameView;
class EventDispatchHandlingState;
class Node;

class EventDispatchHandlingState
    : public GarbageCollected<EventDispatchHandlingState> {
 public:
  DEFINE_INLINE_VIRTUAL_TRACE() {}
};

enum EventDispatchContinuation { ContinueDispatching, DoneDispatching };

class EventDispatcher {
  STACK_ALLOCATED();

 public:
  static DispatchEventResult dispatchEvent(Node&, EventDispatchMediator*);
  static void dispatchScopedEvent(Node&, EventDispatchMediator*);

  static void dispatchSimulatedClick(Node&,
                                     Event* underlyingEvent,
                                     SimulatedClickMouseEventOptions,
                                     SimulatedClickCreationScope);

  DispatchEventResult dispatch();
  Node& node() const { return *m_node; }
  Event& event() const { return *m_event; }

 private:
  EventDispatcher(Node&, Event*);

  EventDispatchContinuation dispatchEventPreProcess(
      EventDispatchHandlingState*&);
  EventDispatchContinuation dispatchEventAtCapturing();
  EventDispatchContinuation dispatchEventAtTarget();
  void dispatchEventAtBubbling();
  void dispatchEventPostProcess(EventDispatchHandlingState*);

  Member<Node> m_node;
  Member<Event> m_event;
  Member<FrameView> m_view;
#if DCHECK_IS_ON()
  bool m_eventDispatched = false;
#endif
};

}  // namespace blink

#endif
