input.h

Low and high-level user input functions.

This header defines low-, medium- and high-level functions to acquire and validate input from the user. These functions do all sorts of weird and wonderful things with the user's input.

Thankfully, despite the wealth of functionality you can find here, getting input from the user is a straightforward thing in most cases. The most complex API is that of the concatenated command parser, and it really should be made simpler (read: transparent).

Original banner, legalese and change history follow.

 *****************************************************************************
 **                                                                         **
 **  FILE:     input.h                                                      **
 **  AUTHORS:  Alexios                                                      **
 **  REVISION: A, June 94                                                   **
 **  PURPOSE:  Interface to input.c                                         **
 **  NOTES:                                                                 **
 **  LEGALESE:                                                              **
 **                                                                         **
 **  This program 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 of the License, or (at  **
 **  your option) any later version.                                        **
 **                                                                         **
 **  This program 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.                               **
 **                                                                         **
 **  You  should have received a copy   of the GNU  General Public License  **
 **  along with    this program;  if   not, write  to  the   Free Software  **
 **  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.              **
 **                                                                         **
 *****************************************************************************


 *
 * $Id: input.h,v 1.3 2001/04/22 14:49:04 alexios Exp $
 *
 * $Log: input.h,v $
 * Revision 1.3  2001/04/22 14:49:04  alexios
 * Merged in leftover 0.99.2 changes and additional bug fixes.
 *
 * Revision 0.8  1999/07/28 23:09:07  alexios
 * *** empty log message ***
 *
 * Revision 0.7  1999/07/18 21:13:24  alexios
 * Made inputflags public to allow for user-supplied high
 * level input functions.
 *
 * Revision 0.6  1998/12/27 15:19:19  alexios
 * Moved function declarations from miscfx.h.
 *
 * Revision 0.5  1998/08/14 11:23:21  alexios
 * Added function to set monitor ID (initially channel number,
 * but user's user ID after login).
 *
 * Revision 0.4  1998/07/26 21:17:06  alexios
 * Removed obsoleted extern injothfile.
 *
 * Revision 0.3  1997/11/06 20:03:39  alexios
 * Added GPL legalese to the top of this file.
 *
 * Revision 0.2  1997/09/12 12:45:25  alexios
 * Added resetblocking() to remember previous states of block-
 * ing/non-blocking and switch between them.
 *
 * Revision 0.1  1997/08/26 15:48:53  alexios
 * First registered revision. Adequate.
 *
 *
 *

Input flags

Input flags.

inp_flags

The input flags.

inp_buffer

User's input buffer (sized MAXINPLEN).

inp_len

Length of user's last input line.

margv

Input arguments, no spaces, argv[]-style

margc

Number of input arguments passed, in argc style

inp_del

The backspace-space-backspace sequence

*monitor

Monitoring structure

inp_init

Initialise input subsystem.

inp_done

Shutdown input system.

inp_acceptinjoth

Display any queued injected messages.

inp_setmonitorid

Set tty or username for monitoring.

inp_monitor

Monitor a line.

inp_get

Mid-level input function.

inp_readstring

Low-level input function.

inp_parsin

Parse input.

inp_clear

Clear input buffers.

inp_raw

Restores raw input.

inp_timeout

Set user input timeout.

inp_cancel

Abort pending user input.

inp_setflags

Set input flags.

inp_clearflags

Set input flags.

Command concatenation

Processing multiple commands typed together.

inp_timeout_msecs

Last msecs argument to inp_timeout().

inp_timeout_intr

Last intrusive argument to inp_timeout().

inp_reprompt

Check if a reprompt is necessary.

inp_nonblock

Set non-blocking mode.

inp_block

Set blocking mode.

inp_resetblocking

Revert to previous blocking mode.

inp_setidle

Set user inactivity timeout.

inp_resetidle

Reset user inactivity timer.

inp_isX

Check for the eXit command.

User-interacting validation functions.

Very high-level input functionality.

Author:

Alexios

Alphabetic index