as_utils_error_quark ()

GQuark
as_utils_error_quark (void);

Since: 0.3.7

as_utils_is_stock_icon_name ()

gboolean
as_utils_is_stock_icon_name (const gchar *name);

Searches the known list of stock icons.

Since: 0.1.3

as_utils_is_spdx_license_id ()

gboolean
as_utils_is_spdx_license_id (const gchar *license_id);

Searches the known list of SPDX license IDs.

Since: 0.1.5

as_utils_is_spdx_license ()

gboolean
as_utils_is_spdx_license (const gchar *license);

Checks the licence string to check it being a valid licence. NOTE: SPDX licences can't typically contain brackets.

Since: 0.2.5

as_utils_is_environment_id ()

gboolean
as_utils_is_environment_id (const gchar *environment_id);

Searches the known list of registered environment IDs.

Since: 0.2.4

as_utils_is_category_id ()

gboolean
as_utils_is_category_id (const gchar *category_id);

Searches the known list of registered category IDs.

Since: 0.2.4

as_utils_is_blacklisted_id ()

gboolean
as_utils_is_blacklisted_id (const gchar *desktop_id);

Searches the known list of blacklisted desktop IDs.

Since: 0.2.2

as_utils_spdx_license_tokenize ()

gchar **
as_utils_spdx_license_tokenize (const gchar *license);

Tokenizes the SPDX license string (or any simarly formatted string) into parts. Any licence parts of the string e.g. "LGPL-2.0+" are prefexed with "@", the conjunctive replaced with "&" and the disjunctive replaced with "|". Brackets are added as indervidual tokens and other strings are appended into single tokens where possible.

Since: 0.1.5

as_utils_spdx_license_detokenize ()

gchar *
as_utils_spdx_license_detokenize (gchar **license_tokens);

De-tokenizes the SPDX licenses into a string.

Since: 0.2.5

as_utils_license_to_spdx ()

gchar *
as_utils_license_to_spdx (const gchar *license);

Converts a non-SPDX license into an SPDX format string where possible.

Since: 0.5.5

as_utils_find_icon_filename ()

gchar *
as_utils_find_icon_filename (const gchar *destdir,
                             const gchar *search,
                             GError **error);

Finds an icon filename from a filesystem root.

Since: 0.2.5

as_utils_find_icon_filename_full ()

gchar *
as_utils_find_icon_filename_full (const gchar *destdir,
                                  const gchar *search,
                                  AsUtilsFindIconFlag flags,
                                  GError **error);

Finds an icon filename from a filesystem root.

Since: 0.3.1

as_utils_install_filename ()

gboolean
as_utils_install_filename (AsUtilsLocation location,
                           const gchar *filename,
                           const gchar *origin,
                           const gchar *destdir,
                           GError **error);

Installs an AppData, MetaInfo, AppStream XML or AppStream Icon metadata file.

Since: 0.3.4

as_utils_search_token_valid ()

gboolean
as_utils_search_token_valid (const gchar *token);

Checks the search token if it is valid. Valid tokens are at least 3 chars in length, not common words like "and", and do not contain markup.

Since: 0.3.4

as_utils_search_tokenize ()

gchar **
as_utils_search_tokenize (const gchar *search);

Splits up a string into tokens and returns tokens that are suitable for searching. This includes taking out common words and casefolding the returned search tokens.

Since: 0.3.4

as_utils_vercmp_full ()

gint
as_utils_vercmp_full (const gchar *version_a,
                      const gchar *version_b,
                      AsVersionCompareFlag flags);

Compares version numbers for sorting.

Since: 0.7.15

as_utils_vercmp ()

gint
as_utils_vercmp (const gchar *version_a,
                 const gchar *version_b);

Compares version numbers for sorting.

Since: 0.3.5

as_utils_guid_is_valid ()

gboolean
as_utils_guid_is_valid (const gchar *guid);

Checks the source string is a valid string GUID descriptor.

Since: 0.5.0

as_utils_guid_from_string ()

gchar *
as_utils_guid_from_string (const gchar *str);

