[Mac] Implement basic hit testing in the scrolling tree
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingCoordinatorTypes.h
1 /*
2  * Copyright (C) 2019 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "ScrollTypes.h"
29
30 namespace WebCore {
31
32 typedef unsigned SynchronousScrollingReasons;
33 typedef uint64_t ScrollingNodeID;
34
35 enum class ScrollingNodeType : uint8_t {
36     MainFrame,
37     Subframe,
38     FrameHosting,
39     Overflow,
40     Fixed,
41     Sticky
42 };
43
44 enum ScrollingStateTreeAsTextBehaviorFlags {
45     ScrollingStateTreeAsTextBehaviorNormal                  = 0,
46     ScrollingStateTreeAsTextBehaviorIncludeLayerIDs         = 1 << 0,
47     ScrollingStateTreeAsTextBehaviorIncludeNodeIDs          = 1 << 1,
48     ScrollingStateTreeAsTextBehaviorIncludeLayerPositions   = 1 << 2,
49     ScrollingStateTreeAsTextBehaviorDebug                   = ScrollingStateTreeAsTextBehaviorIncludeLayerIDs | ScrollingStateTreeAsTextBehaviorIncludeNodeIDs | ScrollingStateTreeAsTextBehaviorIncludeLayerPositions
50 };
51 typedef unsigned ScrollingStateTreeAsTextBehavior;
52
53 enum class ScrollingLayerPositionAction {
54     Set,
55     SetApproximate,
56     Sync
57 };
58
59 struct ScrollableAreaParameters {
60     ScrollElasticity horizontalScrollElasticity { ScrollElasticityNone };
61     ScrollElasticity verticalScrollElasticity { ScrollElasticityNone };
62
63     ScrollbarMode horizontalScrollbarMode { ScrollbarAuto };
64     ScrollbarMode verticalScrollbarMode { ScrollbarAuto };
65
66     bool hasEnabledHorizontalScrollbar { false };
67     bool hasEnabledVerticalScrollbar { false };
68
69     bool useDarkAppearanceForScrollbars { false };
70
71     bool operator==(const ScrollableAreaParameters& other) const
72     {
73         return horizontalScrollElasticity == other.horizontalScrollElasticity
74             && verticalScrollElasticity == other.verticalScrollElasticity
75             && horizontalScrollbarMode == other.horizontalScrollbarMode
76             && verticalScrollbarMode == other.verticalScrollbarMode
77             && hasEnabledHorizontalScrollbar == other.hasEnabledHorizontalScrollbar
78             && hasEnabledVerticalScrollbar == other.hasEnabledVerticalScrollbar
79             && useDarkAppearanceForScrollbars == other.useDarkAppearanceForScrollbars;
80     }
81 };
82
83 enum class ScrollingEventResult {
84     DidNotHandleEvent,
85     DidHandleEvent,
86     SendToMainThread
87 };
88
89 enum class ViewportRectStability {
90     Stable,
91     Unstable,
92     ChangingObscuredInsetsInteractively // This implies Unstable.
93 };
94
95 }