1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/* Copyright 2020 Jaakko Keränen <jaakko.keranen@iki.fi>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
#pragma once
#include <the_Foundation/hash.h>
#include <the_Foundation/ptrarray.h>
#include <the_Foundation/string.h>
#include <the_Foundation/time.h>
iDeclareType(GmRequest)
iDeclareType(Bookmark)
iDeclareTypeConstruction(Bookmark)
/* These values are not serialized as-is in bookmarks.ini. Instead, they are included in `tags`
with a dot prefix. This helps retain backwards and forwards compatibility. */
enum iBookmarkFlags {
homepage_BookmarkFlag = iBit(1),
remoteSource_BookmarkFlag = iBit(2),
linkSplit_BookmarkFlag = iBit(3),
userIcon_BookmarkFlag = iBit(4),
subscribed_BookmarkFlag = iBit(17),
headings_BookmarkFlag = iBit(18),
ignoreWeb_BookmarkFlag = iBit(19),
remote_BookmarkFlag = iBit(31),
};
struct Impl_Bookmark {
iHashNode node;
iString url;
iString title;
iString tags;
uint32_t flags;
iChar icon;
iTime when;
uint32_t parentId; /* remote source or folder */
int order; /* sort order */
};
iLocalDef uint32_t id_Bookmark (const iBookmark *d) { return d->node.key; }
iLocalDef iBool isFolder_Bookmark (const iBookmark *d) { return isEmpty_String(&d->url); }
iBool hasParent_Bookmark (const iBookmark *, uint32_t parentId);
int depth_Bookmark (const iBookmark *);
//iBool hasTag_Bookmark (const iBookmark *, const char *tag);
//void addTag_Bookmark (iBookmark *, const char *tag);
//void removeTag_Bookmark (iBookmark *, const char *tag);
//iLocalDef void addTagIfMissing_Bookmark(iBookmark *d, const char *tag) {
// if (!hasTag_Bookmark(d, tag)) {
// addTag_Bookmark(d, tag);
// }
//}
//iLocalDef void addOrRemoveTag_Bookmark(iBookmark *d, const char *tag, iBool add) {
// if (add) {
// addTagIfMissing_Bookmark(d, tag);
// }
// else {
// removeTag_Bookmark(d, tag);
// }
//}
int cmpTitleAscending_Bookmark (const iBookmark **, const iBookmark **);
int cmpTree_Bookmark (const iBookmark **, const iBookmark **);
iBool filterInsideFolder_Bookmark (void *parentFolder, const iBookmark *);
/*----------------------------------------------------------------------------------------------*/
iDeclareType(Bookmarks)
iDeclareTypeConstruction(Bookmarks)
typedef iBool (*iBookmarksFilterFunc) (void *context, const iBookmark *);
typedef int (*iBookmarksCompareFunc) (const iBookmark **, const iBookmark **);
void clear_Bookmarks (iBookmarks *);
void load_Bookmarks (iBookmarks *, const char *dirPath);
void save_Bookmarks (const iBookmarks *, const char *dirPath);
uint32_t add_Bookmarks (iBookmarks *, const iString *url, const iString *title,
const iString *tags, iChar icon);
iBool remove_Bookmarks (iBookmarks *, uint32_t id);
iBookmark * get_Bookmarks (iBookmarks *, uint32_t id);
void reorder_Bookmarks (iBookmarks *, uint32_t id, int newOrder);
iBool updateBookmarkIcon_Bookmarks(iBookmarks *, const iString *url, iChar icon);
void setRecentFolder_Bookmarks (iBookmarks *, uint32_t folderId);
void sort_Bookmarks (iBookmarks *, uint32_t parentId, iBookmarksCompareFunc cmp);
void fetchRemote_Bookmarks (iBookmarks *);
void requestFinished_Bookmarks (iBookmarks *, iGmRequest *req);
iChar siteIcon_Bookmarks (const iBookmarks *, const iString *url);
uint32_t findUrl_Bookmarks (const iBookmarks *, const iString *url); /* O(n) */
uint32_t recentFolder_Bookmarks (const iBookmarks *);
//iBool filterTagsRegExp_Bookmarks (void *regExp, const iBookmark *);
iBool filterHomepage_Bookmark (void *, const iBookmark *);
/**
* Lists all or a subset of the bookmarks in a sorted array of Bookmark pointers.
*
* @param filter Filter function to determine which bookmarks should be returned.
* If NULL, all bookmarks are listed.
* @param cmp Sort function that compares Bookmark pointers. If NULL, the
* returned list is sorted by descending creation time.
*
* @return Collected array of bookmarks. Caller does not get ownership of the
* listed bookmarks.
*/
const iPtrArray *list_Bookmarks(const iBookmarks *, iBookmarksCompareFunc cmp,
iBookmarksFilterFunc filter, void *context);
enum iBookmarkListType {
listByFolder_BookmarkListType,
listByTag_BookmarkListType,
listByCreationTime_BookmarkListType,
};
const iString * bookmarkListPage_Bookmarks (const iBookmarks *, enum iBookmarkListType listType);
|
