uspace/lib/gui/terminal.h

   1 /*
   2  * Copyright (c) 2012 Petr Koupy
   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 gui
  30  * @{
  31  */
  32 /**
  33  * @file
  34  */
  35
  36 #ifndef GUI_TERMINAL_H_
  37 #define GUI_TERMINAL_H_
  38
  39 #include <stddef.h>
  40 #include <fibril_synch.h>
  41 #include <font.h>
  42 #include <io/chargrid.h>
  43 #include <io/con_srv.h>
  44 #include <adt/list.h>
  45 #include <adt/prodcons.h>
  46 #include <atomic.h>
  47 #include <str.h>
  48 #include "widget.h"
  49
  50 #define UTF8_CHAR_BUFFER_SIZE  (STR_BOUNDS(1) + 1)
  51
  52 typedef struct terminal {
  53         widget_t widget;
  54
  55         fibril_mutex_t mtx;
  56         link_t link;
  57         atomic_t refcnt;
  58
  59         prodcons_t input_pc;
  60         char char_remains[UTF8_CHAR_BUFFER_SIZE];
  61         size_t char_remains_len;
  62
  63         sysarg_t cols;
  64         sysarg_t rows;
  65         chargrid_t *frontbuf;
  66         chargrid_t *backbuf;
  67         sysarg_t top_row;
  68
  69         service_id_t dsid;
  70         con_srvs_t srvs;
  71 } terminal_t;
  72
  73 extern bool init_terminal(terminal_t *, widget_t *, const void *, sysarg_t,
  74     sysarg_t);
  75 extern terminal_t *create_terminal(widget_t *, const void *, sysarg_t,
  76     sysarg_t);
  77 extern void deinit_terminal(terminal_t *);
  78
  79 #endif
  80
  81 /** @}
  82  */