diff options
Diffstat (limited to 'bpkg/pkg-configure.hxx')
| -rw-r--r-- | bpkg/pkg-configure.hxx | 179 |
1 files changed, 159 insertions, 20 deletions
diff --git a/bpkg/pkg-configure.hxx b/bpkg/pkg-configure.hxx index b708df5..cd74786 100644 --- a/bpkg/pkg-configure.hxx +++ b/bpkg/pkg-configure.hxx @@ -7,12 +7,16 @@ #include <libbpkg/manifest.hxx> // version #include <libbpkg/package-name.hxx> +#include <libbuild2/context.hxx> +#include <libbuild2/variable.hxx> // variable_overrides + #include <bpkg/types.hxx> #include <bpkg/forward.hxx> // transaction, selected_package #include <bpkg/utility.hxx> #include <bpkg/package.hxx> // package_prerequisites, // dependencies. +#include <bpkg/package-skeleton.hxx> #include <bpkg/pkg-configure-options.hxx> namespace bpkg @@ -20,35 +24,170 @@ namespace bpkg int pkg_configure (const pkg_configure_options&, cli::scanner& args); - // Note: all of the following functions expect the package dependency - // constraints to be complete. + // Configure a system package and commit the transaction. + // + shared_ptr<selected_package> + pkg_configure_system (const package_name&, + const version&, + database&, + transaction&); + + // The custom search function. If specified, it is called by pkg_configure() + // to obtain the database to search for the prerequisite in, instead of + // searching for it in the linked databases, recursively. If the function + // returns NULL, then fallback to the recursive search through the linked + // databases. + // + using find_database_function = database* (database&, + const package_name&, + bool buildtime); + + // Given dependencies of a package, return its prerequisite packages, + // 1-based indexes of the selected dependency alternatives (0 for toolchain + // build-time dependencies, etc), configuration variables that resulted from + // selection of these prerequisites (import, reflection, etc), and sources + // of the configuration variables resulted from evaluating the reflect + // clauses. Fail if for some of the dependency alternative lists there is no + // satisfactory alternative (all its dependencies are configured, satisfy + // the respective constraints, etc). + // + // The package dependency constraints are expected to be complete. + // + // The dependencies argument may contain pre-selected dependency + // alternatives (with the potential empty entries for the toolchain + // build-time dependencies or for dependencies with all the alternatives + // disabled; see pkg-build for the use-case). In this case the number of + // dependency alternatives for each dependency must be 1 (or 0) and the + // alternatives argument must be specified. The alternatives argument must + // be parallel to the dependencies argument and specify indexes of the + // selected alternatives. + // + // If the dependency alternatives are not pre-selected (alternatives == + // NULL), then for each depends value select the first satisfactory + // alternative encountered. If, however, prerequisites corresponding to the + // previous configured state of the package are specified + // (prev_prerequisites != NULL), then for each depends value try to select + // an alternative where dependencies all belong to this list (the "recreate + // dependency decisions" mode). Failed that, select an alternative as if no + // prerequisites are specified (the "make dependency decisions" mode). + // + // Note that there are actually 3 possible use cases for + // pkg_configure_prerequisites(): + // + // - The package is being configured manually. In this case its dependency + // alternatives are not pre-selected and there is no information about its + // previous configured state (alternatives == NULL, prev_prerequisites == + // NULL). + // + // - The package is being built, upgraded, or re-evaluated. In this case its + // dependency alternatives are pre-selected, their enable, prefer, and + // require clauses are evaluated, and there is no need in the previous + // configured state information (alternatives != NULL, prev_prerequisites + // == NULL). + // + // - The package is being reconfigured for a reason other than any of the + // mentioned above (dependency up/down-grade/reconfiguration, deorphaning, + // pkg-build --disfigure is specified, etc). In this case its dependency + // alternatives are not pre-selected but the previous configured state + // information is provided (alternatives == NULL, prev_prerequisites != + // NULL). + // + // - There are no use cases when both dependency alternatives are + // pre-selected and the previous configured state information needs to be + // provided. Thus, alternatives and prev_prerequisites must never be both + // NULL. + // + // Optionally, remove constraints from the specified dependencies + // (unconstrain_deps). Only allowed in the simulation mode. + // + struct configure_prerequisites_result + { + package_prerequisites prerequisites; + vector<size_t> dependency_alternatives; + strings config_variables; // Note: name and value. + + // Only contains sources of configuration variables collected using the + // package skeleton, excluding those user-specified variables which are + // not the project variables for the specified package (module + // configuration variables, etc). Thus, it is not parallel to the + // config_variables member. + // + vector<config_variable> config_sources; // Note: name and source. + + // SHA256 checksum of variables (names and values) referred to by the + // config_sources member. + // + string config_checksum; + }; + + // Return the "would be" state for packages that would be configured + // by this stage. + // + using find_package_state_function = + optional<pair<package_state, package_substate>> ( + const shared_ptr<selected_package>&); + + // Note: loads selected packages. + // + configure_prerequisites_result + pkg_configure_prerequisites ( + const common_options&, + database&, + transaction&, + const dependencies&, + const vector<size_t>* alternatives, + package_skeleton&&, + const vector<package_name>* prev_prerequisites, + bool simulate, + const function<find_database_function>&, + const function<find_package_state_function>&, + const vector<package_key>* unconstrain_deps = nullptr); // Configure the package, update its state, and commit the transaction. // + // This is a lower-level version meant for sharing the same build context + // to configure multiple packages (in the dependency order). + // + // Note: variable_overrides must include config.config.disfigure, if + // required. + // + // Note: expects all the non-external packages to be configured to be + // already unpacked (for subproject discovery). + // void - pkg_configure (const dir_path& configuration, - const common_options&, + pkg_configure (const common_options&, + database&, transaction&, const shared_ptr<selected_package>&, - const dependencies&, - const strings& config_vars, + configure_prerequisites_result&&, + const unique_ptr<build2::context>&, + const build2::variable_overrides&, bool simulate); - // Configure a system package and commit the transaction. + // Create a build context suitable for configuring packages. // - shared_ptr<selected_package> - pkg_configure_system (const package_name&, const version&, transaction&); - - // Return package prerequisites given its dependencies. Fail if some of the - // prerequisites are not configured or don't satisfy the package's - // dependency constraints. Note that the package argument is used for - // diagnostics only. - // - package_prerequisites - pkg_configure_prerequisites (const common_options&, - transaction&, - const dependencies&, - const package_name&); + unique_ptr<build2::context> + pkg_configure_context ( + const common_options&, + strings&& cmd_vars, + const function<build2::context::var_override_function>& = nullptr); + + // This is a higher-level version meant for configuring a single package. + // + // Note: loads selected packages. + // + void + pkg_configure (const common_options&, + database&, + transaction&, + const shared_ptr<selected_package>&, + const dependencies&, + const vector<size_t>* alternatives, + package_skeleton&&, + const vector<package_name>* prev_prerequisites, + bool disfigured, + bool simulate, + const function<find_database_function>& = {}); } #endif // BPKG_PKG_CONFIGURE_HXX |