uspace/lib/c/include/io/console.h

   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 <time.h>
  39 #include <io/concaps.h>
  40 #include <io/kbd_event.h>
  41 #include <io/cons_event.h>
  42 #include <io/keycode.h>
  43 #include <async.h>
  44 #include <stdbool.h>
  45 #include <stdio.h>
  46
  47 /** Console control structure. */
  48 typedef struct {
  49         /** Console input file */
  50         FILE *input;
  51
  52         /** Console output file */
  53         FILE *output;
  54
  55         /** Console input session */
  56         async_sess_t *input_sess;
  57
  58         /** Console output session */
  59         async_sess_t *output_sess;
  60
  61         /** Input request call with timeout */
  62         ipc_call_t input_call;
  63
  64         /** Input response with timeout */
  65         aid_t input_aid;
  66 } console_ctrl_t;
  67
  68 extern console_ctrl_t *console_init(FILE *, FILE *);
  69 extern void console_done(console_ctrl_t *);
  70 extern bool console_kcon(void);
  71
  72 extern void console_flush(console_ctrl_t *);
  73 extern void console_clear(console_ctrl_t *);
  74
  75 extern errno_t console_get_size(console_ctrl_t *, sysarg_t *, sysarg_t *);
  76 extern errno_t console_get_pos(console_ctrl_t *, sysarg_t *, sysarg_t *);
  77 extern void console_set_pos(console_ctrl_t *, sysarg_t, sysarg_t);
  78
  79 extern void console_set_style(console_ctrl_t *, uint8_t);
  80 extern void console_set_color(console_ctrl_t *, uint8_t, uint8_t, uint8_t);
  81 extern void console_set_rgb_color(console_ctrl_t *, uint32_t, uint32_t);
  82
  83 extern void console_cursor_visibility(console_ctrl_t *, bool);
  84 extern errno_t console_get_color_cap(console_ctrl_t *, sysarg_t *);
  85 extern bool console_get_event(console_ctrl_t *, cons_event_t *);
  86 extern bool console_get_event_timeout(console_ctrl_t *, cons_event_t *,
  87     usec_t *);
  88
  89 #endif
  90
  91 /** @}
  92  */