src/terminal.h

   1 /*
   2  * kmscon - Terminal
   3  *
   4  * Copyright (c) 2011 David Herrmann <dh.herrmann@googlemail.com>
   5  * Copyright (c) 2011 University of Tuebingen
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining
   8  * a copy of this software and associated documentation files
   9  * (the "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sublicense, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included
  16  * in all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  21  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  22  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27 /*
  28  * Terminal
  29  * This provides the basic terminal object. This ties together the vt emulation
  30  * and the output console.
  31  */
  32
  33 #ifndef KMSCON_TERMINAL_H
  34 #define KMSCON_TERMINAL_H
  35
  36 #include <stdlib.h>
  37 #include "console.h"
  38 #include "eloop.h"
  39 #include "font.h"
  40 #include "output.h"
  41 #include "unicode.h"
  42
  43 struct kmscon_terminal;
  44
  45 typedef void (*kmscon_terminal_closed_cb) (struct kmscon_terminal *term,
  46                                                                 void *data);
  47
  48 int kmscon_terminal_new(struct kmscon_terminal **out,
  49                 struct ev_eloop *loop, struct kmscon_font_factory *ff,
  50                 struct kmscon_compositor *comp, struct kmscon_symbol_table *st);
  51 void kmscon_terminal_ref(struct kmscon_terminal *term);
  52 void kmscon_terminal_unref(struct kmscon_terminal *term);
  53
  54 int kmscon_terminal_open(struct kmscon_terminal *term,
  55                         kmscon_terminal_closed_cb closed_cb, void *data);
  56 void kmscon_terminal_close(struct kmscon_terminal *term);
  57
  58 int kmscon_terminal_add_output(struct kmscon_terminal *term,
  59                                                 struct kmscon_output *output);
  60 void kmscon_terminal_rm_all_outputs(struct kmscon_terminal *term);
  61
  62 int kmscon_terminal_input(struct kmscon_terminal *term,
  63                                         const struct kmscon_input_event *ev);
  64
  65 #endif /* KMSCON_TERMINAL_H */