| // Copyright (c) 2012 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_EXTENSIONS_API_OMNIBOX_OMNIBOX_API_H_ |
| #define CHROME_BROWSER_EXTENSIONS_API_OMNIBOX_OMNIBOX_API_H_ |
| |
| #include <set> |
| #include <string> |
| #include <vector> |
| |
| #include "base/memory/scoped_ptr.h" |
| #include "base/strings/string16.h" |
| #include "chrome/browser/autocomplete/autocomplete_match.h" |
| #include "chrome/browser/extensions/api/profile_keyed_api_factory.h" |
| #include "chrome/browser/extensions/chrome_extension_function.h" |
| #include "chrome/browser/extensions/extension_icon_manager.h" |
| #include "chrome/browser/search_engines/template_url_service.h" |
| #include "chrome/common/extensions/api/omnibox.h" |
| #include "content/public/browser/notification_observer.h" |
| #include "content/public/browser/notification_registrar.h" |
| #include "ui/base/window_open_disposition.h" |
| |
| class Profile; |
| class TemplateURL; |
| class TemplateURLService; |
| |
| namespace base { |
| class ListValue; |
| } |
| |
| namespace content { |
| class WebContents; |
| } |
| |
| namespace gfx { |
| class Image; |
| } |
| |
| namespace extensions { |
| |
| // Event router class for events related to the omnibox API. |
| class ExtensionOmniboxEventRouter { |
| public: |
| // The user has just typed the omnibox keyword. This is sent exactly once in |
| // a given input session, before any OnInputChanged events. |
| static void OnInputStarted( |
| Profile* profile, const std::string& extension_id); |
| |
| // The user has changed what is typed into the omnibox while in an extension |
| // keyword session. Returns true if someone is listening to this event, and |
| // thus we have some degree of confidence we'll get a response. |
| static bool OnInputChanged( |
| Profile* profile, |
| const std::string& extension_id, |
| const std::string& input, int suggest_id); |
| |
| // The user has accepted the omnibox input. |
| static void OnInputEntered( |
| content::WebContents* web_contents, |
| const std::string& extension_id, |
| const std::string& input, |
| WindowOpenDisposition disposition); |
| |
| // The user has cleared the keyword, or closed the omnibox popup. This is |
| // sent at most once in a give input session, after any OnInputChanged events. |
| static void OnInputCancelled( |
| Profile* profile, const std::string& extension_id); |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(ExtensionOmniboxEventRouter); |
| }; |
| |
| class OmniboxSendSuggestionsFunction : public ChromeSyncExtensionFunction { |
| public: |
| DECLARE_EXTENSION_FUNCTION("omnibox.sendSuggestions", OMNIBOX_SENDSUGGESTIONS) |
| |
| protected: |
| virtual ~OmniboxSendSuggestionsFunction() {} |
| |
| // ExtensionFunction: |
| virtual bool RunImpl() OVERRIDE; |
| }; |
| |
| class OmniboxAPI : public ProfileKeyedAPI, |
| public content::NotificationObserver { |
| public: |
| explicit OmniboxAPI(Profile* profile); |
| virtual ~OmniboxAPI(); |
| |
| // ProfileKeyedAPI implementation. |
| static ProfileKeyedAPIFactory<OmniboxAPI>* GetFactoryInstance(); |
| |
| // Convenience method to get the OmniboxAPI for a profile. |
| static OmniboxAPI* Get(Profile* profile); |
| |
| // content::NotificationObserver implementation. |
| virtual void Observe(int type, |
| const content::NotificationSource& source, |
| const content::NotificationDetails& details) OVERRIDE; |
| |
| // BrowserContextKeyedService implementation. |
| virtual void Shutdown() OVERRIDE; |
| |
| // Returns the icon to display in the omnibox for the given extension. |
| gfx::Image GetOmniboxIcon(const std::string& extension_id); |
| |
| // Returns the icon to display in the omnibox popup window for the given |
| // extension. |
| gfx::Image GetOmniboxPopupIcon(const std::string& extension_id); |
| |
| private: |
| friend class ProfileKeyedAPIFactory<OmniboxAPI>; |
| |
| typedef std::set<const Extension*> PendingExtensions; |
| |
| void OnTemplateURLsLoaded(); |
| |
| // ProfileKeyedAPI implementation. |
| static const char* service_name() { |
| return "OmniboxAPI"; |
| } |
| static const bool kServiceRedirectedInIncognito = true; |
| |
| Profile* profile_; |
| |
| TemplateURLService* url_service_; |
| |
| // List of extensions waiting for the TemplateURLService to Load to |
| // have keywords registered. |
| PendingExtensions pending_extensions_; |
| |
| content::NotificationRegistrar registrar_; |
| |
| // Keeps track of favicon-sized omnibox icons for extensions. |
| ExtensionIconManager omnibox_icon_manager_; |
| ExtensionIconManager omnibox_popup_icon_manager_; |
| |
| scoped_ptr<TemplateURLService::Subscription> template_url_sub_; |
| |
| DISALLOW_COPY_AND_ASSIGN(OmniboxAPI); |
| }; |
| |
| template <> |
| void ProfileKeyedAPIFactory<OmniboxAPI>::DeclareFactoryDependencies(); |
| |
| class OmniboxSetDefaultSuggestionFunction : public ChromeSyncExtensionFunction { |
| public: |
| DECLARE_EXTENSION_FUNCTION("omnibox.setDefaultSuggestion", |
| OMNIBOX_SETDEFAULTSUGGESTION) |
| |
| protected: |
| virtual ~OmniboxSetDefaultSuggestionFunction() {} |
| |
| // ExtensionFunction: |
| virtual bool RunImpl() OVERRIDE; |
| }; |
| |
| // If the extension has set a custom default suggestion via |
| // omnibox.setDefaultSuggestion, apply that to |match|. Otherwise, do nothing. |
| void ApplyDefaultSuggestionForExtensionKeyword( |
| Profile* profile, |
| const TemplateURL* keyword, |
| const string16& remaining_input, |
| AutocompleteMatch* match); |
| |
| // This function converts style information populated by the JSON schema |
| // // compiler into an ACMatchClassifications object. |
| ACMatchClassifications StyleTypesToACMatchClassifications( |
| const api::omnibox::SuggestResult &suggestion); |
| |
| } // namespace extensions |
| |
| #endif // CHROME_BROWSER_EXTENSIONS_API_OMNIBOX_OMNIBOX_API_H_ |