/*

* Copyright (C) 2011, 2014 Apple Inc. All rights reserved.

* Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

* 1. Redistributions of source code must retain the above copyright

* notice, this list of conditions and the following disclaimer.

* 2. Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in the

* documentation and/or other materials provided with the distribution.

*

* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''

* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,

* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS

* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF

* THE POSSIBILITY OF SUCH DAMAGE.

*/

#pragma once

#include <wtf/CompletionHandler.h>

#include <wtf/Deque.h>

#include <wtf/HashFunctions.h>

#include <wtf/HashMap.h>

#include <wtf/HashSet.h>

#include <wtf/HashTraits.h>

#include <wtf/RetainPtr.h>

#include <wtf/Vector.h>

#if PLATFORM(COCOA)

OBJC_CLASS NSEvent;

#endif

namespace WebCore {

enum class MouseButton : int8_t;

}

namespace WTR {

class TestController;

#if USE(LIBWPE) || ENABLE(WPE_PLATFORM)

class EventSenderProxyClient;

#endif

class EventSenderProxy {

WTF_DEPRECATED_MAKE_FAST_ALLOCATED(EventSenderProxy);

public:

explicit EventSenderProxy(TestController*);

~EventSenderProxy();

WKPoint position() const { return m_position; }

void mouseDown(unsigned button, WKEventModifiers, WKStringRef pointerType = nullptr, CompletionHandler<void()>&& = nullptr);

void mouseUp(unsigned button, WKEventModifiers, WKStringRef pointerType = nullptr, CompletionHandler<void()>&& = nullptr);

void mouseMoveTo(double x, double y, WKStringRef pointerType = nullptr, CompletionHandler<void()>&& = nullptr);

void mouseForceDown();

void mouseForceUp();

void mouseForceChanged(float);

void mouseForceClick();

void startAndCancelMouseForceClick();

// Legacy wheel events.

void mouseScrollBy(int x, int y);

void mouseScrollByWithWheelAndMomentumPhases(int x, int y, int phase, int momentum);

#if PLATFORM(GTK)

void setWheelHasPreciseDeltas(bool);

#endif

void continuousMouseScrollBy(int x, int y, bool paged);

#if PLATFORM(MAC)

enum class WheelEventPhase : uint8_t {

None,

Began,

Changed,

Ended,

Cancelled,

MayBegin,

};

using EventTimestamp = uint64_t; // mach_absolute_time units.

void sendWheelEvent(EventTimestamp, double globalX, double globalY, double deltaX, double deltaY, WheelEventPhase, WheelEventPhase momentumPhase);

#endif

void leapForward(int milliseconds);

void keyDown(WKStringRef key, WKEventModifiers, unsigned location, CompletionHandler<void()>&& = nullptr);

void rawKeyDown(WKStringRef key, WKEventModifiers, unsigned location);

void rawKeyUp(WKStringRef key, WKEventModifiers, unsigned location);

#if PLATFORM(COCOA)

unsigned mouseButtonsCurrentlyDown() const;

unsigned lastButtonDown() const { return m_lastButtonDown; }

#endif

#if ENABLE(TOUCH_EVENTS)

// Touch events.

void addTouchPoint(int x, int y);

void updateTouchPoint(int index, int x, int y);

void setTouchModifier(WKEventModifiers, bool enable);

void setTouchPointRadius(int radiusX, int radiusY);

void touchStart();

void touchMove();

void touchEnd();

void touchCancel();

void clearTouchPoints();

void releaseTouchPoint(int index);

void cancelTouchPoint(int index);

#endif

// Double two-finger tap on trackpad.

void smartMagnify();

#if ENABLE(MAC_GESTURE_EVENTS)

// Gesture events.

void scaleGestureStart(double scale);

void scaleGestureChange(double scale);

void scaleGestureEnd(double scale);

#endif

private:

TestController* m_testController;

double currentEventTime() { return m_time; }

void updateClickCountForButton(int button);

void sendMouseDownToStartPressureEvents();

#if PLATFORM(COCOA)

enum class PressureChangeDirection { Increasing, Decreasing };

RetainPtr<NSEvent> beginPressureEvent(int stage);

RetainPtr<NSEvent> pressureChangeEvent(int stage, PressureChangeDirection);

RetainPtr<NSEvent> pressureChangeEvent(int stage, float pressure, PressureChangeDirection);

#endif

#if PLATFORM(WIN)

LRESULT dispatchMessage(UINT message, WPARAM, LPARAM);

POINT positionInPoint() const { return { static_cast<LONG>(m_position.x), static_cast<LONG>(m_position.y) }; }

#endif

double m_time { 0 };

WKPoint m_position { };

bool m_leftMouseButtonDown { false };

int m_clickCount { 0 };

double m_clickTime { 0 };

WKPoint m_clickPosition { };

WKEventMouseButton m_clickButton { kWKEventMouseButtonNoButton };

#if PLATFORM(COCOA)

int m_eventNumber { 0 };

WTF::HashMap<WebCore::MouseButton, bool, WTF::IntHash<WebCore::MouseButton>, WTF::StrongEnumHashTraits<WebCore::MouseButton>> m_mouseButtonsCurrentlyDown;

unsigned m_lastButtonDown { 0 };

#else

unsigned m_mouseButtonsCurrentlyDown { 0 };

#endif

#if PLATFORM(GTK)

bool m_hasPreciseDeltas { false };

#endif

#if USE(LIBWPE) || ENABLE(WPE_PLATFORM)

std::unique_ptr<EventSenderProxyClient> m_client;

uint32_t m_buttonState { 0 };

#endif

};

} // namespace WTR