source: mainline/uspace/lib/c/include/io/console.h@ 68a552f

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

Efficient way of rendering to the console via shared buffer

Makes congfx reasonably fast

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