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 64 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
75 // ZoomObserver. | 75 // ZoomObserver. |
76 void OnZoomChanged( | 76 void OnZoomChanged( |
77 const ui_zoom::ZoomController::ZoomChangedEventData& data) override; | 77 const ui_zoom::ZoomController::ZoomChangedEventData& data) override; |
78 | 78 |
79 private: | 79 private: |
80 // "Synthetic" event. Called from TabInsertedAt if new tab is detected. | 80 // "Synthetic" event. Called from TabInsertedAt if new tab is detected. |
81 void TabCreatedAt(content::WebContents* contents, int index, bool active); | 81 void TabCreatedAt(content::WebContents* contents, int index, bool active); |
82 | 82 |
83 // Internal processing of tab updated events. Is called by both TabChangedAt | 83 // Internal processing of tab updated events. Is called by both TabChangedAt |
84 // and Observe/NAV_ENTRY_COMMITTED. | 84 // and Observe/NAV_ENTRY_COMMITTED. |
85 void TabUpdated(content::WebContents* contents, bool did_navigate); | 85 class TabEntry; |
| 86 void TabUpdated(TabEntry* entry, |
| 87 scoped_ptr<base::DictionaryValue> changed_properties); |
86 | 88 |
87 // Triggers a tab updated event if the favicon URL changes. | 89 // Triggers a tab updated event if the favicon URL changes. |
88 void FaviconUrlUpdated(content::WebContents* contents); | 90 void FaviconUrlUpdated(content::WebContents* contents); |
89 | 91 |
90 // The DispatchEvent methods forward events to the |profile|'s event router. | 92 // The DispatchEvent methods forward events to the |profile|'s event router. |
91 // The TabsEventRouter listens to events for all profiles, | 93 // The TabsEventRouter listens to events for all profiles, |
92 // so we avoid duplication by dropping events destined for other profiles. | 94 // so we avoid duplication by dropping events destined for other profiles. |
93 void DispatchEvent(Profile* profile, | 95 void DispatchEvent(Profile* profile, |
94 const std::string& event_name, | 96 const std::string& event_name, |
95 scoped_ptr<base::ListValue> args, | 97 scoped_ptr<base::ListValue> args, |
(...skipping 26 matching lines...) Expand all Loading... |
122 // Removes notifications added in RegisterForTabNotifications. | 124 // Removes notifications added in RegisterForTabNotifications. |
123 void UnregisterForTabNotifications(content::WebContents* contents); | 125 void UnregisterForTabNotifications(content::WebContents* contents); |
124 | 126 |
125 content::NotificationRegistrar registrar_; | 127 content::NotificationRegistrar registrar_; |
126 | 128 |
127 // Maintain some information about known tabs, so we can: | 129 // Maintain some information about known tabs, so we can: |
128 // | 130 // |
129 // - distinguish between tab creation and tab insertion | 131 // - distinguish between tab creation and tab insertion |
130 // - not send tab-detached after tab-removed | 132 // - not send tab-detached after tab-removed |
131 // - reduce the "noise" of TabChangedAt() when sending events to extensions | 133 // - reduce the "noise" of TabChangedAt() when sending events to extensions |
| 134 // - remember last muted and audible states to know if there was a change |
132 class TabEntry { | 135 class TabEntry { |
133 public: | 136 public: |
| 137 // Create a TabEntry associated with, and tracking state changes to, |
| 138 // |contents|. |
| 139 explicit TabEntry(content::WebContents* contents); |
| 140 |
| 141 // Indicate via a list of key/value pairs if a tab is loading based on its |
| 142 // WebContents. Whether the state has changed or not is used to determine |
| 143 // if events needs to be sent to extensions during processing of |
| 144 // TabChangedAt(). If this method indicates that a tab should "hold" a |
| 145 // state-change to "loading", the DidNavigate() method should eventually |
| 146 // send a similar message to undo it. If false, the returned key/value |
| 147 // pairs list is empty. |
| 148 scoped_ptr<base::DictionaryValue> UpdateLoadState(); |
| 149 |
| 150 // Indicate via a list of key/value pairs that a tab load has resulted in a |
| 151 // navigation and the destination url is available for inspection. The list |
| 152 // is empty if no updates should be sent. |
| 153 scoped_ptr<base::DictionaryValue> DidNavigate(); |
| 154 |
| 155 // Update the audible and muted states and return whether they were changed |
| 156 bool SetAudible(bool new_val); |
| 157 bool SetMuted(bool new_val); |
| 158 |
| 159 content::WebContents* web_contents() { return contents_; } |
| 160 |
| 161 private: |
| 162 friend class std::map<int, TabEntry>; |
| 163 |
134 // Create a new tab entry whose initial state is TAB_COMPLETE. This | 164 // Create a new tab entry whose initial state is TAB_COMPLETE. This |
135 // constructor is required because TabEntry objects placed inside an | 165 // constructor is required because TabEntry objects placed inside an |
136 // std::map<> by value. | 166 // std::map<> by value. |
137 TabEntry(); | 167 TabEntry(); |
138 | 168 |
139 // Update the load state of the tab based on its WebContents. Returns true | 169 content::WebContents* contents_; |
140 // if the state changed, false otherwise. Whether the state has changed or | |
141 // not is used to determine if events needs to be sent to extensions during | |
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 | 170 |
148 // Indicates that a tab load has resulted in a navigation and the | |
149 // destination url is available for inspection. Returns NULL if no updates | |
150 // should be sent. | |
151 base::DictionaryValue* DidNavigate(const content::WebContents* contents); | |
152 | |
153 private: | |
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 |