2 * Copyright (C) 2009 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
14 * * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include "core/editing/FindOptions.h"
35 #include "platform/geometry/FloatRect.h"
36 #include "platform/heap/Handle.h"
37 #include "public/platform/WebFloatPoint.h"
38 #include "public/platform/WebFloatRect.h"
39 #include "public/platform/WebRect.h"
40 #include "public/web/WebFindOptions.h"
41 #include "wtf/PassOwnPtr.h"
42 #include "wtf/PassRefPtr.h"
43 #include "wtf/Vector.h"
44 #include "wtf/text/WTFString.h"
49 class WebLocalFrameImpl
;
51 template <typename T
> class WebVector
;
53 class TextFinder final
: public NoBaseWillBeGarbageCollectedFinalized
<TextFinder
> {
55 static PassOwnPtrWillBeRawPtr
<TextFinder
> create(WebLocalFrameImpl
& ownerFrame
);
58 int identifier
, const WebString
& searchText
, const WebFindOptions
&,
59 bool wrapWithinFrame
, WebRect
* selectionRect
);
60 void stopFindingAndClearSelection();
61 void scopeStringMatches(
62 int identifier
, const WebString
& searchText
, const WebFindOptions
&,
64 void cancelPendingScopingEffort();
65 void increaseMatchCount(int identifier
, int count
);
66 void resetMatchCount();
67 int findMatchMarkersVersion() const { return m_findMatchMarkersVersion
; }
68 WebFloatRect
activeFindMatchRect();
69 void findMatchRects(WebVector
<WebFloatRect
>&);
70 int selectNearestFindMatch(const WebFloatPoint
&, WebRect
* selectionRect
);
72 // Returns which frame has an active match. This function should only be
73 // called on the main frame, as it is the only frame keeping track. Returned
74 // value can be 0 if no frame has an active match.
75 WebLocalFrameImpl
* activeMatchFrame() const { return m_currentActiveMatchFrame
; }
77 // Returns the active match in the current frame. Could be a null range if
78 // the local frame has no active match.
79 Range
* activeMatch() const { return m_activeMatch
.get(); }
81 void flushCurrentScoping();
83 void resetActiveMatch() { m_activeMatch
= nullptr; }
85 int totalMatchCount() const { return m_totalMatchCount
; }
86 bool scopingInProgress() const { return m_scopingInProgress
; }
87 void increaseMarkerVersion() { ++m_findMatchMarkersVersion
; }
92 ALLOW_ONLY_INLINE_ALLOCATION();
94 FindMatch(PassRefPtrWillBeRawPtr
<Range
>, int ordinal
);
98 RefPtrWillBeMember
<Range
> m_range
;
100 // 1-based index within this frame.
103 // In find-in-page coordinates.
104 // Lazily calculated by updateFindMatchRects.
111 class DeferredScopeStringMatches
;
112 friend class DeferredScopeStringMatches
;
114 explicit TextFinder(WebLocalFrameImpl
& ownerFrame
);
116 // Notifies the delegate about a new selection rect.
117 void reportFindInPageSelection(
118 const WebRect
& selectionRect
, int activeMatchOrdinal
, int identifier
);
120 void reportFindInPageResultToAccessibility(int identifier
);
122 // Clear the find-in-page matches cache forcing rects to be fully
123 // calculated again next time updateFindMatchRects is called.
124 void clearFindMatchesCache();
126 // Check if the activeMatchFrame still exists in the frame tree.
127 bool isActiveMatchFrameValid() const;
129 // Return the index in the find-in-page cache of the match closest to the
130 // provided point in find-in-page coordinates, or -1 in case of error.
131 // The squared distance to the closest match is returned in the distanceSquared parameter.
132 int nearestFindMatch(const FloatPoint
&, float& distanceSquared
);
134 // TODO(yosin) Templataization of |scopeStringMatchesAlgorithm| will be
135 // gone once |RuntimeEnabledFeatures::selectionForComposedTreeEnabled| is
137 template <typename Strategy
>
138 void scopeStringMatchesAlgorithm(
139 int identifier
, const WebString
& searchText
, const WebFindOptions
&,
142 // Select a find-in-page match marker in the current frame using a cache
143 // match index returned by nearestFindMatch. Returns the ordinal of the new
144 // selected match or -1 in case of error. Also provides the bounding box of
145 // the marker in window coordinates if selectionRect is not null.
146 int selectFindMatch(unsigned index
, WebRect
* selectionRect
);
148 // Compute and cache the rects for FindMatches if required.
149 // Rects are automatically invalidated in case of content size changes,
150 // propagating the invalidation to child frames.
151 void updateFindMatchRects();
153 // Append the find-in-page match rects of the current frame to the provided vector.
154 void appendFindMatchRects(Vector
<WebFloatRect
>& frameRects
);
156 // Add a WebKit TextMatch-highlight marker to nodes in a range.
157 void addMarker(Range
*, bool activeMatch
);
159 // Sets the markers within a range as active or inactive.
160 void setMarkerActive(Range
*, bool active
);
162 // Returns the ordinal of the first match in the frame specified. This
163 // function enumerates the frames, starting with the main frame and up to (but
164 // not including) the frame passed in as a parameter and counts how many
165 // matches have been found.
166 int ordinalOfFirstMatchForFrame(WebLocalFrameImpl
*) const;
168 // Determines whether the scoping effort is required for a particular frame.
169 // It is not necessary if the frame is invisible, for example, or if this
170 // is a repeat search that already returned nothing last time the same prefix
172 bool shouldScopeMatches(const WTF::String
& searchText
);
174 // Removes the current frame from the global scoping effort and triggers any
175 // updates if appropriate. This method does not mark the scoping operation
177 void flushCurrentScopingEffort(int identifier
);
179 // Finishes the current scoping effort and triggers any updates if appropriate.
180 void finishCurrentScopingEffort(int identifier
);
182 // Queue up a deferred call to scopeStringMatches.
183 void scopeStringMatchesSoon(
184 int identifier
, const WebString
& searchText
, const WebFindOptions
&,
187 // Called by a DeferredScopeStringMatches instance.
188 void callScopeStringMatches(
189 DeferredScopeStringMatches
*, int identifier
, const WebString
& searchText
,
190 const WebFindOptions
&, bool reset
);
192 // Determines whether to invalidate the content area and scrollbar.
193 void invalidateIfNecessary();
195 // Sets the markers within a current match range as active or inactive.
196 void setMatchMarkerActive(bool);
198 void decrementFramesScopingCount(int identifier
);
200 WebLocalFrameImpl
& ownerFrame() const
202 ASSERT(m_ownerFrame
);
203 return *m_ownerFrame
;
206 // Returns the ordinal of the first match in the owner frame.
207 int ordinalOfFirstMatch() const;
209 RawPtrWillBeMember
<WebLocalFrameImpl
> m_ownerFrame
;
211 // A way for the main frame to keep track of which frame has an active
212 // match. Should be 0 for all other frames.
213 RawPtrWillBeMember
<WebLocalFrameImpl
> m_currentActiveMatchFrame
;
215 // The range of the active match for the current frame.
216 RefPtrWillBeMember
<Range
> m_activeMatch
;
218 // The index of the active match for the current frame.
219 int m_activeMatchIndexInCurrentFrame
;
221 // The scoping effort can time out and we need to keep track of where we
222 // ended our last search so we can continue from where we left of.
224 // This range is collapsed to the end position of the last successful
225 // search; the new search should start from this position.
226 RefPtrWillBeMember
<Range
> m_resumeScopingFromRange
;
228 // Keeps track of the last string this frame searched for. This is used for
229 // short-circuiting searches in the following scenarios: When a frame has
230 // been searched and returned 0 results, we don't need to search that frame
231 // again if the user is just adding to the search (making it more specific).
232 WTF::String m_lastSearchString
;
234 // Keeps track of how many matches this frame has found so far, so that we
235 // don't lose count between scoping efforts, and is also used (in conjunction
236 // with m_lastSearchString) to figure out if we need to search the frame again.
237 int m_lastMatchCount
;
239 // This variable keeps a cumulative total of matches found so far for ALL the
240 // frames on the page, and is only incremented by calling IncreaseMatchCount
241 // (on the main frame only). It should be -1 for all other frames.
242 int m_totalMatchCount
;
244 // This variable keeps a cumulative total of how many frames are currently
245 // scoping, and is incremented/decremented on the main frame only.
246 // It should be -1 for all other frames.
247 int m_framesScopingCount
;
249 // Identifier of the latest find-in-page request. Required to be stored in
250 // the frame in order to reply if required in case the frame is detached.
251 int m_findRequestIdentifier
;
253 // Keeps track of when the scoping effort should next invalidate the scrollbar
254 // and the frame area.
255 int m_nextInvalidateAfter
;
257 // A list of all of the pending calls to scopeStringMatches.
258 WillBeHeapVector
<OwnPtrWillBeMember
<DeferredScopeStringMatches
>> m_deferredScopingWork
;
260 // Version number incremented on the main frame only whenever the document
261 // find-in-page match markers change. It should be 0 for all other frames.
262 int m_findMatchMarkersVersion
;
264 // Local cache of the find match markers currently displayed for this frame.
265 WillBeHeapVector
<FindMatch
> m_findMatchesCache
;
267 // Contents size when find-in-page match rects were last computed for this
269 IntSize m_contentsSizeForCurrentFindMatchRects
;
271 // This flag is used by the scoping effort to determine if we need to figure
272 // out which rectangle is the active match. Once we find the active
273 // rectangle we clear this flag.
274 bool m_locatingActiveRect
;
276 // Keeps track of whether there is an scoping effort ongoing in the frame.
277 bool m_scopingInProgress
;
279 // Keeps track of whether the last find request completed its scoping effort
280 // without finding any matches in this frame.
281 bool m_lastFindRequestCompletedWithNoMatches
;
283 // Determines if the rects in the find-in-page matches cache of this frame
284 // are invalid and should be recomputed.
285 bool m_findMatchRectsAreValid
;
290 WTF_ALLOW_INIT_WITH_MEM_FUNCTIONS(blink::TextFinder::FindMatch
);
292 #endif // TextFinder_h