Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef CHROME_BROWSER_EXTENSIONS_API_TABS_TABS_EVENT_ROUTER_H_ | 5 #ifndef CHROME_BROWSER_EXTENSIONS_API_TABS_TABS_EVENT_ROUTER_H_ |
| 6 #define CHROME_BROWSER_EXTENSIONS_API_TABS_TABS_EVENT_ROUTER_H_ | 6 #define CHROME_BROWSER_EXTENSIONS_API_TABS_TABS_EVENT_ROUTER_H_ |
| 7 | 7 |
| 8 #include <map> | 8 #include <map> |
| 9 #include <string> | 9 #include <string> |
| 10 | 10 |
| (...skipping 13 matching lines...) Expand all Loading... | |
| 24 namespace extensions { | 24 namespace extensions { |
| 25 | 25 |
| 26 // The TabsEventRouter listens to tab events and routes them to listeners inside | 26 // The TabsEventRouter listens to tab events and routes them to listeners inside |
| 27 // extension process renderers. | 27 // extension process renderers. |
| 28 // TabsEventRouter will only route events from windows/tabs within a profile to | 28 // TabsEventRouter will only route events from windows/tabs within a profile to |
| 29 // extension processes in the same profile. | 29 // extension processes in the same profile. |
| 30 class TabsEventRouter : public TabStripModelObserver, | 30 class TabsEventRouter : public TabStripModelObserver, |
| 31 public chrome::BrowserListObserver, | 31 public chrome::BrowserListObserver, |
| 32 public content::NotificationObserver, | 32 public content::NotificationObserver, |
| 33 public ui_zoom::ZoomObserver { | 33 public ui_zoom::ZoomObserver { |
| 34 private: | |
| 35 class TabEntry; | |
|
not at google - send to devlin
2015/03/19 21:23:35
(as I mentioned: please move this to the private s
| |
| 36 | |
| 34 public: | 37 public: |
| 35 explicit TabsEventRouter(Profile* profile); | 38 explicit TabsEventRouter(Profile* profile); |
| 36 ~TabsEventRouter() override; | 39 ~TabsEventRouter() override; |
| 37 | 40 |
| 38 // chrome::BrowserListObserver | 41 // chrome::BrowserListObserver |
| 39 void OnBrowserAdded(Browser* browser) override; | 42 void OnBrowserAdded(Browser* browser) override; |
| 40 void OnBrowserRemoved(Browser* browser) override; | 43 void OnBrowserRemoved(Browser* browser) override; |
| 41 void OnBrowserSetLastActive(Browser* browser) override; | 44 void OnBrowserSetLastActive(Browser* browser) override; |
| 42 | 45 |
| 43 // TabStripModelObserver | 46 // TabStripModelObserver |
| (...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 75 // ZoomObserver. | 78 // ZoomObserver. |
| 76 void OnZoomChanged( | 79 void OnZoomChanged( |
| 77 const ui_zoom::ZoomController::ZoomChangedEventData& data) override; | 80 const ui_zoom::ZoomController::ZoomChangedEventData& data) override; |
| 78 | 81 |
| 79 private: | 82 private: |
| 80 // "Synthetic" event. Called from TabInsertedAt if new tab is detected. | 83 // "Synthetic" event. Called from TabInsertedAt if new tab is detected. |
| 81 void TabCreatedAt(content::WebContents* contents, int index, bool active); | 84 void TabCreatedAt(content::WebContents* contents, int index, bool active); |
| 82 | 85 |
| 83 // Internal processing of tab updated events. Is called by both TabChangedAt | 86 // Internal processing of tab updated events. Is called by both TabChangedAt |
| 84 // and Observe/NAV_ENTRY_COMMITTED. | 87 // and Observe/NAV_ENTRY_COMMITTED. |
| 85 void TabUpdated(content::WebContents* contents, bool did_navigate); | 88 void TabUpdated(TabEntry* entry, |
| 89 scoped_ptr<base::DictionaryValue> changed_properties); | |
| 86 | 90 |
| 87 // Triggers a tab updated event if the favicon URL changes. | 91 // Triggers a tab updated event if the favicon URL changes. |
| 88 void FaviconUrlUpdated(content::WebContents* contents); | 92 void FaviconUrlUpdated(content::WebContents* contents); |
| 89 | 93 |
| 90 // The DispatchEvent methods forward events to the |profile|'s event router. | 94 // The DispatchEvent methods forward events to the |profile|'s event router. |
| 91 // The TabsEventRouter listens to events for all profiles, | 95 // The TabsEventRouter listens to events for all profiles, |
| 92 // so we avoid duplication by dropping events destined for other profiles. | 96 // so we avoid duplication by dropping events destined for other profiles. |
| 93 void DispatchEvent(Profile* profile, | 97 void DispatchEvent(Profile* profile, |
| 94 const std::string& event_name, | 98 const std::string& event_name, |
| 95 scoped_ptr<base::ListValue> args, | 99 scoped_ptr<base::ListValue> args, |
| (...skipping 26 matching lines...) Expand all Loading... | |
| 122 // Removes notifications added in RegisterForTabNotifications. | 126 // Removes notifications added in RegisterForTabNotifications. |
| 123 void UnregisterForTabNotifications(content::WebContents* contents); | 127 void UnregisterForTabNotifications(content::WebContents* contents); |
| 124 | 128 |
| 125 content::NotificationRegistrar registrar_; | 129 content::NotificationRegistrar registrar_; |
| 126 | 130 |
| 127 // Maintain some information about known tabs, so we can: | 131 // Maintain some information about known tabs, so we can: |
| 128 // | 132 // |
| 129 // - distinguish between tab creation and tab insertion | 133 // - distinguish between tab creation and tab insertion |
| 130 // - not send tab-detached after tab-removed | 134 // - not send tab-detached after tab-removed |
| 131 // - reduce the "noise" of TabChangedAt() when sending events to extensions | 135 // - reduce the "noise" of TabChangedAt() when sending events to extensions |
| 136 // - remember last muted and audible states to know if there was a change | |
| 132 class TabEntry { | 137 class TabEntry { |
| 133 public: | 138 public: |
| 134 // Create a new tab entry whose initial state is TAB_COMPLETE. This | 139 // Create a new tab entry whose initial state is TAB_COMPLETE. This |
| 135 // constructor is required because TabEntry objects placed inside an | 140 // constructor is required because TabEntry objects placed inside an |
| 136 // std::map<> by value. | 141 // std::map<> by value. |
| 137 TabEntry(); | 142 TabEntry(); |
| 138 | 143 |
| 139 // Update the load state of the tab based on its WebContents. Returns true | 144 // Allow creating a TabEntry via a webcontents. Used when moving |
| 140 // if the state changed, false otherwise. Whether the state has changed or | 145 // tabs between windows. |
| 141 // not is used to determine if events needs to be sent to extensions during | 146 explicit TabEntry(content::WebContents* contents); |
| 142 // processing of TabChangedAt(). This method will "hold" a state-change | |
| 143 // to "loading", until the DidNavigate() method which should always follow | |
| 144 // it. Returns NULL if no updates should be sent. | |
| 145 base::DictionaryValue* UpdateLoadState( | |
| 146 const content::WebContents* contents); | |
| 147 | 147 |
| 148 // Indicates that a tab load has resulted in a navigation and the | 148 // Indicate via a list of key/value pairs if a tab is loading based on its |
| 149 // destination url is available for inspection. Returns NULL if no updates | 149 // WebContents. Whether the state has changed or not is used to determine |
| 150 // should be sent. | 150 // if events needs to be sent to extensions during processing of |
| 151 base::DictionaryValue* DidNavigate(const content::WebContents* contents); | 151 // TabChangedAt(). If this method indicates that a tab should "hold" a |
| 152 // state-change to "loading", the DidNavigate() method should eventually | |
| 153 // send a similar message to undo it. If false, the returned key/value | |
| 154 // pairs list is empty. | |
| 155 scoped_ptr<base::DictionaryValue> UpdateLoadState(); | |
| 156 | |
| 157 // Indicate via a list of key/value pairs that a tab load has resulted in a | |
| 158 // navigation and the destination url is available for inspection. The list | |
| 159 // is empty if no updates should be sent. | |
| 160 scoped_ptr<base::DictionaryValue> DidNavigate(); | |
| 161 | |
| 162 // Update the audible and muted states and return whether they were changed | |
| 163 bool SetAudible(bool new_val); | |
| 164 bool SetMuted(bool new_val); | |
| 165 | |
| 166 content::WebContents* web_contents() { return contents_; } | |
| 152 | 167 |
| 153 private: | 168 private: |
| 169 content::WebContents* contents_; | |
| 170 | |
| 154 // Whether we are waiting to fire the 'complete' status change. This will | 171 // Whether we are waiting to fire the 'complete' status change. This will |
| 155 // occur the first time the WebContents stops loading after the | 172 // occur the first time the WebContents stops loading after the |
| 156 // NAV_ENTRY_COMMITTED was fired. The tab may go back into and out of the | 173 // NAV_ENTRY_COMMITTED was fired. The tab may go back into and out of the |
| 157 // loading state subsequently, but we will ignore those changes. | 174 // loading state subsequently, but we will ignore those changes. |
| 158 bool complete_waiting_on_load_; | 175 bool complete_waiting_on_load_; |
| 159 | 176 |
| 177 // Previous audible and muted states | |
| 178 bool was_audible_; | |
| 179 bool was_muted_; | |
| 180 | |
| 160 GURL url_; | 181 GURL url_; |
| 161 }; | 182 }; |
| 162 | 183 |
| 163 // Gets the TabEntry for the given |contents|. Returns TabEntry* if | 184 // Gets the TabEntry for the given |contents|. Returns TabEntry* if |
| 164 // found, NULL if not. | 185 // found, NULL if not. |
| 165 TabEntry* GetTabEntry(content::WebContents* contents); | 186 TabEntry* GetTabEntry(content::WebContents* contents); |
| 166 | 187 |
| 167 std::map<int, TabEntry> tab_entries_; | 188 std::map<int, TabEntry> tab_entries_; |
| 168 | 189 |
| 169 // The main profile that owns this event router. | 190 // The main profile that owns this event router. |
| 170 Profile* profile_; | 191 Profile* profile_; |
| 171 | 192 |
| 172 DISALLOW_COPY_AND_ASSIGN(TabsEventRouter); | 193 DISALLOW_COPY_AND_ASSIGN(TabsEventRouter); |
| 173 }; | 194 }; |
| 174 | 195 |
| 175 } // namespace extensions | 196 } // namespace extensions |
| 176 | 197 |
| 177 #endif // CHROME_BROWSER_EXTENSIONS_API_TABS_TABS_EVENT_ROUTER_H_ | 198 #endif // CHROME_BROWSER_EXTENSIONS_API_TABS_TABS_EVENT_ROUTER_H_ |
| OLD | NEW |