summaryrefslogtreecommitdiff
path: root/src/buildtool/file_system/git_utils.hpp
blob: 5749c8b5df78931bf1a20a98d43b7bffd6d737fc (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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright 2022 Huawei Cloud Computing Technology Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef INCLUDED_SRC_BUILDTOOL_FILE_SYSTEM_GIT_UTILS_HPP
#define INCLUDED_SRC_BUILDTOOL_FILE_SYSTEM_GIT_UTILS_HPP

#include <optional>

#include "gsl-lite/gsl-lite.hpp"
#include "src/buildtool/file_system/object_type.hpp"

extern "C" {
struct git_oid;
struct git_odb;
struct git_repository;
struct git_tree;
struct git_treebuilder;
struct git_index;
struct git_strarray;
struct git_signature;
struct git_object;
struct git_remote;
struct git_commit;
struct git_tree_entry;
struct git_config;
}

// time in ms between tries for git locks
constexpr std::size_t kGitLockWaitTime{100};
// number of retries for git locks
constexpr std::size_t kGitLockNumTries{10};

[[nodiscard]] auto GitObjectID(std::string const& id,
                               bool is_hex_id = false) noexcept
    -> std::optional<git_oid>;

/// \brief Retrieve error message of last libgit2 call.
[[nodiscard]] auto GitLastError() noexcept -> std::string;

void repo_closer(gsl::owner<git_repository*> repo);

void odb_closer(gsl::owner<git_odb*> odb);

void tree_closer(gsl::owner<git_tree*> tree);

void treebuilder_closer(gsl::owner<git_treebuilder*> builder);

void index_closer(gsl::owner<git_index*> index);

// to be used for strarrays allocated by libgit2
void strarray_closer(gsl::owner<git_strarray*> strarray);

// to be used for strarrays allocated manually
void strarray_deleter(gsl::owner<git_strarray*> strarray);

void signature_closer(gsl::owner<git_signature*> signature);

void object_closer(gsl::owner<git_object*> object);

void remote_closer(gsl::owner<git_remote*> remote);

void commit_closer(gsl::owner<git_commit*> commit);

void tree_entry_closer(gsl::owner<git_tree_entry*> tree_entry);

void config_closer(gsl::owner<git_config*> cfg);

#endif  // INCLUDED_SRC_BUILDTOOL_FILE_SYSTEM_GIT_UTILS_HPP