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
|
// file : bpkg/pkg-verify.hxx -*- C++ -*-
// license : MIT; see accompanying LICENSE file
#ifndef BPKG_PKG_VERIFY_HXX
#define BPKG_PKG_VERIFY_HXX
#include <libbutl/manifest-forward.hxx>
#include <libbpkg/manifest.hxx>
#include <bpkg/types.hxx>
#include <bpkg/utility.hxx>
#include <bpkg/pkg-verify-options.hxx>
namespace bpkg
{
int
pkg_verify (const pkg_verify_options&, cli::scanner& args);
// Verify archive is a valid package and return its manifest. If requested,
// verify that all manifest entries are recognized and the package is
// compatible with the current toolchain. Also, if requested, expand the
// file-referencing manifest values (description, changes, etc), setting
// them to the contents of files they refer to, set the potentially absent
// description-type value to the effective description type (see
// libbpkg/manifest.hxx), load the bootstrap, root, and config/*.build
// buildfiles into the respective *-build values, and complete the
// manifest values (depends, <distribution>-version, etc).
//
// Throw not_package (derived from failed) if this doesn't look like a
// package. Throw plain failed if this does looks like a package but
// something about it is invalid or if something else goes wrong.
//
// Issue diagnostics according the diag_level as follows:
//
// 0 - Suppress all errors messages except for underlying system errors.
// 1 - Suppress error messages about the reason why this is not a package.
// 2 - Suppress no error messages.
//
class not_package: public failed {};
package_manifest
pkg_verify (const common_options&,
const path& archive,
bool ignore_unknown,
bool ignore_toolchain,
bool expand_values,
bool load_buildfiles,
bool complete_values = true,
int diag_level = 2);
// Similar to the above but verifies that a source directory is a valid
// package. Always translates the package version and completes dependency
// constraints but doesn't expand the file-referencing manifest values. Note
// that it doesn't enforce the <name>-<version> form for the directory
// itself.
//
package_manifest
pkg_verify (const common_options&,
const dir_path& source,
bool ignore_unknown,
bool ignore_toolchain,
bool load_buildfiles,
const function<package_manifest::translate_function>&,
int diag_level = 2);
// Pre-parse the package manifest and return the name value pairs list,
// stripping the format version and the end-of-manifest/stream pairs,
// together with the build2/bpkg build-time dependencies, if present. If
// requested, verify that the package is compatible with the current
// toolchain and issue diagnostics and throw failed if it is not.
//
// Pass through the manifest_parsing and io_error exceptions, so that the
// caller can decide how to handle them (for example, ignore them if the
// manifest-printing process has failed, etc).
//
// To omit the package location from the diagnostics, pass an empty path as
// the what argument.
//
struct pkg_verify_result: vector<butl::manifest_name_value>
{
optional<dependency> build2_dependency;
optional<dependency> bpkg_dependency;
};
pkg_verify_result
pkg_verify (const common_options&,
butl::manifest_parser&,
bool ignore_toolchain,
const path& what,
int diag_level = 2);
}
#endif // BPKG_PKG_VERIFY_HXX
|
