-
Notifications
You must be signed in to change notification settings - Fork 1
/
console_win.h
89 lines (74 loc) · 2.39 KB
/
console_win.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
#pragma once
#include <stdbool.h>
#define CONSOLE_WIN_X 0
#define CONSOLE_WIN_Y 10
#define CONSOLE_WIN_W 80
#define CONSOLE_WIN_H 15
/**
* Console printf.
*
* This is functionally equivilant to standard printf (see https://en.cppreference.com/w/c/io/fprintf)
*/
void console_printf(const char* fmt, ...);
/**
* Read a character from the console.
*
* This may return early if a critical error occurs (e.g. the reactor blows up), in which
* case `ERR` is returned.
*
* @return single char or `ERR`. */
char console_read_chr(void);
/**
* Reads a string from the console (no size limit).
*
* This may return early if a critical error occurs (e.g. the reactor blows up), in which
* case false is returned.
*
* @param[out] out Location to store string.
* @return success. */
bool console_read_str(char* out);
/**
* Reads a string of at most size `max_len` from the console.
*
* This may return early if a critical error occurs (e.g. the reactor blows up), in which
* case false is returned.
*
* @param[out] out Location to store string.
* @param max_len Max length string that should be read.
* @return success. */
bool console_read_strn(char* out, int max_len);
/**
* Wait/Block until the user enters any key into the console.
*
* This may return early if a critical error occurs (e.g. the reactor blows up). */
void console_wait_until_press(void);
/** Clear the console. */
void console_clear(void);
/**
* Interrupt console interrupt.
*
* If another thread is currently being blocked by console input,
* this will cause it to return early. If another thread is not currently
* being blocked by console input, the next input function will return
* immediately with an error.
*
* This is called within reactor upon a critical error.
*/
void console_interrupt(void);
/**
* Clear console interrupt.
*
* If `console_interrupt` has been called but no input function has been
* called, this will cause the next input function called to *not* return
* immediately.
*/
void console_clear_interrupt(void);
/**************************************************************
* Don't worry about anything below here :) *
**************************************************************/
/** Init the console. */
void console_init(void);
/** Finalize the console. */
void console_end(void);
/** Reset the visible cursor back to the console. */
void console_refresh_cursor(void);