man/curs_scanw.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: curs_scanw.3x,v 1.51 2024/03/23 20:41:15 tom Exp $
  31 .TH curs_scanw 3X 2024-03-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  32 .ie \n(.g \{\
  33 .ds `` \(lq
  34 .ds '' \(rq
  35 .\}
  36 .el \{\
  37 .ie t .ds `` ``
  38 .el   .ds `` ""
  39 .ie t .ds '' ''
  40 .el   .ds '' ""
  41 .\}
  42 .
  43 .de bP
  44 .ie n  .IP \(bu 4
  45 .el    .IP \(bu 2
  46 ..
  47 .SH NAME
  48 \fB\%scanw\fP,
  49 \fB\%wscanw\fP,
  50 \fB\%mvscanw\fP,
  51 \fB\%mvwscanw\fP,
  52 \fB\%vwscanw\fP,
  53 \fB\%vw_scanw\fP \-
  54 read formatted input from a \fIcurses\fR window
  55 .SH SYNOPSIS
  56 .nf
  57 \fB#include <curses.h>
  58 .PP
  59 \fBint scanw(const char *\fIfmt\fP, ...);
  60 \fBint wscanw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, ...);
  61 \fBint mvscanw(int \fIy\fP, int \fIx\fP, const char *\fIfmt\fP, ...);
  62 \fBint mvwscanw(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIfmt\fP, ...);
  63 .PP
  64 \fBint vw_scanw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, va_list \fIvarglist\fP);
  65 .PP
  66 \fI/* obsolete */\fP
  67 \fBint vwscanw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, va_list \fIvarglist\fP);
  68 .fi
  69 .SH DESCRIPTION
  70 \fB\%scanw\fP,
  71 \fB\%wscanw\fP,
  72 \fB\%mvscanw\fP,
  73 and
  74 \fB\%mvwscanw\fP
  75 are analogous to \fI\%scanf\fP(3).
  76 In effect,
  77 they call \fB\%wgetstr\fP(3X) with
  78 .I win
  79 (or
  80 .BR \%stdscr )
  81 as its first argument,
  82 then attempt conversion of the resulting string with \fI\%vsscanf\fP(3).
  83 Fields in the string that do not map to a variable in the \fIfmt\fP
  84 parameter are discarded.
  85 .PP
  86 \fB\%vwscanw\fP
  87 and
  88 \fB\%vw_scanw\fP are analogous to \fI\%vscanf\fP(3),
  89 and perform a \fB\%wscanw\fP using a variable argument list.
  90 The third argument is a \fI\%va_list\fP,
  91 a pointer to a list of arguments,
  92 as defined in \fI\%stdarg.h\fP.
  93 .SH RETURN VALUE
  94 These functions return
  95 .B ERR
  96 upon failure and otherwise a count of successful conversions;
  97 this quantity may be zero.
  98 .PP
  99 In
 100 .IR \%ncurses ,
 101 failure occurs if \fI\%vsscanf\fP(3) returns
 102 \fBEOF\fP,
 103 or if the window pointer
 104 .I win
 105 is null.
 106 .PP
 107 Functions with a \*(``mv\*('' prefix first perform a cursor movement
 108 using \fB\%wmove\fP,
 109 and fail if the position is outside the window.
 110 .SH NOTES
 111 No wide character counterpart functions are defined by the
 112 \*(``wide\*(''
 113 .I \%ncurses
 114 configuration nor by any standard.
 115 They are unnecessary:
 116 to retrieve and convert a wide-character string from a
 117 .I curses
 118 terminal keyboard,
 119 use these functions with the \fI\%scanf\fP(3) conversions \*(``%lc\*(''
 120 and \*(``%ls\*('' for wide characters and strings,
 121 respectively.
 122 .PP
 123 .I \%ncurses
 124 implements \fI\%vsscanf\fP(3) internally if it is unavailable when the
 125 library is configured.
 126 .SH PORTABILITY
 127 X/Open Curses, Issue 4, describes these functions.
 128 It specifies no error conditions for them.
 129 .PP
 130 .I \%ncurses
 131 defines \fB\%vw_scanw\fP and \fB\%vwscanw\fP identically to support
 132 legacy applications.
 133 However,
 134 the latter is obsolete.
 135 .bP
 136 X/Open Curses, Issue 4, Version 2 (1996),
 137 marked \fB\%vwscanw\fP as requiring \fI\%varargs.h\fP and
 138 \*(``TO BE WITHDRAWN\*('',
 139 and specified \fB\%vw_scanw\fP using the \fI\%stdarg.h\fP interface.
 140 .bP
 141 X/Open Curses, Issue 5, Draft 2
 142 (December 2007) marked \fB\%vwscanw\fP (along with
 143 \fB\%vwscanw\fP and the \fItermcap\fP interface) as withdrawn.
 144 After incorporating review comments,
 145 this became
 146 X/Open Curses, Issue 7 (2009).
 147 .bP
 148 .I \%ncurses
 149 provides \fB\%vwscanw\fP,
 150 but marks it as deprecated.
 151 .PP
 152 X/Open Curses Issues 4 and 7 both state that these functions return
 153 \fBERR\fP or \fBOK\fP.
 154 This is likely an erratum.
 155 .bP
 156 Since the underlying \fI\%scanf\fP(3) returns the number of successful
 157 conversions,
 158 and SVr4
 159 .I curses
 160 was documented to use this feature,
 161 this may have been an editorial solecism introduced by X/Open,
 162 rather than an intentional change.
 163 .bP
 164 This implementation retains compatibility with SVr4
 165 .IR curses .
 166 As of 2018,
 167 NetBSD
 168 .I curses
 169 also returns the number of successful conversions.
 170 Both
 171 .I \%ncurses\fP
 172 and NetBSD
 173 .I curses
 174 call \fI\%vsscanf\fP(3) to scan the string,
 175 which returns \fBEOF\fP on error.
 176 .bP
 177 Portable applications should test only if the return value is \fBERR\fP,
 178 and not compare it to \fBOK\fP,
 179 since that value (zero) might be misleading.
 180 .IP
 181 One portable way to get useful results would be to use a \*(``%n\*(''
 182 conversion at the end of the format string,
 183 and check the value of the corresponding variable to determine how many
 184 conversions succeeded.
 185 .SH HISTORY
 186 \fB\%scanw\fP was implemented in 4BSD
 187 (November 1980);
 188 .\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=4BSD/usr/src/lib/\
 189 .\"  libcurses/scanw.c
 190 that early version of
 191 .I curses
 192 preceded the ANSI C standard of 1989.
 193 The function was unused in Berkeley distributions for over ten years,
 194 until 4.4BSD,
 195 which employed it in a game.
 196 The 4BSD \fB\%scanw\fP did not use \fI\%varargs.h\fP,
 197 though that had been available since Seventh Edition Unix (1979).
 198 .\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=V7/usr/include/\
 199 .\"  varargs.h
 200 In 1991
 201 (a couple of years after SVr4 was generally available,
 202 and after the C standard was published),
 203 other developers updated the library,
 204 using \fI\%stdarg.h\fP internally in 4.4BSD
 205 .IR curses .
 206 Even with this improvement,
 207 BSD
 208 .I curses
 209 did not use function prototypes
 210 (nor even declare functions)
 211 in \fI\%curses.h\fP until 1992.
 212 .PP
 213 SVr2 (1984) documented \fB\%scanw\fP and \fB\%wscanw\fP tersely as
 214 \*(``scanf through \fB\%stdscr\fP\*('' and
 215 \*(``scanf through \fIwin\fP\*('',
 216 respectively.
 217 .PP
 218 SVr3 (1987) added
 219 \fB\%mvscanw\fP, and
 220 \fB\%mvwscanw\fP, stating
 221 .RS
 222 .PP
 223 \*(``[t]hese routines correspond to \fIscanf\fP(3S),
 224 as do their arguments and return values.
 225 \fB\%wgetstr\fP() is called on the window,
 226 and the resulting line is used as input for the scan.\*(''
 227 .RE
 228 .PP
 229 SVr3 also implemented \fB\%vwscanw\fP,
 230 describing its third parameter as a \fI\%va_list\fP,
 231 defined in \fI\%varargs.h\fP,
 232 and referred the reader to the manual pages for \fI\%varargs\fP and
 233 \fI\%vprintf\fP for detailed descriptions.
 234 (Because the SVr3 documentation does not mention \fI\%vscanf\fP,
 235 the reference to \fI\%vprintf\fP might not be an error).
 236 .PP
 237 SVr4 (1989) introduced no new variations of \fI\%scanw\fP,
 238 but provided for using either \fI\%varargs.h\fP or \fI\%stdarg.h\fP to
 239 define the \fI\%va_list\fP type.
 240 .\" either header declares "va_list", but only one can be used
 241 .PP
 242 X/Open Curses, Issue 4 (1995),
 243 defined \fI\%vw_scanw\fP to replace \fI\%vwscanw\fP,
 244 stating that its \fI\%va_list\fP type is defined in \fI\%stdarg.h\fP.
 245 .SH SEE ALSO
 246 \fB\%curses\fP(3X),
 247 \fB\%curs_getstr\fP(3X),
 248 \fB\%curs_printw\fP(3X),
 249 \fB\%scanf\fP(3),
 250 \fB\%vscanf\fP(3)