FilesExpand file tree

development

/

revwalk.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

260 lines (236 loc) · 7.4 KB

development

/

revwalk.h

Copy path

Top

File metadata and controls

• Code
• Blame

260 lines (236 loc) · 7.4 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

/*

* Copyright (C) the libgit2 contributors. All rights reserved.

*

* This file is part of libgit2, distributed under the GNU GPL v2 with

* a Linking Exception. For full terms see the included COPYING file.

*/

#ifndef INCLUDE_git_revwalk_h__

#define INCLUDE_git_revwalk_h__

#include "common.h"

#include "types.h"

#include "oid.h"

/**

* @file git2/revwalk.h

* @brief Git revision traversal routines

* @defgroup git_revwalk Git revision traversal routines

* @ingroup Git

* @{

*/

GIT_BEGIN_DECL

/**

* Sort the repository contents in no particular ordering;

* this sorting is arbitrary, implementation-specific

* and subject to change at any time.

* This is the default sorting for new walkers.

*/

#define GIT_SORT_NONE (0)

/**

* Sort the repository contents in topological order

* (parents before children); this sorting mode

* can be combined with time sorting.

*/

#define GIT_SORT_TOPOLOGICAL (1 << 0)

/**

* Sort the repository contents by commit time;

* this sorting mode can be combined with

* topological sorting.

*/

#define GIT_SORT_TIME (1 << 1)

/**

* Iterate through the repository contents in reverse

* order; this sorting mode can be combined with

* any of the above.

*/

#define GIT_SORT_REVERSE (1 << 2)

/**

* Allocate a new revision walker to iterate through a repo.

*

* This revision walker uses a custom memory pool and an internal

* commit cache, so it is relatively expensive to allocate.

*

* For maximum performance, this revision walker should be

* reused for different walks.

*

* This revision walker is *not* thread safe: it may only be

* used to walk a repository on a single thread; however,

* it is possible to have several revision walkers in

* several different threads walking the same repository.

*

* @param out pointer to the new revision walker

* @param repo the repo to walk through

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_new(git_revwalk **out, git_repository *repo);

/**

* Reset the revision walker for reuse.

*

* This will clear all the pushed and hidden commits, and

* leave the walker in a blank state (just like at

* creation) ready to receive new commit pushes and

* start a new walk.

*

* The revision walk is automatically reset when a walk

* is over.

*

* @param walker handle to reset.

*/

GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker);

/**

* Mark a commit to start traversal from.

*

* The given OID must belong to a commit on the walked

* repository.

*

* The given commit will be used as one of the roots

* when starting the revision walk. At least one commit

* must be pushed onto the walker before a walk can

* be started.

*

* @param walk the walker being used for the traversal.

* @param id the oid of the commit to start from.

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *id);

/**

* Push matching references

*

* The OIDs pointed to by the references that match the given glob

* pattern will be pushed to the revision walker.

*

* A leading 'refs/' is implied if not present as well as a trailing

* '/ *' if the glob lacks '?', '*' or '['.

*

* @param walk the walker being used for the traversal

* @param glob the glob pattern references should match

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_push_glob(git_revwalk *walk, const char *glob);

/**

* Push the repository's HEAD

*

* @param walk the walker being used for the traversal

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_push_head(git_revwalk *walk);

/**

* Mark a commit (and its ancestors) uninteresting for the output.

*

* The given OID must belong to a commit on the walked

* repository.

*

* The resolved commit and all its parents will be hidden from the

* output on the revision walk.

*

* @param walk the walker being used for the traversal.

* @param commit_id the oid of commit that will be ignored during the traversal

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_hide(git_revwalk *walk, const git_oid *commit_id);

/**

* Hide matching references.

*

* The OIDs pointed to by the references that match the given glob

* pattern and their ancestors will be hidden from the output on the

* revision walk.

*

* A leading 'refs/' is implied if not present as well as a trailing

* '/ *' if the glob lacks '?', '*' or '['.

*

* @param walk the walker being used for the traversal

* @param glob the glob pattern references should match

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_hide_glob(git_revwalk *walk, const char *glob);

/**

* Hide the repository's HEAD

*

* @param walk the walker being used for the traversal

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_hide_head(git_revwalk *walk);

/**

* Push the OID pointed to by a reference

*

* The reference must point to a commit.

*

* @param walk the walker being used for the traversal

* @param refname the reference to push

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_push_ref(git_revwalk *walk, const char *refname);

/**

* Hide the OID pointed to by a reference

*

* The reference must point to a commit.

*

* @param walk the walker being used for the traversal

* @param refname the reference to hide

* @return 0 or an error code

*/

GIT_EXTERN(int) git_revwalk_hide_ref(git_revwalk *walk, const char *refname);

/**

* Get the next commit from the revision walk.

*

* The initial call to this method is *not* blocking when

* iterating through a repo with a time-sorting mode.

*

* Iterating with Topological or inverted modes makes the initial

* call blocking to preprocess the commit list, but this block should be

* mostly unnoticeable on most repositories (topological preprocessing

* times at 0.3s on the git.git repo).

*

* The revision walker is reset when the walk is over.

*

* @param out Pointer where to store the oid of the next commit

* @param walk the walker to pop the commit from.

* @return 0 if the next commit was found;

* GIT_ITEROVER if there are no commits left to iterate

*/

GIT_EXTERN(int) git_revwalk_next(git_oid *out, git_revwalk *walk);

/**

* Change the sorting mode when iterating through the

* repository's contents.

*

* Changing the sorting mode resets the walker.

*

* @param walk the walker being used for the traversal.

* @param sort_mode combination of GIT_SORT_XXX flags

*/

GIT_EXTERN(void) git_revwalk_sorting(git_revwalk *walk, unsigned int sort_mode);

/**

* Push and hide the respective endpoints of the given range.

*

* The range should be of the form

* <commit>..<commit>

* where each <commit> is in the form accepted by 'git_revparse_single'.

* The left-hand commit will be hidden and the right-hand commit pushed.

*

* @param walk the walker being used for the traversal

* @param range the range

* @return 0 or an error code

*

*/

GIT_EXTERN(int) git_revwalk_push_range(git_revwalk *walk, const char *range);

/**

* Simplify the history by first-parent

*

* No parents other than the first for each commit will be enqueued.

*/

GIT_EXTERN(void) git_revwalk_simplify_first_parent(git_revwalk *walk);

/**

* Free a revision walker previously allocated.

*

* @param walk traversal handle to close. If NULL nothing occurs.

*/

GIT_EXTERN(void) git_revwalk_free(git_revwalk *walk);

/**

* Return the repository on which this walker

* is operating.

*

* @param walk the revision walker

* @return the repository being walked

*/

GIT_EXTERN(git_repository *) git_revwalk_repository(git_revwalk *walk);

/** @} */

GIT_END_DECL

#endif