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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-runtime-lib
* Created on: 14 окт. 2019 г.
*
* lsp-runtime-lib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-runtime-lib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-runtime-lib. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_FMT_BOOKMARKS_H_
#define LSP_PLUG_IN_FMT_BOOKMARKS_H_
#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/lltl/parray.h>
#include <lsp-plug.in/common/status.h>
#include <lsp-plug.in/runtime/LSPString.h>
#include <lsp-plug.in/io/Path.h>
#include <lsp-plug.in/io/IInSequence.h>
#include <lsp-plug.in/io/IOutSequence.h>
#define GTK3_BOOKMARK_PATH ".config/gtk-3.0/bookmarks"
#define GTK2_BOOKMARK_PATH ".gtk-bookmarks"
#define QT5_BOOKMARK_PATH ".local/share/user-places.xbel"
#define LNK_BOOKMARK_PATH "Links"
namespace lsp
{
namespace bookmarks
{
enum bm_origin_t
{
BM_LSP = 1 << 0,
BM_GTK2 = 1 << 1,
BM_GTK3 = 1 << 2,
BM_QT5 = 1 << 3,
BM_LNK = 1 << 4,
};
typedef struct bookmark_t
{
LSPString path; // Path to the directory
LSPString name; // Bookmark name
size_t origin; // Bookmark origin: LSP, GTK3, QT
} bookmark_t;
/**
* Read GTK3 bookmarks
* @param dst list to store bookmarks
* @param path location of the file in UTF-8 encoding
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_gtk3(lltl::parray<bookmark_t> *dst, const char *path, const char *charset=NULL);
/**
* Read GTK3 bookmarks
* @param dst list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_gtk3(lltl::parray<bookmark_t> *dst, const LSPString *path, const char *charset=NULL);
/**
* Read GTK3 bookmarks
* @param dst list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_gtk3(lltl::parray<bookmark_t> *dst, const io::Path *path, const char *charset=NULL);
/**
* Read GTK3 bookmarks
* @param dst list to store bookmarks
* @param in input character sequence
* @return status of operation
*/
status_t read_bookmarks_gtk3(lltl::parray<bookmark_t> *dst, io::IInSequence *in);
/**
* Read GTK3 bookmarks
* @param dst list to store bookmarks
* @param path location of the file in UTF-8 encoding
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_gtk2(lltl::parray<bookmark_t> *dst, const char *path, const char *charset=NULL);
/**
* Read GTK3 bookmarks
* @param dst list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_gtk2(lltl::parray<bookmark_t> *dst, const LSPString *path, const char *charset=NULL);
/**
* Read GTK3 bookmarks
* @param dst list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_gtk2(lltl::parray<bookmark_t> *dst, const io::Path *path, const char *charset=NULL);
/**
* Read GTK3 bookmarks
* @param dst list to store bookmarks
* @param in input character sequence
* @return status of operation
*/
status_t read_bookmarks_gtk2(lltl::parray<bookmark_t> *dst, io::IInSequence *in);
/**
* Read QT5 bookmarks
* @param dst list to store bookmarks
* @param path location of the file in UTF-8 encoding
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_qt5(lltl::parray<bookmark_t> *dst, const char *path, const char *charset=NULL);
/**
* Read QT5 bookmarks
* @param dst list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_qt5(lltl::parray<bookmark_t> *dst, const LSPString *path, const char *charset=NULL);
/**
* Read QT5 bookmarks
* @param dst list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks_qt5(lltl::parray<bookmark_t> *dst, const io::Path *path, const char *charset=NULL);
/**
* Read QT5 bookmarks
* @param dst list to store bookmarks
* @param in input character sequence
* @return status of operation
*/
status_t read_bookmarks_qt5(lltl::parray<bookmark_t> *dst, io::IInSequence *in);
/**
* Read Windows bookmarks from the specified folder
* @param dst destination array to store bookmarks
* @param path location of *.lnk files to read bookmarks
* @return status of operation
*/
status_t read_bookmarks_lnk(lltl::parray<bookmark_t> *dst, const char *path);
/**
* Read Windows bookmarks from the specified folder
* @param dst destination array to store bookmarks
* @param path location of *.lnk files to read bookmarks
* @return status of operation
*/
status_t read_bookmarks_lnk(lltl::parray<bookmark_t> *dst, const LSPString *path);
/**
* Read Windows bookmarks from the specified folder
* @param dst destination array to store bookmarks
* @param path location of *.lnk files to read bookmarks
* @return status of operation
*/
status_t read_bookmarks_lnk(lltl::parray<bookmark_t> *dst, const io::Path *path);
/**
* Read LSP bookmarks in JSON5 format
* @param dst list to store bookmarks
* @param path location of the file in UTF-8 encoding
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks(lltl::parray<bookmark_t> *dst, const char *path, const char *charset=NULL);
/**
* Read LSP bookmarks in JSON5 format
* @param dst list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks(lltl::parray<bookmark_t> *dst, const LSPString *path, const char *charset=NULL);
/**
* Read LSP bookmarks in JSON5 format
* @param dst list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t read_bookmarks(lltl::parray<bookmark_t> *dst, const io::Path *path, const char *charset=NULL);
/**
* Read LSP bookmarks in JSON5 format
* @param dst list to store bookmarks
* @param in input character sequence
* @return status of operation
*/
status_t read_bookmarks(lltl::parray<bookmark_t> *dst, io::IInSequence *in);
/**
* Save LSP bookmarks in JSON5 format
* @param src list to store bookmarks
* @param path location of the file in UTF-8 encoding
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t save_bookmarks(const lltl::parray<bookmark_t> *src, const char *path, const char *charset=NULL);
/**
* Save LSP bookmarks in JSON5 format
* @param src list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t save_bookmarks(const lltl::parray<bookmark_t> *src, const LSPString *path, const char *charset=NULL);
/**
* Save LSP bookmarks in JSON5 format
* @param src list to store bookmarks
* @param path location of the file
* @param charset file encoding character set, NULL for default locale
* @return status of operation
*/
status_t save_bookmarks(const lltl::parray<bookmark_t> *src, const io::Path *path, const char *charset=NULL);
/**
* Save LSP bookmarks in JSON5 format
* @param src list to store bookmarks
* @param out output character sequence
* @return status of operation
*/
status_t save_bookmarks(const lltl::parray<bookmark_t> *src, io::IOutSequence *out);
/**
* Merge bookmarks:
* - add all existing in src bookmarks to dst if they are non-existing in dst
* - set origin flag in dst to 'origin' for all bookmarks that exist in dst and origin
* - unset origin flsg in dst for all bookmarks that do not exist in src
* - remove all bookmarks that have zero origin
* @param dst destination storage of bookmarks
* @param src source change set
* @param origin origin flag associated with source
* @param changes pointer to integer to add number of changes
* @return status of operation
*/
status_t merge_bookmarks(lltl::parray<bookmark_t> *dst, size_t *changes, const lltl::parray<bookmark_t> *src, bm_origin_t origin);
/**
* Destroy bookmarks
* @param list list of bookmarks
*/
void destroy_bookmarks(lltl::parray<bookmark_t> *list);
}
}
#endif /* LSP_PLUG_IN_FMT_BOOKMARKS_H_ */
|
