source: mainline/uspace/srv/hid/output/proto/vt100.h@ ef30659

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since ef30659 was 4122410, checked in by Jakub Jermar <jakub@…>, 7 years ago

Improve Doxygen documentaion

This is stil WiP. A number of libraries, drivers and services were
converted to using a more hierarchical and decentralized scheme when it
comes to specifying to which doxygen group they belong.

  • Property mode set to 100644
File size: 2.5 KB
Line 
1/*
2 * Copyright (c) 2011 Martin Decky
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 output
30 * @{
31 */
32
33#ifndef OUTPUT_PROTO_VT100_H_
34#define OUTPUT_PROTO_VT100_H_
35
36#include <io/charfield.h>
37
38typedef void (*vt100_putwchar_t)(wchar_t ch);
39typedef void (*vt100_control_puts_t)(const char *str);
40typedef void (*vt100_flush_t)(void);
41
42typedef struct {
43 sysarg_t cols;
44 sysarg_t rows;
45
46 sysarg_t cur_col;
47 sysarg_t cur_row;
48 char_attrs_t cur_attrs;
49
50 vt100_putwchar_t putwchar;
51 vt100_control_puts_t control_puts;
52 vt100_flush_t flush;
53} vt100_state_t;
54
55extern vt100_state_t *vt100_state_create(sysarg_t, sysarg_t, vt100_putwchar_t,
56 vt100_control_puts_t, vt100_flush_t);
57extern void vt100_state_destroy(vt100_state_t *);
58
59extern errno_t vt100_yield(vt100_state_t *);
60extern errno_t vt100_claim(vt100_state_t *);
61extern void vt100_get_dimensions(vt100_state_t *, sysarg_t *, sysarg_t *);
62
63extern void vt100_goto(vt100_state_t *, sysarg_t, sysarg_t);
64extern void vt100_set_attr(vt100_state_t *, char_attrs_t);
65extern void vt100_cursor_visibility(vt100_state_t *, bool);
66extern void vt100_putwchar(vt100_state_t *, wchar_t);
67extern void vt100_flush(vt100_state_t *);
68
69#endif
70
71/** @}
72 */
Note: See TracBrowser for help on using the repository browser.