blob: 0f52ea0b79dc470139865b9fa53431baff90756d [file] [log] [blame]
Junio C Hamano944ce252018-05-30 22:25:261<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano3dac5042007-12-15 08:40:542<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
Junio C Hamano9d971152012-12-19 00:43:116<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano944ce252018-05-30 22:25:267<meta name="generator" content="AsciiDoc 8.6.10" />
Junio C Hamano103b5722011-01-31 05:03:458<title>tree walking API</title>
Junio C Hamano3dac5042007-12-15 08:40:549<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:1110/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano3dac5042007-12-15 08:40:5425}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamano4604fe52008-09-19 06:37:1031a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano3dac5042007-12-15 08:40:5438
39em {
40 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:4541 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:5442}
43
44strong {
45 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:4546 color: #083194;
Junio C Hamano3dac5042007-12-15 08:40:5447}
48
Junio C Hamano3dac5042007-12-15 08:40:5449h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:5451 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamano4604fe52008-09-19 06:37:1056h1, h2, h3 {
Junio C Hamano3dac5042007-12-15 08:40:5457 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano3dac5042007-12-15 08:40:5460 padding-top: 0.5em;
61}
Junio C Hamano4604fe52008-09-19 06:37:1062h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:1168h5 {
69 font-size: 1.0em;
70}
Junio C Hamano3dac5042007-12-15 08:40:5471
72div.sectionbody {
Junio C Hamano3dac5042007-12-15 08:40:5473 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano103b5722011-01-31 05:03:4585ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:1188ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano103b5722011-01-31 05:03:4590
Junio C Hamanoc14e6ad2014-10-31 20:25:5391.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:5495 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:5398pre {
99 white-space: pre-wrap;
100}
Junio C Hamano3dac5042007-12-15 08:40:54101
Junio C Hamano9d971152012-12-19 00:43:11102#author {
Junio C Hamano3dac5042007-12-15 08:40:54103 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54104 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10105 font-size: 1.1em;
Junio C Hamano3dac5042007-12-15 08:40:54106}
Junio C Hamano9d971152012-12-19 00:43:11107#email {
Junio C Hamano3dac5042007-12-15 08:40:54108}
Junio C Hamano9d971152012-12-19 00:43:11109#revnumber, #revdate, #revremark {
Junio C Hamano3dac5042007-12-15 08:40:54110}
111
Junio C Hamano9d971152012-12-19 00:43:11112#footer {
Junio C Hamano3dac5042007-12-15 08:40:54113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11118#footer-text {
Junio C Hamano3dac5042007-12-15 08:40:54119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11122#footer-badges {
Junio C Hamano3dac5042007-12-15 08:40:54123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11127#preamble {
Junio C Hamano103b5722011-01-31 05:03:45128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano3dac5042007-12-15 08:40:54132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22134 margin-top: 1.0em;
Junio C Hamano3dac5042007-12-15 08:40:54135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano3dac5042007-12-15 08:40:54142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45150 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano3dac5042007-12-15 08:40:54174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano3dac5042007-12-15 08:40:54181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano3dac5042007-12-15 08:40:54190}
Junio C Hamano7bd050f2011-09-22 06:32:22191
Junio C Hamano103b5722011-01-31 05:03:45192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54194 text-align: right;
195}
Junio C Hamano103b5722011-01-31 05:03:45196
Junio C Hamano9d971152012-12-19 00:43:11197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano103b5722011-01-31 05:03:45200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano4604fe52008-09-19 06:37:10206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano3dac5042007-12-15 08:40:54209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22220 border-left: 3px solid #dddddd;
Junio C Hamano3dac5042007-12-15 08:40:54221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54226}
227
Junio C Hamano3dac5042007-12-15 08:40:54228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano103b5722011-01-31 05:03:45230a.image:visited { color: white; }
Junio C Hamano3dac5042007-12-15 08:40:54231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45239 font-style: normal;
240 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54241}
242dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45243 margin-top: 0.1em;
Junio C Hamano3dac5042007-12-15 08:40:54244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano103b5722011-01-31 05:03:45249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano3dac5042007-12-15 08:40:54253 list-style-type: lower-alpha;
254}
Junio C Hamano103b5722011-01-31 05:03:45255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano3dac5042007-12-15 08:40:54271
Junio C Hamano3dac5042007-12-15 08:40:54272tfoot {
273 font-weight: bold;
274}
Junio C Hamano103b5722011-01-31 05:03:45275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano103b5722011-01-31 05:03:45278
279div.hdlist {
Junio C Hamano3dac5042007-12-15 08:40:54280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano103b5722011-01-31 05:03:45283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamano4604fe52008-09-19 06:37:10285}
Junio C Hamano103b5722011-01-31 05:03:45286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano3dac5042007-12-15 08:40:54290 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45291 font-style: normal;
Junio C Hamano3dac5042007-12-15 08:40:54292 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45293 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54294}
Junio C Hamano103b5722011-01-31 05:03:45295td.hdlist2 {
Junio C Hamano3dac5042007-12-15 08:40:54296 vertical-align: top;
297}
Junio C Hamano103b5722011-01-31 05:03:45298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano3dac5042007-12-15 08:40:54306
Junio C Hamano7bd050f2011-09-22 06:32:22307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
Junio C Hamano9d971152012-12-19 00:43:11334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano3dac5042007-12-15 08:40:54341}
Junio C Hamano4604fe52008-09-19 06:37:10342
Junio C Hamano9d971152012-12-19 00:43:11343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11351#toctitle {
Junio C Hamano4604fe52008-09-19 06:37:10352 color: #527bbd;
Junio C Hamano4604fe52008-09-19 06:37:10353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano4604fe52008-09-19 06:37:10360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano3dac5042007-12-15 08:40:54375
Junio C Hamano9d971152012-12-19 00:43:11376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
Junio C Hamano3dac5042007-12-15 08:40:54428}
Junio C Hamano9d971152012-12-19 00:43:11429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
Junio C Hamano3dac5042007-12-15 08:40:54433 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
439/* Because the table frame attribute is overriden by CSS in most browsers. */
440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
Junio C Hamano3dac5042007-12-15 08:40:54450}
451
Junio C Hamano9d971152012-12-19 00:43:11452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54481}
482
Junio C Hamano9d971152012-12-19 00:43:11483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
Junio C Hamano103b5722011-01-31 05:03:45502 text-align: right;
503}
504
Junio C Hamano9d971152012-12-19 00:43:11505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45507}
Junio C Hamano9d971152012-12-19 00:43:11508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
Junio C Hamano3dac5042007-12-15 08:40:54513}
514
Junio C Hamano9d971152012-12-19 00:43:11515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
527body.manpage h2 {
528 border-style: none;
529}
530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano3dac5042007-12-15 08:40:54532}
Junio C Hamano4604fe52008-09-19 06:37:10533
Junio C Hamano9d971152012-12-19 00:43:11534@media print {
535 body.manpage div#toc { display: none; }
536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53537
538
Junio C Hamano3dac5042007-12-15 08:40:54539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53612 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22651 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
Junio C Hamano9d971152012-12-19 00:43:11673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
Junio C Hamano7bd050f2011-09-22 06:32:22683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
Junio C Hamano9d971152012-12-19 00:43:11706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22728}
729
730}
Junio C Hamano9d971152012-12-19 00:43:11731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22732/*]]>*/
733</script>
Junio C Hamano3dac5042007-12-15 08:40:54734</head>
Junio C Hamano9d971152012-12-19 00:43:11735<body class="article">
Junio C Hamano3dac5042007-12-15 08:40:54736<div id="header">
737<h1>tree walking API</h1>
738</div>
Junio C Hamano7bd050f2011-09-22 06:32:22739<div id="content">
Junio C Hamano3dac5042007-12-15 08:40:54740<div id="preamble">
741<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45742<div class="paragraph"><p>The tree walking API is used to traverse and inspect trees.</p></div>
Junio C Hamanofd9274d2009-08-05 21:21:39743</div>
744</div>
Junio C Hamano9d971152012-12-19 00:43:11745<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:39746<h2 id="_data_structures">Data Structures</h2>
747<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45748<div class="dlist"><dl>
749<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53750<code>struct name_entry</code>
Junio C Hamanofd9274d2009-08-05 21:21:39751</dt>
752<dd>
753<p>
754 An entry in a tree. Each entry has a sha1 identifier, pathname, and
755 mode.
756</p>
757</dd>
Junio C Hamano103b5722011-01-31 05:03:45758<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53759<code>struct tree_desc</code>
Junio C Hamanofd9274d2009-08-05 21:21:39760</dt>
761<dd>
762<p>
763 A semi-opaque data structure used to maintain the current state of the
764 walk.
765</p>
Junio C Hamano103b5722011-01-31 05:03:45766<div class="ulist"><ul>
Junio C Hamano3dac5042007-12-15 08:40:54767<li>
768<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53769<code>buffer</code> is a pointer into the memory representation of the tree. It always
Junio C Hamanofd9274d2009-08-05 21:21:39770points at the current entry being visited.
Junio C Hamano3dac5042007-12-15 08:40:54771</p>
772</li>
773<li>
774<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53775<code>size</code> counts the number of bytes left in the <code>buffer</code>.
Junio C Hamano3dac5042007-12-15 08:40:54776</p>
777</li>
778<li>
779<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53780<code>entry</code> points to the current entry being visited.
Junio C Hamano3dac5042007-12-15 08:40:54781</p>
782</li>
Junio C Hamano4604fe52008-09-19 06:37:10783</ul></div>
Junio C Hamanofd9274d2009-08-05 21:21:39784</dd>
Junio C Hamano103b5722011-01-31 05:03:45785<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53786<code>struct traverse_info</code>
Junio C Hamanofd9274d2009-08-05 21:21:39787</dt>
788<dd>
789<p>
790 A structure used to maintain the state of a traversal.
791</p>
Junio C Hamano103b5722011-01-31 05:03:45792<div class="ulist"><ul>
Junio C Hamanofd9274d2009-08-05 21:21:39793<li>
794<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53795<code>prev</code> points to the traverse_info which was used to descend into the
796current tree. If this is the top-level tree <code>prev</code> will point to
Junio C Hamanofd9274d2009-08-05 21:21:39797a dummy traverse_info.
798</p>
799</li>
800<li>
801<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53802<code>name</code> is the entry for the current tree (if the tree is a subtree).
Junio C Hamanofd9274d2009-08-05 21:21:39803</p>
804</li>
805<li>
806<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53807<code>pathlen</code> is the length of the full path for the current tree.
Junio C Hamanofd9274d2009-08-05 21:21:39808</p>
809</li>
810<li>
811<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53812<code>conflicts</code> can be used by callbacks to maintain directory-file conflicts.
Junio C Hamanofd9274d2009-08-05 21:21:39813</p>
814</li>
815<li>
816<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53817<code>fn</code> is a callback called for each entry in the tree. See Traversing for more
Junio C Hamanofd9274d2009-08-05 21:21:39818information.
819</p>
820</li>
821<li>
822<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53823<code>data</code> can be anything the <code>fn</code> callback would want to use.
Junio C Hamanofd9274d2009-08-05 21:21:39824</p>
825</li>
Junio C Hamano53ba6d02010-08-22 07:25:12826<li>
827<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53828<code>show_all_errors</code> tells whether to stop at the first error or not.
Junio C Hamano53ba6d02010-08-22 07:25:12829</p>
830</li>
Junio C Hamanofd9274d2009-08-05 21:21:39831</ul></div>
832</dd>
833</dl></div>
Junio C Hamano3dac5042007-12-15 08:40:54834</div>
Junio C Hamano9d971152012-12-19 00:43:11835</div>
836<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:39837<h2 id="_initializing">Initializing</h2>
838<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45839<div class="dlist"><dl>
840<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53841<code>init_tree_desc</code>
Junio C Hamanofd9274d2009-08-05 21:21:39842</dt>
843<dd>
844<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53845 Initialize a <code>tree_desc</code> and decode its first entry. The buffer and
Junio C Hamanofd9274d2009-08-05 21:21:39846 size parameters are assumed to be the same as the buffer and size
Junio C Hamanoc14e6ad2014-10-31 20:25:53847 members of <code>struct tree</code>.
Junio C Hamanofd9274d2009-08-05 21:21:39848</p>
849</dd>
Junio C Hamano103b5722011-01-31 05:03:45850<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53851<code>fill_tree_descriptor</code>
Junio C Hamanofd9274d2009-08-05 21:21:39852</dt>
853<dd>
854<p>
Junio C Hamano7526f0a2017-08-24 18:09:35855 Initialize a <code>tree_desc</code> and decode its first entry given the
856 object ID of a tree. Returns the <code>buffer</code> member if the latter
857 is a valid tree identifier and NULL otherwise.
Junio C Hamanofd9274d2009-08-05 21:21:39858</p>
859</dd>
Junio C Hamano103b5722011-01-31 05:03:45860<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53861<code>setup_traverse_info</code>
Junio C Hamanofd9274d2009-08-05 21:21:39862</dt>
863<dd>
864<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53865 Initialize a <code>traverse_info</code> given the pathname of the tree to start
866 traversing from. The <code>base</code> argument is assumed to be the <code>path</code>
867 member of the <code>name_entry</code> being recursed into unless the tree is a
Junio C Hamanofd9274d2009-08-05 21:21:39868 top-level tree in which case the empty string ("") is used.
869</p>
870</dd>
871</dl></div>
872</div>
Junio C Hamano9d971152012-12-19 00:43:11873</div>
874<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:39875<h2 id="_walking">Walking</h2>
876<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45877<div class="dlist"><dl>
878<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53879<code>tree_entry</code>
Junio C Hamanofd9274d2009-08-05 21:21:39880</dt>
881<dd>
882<p>
883 Visit the next entry in a tree. Returns 1 when there are more entries
884 left to visit and 0 when all entries have been visited. This is
885 commonly used in the test of a while loop.
886</p>
887</dd>
Junio C Hamano103b5722011-01-31 05:03:45888<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53889<code>tree_entry_len</code>
Junio C Hamanofd9274d2009-08-05 21:21:39890</dt>
891<dd>
892<p>
Junio C Hamano103b5722011-01-31 05:03:45893 Calculate the length of a tree entry&#8217;s pathname. This utilizes the
Junio C Hamanofd9274d2009-08-05 21:21:39894 memory structure of a tree entry to avoid the overhead of using a
895 generic strlen().
896</p>
897</dd>
Junio C Hamano103b5722011-01-31 05:03:45898<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53899<code>update_tree_entry</code>
Junio C Hamanofd9274d2009-08-05 21:21:39900</dt>
901<dd>
902<p>
903 Walk to the next entry in a tree. This is commonly used in conjunction
Junio C Hamanoc14e6ad2014-10-31 20:25:53904 with <code>tree_entry_extract</code> to inspect the current entry.
Junio C Hamanofd9274d2009-08-05 21:21:39905</p>
906</dd>
Junio C Hamano103b5722011-01-31 05:03:45907<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53908<code>tree_entry_extract</code>
Junio C Hamanofd9274d2009-08-05 21:21:39909</dt>
910<dd>
911<p>
912 Decode the entry currently being visited (the one pointed to by
Junio C Hamanoc14e6ad2014-10-31 20:25:53913 <code>tree_desc's</code> <code>entry</code> member) and return the sha1 of the entry. The
914 <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:39915 respectively.
916</p>
917</dd>
Junio C Hamano103b5722011-01-31 05:03:45918<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53919<code>get_tree_entry</code>
Junio C Hamanofd9274d2009-08-05 21:21:39920</dt>
921<dd>
922<p>
923 Find an entry in a tree given a pathname and the sha1 of a tree to
924 search. Returns 0 if the entry is found and -1 otherwise. The third
Junio C Hamano103b5722011-01-31 05:03:45925 and fourth parameters are set to the entry&#8217;s sha1 and mode
Junio C Hamanofd9274d2009-08-05 21:21:39926 respectively.
927</p>
928</dd>
929</dl></div>
930</div>
Junio C Hamano9d971152012-12-19 00:43:11931</div>
932<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:39933<h2 id="_traversing">Traversing</h2>
934<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45935<div class="dlist"><dl>
936<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53937<code>traverse_trees</code>
Junio C Hamanofd9274d2009-08-05 21:21:39938</dt>
939<dd>
940<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53941 Traverse <code>n</code> number of trees in parallel. The <code>fn</code> callback member of
942 <code>traverse_info</code> is called once for each tree entry.
Junio C Hamanofd9274d2009-08-05 21:21:39943</p>
944</dd>
Junio C Hamano103b5722011-01-31 05:03:45945<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53946<code>traverse_callback_t</code>
Junio C Hamanofd9274d2009-08-05 21:21:39947</dt>
948<dd>
949<p>
950 The arguments passed to the traverse callback are as follows:
951</p>
Junio C Hamano103b5722011-01-31 05:03:45952<div class="ulist"><ul>
Junio C Hamanofd9274d2009-08-05 21:21:39953<li>
954<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53955<code>n</code> counts the number of trees being traversed.
Junio C Hamanofd9274d2009-08-05 21:21:39956</p>
957</li>
958<li>
959<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53960<code>mask</code> has its nth bit set if something exists in the nth entry.
Junio C Hamanofd9274d2009-08-05 21:21:39961</p>
962</li>
963<li>
964<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53965<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:39966</p>
967</li>
968<li>
969<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53970<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:39971</p>
972</li>
973<li>
974<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53975<code>info</code> maintains the state of the traversal.
Junio C Hamanofd9274d2009-08-05 21:21:39976</p>
977</li>
978</ul></div>
Junio C Hamano103b5722011-01-31 05:03:45979<div class="paragraph"><p>Returning a negative value will terminate the traversal. Otherwise the
Junio C Hamanofd9274d2009-08-05 21:21:39980return value is treated as an update mask. If the nth bit is set the nth tree
981will be updated and if the bit is not set the nth tree entry will be the
982same in the next callback invocation.</p></div>
983</dd>
Junio C Hamano103b5722011-01-31 05:03:45984<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53985<code>make_traverse_path</code>
Junio C Hamanofd9274d2009-08-05 21:21:39986</dt>
987<dd>
988<p>
989 Generate the full pathname of a tree entry based from the root of the
990 traversal. For example, if the traversal has recursed into another
991 tree named "bar" the pathname of an entry "baz" in the "bar"
992 tree would be "bar/baz".
993</p>
994</dd>
Junio C Hamano103b5722011-01-31 05:03:45995<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53996<code>traverse_path_len</code>
Junio C Hamanofd9274d2009-08-05 21:21:39997</dt>
998<dd>
999<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531000 Calculate the length of a pathname returned by <code>make_traverse_path</code>.
Junio C Hamanofd9274d2009-08-05 21:21:391001 This utilizes the memory structure of a tree entry to avoid the
1002 overhead of using a generic strlen().
1003</p>
1004</dd>
1005</dl></div>
1006</div>
Junio C Hamano9d971152012-12-19 00:43:111007</div>
1008<div class="sect1">
Junio C Hamanofd9274d2009-08-05 21:21:391009<h2 id="_authors">Authors</h2>
1010<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:451011<div class="paragraph"><p>Written by Junio C Hamano &lt;<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>&gt; and Linus Torvalds
1012&lt;<a href="mailto:torvalds@linux-foundation.org">torvalds@linux-foundation.org</a>&gt;</p></div>
Junio C Hamano3dac5042007-12-15 08:40:541013</div>
Junio C Hamano7bd050f2011-09-22 06:32:221014</div>
Junio C Hamano9d971152012-12-19 00:43:111015</div>
Junio C Hamano7bd050f2011-09-22 06:32:221016<div id="footnotes"><hr /></div>
Junio C Hamano3dac5042007-12-15 08:40:541017<div id="footer">
1018<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:531019Last updated
Junio C Hamanocf731002019-01-29 21:19:521020 2018-01-26 15:11:04 PST
Junio C Hamano3dac5042007-12-15 08:40:541021</div>
1022</div>
1023</body>
1024</html>