brlapi_deprecated(3)

💖 brlapi_deprecated — NAME 💖

bestie. okay. so this page lives in the Library Functions Manual and it's called brlapi_deprecated (yes, the (3) one, library functions energy 💅). And what is it? Deprecated names. that's it. that's the whole name. it's the group chat where all the old BrlAPI names went to hang out before they get yeeted. 🫶

---

✨ SYNOPSIS ✨

🎀 Data Structures 🎀

• struct brlapi_writeStruct — the old-school struct, still kicking around

🦋 Macros 🦋

every one of these is an old name pointing at its new name. they still work, but they are deprecated — do not get attached, fr fr.

• #define brlapi_settings_t brlapi_connectionSettings_t — glow-up: settings got a full first name
• #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER — the initializer formerly known as WRITESTRUCT
• #define brl_keycode_t brlapi_keyCode_t — brl_ era name, meet the brlapi_ era name
• #define brl_type_t brlapi_packetType_t — same deal, new surname
• #define BRLCOMMANDS NULL — lowkey iconic, it's just NULL now
• #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX — the max, but make it BRLAPI_
• #define brlapi_initializeConnection brlapi_openConnection — you don't initialize anymore, you open ✨
• #define brlapi_getTty brlapi_enterTtyMode — get? no bestie, you enter
• #define brlapi_getTtyPath brlapi_enterTtyModeWithPath — and if you brought a path, say so
• #define brlapi_leaveTty brlapi_leaveTtyMode — leaving is a mode, apparently
• #define brlapi_unignoreKeyRange brlapi_acceptKeyRange — "unignore" was always a jump scare, now it's "accept" 🥰
• #define brlapi_unignoreKeySet brlapi_acceptKeySet — same healing arc, but for a whole set
• #define brlapi_getRaw brlapi_enterRawMode — again: enter, not get
• #define brlapi_leaveRaw brlapi_leaveRawMode — symmetrical queen
• #define brlapi_suspend brlapi_suspendDriver — now with Driver attached so you know what's napping
• #define brlapi_resume brlapi_resumeDriver — and what's waking back up
• #define BRLERR_SUCCESS BRLAPI_ERROR_SUCCESS — yes the error constant for success, we don't make the rules
• #define BRLERR_NOMEM BRLAPI_ERROR_NOMEM — out of memory, but spelled the new way
• #define BRLERR_TTYBUSY BRLAPI_ERROR_TTYBUSY — tty is busy, it's booked
• #define BRLERR_DEVICEBUSY BRLAPI_ERROR_DEVICEBUSY — device is busy too, everyone's busy
• #define BRLERR_UNKNOWN_INSTRUCTION BRLAPI_ERROR_UNKNOWN_INSTRUCTION — didn't understand the instruction, sorry
• #define BRLERR_ILLEGAL_INSTRUCTION BRLAPI_ERROR_ILLEGAL_INSTRUCTION — that instruction is illegal, we don't do that here 🚫
• #define BRLERR_INVALID_PARAMETER BRLAPI_ERROR_INVALID_PARAMETER — bad parameter bestie
• #define BRLERR_INVALID_PACKET BRLAPI_ERROR_INVALID_PACKET — bad packet, not it
• #define BRLERR_CONNREFUSED BRLAPI_ERROR_CONNREFUSED — the connection said no 💀
• #define BRLERR_OPNOTSUPP BRLAPI_ERROR_OPNOTSUPP — operation not supported, we tried
• #define BRLERR_GAIERR BRLAPI_ERROR_GAIERR — getaddrinfo said something and it wasn't nice
• #define BRLERR_LIBCERR BRLAPI_ERROR_LIBCERR — libc has entered the chat
• #define BRLERR_UNKNOWNTTY BRLAPI_ERROR_UNKNOWNTTY — who is this tty? never met her
• #define BRLERR_PROTOCOL_VERSION BRLAPI_ERROR_PROTOCOL_VERSION — protocol version mismatch, awkward
• #define BRLERR_EOF BRLAPI_ERROR_EOF — end of file, that's all folks
• #define BRLERR_EMPTYKEY BRLAPI_ERROR_EMPTYKEY — the key was empty, tragic
• #define BRLERR_DRIVERERROR BRLAPI_ERROR_DRIVERERROR — the driver is having a day 😭

