blob: 2ddd698ef73978b825f621a967c809fb62c827c2 [file] [log] [blame]
Junio C Hamano3dac5042007-12-15 08:40:541<!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>
Junio C Hamano9d971152012-12-19 00:43:115<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:536<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano103b5722011-01-31 05:03:457<title>tree walking API</title>
Junio C Hamano3dac5042007-12-15 08:40:548<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:119/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano3dac5042007-12-15 08:40:5424}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamano4604fe52008-09-19 06:37:1030a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamano3dac5042007-12-15 08:40:5437
38em {
39 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:4540 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:5441}
42
43strong {
44 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:4545 color: #083194;
Junio C Hamano3dac5042007-12-15 08:40:5446}
47
Junio C Hamano3dac5042007-12-15 08:40:5448h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:5450 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamano4604fe52008-09-19 06:37:1055h1, h2, h3 {
Junio C Hamano3dac5042007-12-15 08:40:5456 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamano3dac5042007-12-15 08:40:5459 padding-top: 0.5em;
60}
Junio C Hamano4604fe52008-09-19 06:37:1061h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:1167h5 {
68 font-size: 1.0em;
69}
Junio C Hamano3dac5042007-12-15 08:40:5470
71div.sectionbody {
Junio C Hamano3dac5042007-12-15 08:40:5472 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano103b5722011-01-31 05:03:4584ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:1187ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano103b5722011-01-31 05:03:4589
Junio C Hamanoc14e6ad2014-10-31 20:25:5390.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:5494 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:5397pre {
98 white-space: pre-wrap;
99}
Junio C Hamano3dac5042007-12-15 08:40:54100
Junio C Hamano9d971152012-12-19 00:43:11101#author {
Junio C Hamano3dac5042007-12-15 08:40:54102 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54103 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10104 font-size: 1.1em;
Junio C Hamano3dac5042007-12-15 08:40:54105}
Junio C Hamano9d971152012-12-19 00:43:11106#email {
Junio C Hamano3dac5042007-12-15 08:40:54107}
Junio C Hamano9d971152012-12-19 00:43:11108#revnumber, #revdate, #revremark {
Junio C Hamano3dac5042007-12-15 08:40:54109}
110
Junio C Hamano9d971152012-12-19 00:43:11111#footer {
Junio C Hamano3dac5042007-12-15 08:40:54112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11117#footer-text {
Junio C Hamano3dac5042007-12-15 08:40:54118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11121#footer-badges {
Junio C Hamano3dac5042007-12-15 08:40:54122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11126#preamble {
Junio C Hamano103b5722011-01-31 05:03:45127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano3dac5042007-12-15 08:40:54131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22133 margin-top: 1.0em;
Junio C Hamano3dac5042007-12-15 08:40:54134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamano3dac5042007-12-15 08:40:54141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45149 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano3dac5042007-12-15 08:40:54173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano3dac5042007-12-15 08:40:54180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano3dac5042007-12-15 08:40:54189}
Junio C Hamano7bd050f2011-09-22 06:32:22190
Junio C Hamano103b5722011-01-31 05:03:45191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54193 text-align: right;
194}
Junio C Hamano103b5722011-01-31 05:03:45195
Junio C Hamano9d971152012-12-19 00:43:11196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano103b5722011-01-31 05:03:45199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano4604fe52008-09-19 06:37:10205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamano3dac5042007-12-15 08:40:54208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22219 border-left: 3px solid #dddddd;
Junio C Hamano3dac5042007-12-15 08:40:54220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54225}
226
Junio C Hamano3dac5042007-12-15 08:40:54227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano103b5722011-01-31 05:03:45229a.image:visited { color: white; }
Junio C Hamano3dac5042007-12-15 08:40:54230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45238 font-style: normal;
239 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54240}
241dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45242 margin-top: 0.1em;
Junio C Hamano3dac5042007-12-15 08:40:54243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano103b5722011-01-31 05:03:45248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamano3dac5042007-12-15 08:40:54252 list-style-type: lower-alpha;
253}
Junio C Hamano103b5722011-01-31 05:03:45254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamano3dac5042007-12-15 08:40:54270
Junio C Hamano3dac5042007-12-15 08:40:54271tfoot {
272 font-weight: bold;
273}
Junio C Hamano103b5722011-01-31 05:03:45274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano103b5722011-01-31 05:03:45277
278div.hdlist {
Junio C Hamano3dac5042007-12-15 08:40:54279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano103b5722011-01-31 05:03:45282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamano4604fe52008-09-19 06:37:10284}
Junio C Hamano103b5722011-01-31 05:03:45285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamano3dac5042007-12-15 08:40:54289 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45290 font-style: normal;
Junio C Hamano3dac5042007-12-15 08:40:54291 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45292 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54293}
Junio C Hamano103b5722011-01-31 05:03:45294td.hdlist2 {
Junio C Hamano3dac5042007-12-15 08:40:54295 vertical-align: top;
296}
Junio C Hamano103b5722011-01-31 05:03:45297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamano3dac5042007-12-15 08:40:54305
Junio C Hamano7bd050f2011-09-22 06:32:22306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano3dac5042007-12-15 08:40:54340}
Junio C Hamano4604fe52008-09-19 06:37:10341
Junio C Hamano9d971152012-12-19 00:43:11342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11350#toctitle {
Junio C Hamano4604fe52008-09-19 06:37:10351 color: #527bbd;
Junio C Hamano4604fe52008-09-19 06:37:10352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano4604fe52008-09-19 06:37:10359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano3dac5042007-12-15 08:40:54374
Junio C Hamano9d971152012-12-19 00:43:11375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
Junio C Hamano3dac5042007-12-15 08:40:54427}
Junio C Hamano9d971152012-12-19 00:43:11428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
Junio C Hamano3dac5042007-12-15 08:40:54432 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
Junio C Hamano3dac5042007-12-15 08:40:54449}
450
Junio C Hamano9d971152012-12-19 00:43:11451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54480}
481
Junio C Hamano9d971152012-12-19 00:43:11482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
Junio C Hamano103b5722011-01-31 05:03:45501 text-align: right;
502}
503
Junio C Hamano9d971152012-12-19 00:43:11504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45506}
Junio C Hamano9d971152012-12-19 00:43:11507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
Junio C Hamano3dac5042007-12-15 08:40:54512}
513
Junio C Hamano9d971152012-12-19 00:43:11514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
526body.manpage h2 {
527 border-style: none;
528}
529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano3dac5042007-12-15 08:40:54531}
Junio C Hamano4604fe52008-09-19 06:37:10532
Junio C Hamano9d971152012-12-19 00:43:11533@media print {
534 body.manpage div#toc { display: none; }
535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53536
537
Junio C Hamano3dac5042007-12-15 08:40:54538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22731/*]]>*/
732</script>
Junio C Hamano3dac5042007-12-15 08:40:54733</head>
Junio C Hamano9d971152012-12-19 00:43:11734<body class="article">
Junio C Hamano3dac5042007-12-15 08:40:54735<div id="header">
736<h1>tree walking API</h1>
737</div>
Junio C Hamano7bd050f2011-09-22 06:32:22738<div id="content">
Junio C Hamano3dac5042007-12-15 08:40:54739<div id="preamble">
740<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45741<div class="paragraph"><p>The tree walking API is used to traverse and inspect trees.</p></div>
Junio C Hamanofd9274d2009-08-05 21:21:39742</div>
743</div>
Junio C Hamano9d971152012-12-19 00:43:11744<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:39745<h2 id="_data_structures">Data Structures</h2>
746<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45747<div class="dlist"><dl>
748<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53749<code>struct name_entry</code>
Junio C Hamanofd9274d2009-08-05 21:21:39750</dt>
751<dd>
752<p>
753 An entry in a tree. Each entry has a sha1 identifier, pathname, and
754 mode.
755</p>
756</dd>
Junio C Hamano103b5722011-01-31 05:03:45757<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53758<code>struct tree_desc</code>
Junio C Hamanofd9274d2009-08-05 21:21:39759</dt>
760<dd>
761<p>
762 A semi-opaque data structure used to maintain the current state of the
763 walk.
764</p>
Junio C Hamano103b5722011-01-31 05:03:45765<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54766<li>
767<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53768<code>buffer</code> is a pointer into the memory representation of the tree. It always
Junio C Hamanofd9274d2009-08-05 21:21:39769points at the current entry being visited.
Junio C Hamano3dac5042007-12-15 08:40:54770</p>
771</li>
772<li>
773<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53774<code>size</code> counts the number of bytes left in the <code>buffer</code>.
Junio C Hamano3dac5042007-12-15 08:40:54775</p>
776</li>
777<li>
778<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53779<code>entry</code> points to the current entry being visited.
Junio C Hamano3dac5042007-12-15 08:40:54780</p>
781</li>
Junio C Hamano4604fe52008-09-19 06:37:10782</ul></div>
Junio C Hamanofd9274d2009-08-05 21:21:39783</dd>
Junio C Hamano103b5722011-01-31 05:03:45784<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53785<code>struct traverse_info</code>
Junio C Hamanofd9274d2009-08-05 21:21:39786</dt>
787<dd>
788<p>
789 A structure used to maintain the state of a traversal.
790</p>
Junio C Hamano103b5722011-01-31 05:03:45791<div class="ulist"><ul>
Junio C Hamanofd9274d2009-08-05 21:21:39792<li>
793<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53794<code>prev</code> points to the traverse_info which was used to descend into the
795current tree. If this is the top-level tree <code>prev</code> will point to
Junio C Hamanofd9274d2009-08-05 21:21:39796a dummy traverse_info.
797</p>
798</li>
799<li>
800<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53801<code>name</code> is the entry for the current tree (if the tree is a subtree).
Junio C Hamanofd9274d2009-08-05 21:21:39802</p>
803</li>
804<li>
805<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53806<code>pathlen</code> is the length of the full path for the current tree.
Junio C Hamanofd9274d2009-08-05 21:21:39807</p>
808</li>
809<li>
810<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53811<code>conflicts</code> can be used by callbacks to maintain directory-file conflicts.
Junio C Hamanofd9274d2009-08-05 21:21:39812</p>
813</li>
814<li>
815<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53816<code>fn</code> is a callback called for each entry in the tree. See Traversing for more
Junio C Hamanofd9274d2009-08-05 21:21:39817information.
818</p>
819</li>
820<li>
821<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53822<code>data</code> can be anything the <code>fn</code> callback would want to use.
Junio C Hamanofd9274d2009-08-05 21:21:39823</p>
824</li>
Junio C Hamano53ba6d02010-08-22 07:25:12825<li>
826<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53827<code>show_all_errors</code> tells whether to stop at the first error or not.
Junio C Hamano53ba6d02010-08-22 07:25:12828</p>
829</li>
Junio C Hamanofd9274d2009-08-05 21:21:39830</ul></div>
831</dd>
832</dl></div>
Junio C Hamano3dac5042007-12-15 08:40:54833</div>
Junio C Hamano9d971152012-12-19 00:43:11834</div>
835<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:39836<h2 id="_initializing">Initializing</h2>
837<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45838<div class="dlist"><dl>
839<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53840<code>init_tree_desc</code>
Junio C Hamanofd9274d2009-08-05 21:21:39841</dt>
842<dd>
843<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53844 Initialize a <code>tree_desc</code> and decode its first entry. The buffer and
Junio C Hamanofd9274d2009-08-05 21:21:39845 size parameters are assumed to be the same as the buffer and size
Junio C Hamanoc14e6ad2014-10-31 20:25:53846 members of <code>struct tree</code>.
Junio C Hamanofd9274d2009-08-05 21:21:39847</p>
848</dd>
Junio C Hamano103b5722011-01-31 05:03:45849<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53850<code>fill_tree_descriptor</code>
Junio C Hamanofd9274d2009-08-05 21:21:39851</dt>
852<dd>
853<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53854 Initialize a <code>tree_desc</code> and decode its first entry given the sha1 of
855 a tree. Returns the <code>buffer</code> member if the sha1 is a valid tree
Junio C Hamanofd9274d2009-08-05 21:21:39856 identifier and NULL otherwise.
857</p>
858</dd>
Junio C Hamano103b5722011-01-31 05:03:45859<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53860<code>setup_traverse_info</code>
Junio C Hamanofd9274d2009-08-05 21:21:39861</dt>
862<dd>
863<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53864 Initialize a <code>traverse_info</code> given the pathname of the tree to start
865 traversing from. The <code>base</code> argument is assumed to be the <code>path</code>
866 member of the <code>name_entry</code> being recursed into unless the tree is a
Junio C Hamanofd9274d2009-08-05 21:21:39867 top-level tree in which case the empty string ("") is used.
868</p>
869</dd>
870</dl></div>
871</div>
Junio C Hamano9d971152012-12-19 00:43:11872</div>
873<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:39874<h2 id="_walking">Walking</h2>
875<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45876<div class="dlist"><dl>
877<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53878<code>tree_entry</code>
Junio C Hamanofd9274d2009-08-05 21:21:39879</dt>
880<dd>
881<p>
882 Visit the next entry in a tree. Returns 1 when there are more entries
883 left to visit and 0 when all entries have been visited. This is
884 commonly used in the test of a while loop.
885</p>
886</dd>
Junio C Hamano103b5722011-01-31 05:03:45887<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53888<code>tree_entry_len</code>
Junio C Hamanofd9274d2009-08-05 21:21:39889</dt>
890<dd>
891<p>
Junio C Hamano103b5722011-01-31 05:03:45892 Calculate the length of a tree entry&#8217;s pathname. This utilizes the
Junio C Hamanofd9274d2009-08-05 21:21:39893 memory structure of a tree entry to avoid the overhead of using a
894 generic strlen().
895</p>
896</dd>
Junio C Hamano103b5722011-01-31 05:03:45897<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53898<code>update_tree_entry</code>
Junio C Hamanofd9274d2009-08-05 21:21:39899</dt>
900<dd>
901<p>
902 Walk to the next entry in a tree. This is commonly used in conjunction
Junio C Hamanoc14e6ad2014-10-31 20:25:53903 with <code>tree_entry_extract</code> to inspect the current entry.
Junio C Hamanofd9274d2009-08-05 21:21:39904</p>
905</dd>
Junio C Hamano103b5722011-01-31 05:03:45906<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53907<code>tree_entry_extract</code>
Junio C Hamanofd9274d2009-08-05 21:21:39908</dt>
909<dd>
910<p>
911 Decode the entry currently being visited (the one pointed to by
Junio C Hamanoc14e6ad2014-10-31 20:25:53912 <code>tree_desc's</code> <code>entry</code> member) and return the sha1 of the entry. The
913 <code>pathp</code> and <code>modep</code> arguments are set to the entry&#8217;s pathname and mode
Junio C Hamanofd9274d2009-08-05 21:21:39914 respectively.
915</p>
916</dd>
Junio C Hamano103b5722011-01-31 05:03:45917<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53918<code>get_tree_entry</code>
Junio C Hamanofd9274d2009-08-05 21:21:39919</dt>
920<dd>
921<p>
922 Find an entry in a tree given a pathname and the sha1 of a tree to
923 search. Returns 0 if the entry is found and -1 otherwise. The third
Junio C Hamano103b5722011-01-31 05:03:45924 and fourth parameters are set to the entry&#8217;s sha1 and mode
Junio C Hamanofd9274d2009-08-05 21:21:39925 respectively.
926</p>
927</dd>
928</dl></div>
929</div>
Junio C Hamano9d971152012-12-19 00:43:11930</div>
931<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:39932<h2 id="_traversing">Traversing</h2>
933<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45934<div class="dlist"><dl>
935<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53936<code>traverse_trees</code>
Junio C Hamanofd9274d2009-08-05 21:21:39937</dt>
938<dd>
939<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53940 Traverse <code>n</code> number of trees in parallel. The <code>fn</code> callback member of
941 <code>traverse_info</code> is called once for each tree entry.
Junio C Hamanofd9274d2009-08-05 21:21:39942</p>
943</dd>
Junio C Hamano103b5722011-01-31 05:03:45944<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53945<code>traverse_callback_t</code>
Junio C Hamanofd9274d2009-08-05 21:21:39946</dt>
947<dd>
948<p>
949 The arguments passed to the traverse callback are as follows:
950</p>
Junio C Hamano103b5722011-01-31 05:03:45951<div class="ulist"><ul>
Junio C Hamanofd9274d2009-08-05 21:21:39952<li>
953<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53954<code>n</code> counts the number of trees being traversed.
Junio C Hamanofd9274d2009-08-05 21:21:39955</p>
956</li>
957<li>
958<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53959<code>mask</code> has its nth bit set if something exists in the nth entry.
Junio C Hamanofd9274d2009-08-05 21:21:39960</p>
961</li>
962<li>
963<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53964<code>dirmask</code> has its nth bit set if the nth tree&#8217;s entry is a directory.
Junio C Hamanofd9274d2009-08-05 21:21:39965</p>
966</li>
967<li>
968<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53969<code>entry</code> is an array of size <code>n</code> where the nth entry is from the nth tree.
Junio C Hamanofd9274d2009-08-05 21:21:39970</p>
971</li>
972<li>
973<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53974<code>info</code> maintains the state of the traversal.
Junio C Hamanofd9274d2009-08-05 21:21:39975</p>
976</li>
977</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45978<div class="paragraph"><p>Returning a negative value will terminate the traversal. Otherwise the
Junio C Hamanofd9274d2009-08-05 21:21:39979return value is treated as an update mask. If the nth bit is set the nth tree
980will be updated and if the bit is not set the nth tree entry will be the
981same in the next callback invocation.</p></div>
982</dd>
Junio C Hamano103b5722011-01-31 05:03:45983<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53984<code>make_traverse_path</code>
Junio C Hamanofd9274d2009-08-05 21:21:39985</dt>
986<dd>
987<p>
988 Generate the full pathname of a tree entry based from the root of the
989 traversal. For example, if the traversal has recursed into another
990 tree named "bar" the pathname of an entry "baz" in the "bar"
991 tree would be "bar/baz".
992</p>
993</dd>
Junio C Hamano103b5722011-01-31 05:03:45994<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53995<code>traverse_path_len</code>
Junio C Hamanofd9274d2009-08-05 21:21:39996</dt>
997<dd>
998<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53999 Calculate the length of a pathname returned by <code>make_traverse_path</code>.
Junio C Hamanofd9274d2009-08-05 21:21:391000 This utilizes the memory structure of a tree entry to avoid the
1001 overhead of using a generic strlen().
1002</p>
1003</dd>
1004</dl></div>
1005</div>
Junio C Hamano9d971152012-12-19 00:43:111006</div>
1007<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:391008<h2 id="_authors">Authors</h2>
1009<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:451010<div class="paragraph"><p>Written by Junio C Hamano &lt;<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>&gt; and Linus Torvalds
1011&lt;<a href="mailto:torvalds@linux-foundation.org">torvalds@linux-foundation.org</a>&gt;</p></div>
Junio C Hamano3dac5042007-12-15 08:40:541012</div>
Junio C Hamano7bd050f2011-09-22 06:32:221013</div>
Junio C Hamano9d971152012-12-19 00:43:111014</div>
Junio C Hamano7bd050f2011-09-22 06:32:221015<div id="footnotes"><hr /></div>
Junio C Hamano3dac5042007-12-15 08:40:541016<div id="footer">
1017<div id="footer-text">
Junio C Hamano683a8612013-08-23 20:50:091018Last updated 2013-08-20 08:40:27 PDT
Junio C Hamano3dac5042007-12-15 08:40:541019</div>
1020</div>
1021</body>
1022</html>