Module functions

Functions

• current_distro_component_id
  Returns the component-ID of the current distribution based on contents of the /etc/os-release file. This function is a shorthand for as_distro_details_get_cid
• default_categories
  Get a list of the default Freedesktop and AppStream categories that software components (especially GUI applications) can be sorted into in software centers.
• default_categories_gi
  Get a list of the default Freedesktop and AppStream categories that software components (especially GUI applications) can be sorted into in software centers.
• is_spdx_license_exception_id
  Searches the known list of SPDX license exception IDs.
• is_spdx_license_expression
  Checks the licence string to check it being a valid licence. NOTE: SPDX licenses can’t typically contain brackets.
• is_spdx_license_id
  Searches the known list of SPDX license IDs.
• license_is_free_license
  Check if the given license is for free-as-in-freedom software. A free software license is either approved by the Free Software Foundation or the Open Source Initiative.
• license_is_metadata_license
  Check if the metadata license is suitable for mixing with other metadata and redistributing the bundled result (this means we prefer permissive licenses here, to not require people shipping catalog metadata to perform a full license review).
• license_is_metadata_license_id
  Tests license ID against the vetted list of licenses that can be used for metainfo metadata. This function will not work for license expressions, if you need to test an SPDX license expression for compliance, please use as_license_is_metadata_license insread.
• license_name
  Get a translated license name for the given SPDX ID.
• license_to_spdx_id
  Converts a non-SPDX license into an SPDX format string where possible.
• license_url
  Get a web URL to the license text and more license information for an SPDX license identifier.
• markup_convert
  Converts XML description markup into other forms of text.
• markup_strsplit_words
  Splits up a long line into an array of smaller strings, each being no longer than line_len. Words are not split.
• spdx_license_tokenize
  Tokenizes the SPDX license string (or any simarly formatted string) into parts. Any license parts of the string e.g. “LGPL-2.0+” are prefexed with “@”, the conjunctive replaced with “&”, the disjunctive replaced with “|” and the WITH operator for license exceptions replaced with “^”. Brackets are added as indervidual tokens and other strings are appended into single tokens where possible.
• utils_build_data_id
  Builds an identifier string unique to the individual dataset using the supplied information.
• utils_data_id_equal
• utils_data_id_get_cid
  Get the component-id part of the data-id.
• utils_data_id_hash
• utils_data_id_match
  Checks two data IDs for equality allowing globs to match, whilst also allowing clients to whitelist sections that have to match.
• utils_data_id_valid
  Checks if a data ID is valid i.e. has the correct number of sections.
• utils_get_desktop_environment_name
  Get a human-readable, translated name of the desktop environment represented by the given ID.
• utils_get_gui_environment_style_name
  Get a human-readable, translated name of the combination of GUI environment and style. E.g. “plasma:dark” becomes “Plasma (Dark)”.
• utils_get_tag_search_weight
  Retrieve the raw search token weight for the given tag name that AppStream uses internally for searching. This can be used to implement separate, but compatible search logic.
• utils_guess_scope_from_path
  Guess the ComponentScope that applies to a given path.
• utils_install_metadata_file
  Installs an AppStream MetaInfo, AppStream Metadata Catalog or AppStream Icon tarball file to the right place on the filesystem. Please note that this function does almost no validation and may guess missing values such as icon sizes and origin names. Ensure your metadata is good before installing it.
• utils_is_category_name
• utils_is_desktop_environment
  Checks if the submitted desktop environment ID is known and valid.
• utils_is_gui_environment_style
  Checks if the given identifier is a valid, known GUI environment style.
• utils_is_platform_triplet
  Test if the given string is a valid platform triplet recognized by AppStream.
• utils_is_tld
  Searches the known list of TLDs we allow for AppStream IDs. This excludes internationalized names.
• utils_locale_is_compatible
  Calculates if one locale is compatible with another. When doing the calculation the locale and language code is taken into account if possible.
• utils_posix_locale_to_bcp47
  Converts a POSIX locale string to the corresponding IETF BCP47 format. If the given locale is already in BCP47 format, no change will be done.
• utils_sort_components_into_categories
  Sorts all components in cpts into the Category categories listed in categories.
• vercmp
  Compare alpha and numeric segments of two software versions, considering flags.
• vercmp_simple
  Compare alpha and numeric segments of two software versions.
• vercmp_test_match
  Compare two version numbers and check if the given version comparator matches.
• version_string
  Get the version of the AppStream library that is currently used at runtime as a string.