🌸 Detailed Description 🌸

okay so story time. with version 0.5.0, BrlAPI is now provided through including <brlapi.h> and it got a big renaming pass. the old names are still available through macros, but they are deprecated since they will get dropped in the next release. this documentation is for you to know the new names. 🎀

and here's the little trick: for checking that you have completely switched to new names, just define BRLAPI_NO_DEPRECATED — that will disable the compatibility macros. do that and if your code still compiles, you ate. 👑

💀 warning: these macros are deprecated. they will get dropped in the next release. do not start new code with them, do not cling. it's giving temporary.

---

🧚 Macro Definition Documentation 🧚

here's the same list again, exactly how the doc generator laid it out, because we keep every crumb. same mappings, alphabetical-ish order, no notes needed — the new name is right there on the line. 🦋

#define BRL_KEYCODE_MAX   BRLAPI_KEY_MAX
#define brl_keycode_t   brlapi_keyCode_t
#define brl_type_t   brlapi_packetType_t
#define brlapi_getRaw   brlapi_enterRawMode
#define brlapi_getTty   brlapi_enterTtyMode
#define brlapi_getTtyPath   brlapi_enterTtyModeWithPath
#define brlapi_initializeConnection   brlapi_openConnection
#define brlapi_leaveRaw   brlapi_leaveRawMode
#define brlapi_leaveTty   brlapi_leaveTtyMode
#define brlapi_resume   brlapi_resumeDriver
#define brlapi_settings_t   brlapi_connectionSettings_t
#define brlapi_suspend   brlapi_suspendDriver
#define brlapi_unignoreKeyRange   brlapi_acceptKeyRange
#define brlapi_unignoreKeySet   brlapi_acceptKeySet
#define BRLAPI_WRITESTRUCT_INITIALIZER   BRLAPI_WRITEARGUMENTS_INITIALIZER
#define BRLCOMMANDS   NULL
#define BRLERR_CONNREFUSED   BRLAPI_ERROR_CONNREFUSED
#define BRLERR_DEVICEBUSY   BRLAPI_ERROR_DEVICEBUSY
#define BRLERR_DRIVERERROR   BRLAPI_ERROR_DRIVERERROR
#define BRLERR_EMPTYKEY   BRLAPI_ERROR_EMPTYKEY
#define BRLERR_EOF   BRLAPI_ERROR_EOF
#define BRLERR_GAIERR   BRLAPI_ERROR_GAIERR
#define BRLERR_ILLEGAL_INSTRUCTION   BRLAPI_ERROR_ILLEGAL_INSTRUCTION
#define BRLERR_INVALID_PACKET   BRLAPI_ERROR_INVALID_PACKET
#define BRLERR_INVALID_PARAMETER   BRLAPI_ERROR_INVALID_PARAMETER
#define BRLERR_LIBCERR   BRLAPI_ERROR_LIBCERR
#define BRLERR_NOMEM   BRLAPI_ERROR_NOMEM
#define BRLERR_OPNOTSUPP   BRLAPI_ERROR_OPNOTSUPP
#define BRLERR_PROTOCOL_VERSION   BRLAPI_ERROR_PROTOCOL_VERSION
#define BRLERR_SUCCESS   BRLAPI_ERROR_SUCCESS
#define BRLERR_TTYBUSY   BRLAPI_ERROR_TTYBUSY
#define BRLERR_UNKNOWN_INSTRUCTION   BRLAPI_ERROR_UNKNOWN_INSTRUCTION
#define BRLERR_UNKNOWNTTY   BRLAPI_ERROR_UNKNOWNTTY

---

🌈 Author 🌈

Generated automatically by Doxygen for BrlAPI from the source code. (not me, not you, not a human — the robot did it. respect.) 🤖💜

---

and that's the page bestie, BrlAPI Version 0.8, the brlapi_deprecated(3) one, straight out of the Library Functions Manual. mwah. 💅✨🫶