Update MostVisitedSites observer interface.

chrome/browser/android/ntp/most_visited_sites.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_ANDROID_NTP_MOST_VISITED_SITES_H_
 #define CHROME_BROWSER_ANDROID_NTP_MOST_VISITED_SITES_H_
 
 #include <stddef.h>
 
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/files/file_path.h"
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "base/scoped_observer.h"
+#include "chrome/browser/android/ntp/popular_sites.h"
 #include "chrome/browser/supervised_user/supervised_user_service.h"
 #include "chrome/browser/supervised_user/supervised_user_service_observer.h"
 #include "components/history/core/browser/history_types.h"
 #include "components/history/core/browser/top_sites_observer.h"
 #include "components/suggestions/proto/suggestions.pb.h"
 #include "components/suggestions/suggestions_service.h"
 #include "url/gurl.h"
 
 namespace suggestions {
 class SuggestionsService;
 }
 
 namespace user_prefs {
 class PrefRegistrySyncable;
 }
 
 class PopularSites;
 class Profile;
 
-// The observer to be notified when the list of most visited sites changes.
-class MostVisitedSitesObserver {
- public:
-  virtual ~MostVisitedSitesObserver() {}
-
-  virtual void OnMostVisitedURLsAvailable(
-      const std::vector<base::string16>& titles,
-      const std::vector<std::string>& urls,
-      const std::vector<std::string>& whitelist_icon_paths) = 0;
-  virtual void OnPopularURLsAvailable(
-      const std::vector<std::string>& urls,
-      const std::vector<std::string>& favicon_urls,
-      const std::vector<std::string>& large_icon_urls) = 0;
-};
-
 // Tracks the list of most visited sites and their thumbnails.
 //
 // Do not use, except from MostVisitedSitesBridge. The interface is in flux
 // while we are extracting the functionality of the Java class to make available
 // in C++.
 //
 // TODO(sfiera): finalize interface.
 class MostVisitedSites : public history::TopSitesObserver,
                          public SupervisedUserServiceObserver {
  public:
+  struct Suggestion;
+  using SuggestionsVector = std::vector<Suggestion>;
+  using PopularSitesVector = std::vector<PopularSites::Site>;
+
+  // The source of the Most Visited sites.
+  enum MostVisitedSource { TOP_SITES, SUGGESTIONS_SERVICE, POPULAR, WHITELIST };
+
+  // The observer to be notified when the list of most visited sites changes.
+  class Observer {
+   public:
+    virtual ~Observer() {}

[Bernhard Bauer, 2016/04/26 14:29:58]

Is there a specific reason to include the destructor in the public interface? If
you don't plan on someone owning an instance through this interface, you could
make it protected.

[sfiera, 2016/04/26 14:42:26]

Wouldn't that require subclasses to re-declare the the destructor as public,
even if they didn't need one? (the sole existing subclass so far doesn't)

[Bernhard Bauer, 2016/04/26 14:50:49]

I think that would happen automatically, as the subclass does get a destructor
generated by the compiler (and I don't think it necessarily gets generated with
exactly the same visibility). And this helps to clarify the interface
(basically, no one is supposed to own a pure Observer, only a concrete
subclass).

+
+    virtual void OnMostVisitedURLsAvailable(
+        const SuggestionsVector& suggestions) = 0;
+    virtual void OnPopularURLsAvailable(const PopularSitesVector& sites) = 0;
+  };
+
+  struct Suggestion {
+    base::string16 title;
+    GURL url;
+    MostVisitedSource source;
+
+    // Only valid for source == WHITELIST (empty otherwise).
+    base::FilePath whitelist_icon_path;
+
+    // Only valid for source == SUGGESTIONS_SERVICE (-1 otherwise).
+    int provider_index;
+
+    Suggestion();
+    ~Suggestion();
+
+    Suggestion(Suggestion&&);
+    Suggestion& operator=(Suggestion&&);
+
+   private:
+    DISALLOW_COPY_AND_ASSIGN(Suggestion);
+  };
+
   explicit MostVisitedSites(Profile* profile);
 
   ~MostVisitedSites() override;
 
   // Does not take ownership of |observer|, which must outlive this object.
   void SetMostVisitedURLsObserver(
-      MostVisitedSitesObserver* observer, int num_sites);
+      Observer* observer, int num_sites);
 
   using ThumbnailCallback = base::Callback<
       void(bool /* is_local_thumbnail */, const SkBitmap* /* bitmap */)>;
   void GetURLThumbnail(const GURL& url, const ThumbnailCallback& callback);
   void AddOrRemoveBlacklistedUrl(const GURL& url, bool add_url);
   void RecordTileTypeMetrics(const std::vector<int>& tile_types);
   void RecordOpenedMostVisitedItem(int index, int tile_type);
 
   // SupervisedUserServiceObserver implementation.
   void OnURLFilterChanged() override;
 
   static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
 
  private:
   friend class MostVisitedSitesTest;
 
