input.c 12 KB
Newer Older
unknown's avatar
unknown committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* input.c -- character input functions for readline. */

/* Copyright (C) 1994 Free Software Foundation, Inc.

   This file is part of the GNU Readline Library, a library for
   reading lines of text with interactive input and history editing.

   The GNU Readline Library is free software; you can redistribute it
   and/or modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; either version 2, or
   (at your option) any later version.

   The GNU Readline Library is distributed in the hope that it will be
   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   The GNU General Public License is often shipped with GNU software, and
   is generally kept in a file called COPYING or LICENSE.  If you do not
   have a copy of the license, write to the Free Software Foundation,
unknown's avatar
unknown committed
21
   59 Temple Place, Suite 330, Boston, MA 02111 USA. */
unknown's avatar
unknown committed
22 23
#define READLINE_LIBRARY

24 25 26 27
#if defined (__TANDEM)
#  include <floss.h>
#endif

28
#include "config_readline.h"
unknown's avatar
unknown committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

#include <sys/types.h>
#include <fcntl.h>
#if defined (HAVE_SYS_FILE_H)
#  include <sys/file.h>
#endif /* HAVE_SYS_FILE_H */

#if defined (HAVE_UNISTD_H)
#  include <unistd.h>
#endif /* HAVE_UNISTD_H */

#if defined (HAVE_STDLIB_H)
#  include <stdlib.h>
#else
#  include "ansi_stdlib.h"
#endif /* HAVE_STDLIB_H */

#if defined (HAVE_SELECT)
unknown's avatar
unknown committed
47
#  if !defined (HAVE_SYS_SELECT_H) || !defined (M_UNIX)
unknown's avatar
unknown committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
#    include <sys/time.h>
#  endif
#endif /* HAVE_SELECT */
#if defined (HAVE_SYS_SELECT_H)
#  include <sys/select.h>
#endif

#if defined (FIONREAD_IN_SYS_IOCTL)
#  include <sys/ioctl.h>
#endif

#include <stdio.h>
#include <errno.h>

#if !defined (errno)
extern int errno;
#endif /* !errno */

/* System-specific feature definitions and include files. */
#include "rldefs.h"
unknown's avatar
unknown committed
68
#include "rlmbutil.h"
unknown's avatar
unknown committed
69 70 71 72

/* Some standard library routines. */
#include "readline.h"

unknown's avatar
unknown committed
73 74 75 76
#include "rlprivate.h"
#include "rlshell.h"
#include "xmalloc.h"

unknown's avatar
unknown committed
77 78 79 80 81 82 83
/* What kind of non-blocking I/O do we have? */
#if !defined (O_NDELAY) && defined (O_NONBLOCK)
#  define O_NDELAY O_NONBLOCK	/* Posix style */
#endif

/* Non-null means it is a pointer to a function to run while waiting for
   character input. */
unknown's avatar
unknown committed
84 85 86
rl_hook_func_t *rl_event_hook = (rl_hook_func_t *)NULL;

rl_getc_func_t *rl_getc_function = rl_getc;
unknown's avatar
unknown committed
87

unknown's avatar
unknown committed
88 89 90 91 92
static int _keyboard_input_timeout = 100000;		/* 0.1 seconds; it's in usec */

static int ibuffer_space PARAMS((void));
static int rl_get_char PARAMS((int *));
static int rl_gather_tyi PARAMS((void));
unknown's avatar
unknown committed
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143

/* **************************************************************** */
/*								    */
/*			Character Input Buffering       	    */
/*								    */
/* **************************************************************** */

static int pop_index, push_index;
static unsigned char ibuffer[512];
static int ibuffer_len = sizeof (ibuffer) - 1;

#define any_typein (push_index != pop_index)

int
_rl_any_typein ()
{
  return any_typein;
}

/* Return the amount of space available in the buffer for stuffing
   characters. */
static int
ibuffer_space ()
{
  if (pop_index > push_index)
    return (pop_index - push_index - 1);
  else
    return (ibuffer_len - (push_index - pop_index));
}

/* Get a key from the buffer of characters to be read.
   Return the key in KEY.
   Result is KEY if there was a key, or 0 if there wasn't. */
static int
rl_get_char (key)
     int *key;
{
  if (push_index == pop_index)
    return (0);

  *key = ibuffer[pop_index++];

  if (pop_index >= ibuffer_len)
    pop_index = 0;

  return (1);
}

/* Stuff KEY into the *front* of the input buffer.
   Returns non-zero if successful, zero if there is
   no space left in the buffer. */
