Move bookmarks/core/... to bookmarks/...

components/bookmarks/core/browser/bookmark_node_data.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_CORE_BROWSER_BOOKMARK_NODE_DATA_H_
-#define COMPONENTS_BOOKMARKS_CORE_BROWSER_BOOKMARK_NODE_DATA_H_
-
-#include <vector>
-
-#include "base/files/file_path.h"
-#include "base/strings/string16.h"
-#include "base/time/time.h"
-#include "components/bookmarks/core/browser/bookmark_node.h"
-#include "ui/base/clipboard/clipboard_types.h"
-
-#include "url/gurl.h"
-#if defined(TOOLKIT_VIEWS)
-#include "ui/base/dragdrop/os_exchange_data.h"
-#endif
-
-class BookmarkModel;
-class Pickle;
-class PickleIterator;
-
-// BookmarkNodeData is used to represent the following:
-//
-// . A single URL.
-// . A single node from the bookmark model.
-// . A set of nodes from the bookmark model.
-//
-// BookmarkNodeData is used by bookmark related views to represent a dragged
-// bookmark or bookmarks.
-//
-// Typical usage when writing data for a drag is:
-//   BookmarkNodeData data(node_user_is_dragging);
-//   data.Write(os_exchange_data_for_drag);
-//
-// Typical usage to read is:
-//   BookmarkNodeData data;
-//   if (data.Read(os_exchange_data))
-//     // data is valid, contents are in elements.
-
-struct BookmarkNodeData {
-  // Element represents a single node.
-  struct Element {
-    Element();
-    explicit Element(const BookmarkNode* node);
-    ~Element();
-
-    // If true, this element represents a URL.
-    bool is_url;
-
-    // The URL, only valid if is_url is true.
-    GURL url;
-
-    // Title of the entry, used for both urls and folders.
-    base::string16 title;
-
-    // Date of when this node was created.
-    base::Time date_added;
-
-    // Date of the last modification. Only used for folders.
-    base::Time date_folder_modified;
-
-    // Children, only used for non-URL nodes.
-    std::vector<Element> children;
-
-    // Meta info for the bookmark node.
-    BookmarkNode::MetaInfoMap meta_info_map;
-
-    int64 id() const { return id_; }
-
-   private:
-    friend struct BookmarkNodeData;
-
-    // For reading/writing this Element.
-    void WriteToPickle(Pickle* pickle) const;
-    bool ReadFromPickle(Pickle* pickle, PickleIterator* iterator);
-
-    // ID of the node.
-    int64 id_;
-  };
-
-  // The MIME type for the clipboard format for BookmarkNodeData.
-  static const char* kClipboardFormatString;
-
-  BookmarkNodeData();
-
-  // Created a BookmarkNodeData populated from the arguments.
-  explicit BookmarkNodeData(const BookmarkNode* node);
-  explicit BookmarkNodeData(const std::vector<const BookmarkNode*>& nodes);
-
-  ~BookmarkNodeData();
-
-#if defined(TOOLKIT_VIEWS)
-  static const ui::OSExchangeData::CustomFormat& GetBookmarkCustomFormat();
-#endif
-
-  static bool ClipboardContainsBookmarks();
-
-  // Reads bookmarks from the given vector.
-  bool ReadFromVector(const std::vector<const BookmarkNode*>& nodes);
-
-  // Creates a single-bookmark DragData from url/title pair.
-  bool ReadFromTuple(const GURL& url, const base::string16& title);
-
-  // Writes bookmarks to the specified clipboard.
-  void WriteToClipboard(ui::ClipboardType type);
-
-  // Reads bookmarks from the specified clipboard. Prefers data written via
-  // WriteToClipboard() but will also attempt to read a plain bookmark.
-  bool ReadFromClipboard(ui::ClipboardType type);
-
-#if defined(TOOLKIT_VIEWS)
-  // Writes elements to data. If there is only one element and it is a URL
-  // the URL and title are written to the clipboard in a format other apps can
-  // use.
-  // |profile_path| is used to identify which profile the data came from. Use an
-  // empty path to indicate that the data is not associated with any profile.
-  void Write(const base::FilePath& profile_path,
-             ui::OSExchangeData* data) const;
-
-  // Restores this data from the clipboard, returning true on success.
-  bool Read(const ui::OSExchangeData& data);
-#endif
-
-  // Writes the data for a drag to |pickle|.
-  void WriteToPickle(const base::FilePath& profile_path, Pickle* pickle) const;
-
-  // Reads the data for a drag from a |pickle|.
-  bool ReadFromPickle(Pickle* pickle);
-
-  // Returns the nodes represented by this DragData. If this DragData was
-  // created from the same profile then the nodes from the model are returned.
-  // If the nodes can't be found (may have been deleted), an empty vector is
-  // returned.
-  std::vector<const BookmarkNode*> GetNodes(
-      BookmarkModel* model,
-      const base::FilePath& profile_path) const;
-
-  // Convenience for getting the first node. Returns NULL if the data doesn't
-  // match any nodes or there is more than one node.
-  const BookmarkNode* GetFirstNode(BookmarkModel* model,
-                                   const base::FilePath& profile_path) const;
-
-  // Do we contain valid data?
-  bool is_valid() const { return !elements.empty(); }
-
-  // Returns true if there is a single url.
-  bool has_single_url() const { return is_valid() && elements[0].is_url; }
-
-  // Number of elements.
-  size_t size() const { return elements.size(); }
-
-  // Clears the data.
-  void Clear();
-
-  // Sets |profile_path_|. This is useful for the constructors/readers that
-  // don't set it. This should only be called if the profile path is not
-  // already set.
-  void SetOriginatingProfilePath(const base::FilePath& profile_path);
-
-  // Returns true if this data is from the specified profile path.
-  bool IsFromProfilePath(const base::FilePath& profile_path) const;
-
-  // The actual elements written to the clipboard.
-  std::vector<Element> elements;
-
- private:
-  // Path of the profile we originated from.
-  base::FilePath profile_path_;
-};
-
-#endif  // COMPONENTS_BOOKMARKS_CORE_BROWSER_BOOKMARK_NODE_DATA_H_