miller/pkg/auxents/auxents.go
John Kerl 2f3e54d1f6
Remove os.Exit callsites below the entrypoint: phase 4 (plans/exit.md) (#2205)
Phase 4 of plans/exit.md: the aux/terminal sub-entrypoints. pkg/auxents and
pkg/terminals are now os.Exit-free; even the dispatchers return exit codes
instead of exiting.

- auxents.Dispatch returns (handled bool, exitCode int); entrypoint.Main --
  the one sanctioned exit point -- exits with the code.
- terminals.Dispatch returns an exit code; the climain caller wraps it in a
  lib.ExitRequest, which also retires the 'terminal did not exit the process'
  panic.
- Usage functions (hex, unhex, lecat, termcvt, repl, script, regtest) no
  longer take an exitCode parameter and exit; call sites print usage and
  return the code explicitly.
- Inner I/O helpers (hexDumpFile, unhexFile, lecatFile, termcvtFile) return
  errors; each sub-main prints 'mlr {verb}: ...' as before and returns 1.
  lecatFile formerly looped forever on a non-EOF read error; it now returns
  the error.
- The regtest directory walk (Execute / executeSinglePath /
  executeSingleDirectory / hasCaseSubdirectories) plumbs errors up to
  RegTestMain; regression_test.go updated for the new Execute signature.

Stderr messages and exit codes are unchanged across mlr aux-list, hex, unhex,
lecat, termcvt, help, version, repl, script, and regtest surfaces (checked by
hand); all 4779 regression cases pass; make lint is clean; docs rebuild with
zero churn.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-15 15:27:26 -04:00

68 lines
1.7 KiB
Go

// Support for Miller regression testing. Originally bash scripts; ported to Go
// for ease of Windows-native testing.
package auxents
import (
"fmt"
"os"
)
// tAuxMain is a function-pointer type for the entrypoint handler for a given auxent,
// such as 'help' or 'regtest'.
type tAuxMain func(args []string) int
type tAuxLookupEntry struct {
name string
main tAuxMain
}
// _AUX_LOOKUP_TABLE is the lookup table for auxents. We get a Golang
// "initialization loop" if this is defined statically. So, we use a "package
// init" function.
var _AUX_LOOKUP_TABLE = []tAuxLookupEntry{}
func init() {
_AUX_LOOKUP_TABLE = []tAuxLookupEntry{
{"aux-list", auxListMain},
{"hex", hexMain},
{"lecat", lecatMain},
{"termcvt", termcvtMain},
{"unhex", unhexMain},
}
}
// Dispatch is called from Miller main. The boolean return says whether
// argv[1] named an auxent handled here; if so, the int is the process exit
// code for the entrypoint layer to exit with. Otherwise control returns to
// main for the rest of Miller.
func Dispatch(args []string) (bool, int) {
if len(args) < 2 {
return false, 0
}
verb := args[1]
for _, entry := range _AUX_LOOKUP_TABLE {
if verb == entry.name {
return true, entry.main(args)
}
}
return false, 0
}
// auxListMain is the handler for 'mlr aux-list'.
func auxListMain(args []string) int {
ShowAuxEntries(os.Stdout)
return 0
}
// ShowAuxEntries is a symbol is exported for 'mlr --help'.
func ShowAuxEntries(o *os.File) {
fmt.Fprintf(o, "Available entries:\n")
for _, entry := range _AUX_LOOKUP_TABLE {
fmt.Fprintf(o, " mlr %s\n", entry.name)
}
fmt.Fprintf(o, "For more information, please invoke mlr {subcommand} --help.\n")
}