console.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2008 Jiri Svoboda
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  *
00009  * - Redistributions of source code must retain the above copyright
00010  *   notice, this list of conditions and the following disclaimer.
00011  * - Redistributions in binary form must reproduce the above copyright
00012  *   notice, this list of conditions and the following disclaimer in the
00013  *   documentation and/or other materials provided with the distribution.
00014  * - The name of the author may not be used to endorse or promote products
00015  *   derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00019  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00020  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00022  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00023  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00024  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00025  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00026  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  */
00028 
00035 #ifndef LIBC_IO_CONSOLE_H_
00036 #define LIBC_IO_CONSOLE_H_
00037 
00038 #include <bool.h>
00039 
00040 typedef enum {
00041         KEY_PRESS,
00042         KEY_RELEASE
00043 } console_ev_type_t;
00044 
00045 typedef enum {
00046         CONSOLE_CCAP_NONE = 0,
00047         CONSOLE_CCAP_STYLE,
00048         CONSOLE_CCAP_INDEXED,
00049         CONSOLE_CCAP_RGB
00050 } console_caps_t;
00051 
00053 typedef struct {
00055         console_ev_type_t type;
00056         
00058         unsigned int key;
00059         
00061         unsigned int mods;
00062         
00064         wchar_t c;
00065 } console_event_t;
00066 
00067 extern void console_clear(int phone);
00068 
00069 extern int console_get_size(int phone, sysarg_t *cols, sysarg_t *rows);
00070 extern int console_get_pos(int phone, sysarg_t *col, sysarg_t *row);
00071 extern void console_set_pos(int phone, sysarg_t col, sysarg_t row);
00072 
00073 extern void console_set_style(int phone, uint8_t style);
00074 extern void console_set_color(int phone, uint8_t fg_color, uint8_t bg_color,
00075     uint8_t flags);
00076 extern void console_set_rgb_color(int phone, uint32_t fg_color, uint32_t bg_color);
00077 
00078 extern void console_cursor_visibility(int phone, bool show);
00079 extern int console_get_color_cap(int phone, sysarg_t *ccap);
00080 extern void console_kcon_enable(int phone);
00081 
00082 extern bool console_get_event(int phone, console_event_t *event);
00083 
00084 #endif
00085 

Generated on Thu Jun 2 07:45:47 2011 for HelenOS/USB by  doxygen 1.4.7