Google Git
Sign in
chromium / external / gitster / git-htmldocs / e5fc3c3d3c68e038cd67539941b9f354a78f7132 / . / technical / api-tree-walking.html
blob: a6b98787b654905a8cb8b05e625aebe1fae1bbc5 [file] [log] [blame]
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]7<title>tree walking API</title>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]30 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]35 color: #083194;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]50h1, h2, h3 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]90 font-size: 1.1em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]91}
92span#email {
93}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]137 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]180 text-align: right;
181}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]182
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]211}
212
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]256
257div.tableblock > table {
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]285
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]286
287div.hdlist {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]293}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]298 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]299 font-style: normal;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]301 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]302}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]303td.hdlist2 {
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]376/* Workarounds for IE6's broken and incomplete CSS2. */
377
378div.sidebar-content {
379 background: #ffffee;
380 border: 1px solid silver;
381 padding: 0.5em;
382}
383div.sidebar-title, div.image-title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]384 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]385 font-family: sans-serif;
386 font-weight: bold;
387 margin-top: 0.0em;
388 margin-bottom: 0.5em;
389}
390
391div.listingblock div.content {
392 border: 1px solid silver;
393 background: #f4f4f4;
394 padding: 0.5em;
395}
396
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]397div.quoteblock-attribution {
398 padding-top: 0.5em;
399 text-align: right;
400}
401
402div.verseblock-content {
403 white-space: pre;
404}
405div.verseblock-attribution {
406 padding-top: 0.75em;
407 text-align: left;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]408}
409
410div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]411 border-left: 3px solid #dddddd;
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]412 padding-left: 0.5em;
413}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]414
415/* IE6 sets dynamically generated links as visited. */
416div#toc a:visited { color: blue; }
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]417</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]418<script type="text/javascript">
419/*<![CDATA[*/
420window.onload = function(){asciidoc.footnotes();}
421var asciidoc = { // Namespace.
422
423/////////////////////////////////////////////////////////////////////
424// Table Of Contents generator
425/////////////////////////////////////////////////////////////////////
426
427/* Author: Mihai Bazon, September 2002
428 * http://students.infoiasi.ro/~mishoo
429 *
430 * Table Of Content generator
431 * Version: 0.4
432 *
433 * Feel free to use this script under the terms of the GNU General Public
434 * License, as long as you do not remove or alter this notice.
435 */
436
437 /* modified by Troy D. Hanson, September 2006. License: GPL */
438 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
439
440// toclevels = 1..4.
441toc: function (toclevels) {
442
443 function getText(el) {
444 var text = "";
445 for (var i = el.firstChild; i != null; i = i.nextSibling) {
446 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
447 text += i.data;
448 else if (i.firstChild != null)
449 text += getText(i);
450 }
451 return text;
452 }
453
454 function TocEntry(el, text, toclevel) {
455 this.element = el;
456 this.text = text;
457 this.toclevel = toclevel;
458 }
459
460 function tocEntries(el, toclevels) {
461 var result = new Array;
462 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
463 // Function that scans the DOM tree for header elements (the DOM2
464 // nodeIterator API would be a better technique but not supported by all
465 // browsers).
466 var iterate = function (el) {
467 for (var i = el.firstChild; i != null; i = i.nextSibling) {
468 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
469 var mo = re.exec(i.tagName);
470 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
471 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
472 }
473 iterate(i);
474 }
475 }
476 }
477 iterate(el);
478 return result;
479 }
480
481 var toc = document.getElementById("toc");
482 var entries = tocEntries(document.getElementById("content"), toclevels);
483 for (var i = 0; i < entries.length; ++i) {
484 var entry = entries[i];
485 if (entry.element.id == "")
486 entry.element.id = "_toc_" + i;
487 var a = document.createElement("a");
488 a.href = "#" + entry.element.id;
489 a.appendChild(document.createTextNode(entry.text));
490 var div = document.createElement("div");
491 div.appendChild(a);
492 div.className = "toclevel" + entry.toclevel;
493 toc.appendChild(div);
494 }
495 if (entries.length == 0)
496 toc.parentNode.removeChild(toc);
497},
498
499
500/////////////////////////////////////////////////////////////////////
501// Footnotes generator
502/////////////////////////////////////////////////////////////////////
503
504/* Based on footnote generation code from:
505 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
506 */
507
508footnotes: function () {
509 var cont = document.getElementById("content");
510 var noteholder = document.getElementById("footnotes");
511 var spans = cont.getElementsByTagName("span");
512 var refs = {};
513 var n = 0;
514 for (i=0; i<spans.length; i++) {
515 if (spans[i].className == "footnote") {
516 n++;
517 // Use [\s\S] in place of . so multi-line matches work.
518 // Because JavaScript has no s (dotall) regex flag.
519 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
520 noteholder.innerHTML +=
521 "<div class='footnote' id='_footnote_" + n + "'>" +
522 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
523 n + "</a>. " + note + "</div>";
524 spans[i].innerHTML =
525 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
526 "' title='View footnote' class='footnote'>" + n + "</a>]";
527 var id =spans[i].getAttribute("id");
528 if (id != null) refs["#"+id] = n;
529 }
530 }
531 if (n == 0)
532 noteholder.parentNode.removeChild(noteholder);
533 else {
534 // Process footnoterefs.
535 for (i=0; i<spans.length; i++) {
536 if (spans[i].className == "footnoteref") {
537 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
538 href = href.match(/#.*/)[0]; // Because IE return full URL.
539 n = refs[href];
540 spans[i].innerHTML =
541 "[<a href='#_footnote_" + n +
542 "' title='View footnote' class='footnote'>" + n + "</a>]";
543 }
544 }
545 }
546}
547
548}
549/*]]>*/
550</script>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]551</head>
552<body>
553<div id="header">
554<h1>tree walking API</h1>
555</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]556<div id="content">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]557<div id="preamble">
558<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]559<div class="paragraph"><p>The tree walking API is used to traverse and inspect trees.</p></div>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]560</div>
561</div>
562<h2 id="_data_structures">Data Structures</h2>
563<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]564<div class="dlist"><dl>
565<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]566<tt>struct name_entry</tt>
567</dt>
568<dd>
569<p>
570 An entry in a tree. Each entry has a sha1 identifier, pathname, and
571 mode.
572</p>
573</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]574<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]575<tt>struct tree_desc</tt>
576</dt>
577<dd>
578<p>
579 A semi-opaque data structure used to maintain the current state of the
580 walk.
581</p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]582<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]583<li>
584<p>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]585<tt>buffer</tt> is a pointer into the memory representation of the tree. It always
586points at the current entry being visited.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]587</p>
588</li>
589<li>
590<p>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]591<tt>size</tt> counts the number of bytes left in the <tt>buffer</tt>.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]592</p>
593</li>
594<li>
595<p>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]596<tt>entry</tt> points to the current entry being visited.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]597</p>
598</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]599</ul></div>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]600</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]601<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]602<tt>struct traverse_info</tt>
603</dt>
604<dd>
605<p>
606 A structure used to maintain the state of a traversal.
607</p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]608<div class="ulist"><ul>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]609<li>
610<p>
611<tt>prev</tt> points to the traverse_info which was used to descend into the
612current tree. If this is the top-level tree <tt>prev</tt> will point to
613a dummy traverse_info.
614</p>
615</li>
616<li>
617<p>
618<tt>name</tt> is the entry for the current tree (if the tree is a subtree).
619</p>
620</li>
621<li>
622<p>
623<tt>pathlen</tt> is the length of the full path for the current tree.
624</p>
625</li>
626<li>
627<p>
628<tt>conflicts</tt> can be used by callbacks to maintain directory-file conflicts.
629</p>
630</li>
631<li>
632<p>
633<tt>fn</tt> is a callback called for each entry in the tree. See Traversing for more
634information.
635</p>
636</li>
637<li>
638<p>
639<tt>data</tt> can be anything the <tt>fn</tt> callback would want to use.
640</p>
641</li>
Junio C Hamano53ba6d02010-08-22 07:25:12[diff] [blame]642<li>
643<p>
644<tt>show_all_errors</tt> tells whether to stop at the first error or not.
645</p>
646</li>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]647</ul></div>
648</dd>
649</dl></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]650</div>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]651<h2 id="_initializing">Initializing</h2>
652<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]653<div class="dlist"><dl>
654<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]655<tt>init_tree_desc</tt>
656</dt>
657<dd>
658<p>
659 Initialize a <tt>tree_desc</tt> and decode its first entry. The buffer and
660 size parameters are assumed to be the same as the buffer and size
661 members of <tt>struct tree</tt>.
662</p>
663</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]664<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]665<tt>fill_tree_descriptor</tt>
666</dt>
667<dd>
668<p>
669 Initialize a <tt>tree_desc</tt> and decode its first entry given the sha1 of
670 a tree. Returns the <tt>buffer</tt> member if the sha1 is a valid tree
671 identifier and NULL otherwise.
672</p>
673</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]674<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]675<tt>setup_traverse_info</tt>
676</dt>
677<dd>
678<p>
679 Initialize a <tt>traverse_info</tt> given the pathname of the tree to start
680 traversing from. The <tt>base</tt> argument is assumed to be the <tt>path</tt>
681 member of the <tt>name_entry</tt> being recursed into unless the tree is a
682 top-level tree in which case the empty string ("") is used.
683</p>
684</dd>
685</dl></div>
686</div>
687<h2 id="_walking">Walking</h2>
688<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]689<div class="dlist"><dl>
690<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]691<tt>tree_entry</tt>
692</dt>
693<dd>
694<p>
695 Visit the next entry in a tree. Returns 1 when there are more entries
696 left to visit and 0 when all entries have been visited. This is
697 commonly used in the test of a while loop.
698</p>
699</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]700<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]701<tt>tree_entry_len</tt>
702</dt>
703<dd>
704<p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]705 Calculate the length of a tree entry&#8217;s pathname. This utilizes the
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]706 memory structure of a tree entry to avoid the overhead of using a
707 generic strlen().
708</p>
709</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]710<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]711<tt>update_tree_entry</tt>
712</dt>
713<dd>
714<p>
715 Walk to the next entry in a tree. This is commonly used in conjunction
716 with <tt>tree_entry_extract</tt> to inspect the current entry.
717</p>
718</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]719<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]720<tt>tree_entry_extract</tt>
721</dt>
722<dd>
723<p>
724 Decode the entry currently being visited (the one pointed to by
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]725 <tt>tree_desc&#8217;s</tt> <tt>entry</tt> member) and return the sha1 of the entry. The
726 <tt>pathp</tt> and <tt>modep</tt> arguments are set to the entry&#8217;s pathname and mode
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]727 respectively.
728</p>
729</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]730<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]731<tt>get_tree_entry</tt>
732</dt>
733<dd>
734<p>
735 Find an entry in a tree given a pathname and the sha1 of a tree to
736 search. Returns 0 if the entry is found and -1 otherwise. The third
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]737 and fourth parameters are set to the entry&#8217;s sha1 and mode
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]738 respectively.
739</p>
740</dd>
741</dl></div>
742</div>
743<h2 id="_traversing">Traversing</h2>
744<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]745<div class="dlist"><dl>
746<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]747<tt>traverse_trees</tt>
748</dt>
749<dd>
750<p>
751 Traverse <tt>n</tt> number of trees in parallel. The <tt>fn</tt> callback member of
752 <tt>traverse_info</tt> is called once for each tree entry.
753</p>
754</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]755<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]756<tt>traverse_callback_t</tt>
757</dt>
758<dd>
759<p>
760 The arguments passed to the traverse callback are as follows:
761</p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]762<div class="ulist"><ul>
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]763<li>
764<p>
765<tt>n</tt> counts the number of trees being traversed.
766</p>
767</li>
768<li>
769<p>
770<tt>mask</tt> has its nth bit set if something exists in the nth entry.
771</p>
772</li>
773<li>
774<p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]775<tt>dirmask</tt> has its nth bit set if the nth tree&#8217;s entry is a directory.
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]776</p>
777</li>
778<li>
779<p>
780<tt>entry</tt> is an array of size <tt>n</tt> where the nth entry is from the nth tree.
781</p>
782</li>
783<li>
784<p>
785<tt>info</tt> maintains the state of the traversal.
786</p>
787</li>
788</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]789<div class="paragraph"><p>Returning a negative value will terminate the traversal. Otherwise the
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]790return value is treated as an update mask. If the nth bit is set the nth tree
791will be updated and if the bit is not set the nth tree entry will be the
792same in the next callback invocation.</p></div>
793</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]794<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]795<tt>make_traverse_path</tt>
796</dt>
797<dd>
798<p>
799 Generate the full pathname of a tree entry based from the root of the
800 traversal. For example, if the traversal has recursed into another
801 tree named "bar" the pathname of an entry "baz" in the "bar"
802 tree would be "bar/baz".
803</p>
804</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]805<dt class="hdlist1">
Junio C Hamanofd9274d2009-08-05 21:21:39[diff] [blame]806<tt>traverse_path_len</tt>
807</dt>
808<dd>
809<p>
810 Calculate the length of a pathname returned by <tt>make_traverse_path</tt>.
811 This utilizes the memory structure of a tree entry to avoid the
812 overhead of using a generic strlen().
813</p>
814</dd>
815</dl></div>
816</div>
817<h2 id="_authors">Authors</h2>
818<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]819<div class="paragraph"><p>Written by Junio C Hamano &lt;<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>&gt; and Linus Torvalds
820&lt;<a href="mailto:torvalds@linux-foundation.org">torvalds@linux-foundation.org</a>&gt;</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]821</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]822</div>
823<div id="footnotes"><hr /></div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]824<div id="footer">
825<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame]826Last updated 2011-11-15 13:45:02 PDT
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]827</div>
828</div>
829</body>
830</html>