.config/coc/extensions/node_modules/coc-pyright/node_modules/pyright/dist/typeshed-fallback/stdlib/_curses.pyi

   1 import sys
   2 from typing import IO, Any, BinaryIO, NamedTuple, Union, overload
   3
   4 _chtype = Union[str, bytes, int]
   5
   6 # ACS codes are only initialized after initscr is called
   7 ACS_BBSS: int
   8 ACS_BLOCK: int
   9 ACS_BOARD: int
  10 ACS_BSBS: int
  11 ACS_BSSB: int
  12 ACS_BSSS: int
  13 ACS_BTEE: int
  14 ACS_BULLET: int
  15 ACS_CKBOARD: int
  16 ACS_DARROW: int
  17 ACS_DEGREE: int
  18 ACS_DIAMOND: int
  19 ACS_GEQUAL: int
  20 ACS_HLINE: int
  21 ACS_LANTERN: int
  22 ACS_LARROW: int
  23 ACS_LEQUAL: int
  24 ACS_LLCORNER: int
  25 ACS_LRCORNER: int
  26 ACS_LTEE: int
  27 ACS_NEQUAL: int
  28 ACS_PI: int
  29 ACS_PLMINUS: int
  30 ACS_PLUS: int
  31 ACS_RARROW: int
  32 ACS_RTEE: int
  33 ACS_S1: int
  34 ACS_S3: int
  35 ACS_S7: int
  36 ACS_S9: int
  37 ACS_SBBS: int
  38 ACS_SBSB: int
  39 ACS_SBSS: int
  40 ACS_SSBB: int
  41 ACS_SSBS: int
  42 ACS_SSSB: int
  43 ACS_SSSS: int
  44 ACS_STERLING: int
  45 ACS_TTEE: int
  46 ACS_UARROW: int
  47 ACS_ULCORNER: int
  48 ACS_URCORNER: int
  49 ACS_VLINE: int
  50 ALL_MOUSE_EVENTS: int
  51 A_ALTCHARSET: int
  52 A_ATTRIBUTES: int
  53 A_BLINK: int
  54 A_BOLD: int
  55 A_CHARTEXT: int
  56 A_COLOR: int
  57 A_DIM: int
  58 A_HORIZONTAL: int
  59 A_INVIS: int
  60 if sys.version_info >= (3, 7):
  61     A_ITALIC: int
  62 A_LEFT: int
  63 A_LOW: int
  64 A_NORMAL: int
  65 A_PROTECT: int
  66 A_REVERSE: int
  67 A_RIGHT: int
  68 A_STANDOUT: int
  69 A_TOP: int
  70 A_UNDERLINE: int
  71 A_VERTICAL: int
  72 BUTTON1_CLICKED: int
  73 BUTTON1_DOUBLE_CLICKED: int
  74 BUTTON1_PRESSED: int
  75 BUTTON1_RELEASED: int
  76 BUTTON1_TRIPLE_CLICKED: int
  77 BUTTON2_CLICKED: int
  78 BUTTON2_DOUBLE_CLICKED: int
  79 BUTTON2_PRESSED: int
  80 BUTTON2_RELEASED: int
  81 BUTTON2_TRIPLE_CLICKED: int
  82 BUTTON3_CLICKED: int
  83 BUTTON3_DOUBLE_CLICKED: int
  84 BUTTON3_PRESSED: int
  85 BUTTON3_RELEASED: int
  86 BUTTON3_TRIPLE_CLICKED: int
  87 BUTTON4_CLICKED: int
  88 BUTTON4_DOUBLE_CLICKED: int
  89 BUTTON4_PRESSED: int
  90 BUTTON4_RELEASED: int
  91 BUTTON4_TRIPLE_CLICKED: int
  92 # Darwin ncurses doesn't provide BUTTON5_* constants
  93 if sys.version_info >= (3, 10) and sys.platform != "darwin":
  94     BUTTON5_PRESSED: int
  95     BUTTON5_RELEASED: int
  96     BUTTON5_CLICKED: int
  97     BUTTON5_DOUBLE_CLICKED: int
  98     BUTTON5_TRIPLE_CLICKED: int
  99 BUTTON_ALT: int
 100 BUTTON_CTRL: int
 101 BUTTON_SHIFT: int
 102 COLOR_BLACK: int
 103 COLOR_BLUE: int
 104 COLOR_CYAN: int
 105 COLOR_GREEN: int
 106 COLOR_MAGENTA: int
 107 COLOR_RED: int
 108 COLOR_WHITE: int
 109 COLOR_YELLOW: int
 110 ERR: int
 111 KEY_A1: int
 112 KEY_A3: int
 113 KEY_B2: int
 114 KEY_BACKSPACE: int
 115 KEY_BEG: int
 116 KEY_BREAK: int
 117 KEY_BTAB: int
 118 KEY_C1: int
 119 KEY_C3: int
 120 KEY_CANCEL: int
 121 KEY_CATAB: int
 122 KEY_CLEAR: int
 123 KEY_CLOSE: int
 124 KEY_COMMAND: int
 125 KEY_COPY: int
 126 KEY_CREATE: int
 127 KEY_CTAB: int
 128 KEY_DC: int
 129 KEY_DL: int
 130 KEY_DOWN: int
 131 KEY_EIC: int
 132 KEY_END: int
 133 KEY_ENTER: int
 134 KEY_EOL: int
 135 KEY_EOS: int
 136 KEY_EXIT: int
 137 KEY_F0: int
 138 KEY_F1: int
 139 KEY_F10: int
 140 KEY_F11: int
 141 KEY_F12: int
 142 KEY_F13: int
 143 KEY_F14: int
 144 KEY_F15: int
 145 KEY_F16: int
 146 KEY_F17: int
 147 KEY_F18: int
 148 KEY_F19: int
 149 KEY_F2: int
 150 KEY_F20: int
 151 KEY_F21: int
 152 KEY_F22: int
 153 KEY_F23: int
 154 KEY_F24: int
 155 KEY_F25: int
 156 KEY_F26: int
 157 KEY_F27: int
 158 KEY_F28: int
 159 KEY_F29: int
 160 KEY_F3: int
 161 KEY_F30: int
 162 KEY_F31: int
 163 KEY_F32: int
 164 KEY_F33: int
 165 KEY_F34: int
 166 KEY_F35: int
 167 KEY_F36: int
 168 KEY_F37: int
 169 KEY_F38: int
 170 KEY_F39: int
 171 KEY_F4: int
 172 KEY_F40: int
 173 KEY_F41: int
 174 KEY_F42: int
 175 KEY_F43: int
 176 KEY_F44: int
 177 KEY_F45: int
 178 KEY_F46: int
 179 KEY_F47: int
 180 KEY_F48: int
 181 KEY_F49: int
 182 KEY_F5: int
 183 KEY_F50: int
 184 KEY_F51: int
 185 KEY_F52: int
 186 KEY_F53: int
 187 KEY_F54: int
 188 KEY_F55: int
 189 KEY_F56: int
 190 KEY_F57: int
 191 KEY_F58: int
 192 KEY_F59: int
 193 KEY_F6: int
 194 KEY_F60: int
 195 KEY_F61: int
 196 KEY_F62: int
 197 KEY_F63: int
 198 KEY_F7: int
 199 KEY_F8: int
 200 KEY_F9: int
 201 KEY_FIND: int
 202 KEY_HELP: int
 203 KEY_HOME: int
 204 KEY_IC: int
 205 KEY_IL: int
 206 KEY_LEFT: int
 207 KEY_LL: int
 208 KEY_MARK: int
 209 KEY_MAX: int
 210 KEY_MESSAGE: int
 211 KEY_MIN: int
 212 KEY_MOUSE: int
 213 KEY_MOVE: int
 214 KEY_NEXT: int
 215 KEY_NPAGE: int
 216 KEY_OPEN: int
 217 KEY_OPTIONS: int
 218 KEY_PPAGE: int
 219 KEY_PREVIOUS: int
 220 KEY_PRINT: int
 221 KEY_REDO: int
 222 KEY_REFERENCE: int
 223 KEY_REFRESH: int
 224 KEY_REPLACE: int
 225 KEY_RESET: int
 226 KEY_RESIZE: int
 227 KEY_RESTART: int
 228 KEY_RESUME: int
 229 KEY_RIGHT: int
 230 KEY_SAVE: int
 231 KEY_SBEG: int
 232 KEY_SCANCEL: int
 233 KEY_SCOMMAND: int
 234 KEY_SCOPY: int
 235 KEY_SCREATE: int
 236 KEY_SDC: int
 237 KEY_SDL: int
 238 KEY_SELECT: int
 239 KEY_SEND: int
 240 KEY_SEOL: int
 241 KEY_SEXIT: int
 242 KEY_SF: int
 243 KEY_SFIND: int
 244 KEY_SHELP: int
 245 KEY_SHOME: int
 246 KEY_SIC: int
 247 KEY_SLEFT: int
 248 KEY_SMESSAGE: int
 249 KEY_SMOVE: int
 250 KEY_SNEXT: int
 251 KEY_SOPTIONS: int
 252 KEY_SPREVIOUS: int
 253 KEY_SPRINT: int
 254 KEY_SR: int
 255 KEY_SREDO: int
 256 KEY_SREPLACE: int
 257 KEY_SRESET: int
 258 KEY_SRIGHT: int
 259 KEY_SRSUME: int
 260 KEY_SSAVE: int
 261 KEY_SSUSPEND: int
 262 KEY_STAB: int
 263 KEY_SUNDO: int
 264 KEY_SUSPEND: int
 265 KEY_UNDO: int
 266 KEY_UP: int
 267 OK: int
 268 REPORT_MOUSE_POSITION: int
 269 _C_API: Any
 270 version: bytes
 271
 272 def baudrate() -> int: ...
 273 def beep() -> None: ...
 274 def can_change_color() -> bool: ...
 275 def cbreak(__flag: bool = ...) -> None: ...
 276 def color_content(__color_number: int) -> tuple[int, int, int]: ...
 277
 278 # Changed in Python 3.8.8 and 3.9.2
 279 if sys.version_info >= (3, 8):
 280     def color_pair(pair_number: int) -> int: ...
 281
 282 else:
 283     def color_pair(__color_number: int) -> int: ...
 284
 285 def curs_set(__visibility: int) -> int: ...
 286 def def_prog_mode() -> None: ...
 287 def def_shell_mode() -> None: ...
 288 def delay_output(__ms: int) -> None: ...
 289 def doupdate() -> None: ...
 290 def echo(__flag: bool = ...) -> None: ...
 291 def endwin() -> None: ...
 292 def erasechar() -> bytes: ...
 293 def filter() -> None: ...
 294 def flash() -> None: ...
 295 def flushinp() -> None: ...
 296 def getmouse() -> tuple[int, int, int, int, int]: ...
 297 def getsyx() -> tuple[int, int]: ...
 298 def getwin(__file: BinaryIO) -> _CursesWindow: ...
 299 def halfdelay(__tenths: int) -> None: ...
 300 def has_colors() -> bool: ...
 301
 302 if sys.version_info >= (3, 10):
 303     def has_extended_color_support() -> bool: ...
 304
 305 def has_ic() -> bool: ...
 306 def has_il() -> bool: ...
 307 def has_key(__key: int) -> bool: ...
 308 def init_color(__color_number: int, __r: int, __g: int, __b: int) -> None: ...
 309 def init_pair(__pair_number: int, __fg: int, __bg: int) -> None: ...
 310 def initscr() -> _CursesWindow: ...
 311 def intrflush(__flag: bool) -> None: ...
 312 def is_term_resized(__nlines: int, __ncols: int) -> bool: ...
 313 def isendwin() -> bool: ...
 314 def keyname(__key: int) -> bytes: ...
 315 def killchar() -> bytes: ...
 316 def longname() -> bytes: ...
 317 def meta(__yes: bool) -> None: ...
 318 def mouseinterval(__interval: int) -> None: ...
 319 def mousemask(__newmask: int) -> tuple[int, int]: ...
 320 def napms(__ms: int) -> int: ...
 321 def newpad(__nlines: int, __ncols: int) -> _CursesWindow: ...
 322 def newwin(__nlines: int, __ncols: int, __begin_y: int = ..., __begin_x: int = ...) -> _CursesWindow: ...
 323 def nl(__flag: bool = ...) -> None: ...
 324 def nocbreak() -> None: ...
 325 def noecho() -> None: ...
 326 def nonl() -> None: ...
 327 def noqiflush() -> None: ...
 328 def noraw() -> None: ...
 329 def pair_content(__pair_number: int) -> tuple[int, int]: ...
 330 def pair_number(__attr: int) -> int: ...
 331 def putp(__string: bytes) -> None: ...
 332 def qiflush(__flag: bool = ...) -> None: ...
 333 def raw(__flag: bool = ...) -> None: ...
 334 def reset_prog_mode() -> None: ...
 335 def reset_shell_mode() -> None: ...
 336 def resetty() -> None: ...
 337 def resize_term(__nlines: int, __ncols: int) -> None: ...
 338 def resizeterm(__nlines: int, __ncols: int) -> None: ...
 339 def savetty() -> None: ...
 340 def setsyx(__y: int, __x: int) -> None: ...
 341 def setupterm(term: str | None = ..., fd: int = ...) -> None: ...
 342 def start_color() -> None: ...
 343 def termattrs() -> int: ...
 344 def termname() -> bytes: ...
 345 def tigetflag(__capname: str) -> int: ...
 346 def tigetnum(__capname: str) -> int: ...
 347 def tigetstr(__capname: str) -> bytes: ...
 348 def tparm(
 349     __str: bytes,
 350     __i1: int = ...,
 351     __i2: int = ...,
 352     __i3: int = ...,
 353     __i4: int = ...,
 354     __i5: int = ...,
 355     __i6: int = ...,
 356     __i7: int = ...,
 357     __i8: int = ...,
 358     __i9: int = ...,
 359 ) -> bytes: ...
 360 def typeahead(__fd: int) -> None: ...
 361 def unctrl(__ch: _chtype) -> bytes: ...
 362 def unget_wch(__ch: int | str) -> None: ...
 363 def ungetch(__ch: _chtype) -> None: ...
 364 def ungetmouse(__id: int, __x: int, __y: int, __z: int, __bstate: int) -> None: ...
 365 def update_lines_cols() -> int: ...
 366 def use_default_colors() -> None: ...
 367 def use_env(__flag: bool) -> None: ...
 368
 369 class error(Exception): ...
 370
 371 class _CursesWindow:
 372     encoding: str
 373     @overload
 374     def addch(self, ch: _chtype, attr: int = ...) -> None: ...
 375     @overload
 376     def addch(self, y: int, x: int, ch: _chtype, attr: int = ...) -> None: ...
 377     @overload
 378     def addnstr(self, str: str, n: int, attr: int = ...) -> None: ...
 379     @overload
 380     def addnstr(self, y: int, x: int, str: str, n: int, attr: int = ...) -> None: ...
 381     @overload
 382     def addstr(self, str: str, attr: int = ...) -> None: ...
 383     @overload
 384     def addstr(self, y: int, x: int, str: str, attr: int = ...) -> None: ...
 385     def attroff(self, __attr: int) -> None: ...
 386     def attron(self, __attr: int) -> None: ...
 387     def attrset(self, __attr: int) -> None: ...
 388     def bkgd(self, __ch: _chtype, __attr: int = ...) -> None: ...
 389     def bkgdset(self, __ch: _chtype, __attr: int = ...) -> None: ...
 390     def border(
 391         self,
 392         ls: _chtype = ...,
 393         rs: _chtype = ...,
 394         ts: _chtype = ...,
 395         bs: _chtype = ...,
 396         tl: _chtype = ...,
 397         tr: _chtype = ...,
 398         bl: _chtype = ...,
 399         br: _chtype = ...,
 400     ) -> None: ...
 401     @overload
 402     def box(self) -> None: ...
 403     @overload
 404     def box(self, vertch: _chtype = ..., horch: _chtype = ...) -> None: ...
 405     @overload
 406     def chgat(self, attr: int) -> None: ...
 407     @overload
 408     def chgat(self, num: int, attr: int) -> None: ...
 409     @overload
 410     def chgat(self, y: int, x: int, attr: int) -> None: ...
 411     @overload
 412     def chgat(self, y: int, x: int, num: int, attr: int) -> None: ...
 413     def clear(self) -> None: ...
 414     def clearok(self, yes: int) -> None: ...
 415     def clrtobot(self) -> None: ...
 416     def clrtoeol(self) -> None: ...
 417     def cursyncup(self) -> None: ...
 418     @overload
 419     def delch(self) -> None: ...
 420     @overload
 421     def delch(self, y: int, x: int) -> None: ...
 422     def deleteln(self) -> None: ...
 423     @overload
 424     def derwin(self, begin_y: int, begin_x: int) -> _CursesWindow: ...
 425     @overload
 426     def derwin(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> _CursesWindow: ...
 427     def echochar(self, __ch: _chtype, __attr: int = ...) -> None: ...
 428     def enclose(self, __y: int, __x: int) -> bool: ...
 429     def erase(self) -> None: ...
 430     def getbegyx(self) -> tuple[int, int]: ...
 431     def getbkgd(self) -> tuple[int, int]: ...
 432     @overload
 433     def getch(self) -> int: ...
 434     @overload
 435     def getch(self, y: int, x: int) -> int: ...
 436     @overload
 437     def get_wch(self) -> int | str: ...
 438     @overload
 439     def get_wch(self, y: int, x: int) -> int | str: ...
 440     @overload
 441     def getkey(self) -> str: ...
 442     @overload
 443     def getkey(self, y: int, x: int) -> str: ...
 444     def getmaxyx(self) -> tuple[int, int]: ...
 445     def getparyx(self) -> tuple[int, int]: ...
 446     @overload
 447     def getstr(self) -> _chtype: ...
 448     @overload
 449     def getstr(self, n: int) -> _chtype: ...
 450     @overload
 451     def getstr(self, y: int, x: int) -> _chtype: ...
 452     @overload
 453     def getstr(self, y: int, x: int, n: int) -> _chtype: ...
 454     def getyx(self) -> tuple[int, int]: ...
 455     @overload
 456     def hline(self, ch: _chtype, n: int) -> None: ...
 457     @overload
 458     def hline(self, y: int, x: int, ch: _chtype, n: int) -> None: ...
 459     def idcok(self, flag: bool) -> None: ...
 460     def idlok(self, yes: bool) -> None: ...
 461     def immedok(self, flag: bool) -> None: ...
 462     @overload
 463     def inch(self) -> _chtype: ...
 464     @overload
 465     def inch(self, y: int, x: int) -> _chtype: ...
 466     @overload
 467     def insch(self, ch: _chtype, attr: int = ...) -> None: ...
 468     @overload
 469     def insch(self, y: int, x: int, ch: _chtype, attr: int = ...) -> None: ...
 470     def insdelln(self, nlines: int) -> None: ...
 471     def insertln(self) -> None: ...
 472     @overload
 473     def insnstr(self, str: str, n: int, attr: int = ...) -> None: ...
 474     @overload
 475     def insnstr(self, y: int, x: int, str: str, n: int, attr: int = ...) -> None: ...
 476     @overload
 477     def insstr(self, str: str, attr: int = ...) -> None: ...
 478     @overload
 479     def insstr(self, y: int, x: int, str: str, attr: int = ...) -> None: ...
 480     @overload
 481     def instr(self, n: int = ...) -> _chtype: ...
 482     @overload
 483     def instr(self, y: int, x: int, n: int = ...) -> _chtype: ...
 484     def is_linetouched(self, __line: int) -> bool: ...
 485     def is_wintouched(self) -> bool: ...
 486     def keypad(self, yes: bool) -> None: ...
 487     def leaveok(self, yes: bool) -> None: ...
 488     def move(self, new_y: int, new_x: int) -> None: ...
 489     def mvderwin(self, y: int, x: int) -> None: ...
 490     def mvwin(self, new_y: int, new_x: int) -> None: ...
 491     def nodelay(self, yes: bool) -> None: ...
 492     def notimeout(self, yes: bool) -> None: ...
 493     @overload
 494     def noutrefresh(self) -> None: ...
 495     @overload
 496     def noutrefresh(self, pminrow: int, pmincol: int, sminrow: int, smincol: int, smaxrow: int, smaxcol: int) -> None: ...
 497     @overload
 498     def overlay(self, destwin: _CursesWindow) -> None: ...
 499     @overload
 500     def overlay(
 501         self, destwin: _CursesWindow, sminrow: int, smincol: int, dminrow: int, dmincol: int, dmaxrow: int, dmaxcol: int
 502     ) -> None: ...
 503     @overload
 504     def overwrite(self, destwin: _CursesWindow) -> None: ...
 505     @overload
 506     def overwrite(
 507         self, destwin: _CursesWindow, sminrow: int, smincol: int, dminrow: int, dmincol: int, dmaxrow: int, dmaxcol: int
 508     ) -> None: ...
 509     def putwin(self, __file: IO[Any]) -> None: ...
 510     def redrawln(self, __beg: int, __num: int) -> None: ...
 511     def redrawwin(self) -> None: ...
 512     @overload
 513     def refresh(self) -> None: ...
 514     @overload
 515     def refresh(self, pminrow: int, pmincol: int, sminrow: int, smincol: int, smaxrow: int, smaxcol: int) -> None: ...
 516     def resize(self, nlines: int, ncols: int) -> None: ...
 517     def scroll(self, lines: int = ...) -> None: ...
 518     def scrollok(self, flag: bool) -> None: ...
 519     def setscrreg(self, __top: int, __bottom: int) -> None: ...
 520     def standend(self) -> None: ...
 521     def standout(self) -> None: ...
 522     @overload
 523     def subpad(self, begin_y: int, begin_x: int) -> _CursesWindow: ...
 524     @overload
 525     def subpad(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> _CursesWindow: ...
 526     @overload
 527     def subwin(self, begin_y: int, begin_x: int) -> _CursesWindow: ...
 528     @overload
 529     def subwin(self, nlines: int, ncols: int, begin_y: int, begin_x: int) -> _CursesWindow: ...
 530     def syncdown(self) -> None: ...
 531     def syncok(self, flag: bool) -> None: ...
 532     def syncup(self) -> None: ...
 533     def timeout(self, delay: int) -> None: ...
 534     def touchline(self, start: int, count: int, changed: bool = ...) -> None: ...
 535     def touchwin(self) -> None: ...
 536     def untouchwin(self) -> None: ...
 537     @overload
 538     def vline(self, ch: _chtype, n: int) -> None: ...
 539     @overload
 540     def vline(self, y: int, x: int, ch: _chtype, n: int) -> None: ...
 541
 542 if sys.version_info >= (3, 8):
 543     class _ncurses_version(NamedTuple):
 544         major: int
 545         minor: int
 546         patch: int
 547     ncurses_version: _ncurses_version
 548     window = _CursesWindow  # undocumented