cmdr
Hex Artifact Content
Not logged in
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to [email protected]
or submit via the online form by Sep 9.

Artifact 05fafb8b1a718c716428ea6cd551d06f85c53a83:


0000: 23 23 20 2d 2a 2d 20 74 63 6c 20 2d 2a 2d 0a 23  ## -*- tcl -*-.#
0010: 20 23 20 23 23 20 23 23 23 20 23 23 23 23 23 20   # ## ### ##### 
0020: 23 23 23 23 23 23 23 23 20 23 23 23 23 23 23 23  ######## #######
0030: 23 23 23 23 23 23 20 23 23 23 23 23 23 23 23 23  ###### #########
0040: 23 23 23 23 23 23 23 23 23 23 23 23 0a 23 23 20  ############.## 
0050: 43 4d 44 52 20 2d 20 48 65 6c 70 20 2d 20 4a 53  CMDR - Help - JS
0060: 4f 4e 20 66 6f 72 6d 61 74 2e 20 4e 6f 74 20 61  ON format. Not a
0070: 76 61 69 6c 61 62 6c 65 20 62 79 20 64 65 66 61  vailable by defa
0080: 75 6c 74 2e 0a 23 23 20 52 65 71 75 69 72 65 20  ult..## Require 
0090: 74 68 69 73 20 70 61 63 6b 61 67 65 20 62 65 66  this package bef
00a0: 6f 72 65 20 63 72 65 61 74 69 6f 6e 20 61 20 63  ore creation a c
00b0: 6f 6d 6d 61 6e 64 65 72 2c 20 73 6f 20 74 68 61  ommander, so tha
00c0: 74 20 74 68 65 0a 23 23 20 6d 64 72 3a 3a 68 65  t the.## mdr::he
00d0: 6c 70 20 68 65 75 72 69 73 74 69 63 73 20 73 65  lp heuristics se
00e0: 65 20 61 6e 64 20 61 75 74 6f 6d 61 74 69 63 61  e and automatica
00f0: 6c 6c 79 20 69 6e 74 65 67 72 61 74 65 20 74 68  lly integrate th
0100: 65 20 66 6f 72 6d 61 74 2e 0a 0a 23 20 40 40 20  e format...# @@ 
0110: 4d 65 74 61 20 42 65 67 69 6e 0a 23 20 50 61 63  Meta Begin.# Pac
0120: 6b 61 67 65 20 63 6d 64 72 3a 3a 68 65 6c 70 3a  kage cmdr::help:
0130: 3a 6a 73 6f 6e 20 31 2e 30 0a 23 20 4d 65 74 61  :json 1.0.# Meta
0140: 20 61 75 74 68 6f 72 20 20 20 7b 41 6e 64 72 65   author   {Andre
0150: 61 73 20 4b 75 70 72 69 65 73 7d 0a 23 20 4d 65  as Kupries}.# Me
0160: 74 61 20 6c 6f 63 61 74 69 6f 6e 20 68 74 74 70  ta location http
0170: 73 3a 2f 2f 63 6f 72 65 2e 74 63 6c 2e 74 6b 2f  s://core.tcl.tk/
0180: 61 6b 75 70 72 69 65 73 2f 63 6d 64 72 0a 23 20  akupries/cmdr.# 
0190: 4d 65 74 61 20 70 6c 61 74 66 6f 72 6d 20 74 63  Meta platform tc
01a0: 6c 0a 23 20 4d 65 74 61 20 73 75 6d 6d 61 72 79  l.# Meta summary
01b0: 20 20 20 20 20 46 6f 72 6d 61 74 74 69 6e 67 20       Formatting 
01c0: 68 65 6c 70 20 61 73 20 4a 53 4f 4e 20 6f 62 6a  help as JSON obj
01d0: 65 63 74 2e 0a 23 20 4d 65 74 61 20 64 65 73 63  ect..# Meta desc
01e0: 72 69 70 74 69 6f 6e 20 46 6f 72 6d 61 74 74 69  ription Formatti
01f0: 6e 67 20 68 65 6c 70 20 61 73 20 4a 53 4f 4e 20  ng help as JSON 
0200: 6f 62 6a 65 63 74 2e 0a 23 20 4d 65 74 61 20 73  object..# Meta s
0210: 75 62 6a 65 63 74 20 7b 63 6f 6d 6d 61 6e 64 20  ubject {command 
0220: 6c 69 6e 65 7d 0a 23 20 4d 65 74 61 20 72 65 71  line}.# Meta req
0230: 75 69 72 65 20 7b 54 63 6c 20 38 2e 35 2d 7d 0a  uire {Tcl 8.5-}.
0240: 23 20 4d 65 74 61 20 72 65 71 75 69 72 65 20 64  # Meta require d
0250: 65 62 75 67 0a 23 20 4d 65 74 61 20 72 65 71 75  ebug.# Meta requ
0260: 69 72 65 20 64 65 62 75 67 3a 3a 63 61 6c 6c 65  ire debug::calle
0270: 72 0a 23 20 4d 65 74 61 20 72 65 71 75 69 72 65  r.# Meta require
0280: 20 7b 63 6d 64 72 3a 3a 68 65 6c 70 20 31 7d 0a   {cmdr::help 1}.
0290: 23 20 4d 65 74 61 20 72 65 71 75 69 72 65 20 7b  # Meta require {
02a0: 63 6d 64 72 3a 3a 75 74 69 6c 20 31 7d 0a 23 20  cmdr::util 1}.# 
02b0: 4d 65 74 61 20 72 65 71 75 69 72 65 20 6a 73 6f  Meta require jso
02c0: 6e 3a 3a 77 72 69 74 65 0a 23 20 40 40 20 4d 65  n::write.# @@ Me
02d0: 74 61 20 45 6e 64 0a 0a 23 20 23 20 23 23 20 23  ta End..# # ## #
02e0: 23 23 20 23 23 23 23 23 20 23 23 23 23 23 23 23  ## ##### #######
02f0: 23 20 23 23 23 23 23 23 23 23 23 23 23 23 23 20  # ############# 
0300: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0310: 23 23 23 23 23 0a 23 23 20 52 65 71 75 69 73 69  #####.## Requisi
0320: 74 65 73 0a 0a 70 61 63 6b 61 67 65 20 72 65 71  tes..package req
0330: 75 69 72 65 20 54 63 6c 20 38 2e 35 0a 70 61 63  uire Tcl 8.5.pac
0340: 6b 61 67 65 20 72 65 71 75 69 72 65 20 64 65 62  kage require deb
0350: 75 67 0a 70 61 63 6b 61 67 65 20 72 65 71 75 69  ug.package requi
0360: 72 65 20 64 65 62 75 67 3a 3a 63 61 6c 6c 65 72  re debug::caller
0370: 0a 70 61 63 6b 61 67 65 20 72 65 71 75 69 72 65  .package require
0380: 20 63 6d 64 72 3a 3a 68 65 6c 70 20 31 0a 70 61   cmdr::help 1.pa
0390: 63 6b 61 67 65 20 72 65 71 75 69 72 65 20 63 6d  ckage require cm
03a0: 64 72 3a 3a 75 74 69 6c 20 31 0a 70 61 63 6b 61  dr::util 1.packa
03b0: 67 65 20 72 65 71 75 69 72 65 20 6a 73 6f 6e 3a  ge require json:
03c0: 3a 77 72 69 74 65 0a 0a 23 20 23 20 23 23 20 23  :write..# # ## #
03d0: 23 23 20 23 23 23 23 23 20 23 23 23 23 23 23 23  ## ##### #######
03e0: 23 20 23 23 23 23 23 23 23 23 23 23 23 23 23 20  # ############# 
03f0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0400: 23 23 23 23 23 0a 0a 64 65 62 75 67 20 64 65 66  #####..debug def
0410: 69 6e 65 20 63 6d 64 72 2f 68 65 6c 70 2f 6a 73  ine cmdr/help/js
0420: 6f 6e 0a 64 65 62 75 67 20 6c 65 76 65 6c 20 20  on.debug level  
0430: 63 6d 64 72 2f 68 65 6c 70 2f 6a 73 6f 6e 0a 64  cmdr/help/json.d
0440: 65 62 75 67 20 70 72 65 66 69 78 20 63 6d 64 72  ebug prefix cmdr
0450: 2f 68 65 6c 70 2f 6a 73 6f 6e 20 7b 5b 64 65 62  /help/json {[deb
0460: 75 67 20 63 61 6c 6c 65 72 5d 20 7c 20 7d 0a 0a  ug caller] | }..
0470: 23 20 23 20 23 23 20 23 23 23 20 23 23 23 23 23  # # ## ### #####
0480: 20 23 23 23 23 23 23 23 23 20 23 23 23 23 23 23   ######## ######
0490: 23 23 23 23 23 23 23 20 23 23 23 23 23 23 23 23  ####### ########
04a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 23 23  #############.##
04b0: 20 44 65 66 69 6e 69 74 69 6f 6e 0a 0a 23 20 23   Definition..# #
04c0: 20 23 23 20 23 23 23 20 23 23 23 23 23 20 23 23   ## ### ##### ##
04d0: 23 23 23 23 23 23 20 23 23 23 23 23 23 23 23 23  ###### #########
04e0: 23 23 23 23 20 23 23 23 23 23 23 23 23 23 23 23  #### ###########
04f0: 23 23 23 23 23 23 23 23 23 23 0a 0a 6e 61 6d 65  ##########..name
0500: 73 70 61 63 65 20 65 76 61 6c 20 3a 3a 63 6d 64  space eval ::cmd
0510: 72 3a 3a 68 65 6c 70 3a 3a 66 6f 72 6d 61 74 20  r::help::format 
0520: 7b 0a 20 20 20 20 6e 61 6d 65 73 70 61 63 65 20  {.    namespace 
0530: 65 78 70 6f 72 74 20 6a 73 6f 6e 0a 20 20 20 20  export json.    
0540: 6e 61 6d 65 73 70 61 63 65 20 65 6e 73 65 6d 62  namespace ensemb
0550: 6c 65 20 63 72 65 61 74 65 0a 0a 20 20 20 20 6e  le create..    n
0560: 61 6d 65 73 70 61 63 65 20 69 6d 70 6f 72 74 20  amespace import 
0570: 3a 3a 63 6d 64 72 3a 3a 68 65 6c 70 3a 3a 71 75  ::cmdr::help::qu
0580: 65 72 79 0a 7d 0a 0a 23 20 23 20 23 23 20 23 23  ery.}..# # ## ##
0590: 23 20 23 23 23 23 23 20 23 23 23 23 23 23 23 23  # ##### ########
05a0: 20 23 23 23 23 23 23 23 23 23 23 23 23 23 20 23   ############# #
05b0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
05c0: 23 23 23 23 0a 0a 70 72 6f 63 20 3a 3a 63 6d 64  ####..proc ::cmd
05d0: 72 3a 3a 68 65 6c 70 3a 3a 66 6f 72 6d 61 74 3a  r::help::format:
05e0: 3a 6a 73 6f 6e 20 7b 72 6f 6f 74 20 77 69 64 74  :json {root widt
05f0: 68 20 68 65 6c 70 7d 20 7b 0a 20 20 20 20 64 65  h help} {.    de
0600: 62 75 67 2e 63 6d 64 72 2f 68 65 6c 70 2f 6a 73  bug.cmdr/help/js
0610: 6f 6e 20 7b 7d 0a 20 20 20 20 23 20 68 65 6c 70  on {}.    # help
0620: 20 3d 20 64 69 63 74 20 28 6e 61 6d 65 20 2d 3e   = dict (name ->
0630: 20 63 6f 6d 6d 61 6e 64 29 0a 0a 20 20 20 20 23   command)..    #
0640: 20 53 74 65 70 20 31 2e 20 43 6f 6d 6d 61 6e 64   Step 1. Command
0650: 20 6d 61 70 70 69 6e 67 2e 0a 20 20 20 20 73 65   mapping..    se
0660: 74 20 64 69 63 74 20 7b 7d 0a 20 20 20 20 64 69  t dict {}.    di
0670: 63 74 20 66 6f 72 20 7b 63 6d 64 20 64 65 73 63  ct for {cmd desc
0680: 7d 20 24 68 65 6c 70 20 7b 0a 09 6c 61 70 70 65  } $help {..lappe
0690: 6e 64 20 64 69 63 74 20 24 63 6d 64 20 5b 4a 53  nd dict $cmd [JS
06a0: 4f 4e 20 24 64 65 73 63 5d 0a 20 20 20 20 7d 0a  ON $desc].    }.
06b0: 20 20 20 20 73 65 74 20 63 6f 6d 6d 61 6e 64 73      set commands
06c0: 20 5b 6a 73 6f 6e 3a 3a 77 72 69 74 65 20 6f 62   [json::write ob
06d0: 6a 65 63 74 20 7b 2a 7d 24 64 69 63 74 5d 0a 0a  ject {*}$dict]..
06e0: 0a 20 20 20 20 23 20 53 74 65 70 20 32 2e 20 53  .    # Step 2. S
06f0: 65 63 74 69 6f 6e 20 54 72 65 65 2e 20 54 68 69  ection Tree. Thi
0700: 73 20 69 73 20 76 65 72 79 20 73 69 6d 69 6c 61  s is very simila
0710: 72 20 74 6f 0a 20 20 20 20 23 20 63 6d 64 72 3a  r to.    # cmdr:
0720: 3a 68 65 6c 70 3a 3a 66 6f 72 6d 61 74 3a 3a 62  :help::format::b
0730: 79 2d 63 61 74 65 67 6f 72 79 2c 20 61 6e 64 20  y-category, and 
0740: 72 65 2d 75 73 65 73 20 69 74 73 20 66 72 6f 6e  re-uses its fron
0750: 74 65 6e 64 20 68 65 6c 70 65 72 0a 20 20 20 20  tend helper.    
0760: 23 20 63 6f 6d 6d 61 6e 64 73 2e 0a 0a 20 20 20  # commands...   
0770: 20 6c 61 73 73 69 67 6e 20 5b 53 65 63 74 69 6f   lassign [Sectio
0780: 6e 54 72 65 65 20 24 68 65 6c 70 20 30 5d 20 73  nTree $help 0] s
0790: 75 62 63 20 63 6d 64 73 0a 20 20 20 20 66 6f 72  ubc cmds.    for
07a0: 65 61 63 68 20 63 20 5b 53 65 63 74 69 6f 6e 4f  each c [SectionO
07b0: 72 64 65 72 20 24 72 6f 6f 74 20 24 73 75 62 63  rder $root $subc
07c0: 5d 20 7b 0a 09 6c 61 70 70 65 6e 64 20 73 65 63  ] {..lappend sec
07d0: 74 69 6f 6e 73 20 5b 4a 53 4f 4e 3a 3a 61 63 61  tions [JSON::aca
07e0: 74 65 67 6f 72 79 20 5b 3a 3a 6c 69 73 74 20 24  tegory [::list $
07f0: 63 5d 20 24 63 6d 64 73 20 24 73 75 62 63 5d 0a  c] $cmds $subc].
0800: 20 20 20 20 7d 0a 0a 20 20 20 20 72 65 74 75 72      }..    retur
0810: 6e 20 5b 6a 73 6f 6e 3a 3a 77 72 69 74 65 20 6f  n [json::write o
0820: 62 6a 65 63 74 20 5c 0a 09 09 73 65 63 74 69 6f  bject \...sectio
0830: 6e 73 20 5b 6a 73 6f 6e 3a 3a 77 72 69 74 65 20  ns [json::write 
0840: 61 72 72 61 79 20 7b 2a 7d 24 73 65 63 74 69 6f  array {*}$sectio
0850: 6e 73 5d 20 5c 0a 09 09 63 6f 6d 6d 61 6e 64 73  ns] \...commands
0860: 20 24 63 6f 6d 6d 61 6e 64 73 5d 0a 7d 0a 0a 23   $commands].}..#
0870: 20 23 20 23 23 20 23 23 23 20 23 23 23 23 23 20   # ## ### ##### 
0880: 23 23 23 23 23 23 23 23 20 23 23 23 23 23 23 23  ######## #######
0890: 23 23 23 23 23 23 20 23 23 23 23 23 23 23 23 23  ###### #########
08a0: 23 23 23 23 23 23 23 23 23 23 23 23 0a 0a 6e 61  ############..na
08b0: 6d 65 73 70 61 63 65 20 65 76 61 6c 20 3a 3a 63  mespace eval ::c
08c0: 6d 64 72 3a 3a 68 65 6c 70 3a 3a 66 6f 72 6d 61  mdr::help::forma
08d0: 74 3a 3a 4a 53 4f 4e 20 7b 7d 0a 0a 70 72 6f 63  t::JSON {}..proc
08e0: 20 3a 3a 63 6d 64 72 3a 3a 68 65 6c 70 3a 3a 66   ::cmdr::help::f
08f0: 6f 72 6d 61 74 3a 3a 4a 53 4f 4e 3a 3a 61 63 61  ormat::JSON::aca
0900: 74 65 67 6f 72 79 20 7b 70 61 74 68 20 63 6d 64  tegory {path cmd
0910: 73 20 73 75 62 63 7d 20 7b 0a 20 20 20 20 73 65  s subc} {.    se
0920: 74 20 6e 61 6d 65 20 5b 6c 69 6e 64 65 78 20 24  t name [lindex $
0930: 70 61 74 68 20 65 6e 64 5d 0a 0a 20 20 20 20 23  path end]..    #
0940: 20 57 69 74 68 20 73 74 72 75 63 74 3a 3a 6c 69   With struct::li
0950: 73 74 20 6d 61 70 20 77 65 20 63 6f 75 6c 64 20  st map we could 
0960: 74 68 65 6e 20 61 6c 73 6f 20 72 65 2d 75 73 65  then also re-use
0970: 20 61 6c 69 73 74 2e 0a 20 20 20 20 73 65 74 20   alist..    set 
0980: 63 6f 6d 6d 61 6e 64 73 20 7b 7d 0a 20 20 20 20  commands {}.    
0990: 66 6f 72 65 61 63 68 20 64 65 66 20 5b 6c 73 6f  foreach def [lso
09a0: 72 74 20 2d 64 69 63 74 20 2d 75 6e 69 71 75 65  rt -dict -unique
09b0: 20 5b 64 69 63 74 20 67 65 74 20 24 63 6d 64 73   [dict get $cmds
09c0: 20 24 70 61 74 68 5d 5d 20 7b 0a 09 6c 61 73 73   $path]] {..lass
09d0: 69 67 6e 20 24 64 65 66 20 63 6e 61 6d 65 20 5f  ign $def cname _
09e0: 0a 09 6c 61 70 70 65 6e 64 20 63 6f 6d 6d 61 6e  ..lappend comman
09f0: 64 73 20 5b 6a 73 6f 6e 3a 3a 77 72 69 74 65 20  ds [json::write 
0a00: 73 74 72 69 6e 67 20 24 63 6e 61 6d 65 5d 0a 20  string $cname]. 
0a10: 20 20 20 7d 0a 0a 20 20 20 20 73 65 74 20 73 65     }..    set se
0a20: 63 74 69 6f 6e 73 20 7b 7d 0a 20 20 20 20 69 66  ctions {}.    if
0a30: 20 7b 5b 64 69 63 74 20 65 78 69 73 74 73 20 24   {[dict exists $
0a40: 73 75 62 63 20 24 70 61 74 68 5d 7d 20 7b 0a 09  subc $path]} {..
0a50: 23 20 41 64 64 20 74 68 65 20 73 75 62 2d 63 61  # Add the sub-ca
0a60: 74 65 67 6f 72 69 65 73 2c 20 69 66 20 61 6e 79  tegories, if any
0a70: 2e 0a 09 66 6f 72 65 61 63 68 20 63 20 5b 6c 73  ...foreach c [ls
0a80: 6f 72 74 20 2d 64 69 63 74 20 2d 75 6e 69 71 75  ort -dict -uniqu
0a90: 65 20 5b 64 69 63 74 20 67 65 74 20 24 73 75 62  e [dict get $sub
0aa0: 63 20 24 70 61 74 68 5d 5d 20 7b 0a 09 20 20 20  c $path]] {..   
0ab0: 20 6c 61 70 70 65 6e 64 20 73 65 63 74 69 6f 6e   lappend section
0ac0: 73 20 5b 61 63 61 74 65 67 6f 72 79 20 5b 6c 69  s [acategory [li
0ad0: 6e 73 65 72 74 20 24 70 61 74 68 20 65 6e 64 20  nsert $path end 
0ae0: 24 63 5d 20 24 63 6d 64 73 20 24 73 75 62 63 5d  $c] $cmds $subc]
0af0: 0a 09 7d 0a 20 20 20 20 7d 0a 0a 20 20 20 20 72  ..}.    }..    r
0b00: 65 74 75 72 6e 20 5b 6a 73 6f 6e 3a 3a 77 72 69  eturn [json::wri
0b10: 74 65 20 6f 62 6a 65 63 74 20 5c 0a 09 09 6e 61  te object \...na
0b20: 6d 65 20 20 20 20 20 5b 6a 73 6f 6e 3a 3a 77 72  me     [json::wr
0b30: 69 74 65 20 73 74 72 69 6e 67 20 24 6e 61 6d 65  ite string $name
0b40: 5d 20 5c 0a 09 09 63 6f 6d 6d 61 6e 64 73 20 5b  ] \...commands [
0b50: 6a 73 6f 6e 3a 3a 77 72 69 74 65 20 61 72 72 61  json::write arra
0b60: 79 20 7b 2a 7d 24 63 6f 6d 6d 61 6e 64 73 5d 20  y {*}$commands] 
0b70: 5c 0a 09 09 73 65 63 74 69 6f 6e 73 20 5b 6a 73  \...sections [js
0b80: 6f 6e 3a 3a 77 72 69 74 65 20 61 72 72 61 79 20  on::write array 
0b90: 7b 2a 7d 24 73 65 63 74 69 6f 6e 73 5d 5d 0a 7d  {*}$sections]].}
0ba0: 0a 0a 70 72 6f 63 20 3a 3a 63 6d 64 72 3a 3a 68  ..proc ::cmdr::h
0bb0: 65 6c 70 3a 3a 66 6f 72 6d 61 74 3a 3a 4a 53 4f  elp::format::JSO
0bc0: 4e 20 7b 63 6f 6d 6d 61 6e 64 7d 20 7b 0a 20 20  N {command} {.  
0bd0: 20 20 23 20 44 61 74 61 20 73 74 72 75 63 74 75    # Data structu
0be0: 72 65 3a 20 73 65 65 20 63 6f 6e 66 69 67 2e 74  re: see config.t
0bf0: 63 6c 2c 20 20 6d 65 74 68 6f 64 20 27 68 65 6c  cl,  method 'hel
0c00: 70 27 2e 0a 20 20 20 20 23 20 44 61 74 61 20 73  p'..    # Data s
0c10: 74 72 75 63 74 75 72 65 3a 20 73 65 65 20 70 72  tructure: see pr
0c20: 69 76 61 74 65 2e 74 63 6c 2c 20 6d 65 74 68 6f  ivate.tcl, metho
0c30: 64 20 27 68 65 6c 70 27 2e 0a 0a 20 20 20 20 64  d 'help'...    d
0c40: 69 63 74 20 77 69 74 68 20 63 6f 6d 6d 61 6e 64  ict with command
0c50: 20 7b 7d 0a 20 20 20 20 23 20 2d 3e 20 61 63 74   {}.    # -> act
0c60: 69 6f 6e 2c 20 64 65 73 63 2c 20 6f 70 74 69 6f  ion, desc, optio
0c70: 6e 73 2c 20 61 72 67 75 6d 65 6e 74 73 2c 20 70  ns, arguments, p
0c80: 61 72 61 6d 65 74 65 72 73 2c 20 73 74 61 74 65  arameters, state
0c90: 73 2c 20 73 65 63 74 69 6f 6e 73 0a 0a 20 20 20  s, sections..   
0ca0: 20 6c 61 70 70 65 6e 64 20 64 69 63 74 20 64 65   lappend dict de
0cb0: 73 63 72 69 70 74 69 6f 6e 20 5b 4a 53 4f 4e 3a  scription [JSON:
0cc0: 3a 61 73 74 72 69 6e 67 20 20 20 20 24 64 65 73  :astring    $des
0cd0: 63 5d 0a 20 20 20 20 6c 61 70 70 65 6e 64 20 64  c].    lappend d
0ce0: 69 63 74 20 61 63 74 69 6f 6e 20 20 20 20 20 20  ict action      
0cf0: 5b 4a 53 4f 4e 3a 3a 61 6c 69 73 74 20 20 20 20  [JSON::alist    
0d00: 20 20 24 61 63 74 69 6f 6e 5d 0a 20 20 20 20 6c    $action].    l
0d10: 61 70 70 65 6e 64 20 64 69 63 74 20 61 72 67 75  append dict argu
0d20: 6d 65 6e 74 73 20 20 20 5b 4a 53 4f 4e 3a 3a 61  ments   [JSON::a
0d30: 6c 69 73 74 20 20 20 20 20 20 24 61 72 67 75 6d  list      $argum
0d40: 65 6e 74 73 5d 0a 20 20 20 20 6c 61 70 70 65 6e  ents].    lappen
0d50: 64 20 64 69 63 74 20 6f 70 74 69 6f 6e 73 20 20  d dict options  
0d60: 20 20 20 5b 4a 53 4f 4e 3a 3a 61 64 69 63 74 20     [JSON::adict 
0d70: 20 20 20 20 20 24 6f 70 74 69 6f 6e 73 5d 0a 20       $options]. 
0d80: 20 20 20 6c 61 70 70 65 6e 64 20 64 69 63 74 20     lappend dict 
0d90: 6f 70 74 32 70 61 72 61 20 20 20 20 5b 4a 53 4f  opt2para    [JSO
0da0: 4e 3a 3a 61 64 69 63 74 20 20 20 20 20 20 24 6f  N::adict      $o
0db0: 70 74 32 70 61 72 61 5d 0a 20 20 20 20 6c 61 70  pt2para].    lap
0dc0: 70 65 6e 64 20 64 69 63 74 20 73 74 61 74 65 73  pend dict states
0dd0: 20 20 20 20 20 20 5b 4a 53 4f 4e 3a 3a 61 6c 69        [JSON::ali
0de0: 73 74 20 20 20 20 20 20 24 73 74 61 74 65 73 5d  st      $states]
0df0: 0a 20 20 20 20 6c 61 70 70 65 6e 64 20 64 69 63  .    lappend dic
0e00: 74 20 70 61 72 61 6d 65 74 65 72 73 20 20 5b 4a  t parameters  [J
0e10: 53 4f 4e 3a 3a 70 61 72 61 6d 65 74 65 72 73 20  SON::parameters 
0e20: 24 70 61 72 61 6d 65 74 65 72 73 5d 0a 20 20 20  $parameters].   
0e30: 20 6c 61 70 70 65 6e 64 20 64 69 63 74 20 73 65   lappend dict se
0e40: 63 74 69 6f 6e 73 20 20 20 20 5b 4a 53 4f 4e 3a  ctions    [JSON:
0e50: 3a 61 6c 69 73 74 20 20 20 20 20 20 24 73 65 63  :alist      $sec
0e60: 74 69 6f 6e 73 5d 0a 20 20 20 20 0a 20 20 20 20  tions].    .    
0e70: 72 65 74 75 72 6e 20 5b 6a 73 6f 6e 3a 3a 77 72  return [json::wr
0e80: 69 74 65 20 6f 62 6a 65 63 74 20 7b 2a 7d 24 64  ite object {*}$d
0e90: 69 63 74 5d 0a 7d 0a 0a 70 72 6f 63 20 3a 3a 63  ict].}..proc ::c
0ea0: 6d 64 72 3a 3a 68 65 6c 70 3a 3a 66 6f 72 6d 61  mdr::help::forma
0eb0: 74 3a 3a 4a 53 4f 4e 3a 3a 70 61 72 61 6d 65 74  t::JSON::paramet
0ec0: 65 72 73 20 7b 70 61 72 61 6d 65 74 65 72 73 7d  ers {parameters}
0ed0: 20 7b 0a 20 20 20 20 73 65 74 20 64 69 63 74 20   {.    set dict 
0ee0: 7b 7d 0a 20 20 20 20 66 6f 72 65 61 63 68 20 7b  {}.    foreach {
0ef0: 6e 61 6d 65 20 64 65 66 7d 20 5b 3a 3a 63 6d 64  name def} [::cmd
0f00: 72 20 75 74 69 6c 20 64 69 63 74 73 6f 72 74 20  r util dictsort 
0f10: 24 70 61 72 61 6d 65 74 65 72 73 5d 20 7b 0a 09  $parameters] {..
0f20: 73 65 74 20 74 6d 70 20 7b 7d 0a 09 66 6f 72 65  set tmp {}..fore
0f30: 61 63 68 20 7b 78 6e 61 6d 65 20 78 64 65 66 7d  ach {xname xdef}
0f40: 20 5b 3a 3a 63 6d 64 72 20 75 74 69 6c 20 64 69   [::cmdr util di
0f50: 63 74 73 6f 72 74 20 24 64 65 66 5d 20 7b 0a 09  ctsort $def] {..
0f60: 20 20 20 20 73 77 69 74 63 68 20 2d 67 6c 6f 62      switch -glob
0f70: 20 2d 2d 20 24 78 6e 61 6d 65 20 7b 0a 09 09 63   -- $xname {...c
0f80: 6d 64 6c 69 6e 65 20 2d 0a 09 09 64 65 66 65 72  mdline -...defer
0f90: 65 64 20 2d 0a 09 09 64 6f 63 75 6d 65 6e 74 65  ed -...documente
0fa0: 64 20 2d 0a 09 09 69 6e 74 65 72 61 63 74 69 76  d -...interactiv
0fb0: 65 20 2d 0a 09 09 69 73 62 6f 6f 6c 20 2d 0a 09  e -...isbool -..
0fc0: 09 6c 69 73 74 20 2d 0a 09 09 6f 72 64 65 72 65  .list -...ordere
0fd0: 64 20 2d 0a 09 09 70 72 65 73 65 6e 63 65 20 2d  d -...presence -
0fe0: 0a 09 09 72 65 71 75 69 72 65 64 20 2d 0a 09 09  ...required -...
0ff0: 40 62 6f 6f 6c 20 7b 0a 09 09 20 20 20 20 23 20  @bool {...    # 
1000: 6e 6f 72 6d 61 6c 69 7a 65 20 74 6f 20 62 6f 6f  normalize to boo
1010: 6c 65 61 6e 0a 09 09 20 20 20 20 73 65 74 20 76  lean...    set v
1020: 61 6c 75 65 20 5b 65 78 70 72 20 7b 21 21 24 78  alue [expr {!!$x
1030: 64 65 66 7d 5d 0a 09 09 7d 0a 09 09 74 68 72 65  def}]...}...thre
1040: 73 68 6f 6c 64 20 7b 0a 09 09 20 20 20 20 23 20  shold {...    # 
1050: 6e 75 6c 6c 7c 69 6e 74 65 67 65 72 0a 09 09 20  null|integer... 
1060: 20 20 20 73 65 74 20 76 61 6c 75 65 20 5b 65 78     set value [ex
1070: 70 72 20 7b 28 24 78 64 65 66 20 65 71 20 7b 7d  pr {($xdef eq {}
1080: 29 20 3f 20 22 6e 75 6c 6c 22 20 3a 20 24 78 64  ) ? "null" : $xd
1090: 65 66 7d 5d 0a 09 09 7d 0a 09 09 63 6f 64 65 20  ef}]...}...code 
10a0: 2d 0a 09 09 64 65 66 61 75 6c 74 20 2d 0a 09 09  -...default -...
10b0: 64 65 73 63 72 69 70 74 69 6f 6e 20 2d 0a 09 09  description -...
10c0: 70 72 6f 6d 70 74 20 2d 0a 09 09 74 79 70 65 20  prompt -...type 
10d0: 2d 0a 09 09 6c 61 62 65 6c 20 2d 0a 09 09 40 73  -...label [email protected]
10e0: 74 72 69 6e 67 20 7b 0a 09 09 20 20 20 20 73 65  tring {...    se
10f0: 74 20 76 61 6c 75 65 20 5b 61 73 74 72 69 6e 67  t value [astring
1100: 20 24 78 64 65 66 5d 0a 09 09 7d 0a 09 09 67 65   $xdef]...}...ge
1110: 6e 65 72 61 74 6f 72 20 2d 0a 09 09 76 61 6c 69  nerator -...vali
1120: 64 61 74 6f 72 20 2d 0a 09 09 40 63 6d 64 70 72  dator [email protected]
1130: 65 66 69 78 20 7b 20 0a 09 09 20 20 20 20 73 65  efix { ...    se
1140: 74 20 76 61 6c 75 65 20 5b 61 6c 69 73 74 20 24  t value [alist $
1150: 78 64 65 66 5d 0a 09 09 7d 0a 09 09 66 6c 61 67  xdef]...}...flag
1160: 73 20 2d 0a 09 09 40 64 69 63 74 20 7b 0a 09 09  s [email protected] {...
1170: 20 20 20 20 73 65 74 20 76 61 6c 75 65 20 5b 61      set value [a
1180: 64 69 63 74 20 24 78 64 65 66 5d 0a 09 09 7d 0a  dict $xdef]...}.
1190: 09 09 2a 20 7b 0a 09 09 20 20 20 20 65 72 72 6f  ..* {...    erro
11a0: 72 20 22 55 6e 6b 6e 6f 77 6e 20 6b 65 79 20 5c  r "Unknown key \
11b0: 22 24 78 6e 61 6d 65 5c 22 2c 20 64 6f 20 6e 6f  "$xname\", do no
11c0: 74 20 6b 6e 6f 77 20 68 6f 77 20 74 6f 20 66 6f  t know how to fo
11d0: 72 6d 61 74 22 0a 09 09 20 20 20 20 23 6c 61 70  rmat"...    #lap
11e0: 70 65 6e 64 20 74 6d 70 20 24 78 6e 61 6d 65 20  pend tmp $xname 
11f0: 5b 61 73 74 72 69 6e 67 20 24 78 64 65 66 5d 0a  [astring $xdef].
1200: 09 09 7d 0a 09 20 20 20 20 7d 0a 09 20 20 20 20  ..}..    }..    
1210: 6c 61 70 70 65 6e 64 20 74 6d 70 20 24 78 6e 61  lappend tmp $xna
1220: 6d 65 20 24 76 61 6c 75 65 0a 09 7d 0a 09 6c 61  me $value..}..la
1230: 70 70 65 6e 64 20 64 69 63 74 20 24 6e 61 6d 65  ppend dict $name
1240: 20 5b 6a 73 6f 6e 3a 3a 77 72 69 74 65 20 6f 62   [json::write ob
1250: 6a 65 63 74 20 7b 2a 7d 24 74 6d 70 5d 0a 20 20  ject {*}$tmp].  
1260: 20 20 7d 0a 20 20 20 20 72 65 74 75 72 6e 20 5b    }.    return [
1270: 6a 73 6f 6e 3a 3a 77 72 69 74 65 20 6f 62 6a 65  json::write obje
1280: 63 74 20 7b 2a 7d 24 64 69 63 74 5d 0a 7d 0a 0a  ct {*}$dict].}..
1290: 23 20 23 20 23 23 20 23 23 23 20 23 23 23 23 23  # # ## ### #####
12a0: 20 23 23 23 23 23 23 23 23 20 23 23 23 23 23 23   ######## ######
12b0: 23 23 23 23 23 23 23 20 23 23 23 23 23 23 23 23  ####### ########
12c0: 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 0a 70  #############..p
12d0: 72 6f 63 20 3a 3a 63 6d 64 72 3a 3a 68 65 6c 70  roc ::cmdr::help
12e0: 3a 3a 66 6f 72 6d 61 74 3a 3a 4a 53 4f 4e 3a 3a  ::format::JSON::
12f0: 61 6c 69 73 74 20 7b 74 68 65 6c 69 73 74 7d 20  alist {thelist} 
1300: 7b 0a 20 20 20 20 73 65 74 20 74 6d 70 20 7b 7d  {.    set tmp {}
1310: 0a 20 20 20 20 66 6f 72 65 61 63 68 20 77 20 24  .    foreach w $
1320: 74 68 65 6c 69 73 74 20 7b 0a 09 6c 61 70 70 65  thelist {..lappe
1330: 6e 64 20 74 6d 70 20 5b 6a 73 6f 6e 3a 3a 77 72  nd tmp [json::wr
1340: 69 74 65 20 73 74 72 69 6e 67 20 24 77 5d 0a 20  ite string $w]. 
1350: 20 20 20 7d 0a 20 20 20 20 72 65 74 75 72 6e 20     }.    return 
1360: 5b 6a 73 6f 6e 3a 3a 77 72 69 74 65 20 61 72 72  [json::write arr
1370: 61 79 20 7b 2a 7d 24 74 6d 70 5d 0a 7d 0a 0a 70  ay {*}$tmp].}..p
1380: 72 6f 63 20 3a 3a 63 6d 64 72 3a 3a 68 65 6c 70  roc ::cmdr::help
1390: 3a 3a 66 6f 72 6d 61 74 3a 3a 4a 53 4f 4e 3a 3a  ::format::JSON::
13a0: 61 64 69 63 74 20 7b 74 68 65 64 69 63 74 7d 20  adict {thedict} 
13b0: 7b 0a 20 20 20 20 73 65 74 20 74 6d 70 20 7b 7d  {.    set tmp {}
13c0: 0a 20 20 20 20 66 6f 72 65 61 63 68 20 7b 6b 20  .    foreach {k 
13d0: 76 7d 20 5b 3a 3a 63 6d 64 72 20 75 74 69 6c 20  v} [::cmdr util 
13e0: 64 69 63 74 73 6f 72 74 20 24 74 68 65 64 69 63  dictsort $thedic
13f0: 74 5d 20 7b 0a 09 6c 61 70 70 65 6e 64 20 74 6d  t] {..lappend tm
1400: 70 20 24 6b 20 5b 6a 73 6f 6e 3a 3a 77 72 69 74  p $k [json::writ
1410: 65 20 73 74 72 69 6e 67 20 24 76 5d 0a 20 20 20  e string $v].   
1420: 20 7d 0a 20 20 20 20 72 65 74 75 72 6e 20 5b 6a   }.    return [j
1430: 73 6f 6e 3a 3a 77 72 69 74 65 20 6f 62 6a 65 63  son::write objec
1440: 74 20 7b 2a 7d 24 74 6d 70 5d 0a 7d 0a 0a 70 72  t {*}$tmp].}..pr
1450: 6f 63 20 3a 3a 63 6d 64 72 3a 3a 68 65 6c 70 3a  oc ::cmdr::help:
1460: 3a 66 6f 72 6d 61 74 3a 3a 4a 53 4f 4e 3a 3a 61  :format::JSON::a
1470: 73 74 72 69 6e 67 20 7b 73 74 72 69 6e 67 7d 20  string {string} 
1480: 7b 0a 20 20 20 20 72 65 67 73 75 62 20 2d 61 6c  {.    regsub -al
1490: 6c 20 2d 2d 20 7b 5b 20 5c 6e 5c 74 5d 2b 7d 20  l -- {[ \n\t]+} 
14a0: 24 73 74 72 69 6e 67 20 7b 20 7d 20 73 74 72 69  $string { } stri
14b0: 6e 67 0a 20 20 20 20 72 65 74 75 72 6e 20 5b 6a  ng.    return [j
14c0: 73 6f 6e 3a 3a 77 72 69 74 65 20 73 74 72 69 6e  son::write strin
14d0: 67 20 5b 73 74 72 69 6e 67 20 74 72 69 6d 20 24  g [string trim $
14e0: 73 74 72 69 6e 67 5d 5d 0a 7d 0a 0a 23 20 23 20  string]].}..# # 
14f0: 23 23 20 23 23 23 20 23 23 23 23 23 20 23 23 23  ## ### ##### ###
1500: 23 23 23 23 23 20 23 23 23 23 23 23 23 23 23 23  ##### ##########
1510: 23 23 23 20 23 23 23 23 23 23 23 23 23 23 23 23  ### ############
1520: 23 23 23 23 23 23 23 23 23 0a 23 23 20 52 65 61  #########.## Rea
1530: 64 79 0a 70 61 63 6b 61 67 65 20 70 72 6f 76 69  dy.package provi
1540: 64 65 20 63 6d 64 72 3a 3a 68 65 6c 70 3a 3a 6a  de cmdr::help::j
1550: 73 6f 6e 20 31 2e 30 0a                          son 1.0.