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
|
/* -*- 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_UTILS_H
#define __AS_UTILS_H
#include <glib.h>
#include "as-app.h"
#include "as-bundle.h"
G_BEGIN_DECLS
/**
* AsUtilsError:
* @AS_UTILS_ERROR_FAILED: Generic failure
* @AS_UTILS_ERROR_INVALID_TYPE: Invalid type
*
* The error type.
**/
typedef enum {
AS_UTILS_ERROR_FAILED,
AS_UTILS_ERROR_INVALID_TYPE,
/*< private >*/
AS_UTILS_ERROR_LAST
} AsUtilsError;
#define AS_UTILS_ERROR as_utils_error_quark ()
/**
* AsUtilsFindIconFlag:
* @AS_UTILS_FIND_ICON_NONE: No flags set
* @AS_UTILS_FIND_ICON_HI_DPI: Prefer a HiDPI icon
*
* The flags used when finding icons.
**/
typedef enum {
AS_UTILS_FIND_ICON_NONE = 0,
AS_UTILS_FIND_ICON_HI_DPI = 1 << 0,
/*< private >*/
AS_UTILS_FIND_ICON_LAST
} AsUtilsFindIconFlag;
/**
* AsUtilsLocation:
* @AS_UTILS_LOCATION_SHARED: Installed by the vendor, shared
* @AS_UTILS_LOCATION_CACHE: Installed as metadata, shared
* @AS_UTILS_LOCATION_USER: Installed by the user
*
* The flags used when installing and removing metadata files.
**/
typedef enum {
AS_UTILS_LOCATION_SHARED,
AS_UTILS_LOCATION_CACHE,
AS_UTILS_LOCATION_USER,
/*< private >*/
AS_UTILS_LOCATION_LAST
} AsUtilsLocation;
/**
* AsVersionParseFlag:
* @AS_VERSION_PARSE_FLAG_NONE: No flags set
* @AS_VERSION_PARSE_FLAG_USE_TRIPLET: Use Microsoft-style version numbers
* @AS_VERSION_PARSE_FLAG_USE_BCD: Use binary coded decimal notation
*
* The flags used when parsing version numbers.
**/
typedef enum {
AS_VERSION_PARSE_FLAG_NONE = 0,
AS_VERSION_PARSE_FLAG_USE_TRIPLET = 1 << 0,
AS_VERSION_PARSE_FLAG_USE_BCD = 1 << 1, /* Since: 0.7.3 */
/*< private >*/
AS_VERSION_PARSE_FLAG_LAST
} AsVersionParseFlag;
/**
* AsVersionCompareFlag:
* @AS_VERSION_COMPARE_FLAG_NONE: No flags set
* @AS_VERSION_COMPARE_FLAG_USE_HEURISTICS: Use a heuristic to parse version numbers
*
* The flags used when comparing version numbers.
**/
typedef enum {
AS_VERSION_COMPARE_FLAG_NONE = 0,
AS_VERSION_COMPARE_FLAG_USE_HEURISTICS = 1 << 0,
/*< private >*/
AS_VERSION_COMPARE_FLAG_LAST
} AsVersionCompareFlag;
/**
* AsUniqueIdMatchFlags:
* @AS_UNIQUE_ID_MATCH_FLAG_NONE: No flags set
* @AS_UNIQUE_ID_MATCH_FLAG_SCOPE: Scope, e.g. a #AsAppScope
* @AS_UNIQUE_ID_MATCH_FLAG_BUNDLE_KIND: Bundle kind, e.g. a #AsBundleKind
* @AS_UNIQUE_ID_MATCH_FLAG_ORIGIN: Origin
* @AS_UNIQUE_ID_MATCH_FLAG_KIND: Component kind, e.g. a #AsAppKind
* @AS_UNIQUE_ID_MATCH_FLAG_ID: Component AppStream ID
* @AS_UNIQUE_ID_MATCH_FLAG_BRANCH: Branch
*
* The flags used when matching unique IDs.
**/
typedef enum {
AS_UNIQUE_ID_MATCH_FLAG_NONE = 0,
AS_UNIQUE_ID_MATCH_FLAG_SCOPE = 1 << 0,
AS_UNIQUE_ID_MATCH_FLAG_BUNDLE_KIND = 1 << 1, /* Since: 0.7.8 */
AS_UNIQUE_ID_MATCH_FLAG_ORIGIN = 1 << 2, /* Since: 0.7.8 */
AS_UNIQUE_ID_MATCH_FLAG_KIND = 1 << 3, /* Since: 0.7.8 */
AS_UNIQUE_ID_MATCH_FLAG_ID = 1 << 4, /* Since: 0.7.8 */
AS_UNIQUE_ID_MATCH_FLAG_BRANCH = 1 << 5, /* Since: 0.7.8 */
/*< private >*/
AS_UNIQUE_ID_MATCH_FLAG_LAST
} AsUniqueIdMatchFlags;
GQuark as_utils_error_quark (void);
gboolean as_utils_is_stock_icon_name (const gchar *name);
gboolean as_utils_is_spdx_license_id (const gchar *license_id);
gboolean as_utils_is_spdx_license (const gchar *license);
gboolean as_utils_is_environment_id (const gchar *environment_id);
gboolean as_utils_is_category_id (const gchar *category_id);
G_DEPRECATED
gboolean as_utils_is_blacklisted_id (const gchar *desktop_id);
gchar **as_utils_spdx_license_tokenize (const gchar *license);
gchar *as_utils_spdx_license_detokenize (gchar **license_tokens);
gchar *as_utils_license_to_spdx (const gchar *license);
gchar *as_utils_find_icon_filename (const gchar *destdir,
const gchar *search,
GError **error);
gchar *as_utils_find_icon_filename_full (const gchar *destdir,
const gchar *search,
AsUtilsFindIconFlag flags,
GError **error);
gboolean as_utils_install_filename (AsUtilsLocation location,
const gchar *filename,
const gchar *origin,
const gchar *destdir,
GError **error);
gboolean as_utils_search_token_valid (const gchar *token);
gchar **as_utils_search_tokenize (const gchar *search);
gint as_utils_vercmp_full (const gchar *version_a,
const gchar *version_b,
AsVersionCompareFlag flags);
gint as_utils_vercmp (const gchar *version_a,
const gchar *version_b);
gboolean as_utils_guid_is_valid (const gchar *guid);
gchar *as_utils_guid_from_string (const gchar *str);
gchar *as_utils_guid_from_data (const gchar *namespace_id,
const guint8 *data,
gsize data_len,
GError **error);
gchar *as_utils_version_from_uint32 (guint32 val,
AsVersionParseFlag flags);
gchar *as_utils_version_from_uint16 (guint16 val,
AsVersionParseFlag flags);
gchar *as_utils_version_parse (const gchar *version);
guint as_utils_string_replace (GString *string,
const gchar *search,
const gchar *replace);
gchar *as_utils_unique_id_build (AsAppScope scope,
AsBundleKind bundle_kind,
const gchar *origin,
AsAppKind kind,
const gchar *id,
const gchar *branch);
gboolean as_utils_unique_id_equal (const gchar *unique_id1,
const gchar *unique_id2);
gboolean as_utils_unique_id_match (const gchar *unique_id1,
const gchar *unique_id2,
AsUniqueIdMatchFlags match_flags);
gboolean as_utils_unique_id_valid (const gchar *unique_id);
guint as_utils_unique_id_hash (const gchar *unique_id);
gchar *as_utils_appstream_id_build (const gchar *str);
gboolean as_utils_appstream_id_valid (const gchar *str);
G_END_DECLS
#endif /* __AS_UTILS_H */
|