-  // The source of the Most Visited sites.
-  enum MostVisitedSource { TOP_SITES, SUGGESTIONS_SERVICE, POPULAR, WHITELIST };
-
-  struct Suggestion {
-    base::string16 title;
-    GURL url;
-    MostVisitedSource source;
-
-    // Only valid for source == WHITELIST (empty otherwise).
-    base::FilePath whitelist_icon_path;
-
-    // Only valid for source == SUGGESTIONS_SERVICE (-1 otherwise).
-    int provider_index;
-
-    Suggestion();
-    ~Suggestion();
-
-    // Get the Histogram name associated with the source.
-    std::string GetSourceHistogramName() const;
-
-   private:
-    DISALLOW_COPY_AND_ASSIGN(Suggestion);
-  };
-
-  using SuggestionsVector = std::vector<std::unique_ptr<Suggestion>>;
+  // TODO(treib): use SuggestionsVector in internal functions. crbug.com/601734
+  using SuggestionsPtrVector = std::vector<std::unique_ptr<Suggestion>>;
 
   void QueryMostVisitedURLs();
 
   // Initialize the query to Top Sites. Called if the SuggestionsService is not
   // enabled, or if it returns no data.
   void InitiateTopSitesQuery();
 
   // If there's a whitelist entry point for the URL, return the large icon path.
   base::FilePath GetWhitelistLargeIconPath(const GURL& url);
 
   // Callback for when data is available from TopSites.
   void OnMostVisitedURLsAvailable(
       const history::MostVisitedURLList& visited_list);
 
   // Callback for when data is available from the SuggestionsService.
   void OnSuggestionsProfileAvailable(
       const suggestions::SuggestionsProfile& suggestions_profile);
 
   // Takes the personal suggestions and creates whitelist entry point
   // suggestions if necessary.
-  SuggestionsVector CreateWhitelistEntryPointSuggestions(
-      const SuggestionsVector& personal_suggestions);
+  SuggestionsPtrVector CreateWhitelistEntryPointSuggestions(
+      const SuggestionsPtrVector& personal_suggestions);
 
   // Takes the personal and whitelist suggestions and creates popular
   // suggestions if necessary.
-  SuggestionsVector CreatePopularSitesSuggestions(
-      const SuggestionsVector& personal_suggestions,
-      const SuggestionsVector& whitelist_suggestions);
+  SuggestionsPtrVector CreatePopularSitesSuggestions(
+      const SuggestionsPtrVector& personal_suggestions,
+      const SuggestionsPtrVector& whitelist_suggestions);
 
   // Takes the personal suggestions, creates and merges in whitelist and popular
   // suggestions if appropriate, and saves the new suggestions.
-  void SaveNewNTPSuggestions(SuggestionsVector* personal_suggestions);
+  void SaveNewNTPSuggestions(SuggestionsPtrVector* personal_suggestions);
 
   // Workhorse for SaveNewNTPSuggestions above. Implemented as a separate static
   // method for ease of testing.
-  static SuggestionsVector MergeSuggestions(
-      SuggestionsVector* personal_suggestions,
-      SuggestionsVector* whitelist_suggestions,
-      SuggestionsVector* popular_suggestions,
+  static SuggestionsPtrVector MergeSuggestions(
+      SuggestionsPtrVector* personal_suggestions,
+      SuggestionsPtrVector* whitelist_suggestions,
+      SuggestionsPtrVector* popular_suggestions,
       const std::vector<std::string>& old_sites_url,
       const std::vector<bool>& old_sites_is_personal);
 
   void GetPreviousNTPSites(size_t num_tiles,
                            std::vector<std::string>* old_sites_url,
                            std::vector<bool>* old_sites_source) const;
 
   void SaveCurrentNTPSites();
 
   // Takes suggestions from |src_suggestions| and moves them to
   // |dst_suggestions| if the suggestion's url/host matches
   // |match_urls|/|match_hosts| respectively. Unmatched suggestion indices from
   // |src_suggestions| are returned for ease of insertion later.
   static std::vector<size_t> InsertMatchingSuggestions(
-      SuggestionsVector* src_suggestions,
-      SuggestionsVector* dst_suggestions,
+      SuggestionsPtrVector* src_suggestions,
+      SuggestionsPtrVector* dst_suggestions,
       const std::vector<std::string>& match_urls,
       const std::vector<std::string>& match_hosts);
 
   // Inserts suggestions from |src_suggestions| at positions |insert_positions|
   // into |dst_suggestions| where ever empty starting from |start_position|.
   // Returns the last filled position so that future insertions can start from
   // there.
   static size_t InsertAllSuggestions(
       size_t start_position,
       const std::vector<size_t>& insert_positions,
-      SuggestionsVector* src_suggestions,
-      SuggestionsVector* dst_suggestions);
+      SuggestionsPtrVector* src_suggestions,
+      SuggestionsPtrVector* dst_suggestions);
 
   // Notifies the observer about the availability of suggestions.
   // Also records impressions UMA if not done already.
   void NotifyMostVisitedURLsObserver();
 
   void OnPopularSitesAvailable(bool success);
 
   // Runs on the UI Thread.
   void OnLocalThumbnailFetched(
       const GURL& url,
@@ skipping 15 matching lines @@
   void RecordImpressionUMAMetrics();
 
   // history::TopSitesObserver implementation.
   void TopSitesLoaded(history::TopSites* top_sites) override;
   void TopSitesChanged(history::TopSites* top_sites,
                        ChangeReason change_reason) override;
 
   // The profile whose most visited sites will be queried.
   Profile* profile_;
 
-  MostVisitedSitesObserver* observer_;
+  Observer* observer_;
 
   // The maximum number of most visited sites to return.
   int num_sites_;
 
   // Whether we have received an initial set of most visited sites (from either
   // TopSites or the SuggestionsService).
   bool received_most_visited_sites_;
 
   // Whether we have received the set of popular sites. Immediately set to true
   // if popular sites are disabled.
@@ skipping 15 matching lines @@
 
   SuggestionsVector current_suggestions_;
 
   // For callbacks may be run after destruction.
   base::WeakPtrFactory<MostVisitedSites> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MostVisitedSites);
 };
 
 #endif  // CHROME_BROWSER_ANDROID_NTP_MOST_VISITED_SITES_H_