1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
// file : bpkg/pkg-configure.hxx -*- C++ -*-
// license : MIT; see accompanying LICENSE file
#ifndef BPKG_PKG_CONFIGURE_HXX
#define BPKG_PKG_CONFIGURE_HXX
#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
{
int
pkg_configure (const pkg_configure_options&, cli::scanner& args);
// 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 common_options&,
database&,
transaction&,
const shared_ptr<selected_package>&,
configure_prerequisites_result&&,
const unique_ptr<build2::context>&,
const build2::variable_overrides&,
bool simulate);
// Create a build context suitable for configuring packages.
//
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
|
