source: mainline/uspace/lib/console/include/io/con_srv.h

Last change on this file was a635535, checked in by Jiri Svoboda <jiri@…>, 19 months ago

Move console/con_srv out of libc into a separate library

  • Property mode set to 100644
File size: 3.3 KB
Line 
1/*
2 * Copyright (c) 2023 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 libconsole
30 * @{
31 */
32/** @file
33 */
34
35#ifndef _LIBCONSOLE_IO_CON_SRV_H_
36#define _LIBCONSOLE_IO_CON_SRV_H_
37
38#include <adt/list.h>
39#include <async.h>
40#include <fibril_synch.h>
41#include <io/charfield.h>
42#include <io/color.h>
43#include <io/concaps.h>
44#include <io/cons_event.h>
45#include <io/pixel.h>
46#include <io/style.h>
47#include <stdbool.h>
48#include <time.h>
49#include <stddef.h>
50
51typedef struct con_ops con_ops_t;
52
53#define CON_CAPTION_MAXLEN 255
54
55/** Service setup (per sevice) */
56typedef struct {
57 con_ops_t *ops;
58 void *sarg;
59 /** Period to check for abort */
60 usec_t abort_timeout;
61 bool aborted;
62} con_srvs_t;
63
64/** Server structure (per client session) */
65typedef struct {
66 con_srvs_t *srvs;
67 async_sess_t *client_sess;
68 void *carg;
69} con_srv_t;
70
71struct con_ops {
72 errno_t (*open)(con_srvs_t *, con_srv_t *);
73 errno_t (*close)(con_srv_t *);
74 errno_t (*read)(con_srv_t *, void *, size_t, size_t *);
75 errno_t (*write)(con_srv_t *, void *, size_t, size_t *);
76 void (*sync)(con_srv_t *);
77 void (*clear)(con_srv_t *);
78 void (*set_pos)(con_srv_t *, sysarg_t col, sysarg_t row);
79 errno_t (*get_pos)(con_srv_t *, sysarg_t *, sysarg_t *);
80 errno_t (*get_size)(con_srv_t *, sysarg_t *, sysarg_t *);
81 errno_t (*get_color_cap)(con_srv_t *, console_caps_t *);
82 void (*set_style)(con_srv_t *, console_style_t);
83 void (*set_color)(con_srv_t *, console_color_t, console_color_t,
84 console_color_attr_t);
85 void (*set_rgb_color)(con_srv_t *, pixel_t, pixel_t);
86 void (*set_cursor_visibility)(con_srv_t *, bool);
87 errno_t (*set_caption)(con_srv_t *, const char *);
88 errno_t (*get_event)(con_srv_t *, cons_event_t *);
89 errno_t (*map)(con_srv_t *, sysarg_t, sysarg_t, charfield_t **);
90 void (*unmap)(con_srv_t *);
91 void (*update)(con_srv_t *, sysarg_t, sysarg_t, sysarg_t, sysarg_t);
92};
93
94extern void con_srvs_init(con_srvs_t *);
95
96extern errno_t con_conn(ipc_call_t *, con_srvs_t *);
97
98#endif
99
100/** @}
101 */
Note: See TracBrowser for help on using the repository browser.