X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_get_wstr.3x;h=07ceb3544bef6b850ddf7c0018ce4747a42ba248;hp=86a5b82a11fc869af7f1b9360306d0a5afe3b72d;hb=95b3f94ec8b2da797e3e9a18fb49320daa5ab221;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x index 86a5b82a..07ceb354 100644 --- a/man/curs_get_wstr.3x +++ b/man/curs_get_wstr.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2002,2003 Free Software Foundation, Inc. * +.\" 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 * .\" copy of this software and associated documentation files (the * @@ -26,142 +27,193 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wstr.3x,v 1.3 2003/07/05 11:15:28 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 `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. +.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 \fR - -\fBint get_wstr(wint_t *\fR\fIwstr\fR\fB);\fR +\fB#include \fP +.sp +\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 \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB);\fP .br -\fBint mvget_wstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wint_t *\fR\fIwstr\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 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 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 mvwget_wstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wint_t *\fR\fIwstr\fR\fB);\fR -.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 -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\fR. -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. - -The user's erase and kill characters are interpreted. If keypad -mode is on for the window, \fBKEY_LEFT\fR and \fBKEY_BACKSPACE\fR +\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\fP, +as defined in \fB\fP. +The newline and end-of-line conditions are represented +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\fP and \fBKEY_BACKSPACE\fP are both considered equivalent to the user's kill character. - -Characters input are echoed only if \fBecho\fR is currently on. In that case, +.PP +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. - -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. - -All of these routines except \fBwgetn_wstr\fR may be macros. -.SH RETURN VALUES -All of these functions return \fBOK\fR upon successful completion. -Otherwise, they return \fBERR\fR. +\fBgetn_wstr\fP, +\fBmvgetn_wstr\fP, +\fBmvwgetn_wstr\fP, or +\fBwgetn_wstr\fP, respectively, is recommended. +.PP +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\fP may be macros. +.SH RETURN VALUE +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 +.TP 5 +\fBwgetn_wstr\fP +returns an error if the associated call to \fBwget_wch\fP failed. +.RE +.PP +Functions with a \*(``mv\*('' prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH PORTABILITY These functions are described in The Single Unix Specification, Version 2. No error conditions are defined. -This implementation returns ERR if the window pointer is null, -or if the lower-level \fBwget_wch\fR call returns an ERR. +This implementation returns \fBERR\fP if the window pointer is null, +or if the lower-level \fBwget_wch\fP call returns an \fBERR\fP. In the latter case, -an ERR 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. +an \fBERR\fP return without other data is treated as an end-of-file condition, +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\fP +in 1997, but that was an error because of this part of the description: +.RS +.PP +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, +while \fBwchar_t\fP is a unsigned type. +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 +value is counted in the length parameter \fIn\fP. +X/Open Curses, Issue 7 revised the corresponding description +of \fBwgetnstr\fP to address this issue. +The unrevised description of \fBwget_nwstr\fP can be interpreted either way. +This implementation counts the terminator in the length. .PP -X/Open curses documents these functions to pass an array of \fBwchar_t\fR, -but all of the vendors implement this using \fBwint_t\fR. +X/Open Curses does not specify what happens if the length \fIn\fP is negative. +.bP +For analogy with \fBwgetnstr\fP, +ncurses 6.2 uses a limit (based on \fBLINE_MAX\fP). +.bP +Some other implementations (such as Solaris xcurses) do the same, +while others (PDCurses) do not allow this. +.bP +NetBSD 7 curses imitates ncurses 6.1 in this regard, +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). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fP(3X), +\fBcurs_get_wch\fP(3X), +\fBcurs_getstr\fP(3X).