ipc/ip.h

   1 /*-
   2  * Copyright (c) 1996
   3  *      Keith Bostic.  All rights reserved.
   4  *
   5  * See the LICENSE file for redistribution information.
   6  *
   7  *      $Id: ip.h,v 8.29 2000/07/17 21:17:54 skimo Exp $ (Berkeley) $Date: 2000/07/17 21:17:54 $
   8  */
   9
  10 #include <sys/socket.h>
  11 #include "ipc_def.h"
  12
  13 typedef struct ipcmsghdr {
  14         struct  cmsghdr header;
  15         int     __room_for_fd;
  16 } IPCMSGHDR;
  17
  18 struct _ip_vi_win;
  19
  20 typedef struct _ip_private {
  21         int      i_fd;          /* Input file descriptor. */
  22         int      o_fd;          /* Output file descriptor. */
  23         int      t_fd;          /* Terminal file descriptor. */
  24
  25         int      argc;
  26         char    **argv;
  27
  28         size_t   row;           /* Current row. */
  29         size_t   col;           /* Current column. */
  30
  31         db_recno_t       sb_total;      /* scrollbar: total lines in file. */
  32         db_recno_t       sb_top;        /* scrollbar: top line on screen. */
  33         size_t   sb_num;        /* scrollbar: number of lines on screen. */
  34
  35         size_t   iblen;         /* Input buffer length. */
  36         size_t   iskip;         /* Returned input buffer. */
  37         char     ibuf[256];     /* Input buffer. */
  38
  39         CHAR_T   tbuf[256];     /* Input keys. */
  40
  41 #define IP_IN_EX        0x0001  /* Currently running ex. */
  42 #define IP_ON_ALTERNATE 0x0002  /* Alternate on. */
  43 #define IP_SCR_VI_INIT  0x0004  /* Vi screen initialized. */
  44         u_int32_t flags;
  45 } IP_PRIVATE;
  46
  47 #define IPP(sp)         ((IP_PRIVATE *)((sp)->wp->ip_private))
  48 #define WIPP(wp)        ((IP_PRIVATE *)((wp)->ip_private))
  49
  50 /* The screen line relative to a specific window. */
  51 #define RLNO(sp, lno)   (sp)->roff + (lno)
  52 #define RCNO(sp, cno)   (sp)->coff + (cno)
  53
  54 #define IPO_CODE_LEN    1       /* Length of a code value. */
  55 #define IPO_INT_LEN     4       /* Length of an integer. */
  56
  57 /* A structure that can hold the information for any frame. */
  58 typedef struct _ip_buf {
  59         int code;               /* Event code. */
  60         const char *str1;       /* String #1. */
  61         u_int32_t len1;         /* String #1 length. */
  62         const char *str2;       /* String #1. */
  63         u_int32_t len2;         /* String #1 length. */
  64         u_int32_t val1;         /* Value #1. */
  65         u_int32_t val2;         /* Value #2. */
  66         u_int32_t val3;         /* Value #3. */
  67 } IP_BUF;
  68
  69 typedef int (*IPFunc) (struct _ip_vi_win *);
  70 typedef int (*IPFunc_1) (struct _ip_vi_win *, u_int32_t);
  71 typedef int (*IPFunc_1a) (struct _ip_vi_win *, u_int32_t, const char *, u_int32_t);
  72 typedef int (*IPFunc_a) (struct _ip_vi_win *, const char *, u_int32_t);
  73 typedef int (*IPFunc_ab1) (struct _ip_vi_win *, const char *, u_int32_t,
  74                             const char *, u_int32_t, u_int32_t);
  75 typedef int (*IPFunc_12) (struct _ip_vi_win *, u_int32_t, u_int32_t);
  76 typedef int (*IPFunc_123) (struct _ip_vi_win *, u_int32_t, u_int32_t, u_int32_t);
  77
  78 typedef int (*IPUnmarshall) (struct _ip_vi_win *, IP_BUF *, IPFunc);
  79
  80 typedef struct _ipfunlist {
  81     char           *format;
  82     IPUnmarshall    unmarshall;
  83     size_t          offset;
  84 } IPFUNLIST;
  85
  86 typedef struct _vipfunlist {
  87     char           *format;
  88     e_event_t       e_event;
  89 } VIPFUNLIST;
  90
  91 typedef struct ip_si_operations {
  92     IPFunc_a    addstr;
  93     IPFunc_12   attribute;
  94     IPFunc      bell;
  95     IPFunc      busy_off;
  96     IPFunc_a    busy_on;
  97     IPFunc      clrtoeol;
  98     IPFunc      deleteln;
  99     IPFunc      discard;
 100     IPFunc_ab1  editopt;
 101     IPFunc      insertln;
 102     IPFunc_12   move;
 103     IPFunc      quit;
 104     IPFunc      redraw;
 105     IPFunc      refresh;
 106     IPFunc_a    rename;
 107     IPFunc_1    rewrite;
 108     IPFunc_123  scrollbar;
 109     IPFunc_a    select;
 110     IPFunc      split;
 111     IPFunc_a    waddstr;
 112 } IPSIOPS;
 113
 114 struct _ip_vi;
 115 typedef struct _ip_vi IPVI;
 116
 117 struct _ip_vi_win;
 118 typedef struct _ip_vi_win IPVIWIN;
 119
 120 struct _ip_vi {
 121     int         ifd;            /* Input file descriptor. */
 122     int         ofd;            /* Output file descriptor. */
 123     pid_t       pid;
 124
 125     void        *private_data;
 126
 127     u_int32_t   flags;
 128
 129     int         (*run) __P((IPVI*, int, char*[]));
 130     int         (*new_window) __P((IPVI *, IPVIWIN **, int));
 131     int         (*close) __P((IPVI*));
 132 };
 133
 134 struct _ip_vi_win {
 135     int         ifd;            /* Input file descriptor. */
 136     int         ofd;            /* Output file descriptor. */
 137
 138     void        *private_data;
 139
 140     IPSIOPS      *si_ops;
 141
 142     int         (*c_bol) __P((IPVIWIN*));
 143     int         (*c_bottom) __P((IPVIWIN*));
 144     int         (*c_del) __P((IPVIWIN*));
 145     int         (*c_eol) __P((IPVIWIN*));
 146     int         (*c_insert) __P((IPVIWIN*));
 147     int         (*c_left) __P((IPVIWIN*));
 148     int         (*c_right) __P((IPVIWIN*));
 149     int         (*c_top) __P((IPVIWIN*));
 150     int         (*c_settop) __P((IPVIWIN*, u_int32_t));
 151
 152     int         (*string) __P((IPVIWIN*, const char*, u_int32_t));
 153     int         (*wq) __P((IPVIWIN*));
 154     int         (*quit) __P((IPVIWIN*));
 155     int         (*resize) __P((IPVIWIN*, u_int32_t, u_int32_t));
 156
 157     int         (*input) __P((IPVIWIN*, int));
 158     int         (*close) __P((IPVIWIN*));
 159
 160     int         (*set_ops) __P((IPVIWIN*, IPSIOPS*));
 161 };
 162
 163 /*
 164  * Screen/editor IP_CODE's.
 165  *
 166  * The program structure depends on the event loop being able to return
 167  * IPO_EOF/IPO_ERR multiple times -- eventually enough things will end
 168  * due to the events that vi will reach the command level for the screen,
 169  * at which point the exit flags will be set and vi will exit.
 170  *
 171  * IP events sent from the screen to vi.
 172  */
 173 #define CODE_OOB         0      /* Illegal code. */
 174 #if 0
 175 #define VI_C_BOL         1      /* Cursor to start of line. */
 176 #define VI_C_BOTTOM      2      /* Cursor to bottom. */
 177 #define VI_C_DEL         3      /* Cursor delete. */
 178 #define VI_C_DOWN        4      /* Cursor down N lines: IPO_INT. */
 179 #define VI_C_EOL         5      /* Cursor to end of line. */
 180 #define VI_C_INSERT      6      /* Cursor: enter insert mode. */
 181 #define VI_C_LEFT        7      /* Cursor left. */
 182 #define VI_C_PGDOWN      8      /* Cursor down N pages: IPO_INT. */
 183 #define VI_C_PGUP        9      /* Cursor up N lines: IPO_INT. */
 184 #define VI_C_RIGHT      10      /* Cursor right. */
 185 #define VI_C_SEARCH     11      /* Cursor: search: IPO_INT, IPO_STR. */
 186 #define VI_C_SETTOP     12      /* Cursor: set screen top line: IPO_INT. */
 187 #define VI_C_TOP        13      /* Cursor to top. */
 188 #define VI_C_UP         14      /* Cursor up N lines: IPO_INT. */
 189 #define VI_EDIT         15      /* Edit a file: IPO_STR. */
 190 #define VI_EDITOPT      16      /* Edit option: 2 * IPO_STR, IPO_INT. */
 191 #define VI_EDITSPLIT    17      /* Split to a file: IPO_STR. */
 192 #define VI_EOF          18      /* End of input (NOT ^D). */
 193 #define VI_ERR          19      /* Input error. */
 194 #define VI_INTERRUPT    20      /* Interrupt. */
 195 #define VI_MOUSE_MOVE   21      /* Mouse click move: IPO_INT, IPO_INT. */
 196 #define VI_QUIT         22      /* Quit. */
 197 #define VI_RESIZE       23      /* Screen resize: IPO_INT, IPO_INT. */
 198 #define VI_SEL_END      24      /* Select end: IPO_INT, IPO_INT. */
 199 #define VI_SEL_START    25      /* Select start: IPO_INT, IPO_INT. */
 200 #define VI_SIGHUP       26      /* SIGHUP. */
 201 #define VI_SIGTERM      27      /* SIGTERM. */
 202 #define VI_STRING       28      /* Input string: IPO_STR. */
 203 #define VI_TAG          29      /* Tag. */
 204 #define VI_TAGAS        30      /* Tag to a string: IPO_STR. */
 205 #define VI_TAGSPLIT     31      /* Split to a tag. */
 206 #define VI_UNDO         32      /* Undo. */
 207 #define VI_WQ           33      /* Write and quit. */
 208 #define VI_WRITE        34      /* Write. */
 209 #define VI_WRITEAS      35      /* Write as another file: IPO_STR. */
 210 #define VI_FLAGS        36      /* Flags passed to nvi_create */
 211 #endif
 212
 213 #define VI_SEARCH_EXT   0x001   /* VI_C_SEARCH: ignore case. */
 214 #define VI_SEARCH_IC    0x002   /* VI_C_SEARCH: ignore case. */
 215 #define VI_SEARCH_ICL   0x004   /* VI_C_SEARCH: ignore case if lower-case. */
 216 #define VI_SEARCH_INCR  0x008   /* VI_C_SEARCH: incremental search. */
 217 #define VI_SEARCH_LIT   0x010   /* VI_C_SEARCH: literal string. */
 218 #define VI_SEARCH_REV   0x020   /* VI_C_SEARCH: reverse direction. */
 219 #define VI_SEARCH_WR    0x040   /* VI_C_SEARCH: wrap at sof/eof. */
 220
 221 /*
 222  * IP events sent from vi to the screen.
 223  */
 224 #if 0
 225 #define SI_ADDSTR        1      /* Add a string: IPO_STR. */
 226 #define SI_ATTRIBUTE     2      /* Set screen attribute: 2 * IPO_INT. */
 227 #define SI_BELL          3      /* Beep/bell/flash the terminal. */
 228 #define SI_BUSY_OFF      4      /* Display a busy message: IPO_STR. */
 229 #define SI_BUSY_ON       5      /* Display a busy message: IPO_STR. */
 230 #define SI_CLRTOEOL      6      /* Clear to the end of the line. */
 231 #define SI_DELETELN      7      /* Delete a line. */
 232 #define SI_DISCARD       8      /* Discard the screen. */
 233 #define SI_EDITOPT       9      /* Edit option: 2 * IPO_STR, IPO_INT. */
 234 #define SI_INSERTLN     10      /* Insert a line. */
 235 #define SI_MOVE         11      /* Move the cursor: 2 * IPO_INT. */
 236 #define SI_QUIT         12      /* Quit. */
 237 #define SI_REDRAW       13      /* Redraw the screen. */
 238 #define SI_REFRESH      14      /* Refresh the screen. */
 239 #define SI_RENAME       15      /* Rename the screen: IPO_STR. */
 240 #define SI_REPLY        16      /* Reply: IPO_INT (0/1), IPO_STR. */
 241 #define SI_REWRITE      17      /* Rewrite a line: IPO_INT. */
 242 #define SI_SCROLLBAR    18      /* Reset the scrollbar: 3 * IPO_INT. */
 243 #define SI_SELECT       19      /* Select area: IPO_STR. */
 244 #define SI_SPLIT        20      /* Split the screen. */
 245 #define SI_EVENT_MAX    20
 246 #endif
 247
 248 #include "extern.h"