aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-fetch.hxx
blob: 86071784b6c1fc046a6cde5f6c7b509d0f9ffe4e (plain)
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
// file      : bpkg/pkg-fetch.hxx -*- C++ -*-
// license   : MIT; see accompanying LICENSE file

#ifndef BPKG_PKG_FETCH_HXX
#define BPKG_PKG_FETCH_HXX

#include <libbpkg/manifest.hxx>     // version
#include <libbpkg/package-name.hxx>

#include <bpkg/types.hxx>
#include <bpkg/forward.hxx> // transaction, selected_package
#include <bpkg/utility.hxx>

#include <bpkg/pkg-fetch-options.hxx>

namespace bpkg
{
  int
  pkg_fetch (const pkg_fetch_options&, cli::scanner& args);

  // Fetch the package as an archive file and commit the transaction. Return
  // the selected package object which may replace the existing one.
  //
  shared_ptr<selected_package>
  pkg_fetch (const common_options&,
             database&,
             transaction&,
             path archive,
             bool replace,
             bool purge,
             bool simulate);

  // Fetch the package from an archive-based repository and commit the
  // transaction. Return the selected package object which may replace the
  // existing one.
  //
  // Note that both package and repository information configurations need to
  // be passed.
  //
  // Also note that it should be called in session.
  //
  shared_ptr<selected_package>
  pkg_fetch (const common_options&,
             database& pdb,
             database& rdb,
             transaction&,
             package_name,
             version,
             bool replace,
             bool simulate);

  pkg_fetch_options
  merge_options (const default_options<pkg_fetch_options>&,
                 const pkg_fetch_options&);
}

#endif // BPKG_PKG_FETCH_HXX