WebSVN – HelenOS – Diff – /branches/network/uspace/lib/libc/include/io/console.h


/*
 * Copyright (c) 2008 Jiri Svoboda
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup libc
 * @{
 */
/** @file
 */
 
#ifndef LIBC_IO_CONSOLE_H_
#define LIBC_IO_CONSOLE_H_
 
#include <ipc/ipc.h>
#include <bool.h>
 
typedef enum {
    KEY_PRESS,
    KEY_RELEASE
} console_ev_type_t;
 
enum {
    CONSOLE_CCAP_NONE = 0,
    CONSOLE_CCAP_STYLE,
    CONSOLE_CCAP_INDEXED,
    CONSOLE_CCAP_RGB
};
 
/** Console event structure. */
typedef struct {
    /** Press or release event. */
    console_ev_type_t type;
   
    /** Keycode of the key that was pressed or released. */
    unsigned int key;
   
    /** Bitmask of modifiers held. */
    unsigned int mods;
   
    /** The character that was generated or '\0' for none. */
    wchar_t c;
} console_event_t;
 
extern void console_clear(int phone);
 
extern int console_get_size(int phone, ipcarg_t *rows, ipcarg_t *cols);
extern void console_goto(int phone, ipcarg_t row, ipcarg_t col);
 
extern void console_set_style(int phone, int style);
extern void console_set_color(int phone, int fg_color, int bg_color, int flags);
extern void console_set_rgb_color(int phone, int fg_color, int bg_color);
 
extern void console_cursor_visibility(int phone, bool show);
extern int console_get_color_cap(int phone, int *ccap);
extern void console_kcon_enable(int phone);
 
extern bool console_get_event(int phone, console_event_t *event);
 
#endif
 
/** @}
 */
 

Rev 4581	Rev 4718
1	/*	1	/*
2	* Copyright (c) 2008 Jiri Svoboda	2	* Copyright (c) 2008 Jiri Svoboda
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup libc	29	/** @addtogroup libc
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef LIBC_IO_CONSOLE_H_	35	#ifndef LIBC_IO_CONSOLE_H_
36	#define LIBC_IO_CONSOLE_H_	36	#define LIBC_IO_CONSOLE_H_
37		37
38	#include <ipc/ipc.h>	38	#include <ipc/ipc.h>
39	#include <bool.h>	39	#include <bool.h>
40		40
41	typedef enum {	41	typedef enum {
42	KEY_PRESS,	42	KEY_PRESS,
43	KEY_RELEASE	43	KEY_RELEASE
44	} console_ev_type_t;	44	} console_ev_type_t;
45		45
-		46	enum {
-		47	CONSOLE_CCAP_NONE = 0,
-		48	CONSOLE_CCAP_STYLE,
-		49	CONSOLE_CCAP_INDEXED,
-		50	CONSOLE_CCAP_RGB
-		51	};
-		52
46	/** Console event structure. */	53	/** Console event structure. */
47	typedef struct {	54	typedef struct {
48	/** Press or release event. */	55	/** Press or release event. */
49	console_ev_type_t type;	56	console_ev_type_t type;
50		57
51	/** Keycode of the key that was pressed or released. */	58	/** Keycode of the key that was pressed or released. */
52	unsigned int key;	59	unsigned int key;
53		60
54	/** Bitmask of modifiers held. */	61	/** Bitmask of modifiers held. */
55	unsigned int mods;	62	unsigned int mods;
56		63
57	/** The character that was generated or '\0' for none. */	64	/** The character that was generated or '\0' for none. */
58	wchar_t c;	65	wchar_t c;
59	} console_event_t;	66	} console_event_t;
60		67
61	extern void console_clear(int phone);	68	extern void console_clear(int phone);
62		69
63	extern int console_get_size(int phone, ipcarg_t rows, ipcarg_t cols);	70	extern int console_get_size(int phone, ipcarg_t rows, ipcarg_t cols);
64	extern void console_goto(int phone, ipcarg_t row, ipcarg_t col);	71	extern void console_goto(int phone, ipcarg_t row, ipcarg_t col);
65		72
66	extern void console_set_style(int phone, int style);	73	extern void console_set_style(int phone, int style);
67	extern void console_set_color(int phone, int fg_color, int bg_color, int flags);	74	extern void console_set_color(int phone, int fg_color, int bg_color, int flags);
68	extern void console_set_rgb_color(int phone, int fg_color, int bg_color);	75	extern void console_set_rgb_color(int phone, int fg_color, int bg_color);
69		76
70	extern void console_cursor_visibility(int phone, bool show);	77	extern void console_cursor_visibility(int phone, bool show);
-		78	extern int console_get_color_cap(int phone, int *ccap);
71	extern void console_kcon_enable(int phone);	79	extern void console_kcon_enable(int phone);
72		80
73	extern bool console_get_event(int phone, console_event_t *event);	81	extern bool console_get_event(int phone, console_event_t *event);
74		82
75	#endif	83	#endif
76		84
77	/** @}	85	/** @}
78	*/	86	*/
79		87

Subversion Repositories HelenOS

(root)/branches/network/uspace/lib/libc/include/io/console.h – Rev 4581 → 4718