brlapi_keycodes.h(3)

📦
version 6.9.1 · 6 versions
, in centos-stream 10, fedora 43, fedora 44, opensuse-leap 16.0, ubuntu resolute, ubuntu stonking

✨ NAME ✨

brlapi_keycodes.h — okay so this is the keycodes header from BrlAPI, filed under Library Functions Manual 🎀 bestie, this page is literally just the receipts for every keycode macro the library defines. no plot twist, just constants 💅

🌸 SYNOPSIS 🌸

Pull it in like this:

#include 'brlapi_constants.h'

🎀 Macros 🎀

Okay so here's the full lineup, in order, no skips, no cuts — every single one:

  • BRLAPI_KEYCODE_C(value) — the macro that takes a value and turns it into a keycode-shaped thing ✨
  • BRLAPI_PRIxKEYCODE — expands to exactly PRIx64, lowercase-hex printf energy 💜
  • BRLAPI_PRIuKEYCODE — expands to exactly PRIu64, unsigned decimal printf energy 💜
  • BRLAPI_KEY_MAX — UINT64_C(0XFFFFFFFFFFFFFFFF), the absolute ceiling, the final boss, no cap 🔥
  • BRLAPI_KEY_FLAGS_MASK — UINT64_C(0XFFFFFFFF00000000), the top half of the bits doing flag duty
  • BRLAPI_KEY_FLAGS_SHIFT — 32, the shift that gets you up into flag territory
  • BRLAPI_KEY_FLG(v) — the flag-maker macro, takes a v
  • BRLAPI_KEY_FLG_MOD1 — BRLAPI_KEY_FLG(0x00000008) 💫
  • BRLAPI_KEY_FLG_MOD2 — BRLAPI_KEY_FLG(0x00000010) 💫
  • BRLAPI_KEY_FLG_MOD3 — BRLAPI_KEY_FLG(0x00000020) 💫
  • BRLAPI_KEY_FLG_MOD4 — BRLAPI_KEY_FLG(0x00000040) 💫
  • BRLAPI_KEY_FLG_MOD5 — BRLAPI_KEY_FLG(0x00000080) 💫
  • BRLAPI_KEY_TYPE_MASK — UINT64_C(0X00000000E0000000), the mask that isolates the type
  • BRLAPI_KEY_TYPE_SHIFT — 29, shift amount for the type field
  • BRLAPI_KEY_TYPE_CMD — UINT64_C(0X0000000020000000), the command type 🫡
  • BRLAPI_KEY_TYPE_SYM — UINT64_C(0X0000000000000000), the symbol type, sitting pretty at zero
  • BRLAPI_KEY_CODE_MASK — UINT64_C(0X000000001FFFFFFF), the mask for the code bits
  • BRLAPI_KEY_CODE_SHIFT — 0, zero shift, we stay exactly where we are bestie 🛋️
  • BRLAPI_KEY_CMD_BLK_MASK — UINT64_C(0X1FFF0000), the block field mask for commands
  • BRLAPI_KEY_CMD_BLK_SHIFT — 16, how far you slide to reach the command block
  • BRLAPI_KEY_CMD_ARG_MASK — UINT64_C(0X0000FFFF), the command argument mask
  • BRLAPI_KEY_CMD_ARG_SHIFT — 0, again zero, again unbothered 💅
  • BRLAPI_KEY_CMD(v) — the command-maker macro, takes a v
  • BRLAPI_KEY_SYM_BACKSPACE — UINT64_C(0X0000FF08) ⌫
  • BRLAPI_KEY_SYM_TAB — UINT64_C(0X0000FF09) ⏩
  • BRLAPI_KEY_SYM_LINEFEED — UINT64_C(0X0000FF0D) 📄
  • BRLAPI_KEY_SYM_ESCAPE — UINT64_C(0X0000FF1B) 🚪
  • BRLAPI_KEY_SYM_HOME — UINT64_C(0X0000FF50) 🏠
  • BRLAPI_KEY_SYM_LEFT — UINT64_C(0X0000FF51) ⬅️
  • BRLAPI_KEY_SYM_UP — UINT64_C(0X0000FF52) ⬆️
  • BRLAPI_KEY_SYM_RIGHT — UINT64_C(0X0000FF53) ➡️
  • BRLAPI_KEY_SYM_DOWN — UINT64_C(0X0000FF54) ⬇️
  • BRLAPI_KEY_SYM_PAGE_UP — UINT64_C(0X0000FF55) 📑
  • BRLAPI_KEY_SYM_PAGE_DOWN — UINT64_C(0X0000FF56) 📑
  • BRLAPI_KEY_SYM_END — UINT64_C(0X0000FF57) 🏁
  • BRLAPI_KEY_SYM_INSERT — UINT64_C(0X0000FF63) ✏️
  • BRLAPI_KEY_SYM_FUNCTION — UINT64_C(0X0000FFBE) 🎛️
  • BRLAPI_KEY_SYM_DELETE — UINT64_C(0X0000FFFF) 🗑️
  • BRLAPI_KEY_SYM_UNICODE — UINT64_C(0X01000000) 🌈
  • BRLAPI_DRV_KEY_PRESS — BRLAPI_KEYCODE_C(0X8000000000000000), the driver key-press code 💥
  • BRLAPI_DRV_KEY_NUMBER_SHIFT — 0
  • BRLAPI_DRV_KEY_NUMBER_MASK — 0XFF
  • BRLAPI_DRV_KEY_NUMBER(code) — the macro that pulls the number out of a code
  • BRLAPI_DRV_KEY_GROUP_SHIFT — 8
  • BRLAPI_DRV_KEY_GROUP_MASK — 0XFF00
  • BRLAPI_DRV_KEY_GROUP(code) — the macro that pulls the group out of a code
  • BRLAPI_DRV_KEY_VALUE_MASK — (BRLAPI_DRV_KEY_GROUP_MASK | BRLAPI_DRV_KEY_NUMBER_MASK), both masks fused into one, iconic behavior ✨
  • BRLAPI_DRV_KEY_NUMBER_ANY — 0XFF
bestie, if you're copy-pasting these, copy them exactly. the capital X in 0X... is not a typo, it is the assignment. do not freestyle it 🙈

🦋 Typedefs 🦋

  • typedef uint64_t brlapi_keyCode_t — the keycode type itself, a uint64_t and honestly? main character energy 👑

💖 Author 💖

Generated automatically by Doxygen for BrlAPI from the source code. not me getting emotionally attached to an autogenerated author section 😭

and that's the whole page, bestie — no options, no flags, no exit statuses, just a very well-documented pile of macros. you ate this. periodt. 💅

signing off from the bottom of the page: BrlAPI, Version 0.8, manual page brlapi_keycodes.h(3) 🫶✨

📦 where this page comes from