drive: ergonomic RE helper over the RPC socket (terse text, auto socket)

Driving via rpcclient meant re-exporting the socket every fresh shell,
long invocations, and piping ~every call through python -c to pull one
field or grep pseudocode. idatui.drive fixes that: it auto-resolves the
socket (the single live pane from the registry), prints compact text
instead of JSON, and bundles the common gestures:

  where | go | pc <fn> [substr] | dis <fn> [n] | callees/callers <fn> |
  names <substr> | rename <old> <new> | mv old=new... | note <fn> <text> |
  screen | raw <method> k=v

So 'goto+rename+parse' becomes 'drive rename old new', and 'pseudocode |
python -c grep' becomes 'drive pc fn needle'. rpcclient stays the raw
transport. rpc_smoke drives it end-to-end (29 green).

1 files changed, 218 insertions, 0 deletions

diff --git a/idatui/drive.py b/idatui/drive.py
new file mode 100644
index 0000000..5a36add
--- /dev/null
+++ b/idatui/drive.py
@@ -0,0 +1,218 @@
+"""Ergonomic RE driver over the idatui RPC socket — terse text, auto socket.
+
+A thin, opinionated layer over ``idatui.rpcclient`` for reverse-engineering
+sessions. It removes the friction of raw driving: it resolves the socket
+automatically (the single live pane), prints compact text instead of JSON
+blobs, and bundles the common composite gestures (goto+rename, batch rename,
+function comment, filtered pseudocode). Use it for low-overhead tool-calls.
+
+    python3 -m idatui.drive where                 # where am I
+    python3 -m idatui.drive pc main strrchr        # pseudocode of main, lines matching 'strrchr'
+    python3 -m idatui.drive callees main           # what main calls
+    python3 -m idatui.drive rename sub_5BE0 stdout_isatty
+    python3 -m idatui.drive mv sub_A=foo sub_B=bar # batch rename
+    python3 -m idatui.drive note main "entry point"# function comment
+
+Socket: --sock, else IDATUI_RPC_SOCK, else the one live pane (from `pane list`).
+'.' or omitted as a target means the current function. `raw <method> k=v` is a
+passthrough to rpcclient (pretty JSON).
+"""
+from __future__ import annotations
+
+import json
+import os
+import sys
+
+from .pane import _load_registry, _pane_alive
+from .rpcclient import RpcClient, RpcError
+
+
+def _resolve_sock(explicit: str | None) -> str:
+    if explicit:
+        return explicit
+    env = os.environ.get("IDATUI_RPC_SOCK")
+    if env:
+        return env
+    live = [r for r in _load_registry()
+            if _pane_alive(r.get("pane", "")) and r.get("sock")
+            and os.path.exists(r["sock"])]
+    if len(live) == 1:
+        return live[0]["sock"]
+    if not live:
+        raise SystemExit("no live idatui pane — pass --sock, set IDATUI_RPC_SOCK, "
+                         "or `python -m idatui.pane spawn ...`")
+    raise SystemExit("multiple live panes — pass --sock <one of>:\n"
+                     + "\n".join("  " + r["sock"] for r in live))
+
+
+def _tgt(a: str | None) -> str | None:
+    return None if a in (None, ".", "") else a
+
+
+def _coerce(v: str):
+    low = v.lower()
+    return {"true": True, "false": False, "null": None}.get(low, v)
+
+
+# --------------------------------------------------------------------------- #
+# commands  (each: (client, args) -> text)
+# --------------------------------------------------------------------------- #
+def _fmt_where(st: dict) -> str:
+    fn = st.get("function") or {}
+    cur = st.get("cursor") or {}
+    name = fn.get("name")
+    ea = fn.get("ea")
+    loc = f"{name} @ {ea:#x}" if isinstance(ea, int) else "(none)"
+    extra = ""
+    if cur.get("kind") in ("decomp", "disasm"):
+        extra = f"  L{cur.get('line')} C{cur.get('col')} word={cur.get('word')!r}"
+    elif cur.get("kind") == "hex":
+        extra = f"  va={cur.get('va'):#x}" if isinstance(cur.get("va"), int) else ""
+    modal = st.get("modal")
+    m = f"  [modal:{modal['kind']}]" if modal else ""
+    return f"{loc}  [{st.get('active')}]{extra}{m}"
+
+
+def cmd_where(c, args):
+    return _fmt_where(c.call("state"))
+
+
+def cmd_go(c, args):
+    if not args:
+        raise SystemExit("usage: go <fn>")
+    c.call("goto", target=args[0], delay_ms=0)
+    return _fmt_where(c.call("state"))
+
+
+def cmd_pc(c, args):
+    target = _tgt(args[0]) if args else None
+    needle = args[1].lower() if len(args) > 1 else None
+    d = c.call("pseudocode", target=target)
+    if not d.get("code"):
+        return f"(no pseudocode: {d.get('error')})"
+    lines = d["code"].splitlines()
+    if needle:
+        lines = [f"{i:4} {l}" for i, l in enumerate(lines) if needle in l.lower()]
+        return "\n".join(lines) or f"(no line matches {needle!r})"
+    return d["code"]
+
+
+def cmd_dis(c, args):
+    target = _tgt(args[0]) if args else None
+    n = int(args[1]) if len(args) > 1 else 60
+    d = c.call("disassembly", target=target, max=n)
+    return "\n".join(f"{ln['ea']:#010x}  {ln['text']}" for ln in d.get("lines", []))
+
+
+def cmd_callees(c, args):
+    xs = c.call("xrefs_from", target=_tgt(args[0]) if args else None)
+    funcs = [x for x in xs if x.get("is_func")]
+    data = [x for x in xs if not x.get("is_func")]
+    out = [f"  {x['to']:#x}  {x.get('name')}" for x in funcs]
+    for x in data:
+        s = f" {x['string']!r}" if x.get("string") else ""
+        out.append(f"  {x['to']:#x}  {x.get('name')}{s}")
+    return "\n".join(out) or "(no outgoing refs)"
+
+
+def cmd_callers(c, args):
+    if not args:
+        raise SystemExit("usage: callers <fn>")
+    xs = c.call("xrefs_to", target=args[0])
+    return "\n".join(f"  {x['frm']:#x}  in {x.get('fn_name')}" for x in xs) \
+        or "(no callers)"
+
+
+def cmd_names(c, args):
+    if not args:
+        raise SystemExit("usage: names <substr> [limit]")
+    lim = int(args[1]) if len(args) > 1 else 40
+    fs = c.call("functions", filter=args[0], limit=lim)
+    return "\n".join(f"  {f['ea']:#x}  {f['name']}  ({f['size']})" for f in fs) \
+        or "(no match)"
+
+
+def _rename_one(c, old, new):
+    c.call("goto", target=old, delay_ms=0)
+    st = c.call("rename", name=new, word=old, delay_ms=0)
+    got = (st.get("function") or {}).get("name")
+    return f"  {old} -> {got}"
+
+
+def cmd_rename(c, args):
+    if len(args) != 2:
+        raise SystemExit("usage: rename <old> <new>")
+    return _rename_one(c, args[0], args[1])
+
+
+def cmd_mv(c, args):
+    out = []
+    for pair in args:
+        if "=" not in pair:
+            raise SystemExit(f"usage: mv old=new ...  (bad: {pair!r})")
+        old, new = pair.split("=", 1)
+        try:
+            out.append(_rename_one(c, old, new))
+        except RpcError as e:
+            out.append(f"  {old} -> FAILED: {e}")
+    return "\n".join(out)
+
+
+def cmd_note(c, args):
+    if len(args) < 2:
+        raise SystemExit("usage: note <fn> <text...>")
+    c.call("goto", target=args[0], delay_ms=0)
+    c.call("cursor", line=0, col=0)
+    c.call("comment", text=" ".join(args[1:]), delay_ms=0)
+    return f"  noted {args[0]}"
+
+
+def cmd_screen(c, args):
+    return c.call("screen").get("text", "")
+
+
+def cmd_raw(c, args):
+    if not args:
+        raise SystemExit("usage: raw <method> [k=v ...]")
+    params = {}
+    for tok in args[1:]:
+        k, _, v = tok.partition("=")
+        params[k] = _coerce(v)
+    return json.dumps(c.call(args[0], **params), indent=2)
+
+
+COMMANDS = {
+    "where": cmd_where, "go": cmd_go, "pc": cmd_pc, "dis": cmd_dis,
+    "callees": cmd_callees, "callers": cmd_callers, "names": cmd_names,
+    "rename": cmd_rename, "mv": cmd_mv, "note": cmd_note,
+    "screen": cmd_screen, "raw": cmd_raw,
+}
+
+
+def main(argv: list[str]) -> int:
+    args = list(argv)
+    sock = None
+    if args and args[0] == "--sock":
+        sock, args = args[1], args[2:]
+    if not args or args[0] in ("-h", "--help", "help"):
+        print("commands: " + " ".join(COMMANDS), file=sys.stderr)
+        print(__doc__, file=sys.stderr)
+        return 0 if args[:1] in (["help"], ["-h"], ["--help"]) else 2
+    cmd, rest = args[0], args[1:]
+    fn = COMMANDS.get(cmd)
+    if fn is None:
+        print(f"unknown command: {cmd!r} (try: {' '.join(COMMANDS)})", file=sys.stderr)
+        return 2
+    try:
+        with RpcClient(_resolve_sock(sock)) as c:
+            out = fn(c, rest)
+    except (OSError, RpcError, ConnectionError) as e:
+        print(f"error: {e}", file=sys.stderr)
+        return 1
+    if out:
+        print(out)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main(sys.argv[1:]))