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 tclconference@googlegroups.com
or submit via the online form by Sep 9.

Artifact d08ba5b76b0f57c31c517f2cc0c0caf8d55270bb:


0000: 0a 54 68 65 20 6d 65 74 68 6f 64 73 20 72 65 6c  .The methods rel
0010: 65 76 61 6e 74 20 74 6f 20 63 6f 6d 6d 61 6e 64  evant to command
0020: 2d 6c 69 6e 65 20 63 6f 6d 70 6c 65 74 69 6f 6e  -line completion
0030: 20 63 61 6e 20 62 65 20 66 6f 75 6e 64 20 69 6e   can be found in
0040: 20 66 6f 75 72 0a 70 61 63 6b 61 67 65 73 2f 63   four.packages/c
0050: 6c 61 73 73 65 73 2c 20 6e 61 6d 65 6c 79 3a 0a  lasses, namely:.
0060: 0a 5b 6c 69 73 74 5f 62 65 67 69 6e 20 64 65 66  .[list_begin def
0070: 69 6e 69 74 69 6f 6e 73 5d 0a 5b 64 65 66 20 5b  initions].[def [
0080: 70 61 63 6b 61 67 65 20 63 6d 64 72 3a 3a 61 63  package cmdr::ac
0090: 74 6f 72 5d 5d 0a 20 20 20 20 20 5b 6c 69 73 74  tor]].     [list
00a0: 5f 62 65 67 69 6e 20 64 65 66 69 6e 69 74 69 6f  _begin definitio
00b0: 6e 73 5d 0a 20 20 20 20 20 5b 64 65 66 20 5b 6d  ns].     [def [m
00c0: 65 74 68 6f 64 20 70 61 72 73 65 2d 6c 69 6e 65  ethod parse-line
00d0: 5d 5d 0a 20 20 20 20 20 54 61 6b 65 73 20 61 20  ]].     Takes a 
00e0: 63 6f 6d 6d 61 6e 64 2d 6c 69 6e 65 20 61 6e 64  command-line and
00f0: 20 72 65 74 75 72 6e 73 20 61 6e 20 69 6e 69 74   returns an init
0100: 69 61 6c 20 70 61 72 73 65 20 73 74 72 75 63 74  ial parse struct
0110: 75 72 65 20 61 73 0a 20 20 20 20 20 64 65 73 63  ure as.     desc
0120: 72 69 62 65 64 20 69 6e 20 73 65 63 74 69 6f 6e  ribed in section
0130: 20 5b 73 65 63 74 72 65 66 20 7b 50 61 72 73 65   [sectref {Parse
0140: 20 53 74 61 74 65 7d 5d 0a 0a 20 20 20 20 20 5b   State}]..     [
0150: 64 65 66 20 5b 6d 65 74 68 6f 64 20 63 6f 6d 70  def [method comp
0160: 6c 65 74 69 6f 6e 73 5d 5d 0a 20 20 20 20 20 5b  letions]].     [
0170: 64 65 66 20 5b 6d 65 74 68 6f 64 20 6d 61 74 63  def [method matc
0180: 68 5d 5d 0a 20 20 20 20 20 5b 6c 69 73 74 5f 65  h]].     [list_e
0190: 6e 64 5d 0a 0a 5b 64 65 66 20 5b 70 61 63 6b 61  nd]..[def [packa
01a0: 67 65 20 63 6d 64 72 3a 3a 63 6f 6e 66 69 67 5d  ge cmdr::config]
01b0: 5d 0a 20 20 20 20 20 5b 6c 69 73 74 5f 62 65 67  ].     [list_beg
01c0: 69 6e 20 64 65 66 69 6e 69 74 69 6f 6e 73 5d 0a  in definitions].
01d0: 20 20 20 20 20 5b 64 65 66 20 5b 6d 65 74 68 6f       [def [metho
01e0: 64 20 63 6f 6d 70 6c 65 74 65 5d 5d 0a 20 20 20  d complete]].   
01f0: 20 20 48 6f 6f 6b 20 6d 65 74 68 6f 64 2c 20 65    Hook method, e
0200: 6e 74 72 79 70 6f 69 6e 74 20 66 6f 72 20 74 68  ntrypoint for th
0210: 65 20 6d 69 6e 69 2d 73 68 65 6c 6c 2e 0a 0a 20  e mini-shell... 
0220: 20 20 20 20 54 61 6b 65 73 20 74 68 65 20 62 75      Takes the bu
0230: 66 66 65 72 20 74 6f 20 63 6f 6d 70 6c 65 74 65  ffer to complete
0240: 20 61 6e 64 20 72 65 74 75 72 6e 73 20 74 68 65   and returns the
0250: 20 6c 69 73 74 20 6f 66 20 63 6f 6d 70 6c 65 74   list of complet
0260: 69 6f 6e 73 2c 0a 20 20 20 20 20 77 68 69 63 68  ions,.     which
0270: 20 6d 61 79 20 62 65 20 65 6d 70 74 79 2e 0a 0a   may be empty...
0280: 20 20 20 20 20 55 73 65 73 20 74 68 65 20 77 6f       Uses the wo
0290: 72 6b 68 6f 72 73 65 20 6d 65 74 68 6f 64 20 62  rkhorse method b
02a0: 65 6c 6f 77 20 61 6e 64 20 74 68 65 20 5b 70 61  elow and the [pa
02b0: 63 6b 61 67 65 20 63 6d 64 72 3a 3a 61 63 74 6f  ckage cmdr::acto
02c0: 72 5d 0a 20 20 20 20 20 6d 65 74 68 6f 64 73 2e  r].     methods.
02d0: 0a 0a 20 20 20 20 20 5b 64 65 66 20 5b 6d 65 74  ..     [def [met
02e0: 68 6f 64 20 63 6f 6d 70 6c 65 74 65 2d 72 65 70  hod complete-rep
02f0: 6c 5d 5d 0a 20 20 20 20 20 4d 61 69 6e 20 77 6f  l]].     Main wo
0300: 72 6b 20 6d 65 74 68 6f 64 20 74 61 6b 69 6e 67  rk method taking
0310: 20 61 20 70 61 72 73 65 20 73 74 72 75 63 74 75   a parse structu
0320: 72 65 20 61 6e 64 20 72 65 74 75 72 6e 69 6e 67  re and returning
0330: 20 74 68 65 20 6c 69 73 74 0a 20 20 20 20 20 6f   the list.     o
0340: 66 20 63 6f 6d 70 6c 65 74 69 6f 6e 73 2e 20 4d  f completions. M
0350: 6f 72 65 20 64 65 74 61 69 6c 73 20 61 62 6f 75  ore details abou
0360: 74 20 69 74 20 28 61 6e 64 20 74 68 65 20 6d 69  t it (and the mi
0370: 6e 69 2d 73 68 65 6c 6c 29 20 63 61 6e 20 62 65  ni-shell) can be
0380: 0a 20 20 20 20 20 66 6f 75 6e 64 20 69 6e 20 73  .     found in s
0390: 65 63 74 69 6f 6e 20 5b 73 65 63 74 72 65 66 20  ection [sectref 
03a0: 7b 4d 69 6e 69 20 53 68 65 6c 6c 20 4f 70 65 72  {Mini Shell Oper
03b0: 61 74 69 6f 6e 7d 5d 2e 0a 0a 20 20 20 20 20 5b  ation}]...     [
03c0: 64 65 66 20 5b 6d 65 74 68 6f 64 20 63 6f 6d 70  def [method comp
03d0: 6c 65 74 65 2d 77 6f 72 64 73 5d 5d 0a 20 20 20  lete-words]].   
03e0: 20 20 4d 61 69 6e 20 77 6f 72 6b 20 6d 65 74 68    Main work meth
03f0: 6f 64 20 66 6f 72 20 63 6f 6d 70 6c 65 74 69 6f  od for completio
0400: 6e 20 66 72 6f 6d 20 74 68 65 20 6d 61 69 6e 20  n from the main 
0410: 73 68 65 6c 6c 2c 20 69 6e 76 6f 6b 65 64 20 62  shell, invoked b
0420: 79 0a 20 20 20 20 20 74 68 65 20 5b 70 61 63 6b  y.     the [pack
0430: 61 67 65 20 63 6d 64 72 3a 3a 70 72 69 76 61 74  age cmdr::privat
0440: 65 5d 20 69 6e 73 74 61 6e 63 65 20 68 61 76 69  e] instance havi
0450: 6e 67 20 74 6f 20 63 6f 6d 70 6c 65 74 65 20 77  ng to complete w
0460: 6f 72 64 73 2e 0a 0a 20 20 20 20 20 5b 6c 69 73  ords...     [lis
0470: 74 5f 65 6e 64 5d 0a 0a 5b 64 65 66 20 5b 70 61  t_end]..[def [pa
0480: 63 6b 61 67 65 20 63 6d 64 72 3a 3a 6f 66 66 69  ckage cmdr::offi
0490: 63 65 72 5d 5d 0a 20 20 20 20 20 5b 6c 69 73 74  cer]].     [list
04a0: 5f 62 65 67 69 6e 20 64 65 66 69 6e 69 74 69 6f  _begin definitio
04b0: 6e 73 5d 0a 20 20 20 20 20 5b 64 65 66 20 5b 6d  ns].     [def [m
04c0: 65 74 68 6f 64 20 63 6f 6d 70 6c 65 74 65 5d 5d  ethod complete]]
04d0: 0a 0a 20 20 20 20 20 48 6f 6f 6b 20 6d 65 74 68  ..     Hook meth
04e0: 6f 64 2c 20 65 6e 74 72 79 70 6f 69 6e 74 20 66  od, entrypoint f
04f0: 6f 72 20 74 68 65 20 6d 61 69 6e 20 73 68 65 6c  or the main shel
0500: 6c 2e 0a 0a 20 20 20 20 20 54 61 6b 65 73 20 74  l...     Takes t
0510: 68 65 20 62 75 66 66 65 72 20 74 6f 20 63 6f 6d  he buffer to com
0520: 70 6c 65 74 65 20 61 6e 64 20 72 65 74 75 72 6e  plete and return
0530: 73 20 74 68 65 20 6c 69 73 74 20 6f 66 20 63 6f  s the list of co
0540: 6d 70 6c 65 74 69 6f 6e 73 2c 0a 20 20 20 20 20  mpletions,.     
0550: 77 68 69 63 68 20 6d 61 79 20 62 65 20 65 6d 70  which may be emp
0560: 74 79 2e 0a 0a 20 20 20 20 20 55 73 65 73 20 74  ty...     Uses t
0570: 68 65 20 77 6f 72 6b 68 6f 72 73 65 20 6d 65 74  he workhorse met
0580: 68 6f 64 20 62 65 6c 6f 77 20 61 6e 64 20 74 68  hod below and th
0590: 65 20 5b 70 61 63 6b 61 67 65 20 63 6d 64 72 3a  e [package cmdr:
05a0: 3a 61 63 74 6f 72 5d 0a 20 20 20 20 20 6d 65 74  :actor].     met
05b0: 68 6f 64 73 2e 0a 0a 20 20 20 20 20 5b 64 65 66  hods...     [def
05c0: 20 5b 6d 65 74 68 6f 64 20 63 6f 6d 70 6c 65 74   [method complet
05d0: 65 2d 77 6f 72 64 73 5d 5d 0a 20 20 20 20 20 4d  e-words]].     M
05e0: 61 69 6e 20 77 6f 72 6b 20 6d 65 74 68 6f 64 20  ain work method 
05f0: 74 61 6b 69 6e 67 20 61 20 70 61 72 73 65 20 73  taking a parse s
0600: 74 72 75 63 74 75 72 65 20 61 6e 64 20 72 65 74  tructure and ret
0610: 75 72 6e 69 6e 67 20 74 68 65 20 6c 69 73 74 0a  urning the list.
0620: 20 20 20 20 20 6f 66 20 63 6f 6d 70 6c 65 74 69       of completi
0630: 6f 6e 73 2e 20 4d 6f 72 65 20 64 65 74 61 69 6c  ons. More detail
0640: 73 20 61 62 6f 75 74 20 69 74 20 28 61 6e 64 20  s about it (and 
0650: 74 68 65 20 6d 61 69 6e 20 73 68 65 6c 6c 29 20  the main shell) 
0660: 63 61 6e 20 62 65 0a 20 20 20 20 20 66 6f 75 6e  can be.     foun
0670: 64 20 69 6e 20 73 65 63 74 69 6f 6e 20 5b 73 65  d in section [se
0680: 63 74 72 65 66 20 7b 4d 61 69 6e 20 53 68 65 6c  ctref {Main Shel
0690: 6c 20 4f 70 65 72 61 74 69 6f 6e 7d 5d 2e 0a 0a  l Operation}]...
06a0: 20 20 20 20 20 5b 70 61 72 61 5d 20 43 61 6e 20       [para] Can 
06b0: 72 65 63 75 72 73 65 20 74 6f 20 74 68 65 20 73  recurse to the s
06c0: 61 6d 65 20 6d 65 74 68 6f 64 20 6f 66 20 6f 74  ame method of ot
06d0: 68 65 72 20 6f 66 66 69 63 65 72 73 2c 20 61 6e  her officers, an
06e0: 64 0a 20 20 20 20 20 70 72 69 76 61 74 65 20 69  d.     private i
06f0: 6e 73 74 61 6e 63 65 73 2e 0a 0a 20 20 20 20 20  nstances...     
0700: 5b 6c 69 73 74 5f 65 6e 64 5d 0a 0a 5b 64 65 66  [list_end]..[def
0710: 20 5b 70 61 63 6b 61 67 65 20 63 6d 64 72 3a 3a   [package cmdr::
0720: 70 61 72 61 6d 65 74 65 72 5d 5d 0a 20 20 20 20  parameter]].    
0730: 20 5b 6c 69 73 74 5f 62 65 67 69 6e 20 64 65 66   [list_begin def
0740: 69 6e 69 74 69 6f 6e 73 5d 0a 20 20 20 20 20 5b  initions].     [
0750: 64 65 66 20 5b 6d 65 74 68 6f 64 20 63 6f 6d 70  def [method comp
0760: 6c 65 74 65 2d 77 6f 72 64 73 5d 5d 0a 20 20 20  lete-words]].   
0770: 20 20 4d 61 69 6e 20 77 6f 72 6b 20 6d 65 74 68    Main work meth
0780: 6f 64 20 77 68 65 6e 20 72 65 61 63 68 69 6e 67  od when reaching
0790: 20 61 20 70 61 72 61 6d 65 74 65 72 2e 0a 0a 20   a parameter... 
07a0: 20 20 20 20 53 69 6d 70 6c 79 20 64 65 6c 65 67      Simply deleg
07b0: 61 74 65 73 20 74 68 65 20 77 6f 72 6b 20 74 6f  ates the work to
07c0: 20 74 68 65 20 6d 65 74 68 6f 64 20 5b 6d 65 74   the method [met
07d0: 68 6f 64 20 63 6f 6d 70 6c 65 74 65 5d 20 6f 66  hod complete] of
07e0: 20 74 68 65 0a 20 20 20 20 20 76 61 6c 69 64 61   the.     valida
07f0: 74 69 6f 6e 20 74 79 70 65 20 61 73 73 6f 63 69  tion type associ
0800: 61 74 65 64 20 77 69 74 68 20 74 68 65 20 70 61  ated with the pa
0810: 72 61 6d 65 74 65 72 2e 0a 20 20 20 20 20 5b 6c  rameter..     [l
0820: 69 73 74 5f 65 6e 64 5d 0a 0a 5b 64 65 66 20 5b  ist_end]..[def [
0830: 70 61 63 6b 61 67 65 20 63 6d 64 72 3a 3a 70 72  package cmdr::pr
0840: 69 76 61 74 65 5d 5d 0a 20 20 20 20 20 5b 6c 69  ivate]].     [li
0850: 73 74 5f 62 65 67 69 6e 20 64 65 66 69 6e 69 74  st_begin definit
0860: 69 6f 6e 73 5d 0a 20 20 20 20 20 5b 64 65 66 20  ions].     [def 
0870: 5b 6d 65 74 68 6f 64 20 63 6f 6d 70 6c 65 74 65  [method complete
0880: 2d 77 6f 72 64 73 5d 5d 0a 20 20 20 20 20 4d 61  -words]].     Ma
0890: 69 6e 20 77 6f 72 6b 20 6d 65 74 68 6f 64 20 77  in work method w
08a0: 68 65 6e 20 72 65 61 63 68 69 6e 67 20 61 20 70  hen reaching a p
08b0: 72 69 76 61 74 65 20 77 68 69 6c 65 20 72 65 63  rivate while rec
08c0: 75 72 73 69 6e 67 20 74 68 72 6f 75 67 68 0a 20  ursing through. 
08d0: 20 20 20 20 74 68 65 20 63 6f 6d 6d 61 6e 64 20      the command 
08e0: 68 69 65 72 61 72 63 68 79 20 66 72 6f 6d 20 6f  hierarchy from o
08f0: 66 66 69 63 65 72 73 2e 0a 0a 20 20 20 20 20 44  fficers...     D
0900: 65 6c 65 67 61 74 65 73 20 74 6f 20 74 68 65 20  elegates to the 
0910: 5b 70 61 63 6b 61 67 65 20 63 6d 64 72 3a 3a 63  [package cmdr::c
0920: 6f 6e 66 69 67 5d 20 6d 65 74 68 6f 64 20 6f 66  onfig] method of
0930: 20 74 68 65 20 73 61 6d 65 20 6e 61 6d 65 2e 0a   the same name..
0940: 0a 20 20 20 20 20 5b 6c 69 73 74 5f 65 6e 64 5d  .     [list_end]
0950: 0a 5b 6c 69 73 74 5f 65 6e 64 5d 0a              .[list_end].