ncurses 5.8 - patch 20110226
[ncurses.git] / doc / html / man / curs_util.3x.html
index 46b73047c97b0a7d864e59248653d9dc57c047ef..8181efa432f386223c3e02ac29ab60a833f53ba9 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 <!-- 
   ****************************************************************************
-  * Copyright (c) 1998-2005,2006 Free Software Foundation, Inc.              *
+  * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc.              *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
@@ -27,7 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_util.3x,v 1.22 2006/12/24 14:55:31 tom Exp @
+  * @Id: curs_util.3x,v 1.32 2010/12/04 18:38:55 tom Exp @
 -->
 <HTML>
 <HEAD>
@@ -57,7 +57,7 @@
        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
        <STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG>
-       <STRONG>char</STRONG> <STRONG>*wunctrl(cchar_t</STRONG> <STRONG>*c);</STRONG>
+       <STRONG>wchar_t</STRONG> <STRONG>*wunctrl(cchar_t</STRONG> <STRONG>*c);</STRONG>
        <STRONG>char</STRONG> <STRONG>*keyname(int</STRONG> <STRONG>c);</STRONG>
        <STRONG>char</STRONG> <STRONG>*key_name(wchar_t</STRONG> <STRONG>w);</STRONG>
        <STRONG>void</STRONG> <STRONG>filter(void);</STRONG>
        tributes.   Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> no-
        tation.  Printing characters are  displayed  as  is.   The
        corresponding  <STRONG>wunctrl</STRONG>  returns a printable representation
-       of a wide-character.
+       of a wide character.
 
        The <STRONG>keyname</STRONG> routine returns a character string correspond-
-       ing to the key <EM>c</EM>.  Control characters are displayed in the
-       <STRONG>^</STRONG><EM>X</EM> notation.  Values above 128 are either meta characters,
-       shown  in the <STRONG>M-</STRONG><EM>X</EM> notation, or the names of function keys,
-       or null.  The corresponding <STRONG>key_name</STRONG> returns  a  character
-       string  corresponding  to the wide-character value <EM>w</EM>.  The
-       two functions do not return the same set of  strings;  the
-       latter  returns null where the former would display a meta
-       character.
+       ing to the key <EM>c</EM>:
+
+          <STRONG>o</STRONG>   Printable  characters  are displayed as themselves,
+              e.g., a one-character string containing the key.
+
+          <STRONG>o</STRONG>   Control characters are displayed in  the  <STRONG>^</STRONG><EM>X</EM>  nota-
+              tion.
+
+          <STRONG>o</STRONG>   DEL (character 127) is displayed as <STRONG>^?</STRONG>.
+
+          <STRONG>o</STRONG>   Values above 128 are either meta characters (if the
+              screen has not been initialized,  or  if  <STRONG>meta</STRONG>  has
+              been  called  with  a TRUE parameter), shown in the
+              <STRONG>M-</STRONG><EM>X</EM> notation, or are displayed as  themselves.   In
+              the  latter  case, the values may not be printable;
+              this follows the X/Open specification.
+
+          <STRONG>o</STRONG>   Values above 256 may be the names of the  names  of
+              function keys.
+
+          <STRONG>o</STRONG>   Otherwise  (if  there is no corresponding name) the
+              function returns null, to denote an error.   X/Open
+              also  lists  an  "UNKNOWN  KEY" return value, which
+              some implementations return rather than null.
+
+       The corresponding <STRONG>key_name</STRONG> returns a character string cor-
+       responding  to  the wide-character value <EM>w</EM>.  The two func-
+       tions do not return the same set of  strings;  the  latter
+       returns null where the former would display a meta charac-
+       ter.
 
        The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG>
        or  <STRONG>newterm</STRONG>  are called.  The effect is that, during those
        X/Open does not define any error conditions.  In this  im-
        plementation
 
-              <STRONG>flushinp</STRONG>
-                   returns  an error if the terminal was not ini-
-                   tialized.
+          <STRONG>flushinp</STRONG>
+               returns  an error if the terminal was not initial-
+               ized.
+
+          <STRONG>meta</STRONG> returns an error if the terminal was not  initial-
+               ized.
 
-              <STRONG>putwin</STRONG>
-                   returns an  error  if  the  associated  <STRONG>fwrite</STRONG>
-                   calls return an error.
+          <STRONG>putwin</STRONG>
+               returns  an  error  if the associated <STRONG>fwrite</STRONG> calls
+               return an error.
 
 
 </PRE>
 <H2>PORTABILITY</H2><PRE>
