uspace/app/terminal/terminal.h

   1 /*
   2  * Copyright (c) 2024 Jiri Svoboda
   3  * Copyright (c) 2012 Petr Koupy
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in the
  14  *   documentation and/or other materials provided with the distribution.
  15  * - The name of the author may not be used to endorse or promote products
  16  *   derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 /** @addtogroup terminal
  31  * @{
  32  */
  33 /**
  34  * @file
  35  */
  36
  37 #ifndef TERMINAL_H
  38 #define TERMINAL_H
  39
  40 #include <adt/prodcons.h>
  41 #include <errno.h>
  42 #include <fibril.h>
  43 #include <fibril_synch.h>
  44 #include <gfx/bitmap.h>
  45 #include <gfx/context.h>
  46 #include <gfx/coord.h>
  47 #include <io/con_srv.h>
  48 #include <io/cons_event.h>
  49 #include <loc.h>
  50 #include <stdatomic.h>
  51 #include <str.h>
  52 #include <task.h>
  53 #include <termui.h>
  54 #include <ui/ui.h>
  55 #include <ui/window.h>
  56
  57 #define UTF8_CHAR_BUFFER_SIZE  (STR_BOUNDS(1) + 1)
  58
  59 typedef enum {
  60         tf_topleft = 1
  61 } terminal_flags_t;
  62
  63 typedef struct {
  64         ui_t *ui;
  65         ui_window_t *window;
  66         ui_resource_t *ui_res;
  67         gfx_context_t *gc;
  68
  69         gfx_bitmap_t *bmp;
  70         sysarg_t w;
  71         sysarg_t h;
  72         gfx_rect_t update;
  73         gfx_coord2_t off;
  74         bool is_focused;
  75
  76         fibril_mutex_t mtx;
  77         link_t link;
  78         atomic_flag refcnt;
  79
  80         prodcons_t input_pc;
  81         char char_remains[UTF8_CHAR_BUFFER_SIZE];
  82         size_t char_remains_len;
  83
  84         termui_t *termui;
  85
  86         termui_color_t default_bgcolor;
  87         termui_color_t default_fgcolor;
  88         termui_color_t emphasis_bgcolor;
  89         termui_color_t emphasis_fgcolor;
  90         termui_color_t selection_bgcolor;
  91         termui_color_t selection_fgcolor;
  92
  93         sysarg_t ucols;
  94         sysarg_t urows;
  95         charfield_t *ubuf;
  96
  97         loc_srv_t *srv;
  98         service_id_t dsid;
  99         con_srvs_t srvs;
 100
 101         task_wait_t wait;
 102         fid_t wfid;
 103 } terminal_t;
 104
 105 /** Terminal event */
 106 typedef struct {
 107         /** Link to list of events */
 108         link_t link;
 109         /** Console event */
 110         cons_event_t ev;
 111 } terminal_event_t;
 112
 113 extern errno_t terminal_create(const char *, sysarg_t, sysarg_t,
 114     terminal_flags_t, const char *, terminal_t **);
 115 extern void terminal_destroy(terminal_t *);
 116
 117 #endif
 118
 119 /** @}
 120  */