uspace/app/terminal/terminal.h

   1 /*
   2  * Copyright (c) 2023 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/chargrid.h>
  48 #include <io/con_srv.h>
  49 #include <loc.h>
  50 #include <stdatomic.h>
  51 #include <str.h>
  52 #include <task.h>
  53 #include <ui/ui.h>
  54 #include <ui/window.h>
  55
  56 #define UTF8_CHAR_BUFFER_SIZE  (STR_BOUNDS(1) + 1)
  57
  58 typedef enum {
  59         tf_topleft = 1
  60 } terminal_flags_t;
  61
  62 typedef struct {
  63         ui_t *ui;
  64         ui_window_t *window;
  65         ui_resource_t *ui_res;
  66         gfx_context_t *gc;
  67
  68         gfx_bitmap_t *bmp;
  69         sysarg_t w;
  70         sysarg_t h;
  71         gfx_rect_t update;
  72         gfx_coord2_t off;
  73         bool is_focused;
  74
  75         fibril_mutex_t mtx;
  76         link_t link;
  77         atomic_flag refcnt;
  78
  79         prodcons_t input_pc;
  80         char char_remains[UTF8_CHAR_BUFFER_SIZE];
  81         size_t char_remains_len;
  82
  83         sysarg_t cols;
  84         sysarg_t rows;
  85         chargrid_t *frontbuf;
  86         chargrid_t *backbuf;
  87         sysarg_t top_row;
  88
  89         sysarg_t ucols;
  90         sysarg_t urows;
  91         charfield_t *ubuf;
  92
  93         loc_srv_t *srv;
  94         service_id_t dsid;
  95         con_srvs_t srvs;
  96
  97         task_wait_t wait;
  98         fid_t wfid;
  99 } terminal_t;
 100
 101 extern errno_t terminal_create(const char *, sysarg_t, sysarg_t,
 102     terminal_flags_t, const char *, terminal_t **);
 103 extern void terminal_destroy(terminal_t *);
 104
 105 #endif
 106
 107 /** @}
 108  */