forked from ariadne/pkgconf
60 lines
3.3 KiB
ReStructuredText
60 lines
3.3 KiB
ReStructuredText
|
|
||
|
|
libpkgconf `queue` module
|
||
|
|
=========================
|
||
|
|
|
||
|
|
The `queue` module provides an interface that allows easily building a dependency graph from an
|
||
|
|
arbitrary set of dependencies. It also provides support for doing "preflight" checks on the entire
|
||
|
|
dependency graph prior to working with it.
|
||
|
|
|
||
|
|
Using the `queue` module functions is the recommended way of working with dependency graphs.
|
||
|
|
|
||
|
|
.. c:function:: void pkgconf_queue_push(pkgconf_list_t *list, const char *package)
|
||
|
|
|
||
|
|
Pushes a requested dependency onto the dependency resolver's queue.
|
||
|
|
|
||
|
|
:param pkgconf_list_t* list: the dependency resolution queue to add the package request to.
|
||
|
|
:param char* package: the dependency atom requested
|
||
|
|
:return: nothing
|
||
|
|
|
||
|
|
.. c:function:: bool pkgconf_queue_compile(pkgconf_client_t *client, pkgconf_pkg_t *world, pkgconf_list_t *list)
|
||
|
|
|
||
|
|
Compile a dependency resolution queue into a dependency resolution problem if possible, otherwise report an error.
|
||
|
|
|
||
|
|
:param pkgconf_client_t* client: The pkgconf client object to use for dependency resolution.
|
||
|
|
:param pkgconf_pkg_t* world: The designated root of the dependency graph.
|
||
|
|
:param pkgconf_list_t* list: The list of dependency requests to consider.
|
||
|
|
:return: true if the built dependency resolution problem is consistent, else false
|
||
|
|
:rtype: bool
|
||
|
|
|
||
|
|
.. c:function:: void pkgconf_queue_free(pkgconf_list_t *list)
|
||
|
|
|
||
|
|
Release any memory related to a dependency resolution queue.
|
||
|
|
|
||
|
|
:param pkgconf_list_t* list: The dependency resolution queue to release.
|
||
|
|
:return: nothing
|
||
|
|
|
||
|
|
.. c:function:: void pkgconf_queue_apply(pkgconf_client_t *client, pkgconf_list_t *list, pkgconf_queue_apply_func_t func, int maxdepth, unsigned int flags, void *data)
|
||
|
|
|
||
|
|
Attempt to compile a dependency resolution queue into a dependency resolution problem, then attempt to solve the problem and
|
||
|
|
feed the solution to a callback function if a complete dependency graph is found.
|
||
|
|
|
||
|
|
:param pkgconf_client_t* client: The pkgconf client object to use for dependency resolution.
|
||
|
|
:param pkgconf_list_t* list: The list of dependency requests to consider.
|
||
|
|
:param pkgconf_queue_apply_func_t func: The callback function to call if a solution is found by the dependency resolver.
|
||
|
|
:param int maxdepth: The maximum allowed depth for the dependency resolver. A depth of -1 means unlimited.
|
||
|
|
:param uint flags: A bitfield of flags that is passed to the dependency resolver, optionally modifying it's behaviour.
|
||
|
|
:param void* data: An opaque pointer which is passed to the callback function.
|
||
|
|
:returns: true if the dependency resolver found a solution, otherwise false.
|
||
|
|
:rtype: bool
|
||
|
|
|
||
|
|
.. c:function:: void pkgconf_queue_validate(pkgconf_client_t *client, pkgconf_list_t *list, pkgconf_queue_apply_func_t func, int maxdepth, unsigned int flags, void *data)
|
||
|
|
|
||
|
|
Attempt to compile a dependency resolution queue into a dependency resolution problem, then attempt to solve the problem.
|
||
|
|
|
||
|
|
:param pkgconf_client_t* client: The pkgconf client object to use for dependency resolution.
|
||
|
|
:param pkgconf_list_t* list: The list of dependency requests to consider.
|
||
|
|
:param int maxdepth: The maximum allowed depth for the dependency resolver. A depth of -1 means unlimited.
|
||
|
|
:param uint flags: A bitfield of flags that is passed to the dependency resolver, optionally modifying it's behaviour.
|
||
|
|
:returns: true if the dependency resolver found a solution, otherwise false.
|
||
|
|
:rtype: bool
|