1/* $Id: curses.tail,v 1.29 2025/07/26 15:32:01 tom Exp $ */ 2/* 3 * vile:cmode: 4 * This file is part of ncurses, designed to be appended after curses.h.in 5 * (see that file for the relevant copyright). 6 */ 7 8/* mouse interface */ 9 10#if NCURSES_MOUSE_VERSION > 1 11#define NCURSES_MOUSE_MASK(b,m) ((mmask_t)(m) << (((b) - 1) * 5)) 12#else 13#define NCURSES_MOUSE_MASK(b,m) ((mmask_t)(m) << (((b) - 1) * 6)) 14#endif 15 16#define NCURSES_BUTTON_RELEASED 001UL 17#define NCURSES_BUTTON_PRESSED 002UL 18#define NCURSES_BUTTON_CLICKED 004UL 19#define NCURSES_DOUBLE_CLICKED 010UL 20#define NCURSES_TRIPLE_CLICKED 020UL 21#define NCURSES_RESERVED_EVENT 040UL 22 23/* event masks */ 24#define BUTTON1_RELEASED NCURSES_MOUSE_MASK(1, NCURSES_BUTTON_RELEASED) 25#define BUTTON1_PRESSED NCURSES_MOUSE_MASK(1, NCURSES_BUTTON_PRESSED) 26#define BUTTON1_CLICKED NCURSES_MOUSE_MASK(1, NCURSES_BUTTON_CLICKED) 27#define BUTTON1_DOUBLE_CLICKED NCURSES_MOUSE_MASK(1, NCURSES_DOUBLE_CLICKED) 28#define BUTTON1_TRIPLE_CLICKED NCURSES_MOUSE_MASK(1, NCURSES_TRIPLE_CLICKED) 29 30#define BUTTON2_RELEASED NCURSES_MOUSE_MASK(2, NCURSES_BUTTON_RELEASED) 31#define BUTTON2_PRESSED NCURSES_MOUSE_MASK(2, NCURSES_BUTTON_PRESSED) 32#define BUTTON2_CLICKED NCURSES_MOUSE_MASK(2, NCURSES_BUTTON_CLICKED) 33#define BUTTON2_DOUBLE_CLICKED NCURSES_MOUSE_MASK(2, NCURSES_DOUBLE_CLICKED) 34#define BUTTON2_TRIPLE_CLICKED NCURSES_MOUSE_MASK(2, NCURSES_TRIPLE_CLICKED) 35 36#define BUTTON3_RELEASED NCURSES_MOUSE_MASK(3, NCURSES_BUTTON_RELEASED) 37#define BUTTON3_PRESSED NCURSES_MOUSE_MASK(3, NCURSES_BUTTON_PRESSED) 38#define BUTTON3_CLICKED NCURSES_MOUSE_MASK(3, NCURSES_BUTTON_CLICKED) 39#define BUTTON3_DOUBLE_CLICKED NCURSES_MOUSE_MASK(3, NCURSES_DOUBLE_CLICKED) 40#define BUTTON3_TRIPLE_CLICKED NCURSES_MOUSE_MASK(3, NCURSES_TRIPLE_CLICKED) 41 42#define BUTTON4_RELEASED NCURSES_MOUSE_MASK(4, NCURSES_BUTTON_RELEASED) 43#define BUTTON4_PRESSED NCURSES_MOUSE_MASK(4, NCURSES_BUTTON_PRESSED) 44#define BUTTON4_CLICKED NCURSES_MOUSE_MASK(4, NCURSES_BUTTON_CLICKED) 45#define BUTTON4_DOUBLE_CLICKED NCURSES_MOUSE_MASK(4, NCURSES_DOUBLE_CLICKED) 46#define BUTTON4_TRIPLE_CLICKED NCURSES_MOUSE_MASK(4, NCURSES_TRIPLE_CLICKED) 47 48/* 49 * In 32 bits the version-1 scheme does not provide enough space for a 5th 50 * button, unless we choose to change the ABI by omitting the reserved-events. 51 */ 52#if NCURSES_MOUSE_VERSION > 1 53 54#define BUTTON5_RELEASED NCURSES_MOUSE_MASK(5, NCURSES_BUTTON_RELEASED) 55#define BUTTON5_PRESSED NCURSES_MOUSE_MASK(5, NCURSES_BUTTON_PRESSED) 56#define BUTTON5_CLICKED NCURSES_MOUSE_MASK(5, NCURSES_BUTTON_CLICKED) 57#define BUTTON5_DOUBLE_CLICKED NCURSES_MOUSE_MASK(5, NCURSES_DOUBLE_CLICKED) 58#define BUTTON5_TRIPLE_CLICKED NCURSES_MOUSE_MASK(5, NCURSES_TRIPLE_CLICKED) 59 60#define BUTTON_CTRL NCURSES_MOUSE_MASK(6, 0001L) 61#define BUTTON_SHIFT NCURSES_MOUSE_MASK(6, 0002L) 62#define BUTTON_ALT NCURSES_MOUSE_MASK(6, 0004L) 63#define REPORT_MOUSE_POSITION NCURSES_MOUSE_MASK(6, 0010L) 64 65/* 66 * If mmask_T is 64-bits, we can define another 6 button stanzas, for a total 67 * of 11, which happens to be the maximum number supported in the X11 protocol. 68 */ 69#if NCURSES_MOUSE_VERSION > 2 70 71#define BUTTON6_RELEASED NCURSES_MOUSE_MASK(6, NCURSES_BUTTON_RELEASED) 72#define BUTTON6_PRESSED NCURSES_MOUSE_MASK(6, NCURSES_BUTTON_PRESSED) 73#define BUTTON6_CLICKED NCURSES_MOUSE_MASK(6, NCURSES_BUTTON_CLICKED) 74#define BUTTON6_DOUBLE_CLICKED NCURSES_MOUSE_MASK(6, NCURSES_DOUBLE_CLICKED) 75#define BUTTON6_TRIPLE_CLICKED NCURSES_MOUSE_MASK(6, NCURSES_TRIPLE_CLICKED) 76 77#define BUTTON7_RELEASED NCURSES_MOUSE_MASK(7, NCURSES_BUTTON_RELEASED) 78#define BUTTON7_PRESSED NCURSES_MOUSE_MASK(7, NCURSES_BUTTON_PRESSED) 79#define BUTTON7_CLICKED NCURSES_MOUSE_MASK(7, NCURSES_BUTTON_CLICKED) 80#define BUTTON7_DOUBLE_CLICKED NCURSES_MOUSE_MASK(7, NCURSES_DOUBLE_CLICKED) 81#define BUTTON7_TRIPLE_CLICKED NCURSES_MOUSE_MASK(7, NCURSES_TRIPLE_CLICKED) 82 83#define BUTTON8_RELEASED NCURSES_MOUSE_MASK(8, NCURSES_BUTTON_RELEASED) 84#define BUTTON8_PRESSED NCURSES_MOUSE_MASK(8, NCURSES_BUTTON_PRESSED) 85#define BUTTON8_CLICKED NCURSES_MOUSE_MASK(8, NCURSES_BUTTON_CLICKED) 86#define BUTTON8_DOUBLE_CLICKED NCURSES_MOUSE_MASK(8, NCURSES_DOUBLE_CLICKED) 87#define BUTTON8_TRIPLE_CLICKED NCURSES_MOUSE_MASK(8, NCURSES_TRIPLE_CLICKED) 88 89#define BUTTON9_RELEASED NCURSES_MOUSE_MASK(9, NCURSES_BUTTON_RELEASED) 90#define BUTTON9_PRESSED NCURSES_MOUSE_MASK(9, NCURSES_BUTTON_PRESSED) 91#define BUTTON9_CLICKED NCURSES_MOUSE_MASK(9, NCURSES_BUTTON_CLICKED) 92#define BUTTON9_DOUBLE_CLICKED NCURSES_MOUSE_MASK(9, NCURSES_DOUBLE_CLICKED) 93#define BUTTON9_TRIPLE_CLICKED NCURSES_MOUSE_MASK(9, NCURSES_TRIPLE_CLICKED) 94 95#define BUTTON10_RELEASED NCURSES_MOUSE_MASK(10, NCURSES_BUTTON_RELEASED) 96#define BUTTON10_PRESSED NCURSES_MOUSE_MASK(10, NCURSES_BUTTON_PRESSED) 97#define BUTTON10_CLICKED NCURSES_MOUSE_MASK(10, NCURSES_BUTTON_CLICKED) 98#define BUTTON10_DOUBLE_CLICKED NCURSES_MOUSE_MASK(10, NCURSES_DOUBLE_CLICKED) 99#define BUTTON10_TRIPLE_CLICKED NCURSES_MOUSE_MASK(10, NCURSES_TRIPLE_CLICKED) 100 101#define BUTTON11_RELEASED NCURSES_MOUSE_MASK(11, NCURSES_BUTTON_RELEASED) 102#define BUTTON11_PRESSED NCURSES_MOUSE_MASK(11, NCURSES_BUTTON_PRESSED) 103#define BUTTON11_CLICKED NCURSES_MOUSE_MASK(11, NCURSES_BUTTON_CLICKED) 104#define BUTTON11_DOUBLE_CLICKED NCURSES_MOUSE_MASK(11, NCURSES_DOUBLE_CLICKED) 105#define BUTTON11_TRIPLE_CLICKED NCURSES_MOUSE_MASK(11, NCURSES_TRIPLE_CLICKED) 106 107#endif 108 109#else /* NCURSES_MOUSE_VERSION == 1 */ 110 111#define BUTTON1_RESERVED_EVENT NCURSES_MOUSE_MASK(1, NCURSES_RESERVED_EVENT) 112#define BUTTON2_RESERVED_EVENT NCURSES_MOUSE_MASK(2, NCURSES_RESERVED_EVENT) 113#define BUTTON3_RESERVED_EVENT NCURSES_MOUSE_MASK(3, NCURSES_RESERVED_EVENT) 114#define BUTTON4_RESERVED_EVENT NCURSES_MOUSE_MASK(4, NCURSES_RESERVED_EVENT) 115 116#define BUTTON_CTRL NCURSES_MOUSE_MASK(5, 0001L) 117#define BUTTON_SHIFT NCURSES_MOUSE_MASK(5, 0002L) 118#define BUTTON_ALT NCURSES_MOUSE_MASK(5, 0004L) 119#define REPORT_MOUSE_POSITION NCURSES_MOUSE_MASK(5, 0010L) 120 121#endif /* NCURSES_MOUSE_VERSION >= 1 */ 122 123#define ALL_MOUSE_EVENTS (REPORT_MOUSE_POSITION - 1) 124 125/* macros to extract single event-bits from masks */ 126#define BUTTON_RELEASE(e, x) ((e) & NCURSES_MOUSE_MASK(x, 001)) 127#define BUTTON_PRESS(e, x) ((e) & NCURSES_MOUSE_MASK(x, 002)) 128#define BUTTON_CLICK(e, x) ((e) & NCURSES_MOUSE_MASK(x, 004)) 129#define BUTTON_DOUBLE_CLICK(e, x) ((e) & NCURSES_MOUSE_MASK(x, 010)) 130#define BUTTON_TRIPLE_CLICK(e, x) ((e) & NCURSES_MOUSE_MASK(x, 020)) 131#define BUTTON_RESERVED_EVENT(e, x) ((e) & NCURSES_MOUSE_MASK(x, 040)) 132 133typedef struct 134{ 135 short id; /* ID to distinguish multiple devices */ 136 int x, y, z; /* event coordinates (character-cell) */ 137 mmask_t bstate; /* button state bits */ 138} 139MEVENT; 140 141extern NCURSES_EXPORT(bool) has_mouse(void); 142extern NCURSES_EXPORT(int) getmouse (MEVENT *); 143extern NCURSES_EXPORT(int) ungetmouse (MEVENT *); 144extern NCURSES_EXPORT(mmask_t) mousemask (mmask_t, mmask_t *); 145extern NCURSES_EXPORT(bool) wenclose (const WINDOW *, int, int); 146extern NCURSES_EXPORT(int) mouseinterval (int); 147extern NCURSES_EXPORT(bool) wmouse_trafo (const WINDOW*, int*, int*, bool); 148extern NCURSES_EXPORT(bool) mouse_trafo (int*, int*, bool); /* generated */ 149 150#if NCURSES_SP_FUNCS 151extern NCURSES_EXPORT(bool) NCURSES_SP_NAME(has_mouse) (SCREEN*); 152extern NCURSES_EXPORT(int) NCURSES_SP_NAME(getmouse) (SCREEN*, MEVENT *); 153extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ungetmouse) (SCREEN*,MEVENT *); 154extern NCURSES_EXPORT(mmask_t) NCURSES_SP_NAME(mousemask) (SCREEN*, mmask_t, mmask_t *); 155extern NCURSES_EXPORT(int) NCURSES_SP_NAME(mouseinterval) (SCREEN*, int); 156#endif 157 158#ifndef NCURSES_NOMACROS 159#define mouse_trafo(y,x,to_screen) wmouse_trafo(stdscr,y,x,to_screen) 160#endif 161 162/* other non-XSI functions */ 163 164extern NCURSES_EXPORT(int) mcprint (char *, int); /* direct data to printer */ 165extern NCURSES_EXPORT(int) has_key (int); /* do we have given key? */ 166 167#if NCURSES_SP_FUNCS 168extern NCURSES_EXPORT(int) NCURSES_SP_NAME(has_key) (SCREEN*, int); /* do we have given key? */ 169extern NCURSES_EXPORT(int) NCURSES_SP_NAME(mcprint) (SCREEN*, char *, int); /* direct data to printer */ 170#endif 171 172/* Debugging : use with libncurses_g.a */ 173 174extern NCURSES_EXPORT(void) _tracef (const char *, ...) GCC_PRINTFLIKE(1,2); 175extern NCURSES_EXPORT(char *) _traceattr (attr_t); 176extern NCURSES_EXPORT(char *) _traceattr2 (int, chtype); 177extern NCURSES_EXPORT(char *) _tracechar (int); 178extern NCURSES_EXPORT(char *) _tracechtype (chtype); 179extern NCURSES_EXPORT(char *) _tracechtype2 (int, chtype); 180#if NCURSES_WIDECHAR 181#define _tracech_t _tracecchar_t 182extern NCURSES_EXPORT(char *) _tracecchar_t (const cchar_t *); 183#define _tracech_t2 _tracecchar_t2 184extern NCURSES_EXPORT(char *) _tracecchar_t2 (int, const cchar_t *); 185#else 186#define _tracech_t _tracechtype 187#define _tracech_t2 _tracechtype2 188#endif 189extern NCURSES_EXPORT(void) trace (const unsigned) GCC_DEPRECATED("use curses_trace"); 190extern NCURSES_EXPORT(unsigned) curses_trace (const unsigned); 191 192/* trace masks */ 193#define TRACE_DISABLE 0x0000 /* turn off tracing */ 194#define TRACE_TIMES 0x0001 /* trace user and system times of updates */ 195#define TRACE_TPUTS 0x0002 /* trace tputs calls */ 196#define TRACE_UPDATE 0x0004 /* trace update actions, old & new screens */ 197#define TRACE_MOVE 0x0008 /* trace cursor moves and scrolls */ 198#define TRACE_CHARPUT 0x0010 /* trace all character outputs */ 199#define TRACE_ORDINARY 0x001F /* trace all update actions */ 200#define TRACE_CALLS 0x0020 /* trace all curses calls */ 201#define TRACE_VIRTPUT 0x0040 /* trace virtual character puts */ 202#define TRACE_IEVENT 0x0080 /* trace low-level input processing */ 203#define TRACE_BITS 0x0100 /* trace state of TTY control bits */ 204#define TRACE_ICALLS 0x0200 /* trace internal/nested calls */ 205#define TRACE_CCALLS 0x0400 /* trace per-character calls */ 206#define TRACE_DATABASE 0x0800 /* trace read/write of terminfo/termcap data */ 207#define TRACE_ATTRS 0x1000 /* trace attribute updates */ 208 209#define TRACE_SHIFT 13 /* number of bits in the trace masks */ 210#define TRACE_MAXIMUM ((1 << TRACE_SHIFT) - 1) /* maximum trace level */ 211 212#if defined(TRACE) || defined(NCURSES_TEST) 213extern NCURSES_EXPORT_VAR(int) _nc_optimize_enable; /* enable optimizations */ 214extern NCURSES_EXPORT(const char *) _nc_visbuf (const char *); 215#define OPTIMIZE_MVCUR 0x01 /* cursor movement optimization */ 216#define OPTIMIZE_HASHMAP 0x02 /* diff hashing to detect scrolls */ 217#define OPTIMIZE_SCROLL 0x04 /* scroll optimization */ 218#define OPTIMIZE_ALL 0xff /* enable all optimizations (dflt) */ 219#endif 220 221extern GCC_NORETURN NCURSES_EXPORT(void) exit_curses (int); 222 223#include <unctrl.h> 224 225#ifdef __cplusplus 226 227#ifndef NCURSES_NOMACROS 228 229/* these names conflict with STL */ 230#undef box 231#undef clear 232#undef erase 233#undef move 234#undef refresh 235 236#endif /* NCURSES_NOMACROS */ 237 238} 239#endif 240 241#endif /* __NCURSES_H */ 242