-       The  XSI  Curses  standard,  Issue 4 describes these func-
-       tions.  It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG>  will  return  a
-       null  pointer if unsuccessful, but does not define any er-
-       ror conditions.
+       The XSI Curses standard, Issue  4  describes  these  func-
+       tions.   It  states  that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a
+       null pointer if unsuccessful, but does not define any  er-
+       ror conditions.  This implementation checks for three cas-
+       es:
+
+          <STRONG>o</STRONG>   the parameter is a 7-bit US-ASCII  code.   This  is
+              the case that X/Open Curses documented.
+
+          <STRONG>o</STRONG>   the  parameter  is in the range 128-159, i.e., a C1
+              control code.  If <STRONG>use_legacy_coding</STRONG> has been called
+              with  a  <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG> returns the parameter,
+              i.e., a one-character string with the parameter  as
+              the first character.  Otherwise, it returns ``~@'',
+              ``~A'', etc., analogous to ``^@'', ``^A'', C0  con-
+              trols.
+
+              X/Open  Curses does not document whether <STRONG>unctrl</STRONG> can
+              be called before initializing curses.  This  imple-
+              mentation  permits  that,  and  returns the ``~@'',
+              etc., values in that case.
+
+          <STRONG>o</STRONG>   parameter values outside the 0 to 255 range.   <STRONG>unc-</STRONG>
+              <STRONG>trl</STRONG> returns a null pointer.
 
        The SVr4 documentation describes the action of <STRONG>filter</STRONG> only
-       in  the  vaguest  terms.   The description here is adapted
-       from the XSI Curses standard (which erroneously  fails  to
+       in the vaguest terms.  The  description  here  is  adapted
+       from  the  XSI Curses standard (which erroneously fails to
        describe the disabling of <STRONG>cuu</STRONG>).
 
-       The  strings returned by <STRONG>unctrl</STRONG> in this implementation are
-       determined at compile time, showing C1 controls  from  the
-       upper-128  codes with a `~' prefix rather than `^'.  Other
-       implementations have different conventions.  For  example,
-       they  may  show  both sets of control characters with `^',
-       and strip the parameter to 7 bits.  Or they may ignore  C1
-       controls  and  treat all of the upper-1280 codes as print-
+       The strings returned by <STRONG>unctrl</STRONG> in this implementation  are
+       determined  at  compile time, showing C1 controls from the
+       upper-128 codes with a `~' prefix rather than `^'.   Other
+       implementations  have different conventions.  For example,
+       they may show both sets of control  characters  with  `^',
+       and  strip the parameter to 7 bits.  Or they may ignore C1
+       controls and treat all of the upper-128  codes  as  print-
        able.  This implementation uses 8 bits but does not modify
        the string to reflect locale.  The <STRONG>use_legacy_coding</STRONG> func-
        tion allows the caller to change the output of <STRONG>unctrl</STRONG>.
 
-       The <STRONG>keyname</STRONG> function may return the names of  user-defined
-       string  capabilities which are defined in the terminfo en-
-       try via the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>.  This  implementation  auto-
-       matically  assigns  at  run-time  keycodes to user-defined
-       strings which begin  with  "k".   The  keycodes  start  at
-       KEY_MAX,  but  are not guaranteed to be the same value for
-       different runs because user-defined codes are merged  from
-       all terminal descriptions which have been loaded.
+       Likewise,  the  <STRONG>meta</STRONG>  function allows the caller to change
+       the output of <STRONG>keyname</STRONG>, i.e., it determines whether to  use
+       the  `M-' prefix for ``meta'' keys (codes in the range 128
+       to 255).  Both <STRONG>use_legacy_coding</STRONG> and <STRONG>meta</STRONG> succeed only af-
+       ter  curses  is initialized.  X/Open Curses does not docu-
+       ment the treatment of codes 128  to  159.   When  treating
+       them as ``meta'' keys (or if <STRONG>keyname</STRONG> is called before ini-
+       tializing curses),  this  implementation  returns  strings
+       ``M-^@'', ``M-^A'', etc.
+
+       The  <STRONG>keyname</STRONG> function may return the names of user-defined
+       string capabilities which are defined in the terminfo  en-
+       try  via  the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>.  This implementation auto-
+       matically assigns at  run-time  keycodes  to  user-defined
+       strings  which  begin  with  "k".   The  keycodes start at
+       KEY_MAX, but are not guaranteed to be the same  value  for
+       different  runs because user-defined codes are merged from
+       all terminal descriptions which  have  been  loaded.   The
+       <STRONG>use_extended_names</STRONG>  function controls whether this data is
+       loaded when the terminal description is read  by  the  li-
+       brary.
 
        The  <STRONG>nofilter</STRONG>  routine is specific to ncurses.  It was not
        supported on Version 7, BSD or System  V  implementations.
 </PRE>
 <H2>SEE ALSO</H2><PRE>
        <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG>curs_ker-</STRONG>
-       <STRONG><A HREF="curs_kernel.3x.html">nel(3x)</A></STRONG>, <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>.
+       <STRONG><A HREF="curs_kernel.3x.html">nel(3x)</A></STRONG>,   <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>,   <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,  <STRONG>lega-</STRONG>
+       <STRONG><A HREF="legacy_coding.3x.html">cy_coding(3x)</A></STRONG>.