bookmarks_helper.h revision 2a99a7e74a7f215066514fe81d2bfa6639d9eddd 
1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CHROME_BROWSER_SYNC_TEST_INTEGRATION_BOOKMARKS_HELPER_H_
6#define CHROME_BROWSER_SYNC_TEST_INTEGRATION_BOOKMARKS_HELPER_H_
7
8#include <set>
9#include <string>
10#include <vector>
11
12#include "base/compiler_specific.h"
13#include "chrome/browser/bookmarks/bookmark_model.h"
14#include "googleurl/src/gurl.h"
15#include "testing/gtest/include/gtest/gtest.h"
16#include "third_party/skia/include/core/SkBitmap.h"
17
18class GURL;
19
20namespace bookmarks_helper {
21
22// Used to access the bookmark model within a particular sync profile.
23BookmarkModel* GetBookmarkModel(int index) WARN_UNUSED_RESULT;
24
25// Used to access the bookmark bar within a particular sync profile.
26const BookmarkNode* GetBookmarkBarNode(int index) WARN_UNUSED_RESULT;
27
28// Used to access the "other bookmarks" node within a particular sync profile.
29const BookmarkNode* GetOtherNode(int index) WARN_UNUSED_RESULT;
30
31// Used to access the "Synced Bookmarks" node within a particular sync profile.
32const BookmarkNode* GetSyncedBookmarksNode(int index) WARN_UNUSED_RESULT;
33
34// Used to access the bookmarks within the verifier sync profile.
35BookmarkModel* GetVerifierBookmarkModel() WARN_UNUSED_RESULT;
36
37// Adds a URL with address |url| and title |title| to the bookmark bar of
38// profile |profile|. Returns a pointer to the node that was added.
39const BookmarkNode* AddURL(
40    int profile,
41    const std::wstring& title,
42    const GURL& url) WARN_UNUSED_RESULT;
43
44// Adds a URL with address |url| and title |title| to the bookmark bar of
45// profile |profile| at position |index|. Returns a pointer to the node that
46// was added.
47const BookmarkNode* AddURL(
48    int profile,
49    int index,
50    const std::wstring& title,
51    const GURL& url) WARN_UNUSED_RESULT;
52
53// Adds a URL with address |url| and title |title| under the node |parent| of
54// profile |profile| at position |index|. Returns a pointer to the node that
55// was added.
56const BookmarkNode* AddURL(
57    int profile,
58    const BookmarkNode* parent,
59    int index,
60    const std::wstring& title,
61    const GURL& url) WARN_UNUSED_RESULT;
62
63// Adds a folder named |title| to the bookmark bar of profile |profile|.
64// Returns a pointer to the folder that was added.
65const BookmarkNode* AddFolder(
66    int profile,
67    const std::wstring& title) WARN_UNUSED_RESULT;
68
69// Adds a folder named |title| to the bookmark bar of profile |profile| at
70// position |index|. Returns a pointer to the folder that was added.
71const BookmarkNode* AddFolder(
72    int profile,
73    int index,
74    const std::wstring& title) WARN_UNUSED_RESULT;
75
76// Adds a folder named |title| to the node |parent| in the bookmark model of
77// profile |profile| at position |index|. Returns a pointer to the node that
78// was added.
79const BookmarkNode* AddFolder(
80    int profile,
81    const BookmarkNode* parent,
82    int index,
83    const std::wstring& title) WARN_UNUSED_RESULT;
84
85// Changes the title of the node |node| in the bookmark model of profile
86// |profile| to |new_title|.
87void SetTitle(int profile,
88                     const BookmarkNode* node,
89                     const std::wstring& new_title);
90
91// The source of the favicon.
92enum FaviconSource {
93  FROM_UI,
94  FROM_SYNC
95};
96
97// Sets the |icon_url| and |image| data for the favicon for |node| in the
98// bookmark model for |profile|.
99void SetFavicon(int profile,
100                const BookmarkNode* node,
101                const GURL& icon_url,
102                const gfx::Image& image,
103                FaviconSource source);
104
105// Changes the url of the node |node| in the bookmark model of profile
106// |profile| to |new_url|. Returns a pointer to the node with the changed url.
107const BookmarkNode* SetURL(
108    int profile,
109    const BookmarkNode* node,
110    const GURL& new_url) WARN_UNUSED_RESULT;
111
112// Moves the node |node| in the bookmark model of profile |profile| so it ends
113// up under the node |new_parent| at position |index|.
114void Move(
115    int profile,
116    const BookmarkNode* node,
117    const BookmarkNode* new_parent,
118    int index);
119
120// Removes the node in the bookmark model of profile |profile| under the node
121// |parent| at position |index|.
122void Remove(int profile, const BookmarkNode* parent, int index);
123
124// Sorts the children of the node |parent| in the bookmark model of profile
125// |profile|.
126void SortChildren(int profile, const BookmarkNode* parent);
127
128// Reverses the order of the children of the node |parent| in the bookmark
129// model of profile |profile|.
130void ReverseChildOrder(int profile, const BookmarkNode* parent);
131
132// Checks if the bookmark model of profile |profile| matches the verifier
133// bookmark model. Returns true if they match.
134bool ModelMatchesVerifier(int profile) WARN_UNUSED_RESULT;
135
136// Checks if the bookmark models of all sync profiles match the verifier
137// bookmark model. Returns true if they match.
138bool AllModelsMatchVerifier() WARN_UNUSED_RESULT;
139
140// Checks if the bookmark models of |profile_a| and |profile_b| match each
141// other. Returns true if they match.
142bool ModelsMatch(int profile_a, int profile_b) WARN_UNUSED_RESULT;
143
144// Checks if the bookmark models of all sync profiles match each other. Does
145// not compare them with the verifier bookmark model. Returns true if they
146// match.
147bool AllModelsMatch() WARN_UNUSED_RESULT;
148
149// Checks if the bookmark model of profile |profile| contains any instances of
150// two bookmarks with the same URL under the same parent folder. Returns true
151// if even one instance is found.
152bool ContainsDuplicateBookmarks(int profile);
153
154// Returns whether a node exists with the specified url.
155bool HasNodeWithURL(int profile, const GURL& url);
156
157// Gets the node in the bookmark model of profile |profile| that has the url
158// |url|. Note: Only one instance of |url| is assumed to be present.
159const BookmarkNode* GetUniqueNodeByURL(
160    int profile,
161    const GURL& url) WARN_UNUSED_RESULT;
162
163// Returns the number of bookmarks in bookmark model of profile |profile|
164// whose titles match the string |title|.
165int CountBookmarksWithTitlesMatching(
166    int profile,
167    const std::wstring& title) WARN_UNUSED_RESULT;
168
169// Returns the number of bookmark folders in the bookmark model of profile
170// |profile| whose titles contain the query string |title|.
171int CountFoldersWithTitlesMatching(
172    int profile,
173    const std::wstring& title) WARN_UNUSED_RESULT;
174
175// Creates a favicon of |color| with image reps of the platform's supported
176// scale factors (eg MacOS) in addition to 1x.
177gfx::Image CreateFavicon(SkColor color);
178
179// Creates a 1x only favicon from the PNG file at |path|.
180gfx::Image Create1xFaviconFromPNGFile(const std::string& path);
181
182// Returns a URL identifiable by |i|.
183std::string IndexedURL(int i);
184
185// Returns a URL title identifiable by |i|.
186std::wstring IndexedURLTitle(int i);
187
188// Returns a folder name identifiable by |i|.
189std::wstring IndexedFolderName(int i);
190
191// Returns a subfolder name identifiable by |i|.
192std::wstring IndexedSubfolderName(int i);
193
194// Returns a subsubfolder name identifiable by |i|.
195std::wstring IndexedSubsubfolderName(int i);
196
197}  // namespace bookmarks_helper
198
199#endif  // CHROME_BROWSER_SYNC_TEST_INTEGRATION_BOOKMARKS_HELPER_H_
200