BEH_DEBUG(3)

📦 version 5.1.1, in fedora 43, fedora 44

🦋 ORIGIN 🦋

okay so before we get into it, bestie, here's where this whole thing comes from. This software belongs to the ALLIANCE CAD SYSTEM developed by the ASIM team at the LIP6 laboratory of Université Pierre et Marie CURIE, in Paris, France. 🇫🇷✨

💖 NAME 💖

beh_debug — the BEH structures displayer-debugger, aka your new fave little window into what your structs are actually doing 👀

✨ SYNOPSIS ✨

void beh_debug (pnt, type)
void *pnt;
char *type;

🎀 PARAMETERS 🎀

  • pnt — the pointer of the structure you wanna display. just hand it over, she'll take it from there 🫶
  • type — the name of the structure to be displayed. and like, type can be any of: "befig", "beout", "bereg", "bemsg", "bepor", "begen", "berin", "bebus", "beaux", "bebux", "biabl", "binode", "beder", "bequad", "abl", "integer", "long", "short", "character", "ptype", "chain". that's the whole menu, no substitutions 💅

🌸 DESCRIPTION 🌸

When you call her, beh_debug() displays the structure pointed by pnt, and then prints this line:

COMMAND   >>

…and then she just waits. patiently. for a command to be entered by the user. the way she's literally just standing there waiting for you to say something 😭

Now — important — if pnt is a NULL pointer, or if type doesn´t represent a known structure, beh_debug() exits without making any action. like, she just leaves. no drama, no output, nothing. periodt.

🌈 how she shows you the struct

To display the structure, beh_debug() prints a line per field. Fields containing an immediate value (integer, character, string, ...) are displayed in the following form:

name_of_the_field  :  value_of_the_field

Fields containing a pointer are marked by the symbol ->. And if the field contains a NULL pointer, the field is displayed as:

-> name_of_the_field  :

In the other case, beh_debug() prints :

-> name_of_the_field  :  available

👑 the two kinds of command, bestie

Two kinds of command are accepted by the displayer. yes, two. iconic.

Kind one: a command can be the name of a field containing a pointer. The command is accepted only if the pointer is not a NULL pointer (so, only if the field was displayed as "available"). When the debugger receives such a command, it first pushes the current structure on its stack, then displays the structure pointed by the named field. it's giving descend into the void 🕳️✨

Kind two: the predefined commands, and there are eight of them:

  • _exit — to exit from the debugger
  • _up — to return to the previous structure
  • _stop — to put a stop mark on the current structure
  • _top — to return to the first structure (the one pointed by pnt)
  • _back — to return to the last structure marked with a stop mark
  • _save — to save the current structure in a static table. At most 10 structures may be saved. (example : "_save 1" saves the current structure in the entry number 1 of the table)
  • _jump — to jump to a saved structure (example : "_jump 1" displays the structure saved in the entry number 1 of the table).
  • _display — displays a field under a given format. (example : "_display next integer" displays the field named next as an integer).

In addition to these commands, the command . (dot) can be used to repeat the last command. muscle memory queen 💅

⭐ EXAMPLE ⭐

#include <beh109.h>
struct beout *beout_pnt;

beh_debug (beout_pnt , "beout");

🍓 NOTES 🍓

beh_debug() uses an internal stack. The message "stack overflow" is printed if too many structures have been pushed on the stack. so like… don't go too deep, bestie, she will absolutely tell on you 💀

🧚 SEE ALSO 🧚

beh(3)

💜 BUG REPORT 💜

This tool is under development at the ASIM department of the LIP6 laboratory. We need your feedback to improve documentation and tools. fr fr, they're literally asking, so if something's weird, say something 🫶

and that's the whole page, gorgeous 💖 this one came from ASIM/LIP6, dated October 1, 1997, and it's living in section BEH_DEBUG(3). go debug something cute ✨👑

📦 where this page comes from