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
|
/*
* This file is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2,
* as published by the Free Software Foundation.
*
* In addition to the permissions in the GNU General Public License,
* the authors give you unlimited permission to link the compiled
* version of this file into combinations with other programs,
* and to distribute those combinations without any restriction
* coming from the use of this file. (The General Public License
* restrictions do apply in other respects; for example, they cover
* modification of the file, and distribution when not linked into
* a combined executable.)
*
* This file is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef INCLUDE_git_revwalk_h__
#define INCLUDE_git_revwalk_h__
#include "common.h"
#include "odb.h"
#include "commit.h"
/**
* @file git/revwalk.h
* @brief Git revision traversal routines
* @defgroup git_revwalk Git revision traversal routines
* @ingroup Git
* @{
*/
GIT_BEGIN_DECL
/**
* Allocate a new revision traversal pool.
*
* The configuration is copied during allocation. Changes
* to the configuration after allocation do not affect the pool
* returned by this function. Callers may safely free the
* passed configuration after the function completes.
*
* @param db the database objects are read from.
* @return the new traversal handle; NULL if memory is exhausted.
*/
GIT_EXTERN(git_revpool*) gitrp_alloc(git_odb *db);
/**
* Reset the traversal machinary for reuse.
* @param pool traversal handle to reset.
*/
GIT_EXTERN(void) gitrp_reset(git_revpool *pool);
/**
* Mark an object to start traversal from.
* @param pool the pool being used for the traversal.
* @param commit the commit the commit to start from.
*/
GIT_EXTERN(void) gitrp_push(git_revpool *pool, git_commit *commit);
/**
* Mark a commit (and its ancestors) uninteresting for the output.
* @param pool the pool being used for the traversal.
* @param commit the commit the commit to start from.
*/
GIT_EXTERN(void) gitrp_hide(git_revpool *pool, git_commit *commit);
/**
* Get the next commit from the revision traversal.
* @param pool the pool to pop the commit from.
* @return next commit; NULL if there is no more output.
*/
GIT_EXTERN(git_commit*) gitrp_next(git_revpool *pool);
/**
* Free a revwalk previously allocated.
* @param pool traversal handle to close. If NULL nothing occurs.
*/
GIT_EXTERN(void) gitrp_free(git_revpool *pool);
/** @} */
GIT_END_DECL
#endif
|
