Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Add new page session.in to document the session module. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
fd135b2345ec235ac1dfe459e3063adf |
User & Date: | dan 2011-03-20 11:13:15.000 |
Context
2011-03-21
| ||
02:19 | Automatically create the "session" subdirectory if it does not previously exist. (check-in: ddc0a3baa3 user: drh tags: trunk) | |
2011-03-20
| ||
11:13 | Add new page session.in to document the session module. (check-in: fd135b2345 user: dan tags: trunk) | |
2011-03-17
| ||
14:13 | Add Nokia back to the list of sponsors. (check-in: 1fe83b7e46 user: drh tags: trunk) | |
Changes
Added pages/session.in.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 | <title>SQLite Session Module C/C++ Interface</title> <h2>SQLite Session Module C/C++ Interface</h2> <tcl> set hdrfile [file join $SRC ext session sqlite3session.h] if {[file exists $hdrfile]} { set in [open $hdrfile] } else { set in [open /dev/null] } set title {} ;# title of a section of interface definition set type {} ;# one of: constant datatype function set body {} ;# human-readable description set code {} ;# C code of the definition set phase 0 ;# Phase used by the parser set content {} ;# List of records, one record per definition set dcnt 0 ;# Number of individual declarations set lineno 0 ;# input file line number set intab 0 ;# In a covenents or limitations table set inrow 0 ;# In a row of a table set rowbody {} ;# Content of a row set rowtag {} ;# set exflag 0 ;# True for experimental interfaces set obsflag 0 ;# True for obsolete interfaces unset -nocomplain keyword unset -nocomplain supported ;# 0: stable. 1: experimental 2: deprecated # End a table row or the complete table. # proc endrow {} { global inrow body rowbody rowtag keyword dflt_parent if {$inrow} { set rowbody [string trim $rowbody] append body $rowbody</td></tr>\n if {$dflt_parent!=""} { append rowbody " <$dflt_parent>" } #hd_requirement $rowtag $rowbody #set keyword($rowtag) 1 set inrow 0 set rowbody {} set rowtag {} } } proc endtab {} { global intab body endrow if {$intab} { append body "</table>\n" set intab 0 } } proc starttab {} { global intab body endtab append body {<table border="0" cellpadding="5" cellspacing="0">} append body \n set intab 1 } # Read sqlite3.c line by line and extract interface definition # information (found in what was originally sqlite3.h). # while {![eof $in]} { set line [gets $in] incr lineno if {$phase==0} { # Looking for the CAPI3REF: keyword. This marks the beginning of # an interface definition. When the CAPI3REF keywords is seen, # record the interface title and then switch to "phase 1". # if {[regexp {^\*\* CAPI3REF: +(.*)} $line all tx]} { set title $tx set dflt_parent {} regexp {<([AHLS]\d\d\d\d\d)>} $title all dflt_parent set title_lineno $lineno set phase 1 } } elseif {$phase==1} { if {[string range $line 0 1]=="**"} { # Record all lines of column following the CAPI3REF keyword as the # description of the interface. Except, look for special keywords # CATEGORY, KEYWORDS, INVARIANTS, and ASSUMPTIONS and process them # separately. # 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 } } elseif {[regexp {^EXPERIMENTAL} $lx]} { set exflag 1 } elseif {[regexp {^DEPRECATED} $lx]} { set obsflag 1 } else { append body $lx\n } } elseif {[string range $line 0 1]=="*/"} { # When we reach the end of the block comment that contained the # CAPI3REF keyword, that ends the description. Switch to phase 3 # in order to begin picking up the interface definition. # set phase 2 } } elseif {$phase==2} { # Reading in an interface definition. Stop reading at the first blank # line. # # Ignore API tags. regsub {^SQLITE_DEPRECATED } $line {} line regsub {^SQLITE_EXPERIMENTAL } $line {} line regsub {^SQLITE_API } $line {} line if {$line==""} { set reqtag {} set reqdf {} if {[regexp {\{([AHLS]\d\d\d\d\d)\}} $title all reqtag]} { regsub { *\{[AHLS]\d\d\d\d\d\}} $title {} title while {[regexp {<([AHLS]\d\d\d\d\d)>} $title all df]} { append reqdf <$df> regsub { *<[AHLS]\d\d\d\d\d>} $title {} title } # set keyword($reqtag) 1 } set kwlist [lsort [array names keyword]] unset -nocomplain keyword if {$exflag} { foreach kw $kwlist {set supported($kw) 1} } elseif {$obsflag} { foreach kw $kwlist {set supported($kw) 2} } else { foreach kw $kwlist {set supported($kw) 0} } set exflag 0 set obsflag 0 set key $type:$kwlist regsub -all { *\{[\w.]+\}} $body {} body set body [string map \ {<todo> {<font color="red">(TODO: } </todo> )</font>} $body] set code [string map {& & < < > >} $code] lappend content [list $key $title $type $kwlist $body $code] set title {} set keywords {} set type {} set body {} set code {} set phase 0 set dcnt 0 } else { if {[regexp {^#define (SQLITE_[A-Z0-9_]+)} $line all kx]} { set type constant set keyword($kx) 1 incr dcnt } elseif {[regexp {^typedef .*(sqlite[0-9a-z_]+);} $line all kx]} { set type datatype set keyword($kx) 1 incr dcnt } elseif {[regexp {^struct (sqlite3[0-9a-z_]+)} $line all kx]} { set type datatype set keyword($kx) 1 incr dcnt } elseif {[regexp {^[a-z].*[ *](sqlite3[a-z0-9_]+)\(} $line all kx]} { set type function set keyword($kx) 1 incr dcnt } elseif {[regexp {^[a-z].*[ *](sqlite3[a-z0-9_]+);} $line all kx]} { set type datatype set keyword($kx) 1 incr dcnt } elseif {[regexp {^SQLITE_EXTERN .*(sqlite[0-9a-z_]+);} $line all kx]} { set type datatype set keyword($kx) 1 incr dcnt } append code $line\n } } } # Convert a tag name into the filename used for the # multi-file version. # # Constants begin with SQLITE_. The names are converted # to lower case and prefixed with "c_". If we did not # do this, then the names "SQLITE_BLOB" and "sqlite3_blob" # would collide. # proc convert_keyword_to_filename {oldname} { set oldname [string tolower $oldname] regsub {^sqlite_} $oldname {c_} oldname regsub {^sqlite3_} $oldname {} name return $name.html } # Output HTML that displays the list $lx in $N columns # proc output_list {N lx} { hd_putsnl {<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}] hd_puts {<td valign="top"><ul>} for {set j $start} {$j<$end} {incr j} { set entry [lindex $lx $j] if {$entry!=""} { foreach {link label s} $entry break if {$s==1} { hd_resolve "<li>\[$link|$label\] " hd_resolve "\[experimental | <small><i>(exp)</i></small>\]</li>" } elseif {$s==2} { hd_resolve "<li>\[$link|$label\] " hd_resolve "\[deprecated | <small><i>(obs)</i></small>\]</li>" } else { hd_resolve "<li>\[$link|$label\]</li>" } hd_puts \n } } hd_putsnl {</ul></td>} } hd_putsnl {</tr></table>} } hd_open_aux session/intro.html hd_header Introduction hd_enable_main 0 hd_keywords *session {Session Module C-language Interface} </tcl> <p>These pages define the C-language interface to SQLite.</p> <p>This is not a tutorial. These pages are designed to be precise, not easy to read. For a tutorial introduction see [quickstart | SQLite In 3 Minutes Or Less] and/or the [cintro | Introduction To The SQLite C/C++ Interface]. </p> <p>This version of the C-language interface reference is broken down into small pages for easy viewing. The same content is also available as a <a href="../session.html">single large HTML file</a> for those who prefer that format.</p> <p>The content on these pages is extracted from comments in the source code.</p> <p>The interface is broken down into three categories:</p> <ol> <li><p><a href="objlist.html"><b>List Of Objects.</b></a> This is a list of all abstract objects and datatypes used by the SQLite library. There are couple dozen objects in total, but the three most important objects are: A database connection object [sqlite3], prepared statement object [sqlite3_stmt], and the 64-bit integer type [sqlite3_int64].</p></li> <li><p><a href="constlist.html"><b>List Of Constants.</b></a> This is a list of numeric constants used by SQLite and represented by #defines in the sqlite3session.h header file. These constants are things such as numeric return parameters from various interfaces (ex: [SQLITE_OK] or flags passed into functions to control behavior (ex: [SQLITE_OPEN_READONLY]).</p></li> <li><p><a href="funclist.html"><b>List Of Functions.</b></a> This is a list of all functions and methods operating on the <a href="objlist.html">objects</a> and using and/or returning <a href="constlist.html">constants</a>. There are many functions, but most applications only use a handful. </p></li> </ol> <tcl> hd_close_aux hd_enable_main 1 </tcl> <p>This page defines the C-language interface to the SQLite session module. This is not a tutorial. These pages are designed to be precise, not easy to read. Unfortunately, there is currently no tutorial introduction to the session module. <p>This page contains all C-language interface information in a single HTML file. The same information is also available broken out into <a href="session/intro.html">lots of small pages</a> for easier viewing, if you prefer.</p> <p>This document is created by a script which scans comments in the source code file sqlite3session.h.</p> <hr> <tcl> # Find the preferred keyword for a page given a list of # acceptable keywords. # proc preferred_keyword {keyword_list} { foreach kw $keyword_list { if {[regexp -nocase {^sqlite} $kw]} break } return $kw } <tcl> # 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 [preferred_keyword $keywords] set s $supported($k) foreach kw $keywords { if {[regexp {^sqlite} $kw]} { lappend objlist [list $k $kw $s] } } } hd_open_aux session/objlist.html hd_header {List Of SQLite Objects} hd_enable_main 0 hd_putsnl {<a href="intro.html"><h2>SQLite C Interface</h2></a>} hd_enable_main 1 </tcl> <h2>Objects:</h2> <tcl> output_list 3 [lsort $objlist] hd_enable_main 0 hd_putsnl {<p>Other lists: <a href="constlist.html">Constants</a> and <a href="funclist.html">Functions</a>.} hd_close_aux hd_enable_main 1 hd_putsnl {<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 [preferred_keyword $keywords] set s $supported($k) foreach kw $keywords { if {[regexp {^SQLITE_} $kw]} { lappend clist [list $k $kw $s] } } } hd_open_aux session/constlist.html hd_header {List Of SQLite Constants} hd_enable_main 0 hd_putsnl {<a href="intro.html"><h2>SQLite C Interface</h2></a>} hd_enable_main 1 </tcl> <h2>Constants:</h2> <tcl> set clist [lsort -index 1 $clist] output_list 2 $clist hd_enable_main 0 hd_putsnl {<p>Other lists: <a href="objlist.html">Objects</a> and <a href="funclist.html">Functions</a>.</p>} hd_enable_main 1 hd_close_aux hd_putsnl {<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 [preferred_keyword $keywords] set s $supported($k) foreach kw $keywords { if {[regexp {^sqlite} $kw]} { lappend funclist [list $k $kw $s] } } } hd_open_aux session/funclist.html hd_header {List Of SQLite Functions} hd_keywords *session_funclist {Session Module C-API function list} hd_enable_main 0 hd_putsnl {<a href="intro.html"><h2>SQLite C Interface</h2></a>} hd_enable_main 1 </tcl> <h2>Functions:</h2> <tcl> set funclist [lsort -index 1 $funclist] output_list 3 $funclist hd_enable_main 0 hd_putsnl {<p>Other lists: <a href="constlist.html">Constants</a> and <a href="objlist.html">Objects</a>.</p>} hd_enable_main 1 hd_close_aux hd_putsnl {<hr>} # Output all the records # foreach c [lsort $content] { foreach {key title type keywords body code} $c break set kw [preferred_keyword [lsort $keywords]] hd_fragment $kw hd_open_aux session/[convert_keyword_to_filename $kw] hd_header $title hd_enable_main 0 hd_puts {<a href="intro.html"><h2>SQLite C Interface</h2></a>} hd_enable_main 1 eval hd_keywords $keywords hd_puts "<h2>$title</h2>" hd_puts "<blockquote><pre>" hd_puts "$code" hd_puts "</pre></blockquote>" if {$supported($kw)==1} { hd_resolve {<p><b>Important:</b> This interface is [experimental] } hd_resolve {and is subject to change without notice.</p>} } regsub -all "\n\n+" $body "</p>\n\n<p>" body hd_resolve <p>$body</p> hd_enable_main 0 hd_puts {<p>See also lists of <a href="objlist.html">Objects</a>, <a href="constlist.html">Constants</a>, and <a href="funclist.html">Functions</a>.</p>} hd_enable_main 1 hd_close_aux hd_puts "<hr>" } </tcl> |