improve 'help' command
[openocd.git] / src / helper / startup.tcl
index fc5f9e1a0f571091fd37254bb9d661feeb8cd79c..ddfef1dc9ae1181d537f58d21b12a1e12e9c2e07 100644 (file)
@@ -1,11 +1,8 @@
-#
-# Defines basic Tcl procs that must be there for
-# OpenOCD to work.
+# Defines basic Tcl procs that must exist for OpenOCD scripts to work.
 #
 # Embedded into OpenOCD executable
 #
 
-
 # Help text list. A list of command + help text pairs.
 #
 # Commands can be more than one word and they are stored
@@ -21,90 +18,44 @@ proc get_help_text {} {
        return $ocd_helptext
 }
 
-# Production command
-# FIX!!! need to figure out how to feed back relevant output
-# from e.g. "flash banks" command...
-proc board_produce {filename serialnumber} {
-       openocd "reset init"
-       openocd "flash write_image erase $filename [flash] bin"]]
-       openocd "verify_image $filename [flash] bin"]]
-       echo "Successfully ran production procedure"
-}
-
-proc board_test {} {
-       echo "Production test not implemented"
-}
-
-# Show flash in human readable form
-# This is an example of a human readable form of a low level fn
-proc flash_banks {} { 
-       set i 0         
-       set result ""
-       foreach {a} [openocd_flash_banks] {
-               if {$i > 0} {
-                       set result "$result\n"
-               }
-               set result [format "$result#%d: %s at 0x%08x, size 0x%08x, buswidth %d, chipwidth %d" $i $a(name) $a(base) $a(size) $a(bus_width) $a(chip_width)]
-               set i [expr $i+1]       
-       }       
-       return $result
-}
 
 # We need to explicitly redirect this to the OpenOCD command
 # as Tcl defines the exit proc
 proc exit {} {
-       openocd_throw exit
+       ocd_throw exit
 }
 
-#Print help text for a command. Word wrap
-#help text that is too wide inside column.
-proc help {args} {
-       global ocd_helptext
-       set cmd $args
-       foreach a [lsort $ocd_helptext] {
-               if {[string length $cmd]==0||[string first $cmd $a]!=-1||[string first $cmd [lindex $a 1]]!=-1} {
-                       set w 50
-                       set cmdname [lindex $a 0]
-                       set h [lindex $a 1]
-                       set n 0
-                       while 1 {
-                               if {$n > [string length $h]} {break}
-                               
-                               set next_a [expr $n+$w]
-                               if {[string length $h]>$n+$w} {
-                                       set xxxx [string range $h $n [expr $n+$w]]
-                                       for {set lastpos [expr [string length $xxxx]-1]} {$lastpos>=0&&[string compare [string range $xxxx $lastpos $lastpos] " "]!=0} {set lastpos [expr $lastpos-1]} {
-                                       }
-                                       #set next_a -1
-                                       if {$lastpos!=-1} {
-                                               set next_a [expr $lastpos+$n+1]
-                                       }
-                               }
-                               
-                               
-                               puts [format "%-25s %s" $cmdname [string range $h $n [expr $next_a-1]] ]
-                               set cmdname ""
-                               set n [expr $next_a]
+proc cmd_help {cmdname h indent} {
+       set indent [expr $indent * 2]
+
+       set fmt_str [format "%%%ds%%-%ds %%s" $indent [expr 25 - $indent]]
+       set w [expr 50 - $indent]
+       set n 0
+
+       while 1 {
+               if {$n > [string length $h]} {break}
+
+               set next_a [expr $n + $w]
+               if {[string length $h] > $n + $w} \
+               {
+                       set xxxx [string range $h $n [expr $n + $w]]
+                       for {set lastpos [expr [string length $xxxx] - 1]} \
+                               {$lastpos >= 0 && [string compare \
+                                       [string range $xxxx $lastpos $lastpos] " "] != 0} \
+                               {set lastpos [expr $lastpos - 1]} \
+                       {
+                       }
+                       #set next_a -1
+                       if {$lastpos != -1} {
+                               set next_a [expr $lastpos + $n + 1]
                        }
                }
-       }
-}
-
-add_help_text help "Tcl implementation of help command"
 
-
-#a bit of backwards compatibility
-proc openocd_throw {cmd} {
-       set openocd_output ""
-       eval $cmd
-       return $openocd_output
-}
-
-#a bit of backwards compatibility
-proc openocd {cmd} {
-       set openocd_output ""
-       eval $cmd
-       return $openocd_output
+               puts [format $fmt_str "" $cmdname \
+                               [string range $h $n [expr $next_a - 1]] ]
+               set cmdname ""
+               set n [expr $next_a]
+       }
 }
 
 # If a fn is unknown to Tcl, we try to execute it as an OpenOCD command
@@ -115,39 +66,33 @@ proc unknown {args} {
        # do the name mangling from "flash banks" to "flash_banks"
        if {[llength $args]>=2} {
                set cmd_name "[lindex $args 0]_[lindex $args 1]"
-               # Fix?? add a check here if this is a command?
-               # we'll strip away args until we fail anyway...
-               return [eval "$cmd_name [lrange $args 2 end]"]
+               if {[catch {info body $cmd_name}]==0} {
+                   # the command exists, try it...
+                       return [eval "$cmd_name [lrange $args 2 end]"]
+               }
        }
        # This really is an unknown command.
-       puts "Unknown command: $args"
+       return -code error "Unknown command: $args"
 }
 
-
-proc target_script {target_num eventname scriptname} {
-       if {[string compare $eventname reset]==0} {
-               set eventname post_reset
-       }
-
-       # This is the script we invoke
-       proc "target_[set eventname]_[set target_num]" {} "script $scriptname" 
-       
+proc new_target_name { } {
+       return [target number [expr [target count] - 1 ]]
 }
 
 # Try flipping / and \ to find file if the filename does not
 # match the precise spelling
 proc find {filename} {
-       if {[catch {openocd_find $filename} t]==0} {
+       if {[catch {ocd_find $filename} t]==0} {
                return $t
-       }  
-       if {[catch {openocd_find [string map {\ /} $filename} t]==0} {
+       }
+       if {[catch {ocd_find [string map {\ /} $filename} t]==0} {
                return $t
-       }  
-       if {[catch {openocd_find [string map {/ \\} $filename} t]==0} {
+       }
+       if {[catch {ocd_find [string map {/ \\} $filename} t]==0} {
                return $t
-       }  
+       }
        # make sure error message matches original input string
-       return [openocd_find $filename]
+       return -code error "Can't find $filename"
 }
 add_help_text find "<file> - print full path to file according to OpenOCD search rules"
 
@@ -158,5 +103,12 @@ proc script {filename} {
 
 add_help_text script "<filename> - filename of OpenOCD script (tcl) to run"
 
-add_help_text target_script "<target#> <event=reset/pre_reset/post_halt/pre_resume/gdb_program_config> <script_file>"
+#########
 
+# catch any exceptions, capture output and return output
+proc capture_catch {a} {
+       catch {
+               capture {uplevel $a}
+       } result
+       return $result
+}

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)