Tcl_Backslash(3)

📦
version 8.6.17 · 2 versions
  • 8.6.17 · alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, centos-stream 10, opensuse-leap 16.0 (latest)
  • 8.6.10 · centos-stream 9
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, centos-stream 10, opensuse-leap 16.0

🌸 NAME 🌸

okay bestie, this is the Tcl_Backslash(3) page — and the whole vibe is Tcl_Backslash - parse a backslash sequence. It’s a Tcl library procedure, and yes, it’s giving “legacy but still iconic” energy. ✨

✨ SYNOPSIS ✨

#include <tcl.h>

char
Tcl_Backslash(src, countPtr)

🎀 ARGUMENTS 🎀

  • const char *src (in) — pointer to a string that starts with a backslash. Like, it literally begins with \, no cap.
  • int *countPtr (out) — if countPtr is not NULL, then *countPtr gets filled in with the number of characters in the backslash sequence, including the backslash character itself. Count it, bestie.

💅 DESCRIPTION 💅

Okay, first things first, important tea: the use of Tcl_Backslash is deprecated in favor of Tcl_UtfBackslash. So it’s still here, but it’s lowkey in its legacy era. Don’t pretend we didn’t warn you. 😭

This is a utility procedure provided for backwards compatibility with non-internationalized Tcl extensions. It parses a backslash sequence and returns the low byte of the Unicode character corresponding to the sequence. Tcl_Backslash modifies *countPtr to contain the number of characters in the backslash sequence.

See the Tcl manual entry for info on the valid backslash sequences. All of the sequences described in the Tcl manual entry are supported by Tcl_Backslash. Slay, compatibility icon. 💖

🔍 SEE ALSO 🔍

🔑 KEYWORDS 🔑

  • backslash
  • parse

cute sign-off: this page is from Tcl 8.1, manual name Tcl_Backslash(3), and the footer doesn’t give a date — so that’s the source/version/date sitch, bestie 💖🫶

📦 where this page comes from