Add audible, muted to Tab, c.t.query, c.t.update, and c.t.onUpdated where relevant

chrome/browser/extensions/api/tabs/tabs_event_router.h

 // Copyright 2013 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_TABS_TABS_EVENT_ROUTER_H_
 #define CHROME_BROWSER_EXTENSIONS_API_TABS_TABS_EVENT_ROUTER_H_
 
 #include <map>
 #include <string>
 
@@ skipping 64 matching lines @@
   // ZoomObserver.
   void OnZoomChanged(
       const ui_zoom::ZoomController::ZoomChangedEventData& data) override;
 
  private:
   // "Synthetic" event. Called from TabInsertedAt if new tab is detected.
   void TabCreatedAt(content::WebContents* contents, int index, bool active);
 
   // Internal processing of tab updated events. Is called by both TabChangedAt
   // and Observe/NAV_ENTRY_COMMITTED.
-  void TabUpdated(content::WebContents* contents, bool did_navigate);
+  class TabEntry;
+  void TabUpdated(TabEntry* entry,
+                  scoped_ptr<base::DictionaryValue> changed_properties);
 
   // Triggers a tab updated event if the favicon URL changes.
   void FaviconUrlUpdated(content::WebContents* contents);
 
   // The DispatchEvent methods forward events to the |profile|'s event router.
   // The TabsEventRouter listens to events for all profiles,
   // so we avoid duplication by dropping events destined for other profiles.
   void DispatchEvent(Profile* profile,
                      const std::string& event_name,
                      scoped_ptr<base::ListValue> args,
@@ skipping 26 matching lines @@
   // Removes notifications added in RegisterForTabNotifications.
   void UnregisterForTabNotifications(content::WebContents* contents);
 
   content::NotificationRegistrar registrar_;
 
   // Maintain some information about known tabs, so we can:
   //
   //  - distinguish between tab creation and tab insertion
   //  - not send tab-detached after tab-removed
   //  - reduce the "noise" of TabChangedAt() when sending events to extensions
+  //  - remember last muted and audible states to know if there was a change
   class TabEntry {
    public:
     // Create a new tab entry whose initial state is TAB_COMPLETE.  This
     // constructor is required because TabEntry objects placed inside an
     // std::map<> by value.
     TabEntry();

[miu, 2015/05/26 21:28:46]

nit: Can you move this zero-arg constructor to the "private:" section below,
then add:

  friend class std::map<int, TabEntry>;

This would allow the compiler to strictly enforce that the zero-arg constructor
is only being used for the std::map<>'s default allocator.  ;-)

[Jared Sohn, 2015/05/27 14:52:02]

Done.

 
-    // Update the load state of the tab based on its WebContents.  Returns true
-    // if the state changed, false otherwise.  Whether the state has changed or
-    // not is used to determine if events needs to be sent to extensions during
-    // processing of TabChangedAt(). This method will "hold" a state-change
-    // to "loading", until the DidNavigate() method which should always follow
-    // it. Returns NULL if no updates should be sent.
-    base::DictionaryValue* UpdateLoadState(
-        const content::WebContents* contents);
+    // Allow creating a TabEntry via a webcontents.  Used when moving

[miu, 2015/05/26 21:28:46]

This comment isn't quite accurate since the implementation isn't all about
tracking tabs moving between windows.  Instead, how about:

  // Create a TabEntry associated with, and tracking state changes to,
|contents|.

[Jared Sohn, 2015/05/27 14:52:02]

Done. This code is the inspiration for including a test for maintaining the
audible state when a tab is moved across windows (as I mention in another
comment.)

+    // tabs between windows.
+    explicit TabEntry(content::WebContents* contents);
 
-    // Indicates that a tab load has resulted in a navigation and the
-    // destination url is available for inspection. Returns NULL if no updates
-    // should be sent.
-    base::DictionaryValue* DidNavigate(const content::WebContents* contents);
+    // Indicate via a list of key/value pairs if a tab is loading based on its
+    // WebContents. Whether the state has changed or not is used to determine
+    // if events needs to be sent to extensions during processing of
+    // TabChangedAt(). If this method indicates that a tab should "hold" a
+    // state-change to "loading", the DidNavigate() method should eventually
+    // send a similar message to undo it. If false, the returned key/value
+    // pairs list is empty.
+    scoped_ptr<base::DictionaryValue> UpdateLoadState();
+
+    // Indicate via a list of key/value pairs that a tab load has resulted in a
+    // navigation and the destination url is available for inspection. The list
+    // is empty if no updates should be sent.
+    scoped_ptr<base::DictionaryValue> DidNavigate();
+
+    // Update the audible and muted states and return whether they were changed
+    bool SetAudible(bool new_val);
+    bool SetMuted(bool new_val);
+
+    content::WebContents* web_contents() { return contents_; }
 
    private:
+    content::WebContents* contents_;
+
     // Whether we are waiting to fire the 'complete' status change. This will
     // occur the first time the WebContents stops loading after the
     // NAV_ENTRY_COMMITTED was fired. The tab may go back into and out of the
     // loading state subsequently, but we will ignore those changes.
     bool complete_waiting_on_load_;
 
+    // Previous audible and muted states
+    bool was_audible_;
+    bool was_muted_;
+
     GURL url_;
   };
 
   // Gets the TabEntry for the given |contents|. Returns TabEntry* if
   // found, NULL if not.
   TabEntry* GetTabEntry(content::WebContents* contents);
 
   std::map<int, TabEntry> tab_entries_;
 
   // The main profile that owns this event router.
   Profile* profile_;
 
   DISALLOW_COPY_AND_ASSIGN(TabsEventRouter);
 };
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_TABS_TABS_EVENT_ROUTER_H_