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
280
281
282
283
284
285
286
287
288
289
290
291
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2013-2014 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU Lesser General Public License Version 2.1
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#if !defined (__APPSTREAM_GLIB_H) && !defined (AS_COMPILATION)
#error "Only <appstream-glib.h> can be included directly."
#endif
#ifndef __AS_STORE_H
#define __AS_STORE_H
#include <glib-object.h>
#include <gio/gio.h>
#include "as-app.h"
#include "as-node.h"
G_BEGIN_DECLS
#define AS_TYPE_STORE (as_store_get_type ())
G_DECLARE_DERIVABLE_TYPE (AsStore, as_store, AS, STORE, GObject)
struct _AsStoreClass
{
GObjectClass parent_class;
void (*changed) (AsStore *store);
void (*app_added) (AsStore *store,
AsApp *app);
void (*app_removed) (AsStore *store,
AsApp *app);
void (*app_changed) (AsStore *store,
AsApp *app);
/*< private >*/
void (*_as_reserved1) (void);
void (*_as_reserved2) (void);
void (*_as_reserved3) (void);
void (*_as_reserved4) (void);
};
/**
* AsStoreLoadFlags:
* @AS_STORE_LOAD_FLAG_NONE: No extra flags to use
* @AS_STORE_LOAD_FLAG_APP_INFO_SYSTEM: The system app-info AppStream data
* @AS_STORE_LOAD_FLAG_APP_INFO_USER: The per-user app-info AppStream data
* @AS_STORE_LOAD_FLAG_APP_INSTALL: The ubuntu-specific app-install data (obsolete)
* @AS_STORE_LOAD_FLAG_APPDATA: The installed AppData files
* @AS_STORE_LOAD_FLAG_DESKTOP: The installed desktop files
* @AS_STORE_LOAD_FLAG_ALLOW_VETO: Add vetoed applications
* @AS_STORE_LOAD_FLAG_FLATPAK_USER: Add flatpak user applications (obsolete)
* @AS_STORE_LOAD_FLAG_FLATPAK_SYSTEM: Add flatpak system applications (obsolete)
* @AS_STORE_LOAD_FLAG_IGNORE_INVALID: Ignore invalid files
* @AS_STORE_LOAD_FLAG_ONLY_UNCOMPRESSED: Ignore compressed files
* @AS_STORE_LOAD_FLAG_ONLY_MERGE_APPS: Ignore non-wildcard matches
*
* The flags to use when loading the store.
**/
typedef enum {
AS_STORE_LOAD_FLAG_NONE = 0, /* Since: 0.1.2 */
AS_STORE_LOAD_FLAG_APP_INFO_SYSTEM = 1 << 0, /* Since: 0.1.2 */
AS_STORE_LOAD_FLAG_APP_INFO_USER = 1 << 1, /* Since: 0.1.2 */
AS_STORE_LOAD_FLAG_APP_INSTALL = 1 << 2, /* Since: 0.1.2 */
AS_STORE_LOAD_FLAG_APPDATA = 1 << 3, /* Since: 0.2.2 */
AS_STORE_LOAD_FLAG_DESKTOP = 1 << 4, /* Since: 0.2.2 */
AS_STORE_LOAD_FLAG_ALLOW_VETO = 1 << 5, /* Since: 0.2.5 */
AS_STORE_LOAD_FLAG_FLATPAK_USER = 1 << 6, /* Since: 0.5.7 */
AS_STORE_LOAD_FLAG_FLATPAK_SYSTEM = 1 << 7, /* Since: 0.5.7 */
AS_STORE_LOAD_FLAG_IGNORE_INVALID = 1 << 8, /* Since: 0.5.8 */
AS_STORE_LOAD_FLAG_ONLY_UNCOMPRESSED = 1 << 9, /* Since: 0.6.4 */
AS_STORE_LOAD_FLAG_ONLY_MERGE_APPS = 1 << 10, /* Since: 0.6.4 */
/*< private >*/
AS_STORE_LOAD_FLAG_LAST
} AsStoreLoadFlags;
/* DEPRECATED */
#define AS_STORE_LOAD_FLAG_XDG_APP_USER AS_STORE_LOAD_FLAG_FLATPAK_USER
#define AS_STORE_LOAD_FLAG_XDG_APP_SYSTEM AS_STORE_LOAD_FLAG_FLATPAK_SYSTEM
/**
* AsStoreAddFlags:
* @AS_STORE_ADD_FLAG_NONE: No extra flags to use
* @AS_STORE_ADD_FLAG_PREFER_LOCAL: Local files will be used by default
* @AS_STORE_ADD_FLAG_USE_UNIQUE_ID: Allow multiple apps with the same AppStream ID
* @AS_STORE_ADD_FLAG_USE_MERGE_HEURISTIC: Use a heuristic when adding merge components
* @AS_STORE_ADD_FLAG_ONLY_NATIVE_LANGS: Only load native languages
*
* The flags to use when adding applications to the store.
**/
typedef enum {
AS_STORE_ADD_FLAG_NONE = 0, /* Since: 0.2.2 */
AS_STORE_ADD_FLAG_PREFER_LOCAL = 1 << 0, /* Since: 0.2.2 */
AS_STORE_ADD_FLAG_USE_UNIQUE_ID = 1 << 1, /* Since: 0.6.1 */
AS_STORE_ADD_FLAG_USE_MERGE_HEURISTIC = 1 << 2, /* Since: 0.6.1 */
AS_STORE_ADD_FLAG_ONLY_NATIVE_LANGS = 1 << 3, /* Since: 0.6.5 */
/*< private >*/
AS_STORE_ADD_FLAG_LAST
} AsStoreAddFlags;
/**
* AsStoreWatchFlags:
* @AS_STORE_WATCH_FLAG_NONE: No extra flags to use
* @AS_STORE_WATCH_FLAG_ADDED: Add applications if files change or are added
* @AS_STORE_WATCH_FLAG_REMOVED: Remove applications if files are changed or deleted
*
* The flags to use when local files are added or removed from the store.
**/
typedef enum {
AS_STORE_WATCH_FLAG_NONE = 0, /* Since: 0.4.2 */
AS_STORE_WATCH_FLAG_ADDED = 1, /* Since: 0.4.2 */
AS_STORE_WATCH_FLAG_REMOVED = 2, /* Since: 0.4.2 */
/*< private >*/
AS_STORE_WATCH_FLAG_LAST
} AsStoreWatchFlags;
/**
* AsStoreSearchFlags:
* @AS_STORE_SEARCH_FLAG_NONE: No extra flags to use
* @AS_STORE_SEARCH_FLAG_USE_WILDCARDS: Process the globs
*
* The flags to use when searching in the store.
**/
typedef enum {
AS_STORE_SEARCH_FLAG_NONE = 0, /* Since: 0.6.1 */
AS_STORE_SEARCH_FLAG_USE_WILDCARDS = 1, /* Since: 0.6.1 */
/*< private >*/
AS_STORE_SEARCH_FLAG_LAST
} AsStoreSearchFlags;
/**
* AsStoreError:
* @AS_STORE_ERROR_FAILED: Generic failure
*
* The error type.
**/
typedef enum {
AS_STORE_ERROR_FAILED,
/*< private >*/
AS_STORE_ERROR_LAST
} AsStoreError;
#define AS_STORE_ERROR as_store_error_quark ()
AsStore *as_store_new (void);
GQuark as_store_error_quark (void);
/* getters */
guint as_store_get_size (AsStore *store);
/* object methods */
gboolean as_store_from_file (AsStore *store,
GFile *file,
const gchar *icon_root,
GCancellable *cancellable,
GError **error);
gboolean as_store_from_bytes (AsStore *store,
GBytes *bytes,
GCancellable *cancellable,
GError **error);
gboolean as_store_from_xml (AsStore *store,
const gchar *data,
const gchar *icon_root,
GError **error);
gboolean as_store_load (AsStore *store,
guint32 flags,
GCancellable *cancellable,
GError **error);
void as_store_load_async (AsStore *store,
AsStoreLoadFlags flags,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean as_store_load_finish (AsStore *store,
GAsyncResult *result,
GError **error);
gboolean as_store_load_path (AsStore *store,
const gchar *path,
GCancellable *cancellable,
GError **error);
void as_store_load_path_async (AsStore *store,
const gchar *path,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean as_store_load_path_finish (AsStore *store,
GAsyncResult *result,
GError **error);
void as_store_load_search_cache (AsStore *store);
void as_store_set_search_match (AsStore *store,
guint16 search_match);
guint16 as_store_get_search_match (AsStore *store);
void as_store_remove_all (AsStore *store);
GPtrArray *as_store_get_apps (AsStore *store);
GPtrArray *as_store_get_apps_by_id (AsStore *store,
const gchar *id);
GPtrArray *as_store_get_apps_by_id_merge (AsStore *store,
const gchar *id);
GPtrArray *as_store_get_apps_by_metadata (AsStore *store,
const gchar *key,
const gchar *value);
AsApp *as_store_get_app_by_id (AsStore *store,
const gchar *id);
AsApp *as_store_get_app_by_unique_id (AsStore *store,
const gchar *unique_id,
guint32 search_flags);
AsApp *as_store_get_app_by_id_ignore_prefix
(AsStore *store,
const gchar *id);
AsApp *as_store_get_app_by_id_with_fallbacks (AsStore *store,
const gchar *id);
AsApp *as_store_get_app_by_pkgname (AsStore *store,
const gchar *pkgname);
AsApp *as_store_get_app_by_pkgnames (AsStore *store,
gchar **pkgnames);
AsApp *as_store_get_app_by_provide (AsStore *store,
AsProvideKind kind,
const gchar *value);
AsApp *as_store_get_app_by_launchable (AsStore *store,
AsLaunchableKind kind,
const gchar *value);
GPtrArray *as_store_get_apps_by_provide (AsStore *store,
AsProvideKind kind,
const gchar *value);
void as_store_add_app (AsStore *store,
AsApp *app);
void as_store_add_apps (AsStore *store,
GPtrArray *apps);
void as_store_remove_app (AsStore *store,
AsApp *app);
void as_store_remove_app_by_id (AsStore *store,
const gchar *id);
void as_store_remove_apps_with_veto (AsStore *store);
GString *as_store_to_xml (AsStore *store,
guint32 flags);
gboolean as_store_to_file (AsStore *store,
GFile *file,
guint32 flags,
GCancellable *cancellable,
GError **error);
gboolean as_store_convert_icons (AsStore *store,
AsIconKind kind,
GError **error);
const gchar *as_store_get_origin (AsStore *store);
void as_store_set_origin (AsStore *store,
const gchar *origin);
const gchar *as_store_get_builder_id (AsStore *store);
void as_store_set_builder_id (AsStore *store,
const gchar *builder_id);
const gchar *as_store_get_destdir (AsStore *store);
void as_store_set_destdir (AsStore *store,
const gchar *destdir);
gdouble as_store_get_api_version (AsStore *store);
void as_store_set_api_version (AsStore *store,
gdouble api_version);
guint32 as_store_get_add_flags (AsStore *store);
void as_store_set_add_flags (AsStore *store,
guint32 add_flags);
guint32 as_store_get_watch_flags (AsStore *store);
void as_store_set_watch_flags (AsStore *store,
guint32 watch_flags);
GPtrArray *as_store_validate (AsStore *store,
guint32 flags,
GError **error);
void as_store_add_metadata_index (AsStore *store,
const gchar *key);
void as_store_add_filter (AsStore *store,
AsAppKind kind);
void as_store_remove_filter (AsStore *store,
AsAppKind kind);
G_END_DECLS
#endif /* __AS_STORE_H */
|
