/ Hex Artifact Content
Login
SQLite training in Houston TX on 2019-11-05 (details)
Part of the 2019 Tcl Conference

Artifact d1b6362bd3aa80d5520d4d6f3765badf01f6c43c:


0000: 23 21 2f 75 73 72 2f 62 69 6e 2f 74 63 6c 73 68  #!/usr/bin/tclsh
0010: 0a 23 0a 23 20 54 68 69 73 20 54 43 4c 20 73 63  .#.# This TCL sc
0020: 72 69 70 74 20 73 63 61 6e 73 20 74 68 65 20 6f  ript scans the o
0030: 70 63 6f 64 65 73 2e 68 20 66 69 6c 65 20 28 77  pcodes.h file (w
0040: 68 69 63 68 20 69 73 20 69 74 73 65 6c 66 20 67  hich is itself g
0050: 65 6e 65 72 61 74 65 64 20 62 79 0a 23 20 61 6e  enerated by.# an
0060: 6f 74 68 65 72 20 54 43 4c 20 73 63 72 69 70 74  other TCL script
0070: 29 20 61 6e 64 20 75 73 65 73 20 74 68 65 20 69  ) and uses the i
0080: 6e 66 6f 72 6d 61 74 69 6f 6e 20 67 6c 65 61 6e  nformation glean
0090: 65 64 20 74 6f 20 63 72 65 61 74 65 20 74 68 65  ed to create the
00a0: 0a 23 20 6f 70 63 6f 64 65 73 2e 63 20 73 6f 75  .# opcodes.c sou
00b0: 72 63 65 20 66 69 6c 65 2e 0a 23 0a 23 20 4f 70  rce file..#.# Op
00c0: 63 6f 64 65 73 2e 63 20 63 6f 6e 74 61 69 6e 73  codes.c contains
00d0: 20 73 74 72 69 6e 67 73 20 77 68 69 63 68 20 61   strings which a
00e0: 72 65 20 74 68 65 20 73 79 6d 62 6f 6c 69 63 20  re the symbolic 
00f0: 6e 61 6d 65 73 20 66 6f 72 20 74 68 65 20 76 61  names for the va
0100: 72 69 6f 75 73 0a 23 20 6f 70 63 6f 64 65 73 20  rious.# opcodes 
0110: 75 73 65 64 20 62 79 20 74 68 65 20 56 44 42 45  used by the VDBE
0120: 2e 20 20 54 68 65 73 65 20 73 74 72 69 6e 67 73  .  These strings
0130: 20 61 72 65 20 75 73 65 64 20 77 68 65 6e 20 64   are used when d
0140: 69 73 61 73 73 65 6d 62 6c 69 6e 67 20 61 0a 23  isassembling a.#
0150: 20 56 44 42 45 20 70 72 6f 67 72 61 6d 20 64 75   VDBE program du
0160: 72 69 6e 67 20 74 72 61 63 69 6e 67 20 6f 72 20  ring tracing or 
0170: 61 73 20 61 20 72 65 73 75 6c 74 20 6f 66 20 74  as a result of t
0180: 68 65 20 45 58 50 4c 41 49 4e 20 6b 65 79 77 6f  he EXPLAIN keywo
0190: 72 64 2e 0a 23 0a 70 75 74 73 20 22 2f 2a 20 41  rd..#.puts "/* A
01a0: 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 67 65 6e  utomatically gen
01b0: 65 72 61 74 65 64 2e 20 20 44 6f 20 6e 6f 74 20  erated.  Do not 
01c0: 65 64 69 74 20 2a 2f 22 0a 70 75 74 73 20 22 2f  edit */".puts "/
01d0: 2a 20 53 65 65 20 74 68 65 20 74 6f 6f 6c 2f 6d  * See the tool/m
01e0: 6b 6f 70 63 6f 64 65 63 2e 74 63 6c 20 73 63 72  kopcodec.tcl scr
01f0: 69 70 74 20 66 6f 72 20 64 65 74 61 69 6c 73 2e  ipt for details.
0200: 20 2a 2f 22 0a 70 75 74 73 20 22 23 69 66 20 21   */".puts "#if !
0210: 64 65 66 69 6e 65 64 28 53 51 4c 49 54 45 5f 4f  defined(SQLITE_O
0220: 4d 49 54 5f 45 58 50 4c 41 49 4e 29 20 5c 5c 22  MIT_EXPLAIN) \\"
0230: 0a 70 75 74 73 20 22 20 7c 7c 20 64 65 66 69 6e  .puts " || defin
0240: 65 64 28 56 44 42 45 5f 50 52 4f 46 49 4c 45 29  ed(VDBE_PROFILE)
0250: 20 5c 5c 22 0a 70 75 74 73 20 22 20 7c 7c 20 64   \\".puts " || d
0260: 65 66 69 6e 65 64 28 53 51 4c 49 54 45 5f 44 45  efined(SQLITE_DE
0270: 42 55 47 29 22 0a 70 75 74 73 20 22 23 69 66 20  BUG)".puts "#if 
0280: 64 65 66 69 6e 65 64 28 53 51 4c 49 54 45 5f 45  defined(SQLITE_E
0290: 4e 41 42 4c 45 5f 45 58 50 4c 41 49 4e 5f 43 4f  NABLE_EXPLAIN_CO
02a0: 4d 4d 45 4e 54 53 29 20 7c 7c 20 64 65 66 69 6e  MMENTS) || defin
02b0: 65 64 28 53 51 4c 49 54 45 5f 44 45 42 55 47 29  ed(SQLITE_DEBUG)
02c0: 22 0a 70 75 74 73 20 22 23 20 64 65 66 69 6e 65  ".puts "# define
02d0: 20 4f 70 48 65 6c 70 28 58 29 20 5c 22 5c 5c 30   OpHelp(X) \"\\0
02e0: 5c 22 20 58 22 0a 70 75 74 73 20 22 23 65 6c 73  \" X".puts "#els
02f0: 65 22 0a 70 75 74 73 20 22 23 20 64 65 66 69 6e  e".puts "# defin
0300: 65 20 4f 70 48 65 6c 70 28 58 29 22 0a 70 75 74  e OpHelp(X)".put
0310: 73 20 22 23 65 6e 64 69 66 22 0a 70 75 74 73 20  s "#endif".puts 
0320: 22 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c  "const char *sql
0330: 69 74 65 33 4f 70 63 6f 64 65 4e 61 6d 65 28 69  ite3OpcodeName(i
0340: 6e 74 20 69 29 5c 31 37 33 22 0a 70 75 74 73 20  nt i)\173".puts 
0350: 22 20 73 74 61 74 69 63 20 63 6f 6e 73 74 20 63  " static const c
0360: 68 61 72 20 2a 63 6f 6e 73 74 20 61 7a 4e 61 6d  har *const azNam
0370: 65 5c 5b 5c 5d 20 3d 20 5c 31 37 33 22 0a 73 65  e\[\] = \173".se
0380: 74 20 6d 78 20 30 0a 0a 73 65 74 20 69 6e 20 5b  t mx 0..set in [
0390: 6f 70 65 6e 20 5b 6c 69 6e 64 65 78 20 24 61 72  open [lindex $ar
03a0: 67 76 20 30 5d 20 72 62 5d 0a 77 68 69 6c 65 20  gv 0] rb].while 
03b0: 7b 21 5b 65 6f 66 20 24 69 6e 5d 7d 20 7b 0a 20  {![eof $in]} {. 
03c0: 20 73 65 74 20 6c 69 6e 65 20 5b 67 65 74 73 20   set line [gets 
03d0: 24 69 6e 5d 0a 20 20 69 66 20 7b 5b 72 65 67 65  $in].  if {[rege
03e0: 78 70 20 7b 5e 23 64 65 66 69 6e 65 20 4f 50 5f  xp {^#define OP_
03f0: 7d 20 24 6c 69 6e 65 5d 7d 20 7b 0a 20 20 20 20  } $line]} {.    
0400: 73 65 74 20 6e 61 6d 65 20 5b 6c 69 6e 64 65 78  set name [lindex
0410: 20 24 6c 69 6e 65 20 31 5d 0a 20 20 20 20 72 65   $line 1].    re
0420: 67 73 75 62 20 7b 5e 4f 50 5f 7d 20 24 6e 61 6d  gsub {^OP_} $nam
0430: 65 20 7b 7d 20 6e 61 6d 65 0a 20 20 20 20 73 65  e {} name.    se
0440: 74 20 69 20 5b 6c 69 6e 64 65 78 20 24 6c 69 6e  t i [lindex $lin
0450: 65 20 32 5d 0a 20 20 20 20 73 65 74 20 6c 61 62  e 2].    set lab
0460: 65 6c 28 24 69 29 20 24 6e 61 6d 65 0a 20 20 20  el($i) $name.   
0470: 20 69 66 20 7b 24 6d 78 3c 24 69 7d 20 7b 73 65   if {$mx<$i} {se
0480: 74 20 6d 78 20 24 69 7d 0a 20 20 20 20 69 66 20  t mx $i}.    if 
0490: 7b 5b 72 65 67 65 78 70 20 7b 73 79 6e 6f 70 73  {[regexp {synops
04a0: 69 73 3a 20 28 2e 2a 29 20 5c 2a 2f 7d 20 24 6c  is: (.*) \*/} $l
04b0: 69 6e 65 20 61 6c 6c 20 78 5d 7d 20 7b 0a 20 20  ine all x]} {.  
04c0: 20 20 20 20 73 65 74 20 73 79 6e 6f 70 73 69 73      set synopsis
04d0: 28 24 69 29 20 5b 73 74 72 69 6e 67 20 74 72 69  ($i) [string tri
04e0: 6d 20 24 78 5d 0a 20 20 20 20 7d 20 65 6c 73 65  m $x].    } else
04f0: 20 7b 0a 20 20 20 20 20 20 73 65 74 20 73 79 6e   {.      set syn
0500: 6f 70 73 69 73 28 24 69 29 20 7b 7d 0a 20 20 20  opsis($i) {}.   
0510: 20 7d 0a 20 20 7d 0a 7d 0a 63 6c 6f 73 65 20 24   }.  }.}.close $
0520: 69 6e 0a 0a 66 6f 72 20 7b 73 65 74 20 69 20 30  in..for {set i 0
0530: 7d 20 7b 24 69 3c 3d 24 6d 78 7d 20 7b 69 6e 63  } {$i<=$mx} {inc
0540: 72 20 69 7d 20 7b 0a 20 20 70 75 74 73 20 5b 66  r i} {.  puts [f
0550: 6f 72 6d 61 74 20 22 20 20 20 20 2f 2a 20 25 33  ormat "    /* %3
0560: 64 20 2a 2f 20 25 2d 31 38 73 20 4f 70 48 65 6c  d */ %-18s OpHel
0570: 70 28 5c 22 25 73 5c 22 29 2c 22 20 5c 0a 20 20  p(\"%s\")," \.  
0580: 20 20 20 20 20 20 20 24 69 20 5c 22 24 6c 61 62         $i \"$lab
0590: 65 6c 28 24 69 29 5c 22 20 24 73 79 6e 6f 70 73  el($i)\" $synops
05a0: 69 73 28 24 69 29 5d 0a 7d 0a 70 75 74 73 20 22  is($i)].}.puts "
05b0: 20 20 5c 31 37 35 3b 22 0a 70 75 74 73 20 22 20    \175;".puts " 
05c0: 20 72 65 74 75 72 6e 20 61 7a 4e 61 6d 65 5c 5b   return azName\[
05d0: 69 5c 5d 3b 22 0a 70 75 74 73 20 22 5c 31 37 35  i\];".puts "\175
05e0: 22 0a 70 75 74 73 20 22 23 65 6e 64 69 66 22 0a  ".puts "#endif".