1 2libpkgconf `queue` module 3========================= 4 5The `queue` module provides an interface that allows easily building a dependency graph from an 6arbitrary set of dependencies. It also provides support for doing "preflight" checks on the entire 7dependency graph prior to working with it. 8 9Using the `queue` module functions is the recommended way of working with dependency graphs. 10 11.. c:function:: void pkgconf_queue_push(pkgconf_list_t *list, const char *package) 12 13 Pushes a requested dependency onto the dependency resolver's queue. 14 15 :param pkgconf_list_t* list: the dependency resolution queue to add the package request to. 16 :param char* package: the dependency atom requested 17 :return: nothing 18 19.. c:function:: bool pkgconf_queue_compile(pkgconf_client_t *client, pkgconf_pkg_t *world, pkgconf_list_t *list) 20 21 Compile a dependency resolution queue into a dependency resolution problem if possible, otherwise report an error. 22 23 :param pkgconf_client_t* client: The pkgconf client object to use for dependency resolution. 24 :param pkgconf_pkg_t* world: The designated root of the dependency graph. 25 :param pkgconf_list_t* list: The list of dependency requests to consider. 26 :return: true if the built dependency resolution problem is consistent, else false 27 :rtype: bool 28 29.. c:function:: void pkgconf_queue_free(pkgconf_list_t *list) 30 31 Release any memory related to a dependency resolution queue. 32 33 :param pkgconf_list_t* list: The dependency resolution queue to release. 34 :return: nothing 35 36.. c:function:: void pkgconf_solution_free(pkgconf_client_t *client, pkgconf_pkg_t *world, int maxdepth) 37 38 Removes references to package nodes contained in a solution. 39 40 :param pkgconf_client_t* client: The pkgconf client object to use for dependency resolution. 41 :param pkgconf_pkg_t* world: The root for the generated dependency graph. Should have PKGCONF_PKG_PROPF_VIRTUAL flag. 42 :returns: nothing 43 44.. c:function:: bool pkgconf_queue_solve(pkgconf_client_t *client, pkgconf_list_t *list, pkgconf_pkg_t *world, int maxdepth) 45 46 Solves and flattens the dependency graph for the supplied dependency list. 47 48 :param pkgconf_client_t* client: The pkgconf client object to use for dependency resolution. 49 :param pkgconf_list_t* list: The list of dependency requests to consider. 50 :param pkgconf_pkg_t* world: The root for the generated dependency graph, provided by the caller. Should have PKGCONF_PKG_PROPF_VIRTUAL flag. 51 :param int maxdepth: The maximum allowed depth for the dependency resolver. A depth of -1 means unlimited. 52 :returns: true if the dependency resolver found a solution, otherwise false. 53 :rtype: bool 54 55.. c:function:: void pkgconf_queue_apply(pkgconf_client_t *client, pkgconf_list_t *list, pkgconf_queue_apply_func_t func, int maxdepth, void *data) 56 57 Attempt to compile a dependency resolution queue into a dependency resolution problem, then attempt to solve the problem and 58 feed the solution to a callback function if a complete dependency graph is found. 59 60 This function should not be used in new code. Use pkgconf_queue_solve instead. 61 62 :param pkgconf_client_t* client: The pkgconf client object to use for dependency resolution. 63 :param pkgconf_list_t* list: The list of dependency requests to consider. 64 :param pkgconf_queue_apply_func_t func: The callback function to call if a solution is found by the dependency resolver. 65 :param int maxdepth: The maximum allowed depth for the dependency resolver. A depth of -1 means unlimited. 66 :param void* data: An opaque pointer which is passed to the callback function. 67 :returns: true if the dependency resolver found a solution, otherwise false. 68 :rtype: bool 69 70.. c:function:: void pkgconf_queue_validate(pkgconf_client_t *client, pkgconf_list_t *list, pkgconf_queue_apply_func_t func, int maxdepth, void *data) 71 72 Attempt to compile a dependency resolution queue into a dependency resolution problem, then attempt to solve the problem. 73 74 :param pkgconf_client_t* client: The pkgconf client object to use for dependency resolution. 75 :param pkgconf_list_t* list: The list of dependency requests to consider. 76 :param int maxdepth: The maximum allowed depth for the dependency resolver. A depth of -1 means unlimited. 77 :returns: true if the dependency resolver found a solution, otherwise false. 78 :rtype: bool 79