Commit 061605020c8f212d696a2a3d28e20c7091c09443

Shawn O. Pearce 2008-10-31T12:30:28

Take the first stab at defining revision traversal Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
diff --git a/Makefile b/Makefile
index 662a69f..116caa6 100644
--- a/Makefile
+++ b/Makefile
@@ -3,7 +3,9 @@ all::
 DOXYGEN = doxygen
 
 CFLAGS = -g -O2
-BASIC_CFLAGS = -Isrc
+
+BASIC_CFLAGS := -Isrc
+BASIC_CFLAGS += -DGIT__PRIVATE
 
 OBJS = $(patsubst %.c,%.o,$(wildcard src/*.c))
 HDRS = $(wildcard src/*.h)
diff --git a/src/git_commit.c b/src/git_commit.c
new file mode 100644
index 0000000..ed6e85b
--- /dev/null
+++ b/src/git_commit.c
@@ -0,0 +1,41 @@
+/*
+ * 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.
+ */
+
+#include "git_commit.h"
+
+const git_oid_t *git_commit_id(git_commit_t *c)
+{
+	return &c->id;
+}
diff --git a/src/git_commit.h b/src/git_commit.h
new file mode 100644
index 0000000..05bf671
--- /dev/null
+++ b/src/git_commit.h
@@ -0,0 +1,92 @@
+/*
+ * 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_commit_h__
+#define INCLUDE_git_commit_h__
+
+#include "git_common.h"
+#include "git_oid.h"
+#include <time.h>
+
+/**
+ * @file git_commit.h
+ * @brief Git commit parsing, formatting routines
+ * @defgroup git_commit Git commit parsing, formatting routines
+ * @ingroup Git
+ * @{
+ */
+GIT_BEGIN_DECL
+
+/** Parsed representation of a commit object. */
+typedef struct git_commit_t git_commit_t;
+#ifdef GIT__PRIVATE
+struct git_commit_t {
+	git_oid_t id;
+	time_t commit_time;
+	unsigned parsed:1,
+	         flags:26;
+};
+#endif
+
+/**
+ * Parse (or lookup) a commit from a revision pool.
+ * @param pool the pool to use when parsing/caching the commit.
+ * @param id identity of the commit to locate.  If the object is
+ *        an annotated tag it will be peeled back to the commit.
+ * @return the commit; NULL if the commit does not exist in the
+ *         pool's git_odb_t, or if the commit is present but is
+ *         too malformed to be parsed successfully.
+ */
+GIT_EXTERN(git_commit_t*) git_commit_parse(git_revp_t *pool, const git_oid_t *id);
+
+/**
+ * Get the id of a commit.
+ * @param commit a previously parsed commit.
+ * @return object identity for the commit.
+ */
+GIT_EXTERN(const git_oid_t*) git_commit_id(git_commit_t *commit);
+
+/**
+ * Get the application data address.
+ * @param commit a previously parsed commit.
+ * @return address of the application's data buffer.
+ *         Applications should cast to something like
+ *         'struct mydata*' in order to access fields.
+ */
+GIT_EXTERN(void*) git_commit_appdata(git_commit_t *commit);
+
+/** @} */
+GIT_END_DECL
+#endif
diff --git a/src/git_common.h b/src/git_common.h
index f5121b1..6e19d89 100644
--- a/src/git_common.h
+++ b/src/git_common.h
@@ -78,6 +78,9 @@ typedef int git_result_t;
 /** Input does not exist in the scope searched. */
 #define GIT_ENOTFOUND (GIT_ERROR - 2)
 
+/** A revision traversal pool. */
+typedef struct git_revp_t git_revp_t;
+
 /** @} */
 GIT_END_DECL
 #endif
diff --git a/src/git_revwalk.c b/src/git_revwalk.c
new file mode 100644
index 0000000..7b7d17f
--- /dev/null
+++ b/src/git_revwalk.c
@@ -0,0 +1,71 @@
+/*
+ * 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.
+ */
+
+#include "git_revwalk.h"
+#include <stdlib.h>
+#include <string.h>
+
+struct git_revp_attr_t {
+	size_t app_size;
+	git_result_t (*app_init)(git_commit_t *, void *);
+};
+
+struct git_revp_t {
+	git_odb_t *db;
+	git_revp_attr_t attr;
+};
+
+
+git_revp_t *git_revp_alloc(
+	git_odb_t *db,
+	const git_revp_attr_t *attr)
+{
+	git_revp_t *walk = malloc(sizeof(*walk));
+	if (!walk)
+		return NULL;
+
+	walk->db = db;
+	if (attr)
+		memcpy(&walk->attr, attr, sizeof(walk->attr));
+	else
+		memset(&walk->attr, 0, sizeof(walk->attr));
+
+	return walk;
+}
+
+void git_revp_free(git_revp_t *walk)
+{
+	free(walk);
+}
diff --git a/src/git_revwalk.h b/src/git_revwalk.h
new file mode 100644
index 0000000..a84d130
--- /dev/null
+++ b/src/git_revwalk.h
@@ -0,0 +1,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