aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-unpack.hxx
blob: 1ae38068df87ce1703fd0a2f81784468b524c25a (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-unpack.hxx -*- C++ -*-
// copyright : Copyright (c) 2014-2019 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#ifndef BPKG_PKG_UNPACK_HXX
#define BPKG_PKG_UNPACK_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-unpack-options.hxx>

namespace bpkg
{
  int
  pkg_unpack (const pkg_unpack_options&, cli::scanner& args);

  // Unpack the package as a source directory and commit the transaction. Can
  // return a new selected package object, replacing the existing one.
  //
  shared_ptr<selected_package>
  pkg_unpack (const common_options&,
              const dir_path& configuration,
              transaction&,
              const dir_path&,
              bool replace,
              bool purge,
              bool simulate);

  // Unpack the fetched package and commit the transaction.
  //
  shared_ptr<selected_package>
  pkg_unpack (const common_options&,
              const dir_path& configuration,
              transaction&,
              const package_name&,
              bool simulate);

  // Unpack the package as a source directory from a directory-based
  // repository and commit the transaction. Can return a new selected package
  // object, replacing the existing one.
  //
  shared_ptr<selected_package>
  pkg_unpack (const common_options&,
              const dir_path& configuration,
              transaction&,
              package_name,
              version,
              bool replace,
              bool simulate);
}

#endif // BPKG_PKG_UNPACK_HXX