Returns a GUID for a given string. This uses a hash and so even small differences in the str will produce radically different return values.

The implementation is taken from RFC4122, Section 4.1.3; specifically using a type-5 SHA-1 hash with a DNS namespace. The same result can be obtained with this simple python program:

#!/usr/bin/python import uuid print uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')

Since: 0.5.0

as_utils_guid_from_data ()

gchar *
as_utils_guid_from_data (const gchar *namespace_id,
                         const guint8 *data,
                         gsize data_len,
                         GError **error);

Returns a GUID for some data. This uses a hash and so even small differences in the data will produce radically different return values.

The implementation is taken from RFC4122, Section 4.1.3; specifically using a type-5 SHA-1 hash.

Since: 0.6.13

as_utils_version_from_uint32 ()

gchar *
as_utils_version_from_uint32 (guint32 val,
                              AsVersionParseFlag flags);

Returns a dotted decimal version string from a 32 bit number.

Since: 0.5.2

as_utils_version_from_uint16 ()

gchar *
as_utils_version_from_uint16 (guint16 val,
                              AsVersionParseFlag flags);

Returns a dotted decimal version string from a 16 bit number.

Since: 0.5.2

as_utils_version_parse ()

gchar *
as_utils_version_parse (const gchar *version);

Returns a dotted decimal version string from a version string. The supported formats are:

Anything with a '.' or that doesn't match [0-9] or 0x[a-f,0-9] is considered a string and returned without modification.

Since: 0.5.2

as_utils_string_replace ()

guint
as_utils_string_replace (GString *string,
                         const gchar *search,
                         const gchar *replace);

Performs multiple search and replace operations on the given string.

Since: 0.5.11

as_utils_unique_id_build ()

gchar *
as_utils_unique_id_build (AsAppScope scope,
                          AsBundleKind bundle_kind,
                          const gchar *origin,
                          AsAppKind kind,
                          const gchar *id,
                          const gchar *branch);

Builds a valid unique ID using available data.

Since: 0.6.1

as_utils_unique_id_equal ()

gboolean
as_utils_unique_id_equal (const gchar *unique_id1,
                          const gchar *unique_id2);

Checks two unique IDs for equality allowing globs to match.

Since: 0.6.1

as_utils_unique_id_match ()

gboolean
as_utils_unique_id_match (const gchar *unique_id1,
                          const gchar *unique_id2,
                          AsUniqueIdMatchFlags match_flags);

Checks two unique IDs for equality allowing globs to match, whilst also allowing clients to whitelist sections that have to match.

Since: 0.7.8

as_utils_unique_id_valid ()

gboolean
as_utils_unique_id_valid (const gchar *unique_id);

Checks if a unique ID is valid i.e. has the correct number of sections.

Since: 0.6.1

as_utils_unique_id_hash ()

guint
as_utils_unique_id_hash (const gchar *unique_id);

Converts a unique-id to a hash value.

This function implements the widely used DJB hash on the ID subset of the unique-id string.

It can be passed to g_hash_table_new() as the hash_func parameter, when using non-NULL strings or unique_ids as keys in a GHashTable.

Since: 0.6.2

as_utils_appstream_id_build ()

gchar *
as_utils_appstream_id_build (const gchar *str);

Fixes a string to be a valid AppStream ID.

This function replaces any invalid chars with an underscore.

Since: 0.6.4

as_utils_appstream_id_valid ()

gboolean
as_utils_appstream_id_valid (const gchar *str);

Checks to see if a string is a valid AppStream ID. A valid AppStream ID only contains alphanumeric chars, dots and dashes.

Since: 0.6.4

enum AsUtilsError

The error type.

AS_UTILS_ERROR

#define AS_UTILS_ERROR				as_utils_error_quark ()

enum AsUtilsFindIconFlag

The flags used when finding icons.

enum AsUtilsLocation

The flags used when installing and removing metadata files.

enum AsVersionParseFlag

The flags used when parsing version numbers.

enum AsVersionCompareFlag

The flags used when comparing version numbers.

enum AsUniqueIdMatchFlags

The flags used when matching unique IDs.