Supporting undoing bookmark deletion without creating new ID.

components/bookmarks/browser/bookmark_model.h

 // Copyright 2014 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 COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_MODEL_H_
 #define COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_MODEL_H_
 
 #include <stdint.h>
 #include <map>
 #include <set>
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/macros.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/synchronization/waitable_event.h"
 #include "components/bookmarks/browser/bookmark_client.h"
 #include "components/bookmarks/browser/bookmark_node.h"
+#include "components/bookmarks/browser/bookmark_undo_provider.h"
 #include "components/keyed_service/core/keyed_service.h"
 #include "ui/gfx/image/image.h"
 #include "url/gurl.h"
 
 class PrefService;
 
 namespace base {
 class FilePath;
 class SequencedTaskRunner;
 }
 
 namespace favicon_base {
 struct FaviconImageResult;
 }
 
 namespace query_parser {
 enum class MatchingAlgorithm;
 }
 
 namespace bookmarks {
 
 class BookmarkCodecTest;
 class BookmarkExpandedStateTracker;
 class BookmarkIndex;
 class BookmarkLoadDetails;
 class BookmarkModelObserver;
 class BookmarkStorage;
+class BookmarkUndoDelegate;
 class ScopedGroupBookmarkActions;
 class TestBookmarkClient;
 struct BookmarkMatch;
 
 // BookmarkModel --------------------------------------------------------------
 
 // BookmarkModel provides a directed acyclic graph of URLs and folders.
 // Three graphs are provided for the three entry points: those on the 'bookmarks
 // bar', those in the 'other bookmarks' folder and those in the 'mobile' folder.
 //
 // An observer may be attached to observe relevant events.
 //
 // You should NOT directly create a BookmarkModel, instead go through the
 // BookmarkModelFactory.
-class BookmarkModel : public KeyedService {
+class BookmarkModel : public BookmarkUndoProvider,
+                      public KeyedService {
  public:
   struct URLAndTitle {
     GURL url;
     base::string16 title;
   };
 
   explicit BookmarkModel(BookmarkClient* client);
   ~BookmarkModel() override;
 
   // KeyedService:
@@ skipping 226 matching lines @@
   // http://www.google.com) and the given icon URL (e.g.
   // http://www.google.com/favicon.ico) have changed. It is valid to call
   // OnFaviconsChanged() with non-empty |page_urls| and an empty |icon_url| and
   // vice versa.
   void OnFaviconsChanged(const std::set<GURL>& page_urls,
                          const GURL& icon_url);
 
   // Returns the client used by this BookmarkModel.
   BookmarkClient* client() const { return client_; }
 
+  void SetUndoDelegate(BookmarkUndoDelegate* undo_delegate);
+
  private:
   friend class BookmarkCodecTest;
   friend class BookmarkModelFaviconTest;
   friend class BookmarkStorage;
   friend class ScopedGroupBookmarkActions;
   friend class TestBookmarkClient;
 
   // Used to order BookmarkNodes by URL.
   class NodeURLComparator {
    public:
     bool operator()(const BookmarkNode* n1, const BookmarkNode* n2) const {
       return n1->url() < n2->url();
     }
   };
 
+  // BookmarkUndoProvider:
+  void RestoreRemovedNode(const BookmarkNode* parent,
+                          int index,
+                          scoped_ptr<BookmarkNode> node) override;
+
+  // Notifies the observers for adding every descedent of |node|.
+  void NotifyNodeAddedForAllDescendents(const BookmarkNode* node);
+
   // Implementation of IsBookmarked. Before calling this the caller must obtain
   // a lock on |url_lock_|.
   bool IsBookmarkedNoLock(const GURL& url);
 
   // Removes the node from internal maps and recurses through all children. If
   // the node is a url, its url is added to removed_urls.
   //
   // This does NOT delete the node.
   void RemoveNode(BookmarkNode* node, std::set<GURL>* removed_urls);
 
@@ skipping 62 matching lines @@
   // Sets the maximum node ID to the given value.
   // This is used by BookmarkCodec to report the maximum ID after it's done
   // decoding since during decoding codec assigns node IDs.
   void set_next_node_id(int64_t id) { next_node_id_ = id; }
 
   // Creates and returns a new BookmarkLoadDetails. It's up to the caller to
   // delete the returned object.
   scoped_ptr<BookmarkLoadDetails> CreateLoadDetails(
       const std::string& accept_languages);
 
+  BookmarkUndoDelegate* undo_delegate() const;
+
   BookmarkClient* const client_;
 
   // Whether the initial set of data has been loaded.
   bool loaded_;
 
   // The root node. This contains the bookmark bar node, the 'other' node and
   // the mobile node as children.
   BookmarkNode root_;
 
   BookmarkPermanentNode* bookmark_bar_node_;
@@ skipping 24 matching lines @@
 
   base::WaitableEvent loaded_signal_;
 
   // See description of IsDoingExtensiveChanges above.
   int extensive_changes_;
 
   scoped_ptr<BookmarkExpandedStateTracker> expanded_state_tracker_;
 
   std::set<std::string> non_cloned_keys_;
 
+  BookmarkUndoDelegate* undo_delegate_;
+  scoped_ptr<BookmarkUndoDelegate> empty_undo_delegate_;
+
   DISALLOW_COPY_AND_ASSIGN(BookmarkModel);
 };
 
 }  // namespace bookmarks
 
 #endif  // COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_MODEL_H_