ip/ip_read.c

   1 /*-
   2  * Copyright (c) 1996
   3  *      Keith Bostic.  All rights reserved.
   4  *
   5  * See the LICENSE file for redistribution information.
   6  */
   7
   8 #include "config.h"
   9
  10 #ifndef lint
  11 static const char sccsid[] = "$Id: ip_read.c,v 8.23 2001/06/25 15:19:24 skimo Exp $ (Berkeley) $Date: 2001/06/25 15:19:24 $";
  12 #endif /* not lint */
  13
  14 #include <sys/types.h>
  15 #include <sys/queue.h>
  16 #include <sys/time.h>
  17
  18 #include <bitstring.h>
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <termios.h>
  23 #include <time.h>
  24 #include <unistd.h>
  25 #include <netinet/in.h>
  26
  27 #include "../common/common.h"
  28 #include "../ex/script.h"
  29 #include "../ipc/ip.h"
  30 #include "extern.h"
  31
  32 extern GS *__global_list;
  33
  34 VIPFUNLIST const vipfuns[] = {
  35 /* VI_C_BOL         Cursor to start of line. */
  36     {"",    E_IPCOMMAND},
  37 /* VI_C_BOTTOM   2      /* Cursor to bottom. */
  38     {"",    E_IPCOMMAND},
  39 /* VI_C_DEL      3      /* Cursor delete. */
  40     {"",    E_IPCOMMAND},
  41 /* VI_C_DOWN        Cursor down N lines: IPO_INT. */
  42     {"1",   E_IPCOMMAND},
  43 /* VI_C_EOL      5      /* Cursor to end of line. */
  44     {"",    E_IPCOMMAND},
  45 /* VI_C_INSERT   6      /* Cursor: enter insert mode. */
  46     {"",    E_IPCOMMAND},
  47 /* VI_C_LEFT     7      /* Cursor left. */
  48     {"",    E_IPCOMMAND},
  49 /* VI_C_PGDOWN   8      /* Cursor down N pages: IPO_INT. */
  50     {"1",   E_IPCOMMAND},
  51 /* VI_C_PGUP     9      /* Cursor up N lines: IPO_INT. */
  52     {"1",   E_IPCOMMAND},
  53 /* VI_C_RIGHT   10      /* Cursor right. */
  54     {"",    E_IPCOMMAND},
  55 /* VI_C_SEARCH  11      /* Cursor: search: IPO_INT, IPO_STR. */
  56     {"a1",  E_IPCOMMAND},
  57 /* VI_C_SETTOP  12      /* Cursor: set screen top line: IPO_INT. */
  58     {"1",   E_IPCOMMAND},
  59 /* VI_C_TOP     13      /* Cursor to top. */
  60     {"",    E_IPCOMMAND},
  61 /* VI_C_UP              14      /* Cursor up N lines: IPO_INT. */
  62     {"1",   E_IPCOMMAND},
  63 /* VI_EDIT              15      /* Edit a file: IPO_STR. */
  64     {"a",   E_IPCOMMAND},
  65 /* VI_EDITOPT   16      /* Edit option: 2 * IPO_STR, IPO_INT. */
  66     {"ab1", E_IPCOMMAND},
  67 /* VI_EDITSPLIT 17      /* Split to a file: IPO_STR. */
  68     {"a",   E_IPCOMMAND},
  69 /* VI_EOF               18      /* End of input (NOT ^D). */
  70     {"",    E_EOF},
  71 /* VI_ERR               19      /* Input error. */
  72     {"",    E_ERR},
  73 /* VI_FLAGS         Flags */
  74     {"1",   E_FLAGS},
  75 /* VI_INTERRUPT 20      /* Interrupt. */
  76     {"",    E_INTERRUPT},
  77 /* VI_MOUSE_MOVE        21      /* Mouse click move: IPO_INT, IPO_INT. */
  78     {"12",  E_IPCOMMAND},
  79 /* VI_QUIT              22      /* Quit. */
  80     {"",    E_IPCOMMAND},
  81 /* VI_RESIZE        Screen resize: IPO_INT, IPO_INT. */
  82     {"12",  E_WRESIZE},
  83 /* VI_SEL_END   24      /* Select end: IPO_INT, IPO_INT. */
  84     {"12",  E_IPCOMMAND},
  85 /* VI_SEL_START 25      /* Select start: IPO_INT, IPO_INT. */
  86     {"12",  E_IPCOMMAND},
  87 /* VI_SIGHUP    26      /* SIGHUP. */
  88     {"",    E_SIGHUP},
  89 /* VI_SIGTERM   27      /* SIGTERM. */
  90     {"",    E_SIGTERM},
  91 /* VI_STRING        Input string: IPO_STR. */
  92     {"a",   E_STRING},
  93 /* VI_TAG               29      /* Tag. */
  94     {"",    E_IPCOMMAND},
  95 /* VI_TAGAS     30      /* Tag to a string: IPO_STR. */
  96     {"a",   E_IPCOMMAND},
  97 /* VI_TAGSPLIT  31      /* Split to a tag. */
  98     {"",    E_IPCOMMAND},
  99 /* VI_UNDO              32      /* Undo. */
 100     {"",    E_IPCOMMAND},
 101 /* VI_WQ                33      /* Write and quit. */
 102     {"",    E_IPCOMMAND},
 103 /* VI_WRITE     34      /* Write. */
 104     {"",    E_IPCOMMAND},
 105 /* VI_WRITEAS   35      /* Write as another file: IPO_STR. */
 106     {"a",   E_IPCOMMAND},
 107 /* VI_EVENT_SUP */
 108 };
 109
 110 typedef enum { INP_OK=0, INP_EOF, INP_ERR, INP_TIMEOUT } input_t;
 111
 112 static input_t  ip_read __P((SCR *, IP_PRIVATE *, struct timeval *, int, int*));
 113 static int      ip_resize __P((SCR *, u_int32_t, u_int32_t));
 114 static int      ip_trans __P((SCR *, IP_PRIVATE *, EVENT *));
 115
 116 /*
 117  * ip_event --
 118  *      Return a single event.
 119  *
 120  * PUBLIC: int ip_event __P((SCR *, EVENT *, u_int32_t, int));
 121  */
 122 int
 123 ip_event(SCR *sp, EVENT *evp, u_int32_t flags, int ms)
 124 {
 125         return ip_wevent(sp->wp, sp, evp, flags, ms);
 126 }
 127
 128 /*
 129  * XXX probably better to require new_window to send size
 130  *     so we never have to call ip_wevent with sp == NULL
 131  *
 132  * ip_wevent --
 133  *      Return a single event.
 134  *
 135  * PUBLIC: int ip_wevent __P((WIN *, SCR *, EVENT *, u_int32_t, int));
 136  */
 137 int
 138 ip_wevent(WIN *wp, SCR *sp, EVENT *evp, u_int32_t flags, int ms)
 139 {
 140         IP_PRIVATE *ipp;
 141         struct timeval t, *tp;
 142         int termread;
 143         int nr;
 144
 145         if (LF_ISSET(EC_INTERRUPT)) {           /* XXX */
 146                 evp->e_event = E_TIMEOUT;
 147                 return (0);
 148         }
 149
 150         ipp = sp == NULL ? WIPP(wp) : IPP(sp);
 151
 152         /* Discard the last command. */
 153         if (ipp->iskip != 0) {
 154                 ipp->iblen -= ipp->iskip;
 155                 memmove(ipp->ibuf, ipp->ibuf + ipp->iskip, ipp->iblen);
 156                 ipp->iskip = 0;
 157         }
 158
 159         termread = F_ISSET(ipp, IP_IN_EX) ||
 160                     (sp && F_ISSET(sp, SC_SCR_EXWROTE));
 161
 162         /* Process possible remaining commands */
 163         if (!termread && ipp->iblen >= IPO_CODE_LEN && ip_trans(sp, ipp, evp))
 164                 return 0;
 165
 166         /* Set timer. */
 167         if (ms == 0)
 168                 tp = NULL;
 169         else {
 170                 t.tv_sec = ms / 1000;
 171                 t.tv_usec = (ms % 1000) * 1000;
 172                 tp = &t;
 173         }
 174
 175         /* Read input events. */
 176         for (;;) {
 177                 switch (ip_read(sp, ipp, tp, termread, &nr)) {
 178                 case INP_OK:
 179                         if (termread) {
 180                                 evp->e_csp = ipp->tbuf;
 181                                 evp->e_len = nr;
 182                                 evp->e_event = E_STRING;
 183                         } else if (!ip_trans(sp, ipp, evp))
 184                                 continue;
 185                         break;
 186                 case INP_EOF:
 187                         evp->e_event = E_EOF;
 188                         break;
 189                 case INP_ERR:
 190                         evp->e_event = E_ERR;
 191                         break;
 192                 case INP_TIMEOUT:
 193                         evp->e_event = E_TIMEOUT;
 194                         break;
 195                 default:
 196                         abort();
 197                 }
 198                 break;
 199         }
 200         return (0);
 201 }
 202
 203 /*
 204  * ip_read --
 205  *      Read characters from the input.
 206  */
 207 static input_t
 208 ip_read(SCR *sp, IP_PRIVATE *ipp, struct timeval *tp, int termread, int *nr)
 209 {
 210         struct timeval poll;
 211         GS *gp;
 212         fd_set rdfd;
 213         input_t rval;
 214         size_t blen;
 215         int maxfd;
 216         char *bp;
 217         int fd;
 218         CHAR_T *wp;
 219         size_t wlen;
 220
 221         gp = sp == NULL ? __global_list : sp->gp;
 222         bp = ipp->ibuf + ipp->iblen;
 223         blen = sizeof(ipp->ibuf) - ipp->iblen;
 224         fd = termread ? ipp->t_fd : ipp->i_fd;
 225
 226         /*
 227          * 1: A read with an associated timeout, e.g., trying to complete
 228          *    a map sequence.  If input exists, we fall into #2.
 229          */
 230         FD_ZERO(&rdfd);
 231         poll.tv_sec = 0;
 232         poll.tv_usec = 0;
 233         if (tp != NULL) {
 234                 FD_SET(fd, &rdfd);
 235                 switch (select(fd + 1,
 236                     &rdfd, NULL, NULL, tp == NULL ? &poll : tp)) {
 237                 case 0:
 238                         return (INP_TIMEOUT);
 239                 case -1:
 240                         goto err;
 241                 default:
 242                         break;
 243                 }
 244         }
 245
 246         /*
 247          * 2: Wait for input.
 248          *
 249          * Select on the command input and scripting window file descriptors.
 250          * It's ugly that we wait on scripting file descriptors here, but it's
 251          * the only way to keep from locking out scripting windows.
 252          */
 253         if (sp != NULL && F_ISSET(gp, G_SCRWIN)) {
 254                 FD_ZERO(&rdfd);
 255                 FD_SET(fd, &rdfd);
 256                 maxfd = fd;
 257                 if (sscr_check_input(sp, &rdfd, maxfd))
 258                         goto err;
 259         }
 260
 261         /*
 262          * 3: Read the input.
 263          */
 264         switch (*nr = read(fd, termread ? (char *)ipp->tbuf : bp,
 265                               termread ? sizeof(ipp->tbuf)/sizeof(CHAR_T)
 266                                        : blen)) {
 267         case  0:                                /* EOF. */
 268                 rval = INP_EOF;
 269                 break;
 270         case -1:                                /* Error or interrupt. */
 271 err:            rval = INP_ERR;
 272                 msgq(sp, M_SYSERR, "input");
 273                 break;
 274         default:                                /* Input characters. */
 275                 if (!termread) ipp->iblen += *nr;
 276                 else {
 277                         CHAR2INT(sp, (char *)ipp->tbuf, *nr, wp, wlen);
 278                         MEMMOVEW(ipp->tbuf, wp, wlen);
 279                 }
 280                 rval = INP_OK;
 281                 break;
 282         }
 283         return (rval);
 284 }
 285
 286 /*
 287  * ip_trans --
 288  *      Translate messages into events.
 289  */
 290 static int
 291 ip_trans(SCR *sp, IP_PRIVATE *ipp, EVENT *evp)
 292 {
 293         u_int32_t skip, val;
 294         char *fmt;
 295         CHAR_T *wp;
 296         size_t wlen;
 297
 298         if (ipp->ibuf[0] == CODE_OOB ||
 299             ipp->ibuf[0] >= VI_EVENT_SUP)
 300         {
 301                 /*
 302                  * XXX: Protocol is out of sync?
 303                  */
 304                 abort();
 305         }
 306         fmt = vipfuns[ipp->ibuf[0]-1].format;
 307         evp->e_event = vipfuns[ipp->ibuf[0]-1].e_event;
 308         evp->e_ipcom = ipp->ibuf[0];
 309
 310         for (skip = IPO_CODE_LEN; *fmt != '\0'; ++fmt)
 311                 switch (*fmt) {
 312                 case '1':
 313                 case '2':
 314                         if (ipp->iblen < skip + IPO_INT_LEN)
 315                                 return (0);
 316                         memcpy(&val, ipp->ibuf + skip, IPO_INT_LEN);
 317                         val = ntohl(val);
 318                         if (*fmt == '1')
 319                                 evp->e_val1 = val;
 320                         else
 321                                 evp->e_val2 = val;
 322                         skip += IPO_INT_LEN;
 323                         break;
 324                 case 'a':
 325                 case 'b':
 326                         if (ipp->iblen < skip + IPO_INT_LEN)
 327                                 return (0);
 328                         memcpy(&val, ipp->ibuf + skip, IPO_INT_LEN);
 329                         val = ntohl(val);
 330                         skip += IPO_INT_LEN;
 331                         if (ipp->iblen < skip + val)
 332                                 return (0);
 333                         if (*fmt == 'a') {
 334                                 CHAR2INT(sp, ipp->ibuf + skip, val,
 335                                          wp, wlen);
 336                                 MEMCPYW(ipp->tbuf, wp, wlen);
 337                                 evp->e_str1 = ipp->tbuf;
 338                                 evp->e_len1 = wlen;
 339                         } else {
 340                                 CHAR2INT(sp, ipp->ibuf + skip, val,
 341                                          wp, wlen);
 342                                 MEMCPYW(ipp->tbuf, wp, wlen);
 343                                 evp->e_str2 = ipp->tbuf;
 344                                 evp->e_len2 = wlen;
 345                         }
 346                         skip += val;
 347                         break;
 348                 }
 349
 350         ipp->iskip = skip;
 351
 352         if (evp->e_event == E_WRESIZE)
 353                 (void)ip_resize(sp, evp->e_val1, evp->e_val2);
 354
 355         return (1);
 356 }
 357
 358 /*
 359  * ip_resize --
 360  *      Reset the options for a resize event.
 361  */
 362 static int
 363 ip_resize(SCR *sp, u_int32_t lines, u_int32_t columns)
 364 {
 365         GS *gp;
 366         int rval;
 367
 368         /*
 369          * XXX
 370          * The IP screen has to know the lines and columns before anything
 371          * else happens.  So, we may not have a valid SCR pointer, and we
 372          * have to deal with that.
 373          */
 374         if (sp == NULL) {
 375                 gp = __global_list;
 376                 OG_VAL(gp, GO_LINES) = OG_D_VAL(gp, GO_LINES) = lines;
 377                 OG_VAL(gp, GO_COLUMNS) = OG_D_VAL(gp, GO_COLUMNS) = columns;
 378                 return (0);
 379         }
 380
 381         rval = api_opts_set(sp, L("lines"), NULL, lines, 0);
 382         if (api_opts_set(sp, L("columns"), NULL, columns, 0))
 383                 rval = 1;
 384         return (rval);
 385 }