Changeset 1910 for ncurses/vendor/current/doc/html/man/curs_util.3x.html
- Timestamp:
- Jan 13, 2017, 3:21:12 PM (8 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
TabularUnified ncurses/vendor/current/doc/html/man/curs_util.3x.html ¶
r85 r1910 2 2 <!-- 3 3 **************************************************************************** 4 * Copyright (c) 1998-200 7,2008Free Software Foundation, Inc. *4 * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * 5 5 * * 6 6 * Permission is hereby granted, free of charge, to any person obtaining a * … … 28 28 * authorization. * 29 29 **************************************************************************** 30 * @Id: curs_util.3x,v 1. 26 2008/10/11 20:32:56tom Exp @30 * @Id: curs_util.3x,v 1.32 2010/12/04 18:38:55 tom Exp @ 31 31 --> 32 32 <HTML> … … 77 77 tation. Printing characters are displayed as is. The 78 78 corresponding <STRONG>wunctrl</STRONG> returns a printable representation 79 of a wide -character.79 of a wide character. 80 80 81 81 The <STRONG>keyname</STRONG> routine returns a character string correspond- 82 82 ing to the key <EM>c</EM>: 83 83 84 - Printable characters are displayed as themselves, 85 e.g., a one-character string containing the key. 86 87 - Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> notation. 88 89 - DEL (character 127) is displayed as <STRONG>^?</STRONG>. 90 91 - Values above 128 are either meta characters (if the 92 screen has not been initialized, or if <STRONG>meta</STRONG> has been 93 called with a TRUE parameter), shown in the <STRONG>M-</STRONG><EM>X</EM> no- 94 tation, or are displayed as themselves. In the lat- 95 ter case, the values may not be printable; this fol- 96 lows the X/Open specification. 97 98 - Values above 256 may be the names of the names of 99 function keys. 100 101 - Otherwise (if there is no corresponding name) the 102 function returns null, to denote an error. X/Open 103 also lists an "UNKNOWN KEY" return value, which some 104 implementations return rather than null. 84 <STRONG>o</STRONG> Printable characters are displayed as themselves, 85 e.g., a one-character string containing the key. 86 87 <STRONG>o</STRONG> Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> nota- 88 tion. 89 90 <STRONG>o</STRONG> DEL (character 127) is displayed as <STRONG>^?</STRONG>. 91 92 <STRONG>o</STRONG> Values above 128 are either meta characters (if the 93 screen has not been initialized, or if <STRONG>meta</STRONG> has 94 been called with a TRUE parameter), shown in the 95 <STRONG>M-</STRONG><EM>X</EM> notation, or are displayed as themselves. In 96 the latter case, the values may not be printable; 97 this follows the X/Open specification. 98 99 <STRONG>o</STRONG> Values above 256 may be the names of the names of 100 function keys. 101 102 <STRONG>o</STRONG> Otherwise (if there is no corresponding name) the 103 function returns null, to denote an error. X/Open 104 also lists an "UNKNOWN KEY" return value, which 105 some implementations return rather than null. 105 106 106 107 The corresponding <STRONG>key_name</STRONG> returns a character string cor- … … 164 165 plementation 165 166 166 <STRONG>flushinp</STRONG> 167 returns an error if the terminal was not ini- 168 tialized. 169 170 <STRONG>putwin</STRONG> 171 returns an error if the associated <STRONG>fwrite</STRONG> 172 calls return an error. 167 <STRONG>flushinp</STRONG> 168 returns an error if the terminal was not initial- 169 ized. 170 171 <STRONG>meta</STRONG> returns an error if the terminal was not initial- 172 ized. 173 174 <STRONG>putwin</STRONG> 175 returns an error if the associated <STRONG>fwrite</STRONG> calls 176 return an error. 173 177 174 178 175 179 </PRE> 176 180 <H2>PORTABILITY</H2><PRE> 177 The XSI Curses standard, Issue 4 describes thesefunc-178 tions. It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will returna179 null pointer if unsuccessful, but does not define anyer-181 The XSI Curses standard, Issue 4 describes these func- 182 tions. It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a 183 null pointer if unsuccessful, but does not define any er- 180 184 ror conditions. This implementation checks for three cas- 181 185 es: 182 186 183 - the parameter is a 7-bit US-ASCII code. This184 isthe case that X/Open Curses documented.185 186 - the parameter is in the range 128-159, i.e., a187 C1 control code. If <STRONG>use_legacy_coding</STRONG> has188 been called with a <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG> returns189 the parameter, i.e., a one-character string190 with the parameter as the first character.191 Otherwise, it returns ``~@'', ``~A'', etc.,192 analogous to ``^@'', ``^A'', C0 controls.193 194 X/Open Curses does not document whether <STRONG>unctrl</STRONG>195 can be called before initializing curses.196 This implementation permits that, and returns197 the ``~@'',etc., values in that case.198 199 - parameter values outside the 0 to 255 range.200 <STRONG>unctrl</STRONG> returns a null pointer.187 <STRONG>o</STRONG> the parameter is a 7-bit US-ASCII code. This is 188 the case that X/Open Curses documented. 189 190 <STRONG>o</STRONG> the parameter is in the range 128-159, i.e., a C1 191 control code. If <STRONG>use_legacy_coding</STRONG> has been called 192 with a <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG> returns the parameter, 193 i.e., a one-character string with the parameter as 194 the first character. Otherwise, it returns ``~@'', 195 ``~A'', etc., analogous to ``^@'', ``^A'', C0 con- 196 trols. 197 198 X/Open Curses does not document whether <STRONG>unctrl</STRONG> can 199 be called before initializing curses. This imple- 200 mentation permits that, and returns the ``~@'', 201 etc., values in that case. 202 203 <STRONG>o</STRONG> parameter values outside the 0 to 255 range. <STRONG>unc-</STRONG> 204 <STRONG>trl</STRONG> returns a null pointer. 201 205 202 206 The SVr4 documentation describes the action of <STRONG>filter</STRONG> only 203 in the vaguest terms. The description here isadapted204 from the XSI Curses standard (which erroneously failsto207 in the vaguest terms. The description here is adapted 208 from the XSI Curses standard (which erroneously fails to 205 209 describe the disabling of <STRONG>cuu</STRONG>). 206 210 207 The strings returned by <STRONG>unctrl</STRONG> in this implementationare208 determined at compile time, showing C1 controls fromthe209 upper-128 codes with a `~' prefix rather than `^'.Other210 implementations have different conventions. Forexample,211 they may show both sets of control characters with`^',212 and strip the parameter to 7 bits. Or they may ignoreC1213 controls and treat all of the upper-128 codes asprint-211 The strings returned by <STRONG>unctrl</STRONG> in this implementation are 212 determined at compile time, showing C1 controls from the 213 upper-128 codes with a `~' prefix rather than `^'. Other 214 implementations have different conventions. For example, 215 they may show both sets of control characters with `^', 216 and strip the parameter to 7 bits. Or they may ignore C1 217 controls and treat all of the upper-128 codes as print- 214 218 able. This implementation uses 8 bits but does not modify 215 219 the string to reflect locale. The <STRONG>use_legacy_coding</STRONG> func- 216 220 tion allows the caller to change the output of <STRONG>unctrl</STRONG>. 217 221 218 Likewise, the <STRONG>meta</STRONG> function allows the caller tochange219 the output of <STRONG>keyname</STRONG>, i.e., it determines whether touse220 the `M-' prefix for ``meta'' keys (codes in the range128222 Likewise, the <STRONG>meta</STRONG> function allows the caller to change 223 the output of <STRONG>keyname</STRONG>, i.e., it determines whether to use 224 the `M-' prefix for ``meta'' keys (codes in the range 128 221 225 to 255). Both <STRONG>use_legacy_coding</STRONG> and <STRONG>meta</STRONG> succeed only af- 222 ter curses is initialized. X/Open Curses does notdocu-223 ment the treatment of codes 128 to 159. Whentreating226 ter curses is initialized. X/Open Curses does not docu- 227 ment the treatment of codes 128 to 159. When treating 224 228 them as ``meta'' keys (or if <STRONG>keyname</STRONG> is called before ini- 225 tializing curses), this implementation returnsstrings229 tializing curses), this implementation returns strings 226 230 ``M-^@'', ``M-^A'', etc. 227 231 228 The <STRONG>keyname</STRONG> function may return the names ofuser-defined229 string capabilities which are defined in the terminfoen-230 try via the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>. This implementationauto-231 matically assigns at run-time keycodes touser-defined232 strings which begin with "k". The keycodes startat233 KEY_MAX, but are not guaranteed to be the same valuefor234 different runs because user-defined codes are mergedfrom235 all terminal descriptions which have been loaded.The236 <STRONG>use_extended_names</STRONG> function controls whether this datais237 loaded when the terminal description is read by theli-232 The <STRONG>keyname</STRONG> function may return the names of user-defined 233 string capabilities which are defined in the terminfo en- 234 try via the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>. This implementation auto- 235 matically assigns at run-time keycodes to user-defined 236 strings which begin with "k". The keycodes start at 237 KEY_MAX, but are not guaranteed to be the same value for 238 different runs because user-defined codes are merged from 239 all terminal descriptions which have been loaded. The 240 <STRONG>use_extended_names</STRONG> function controls whether this data is 241 loaded when the terminal description is read by the li- 238 242 brary. 239 243 240 The <STRONG>nofilter</STRONG> routine is specific to ncurses. It wasnot241 supported on Version 7, BSD or System Vimplementations.242 It is recommended that any code depending on ncursesex-244 The <STRONG>nofilter</STRONG> routine is specific to ncurses. It was not 245 supported on Version 7, BSD or System V implementations. 246 It is recommended that any code depending on ncurses ex- 243 247 tensions be conditioned using NCURSES_VERSION. 244 248 … … 247 251 <H2>SEE ALSO</H2><PRE> 248 252 <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> 249 <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="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>. 253 <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> 254 <STRONG><A HREF="legacy_coding.3x.html">cy_coding(3x)</A></STRONG>. 250 255 251 256
Note:
See TracChangeset
for help on using the changeset viewer.
