Tcl_OOInitStubs(3tcl)

💖 Tcl_OOInitStubs — bestie edition 💖

okay so this is a page from the TclOO Library Functions manual, section 3tcl, and it's literally all about one lil function called Tcl_OOInitStubs. it's short. it's sweet. it's giving "gatekeeper at the door of the TclOO C API." let's get into it 🫶

---

✨ NAME ✨

Tcl_OOInitStubs — initialize library access to TclOO functionality

so like. it initializes your library's access to TclOO stuff. that's the whole vibe. 🌸

---

🎀 SYNOPSIS 🎀

#include <tclOO.h>

const char *
Tcl_OOInitStubs(interp)

---

🦋 ARGUMENTS 🦋

• Tcl_Interp *interp (in) — the Tcl interpreter that the TclOO API is integrated with, and whose C interface is gonna be the one you use. that's the interp. your interp. the one you're working with. no cap 💅

---

🌈 DESCRIPTION 🌈

okay so picture this: your extension library wants to use the C interface that TclOO exposes. iconique. iconic. but bestie, you can't just walk in there — you gotta initialize your access to that interface first. do it from inside your *_Init function (or your *_SafeInit function, same energy), and pass in the interp that got passed into that routine as the context. that's the move. that's the whole ritual ✨

now here's the part where you pay attention, because the result actually tells you what happened:

• if calling Tcl_OOInitStubs gives you back NULL?? the initialization failed, and an error message will have been left sitting in the interpreter's result. it's giving heartbreak 😭
• otherwise?? initialization succeeded, and from that point on you can use the TclOO API freely. the function also hands you back the version of the TclOO API. slay 👑

and one more thing, and it's a pick-one-not-both situation:

• either the C #define symbol USE_TCLOO_STUBS should be defined and your library code linked against the Tcl stub library,
• or that #define symbol should not be defined and your library code linked against the Tcl main library directly.

that's it. that's the fork in the road. choose your lane 💫

---

💀 BACKWARD COMPATIBILITY NOTE 💀

if you're linking against the Tcl 8.5 forward compatibility package for TclOO — heads up — only the stub-enabled configuration is supported. so you should also link against the TclOO independent stub library. and here's the glow-up: that library is an integrated part of the main Tcl stub library in Tcl 8.6. so if you're on 8.6 you already got it, bestie. no extra steps. we love an integrated era 🌟

---

👑 KEYWORDS 👑

stubs

---

🔥 SEE ALSO 🔥

Tcl_InitStubs(3tcl)

---

and that's the page, fr fr. this lil slice of the manual is TclOO, version 1.0, documenting Tcl_OOInitStubs(3tcl). go initialize those stubs, bestie, you got this 💜💅🦋