MirOS Manual: curs_util(3), delay_output(3), filter(3), flushinp(3), getwin(3), keyname(3), key_name(3), putwin(3), unctrl(3), use_env(3), wunctrl(3)


curs_util(3)        UNIX Programmer's Manual         curs_util(3)

NAME

     delay_output, filter, flushinp, getwin, key_name, keyname,
     putwin, unctrl, use_env, wunctrl - miscellaneous curses
     utility routines

SYNOPSIS

     #include <curses.h>

     char *unctrl(chtype c);
     char *wunctrl(cchar_t *c);
     char *keyname(int c);
     char *key_name(wchar_t w);
     void filter(void);
     void use_env(bool f);
     int putwin(WINDOW *win, FILE *filep);
     WINDOW *getwin(FILE *filep);
     int delay_output(int ms);
     int flushinp(void);

DESCRIPTION

     The unctrl routine returns a character  string  which  is  a
     printable representation of the character c, ignoring attri-
     butes. Control characters are displayed in the ^X  notation.
     Printing  characters  are displayed as is. The corresponding
     wunctrl  returns  a  printable  representation  of  a  wide-
     character.

     The keyname routine returns a character string corresponding
     to the key c. Control characters are displayed in the ^X no-
     tation. Values above 128 are either meta  characters,  shown
     in the M-X notation, or the names of function keys, or null.
     The  corresponding  key_name  returns  a  character   string
     corresponding  to  the wide-character value w. The two func-
     tions do not return the same set of strings; the latter  re-
     turns null where the former would display a meta character.

     The filter routine, if used, must be called  before  initscr
     or  newterm  are  called.   The effect is that, during those
     calls, LINES is set to 1; the capabilities clear, cup,  cud,
     cud1,  cuu1,  cuu,  vpa are disabled; and the home string is
     set to the value of cr.

     The use_env routine, if used, is called  before  initscr  or
     newterm  are called.  When called with FALSE as an argument,
     the values of lines and columns specified  in  the  terminfo
     database  will  be used, even if environment variables LINES
     and COLUMNS (used by default) are set, or if curses is  run-
     ning in a window (in which case default behavior would be to
     use the window size if LINES and COLUMNS are not set).  Note
     that  setting  LINES  or COLUMNS overrides the corresponding
     size which may be obtained from the operating system.

MirOS BSD #10-current  Printed 03.04.2017                       1

curs_util(3)        UNIX Programmer's Manual         curs_util(3)

     The putwin routine writes all data  associated  with  window
     win  into  the file to which filep points.  This information
     can be later retrieved using the getwin function.

     The getwin routine reads window related data stored  in  the
     file  by putwin.  The routine then creates and initializes a
     new window using that data.  It returns a pointer to the new
     window.

     The delay_output routine inserts an ms millisecond pause  in
     output.  This routine should not be used extensively because
     padding characters are used rather than a CPU pause.  If  no
     padding  character  is specified, this uses napms to perform
     the delay.

     The flushinp routine throws away any typeahead that has been
     typed by the user and has not yet been read by the program.

RETURN VALUE

     Except for flushinp, routines that return an integer  return
     ERR  upon  failure  and  OK (SVr4 specifies only "an integer
     value other than ERR") upon successful completion.

     Routines that return pointers return NULL on error.

     X/Open does not define any error conditions. In this  imple-
     mentation

          flushinp
               returns an error if the terminal was not  initial-
               ized.

          putwin
               returns an error if the  associated  fwrite  calls
               return an error.

PORTABILITY

     The XSI Curses standard, Issue 4 describes these  functions.
     It states that unctrl and wunctrl will return a null pointer
     if unsuccessful, but does not define any error conditions.

     The SVr4 documentation describes the action of  filter  only
     in  the vaguest terms.  The description here is adapted from
     the XSI Curses standard (which erroneously fails to describe
     the disabling of cuu).

     The strings returned by unctrl in  this  implementation  are
     determined  at  compile  time,  showing C1 controls from the
     upper-128 codes with a `~' prefix rather than `^'. Other im-
     plementations typically show both sets of control characters
     with `^', and may strip the parameter to 7 bits. This imple-
     mentation  uses 8 bits but does not modify the string to re-

MirOS BSD #10-current  Printed 03.04.2017                       2

curs_util(3)        UNIX Programmer's Manual         curs_util(3)

     flect locale.

     The keyname function may return the  names  of  user-defined
     string  capabilities which are defined in the terminfo entry
     via the -x option of tic.

SEE ALSO

     curses(3),         curs_initscr(3),          curs_kernel(3),
     curs_scr_dump(3).

MirOS BSD #10-current  Printed 03.04.2017                       3

Generated on 2017-04-03 16:26:17 by $MirOS: src/scripts/roff2htm,v 1.88 2017/01/29 00:51:06 tg Exp $

These manual pages and other documentation are copyrighted by their respective writers; their source is available at our CVSweb, AnonCVS, and other mirrors. The rest is Copyright © 2002–2017 The MirOS Project, Germany.
This product includes material provided by mirabilos.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.