Reorder the methods in JumpList class according to the update workflow

chrome/browser/win/jumplist.h

 // 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_WIN_JUMPLIST_H_
 #define CHROME_BROWSER_WIN_JUMPLIST_H_
 
 #include <stddef.h>
 
 #include <list>
@@ skipping 44 matching lines @@
 // the JumpList whenever a change is detected.
 //
 // Updating a JumpList requires some file operations and it is not good to
 // update it in a UI thread. To solve this problem, this class posts to a
 // runnable method when it actually updates a JumpList.
 class JumpList : public sessions::TabRestoreServiceObserver,
                  public history::TopSitesObserver,
                  public KeyedService {
  public:
   // KeyedService:
   void Shutdown() override;

[grt (UTC plus 2), 2017/06/14 20:50:38]

nit: this method is less interesting to the reader than Enabled(), so it seems
logical that it would come later in the class definition.

[chengx, 2017/06/16 18:10:41]

Done.

 
   // Returns true if the custom JumpList is enabled.
   static bool Enabled();
 
  private:
   using UrlAndLinkItem = std::pair<std::string, scoped_refptr<ShellLinkItem>>;
   using URLIconCache = base::flat_map<std::string, base::FilePath>;
 
   // Holds results of the RunUpdateJumpList run.
   struct UpdateResults {
@@ skipping 18 matching lines @@
     // A flag indicating if there is a timeout in notifying the JumpList update
     // to shell. Note that this variable is independent of update_success.
     bool update_timeout = false;
   };
 
   friend JumpListFactory;
   explicit JumpList(Profile* profile);  // Use JumpListFactory instead
 
   ~JumpList() override;
 
+  // history::TopSitesObserver:
+  void TopSitesLoaded(history::TopSites* top_sites) override;
+  void TopSitesChanged(history::TopSites* top_sites,
+                       ChangeReason change_reason) override;
+
+  // sessions::TabRestoreServiceObserver:
+  void TabRestoreServiceChanged(sessions::TabRestoreService* service) override;
+  void TabRestoreServiceDestroyed(
+      sessions::TabRestoreService* service) override;
+
+  // Initializes the one-shot timer to update the JumpList in a while. If there
+  // is already a request queued then cancel it and post the new request. This
+  // ensures that JumpList update won't happen until there has been a brief
+  // quiet period, thus avoiding update storms.
+  void InitializeTimerForUpdate();
+
+  // Called on a timer after requests storms have subsided. Calls APIs
+  // ProcessTopSitesNotification and ProcessTabRestoreNotification on
+  // demand to do the actual work.
+  void OnDelayTimer();
+
+  // Processes notifications from TopSites service.
+  void ProcessTopSitesNotification();
+
+  // Processes notifications from TabRestore service.
+  void ProcessTabRestoreServiceNotification();
+
+  // Callback for TopSites that notifies when |data|, the "Most Visited" list,
+  // is available. This function updates the ShellLinkItemList objects and
+  // begins the process of fetching favicons for the URLs.
+  void OnMostVisitedURLsAvailable(const history::MostVisitedURLList& data);
+
   // Adds a new ShellLinkItem for |tab| to the JumpList data provided that doing
   // so will not exceed |max_items|.
   bool AddTab(const sessions::TabRestoreService::Tab& tab, size_t max_items);
 
   // Adds a new ShellLinkItem for each tab in |window| to the JumpList data
   // provided that doing so will not exceed |max_items|.
   void AddWindow(const sessions::TabRestoreService::Window& window,
                  size_t max_items);
 
   // Starts loading a favicon for each URL in |icon_urls_|.
   // This function sends a query to HistoryService.
   // When finishing loading all favicons, this function posts a task that
   // decompresses collected favicons and updates a JumpList.
   void StartLoadingFavicon();
 
   // Callback for HistoryService that notifies when a requested favicon is
   // available. To avoid file operations, this function just attaches the given
   // |image_result| to a ShellLinkItem object.
   void OnFaviconDataAvailable(
       const favicon_base::FaviconImageResult& image_result);
 
-  // Callback for TopSites that notifies when |data|, the "Most Visited" list,
-  // is available. This function updates the ShellLinkItemList objects and
-  // begins the process of fetching favicons for the URLs.
-  void OnMostVisitedURLsAvailable(
-      const history::MostVisitedURLList& data);
-
   // Callback for changes to the incognito mode availability pref.
   void OnIncognitoAvailabilityChanged();

[grt (UTC plus 2), 2017/06/14 20:50:38]

nit: this is more similar to the overrides above, in that it handles
notifications coming in from the rest of Chrome. i think it makes sense for it
to be up after the TabRestoreServiceObserver overrides.

[chengx, 2017/06/16 18:10:41]

Done.

 
-  // sessions::TabRestoreServiceObserver:
-  void TabRestoreServiceChanged(sessions::TabRestoreService* service) override;
-  void TabRestoreServiceDestroyed(
-      sessions::TabRestoreService* service) override;
-
-  // history::TopSitesObserver:
-  void TopSitesLoaded(history::TopSites* top_sites) override;
-  void TopSitesChanged(history::TopSites* top_sites,
-                       ChangeReason change_reason) override;
-
-  // Initializes the one-shot timer to update the JumpList in a while. If there
-  // is already a request queued then cancel it and post the new request. This
-  // ensures that JumpList update won't happen until there has been a brief
-  // quiet period, thus avoiding update storms.
-  void InitializeTimerForUpdate();
-
-  // Called on a timer after requests storms have subsided. Calls APIs
-  // ProcessTopSitesNotification and ProcessTabRestoreNotification on
-  // demand to do the actual work.
-  void OnDelayTimer();
-
-  // Processes notifications from TopSites service.
-  void ProcessTopSitesNotification();
-
-  // Processes notifications from TabRestore service.
-  void ProcessTabRestoreServiceNotification();
-
   // Posts tasks to update the JumpList and delete any obsolete JumpList related
   // folders.
   void PostRunUpdate();
 
-  // Deletes icon files in |icon_dir| which are not in |icon_cache| anymore.
-  static void DeleteIconFiles(const base::FilePath& icon_dir,
-                              URLIconCache* icon_cache);
+  // Callback for RunUpdateJumpList that notifies when it finishes running.
+  // Updates certain JumpList member variables and/or triggers a new JumpList
+  // update based on |update_results|.
+  void OnRunUpdateCompletion(std::unique_ptr<UpdateResults> update_results);
 
-  // In |icon_dir|, creates at most |max_items| icon files which are not in
-  // |icon_cache| for the asynchrounously loaded icons stored in |item_list|.
-  // |icon_cache| is also updated for newly created icons.
-  // Returns the number of new icon files created.
-  static int CreateIconFiles(const base::FilePath& icon_dir,
-                             const ShellLinkItemList& item_list,
-                             size_t max_items,
-                             URLIconCache* icon_cache);
+  // Cancels a pending JumpList update.
+  void CancelPendingUpdate();
 
-  // Updates icon files for |page_list| in |icon_dir|, which consists of
-  // 1) creating at most |slot_limit| new icons which are not in |icon_cache|;
-  // 2) deleting old icons which are not in |icon_cache|.
-  // Returns the number of new icon files created.
-  static int UpdateIconFiles(const base::FilePath& icon_dir,
-                             const ShellLinkItemList& page_list,
-                             size_t slot_limit,
-                             URLIconCache* icon_cache);
+  // Terminates the JumpList, which includes cancelling any pending updates and
+  // stopping observing the Profile and its services. This must be called before
+  // the |profile_| is destroyed.
+  void Terminate();
 
   // Updates the application JumpList, which consists of 1) create new icon
   // files; 2) delete obsolete icon files; 3) notify the OS.
   // Note that any timeout error along the way results in the old JumpList being
   // left as-is, while any non-timeout error results in the old JumpList being
   // left as-is, but without icon files.
   static void RunUpdateJumpList(
       const base::string16& app_id,
       const base::FilePath& profile_dir,
       const ShellLinkItemList& most_visited_pages,
       const ShellLinkItemList& recently_closed_pages,
       bool most_visited_pages_have_updates,
       bool recently_closed_pages_have_updates,
       IncognitoModePrefs::Availability incognito_availability,
       UpdateResults* update_results);
 
-  // Callback for RunUpdateJumpList that notifies when it finishes running.
-  // Updates certain JumpList member variables and/or triggers a new JumpList
-  // update based on |update_results|.
-  void OnRunUpdateCompletion(std::unique_ptr<UpdateResults> update_results);
+  // Updates icon files for |page_list| in |icon_dir|, which consists of
+  // 1) creating at most |slot_limit| new icons which are not in |icon_cache|;
+  // 2) deleting old icons which are not in |icon_cache|.
+  // Returns the number of new icon files created.
+  static int UpdateIconFiles(const base::FilePath& icon_dir,
+                             const ShellLinkItemList& page_list,
+                             size_t slot_limit,
+                             URLIconCache* icon_cache);
 
-  // Cancels a pending JumpList update.
-  void CancelPendingUpdate();
+  // In |icon_dir|, creates at most |max_items| icon files which are not in
+  // |icon_cache| for the asynchrounously loaded icons stored in |item_list|.
+  // |icon_cache| is also updated for newly created icons.
+  // Returns the number of new icon files created.
+  static int CreateIconFiles(const base::FilePath& icon_dir,
+                             const ShellLinkItemList& item_list,
+                             size_t max_items,
+                             URLIconCache* icon_cache);
 
-  // Terminates the JumpList, which includes cancelling any pending updates and
-  // stopping observing the Profile and its services. This must be called before
-  // the |profile_| is destroyed.
-  void Terminate();
+  // Deletes icon files in |icon_dir| which are not in |icon_cache| anymore.
+  static void DeleteIconFiles(const base::FilePath& icon_dir,
+                              URLIconCache* icon_cache);
 
   // Tracks FaviconService tasks.
   base::CancelableTaskTracker cancelable_task_tracker_;
 
   // The Profile object is used to listen for events.
   Profile* profile_;
 
   // Manages the registration of pref change observers.
   std::unique_ptr<PrefChangeRegistrar> pref_change_registrar_;
 
@@ skipping 55 matching lines @@
 
   SEQUENCE_CHECKER(sequence_checker_);
 
   // For callbacks may run after destruction.
   base::WeakPtrFactory<JumpList> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(JumpList);
 };
 
 #endif  // CHROME_BROWSER_WIN_JUMPLIST_H_