source: mainline/uspace/lib/c/include/io/console.h@ 74fec95

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 74fec95 was 111d2d6, checked in by Jiri Svoboda <jiri@…>, 13 years ago

Factor out input protocol client code.

  • Property mode set to 100644
File size: 3.1 KB
Line 
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/kbd_event.h>
40#include <io/keycode.h>
41#include <async.h>
42#include <bool.h>
43#include <stdio.h>
44
45typedef enum {
46 CONSOLE_CAP_NONE = 0,
47 CONSOLE_CAP_STYLE = 1,
48 CONSOLE_CAP_INDEXED = 2,
49 CONSOLE_CAP_RGB = 4
50} console_caps_t;
51
52/** Console control structure. */
53typedef struct {
54 /** Console input file */
55 FILE *input;
56
57 /** Console output file */
58 FILE *output;
59
60 /** Console input session */
61 async_sess_t *input_sess;
62
63 /** Console output session */
64 async_sess_t *output_sess;
65
66 /** Input request call with timeout */
67 ipc_call_t input_call;
68
69 /** Input response with timeout */
70 aid_t input_aid;
71} console_ctrl_t;
72
73extern console_ctrl_t *console_init(FILE *, FILE *);
74extern void console_done(console_ctrl_t *);
75extern bool console_kcon(void);
76
77extern void console_flush(console_ctrl_t *);
78extern void console_clear(console_ctrl_t *);
79
80extern int console_get_size(console_ctrl_t *, sysarg_t *, sysarg_t *);
81extern int console_get_pos(console_ctrl_t *, sysarg_t *, sysarg_t *);
82extern void console_set_pos(console_ctrl_t *, sysarg_t, sysarg_t);
83
84extern void console_set_style(console_ctrl_t *, uint8_t);
85extern void console_set_color(console_ctrl_t *, uint8_t, uint8_t, uint8_t);
86extern void console_set_rgb_color(console_ctrl_t *, uint32_t, uint32_t);
87
88extern void console_cursor_visibility(console_ctrl_t *, bool);
89extern int console_get_color_cap(console_ctrl_t *, sysarg_t *);
90extern bool console_get_kbd_event(console_ctrl_t *, kbd_event_t *);
91extern bool console_get_kbd_event_timeout(console_ctrl_t *, kbd_event_t *,
92 suseconds_t *);
93
94#endif
95
96/** @}
97 */
Note: See TracBrowser for help on using the repository browser.