Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
| Comment: | Moved handling of option arguments in help to separate proc. Reworked the handling of global options to show arguments as well. Fixed sorting of section display when seeing options with arguments. |
|---|---|
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
f41f44de14b06cc430c68f2716202e8e |
| User & Date: | andreask 2014-09-10 20:21:12.191 |
Context
|
2014-09-10
| ||
| 20:35 | Move handling of global option to before checking for a command. We can now enter a main shell with global options set. Bump version numbers. check-in: 2bfa8d5785 user: andreask tags: trunk | |
| 20:21 | Moved handling of option arguments in help to separate proc. Reworked the handling of global options to show arguments as well. Fixed sorting of section display when seeing options with arguments. check-in: f41f44de14 user: andreask tags: trunk | |
|
2014-08-29
| ||
| 20:19 | cmdr::parameter - Extended spec with description of option argument, if any. cmdr::help - Modified to make use of the new information in help texts. check-in: 463519edc6 user: andreask tags: trunk | |
Changes
Changes to help.tcl.
| ︙ | ︙ | |||
232 233 234 235 236 237 238 |
}
# plus per-option descriptions (sort by flag name)
if {[dict size $options]} {
set onames {}
set odefs {}
foreach {oname ohelp} [::cmdr util dictsort $options] {
| < < < < < < < < < < < < < | | 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
}
# plus per-option descriptions (sort by flag name)
if {[dict size $options]} {
set onames {}
set odefs {}
foreach {oname ohelp} [::cmdr util dictsort $options] {
set oname [OptionName $oname parameters opt2para]
lappend onames $oname
lappend odefs $ohelp
}
DefList $width $onames $odefs
}
# plus per-argument descriptions (keep in cmdline order)
|
| ︙ | ︙ | |||
371 372 373 374 375 376 377 |
# Get the commands in the category, preliminary formatting
# (labels, descriptions).
set names {}
set descs {}
if {[dict exists $cmds $path]} {
| | | 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# Get the commands in the category, preliminary formatting
# (labels, descriptions).
set names {}
set descs {}
if {[dict exists $cmds $path]} {
foreach def [lsort -dict -unique -index 0 [dict get $cmds $path]] {
lassign $def syntax desc
lappend names $syntax
lappend descs $desc
}
}
set labels [cmdr util padr $names]
|
| ︙ | ︙ | |||
480 481 482 483 484 485 486 |
continue
}
# Exclude officers from the categorized help. They can only be
# a source of shared options. Shared options are collected in
# a separate structure.
if {![info exists action] && [dict size $options]} {
| | | 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 |
continue
}
# Exclude officers from the categorized help. They can only be
# a source of shared options. Shared options are collected in
# a separate structure.
if {![info exists action] && [dict size $options]} {
set opts($name) [::list $options $parameters $opt2para]
continue
}
if {![llength $sections]} {
lappend sections Miscellaneous
}
|
| ︙ | ︙ | |||
505 506 507 508 509 510 511 |
}
}
# Options for the root => global options, put into the section tree.
# We are ignoring deeper shared options.
if {[info exists opts($root)]} {
| | | > > > > > > > > > > > > > > > > > > > > > > > | 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 |
}
}
# Options for the root => global options, put into the section tree.
# We are ignoring deeper shared options.
if {[info exists opts($root)]} {
lassign $opts($root) options parameters opt2para
set category {Global Options}
lappend sections $category
set category [::list $category]
foreach {o d} [::cmdr util dictsort $options] {
set o [OptionName $o parameters opt2para]
lappend cmds($category) [::list $o [string trim $d]]
LinkParent $category
}
unset opts($root)
}
# puts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# parray subc
# parray cmds
# parray opts
# puts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::list [array get subc] [array get cmds]
}
proc ::cmdr::help::format::OptionName {oname pv ov} {
upvar 1 $pv parameters $ov opt2para
# Inspect the parameter and determine of the option
# requires an argument. If yes, suitably extend the
# definition key of the option list.
set pname [dict get $opt2para $oname]
set vt [dict get $parameters $pname validator]
if {$vt ne "::cmdr::validate::boolean"} {
if {[dict exists $parameters $pname arglabel]} {
set plabel [dict get $parameters $pname arglabel]
} else {
set plabel [dict get $parameters $pname label]
}
append oname " [string toupper $plabel]"
}
return $oname
}
proc ::cmdr::help::format::LinkParent {category} {
if {![llength $category]} return
upvar 1 subc subc
set parent [lreverse [lassign [lreverse $category] leaf]]
lappend subc($parent) $leaf
LinkParent $parent
|
| ︙ | ︙ |