unknown's avatar
unknown committed
144 145
int
_rl_unget_char (key)
unknown's avatar
unknown committed
146 147 148 149 150 151 152 153 154 155 156 157 158
     int key;
{
  if (ibuffer_space ())
    {
      pop_index--;
      if (pop_index < 0)
	pop_index = ibuffer_len - 1;
      ibuffer[pop_index] = key;
      return (1);
    }
  return (0);
}

159 160 161 162 163 164
int
_rl_pushed_input_available ()
{
  return (push_index != pop_index);
}

unknown's avatar
unknown committed
165 166 167 168
/* If a character is available to be read, then read it and stuff it into
   IBUFFER.  Otherwise, just return.  Returns number of characters read
   (0 if none available) and -1 on error (EIO). */
static int
unknown's avatar
unknown committed
169 170 171 172
rl_gather_tyi ()
{
  int tty;
  register int tem, result;
173
  int chars_avail, k;
unknown's avatar
unknown committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187
  char input;
#if defined(HAVE_SELECT)
  fd_set readfds, exceptfds;
  struct timeval timeout;
#endif

  tty = fileno (rl_instream);

#if defined (HAVE_SELECT)
  FD_ZERO (&readfds);
  FD_ZERO (&exceptfds);
  FD_SET (tty, &readfds);
  FD_SET (tty, &exceptfds);
  timeout.tv_sec = 0;
unknown's avatar
unknown committed
188 189 190 191
  timeout.tv_usec = _keyboard_input_timeout;
  result = select (tty + 1, &readfds, (fd_set *)NULL, &exceptfds, &timeout);
  if (result <= 0)
    return 0;	/* Nothing to read. */
unknown's avatar
unknown committed
192 193 194 195
#endif

  result = -1;
#if defined (FIONREAD)
unknown's avatar
unknown committed
196
  errno = 0;
unknown's avatar
unknown committed
197
  result = ioctl (tty, FIONREAD, &chars_avail);
unknown's avatar
unknown committed
198 199
  if (result == -1 && errno == EIO)
    return -1;
unknown's avatar
unknown committed
200 201 202 203 204 205 206 207 208 209 210 211
#endif

#if defined (O_NDELAY)
  if (result == -1)
    {
      tem = fcntl (tty, F_GETFL, 0);

      fcntl (tty, F_SETFL, (tem | O_NDELAY));
      chars_avail = read (tty, &input, 1);

      fcntl (tty, F_SETFL, tem);
      if (chars_avail == -1 && errno == EAGAIN)
unknown's avatar
unknown committed
212
	return 0;
213 214 215 216 217
      if (chars_avail == 0)	/* EOF */
	{
	  rl_stuff_char (EOF);
	  return (0);
	}
unknown's avatar
unknown committed
218 219 220 221 222 223
    }
#endif /* O_NDELAY */

  /* If there's nothing available, don't waste time trying to read
     something. */
  if (chars_avail <= 0)
unknown's avatar
unknown committed
224
    return 0;
unknown's avatar
unknown committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

  tem = ibuffer_space ();

  if (chars_avail > tem)
    chars_avail = tem;

  /* One cannot read all of the available input.  I can only read a single
     character at a time, or else programs which require input can be
     thwarted.  If the buffer is larger than one character, I lose.
     Damn! */
  if (tem < ibuffer_len)
    chars_avail = 0;

  if (result != -1)
    {
      while (chars_avail--)
241 242 243 244 245 246
	{
	  k = (*rl_getc_function) (rl_instream);
	  rl_stuff_char (k);
	  if (k == NEWLINE || k == RETURN)
	    break;
	}
unknown's avatar
unknown committed
247 248 249 250 251 252
    }
  else
    {
      if (chars_avail)
	rl_stuff_char (input);
    }
unknown's avatar
unknown committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266

  return 1;
}

int
rl_set_keyboard_input_timeout (u)
     int u;
{
  int o;

  o = _keyboard_input_timeout;
  if (u > 0)
    _keyboard_input_timeout = u;
  return (o);
unknown's avatar
unknown committed
267 268 269
}

/* Is there input available to be read on the readline input file
unknown's avatar
unknown committed
270 271 272 273 274
   descriptor?  Only works if the system has select(2) or FIONREAD.
   Uses the value of _keyboard_input_timeout as the timeout; if another
   readline function wants to specify a timeout and not leave it up to
   the user, it should use _rl_input_queued(timeout_value_in_microseconds)
   instead. */
