doskeyb

annotate keyb.h @ 0:c2b210a70ce9

initial DOS keyboard driver commit
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 23 Sep 2013 03:42:39 +0300
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 DOS interrupt-based keyboard driver.
nuclear@0 3 Copyright (C) 2013 John Tsiombikas <nuclear@member.fsf.org>
nuclear@0 4
nuclear@0 5 This program is free software: you can redistribute it and/or modify
nuclear@0 6 it under the terms of the GNU General Public License as published by
nuclear@0 7 the Free Software Foundation, either version 3 of the License, or
nuclear@0 8 (at your option) any later version.
nuclear@0 9
nuclear@0 10 This program is distributed in the hope that it will be useful,
nuclear@0 11 but WITHOUT ANY WARRANTY; without even the implied warranty of
nuclear@0 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nuclear@0 13 GNU General Public License for more details.
nuclear@0 14
nuclear@0 15 You should have received a copy of the GNU General Public License
nuclear@0 16 along with the program. If not, see <http://www.gnu.org/licenses/>
nuclear@0 17 */
nuclear@0 18 #ifndef KEYB_H_
nuclear@0 19 #define KEYB_H_
nuclear@0 20
nuclear@0 21 #define KB_ANY (-1)
nuclear@0 22
nuclear@0 23 int kb_init(int bufsz); /* bufsz can be 0 for no buffered keys */
nuclear@0 24 void kb_shutdown(void); /* don't forget to call this at the end! */
nuclear@0 25
nuclear@0 26 /* Boolean predicate for testing the current state of a particular key.
nuclear@0 27 * You may also pass KB_ANY to test if any key is held down.
nuclear@0 28 */
nuclear@0 29 int kb_isdown(int key);
nuclear@0 30
nuclear@0 31 /* waits for any keypress */
nuclear@0 32 void kb_wait(void);
nuclear@0 33
nuclear@0 34 /* removes and returns a signle key from the input buffer.
nuclear@0 35 * If buffering is disabled (initialized with kb_init(0)), then it always
nuclear@0 36 * returns the last key pressed.
nuclear@0 37 */
nuclear@0 38 int kb_getkey(void);
nuclear@0 39
nuclear@0 40 #endif /* KEYB_H_ */