Hash :
06160502
Author :
Date :
2008-10-31T12:30:28
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
/*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Git Development Community nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef INCLUDE_git_revwalk_h__
#define INCLUDE_git_revwalk_h__
#include "git_common.h"
#include "git_odb.h"
#include "git_commit.h"
/**
* @file git_revwalk.h
* @brief Git revision traversal routines
* @defgroup git_revwalk Git revision traversal routines
* @ingroup Git
* @{
*/
GIT_BEGIN_DECL
/** Configuration of a revision pool. */
typedef struct git_revp_attr_t git_revp_attr_t;
/**
* Allocate an empty pool configuration.
*
* The resulting configuration is identical to passing NULL
* to git_revp_alloc().
*
* @return a new configuration block.
* NULL if there is insufficient memory.
*/
GIT_EXTERN(git_revp_attr_t*) git_revp_attr_alloc(void);
/**
* Setup the application's per-commit data allocation.
*
* If size is non-zero the requested number of bytes is allocated
* alongside every git_commit_t used by the revision pool, allowing
* constant-time access to per-commit application data.
*
* If init is not NULL the function is invoked with the commit and
* the application data pointer, allowing the function to populate
* the application's data space the first time the commit is parsed
* into the pool. Space available within the application data is
* not initialized. Subsequent resets do not invoke this method.
*
* If init is NULL and size is non-zero the application data space
* is cleared during the first parse.
*
* @param attr the pool configuration to adjust.
* @param size number of bytes required by the application on
* each rev_commit_t instance within the pool.
* @param init optional callback function to initialize the
* application data space. If NULL the application
* space will be zeroed. If supplied the application
* space may contain random garbage.
*/
GIT_EXTERN(void) git_revp_attr_appdata(
git_revp_attr_t *attr,
size_t size,
git_result_t (*init)(git_commit_t *, void *));
/**
* Free a pool configuration.
* @param attr the configuration to free. No-op if NULL.
*/
GIT_EXTERN(void) git_revp_attr_free(git_revp_attr_t *attr);
/**
* 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.
* @param attr configuration for the pool.
* NULL to use a default configuration.
* @return the new traversal handle; NULL if memory is exhausted.
*/
GIT_EXTERN(git_revp_t*) git_revp_alloc(
git_odb_t *db,
const git_revp_attr_t *attr);
/**
* Reset the traversal machinary for reuse.
* @param pool traversal handle to reset.
*/
GIT_EXTERN(void) git_revp_reset(git_revp_t *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) git_revp_pushc(git_revp_t *pool, git_commit_t *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) git_revp_hidec(git_revp_t *pool, git_commit_t *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_t*) git_revp_nextc(git_revp_t *pool);
/**
* Free a revwalk previously allocated.
* @param pool traversal handle to close. If NULL nothing occurs.
*/
GIT_EXTERN(void) git_revp_free(git_revp_t *pool);
/** @} */
GIT_END_DECL
#endif