forked from git/git
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathapi-tree-walking.html
More file actions
583 lines (546 loc) · 11.7 KB
/
Copy pathapi-tree-walking.html
File metadata and controls
583 lines (546 loc) · 11.7 KB
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.5" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
div.olist2 ol {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>tree walking API</title>
</head>
<body>
<div id="header">
<h1>tree walking API</h1>
</div>
<div id="preamble">
<div class="sectionbody">
<div class="para"><p>The tree walking API is used to traverse and inspect trees.</p></div>
</div>
</div>
<h2 id="_data_structures">Data Structures</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
<tt>struct name_entry</tt>
</dt>
<dd>
<p>
An entry in a tree. Each entry has a sha1 identifier, pathname, and
mode.
</p>
</dd>
<dt>
<tt>struct tree_desc</tt>
</dt>
<dd>
<p>
A semi-opaque data structure used to maintain the current state of the
walk.
</p>
<div class="ilist"><ul>
<li>
<p>
<tt>buffer</tt> is a pointer into the memory representation of the tree. It always
points at the current entry being visited.
</p>
</li>
<li>
<p>
<tt>size</tt> counts the number of bytes left in the <tt>buffer</tt>.
</p>
</li>
<li>
<p>
<tt>entry</tt> points to the current entry being visited.
</p>
</li>
</ul></div>
</dd>
<dt>
<tt>struct traverse_info</tt>
</dt>
<dd>
<p>
A structure used to maintain the state of a traversal.
</p>
<div class="ilist"><ul>
<li>
<p>
<tt>prev</tt> points to the traverse_info which was used to descend into the
current tree. If this is the top-level tree <tt>prev</tt> will point to
a dummy traverse_info.
</p>
</li>
<li>
<p>
<tt>name</tt> is the entry for the current tree (if the tree is a subtree).
</p>
</li>
<li>
<p>
<tt>pathlen</tt> is the length of the full path for the current tree.
</p>
</li>
<li>
<p>
<tt>conflicts</tt> can be used by callbacks to maintain directory-file conflicts.
</p>
</li>
<li>
<p>
<tt>fn</tt> is a callback called for each entry in the tree. See Traversing for more
information.
</p>
</li>
<li>
<p>
<tt>data</tt> can be anything the <tt>fn</tt> callback would want to use.
</p>
</li>
<li>
<p>
<tt>show_all_errors</tt> tells whether to stop at the first error or not.
</p>
</li>
</ul></div>
</dd>
</dl></div>
</div>
<h2 id="_initializing">Initializing</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
<tt>init_tree_desc</tt>
</dt>
<dd>
<p>
Initialize a <tt>tree_desc</tt> and decode its first entry. The buffer and
size parameters are assumed to be the same as the buffer and size
members of <tt>struct tree</tt>.
</p>
</dd>
<dt>
<tt>fill_tree_descriptor</tt>
</dt>
<dd>
<p>
Initialize a <tt>tree_desc</tt> and decode its first entry given the sha1 of
a tree. Returns the <tt>buffer</tt> member if the sha1 is a valid tree
identifier and NULL otherwise.
</p>
</dd>
<dt>
<tt>setup_traverse_info</tt>
</dt>
<dd>
<p>
Initialize a <tt>traverse_info</tt> given the pathname of the tree to start
traversing from. The <tt>base</tt> argument is assumed to be the <tt>path</tt>
member of the <tt>name_entry</tt> being recursed into unless the tree is a
top-level tree in which case the empty string ("") is used.
</p>
</dd>
</dl></div>
</div>
<h2 id="_walking">Walking</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
<tt>tree_entry</tt>
</dt>
<dd>
<p>
Visit the next entry in a tree. Returns 1 when there are more entries
left to visit and 0 when all entries have been visited. This is
commonly used in the test of a while loop.
</p>
</dd>
<dt>
<tt>tree_entry_len</tt>
</dt>
<dd>
<p>
Calculate the length of a tree entry's pathname. This utilizes the
memory structure of a tree entry to avoid the overhead of using a
generic strlen().
</p>
</dd>
<dt>
<tt>update_tree_entry</tt>
</dt>
<dd>
<p>
Walk to the next entry in a tree. This is commonly used in conjunction
with <tt>tree_entry_extract</tt> to inspect the current entry.
</p>
</dd>
<dt>
<tt>tree_entry_extract</tt>
</dt>
<dd>
<p>
Decode the entry currently being visited (the one pointed to by
<tt>tree_desc's</tt> <tt>entry</tt> member) and return the sha1 of the entry. The
<tt>pathp</tt> and <tt>modep</tt> arguments are set to the entry's pathname and mode
respectively.
</p>
</dd>
<dt>
<tt>get_tree_entry</tt>
</dt>
<dd>
<p>
Find an entry in a tree given a pathname and the sha1 of a tree to
search. Returns 0 if the entry is found and -1 otherwise. The third
and fourth parameters are set to the entry's sha1 and mode
respectively.
</p>
</dd>
</dl></div>
</div>
<h2 id="_traversing">Traversing</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
<tt>traverse_trees</tt>
</dt>
<dd>
<p>
Traverse <tt>n</tt> number of trees in parallel. The <tt>fn</tt> callback member of
<tt>traverse_info</tt> is called once for each tree entry.
</p>
</dd>
<dt>
<tt>traverse_callback_t</tt>
</dt>
<dd>
<p>
The arguments passed to the traverse callback are as follows:
</p>
<div class="ilist"><ul>
<li>
<p>
<tt>n</tt> counts the number of trees being traversed.
</p>
</li>
<li>
<p>
<tt>mask</tt> has its nth bit set if something exists in the nth entry.
</p>
</li>
<li>
<p>
<tt>dirmask</tt> has its nth bit set if the nth tree's entry is a directory.
</p>
</li>
<li>
<p>
<tt>entry</tt> is an array of size <tt>n</tt> where the nth entry is from the nth tree.
</p>
</li>
<li>
<p>
<tt>info</tt> maintains the state of the traversal.
</p>
</li>
</ul></div>
<div class="para"><p>Returning a negative value will terminate the traversal. Otherwise the
return value is treated as an update mask. If the nth bit is set the nth tree
will be updated and if the bit is not set the nth tree entry will be the
same in the next callback invocation.</p></div>
</dd>
<dt>
<tt>make_traverse_path</tt>
</dt>
<dd>
<p>
Generate the full pathname of a tree entry based from the root of the
traversal. For example, if the traversal has recursed into another
tree named "bar" the pathname of an entry "baz" in the "bar"
tree would be "bar/baz".
</p>
</dd>
<dt>
<tt>traverse_path_len</tt>
</dt>
<dd>
<p>
Calculate the length of a pathname returned by <tt>make_traverse_path</tt>.
This utilizes the memory structure of a tree entry to avoid the
overhead of using a generic strlen().
</p>
</dd>
</dl></div>
</div>
<h2 id="_authors">Authors</h2>
<div class="sectionbody">
<div class="para"><p>Written by Junio C Hamano <gitster@pobox.com> and Linus Torvalds
<torvalds@linux-foundation.org></p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2010-09-18 23:57:15 UTC
</div>
</div>
</body>
</html>