| 1 | /*
|
|---|
| 2 | * Copyright (c) 2008 Jiri Svoboda
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 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
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 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
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 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
|
|---|
| 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
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup libc
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | #ifndef LIBC_IO_CONSOLE_H_
|
|---|
| 36 | #define LIBC_IO_CONSOLE_H_
|
|---|
| 37 |
|
|---|
| 38 | #include <sys/time.h>
|
|---|
| 39 | #include <io/keycode.h>
|
|---|
| 40 | #include <async.h>
|
|---|
| 41 | #include <bool.h>
|
|---|
| 42 | #include <stdio.h>
|
|---|
| 43 |
|
|---|
| 44 | typedef enum {
|
|---|
| 45 | CONSOLE_CAP_NONE = 0,
|
|---|
| 46 | CONSOLE_CAP_STYLE = 1,
|
|---|
| 47 | CONSOLE_CAP_INDEXED = 2,
|
|---|
| 48 | CONSOLE_CAP_RGB = 4
|
|---|
| 49 | } console_caps_t;
|
|---|
| 50 |
|
|---|
| 51 | /** Console control structure. */
|
|---|
| 52 | typedef struct {
|
|---|
| 53 | /** Console input file */
|
|---|
| 54 | FILE *input;
|
|---|
| 55 |
|
|---|
| 56 | /** Console output file */
|
|---|
| 57 | FILE *output;
|
|---|
| 58 |
|
|---|
| 59 | /** Console input session */
|
|---|
| 60 | async_sess_t *input_sess;
|
|---|
| 61 |
|
|---|
| 62 | /** Console output session */
|
|---|
| 63 | async_sess_t *output_sess;
|
|---|
| 64 |
|
|---|
| 65 | /** Input request call with timeout */
|
|---|
| 66 | ipc_call_t input_call;
|
|---|
| 67 |
|
|---|
| 68 | /** Input response with timeout */
|
|---|
| 69 | aid_t input_aid;
|
|---|
| 70 | } console_ctrl_t;
|
|---|
| 71 |
|
|---|
| 72 | typedef enum {
|
|---|
| 73 | KEY_PRESS,
|
|---|
| 74 | KEY_RELEASE
|
|---|
| 75 | } kbd_event_type_t;
|
|---|
| 76 |
|
|---|
| 77 | /** Console event structure. */
|
|---|
| 78 | typedef struct {
|
|---|
| 79 | /** List handle */
|
|---|
| 80 | link_t link;
|
|---|
| 81 |
|
|---|
| 82 | /** Press or release event. */
|
|---|
| 83 | kbd_event_type_t type;
|
|---|
| 84 |
|
|---|
| 85 | /** Keycode of the key that was pressed or released. */
|
|---|
| 86 | keycode_t key;
|
|---|
| 87 |
|
|---|
| 88 | /** Bitmask of modifiers held. */
|
|---|
| 89 | keymod_t mods;
|
|---|
| 90 |
|
|---|
| 91 | /** The character that was generated or '\0' for none. */
|
|---|
| 92 | wchar_t c;
|
|---|
| 93 | } kbd_event_t;
|
|---|
| 94 |
|
|---|
| 95 | extern console_ctrl_t *console_init(FILE *, FILE *);
|
|---|
| 96 | extern void console_done(console_ctrl_t *);
|
|---|
| 97 | extern bool console_kcon(void);
|
|---|
| 98 |
|
|---|
| 99 | extern void console_flush(console_ctrl_t *);
|
|---|
| 100 | extern void console_clear(console_ctrl_t *);
|
|---|
| 101 |
|
|---|
| 102 | extern int console_get_size(console_ctrl_t *, sysarg_t *, sysarg_t *);
|
|---|
| 103 | extern int console_get_pos(console_ctrl_t *, sysarg_t *, sysarg_t *);
|
|---|
| 104 | extern void console_set_pos(console_ctrl_t *, sysarg_t, sysarg_t);
|
|---|
| 105 |
|
|---|
| 106 | extern void console_set_style(console_ctrl_t *, uint8_t);
|
|---|
| 107 | extern void console_set_color(console_ctrl_t *, uint8_t, uint8_t, uint8_t);
|
|---|
| 108 | extern void console_set_rgb_color(console_ctrl_t *, uint32_t, uint32_t);
|
|---|
| 109 |
|
|---|
| 110 | extern void console_cursor_visibility(console_ctrl_t *, bool);
|
|---|
| 111 | extern int console_get_color_cap(console_ctrl_t *, sysarg_t *);
|
|---|
| 112 | extern bool console_get_kbd_event(console_ctrl_t *, kbd_event_t *);
|
|---|
| 113 | extern bool console_get_kbd_event_timeout(console_ctrl_t *, kbd_event_t *,
|
|---|
| 114 | suseconds_t *);
|
|---|
| 115 |
|
|---|
| 116 | #endif
|
|---|
| 117 |
|
|---|
| 118 | /** @}
|
|---|
| 119 | */
|
|---|
