2 ****************************************************************************
3 * Copyright 2018-2019,2020 Thomas E. Dickey *
4 * Copyright 2002-2012,2017 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_get_wstr.3x,v 1.21 2020/10/17 23:17:24 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_get_wstr 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_get_wstr 3x</H1>
44 <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>get_wstr</STRONG>, <STRONG>getn_wstr</STRONG>, <STRONG>wget_wstr</STRONG>, <STRONG>wgetn_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>,
51 <STRONG>mvwget_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG> - get an array of wide characters from a
52 curses terminal keyboard
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
58 <STRONG>int</STRONG> <STRONG>get_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>getn_wstr(wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>wget_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>wgetn_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvget_wstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvgetn_wstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>mvwget_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>);</STRONG>
66 <STRONG>int</STRONG> <STRONG>mvwgetn_wstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
69 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
70 The effect of <STRONG>get_wstr</STRONG> is as though a series of calls to <STRONG><A HREF="curs_get_wch.3x.html">get_wch(3x)</A></STRONG>
71 were made, until a newline, other end-of-line, or end-of-file condition
72 is processed. An end-of-file condition is represented by <STRONG>WEOF</STRONG>, as de-
73 fined in <STRONG><wchar.h></STRONG>. The newline and end-of-line conditions are repre-
74 sented by the <STRONG>\n</STRONG> <STRONG>wchar_t</STRONG> value. In all instances, the end of the
75 string is terminated by a null <STRONG>wchar_t</STRONG>. The routine places resulting
76 values in the area pointed to by <EM>wstr</EM>.
78 The user's erase and kill characters are interpreted. If keypad mode
79 is on for the window, <STRONG>KEY_LEFT</STRONG> and <STRONG>KEY_BACKSPACE</STRONG> are both considered
80 equivalent to the user's kill character.
82 Characters input are echoed only if <STRONG>echo</STRONG> is currently on. In that
83 case, backspace is echoed as deletion of the previous character (typi-
86 The effect of <STRONG>wget_wstr</STRONG> is as though a series of calls to <STRONG>wget_wch</STRONG> were
89 The effect of <STRONG>mvget_wstr</STRONG> is as though a call to <STRONG>move</STRONG> and then a series
90 of calls to <STRONG>get_wch</STRONG> were made.
92 The effect of <STRONG>mvwget_wstr</STRONG> is as though a call to <STRONG>wmove</STRONG> and then a se-
93 ries of calls to <STRONG>wget_wch</STRONG> were made.
95 The <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, and <STRONG>wgetn_wstr</STRONG> functions are
96 identical to the <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, and <STRONG>wget_wstr</STRONG> func-
97 tions, respectively, except that the <STRONG>*n_*</STRONG> versions read at most <EM>n</EM> char-
98 acters, letting the application prevent overflow of the input buffer.
101 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
102 Using <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to read a line
103 that overflows the array pointed to by <STRONG>wstr</STRONG> causes undefined results.
104 The use of <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, or <STRONG>wgetn_wstr</STRONG>, respec-
105 tively, is recommended.
107 These functions cannot return <STRONG>KEY_</STRONG> values because there is no way to
108 distinguish a <STRONG>KEY_</STRONG> value from a valid <STRONG>wchar_t</STRONG> value.
110 All of these routines except <STRONG>wgetn_wstr</STRONG> may be macros.
113 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
114 All of these functions return <STRONG>OK</STRONG> upon successful completion. Other-
115 wise, they return <STRONG>ERR</STRONG>.
117 Functions using a window parameter return an error if it is null.
119 <STRONG>wgetn_wstr</STRONG>
120 returns an error if the associated call to <STRONG>wget_wch</STRONG> failed.
122 Functions with a "mv" prefix first perform a cursor movement using
123 <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
124 the window pointer is null.
127 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
128 These functions are described in The Single Unix Specification, Version
129 2. No error conditions are defined. This implementation returns <STRONG>ERR</STRONG>
130 if the window pointer is null, or if the lower-level <STRONG>wget_wch</STRONG> call re-
131 turns an <STRONG>ERR</STRONG>. In the latter case, an <STRONG>ERR</STRONG> return without other data is
132 treated as an end-of-file condition, and the returned array contains a
133 <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>.
135 X/Open curses documented these functions to pass an array of <STRONG>wchar_t</STRONG> in
136 1997, but that was an error because of this part of the description:
138 The effect of <EM>get</EM><STRONG>_</STRONG><EM>wstr()</EM> is as though a series of calls to
139 <EM>get</EM><STRONG>_</STRONG><EM>wch()</EM> were made, until a newline character, end-of-line
140 character, or end-of-file character is processed.
142 The latter function <EM>get</EM><STRONG>_</STRONG><EM>wch()</EM> can return a negative value, while
143 <STRONG>wchar_t</STRONG> is a unsigned type. All of the vendors implement this using
144 <STRONG>wint_t</STRONG>, following the standard.
146 X/Open Curses, Issue 7 (2009) is unclear regarding whether the termi-
147 nating <EM>null</EM> <STRONG>wchar_t</STRONG> value is counted in the length parameter <EM>n</EM>. X/Open
148 Curses, Issue 7 revised the corresponding description of <STRONG>wgetnstr</STRONG> to
149 address this issue. The unrevised description of <STRONG>wget_nwstr</STRONG> can be in-
150 terpreted either way. This implementation counts the terminator in the
153 X/Open Curses does not specify what happens if the length <EM>n</EM> is nega-
156 <STRONG>o</STRONG> For analogy with <STRONG>wgetnstr</STRONG>, ncurses 6.2 uses a limit (based on
157 <STRONG>LINE_MAX</STRONG>).
159 <STRONG>o</STRONG> Some other implementations (such as Solaris xcurses) do the same,
160 while others (PDCurses) do not allow this.
162 <STRONG>o</STRONG> NetBSD 7 curses imitates ncurses 6.1 in this regard, treating a <STRONG>-1</STRONG>
163 as an indefinite number of characters.
166 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
167 Functions: <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>.
171 <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
175 <li><a href="#h2-NAME">NAME</a></li>
176 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
177 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
178 <li><a href="#h2-NOTES">NOTES</a></li>
179 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
180 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
181 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>