X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fcurs_get_wstr.3x;h=2c49920fb48a0802053629e650c4ae40ddc61801;hb=HEAD;hp=2ccf068adc0e4ce61c6ed268771d06a9ed41574f;hpb=f79c210479470378389aab5b8d4d42d4a7f3d9a4;p=ncurses.git diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x index 2ccf068a..32ae541a 100644 --- a/man/curs_get_wstr.3x +++ b/man/curs_get_wstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,97 +27,90 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wstr.3x,v 1.27 2022/02/12 20:07:29 tom Exp $ -.TH curs_get_wstr 3X 2022-02-12 "ncurses 6.4" "Library calls" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_get_wstr.3x,v 1.48 2024/04/20 19:18:18 tom Exp $ +.TH curs_get_wstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\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 +\fB\%get_wstr\fP, +\fB\%getn_wstr\fP, +\fB\%wget_wstr\fP, +\fB\%wgetn_wstr\fP, +\fB\%mvget_wstr\fP, +\fB\%mvgetn_wstr\fP, +\fB\%mvwget_wstr\fP, +\fB\%mvwgetn_wstr\fP \- +get a wide-character string from a \fIcurses\fR terminal keyboard .SH SYNOPSIS .nf -\fB#include \fP -.sp -\fBint get_wstr(wint_t *\fIwstr\fB);\fR -.br -\fBint getn_wstr(wint_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint wget_wstr(WINDOW *\fIwin\fB, wint_t *\fIwstr\fB);\fR -.br -\fBint wgetn_wstr(WINDOW *\fIwin\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR -.sp -\fBint mvget_wstr(int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB);\fR -.br -\fBint mvgetn_wstr(int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint mvwget_wstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB);\fR -.br -\fBint mvwgetn_wstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR +\fB#include +.PP +\fBint get_wstr(wint_t *\fIwstr\fP); +\fBint getn_wstr(wint_t *\fIwstr\fP, int \fIn\fP); +\fBint wget_wstr(WINDOW *\fIwin\fP, wint_t *\fIwstr\fP); +\fBint wgetn_wstr(WINDOW *\fIwin\fP, wint_t *\fIwstr\fP, int \fIn\fP); +.PP +\fBint mvget_wstr(int \fIy\fP, int \fIx\fP, wint_t *\fIwstr\fP); +\fBint mvgetn_wstr(int \fIy\fP, int \fIx\fP, wint_t *\fIwstr\fP, int \fIn\fP); +\fBint mvwget_wstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wint_t *\fIwstr\fP); +\fBint mvwgetn_wstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wint_t *\fIwstr\fP, int \fIn\fP); .fi .SH DESCRIPTION -The effect of -\fBget_wstr\fP -is as though a series of calls -to -\fBget_wch\fP(3X) -were made, until a newline, other end-of-line, -or end-of-file condition is processed. +The function +\fBwgetn_wstr\fP +is equivalent to a series of calls to +\fBwget_wch\fP(3X) +until a newline or carriage return terminates the series: +.bP +The terminating character is not included in the returned string. +.bP 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. +.bP +In all instances, the end of the string is terminated +by a null \fBwchar_t\fP. +.bP +The function stores the result in the area pointed to +by the \fIwstr\fP parameter. +.bP +The function reads at most \fIn\fP characters, +thus preventing a possible overflow of the input buffer. +.IP +Any attempt to enter more characters +(other than the terminating newline or carriage return) +causes a beep. +.IP +Function keys also cause a beep and are ignored. .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. +The user's \fIerase\fP and \fIkill\fP characters are interpreted: +.bP +The \fIerase\fP character (e.g., \fB^H\fP) erases the character +at the end of the buffer, moving the cursor to the left. +.IP +If \fIkeypad\fP mode is on for the window, +\fBKEY_LEFT\fP and \fBKEY_BACKSPACE\fP +are both considered equivalent to the user's \fIerase\fP character. +.bP +The \fIkill\fP character (e.g., \fB^U\fP) erases the entire buffer, +leaving the cursor at the beginning of the buffer. .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\fP -is as though a series of -calls to -\fBwget_wch\fP -were made. -.PP -The effect of -\fBmvget_wstr\fP -is as though a call to -\fBmove\fP -and then a series of calls to -\fBget_wch\fP -were -made. -.PP -The effect of -\fBmvwget_wstr\fP -is as though a call to -\fBwmove\fP -and then a series of calls to -\fBwget_wch\fP -were made. +backspace is echoed as deletion of the previous character +(typically a left motion). .PP The \fBgetn_wstr\fP, @@ -137,7 +130,33 @@ versions read at most \fIn\fP characters, letting the application prevent overflow of the input buffer. +.SH RETURN VALUE +All of these functions return the integer \fBOK\fP upon successful completion. +If unsuccessful, they return \fBERR\fP. +.PP +X/Open defines no error conditions. +.PP +In this implementation, +these functions return an error +.bP +if the window pointer is null, +.bP +if its timeout expires without having any data, or +.bP +if the associated call to +\fBwget_wch\fP +failed. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES +Any of these functions other than +\fBwgetn_wstr\fP +may be macros. +.PP Using \fBget_wstr\fP, \fBmvget_wstr\fP, @@ -152,29 +171,15 @@ The use of \fBgetn_wstr\fP, \fBmvgetn_wstr\fP, \fBmvwgetn_wstr\fP, or -\fBwgetn_wstr\fP, respectively, is recommended. +\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. +.PP 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, @@ -205,15 +210,17 @@ This implementation counts the terminator in the length. 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). +\fI\%ncurses\fP 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, +NetBSD 7 curses imitates \fI\%ncurses\fP 6.1 in this regard, treating a \fB\-1\fP as an indefinite number of characters. .SH SEE ALSO -Functions: -\fBcurses\fP(3X), -\fBcurs_get_wch\fP(3X), -\fBcurs_getstr\fP(3X). +\fB\%curs_getstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. +.PP +\fB\%curses\fP(3X), +\fB\%curs_get_wch\fP(3X)