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
|
/* -*- 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"
#define AS_TYPE_STORE (as_store_get_type())
#define AS_STORE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), AS_TYPE_STORE, AsStore))
#define AS_STORE_CLASS(cls) (G_TYPE_CHECK_CLASS_CAST((cls), AS_TYPE_STORE, AsStoreClass))
#define AS_IS_STORE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), AS_TYPE_STORE))
#define AS_IS_STORE_CLASS(cls) (G_TYPE_CHECK_CLASS_TYPE((cls), AS_TYPE_STORE))
#define AS_STORE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), AS_TYPE_STORE, AsStoreClass))
G_BEGIN_DECLS
typedef struct _AsStore AsStore;
typedef struct _AsStoreClass AsStoreClass;
struct _AsStore
{
GObject parent;
};
struct _AsStoreClass
{
GObjectClass parent_class;
void (*changed) (AsStore *store);
/*< private >*/
void (*_as_reserved1) (void);
void (*_as_reserved2) (void);
void (*_as_reserved3) (void);
void (*_as_reserved4) (void);
void (*_as_reserved5) (void);
void (*_as_reserved6) (void);
void (*_as_reserved7) (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
* @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
*
* 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, /* Since: 0.1.2 */
AS_STORE_LOAD_FLAG_APP_INFO_USER = 2, /* Since: 0.1.2 */
AS_STORE_LOAD_FLAG_APP_INSTALL = 4, /* Since: 0.1.2 */
AS_STORE_LOAD_FLAG_APPDATA = 8, /* Since: 0.2.2 */
AS_STORE_LOAD_FLAG_DESKTOP = 16, /* Since: 0.2.2 */
AS_STORE_LOAD_FLAG_ALLOW_VETO = 32, /* Since: 0.2.5 */
/*< private >*/
AS_STORE_LOAD_FLAG_LAST
} AsStoreLoadFlags;
/**
* AsStoreAddFlags:
* @AS_STORE_ADD_FLAG_NONE: No extra flags to use
* @AS_STORE_ADD_FLAG_PREFER_LOCAL: Local files will be used by default
*
* 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, /* Since: 0.2.2 */
/*< 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;
/**
* 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 ()
GType as_store_get_type (void);
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_xml (AsStore *store,
const gchar *data,
const gchar *icon_root,
GError **error);
gboolean as_store_load (AsStore *store,
AsStoreLoadFlags flags,
GCancellable *cancellable,
GError **error);
gboolean as_store_load_path (AsStore *store,
const gchar *path,
GCancellable *cancellable,
GError **error);
void as_store_remove_all (AsStore *store);
GPtrArray *as_store_get_apps (AsStore *store);
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_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);
void as_store_add_app (AsStore *store,
AsApp *app);
void as_store_remove_app (AsStore *store,
AsApp *app);
void as_store_remove_app_by_id (AsStore *store,
const gchar *id);
GString *as_store_to_xml (AsStore *store,
AsNodeToXmlFlags flags);
gboolean as_store_to_file (AsStore *store,
GFile *file,
AsNodeToXmlFlags 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);
AsStoreAddFlags as_store_get_add_flags (AsStore *store);
void as_store_set_add_flags (AsStore *store,
AsStoreAddFlags add_flags);
AsStoreWatchFlags as_store_get_watch_flags (AsStore *store);
void as_store_set_watch_flags (AsStore *store,
AsStoreWatchFlags watch_flags);
GPtrArray *as_store_validate (AsStore *store,
AsAppValidateFlags flags,
GError **error);
void as_store_add_metadata_index (AsStore *store,
const gchar *key);
void as_store_add_filter (AsStore *store,
AsIdKind kind);
void as_store_remove_filter (AsStore *store,
AsIdKind kind);
G_END_DECLS
#endif /* __AS_STORE_H */
|
