blob: 723f84a5a4459e4462489bea67787da864be9a6c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
#!/usr/bin/tclsh
#
# Run this script redirecting the sqlite3.h file as standard
# inputs and this script will generate API documentation.
#
set rcsid {$Id: mkapidoc.tcl,v 1.2 2007/06/20 09:09:48 danielk1977 Exp $}
source common.tcl
header {C/C++ Interface For SQLite Version 3}
puts {
<h2 class=pdf_section>C/C++ Interface For SQLite Version 3</h2>
}
# Scan standard input to extract the information we need
# to build the documentation.
#
set title {}
set type {}
set body {}
set code {}
set phase 0
set content {}
while {![eof stdin]} {
set line [gets stdin]
if {$phase==0} {
# Looking for the CAPI3REF: keyword
if {[regexp {^\*\* CAPI3REF: +(.*)} $line all tx]} {
set title $tx
set phase 1
}
} elseif {$phase==1} {
if {[string range $line 0 1]=="**"} {
set lx [string trim [string range $line 3 end]]
if {[regexp {^CATEGORY: +([a-z]*)} $lx all cx]} {
set type $cx
} elseif {[regexp {^KEYWORDS: +(.*)} $lx all kx]} {
foreach k $kx {
set keyword($k) 1
}
} else {
append body $lx\n
}
} elseif {[string range $line 0 1]=="*/"} {
set phase 2
}
} elseif {$phase==2} {
if {$line==""} {
set kwlist [lsort [array names keyword]]
unset -nocomplain keyword
set key $type:$kwlist
lappend content [list $key $title $type $kwlist $body $code]
set title {}
set keywords {}
set type {}
set body {}
set code {}
set phase 0
} else {
if {[regexp {^#define (SQLITE_[A-Z0-9_]+)} $line all kx]} {
set type constant
set keyword($kx) 1
} elseif {[regexp {^typedef .* (sqlite[0-9a-z_]+);} $line all kx]} {
set type datatype
set keyword($kx) 1
} elseif {[regexp {^[a-z].*[ *](sqlite3_[a-z0-9_]+)\(} $line all kx]} {
set type function
set keyword($kx) 1
}
append code $line\n
}
}
}
# Output HTML that displays the given list in N columns
#
proc output_list {N lx} {
puts {<table width="100%" cellpadding="5"><tr>}
set len [llength $lx]
set n [expr {($len + $N - 1)/$N}]
for {set i 0} {$i<$N} {incr i} {
set start [expr {$i*$n}]
set end [expr {($i+1)*$n}]
puts {<td valign="top"><ul>}
for {set j $start} {$j<$end} {incr j} {
set entry [lindex $lx $j]
if {$entry!=""} {
foreach {link label} $entry break
puts "<li><a href=\"#$link\">$label</a></li>"
}
}
puts {</ul></td>}
}
puts {</tr></table>}
}
# Do a table of contents for objects
#
set objlist {}
foreach c $content {
foreach {key title type keywords body code} $c break
if {$type!="datatype"} continue
set keywords [lsort $keywords]
set k [lindex $keywords 0]
foreach kw $keywords {
lappend objlist [list $k $kw]
}
}
puts {<h2>Datatypes:</h2>}
output_list 3 $objlist
puts {<hr>}
# Do a table of contents for constants
#
set clist {}
foreach c $content {
foreach {key title type keywords body code} $c break
if {$type!="constant"} continue
set keywords [lsort $keywords]
set k [lindex $keywords 0]
foreach kw $keywords {
lappend clist [list $k $kw]
}
}
puts {<h2>Constants:</h2>}
set clist [lsort -index 1 $clist]
output_list 3 $clist
puts {<hr>}
# Do a table of contents for functions
#
set funclist {}
foreach c $content {
foreach {key title type keywords body code} $c break
if {$type!="function"} continue
set keywords [lsort $keywords]
set k [lindex $keywords 0]
foreach kw $keywords {
lappend funclist [list $k $kw]
}
}
puts {<h2>Functions:</h2>}
set funclist [lsort -index 1 $funclist]
output_list 3 $funclist
puts {<hr>}
# Resolve links
#
proc resolve_links {args} {
set tag [lindex $args 0]
regsub -all {[^a-zA-Z0-9_]} $tag {} tag
set x "<a href=\"#$tag\">"
if {[llength $args]>2} {
append x [lrange $args 2 end]</a>
} else {
append x [lindex $args 0]</a>
}
return $x
}
# Output all the records
#
foreach c [lsort $content] {
foreach {key title type keywords body code} $c break
foreach k $keywords {
puts "<a name=\"$k\"></a>"
}
puts "<h2>$title</h2>"
puts "<blockquote><pre>"
puts "$code"
puts "</pre></blockquote>"
regsub -all "\n\n+" $body {</p>\1<p>} body
regsub -all {\[} <p>$body</p> {[resolve_links } body
set body [subst -novar -noback $body]
puts "$body"
puts "<hr>"
}
|
