Added scrolling
[dosdemo] / src / dos / keyb.h
1 /*
2 DOS interrupt-based keyboard driver.
3 Copyright (C) 2013  John Tsiombikas <nuclear@member.fsf.org>
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License  for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with the program. If not, see <http://www.gnu.org/licenses/>
17 */
18 #ifndef KEYB_H_
19 #define KEYB_H_
20
21 #define KB_ANY          (-1)
22 #define KB_ALT          (-2)
23 #define KB_CTRL         (-3)
24 #define KB_SHIFT        (-4)
25
26 /* special keys */
27 enum {
28         KB_LALT, KB_RALT,
29         KB_LCTRL, KB_RCTRL,
30         KB_LSHIFT, KB_RSHIFT,
31         KB_F1, KB_F2, KB_F3, KB_F4, KB_F5, KB_F6,
32         KB_F7, KB_F8, KB_F9, KB_F10, KB_F11, KB_F12,
33         KB_CAPSLK, KB_NUMLK, KB_SCRLK, KB_SYSRQ,
34         KB_ESC = 27,
35         KB_INSERT, KB_DEL, KB_HOME, KB_END, KB_PGUP, KB_PGDN,
36         KB_LEFT, KB_RIGHT, KB_UP, KB_DOWN,
37         KB_NUM_DOT, KB_NUM_ENTER, KB_NUM_PLUS, KB_NUM_MINUS, KB_NUM_MUL, KB_NUM_DIV,
38         KB_NUM_0, KB_NUM_1, KB_NUM_2, KB_NUM_3, KB_NUM_4,
39         KB_NUM_5, KB_NUM_6, KB_NUM_7, KB_NUM_8, KB_NUM_9,
40         KB_BACKSP = 127
41 };
42
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 int kb_init(int bufsz); /* bufsz can be 0 for no buffered keys */
49 void kb_shutdown(void); /* don't forget to call this at the end! */
50
51 /* Boolean predicate for testing the current state of a particular key.
52  * You may also pass KB_ANY to test if any key is held down.
53  */
54 int kb_isdown(int key);
55
56 /* waits for any keypress */
57 void kb_wait(void);
58
59 /* removes and returns a single key from the input buffer.
60  * If buffering is disabled (initialized with kb_init(0)), then it always
61  * returns the last key pressed.
62  */
63 int kb_getkey(void);
64
65 void kb_putback(int key);
66
67 #ifdef __cplusplus
68 }
69 #endif
70
71 #endif  /* KEYB_H_ */