Tcl_RecordAndEval(3tcl)

📦
version 9.0.4 · 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 Tcl_RecordAndEval — bestie edition 💖

okay so you're in the Tcl Library Procedures corner of the manual and the page we're doing today is Tcl_RecordAndEval. she's giving history-list girlie and honestly? she ate. let's go 🌸

✨ NAME ✨

Tcl_RecordAndEval — save command on history list before evaluating 🎀

🦋 SYNOPSIS 🦋

#include <tcl.h>

int
Tcl_RecordAndEval(interp, cmd, flags)

🌈 ARGUMENTS 🌈

  • Tcl_Interp *interp (in) — the Tcl interpreter where you wanna evaluate the command. literally the whole vibe lives in here 💜
  • const char *cmd (in) — the command (or a whole sequence of commands, she's flexible) that you want to execute ✨
  • int flags (in) — an OR'ed-together combo of flag bits, no cap:
    • TCL_NO_EVAL means record the command but do not evaluate it 🙈
    • TCL_EVAL_GLOBAL means evaluate the command at global level instead of the current stack level 👑

🌸 DESCRIPTION 🌸

So Tcl_RecordAndEval is the function you call when you want to record a command as an event on the history list and then run it using Tcl_Eval (or Tcl_GlobalEval if the TCL_EVAL_GLOBAL bit is set in flags). she does both. multitasking icon 💅

She returns a completion code like TCL_OK — exactly like Tcl_Eval does — and she leaves info chillin' in the interpreter's result. 🫶

bestie, listen: if you do not want the command recorded on the history list, then you should invoke Tcl_Eval instead of Tcl_RecordAndEval. that's the whole difference. periodt.

Normally Tcl_RecordAndEval is only called with top-level commands typed by the user, because the entire point of history is to let the user re-issue recently-invoked commands. it's giving up-arrow energy ⬆️✨

And if the flags argument contains the TCL_NO_EVAL bit, then the command gets recorded without being evaluated. recorded but not performed. the ultimate "not me, I'm just watching" move 😭

Also lowkey important: note that Tcl_RecordAndEval has been largely replaced by the value-based procedure Tcl_RecordAndEvalObj. that value-based procedure records and optionally executes a command held in a Tcl value instead of a string. so like, glow-up version, same soul 💖

🎀 SEE ALSO 🎀

  • Tcl_RecordAndEvalObj — her value-based sister, go say hi 🦋

⭐ KEYWORDS ⭐

command, event, execute, history, interpreter, record

mwah 💋 this page is from the Tcl library manual, version 7.4, dated 7.4 — ily, go record some history and slay responsibly 👑🌈

📦 where this page comes from