unknown's avatar
unknown committed
275 276 277 278 279 280 281
int
_rl_input_available ()
{
#if defined(HAVE_SELECT)
  fd_set readfds, exceptfds;
  struct timeval timeout;
#endif
unknown's avatar
unknown committed
282
#if !defined (HAVE_SELECT) && defined(FIONREAD)
unknown's avatar
unknown committed
283 284 285 286 287 288 289 290 291 292 293 294
  int chars_avail;
#endif
  int tty;

  tty = fileno (rl_instream);

#if defined (HAVE_SELECT)
  FD_ZERO (&readfds);
  FD_ZERO (&exceptfds);
  FD_SET (tty, &readfds);
  FD_SET (tty, &exceptfds);
  timeout.tv_sec = 0;
unknown's avatar
unknown committed
295
  timeout.tv_usec = _keyboard_input_timeout;
unknown's avatar
unknown committed
296
  return (select (tty + 1, &readfds, (fd_set *)NULL, &exceptfds, &timeout) > 0);
unknown's avatar
unknown committed
297
#else
unknown's avatar
unknown committed
298 299 300 301 302

#if defined (FIONREAD)
  if (ioctl (tty, FIONREAD, &chars_avail) == 0)
    return (chars_avail);
#endif
unknown's avatar
unknown committed
303 304

#endif
unknown's avatar
unknown committed
305 306 307 308

  return 0;
}

unknown's avatar
unknown committed
309 310 311 312 313 314 315 316 317 318 319 320
int
_rl_input_queued (t)
     int t;
{
  int old_timeout, r;

  old_timeout = rl_set_keyboard_input_timeout (t);
  r = _rl_input_available ();
  rl_set_keyboard_input_timeout (old_timeout);
  return r;
}

unknown's avatar
unknown committed
321 322 323
void
_rl_insert_typein (c)
     int c;     
unknown's avatar
unknown committed
324
{    	
unknown's avatar
unknown committed
325 326 327 328
  int key, t, i;
  char *string;

  i = key = 0;
unknown's avatar
unknown committed
329
  string = (char *)xmalloc (ibuffer_len + 1);
unknown's avatar
unknown committed
330 331 332 333 334 335 336 337
  string[i++] = (char) c;

  while ((t = rl_get_char (&key)) &&
	 _rl_keymap[key].type == ISFUNC &&
	 _rl_keymap[key].function == rl_insert)
    string[i++] = key;

  if (t)
unknown's avatar
unknown committed
338
    _rl_unget_char (key);
unknown's avatar
unknown committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357

  string[i] = '\0';
  rl_insert_text (string);
  free (string);
}

/* Add KEY to the buffer of characters to be read.  Returns 1 if the
   character was stuffed correctly; 0 otherwise. */
int
rl_stuff_char (key)
     int key;
{
  if (ibuffer_space () == 0)
    return 0;

  if (key == EOF)
    {
      key = NEWLINE;
      rl_pending_input = EOF;
unknown's avatar
unknown committed
358
      RL_SETSTATE (RL_STATE_INPUTPENDING);
unknown's avatar
unknown committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372
    }
  ibuffer[push_index++] = key;
  if (push_index >= ibuffer_len)
    push_index = 0;

  return 1;
}

/* Make C be the next command to be executed. */
int
rl_execute_next (c)
     int c;
{
  rl_pending_input = c;
unknown's avatar
unknown committed
373 374 375 376 377 378 379 380 381 382
  RL_SETSTATE (RL_STATE_INPUTPENDING);
  return 0;
}

/* Clear any pending input pushed with rl_execute_next() */
int
rl_clear_pending_input ()
{
  rl_pending_input = 0;
  RL_UNSETSTATE (RL_STATE_INPUTPENDING);
unknown's avatar
unknown committed
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
  return 0;
}

/* **************************************************************** */
/*								    */
/*			     Character Input			    */
/*								    */
/* **************************************************************** */

