Move the ShortcutsBackend from history to autocomplete so that it can fully

chrome/browser/history/shortcuts_backend.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_HISTORY_SHORTCUTS_BACKEND_H_
-#define CHROME_BROWSER_HISTORY_SHORTCUTS_BACKEND_H_
-
-#include <map>
-#include <string>
-#include <vector>
-
-#include "base/files/file_path.h"
-#include "base/gtest_prod_util.h"
-#include "base/memory/ref_counted.h"
-#include "base/memory/scoped_ptr.h"
-#include "base/observer_list.h"
-#include "base/strings/string16.h"
-#include "base/synchronization/lock.h"
-#include "base/time/time.h"
-#include "chrome/browser/autocomplete/autocomplete_match.h"
-#include "components/keyed_service/content/refcounted_browser_context_keyed_service.h"
-#include "content/public/browser/notification_observer.h"
-#include "content/public/browser/notification_registrar.h"
-#include "url/gurl.h"
-
-class Profile;
-
-namespace history {
-
-class ShortcutsDatabase;
-
-// This class manages the shortcut provider backend - access to database on the
-// db thread, etc.
-class ShortcutsBackend : public RefcountedBrowserContextKeyedService,
-                         public content::NotificationObserver {
- public:
-  // The following struct encapsulates one previously selected omnibox shortcut.
-  struct Shortcut {
-    // The pieces of an AutocompleteMatch that we preserve in a shortcut.
-    struct MatchCore {
-      explicit MatchCore(const AutocompleteMatch& match);
-      MatchCore(const base::string16& fill_into_edit,
-                const GURL& destination_url,
-                const base::string16& contents,
-                const ACMatchClassifications& contents_class,
-                const base::string16& description,
-                const ACMatchClassifications& description_class,
-                content::PageTransition transition,
-                AutocompleteMatch::Type type,
-                const base::string16& keyword);
-      ~MatchCore();
-
-      AutocompleteMatch ToMatch() const;
-
-      base::string16 fill_into_edit;
-      GURL destination_url;
-      base::string16 contents;
-      // For both contents_class and description_class, we strip MATCH
-      // classifications; the ShortcutsProvider will re-mark MATCH regions based
-      // on the user's current typing.
-      ACMatchClassifications contents_class;
-      base::string16 description;
-      ACMatchClassifications description_class;
-      content::PageTransition transition;
-      AutocompleteMatch::Type type;
-      base::string16 keyword;
-    };
-
-    Shortcut(const std::string& id,
-             const base::string16& text,
-             const MatchCore& match_core,
-             const base::Time& last_access_time,
-             int number_of_hits);
-    // Required for STL, we don't use this directly.
-    Shortcut();
-    ~Shortcut();
-
-    std::string id;  // Unique guid for the shortcut.
-    base::string16 text;   // The user's original input string.
-    MatchCore match_core;
-    base::Time last_access_time;  // Last time shortcut was selected.
-    int number_of_hits;           // How many times shortcut was selected.
-  };
-
-  typedef std::multimap<base::string16, const Shortcut> ShortcutMap;
-
-  // |profile| is necessary for profile notifications only and can be NULL in
-  // unit-tests. For unit testing, set |suppress_db| to true to prevent creation
-  // of the database, in which case all operations are performed in memory only.
-  ShortcutsBackend(Profile* profile, bool suppress_db);
-
-  // The interface is guaranteed to be called on the thread AddObserver()
-  // was called.
-  class ShortcutsBackendObserver {
-   public:
-    // Called after the database is loaded and Init() completed.
-    virtual void OnShortcutsLoaded() = 0;
-    // Called when shortcuts changed (added/updated/removed) in the database.
-    virtual void OnShortcutsChanged() {}
-
-   protected:
-    virtual ~ShortcutsBackendObserver() {}
-  };
-
-  // Asynchronously initializes the ShortcutsBackend, it is safe to call
-  // multiple times - only the first call will be processed.
-  bool Init();
-
-  // All of the public functions *must* be called on UI thread only!
-
-  bool initialized() const { return current_state_ == INITIALIZED; }
-  const ShortcutMap& shortcuts_map() const { return shortcuts_map_; }
-
-  // Deletes the Shortcuts with the url.
-  bool DeleteShortcutsWithUrl(const GURL& shortcut_url);
-
-  void AddObserver(ShortcutsBackendObserver* obs);
-  void RemoveObserver(ShortcutsBackendObserver* obs);
-
-  // Looks for an existing shortcut to match.destination_url that starts with
-  // |text|.  Updates that shortcut if found, otherwise adds a new shortcut.
-  void AddOrUpdateShortcut(const base::string16& text,
-                           const AutocompleteMatch& match);
-
- private:
-  friend class base::RefCountedThreadSafe<ShortcutsBackend>;
-  friend class ShortcutsProviderTest;
-  FRIEND_TEST_ALL_PREFIXES(ShortcutsBackendTest, AddAndUpdateShortcut);
-  FRIEND_TEST_ALL_PREFIXES(ShortcutsBackendTest, DeleteShortcuts);
-
-  enum CurrentState {
-    NOT_INITIALIZED,  // Backend created but not initialized.
-    INITIALIZING,     // Init() called, but not completed yet.
-    INITIALIZED,      // Initialization completed, all accessors can be safely
-                      // called.
-  };
-
-  typedef std::map<std::string, ShortcutMap::iterator> GuidMap;
-
-  virtual ~ShortcutsBackend();
-
-  // RefcountedBrowserContextKeyedService:
-  virtual void ShutdownOnUIThread() OVERRIDE;
-
-  // content::NotificationObserver:
-  virtual void Observe(int type,
-                       const content::NotificationSource& source,
-                       const content::NotificationDetails& details) OVERRIDE;
-
-  // Internal initialization of the back-end. Posted by Init() to the DB thread.
-  // On completion posts InitCompleted() back to UI thread.
-  void InitInternal();
-
-  // Finishes initialization on UI thread, notifies all observers.
-  void InitCompleted();
-
-  // Adds the Shortcut to the database.
-  bool AddShortcut(const Shortcut& shortcut);
-
-  // Updates timing and selection count for the Shortcut.
-  bool UpdateShortcut(const Shortcut& shortcut);
-
-  // Deletes the Shortcuts with the id.
-  bool DeleteShortcutsWithIds(const std::vector<std::string>& shortcut_ids);
-
-  // Deletes all shortcuts whose URLs begin with |url|.  If |exact_match| is
-  // true, only shortcuts from exactly |url| are deleted.
-  bool DeleteShortcutsWithUrl(const GURL& url, bool exact_match);
-
-  // Deletes all of the shortcuts.
-  bool DeleteAllShortcuts();
-
-  CurrentState current_state_;
-  ObserverList<ShortcutsBackendObserver> observer_list_;
-  scoped_refptr<ShortcutsDatabase> db_;
-
-  // The |temp_shortcuts_map_| and |temp_guid_map_| used for temporary storage
-  // between InitInternal() and InitComplete() to avoid doing a potentially huge
-  // copy.
-  scoped_ptr<ShortcutMap> temp_shortcuts_map_;
-  scoped_ptr<GuidMap> temp_guid_map_;
-
-  ShortcutMap shortcuts_map_;
-  // This is a helper map for quick access to a shortcut by guid.
-  GuidMap guid_map_;
-
-  content::NotificationRegistrar notification_registrar_;
-
-  // For some unit-test only.
-  bool no_db_access_;
-
-  DISALLOW_COPY_AND_ASSIGN(ShortcutsBackend);
-};
-
-}  // namespace history
-
-#endif  // CHROME_BROWSER_HISTORY_SHORTCUTS_BACKEND_H_