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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 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_APP_H
#define __AS_APP_H
#include <glib-object.h>
#include "as-enums.h"
#include "as-provide.h"
#include "as-release.h"
#include "as-screenshot.h"
#define AS_TYPE_APP (as_app_get_type())
#define AS_APP(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), AS_TYPE_APP, AsApp))
#define AS_APP_CLASS(cls) (G_TYPE_CHECK_CLASS_CAST((cls), AS_TYPE_APP, AsAppClass))
#define AS_IS_APP(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), AS_TYPE_APP))
#define AS_IS_APP_CLASS(cls) (G_TYPE_CHECK_CLASS_TYPE((cls), AS_TYPE_APP))
#define AS_APP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), AS_TYPE_APP, AsAppClass))
G_BEGIN_DECLS
typedef struct _AsApp AsApp;
typedef struct _AsAppClass AsAppClass;
struct _AsApp
{
GObject parent;
};
struct _AsAppClass
{
GObjectClass parent_class;
/*< 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);
void (*_as_reserved8) (void);
};
/**
* AsAppParseFlags:
* @AS_APP_PARSE_FLAG_NONE: No special actions to use
* @AS_APP_PARSE_FLAG_USE_HEURISTICS: Use heuristic to infer properties
* @AS_APP_PARSE_FLAG_KEEP_COMMENTS: Save comments from the file
* @AS_APP_PARSE_FLAG_CONVERT_TRANSLATABLE: Allow translatable flags like <_p>
*
* The flags to use when parsing resources.
**/
typedef enum {
AS_APP_PARSE_FLAG_NONE,
AS_APP_PARSE_FLAG_USE_HEURISTICS = 1, /* Since: 0.1.2 */
AS_APP_PARSE_FLAG_KEEP_COMMENTS = 2, /* Since: 0.1.6 */
AS_APP_PARSE_FLAG_CONVERT_TRANSLATABLE = 4, /* Since: 0.1.6 */
/*< private >*/
AS_APP_PARSE_FLAG_LAST,
} AsAppParseFlags;
/**
* AsAppSubsumeFlags:
* @AS_APP_SUBSUME_FLAG_NONE: No special actions to use
* @AS_APP_SUBSUME_FLAG_NO_OVERWRITE: Do not overwrite already set properties
* @AS_APP_SUBSUME_FLAG_BOTH_WAYS: Copy unset properties both ways
*
* The flags to use when subsuming applications.
**/
typedef enum {
AS_APP_SUBSUME_FLAG_NONE,
AS_APP_SUBSUME_FLAG_NO_OVERWRITE = 1, /* Since: 0.1.4 */
AS_APP_SUBSUME_FLAG_BOTH_WAYS = 2, /* Since: 0.1.4 */
/*< private >*/
AS_APP_SUBSUME_FLAG_LAST,
} AsAppSubsumeFlags;
/**
* AsAppError:
* @AS_APP_ERROR_FAILED: Generic failure
* @AS_APP_ERROR_INVALID_TYPE: Invalid type
*
* The error type.
**/
typedef enum {
AS_APP_ERROR_FAILED,
AS_APP_ERROR_INVALID_TYPE,
/*< private >*/
AS_APP_ERROR_LAST
} AsAppError;
/**
* AsAppValidateFlags:
* @AS_APP_VALIDATE_FLAG_NONE: No extra flags to use
* @AS_APP_VALIDATE_FLAG_RELAX: Relax the checks
* @AS_APP_VALIDATE_FLAG_STRICT: Make the checks more strict
* @AS_APP_VALIDATE_FLAG_NO_NETWORK: Do not use the network
*
* The flags to use when validating.
**/
typedef enum {
AS_APP_VALIDATE_FLAG_NONE = 0, /* Since: 0.1.4 */
AS_APP_VALIDATE_FLAG_RELAX = 1, /* Since: 0.1.4 */
AS_APP_VALIDATE_FLAG_STRICT = 2, /* Since: 0.1.4 */
AS_APP_VALIDATE_FLAG_NO_NETWORK = 4, /* Since: 0.1.4 */
/*< private >*/
AS_APP_VALIDATE_FLAG_LAST
} AsAppValidateFlags;
/**
* AsAppSourceKind:
* @AS_APP_SOURCE_KIND_UNKNOWN: Not sourced from a file
* @AS_APP_SOURCE_KIND_APPSTREAM: Sourced from a AppStream file
* @AS_APP_SOURCE_KIND_DESKTOP: Sourced from a desktop file
* @AS_APP_SOURCE_KIND_APPDATA: Sourced from a AppData file
* @AS_APP_SOURCE_KIND_METAINFO: Sourced from a MetaInfo file
*
* The source kind.
**/
typedef enum {
AS_APP_SOURCE_KIND_UNKNOWN, /* Since: 0.1.4 */
AS_APP_SOURCE_KIND_APPSTREAM, /* Since: 0.1.4 */
AS_APP_SOURCE_KIND_DESKTOP, /* Since: 0.1.4 */
AS_APP_SOURCE_KIND_APPDATA, /* Since: 0.1.4 */
AS_APP_SOURCE_KIND_METAINFO, /* Since: 0.1.4 */
/*< private >*/
AS_APP_SOURCE_KIND_LAST
} AsAppSourceKind;
#define AS_APP_ERROR as_app_error_quark ()
GType as_app_get_type (void);
AsApp *as_app_new (void);
GQuark as_app_error_quark (void);
AsAppSourceKind as_app_guess_source_kind (const gchar *filename);
/* getters */
AsIconKind as_app_get_icon_kind (AsApp *app);
AsIdKind as_app_get_id_kind (AsApp *app);
AsAppSourceKind as_app_get_source_kind (AsApp *app);
GList *as_app_get_languages (AsApp *app);
GPtrArray *as_app_get_addons (AsApp *app);
GPtrArray *as_app_get_categories (AsApp *app);
GPtrArray *as_app_get_compulsory_for_desktops (AsApp *app);
GPtrArray *as_app_get_extends (AsApp *app);
GPtrArray *as_app_get_keywords (AsApp *app);
GPtrArray *as_app_get_pkgnames (AsApp *app);
GPtrArray *as_app_get_architectures (AsApp *app);
GPtrArray *as_app_get_releases (AsApp *app);
GPtrArray *as_app_get_provides (AsApp *app);
GPtrArray *as_app_get_screenshots (AsApp *app);
GHashTable *as_app_get_names (AsApp *app);
GHashTable *as_app_get_comments (AsApp *app);
GHashTable *as_app_get_developer_names (AsApp *app);
GHashTable *as_app_get_metadata (AsApp *app);
GHashTable *as_app_get_descriptions (AsApp *app);
GHashTable *as_app_get_urls (AsApp *app);
const gchar *as_app_get_icon (AsApp *app);
const gchar *as_app_get_icon_path (AsApp *app);
const gchar *as_app_get_id (AsApp *app);
const gchar *as_app_get_id_full (AsApp *app);
const gchar *as_app_get_project_group (AsApp *app);
const gchar *as_app_get_project_license (AsApp *app);
const gchar *as_app_get_metadata_license (AsApp *app);
const gchar *as_app_get_update_contact (AsApp *app);
const gchar *as_app_get_name (AsApp *app,
const gchar *locale);
const gchar *as_app_get_comment (AsApp *app,
const gchar *locale);
const gchar *as_app_get_developer_name (AsApp *app,
const gchar *locale);
const gchar *as_app_get_description (AsApp *app,
const gchar *locale);
gint as_app_get_priority (AsApp *app);
gint as_app_get_language (AsApp *app,
const gchar *locale);
const gchar *as_app_get_metadata_item (AsApp *app,
const gchar *key);
const gchar *as_app_get_url_item (AsApp *app,
AsUrlKind url_kind);
gboolean as_app_has_category (AsApp *app,
const gchar *category);
/* setters */
void as_app_set_id_full (AsApp *app,
const gchar *id_full,
gssize id_full_len);
void as_app_set_id_kind (AsApp *app,
AsIdKind id_kind);
void as_app_set_source_kind (AsApp *app,
AsAppSourceKind source_kind);
void as_app_set_project_group (AsApp *app,
const gchar *project_group,
gssize project_group_len);
void as_app_set_project_license (AsApp *app,
const gchar *project_license,
gssize project_license_len);
void as_app_set_metadata_license (AsApp *app,
const gchar *metadata_license,
gssize metadata_license_len);
void as_app_set_update_contact (AsApp *app,
const gchar *update_contact,
gssize update_contact_len);
void as_app_set_icon (AsApp *app,
const gchar *icon,
gssize icon_len);
void as_app_set_icon_path (AsApp *app,
const gchar *icon_path,
gssize icon_path_len);
void as_app_set_icon_kind (AsApp *app,
AsIconKind icon_kind);
void as_app_set_name (AsApp *app,
const gchar *locale,
const gchar *name,
gssize name_len);
void as_app_set_comment (AsApp *app,
const gchar *locale,
const gchar *comment,
gssize comment_len);
void as_app_set_developer_name (AsApp *app,
const gchar *locale,
const gchar *developer_name,
gssize developer_name_len);
void as_app_set_description (AsApp *app,
const gchar *locale,
const gchar *description,
gssize description_len);
void as_app_set_priority (AsApp *app,
gint priority);
void as_app_add_category (AsApp *app,
const gchar *category,
gssize category_len);
void as_app_add_keyword (AsApp *app,
const gchar *keyword,
gssize keyword_len);
void as_app_add_mimetype (AsApp *app,
const gchar *mimetype,
gssize mimetype_len);
void as_app_add_pkgname (AsApp *app,
const gchar *pkgname,
gssize pkgname_len);
void as_app_add_arch (AsApp *app,
const gchar *arch,
gssize arch_len);
void as_app_add_release (AsApp *app,
AsRelease *release);
void as_app_add_provide (AsApp *app,
AsProvide *provide);
void as_app_add_screenshot (AsApp *app,
AsScreenshot *screenshot);
void as_app_add_language (AsApp *app,
gint percentage,
const gchar *locale,
gssize locale_len);
void as_app_add_compulsory_for_desktop (AsApp *app,
const gchar *compulsory_for_desktop,
gssize compulsory_for_desktop_len);
void as_app_add_url (AsApp *app,
AsUrlKind url_kind,
const gchar *url,
gssize url_len);
void as_app_add_metadata (AsApp *app,
const gchar *key,
const gchar *value,
gssize value_len);
void as_app_remove_metadata (AsApp *app,
const gchar *key);
void as_app_add_addon (AsApp *app,
AsApp *addon);
void as_app_add_extends (AsApp *app,
const gchar *extends,
gssize extends_len);
/* object methods */
GPtrArray *as_app_validate (AsApp *app,
AsAppValidateFlags flags,
GError **error);
void as_app_subsume (AsApp *app,
AsApp *donor);
void as_app_subsume_full (AsApp *app,
AsApp *donor,
AsAppSubsumeFlags flags);
guint as_app_search_matches_all (AsApp *app,
gchar **search);
guint as_app_search_matches (AsApp *app,
const gchar *search);
gboolean as_app_parse_file (AsApp *app,
const gchar *filename,
AsAppParseFlags flags,
GError **error);
G_END_DECLS
#endif /* __AS_APP_H */
|
