blob: 4b475468dd809d3b3317ee8e3aa6018f6cb44bf7 [file] [log] [blame]
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_FIND_BAR_FIND_TAB_HELPER_H_
#define CHROME_BROWSER_UI_FIND_BAR_FIND_TAB_HELPER_H_
#include "base/macros.h"
#include "build/build_config.h"
#include "chrome/browser/ui/find_bar/find_bar_controller.h"
#include "chrome/browser/ui/find_bar/find_notification_details.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "ui/gfx/range/range.h"
// Per-tab find manager. Handles dealing with the life cycle of find sessions.
class FindTabHelper : public content::WebContentsObserver,
public content::WebContentsUserData<FindTabHelper> {
public:
~FindTabHelper() override;
// Starts the Find operation by calling StartFinding on the Tab. This function
// can be called from the outside as a result of hot-keys, so it uses the
// last remembered search string as specified with set_find_string(). This
// function does not block while a search is in progress. The controller will
// receive the results through the notification mechanism. See Observe(...)
// for details.
void StartFinding(base::string16 search_string,
bool forward_direction,
bool case_sensitive,
bool run_synchronously_for_testing = false);
// Stops the current Find operation.
void StopFinding(FindBarController::SelectionAction selection_action);
// When the user commits to a search query or jumps from one result
// to the next, move accessibility focus to the next find result.
void ActivateFindInPageResultForAccessibility();
// Accessors/Setters for find_ui_active_.
bool find_ui_active() const { return find_ui_active_; }
void set_find_ui_active(bool find_ui_active) {
find_ui_active_ = find_ui_active;
}
// Setter for find_op_aborted_.
void set_find_op_aborted(bool find_op_aborted) {
find_op_aborted_ = find_op_aborted;
}
// Used _only_ by testing to get or set the current request ID.
int current_find_request_id() { return current_find_request_id_; }
void set_current_find_request_id(int current_find_request_id) {
current_find_request_id_ = current_find_request_id;
}
// Accessor for find_text_. Used to determine if this WebContents has any
// active searches.
base::string16 find_text() const { return find_text_; }
// Accessor for the previous search we issued.
base::string16 previous_find_text() const { return previous_find_text_; }
// Accessor for the latest search for which a final result was reported.
base::string16 last_completed_find_text() const {
return last_completed_find_text_;
}
void set_last_completed_find_text(
const base::string16& last_completed_find_text) {
last_completed_find_text_ = last_completed_find_text;
}
gfx::Range selected_range() const { return selected_range_; }
void set_selected_range(const gfx::Range& selected_range) {
selected_range_ = selected_range;
}
// Accessor for find_result_.
const FindNotificationDetails& find_result() const {
return last_search_result_;
}
#if defined(OS_ANDROID)
// Selects and zooms to the find result nearest to the point (x,y)
// defined in find-in-page coordinates.
void ActivateNearestFindResult(float x, float y);
// Asks the renderer to send the rects of the current find matches.
void RequestFindMatchRects(int current_version);
#endif
void HandleFindReply(int request_id,
int number_of_matches,
const gfx::Rect& selection_rect,
int active_match_ordinal,
bool final_update);
private:
explicit FindTabHelper(content::WebContents* web_contents);
friend class content::WebContentsUserData<FindTabHelper>;
// Each time a search request comes in we assign it an id before passing it
// over the IPC so that when the results come in we can evaluate whether we
// still care about the results of the search (in some cases we don't because
// the user has issued a new search).
static int find_request_id_counter_;
// True if the Find UI is active for this Tab.
bool find_ui_active_;
// True if a Find operation was aborted. This can happen if the Find box is
// closed or if the search term inside the Find box is erased while a search
// is in progress. This can also be set if a page has been reloaded, and will
// on FindNext result in a full Find operation so that the highlighting for
// inactive matches can be repainted.
bool find_op_aborted_;
// This variable keeps track of what the most recent request ID is.
int current_find_request_id_;
// This variable keeps track of the ID of the first find request in the
// current session, which also uniquely identifies the session.
int current_find_session_id_;
// The current string we are/just finished searching for. This is used to
// figure out if this is a Find or a FindNext operation (FindNext should not
// increase the request id).
base::string16 find_text_;
// The string we searched for before |find_text_|.
base::string16 previous_find_text_;
// Used to keep track the last completed search. A single find session can
// result in multiple final updates, if the document contents change
// dynamically. It's a nuisance to notify the user more than once that a
// search came up empty, and we never want to notify the user that a
// previously successful search's results were removed because,
// for instance, the page is being torn down during navigation.
base::string16 last_completed_find_text_;
// The selection within the text.
gfx::Range selected_range_;
// Whether the last search was case sensitive or not.
bool last_search_case_sensitive_;
// The last find result. This object contains details about the number of
// matches, the find selection rectangle, etc. The UI can access this
// information to build its presentation.
FindNotificationDetails last_search_result_;
WEB_CONTENTS_USER_DATA_KEY_DECL();
DISALLOW_COPY_AND_ASSIGN(FindTabHelper);
};
#endif // CHROME_BROWSER_UI_FIND_BAR_FIND_TAB_HELPER_H_