2010-11-23 Yael Aharon <yael.aharon@nokia.com>
[WebKit-https.git] / WebCore / page / SpatialNavigation.h
1 /*
2  * Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies)
3  * Copyright (C) 2009 Antonio Gomes <tonikitoo@webkit.org>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef SpatialNavigation_h
22 #define SpatialNavigation_h
23
24 #include "FocusDirection.h"
25 #include "IntRect.h"
26 #include "Node.h"
27
28 #include <limits>
29
30 namespace WebCore {
31
32 class Element;
33 class Frame;
34 class IntRect;
35 class RenderObject;
36
37 using namespace std;
38
39 inline long long maxDistance()
40 {
41     return numeric_limits<long long>::max();
42 }
43
44 inline int fudgeFactor()
45 {
46     return 2;
47 }
48
49 bool isSpatialNavigationEnabled(const Frame*);
50
51 // Spatially speaking, two given elements in a web page can be:
52 // 1) Fully aligned: There is a full intersection between the rects, either
53 //    vertically or horizontally.
54 //
55 // * Horizontally       * Vertically
56 //    _
57 //   |_|                   _ _ _ _ _ _
58 //   |_|...... _          |_|_|_|_|_|_|
59 //   |_|      |_|         .       .
60 //   |_|......|_|   OR    .       .
61 //   |_|      |_|         .       .
62 //   |_|......|_|          _ _ _ _
63 //   |_|                  |_|_|_|_|
64 //
65 //
66 // 2) Partially aligned: There is a partial intersection between the rects, either
67 //    vertically or horizontally.
68 //
69 // * Horizontally       * Vertically
70 //    _                   _ _ _ _ _
71 //   |_|                 |_|_|_|_|_|
72 //   |_|.... _      OR           . .
73 //   |_|    |_|                  . .
74 //   |_|....|_|                  ._._ _
75 //          |_|                  |_|_|_|
76 //          |_|
77 //
78 // 3) Or, otherwise, not aligned at all.
79 //
80 // * Horizontally       * Vertically
81 //         _              _ _ _ _
82 //        |_|            |_|_|_|_|
83 //        |_|                    .
84 //        |_|                     .
85 //       .          OR             .
86 //    _ .                           ._ _ _ _ _
87 //   |_|                            |_|_|_|_|_|
88 //   |_|
89 //   |_|
90 //
91 // "Totally Aligned" elements are preferable candidates to move
92 // focus to over "Partially Aligned" ones, that on its turns are
93 // more preferable than "Not Aligned".
94 enum RectsAlignment {
95     None = 0,
96     Partial,
97     Full
98 };
99
100 struct FocusCandidate {
101     FocusCandidate()
102         : node(0)
103         , enclosingScrollableBox(0)
104         , distance(maxDistance())
105         , parentDistance(maxDistance())
106         , alignment(None)
107         , parentAlignment(None)
108     {
109     }
110
111     FocusCandidate(Node* n);
112     bool isNull() const { return !node; }
113     bool inScrollableContainer() const { return node && enclosingScrollableBox; }
114     Document* document() const { return node ? node->document() : 0; }
115
116     Node* node;
117     Node* enclosingScrollableBox;
118     long long distance;
119     long long parentDistance;
120     RectsAlignment alignment;
121     RectsAlignment parentAlignment;
122     IntRect rect;
123 };
124
125 bool scrollInDirection(Frame*, FocusDirection);
126 bool scrollInDirection(Node* container, FocusDirection);
127 bool hasOffscreenRect(Node*, FocusDirection direction = FocusDirectionNone);
128 bool isScrollableContainerNode(const Node*);
129 bool isNodeDeepDescendantOfDocument(Node*, Document*);
130 Node* scrollableEnclosingBoxOrParentFrameForNodeInDirection(FocusDirection, Node* node);
131 bool canScrollInDirection(FocusDirection, const Node* container);
132 bool canScrollInDirection(FocusDirection, const Frame*);
133 IntRect nodeRectInAbsoluteCoordinates(Node*, bool ignoreBorder = false);
134 IntRect frameRectInAbsoluteCoordinates(Frame*);
135 void distanceDataForNode(FocusDirection, FocusCandidate& current, FocusCandidate& candidate);
136 bool canBeScrolledIntoView(FocusDirection, const FocusCandidate&);
137 IntRect virtualRectForDirection(FocusDirection, const IntRect& startingRect);
138 } // namspace WebCore
139
140 #endif // SpatialNavigation_h