.\"***************************************************************************
-.\" Copyright 2018-2019,2020 Thomas E. Dickey *
+.\" Copyright 2018-2020,2021 Thomas E. Dickey *
.\" Copyright 2002-2012,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_get_wstr.3x,v 1.21 2020/10/17 23:17:24 tom Exp $
+.\" $Id: curs_get_wstr.3x,v 1.25 2021/12/25 21:49:32 tom Exp $
.TH curs_get_wstr 3X ""
.ie \n(.g .ds `` \(lq
.el .ds `` ``
.na
.hy 0
.SH NAME
-\fBget_wstr\fR,
-\fBgetn_wstr\fR,
-\fBwget_wstr\fR,
-\fBwgetn_wstr\fR,
-\fBmvget_wstr\fR,
-\fBmvgetn_wstr\fR,
-\fBmvwget_wstr\fR,
-\fBmvwgetn_wstr\fR \- get an array of wide characters from a curses terminal keyboard
+\fBget_wstr\fP,
+\fBgetn_wstr\fP,
+\fBwget_wstr\fP,
+\fBwgetn_wstr\fP,
+\fBmvget_wstr\fP,
+\fBmvgetn_wstr\fP,
+\fBmvwget_wstr\fP,
+\fBmvwgetn_wstr\fP \- get an array of wide characters from a curses terminal keyboard
.ad
.hy
.SH SYNOPSIS
.nf
-\fB#include <curses.h>\fR
+\fB#include <curses.h>\fP
.sp
-\fBint get_wstr(wint_t *\fR\fIwstr\fR\fB);\fR
+\fBint get_wstr(wint_t *\fP\fIwstr\fP\fB);\fP
.br
-\fBint getn_wstr(wint_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
+\fBint getn_wstr(wint_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
.br
-\fBint wget_wstr(WINDOW *\fR\fIwin\fR\fB, wint_t *\fR\fIwstr\fR\fB);\fR
+\fBint wget_wstr(WINDOW *\fP\fIwin\fP\fB, wint_t *\fP\fIwstr\fP\fB);\fP
.br
-\fBint wgetn_wstr(WINDOW *\fR\fIwin\fR\fB, wint_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
+\fBint wgetn_wstr(WINDOW *\fP\fIwin\fP\fB, wint_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
.sp
-\fBint mvget_wstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wint_t *\fR\fIwstr\fR\fB);\fR
+\fBint mvget_wstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB);\fP
.br
-\fBint mvgetn_wstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wint_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
+\fBint mvgetn_wstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
.br
-\fBint mvwget_wstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wint_t *\fR\fIwstr\fR\fB);\fR
+\fBint mvwget_wstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB);\fP
.br
-\fBint mvwgetn_wstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wint_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
+\fBint mvwgetn_wstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
.fi
.SH DESCRIPTION
The effect of
-\fBget_wstr\fR
+\fBget_wstr\fP
is as though a series of calls
to
-\fBget_wch\fR(3X)
+\fBget_wch\fP(3X)
were made, until a newline, other end-of-line,
or end-of-file condition is processed.
-An end-of-file condition is represented by \fBWEOF\fR,
-as defined in \fB<wchar.h>\fR.
+An end-of-file condition is represented by \fBWEOF\fP,
+as defined in \fB<wchar.h>\fP.
The newline and end-of-line conditions are represented
-by the \fB\\n\fR \fBwchar_t\fR value.
-In all instances, the end of the string is terminated by a null \fBwchar_t\fR.
-The routine places resulting values in the area pointed to by \fIwstr\fR.
+by the \fB\\n\fP \fBwchar_t\fP value.
+In all instances, the end of the string is terminated by a null \fBwchar_t\fP.
+The routine places resulting values in the area pointed to by \fIwstr\fP.
.PP
The user's erase and kill characters are interpreted.
If keypad
-mode is on for the window, \fBKEY_LEFT\fR and \fBKEY_BACKSPACE\fR
+mode is on for the window, \fBKEY_LEFT\fP and \fBKEY_BACKSPACE\fP
are both considered equivalent to the user's kill character.
.PP
-Characters input are echoed only if \fBecho\fR is currently on.
+Characters input are echoed only if \fBecho\fP is currently on.
In that case,
backspace is echoed as deletion of the previous character (typically a left
motion).
.PP
The effect of
-\fBwget_wstr\fR
+\fBwget_wstr\fP
is as though a series of
calls to
-\fBwget_wch\fR
+\fBwget_wch\fP
were made.
.PP
The effect of
-\fBmvget_wstr\fR
+\fBmvget_wstr\fP
is as though a call to
-\fBmove\fR
+\fBmove\fP
and then a series of calls to
-\fBget_wch\fR
+\fBget_wch\fP
were
made.
.PP
The effect of
-\fBmvwget_wstr\fR
+\fBmvwget_wstr\fP
is as though a call to
-\fBwmove\fR
+\fBwmove\fP
and then a series of calls to
-\fBwget_wch\fR
+\fBwget_wch\fP
were made.
.PP
The
-\fBgetn_wstr\fR,
-\fBmvgetn_wstr\fR,
-\fBmvwgetn_wstr\fR, and
-\fBwgetn_wstr\fR
+\fBgetn_wstr\fP,
+\fBmvgetn_wstr\fP,
+\fBmvwgetn_wstr\fP, and
+\fBwgetn_wstr\fP
functions are identical
to the
-\fBget_wstr\fR,
-\fBmvget_wstr\fR,
-\fBmvwget_wstr\fR, and
-\fBwget_wstr\fR
+\fBget_wstr\fP,
+\fBmvget_wstr\fP,
+\fBmvwget_wstr\fP, and
+\fBwget_wstr\fP
functions, respectively,
except that the
-\fB*n_*\fR
+\fB*n_*\fP
versions read at most
-\fIn\fR
+\fIn\fP
characters, letting the application prevent overflow of the
input buffer.
.SH NOTES
Using
-\fBget_wstr\fR,
-\fBmvget_wstr\fR,
-\fBmvwget_wstr\fR, or
-\fBwget_wstr\fR
+\fBget_wstr\fP,
+\fBmvget_wstr\fP,
+\fBmvwget_wstr\fP, or
+\fBwget_wstr\fP
to read a line that
overflows the array pointed to by
-\fBwstr\fR
+\fBwstr\fP
causes undefined
results.
The use of
-\fBgetn_wstr\fR,
-\fBmvgetn_wstr\fR,
-\fBmvwgetn_wstr\fR, or
-\fBwgetn_wstr\fR, respectively, is recommended.
+\fBgetn_wstr\fP,
+\fBmvgetn_wstr\fP,
+\fBmvwgetn_wstr\fP, or
+\fBwgetn_wstr\fP, respectively, is recommended.
.PP
-These functions cannot return \fBKEY_\fR values because there
-is no way to distinguish a \fBKEY_\fR value from a valid \fBwchar_t\fR value.
+These functions cannot return \fBKEY_\fP values because there
+is no way to distinguish a \fBKEY_\fP value from a valid \fBwchar_t\fP value.
.PP
-All of these routines except \fBwgetn_wstr\fR may be macros.
+All of these routines except \fBwgetn_wstr\fP may be macros.
.SH RETURN VALUE
-All of these functions return \fBOK\fR upon successful completion.
-Otherwise, they return \fBERR\fR.
+All of these functions return \fBOK\fP upon successful completion.
+Otherwise, they return \fBERR\fP.
.PP
Functions using a window parameter return an error if it is null.
.RS
These functions are described in The Single Unix Specification, Version 2.
No error conditions are defined.
This implementation returns \fBERR\fP if the window pointer is null,
-or if the lower-level \fBwget_wch\fR call returns an \fBERR\fP.
+or if the lower-level \fBwget_wch\fP call returns an \fBERR\fP.
In the latter case,
an \fBERR\fP return without other data is treated as an end-of-file condition,
-and the returned array contains a \fBWEOF\fR followed by a null \fBwchar_t\fR.
+and the returned array contains a \fBWEOF\fP followed by a null \fBwchar_t\fP.
.PP
-X/Open curses documented these functions to pass an array of \fBwchar_t\fR
+X/Open curses documented these functions to pass an array of \fBwchar_t\fP
in 1997, but that was an error because of this part of the description:
.RS
.PP
-The effect of \fIget_wstr()\fP is as though a series of calls to
-\fIget_wch()\fP were made, until a newline character, end-of-line character, or
+The effect of \fBget_wstr\fP is as though a series of calls to
+\fBget_wch\fP were made, until a newline character, end-of-line character, or
end-of-file character is processed.
.RE
.PP
-The latter function \fIget_wch()\fP can return a negative value,
+The latter function \fIget_wch\fP can return a negative value,
while \fBwchar_t\fP is a unsigned type.
-All of the vendors implement this using \fBwint_t\fR, following the standard.
+All of the vendors implement this using \fBwint_t\fP, following the standard.
.PP
X/Open Curses, Issue 7 (2009) is unclear regarding whether
the terminating \fInull \fP\fBwchar_t\fP
treating a \fB\-1\fP as an indefinite number of characters.
.SH SEE ALSO
Functions:
-\fBcurses\fR(3X),
-\fBcurs_get_wch\fR(3X),
-\fBcurs_getstr\fR(3X).
+\fBcurses\fP(3X),
+\fBcurs_get_wch\fP(3X),
+\fBcurs_getstr\fP(3X).
projects / ncurses.git / blobdiff