/* Read a key, including pending input. */
int
rl_read_key ()
{
  int c;

  rl_key_sequence_length++;

  if (rl_pending_input)
    {
      c = rl_pending_input;
unknown's avatar
unknown committed
403
      rl_clear_pending_input ();
unknown's avatar
unknown committed
404 405 406 407
    }
  else
    {
      /* If input is coming from a macro, then use that. */
408
      if (c = _rl_next_macro_key ())
unknown's avatar
unknown committed
409 410 411 412 413 414 415 416
	return (c);

      /* If the user has an event function, then call it periodically. */
      if (rl_event_hook)
	{
	  while (rl_event_hook && rl_get_char (&c) == 0)
	    {
	      (*rl_event_hook) ();
unknown's avatar
unknown committed
417 418 419 420 421 422 423
	      if (rl_done)		/* XXX - experimental */
		return ('\n');
	      if (rl_gather_tyi () < 0)	/* XXX - EIO */
		{
		  rl_done = 1;
		  return ('\n');
		}
unknown's avatar
unknown committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
	    }
	}
      else
	{
	  if (rl_get_char (&c) == 0)
	    c = (*rl_getc_function) (rl_instream);
	}
    }

  return (c);
}

int
rl_getc (stream)
     FILE *stream;
{
unknown's avatar
unknown committed
440
  int result;
unknown's avatar
unknown committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
  unsigned char c;

  while (1)
    {
      result = read (fileno (stream), &c, sizeof (unsigned char));

      if (result == sizeof (unsigned char))
	return (c);

      /* If zero characters are returned, then the file that we are
	 reading from is empty!  Return EOF in that case. */
      if (result == 0)
	return (EOF);

#if defined (__BEOS__)
      if (errno == EINTR)
	continue;
#endif

#if defined (EWOULDBLOCK)
unknown's avatar
unknown committed
461 462 463 464 465 466 467 468 469 470 471 472
#  define X_EWOULDBLOCK EWOULDBLOCK
#else
#  define X_EWOULDBLOCK -99
#endif

#if defined (EAGAIN)
#  define X_EAGAIN EAGAIN
#else
#  define X_EAGAIN -99
#endif

      if (errno == X_EWOULDBLOCK || errno == X_EAGAIN)
unknown's avatar
unknown committed
473
	{
unknown's avatar
unknown committed
474
	  if (sh_unset_nodelay_mode (fileno (stream)) < 0)
unknown's avatar
unknown committed
475 476 477 478
	    return (EOF);
	  continue;
	}

unknown's avatar
unknown committed
479 480
#undef X_EWOULDBLOCK
#undef X_EAGAIN
unknown's avatar
unknown committed
481 482 483 484 485 486 487 488

      /* If the error that we received was SIGINT, then try again,
	 this is simply an interrupted system call to read ().
	 Otherwise, some error ocurred, also signifying EOF. */
      if (errno != EINTR)
	return (EOF);
    }
}
unknown's avatar
unknown committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558

#if defined (HANDLE_MULTIBYTE)
/* read multibyte char */
int
_rl_read_mbchar (mbchar, size)
     char *mbchar;
     int size;
{
  int mb_len = 0;
  size_t mbchar_bytes_length;
  wchar_t wc;
  mbstate_t ps, ps_back;

  memset(&ps, 0, sizeof (mbstate_t));
  memset(&ps_back, 0, sizeof (mbstate_t));
  
  while (mb_len < size)
    {
      RL_SETSTATE(RL_STATE_MOREINPUT);
      mbchar[mb_len++] = rl_read_key ();
      RL_UNSETSTATE(RL_STATE_MOREINPUT);

      mbchar_bytes_length = mbrtowc (&wc, mbchar, mb_len, &ps);
      if (mbchar_bytes_length == (size_t)(-1))
	break;		/* invalid byte sequence for the current locale */
      else if (mbchar_bytes_length == (size_t)(-2))
	{
	  /* shorted bytes */
	  ps = ps_back;
	  continue;
	} 
      else if (mbchar_bytes_length > (size_t)(0))
	break;
    }

  return mb_len;
}

/* Read a multibyte-character string whose first character is FIRST into
   the buffer MB of length MBLEN.  Returns the last character read, which
   may be FIRST.  Used by the search functions, among others.  Very similar
   to _rl_read_mbchar. */
int
_rl_read_mbstring (first, mb, mblen)
     int first;
     char *mb;
     int mblen;
{
  int i, c;
  mbstate_t ps;

  c = first;
  memset (mb, 0, mblen);
  for (i = 0; i < mblen; i++)
    {
      mb[i] = (char)c;
      memset (&ps, 0, sizeof (mbstate_t));
      if (_rl_get_char_len (mb, &ps) == -2)
	{
	  /* Read more for multibyte character */
	  RL_SETSTATE (RL_STATE_MOREINPUT);
	  c = rl_read_key ();
	  RL_UNSETSTATE (RL_STATE_MOREINPUT);
	}
      else
	break;
    }
  return c;
}
#endif /* HANDLE_MULTIBYTE */