Source/WebCore/platform/EventTrackingRegions.h

/*
 * Copyright (C) 2016 Apple Inc.  All rights reserved.
 *
 * 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. ``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
 * 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 "Region.h"
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/text/StringHash.h>
#include <wtf/text/WTFString.h>

namespace WebCore {

struct EventNames;

enum class TrackingType : uint8_t {
    NotTracking = 0,
    Asynchronous = 1,
    Synchronous = 2
};

struct EventTrackingRegions {
    enum class EventType : uint8_t {
        Mousedown,
        Mousemove,
        Mouseup,
        Mousewheel,
        Pointerdown,
        Pointerenter,
        Pointerleave,
        Pointermove,
        Pointerout,
        Pointerover,
        Pointerup,
        Touchend,
        Touchforcechange,
        Touchmove,
        Touchstart,
        Wheel,
    };

    WEBCORE_EXPORT static ASCIILiteral eventName(EventType);
    WEBCORE_EXPORT static const AtomString& eventNameAtomString(const EventNames&, EventType);

    // Region for which events can be dispatched without blocking scrolling.
    Region asynchronousDispatchRegion;

    // Regions for which events must be sent before performing the default behavior.
    // The key is the EventType with an active handler.
    using EventSpecificSynchronousDispatchRegions = HashMap<EventType, Region, WTF::IntHash<EventType>, WTF::StrongEnumHashTraits<EventType>>;
    EventSpecificSynchronousDispatchRegions eventSpecificSynchronousDispatchRegions;

    bool isEmpty() const;

    void translate(IntSize);
    void uniteSynchronousRegion(EventType, const Region&);
    void unite(const EventTrackingRegions&);

    TrackingType trackingTypeForPoint(EventType, const IntPoint&);
};

bool operator==(const EventTrackingRegions&, const EventTrackingRegions&);
inline bool operator!=(const EventTrackingRegions& a, const EventTrackingRegions& b) { return !(a == b); }

} // namespace WebCore

namespace WTF {

template<> struct EnumTraits<WebCore::EventTrackingRegions::EventType> {
    using values = EnumValues<
        WebCore::EventTrackingRegions::EventType,
        WebCore::EventTrackingRegions::EventType::Mousedown,
        WebCore::EventTrackingRegions::EventType::Mousemove,
        WebCore::EventTrackingRegions::EventType::Mouseup,
        WebCore::EventTrackingRegions::EventType::Mousewheel,
        WebCore::EventTrackingRegions::EventType::Pointerdown,
        WebCore::EventTrackingRegions::EventType::Pointerenter,
        WebCore::EventTrackingRegions::EventType::Pointerleave,
        WebCore::EventTrackingRegions::EventType::Pointermove,
        WebCore::EventTrackingRegions::EventType::Pointerout,
        WebCore::EventTrackingRegions::EventType::Pointerover,
        WebCore::EventTrackingRegions::EventType::Pointerup,
        WebCore::EventTrackingRegions::EventType::Touchend,
        WebCore::EventTrackingRegions::EventType::Touchforcechange,
        WebCore::EventTrackingRegions::EventType::Touchmove,
        WebCore::EventTrackingRegions::EventType::Touchstart,
        WebCore::EventTrackingRegions::EventType::Wheel
    >;
};

} // namespace WTF