2 ****************************************************************************
3 * Copyright 2018-2023,2024 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.54 2024/06/22 21:34:19 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 2024-06-22 ncurses 6.5 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">curs_get_wstr 3x 2024-06-22 ncurses 6.5 Library calls</H1>
44 <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG> Library calls <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 a wide-character string from a <EM>curses</EM>
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>wget_wstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG> <EM>wstr</EM><STRONG>);</STRONG>
60 <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>
61 <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>
63 <STRONG>int</STRONG> <STRONG>getn_wstr(wint_t</STRONG> <STRONG>*</STRONG> <EM>wstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
64 <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>
65 <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>
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 function <STRONG>wgetn_wstr</STRONG> is equivalent to a series of calls to
71 <STRONG><A HREF="curs_get_wch.3x.html">wget_wch(3x)</A></STRONG> until a newline or carriage return terminates the series:
73 <STRONG>o</STRONG> The terminating character is not included in the returned string.
75 <STRONG>o</STRONG> An end-of-file condition is represented by <STRONG>WEOF</STRONG>, as defined in
76 <STRONG><wchar.h></STRONG>.
78 <STRONG>o</STRONG> In all instances, the end of the string is terminated by a null
79 <STRONG>wchar_t</STRONG>.
81 <STRONG>o</STRONG> The function stores the result in the area pointed to by the <EM>wstr</EM>
84 <STRONG>o</STRONG> The function reads at most <EM>n</EM> characters, thus preventing a possible
85 overflow of the input buffer.
87 Any attempt to enter more characters (other than the terminating
88 newline or carriage return) causes a beep.
90 Function keys also cause a beep and are ignored.
92 The user's <EM>erase</EM> and <EM>kill</EM> characters are interpreted:
94 <STRONG>o</STRONG> The <EM>erase</EM> character (e.g., <STRONG>^H</STRONG>) erases the character at the end of
95 the buffer, moving the cursor to the left.
97 If <EM>keypad</EM> mode is on for the window, <STRONG>KEY_LEFT</STRONG> and <STRONG>KEY_BACKSPACE</STRONG> are
98 both considered equivalent to the user's <EM>erase</EM> character.
100 <STRONG>o</STRONG> The <EM>kill</EM> character (e.g., <STRONG>^U</STRONG>) erases the entire buffer, leaving the
101 cursor at the beginning of the buffer.
103 Characters input are echoed only if <STRONG>echo</STRONG> is currently on. In that
104 case, backspace is echoed as deletion of the previous character
105 (typically a left motion).
107 The <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, and <STRONG>wgetn_wstr</STRONG> functions are
108 identical to the <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, and <STRONG>wget_wstr</STRONG>
109 functions, respectively, except that the <STRONG>*n_*</STRONG> versions read at most <EM>n</EM>
110 characters, letting the application prevent overflow of the input
114 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
115 All of these functions return the integer <STRONG>OK</STRONG> upon successful
116 completion. If unsuccessful, they return <STRONG>ERR</STRONG>.
118 X/Open defines no error conditions.
120 In this implementation, these functions return <STRONG>ERR</STRONG>
122 <STRONG>o</STRONG> if the window pointer is null,
124 <STRONG>o</STRONG> if its timeout expires without having any data, or
126 <STRONG>o</STRONG> if the associated call to <STRONG>wget_wch</STRONG> failed.
128 Functions prefixed with "mv" first perform cursor movement and fail if
129 the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
132 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
133 Any of these functions other than <STRONG>wgetn_wstr</STRONG> may be macros.
135 Using <STRONG>get_wstr</STRONG>, <STRONG>mvget_wstr</STRONG>, <STRONG>mvwget_wstr</STRONG>, or <STRONG>wget_wstr</STRONG> to read a line
136 that overflows the array pointed to by <STRONG>wstr</STRONG> causes undefined results.
137 The use of <STRONG>getn_wstr</STRONG>, <STRONG>mvgetn_wstr</STRONG>, <STRONG>mvwgetn_wstr</STRONG>, or <STRONG>wgetn_wstr</STRONG>,
138 respectively, is recommended.
140 These functions cannot return <STRONG>KEY_</STRONG> values because there is no way to
141 distinguish a <STRONG>KEY_</STRONG> value from a valid <STRONG>wchar_t</STRONG> value.
144 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
145 X/Open Curses, Issue 4 describes these functions. It specifies no
146 error conditions for them.
148 This implementation returns <STRONG>ERR</STRONG> if the window pointer is null, or if
149 the lower-level <STRONG>wget_wch</STRONG> call returns an <STRONG>ERR</STRONG>. In the latter case, an
150 <STRONG>ERR</STRONG> return without other data is treated as an end-of-file condition,
151 and the returned array contains a <STRONG>WEOF</STRONG> followed by a null <STRONG>wchar_t</STRONG>.
153 X/Open curses documented these functions to pass an array of <STRONG>wchar_t</STRONG> in
154 1997, but that was an error because of this part of the description:
156 The effect of <STRONG>get_wstr</STRONG> is as though a series of calls to <STRONG>get_wch</STRONG>
157 were made, until a newline character, end-of-line character, or
158 end-of-file character is processed.
160 The latter function <EM>get</EM><STRONG>_</STRONG><EM>wch</EM> can return a negative value, while <STRONG>wchar_t</STRONG>
161 is a unsigned type. All of the vendors implement this using <STRONG>wint_t</STRONG>,
162 following the standard.
164 X/Open Curses, Issue 7 (2009) is unclear regarding whether the
165 terminating <EM>null</EM> <STRONG>wchar_t</STRONG> value is counted in the length parameter <EM>n</EM>.
166 X/Open Curses, Issue 7 revised the corresponding description of
167 <STRONG>wgetnstr</STRONG> to address this issue. The unrevised description of
168 <STRONG>wget_nwstr</STRONG> can be interpreted either way. This implementation counts
169 the terminator in the length.
171 X/Open Curses does not specify what happens if the length <EM>n</EM> is
174 <STRONG>o</STRONG> For analogy with <STRONG>wgetnstr</STRONG>, <EM>ncurses</EM> 6.2 uses a limit (based on
175 <STRONG>LINE_MAX</STRONG>).
177 <STRONG>o</STRONG> Some other implementations (such as Solaris xcurses) do the same,
178 while others (PDCurses) do not allow this.
180 <STRONG>o</STRONG> NetBSD 7 curses imitates <EM>ncurses</EM> 6.1 in this regard, treating a <STRONG>-1</STRONG>
181 as an indefinite number of characters.
184 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
185 <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM> library
186 in its non-wide-character configuration.
188 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
192 ncurses 6.5 2024-06-22 <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
196 <li><a href="#h2-NAME">NAME</a></li>
197 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
198 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
199 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
200 <li><a href="#h2-NOTES">NOTES</a></li>
201 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
202 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>