ord: fix tcl completion issue #7816

Use ::sta::cmd_args to find the command args and combine them
with file completions and ScriptCompleter results.
ScriptCompleter runs the command with args "----" to find its
completions, which can have side effects! Maybe we should remove
it entirely in a follow up PR.

Fixes #7816

Signed-off-by: Ahmed R. Mohamed <[email protected]>

Author: Ahmed R. Mohamed

src/Main.cc

@@ -313,14 +313,9 @@ int main(int argc, char* argv[])
 #ifdef ENABLE_READLINE
 static int tclReadlineInit(Tcl_Interp* interp)
 {
-  std::array<const char*, 7> readline_cmds = {
-      "history event",
-      "eval $auto_index(::tclreadline::ScriptCompleter)",
-      "::tclreadline::readline builtincompleter true",
-      "::tclreadline::readline customcompleter ::tclreadline::ScriptCompleter",
-      "proc ::tclreadline::prompt1 {} { return \"openroad> \" }",
-      "proc ::tclreadline::prompt2 {} { return \"...> \" }",
-      "::tclreadline::Loop"};
+  std::array<const char*, 2> readline_cmds = {
+    "ord::setup_tclreadline",
+    "::tclreadline::Loop"};
 
   for (auto cmd : readline_cmds) {
     if (TCL_ERROR == Tcl_Eval(interp, cmd)) {

src/OpenRoad.tcl

@@ -587,5 +587,51 @@ proc parse_list_args { cmd arg_var list_var lists_args } {
   }
 }
 
+proc cmd_args_completer {part start end line} {
+  if { $start == 0 || [catch {set cmd [::tclreadline::Lindex $line 0]} err] != 0 } {
+      utl::redirectStringBegin
+      set err [catch {::tclreadline::ScriptCompleter $part $start $end $line} ret]
+      utl::redirectStringEnd
+      if { $err == 0} {
+        return $ret
+      } else {
+        return ""
+      }
+  }
+  if { [info exists ::sta::cmd_args($cmd)] } {
+    set metadata $::sta::cmd_args($cmd)
+  }
+  set unused_flags {}
+  if { [info exists metadata] } {
+    set all_flags [regexp -all -inline -- {[-+][a-zA-Z0-9_]+} $metadata]
+    set unused_flags [::tclreadline::RemoveUsedOptions $line [lsort -unique $all_flags]]
+  }
+  set raw_files [glob -nocomplain -types {f d} -- "${part}*"]
+  set files {}
+  foreach f $raw_files {
+    if {[file isdirectory $f]} {
+      lappend files "${f}/"
+    } else {
+      lappend files $f
+    }
+  }
+  set matches [lsort -unique [concat $unused_flags $files]]
+  set matches [::tclreadline::CompleteFromList $part $matches]
+  if { [llength $matches] == 1 && [string index [lindex $matches 0] end] == "/" } {
+    return [list [lindex $matches 0] [list {}]]
+  }
+  return $matches
+}
+
+proc setup_tclreadline { } {
+  history event
+  eval $::auto_index(::tclreadline::ScriptCompleter)
+  ::tclreadline::readline builtincompleter false
+  catch { ::tclreadline::ScriptCompleter "" 0 0 "" }
+  ::tclreadline::readline customcompleter ::ord::cmd_args_completer
+  proc ::tclreadline::prompt1 {} { return "openroad> " }
+  proc ::tclreadline::prompt2 {} { return "...> " }
+}
+
 # namespace ord
 }

test/issue_7816.ok

@@ -0,0 +1,8 @@
+Test 1: Command name completion 'read_db'
+PASS: Test 1 returned empty (as expected for mock failure)
+
+Test 2: Argument completion 'read_db '
+PASS: Test 2 returned list of length > 0
+
+Test 3: write_lef completion
+PASS: Test 3 returned list of length > 0

test/issue_7816.tcl

@@ -0,0 +1,72 @@
+# Mock tclreadline
+namespace eval ::tclreadline {
+  proc Lindex {line index} {
+    return [lindex $line $index]
+  }
+  
+  proc ScriptCompleter {part start end line} {
+    # Simulate noisy output from ScriptCompleter to ensure it's suppressed
+    puts "ScriptCompleter: [ERROR] Should be suppressed"
+    error "ScriptCompleter Error"
+  }
+
+  proc RemoveUsedOptions {line flags} {
+    # Default behavior: return flags as is
+    return $flags
+  }
+
+  proc CompleteFromList {part matches} {
+    set res {}
+    foreach m $matches {
+      if {[string match "${part}*" $m]} {
+        lappend res $m
+      }
+    }
+    return $res
+  }
+}
+
+if {[info procs ::ord::cmd_args_completer] eq ""} {
+  puts "Error: ::ord::cmd_args_completer not found."
+  exit 1
+}
+
+puts "Test 1: Command name completion 'read_db'"
+# start=0 triggers ScriptCompleter path.
+# We expect NO error to propagate (caught inside) and clean stdout (redirected).
+# Result should be "" (from catch block returning "")
+set result ""
+if { [catch {set result [::ord::cmd_args_completer "read_db" 0 7 "read_db"]} err] } {
+  puts "FAIL: Test 1 threw error: $err"
+} else {
+  if {$result eq ""} {
+    puts "PASS: Test 1 returned empty (as expected for mock failure)"
+  } else {
+    puts "PASS: Test 1 returned: $result"
+  }
+}
+
+puts "\nTest 2: Argument completion 'read_db '"
+# start=8 triggers RemoveUsedOptions path.
+# We expect it to find files in current directory (or our mock).
+# Since we didn't mock glob, it will use real glob.
+# 'read_db' takes a file. cmd_args_completer logic does `glob`.
+set result ""
+if { [catch {set result [::ord::cmd_args_completer "" 8 8 "read_db "]} err] } {
+  puts "FAIL: Test 2 threw error: $err"
+} else {
+  # It should return a list of files/dirs
+  if {[llength $result] > 0} {
+     puts "PASS: Test 2 returned list of length > 0"
+  }
+}
+
+puts "\nTest 3: write_lef completion"
+# write_lef also takes filename.
+if { [catch {set result [::ord::cmd_args_completer "" 10 10 "write_lef "]} err] } {
+  puts "FAIL: Test 3 threw error: $err"
+} else {
+  if {[llength $result] > 0} {
+     puts "PASS: Test 3 returned list of length > 0"
+  }
+}

test/regression_tests.tcl

@@ -24,3 +24,5 @@ record_flow_tests {
 record_test open_db $test_dir "compare_logfile" "-db gcd_sky130hd.odb"
 # For invalid DB, allow non-zero exit but require log to match ok
 record_test open_db_invalid $test_dir "compare_logfile_allow_error" "-db nonexistent_file.odb"
+
+record_test issue_7816 $test_dir "compare_logfile"