lib-ui/madtty.h

   1 /*
   2     LICENSE INFORMATION:
   3     This program is free software; you can redistribute it and/or
   4     modify it under the terms of the GNU Lesser General Public
   5     License (LGPL) as published by the Free Software Foundation.
   6
   7     Please refer to the COPYING file for more information.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12     General Public License for more details.
  13
  14     You should have received a copy of the GNU Lesser General Public
  15     License along with this program; if not, write to the Free Software
  16     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17
  18     Copyright © 2004 Bruno T. C. de Oliveira
  19     Copyright © 2006 Pierre Habouzit
  20  */
  21
  22 #ifndef MADTTY_MADTTY_H
  23 #define MADTTY_MADTTY_H
  24
  25 #include <sys/types.h>
  26
  27 enum {
  28     /* means escape sequence was handled */
  29     MADTTY_HANDLER_OK,
  30     /* means the escape sequence was not  recognized yet, but
  31      * there is hope that it still will once more characters
  32      * arrive (i.e. it is not yet complete).
  33      *
  34      * The library will thus continue collecting characters
  35      * and calling the handler as each character arrives until
  36      * either OK or NOWAY is returned.
  37      */
  38     MADTTY_HANDLER_NOTYET,
  39     /* means the escape sequence was not recognized, and there
  40      * is no chance that it will even if more characters  are
  41      * added to it.
  42      */
  43     MADTTY_HANDLER_NOWAY
  44 };
  45
  46 typedef struct madtty_t madtty_t;
  47 typedef int (*madtty_handler_t)(madtty_t *, char *es);
  48
  49 void madtty_init_colors(void);
  50 void madtty_init_vt100_graphics(void);
  51 void madtty_set_handler(madtty_t *, madtty_handler_t);
  52 void madtty_set_data(madtty_t *, void *);
  53 void *madtty_get_data(madtty_t *);
  54 int madtty_color_pair(int fg, int bg);
  55
  56 madtty_t *madtty_create(int rows, int cols);
  57 void madtty_resize(madtty_t *, int rows, int cols);
  58 void madtty_destroy(madtty_t *);
  59 pid_t madtty_forkpty(madtty_t *, const char *, const char *argv[], int *pty);
  60 int madtty_getpty(madtty_t *);
  61 unsigned madtty_cursor(madtty_t *t);
  62
  63 int madtty_process(madtty_t *);
  64 void madtty_keypress(madtty_t *, int keycode);
  65 void madtty_keypress_sequence(madtty_t *, const char *seq);
  66 void madtty_dirty(madtty_t *t);
  67 void madtty_draw(madtty_t *, WINDOW *win, int startrow, int startcol);
  68
  69 #endif /* MADTTY_MADTTY_H */