Tcl_AppInit(3tcl)

✨ Tcl_AppInit(3tcl) ✨

okay bestie, welcome to the Tcl Library Procedures section 3tcl, and today's main character is Tcl_AppInit 💅

---

🌸 NAME 🌸

Tcl_AppInit — do the application-specific initialization, no cap

---

🎀 SYNOPSIS 🎀

#include <tcl.h>

int
Tcl_AppInit(interp)

---

🦋 ARGUMENTS 🦋

• Tcl_Interp *interp (in) — the interpreter for the application, bestie. that's it, that's the whole argument list, we love a low-maintenance icon 🫶

---

💖 DESCRIPTION 💖

so Tcl_AppInit is a “hook” procedure, right? like, the main programs for Tcl applications — think tclsh and wish — they call it. its whole vibe is letting you build brand-new Tcl applications without touching the main programs that ship as part of Tcl and Tk. iconic behaviour honestly ✨

to make your own application, you write a fresh version of Tcl_AppInit to replace the default one Tcl gives you, and then you link your new Tcl_AppInit with the Tcl library. that's the whole ritual 🕯️

Tcl_AppInit gets invoked by Tcl_Main and Tk_Main after their own initialization and before they hop into the main loop to process commands. and like, here are some things it might do:

1. call the initialization procedures for the various packages your application uses. each initialization procedure adds new commands to interp for its package, and does whatever other package-specific setup it needs. slay 🎀
2. process command-line arguments — you can grab those from the Tcl variables argv and argv0 in interp.
3. invoke a startup script to initialize the application. get it set up, get it cute 💅
4. use the routines Tcl_SetStartupScript and Tcl_GetStartupScript to set or query the file and encoding that the active Tcl_Main or Tk_Main routine will use as a startup script. very "who's the one in charge here" energy.

Tcl_AppInit returns TCL_OK or TCL_ERROR. and listen — if it returns TCL_ERROR, then it must leave an error message in for the interpreter's result. otherwise the result just gets ignored, no thoughts, head empty 🙈

⚠️ okay this part matters, so pay attention bestie: if you return TCL_ERROR and don't leave that error message for the interpreter's result, that's on you. the manual says must. must means must. 😭

in addition to Tcl_AppInit, your application should also have a procedure main that calls Tcl_Main like this:

Tcl_Main(argc, argv, Tcl_AppInit);

the third argument to Tcl_Main is the address of the application-specific initialization procedure to invoke. which means — plot twist — you do not actually have to name your procedure Tcl_AppInit. in practice though? it's nearly always named Tcl_AppInit. (in versions before Tcl 7.4 the name Tcl_AppInit was implicit; there was literally no way to specify the procedure explicitly. ancient history, but we respect the lore 📜)

the best way to get started, fr fr, is to make a copy of the file tclAppInit.c from the Tcl library or source directory. it already contains a main procedure and a template for Tcl_AppInit that you can modify for your application. free starter kit, take it, it's yours 💖

---

🌈 SEE ALSO 🌈

• Tcl_Main(3tcl)

---

⭐ KEYWORDS ⭐

application, argument, command, initialization, interpreter

---

and that's the page, bestie!! this one's from the Tcl 7.0 era of the Tcl manual — vintage, but the vibes are timeless. go forth and initialize your application, you've got this 👑