man/curs_printw.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2022,2023 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_printw.3x,v 1.45 2023/12/18 00:03:28 tom Exp $
  31 .TH curs_printw 3X 2023-12-17 "ncurses 6.4" "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\%printw\fP,
  49 \fB\%wprintw\fP,
  50 \fB\%mvprintw\fP,
  51 \fB\%mvwprintw\fP,
  52 \fB\%vwprintw\fP,
  53 \fB\%vw_printw\fP \-
  54 write formatted output to a \fIcurses\fR window
  55 .SH SYNOPSIS
  56 .nf
  57 \fB#include <curses.h>
  58 .PP
  59 \fBint printw(const char *\fIfmt\fP, ...);
  60 \fBint wprintw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, ...);
  61 \fBint mvprintw(int \fIy\fP, int \fIx\fP, const char *\fIfmt\fP, ...);
  62 \fBint mvwprintw(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIfmt\fP, ...);
  63 .PP
  64 \fBint vw_printw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, va_list \fIvarglist\fP);
  65 .PP
  66 \fI/* obsolete */\fP
  67 \fBint vwprintw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, va_list \fIvarglist\fP);
  68 .fi
  69 .SH DESCRIPTION
  70 \fB\%printw\fP,
  71 \fB\%wprintw\fP,
  72 \fB\%mvprintw\fP,
  73 and
  74 \fB\%mvwprintw\fP
  75 are analogous to \fI\%printf\fP(3).
  76 In effect,
  77 the string that would be output by \fI\%printf\fP(3) is instead output
  78 as though \fB\%waddstr\fP(3X) were used with
  79 .I win
  80 (or
  81 .BR \%stdscr )
  82 as its first argument.
  83 .PP
  84 \fB\%vwprintw\fP
  85 and
  86 \fB\%vw_printw\fP are analogous to \fI\%vprintf\fP(3),
  87 and perform a \fB\%wprintw\fP using a variable argument list.
  88 The third argument is a \fI\%va_list\fP,
  89 a pointer to a list of arguments,
  90 as defined in \fI\%stdarg.h\fP.
  91 .SH RETURN VALUE
  92 These functions return
  93 .B ERR
  94 upon failure and
  95 .B OK
  96 upon success.
  97 .PP
  98 In
  99 .I \%ncurses,
 100 failure occurs if the library cannot allocate enough memory for the
 101 buffer into which the output is formatted,
 102 or if the window pointer
 103 .I win
 104 is null.
 105 .PP
 106 Functions with a \*(``mv\*('' prefix first perform a cursor movement
 107 using \fB\%wmove\fP,
 108 and fail if the position is outside the window.
 109 .SH NOTES
 110 No wide character counterpart functions are defined by the
 111 \*(``wide\*(''
 112 .I \%ncurses
 113 configuration nor by any standard.
 114 To format and write a wide-character string to a
 115 .I curses
 116 window,
 117 consider using \fI\%swprintf\fP(3) and \fB\%waddwstr\fP(3X) or similar.
 118 .SH PORTABILITY
 119 X/Open Curses, Issue 4, describes these functions.
 120 It specifies no error conditions for them.
 121 .PP
 122 .I \%ncurses
 123 defines \fB\%vw_printw\fP and \fB\%vwprintw\fP identically to support
 124 legacy applications.
 125 However,
 126 the latter is obsolete.
 127 .bP
 128 X/Open Curses, Issue 4, Version 2 (1996),
 129 marked \fB\%vwprintw\fP as requiring \fI\%varargs.h\fP and
 130 \*(``TO BE WITHDRAWN\*('',
 131 and specified \fB\%vw_printw\fP using the \fI\%stdarg.h\fP interface.
 132 .bP
 133 X/Open Curses, Issue 5, Draft 2
 134 (December 2007) marked \fBvwprintw\fP (along with
 135 \fBvwscanw\fP and the termcap interface) as withdrawn.
 136 After incorporating review comments,
 137 this became
 138 X/Open Curses, Issue 7 (2009).
 139 .bP
 140 .I \%ncurses
 141 provides \fB\%vwprintw\fP,
 142 but marks it as deprecated.
 143 .SH HISTORY
 144 While \fB\%printw\fP was implemented in 4BSD
 145 (November 1980),
 146 .\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=4BSD/usr/src/lib/\
 147 .\"   libcurses/printw.c
 148 it was unused until 4.2BSD
 149 (August 1983),
 150 which employed it for games.
 151 That early version of
 152 .I curses
 153 preceded the ANSI C standard of 1989.
 154 It did not use \fI\%varargs.h\fP,
 155 though that had been available since Seventh Edition Unix (1979).
 156 .\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=V7/usr/include/\
 157 .\"  varargs.h
 158 In 1991
 159 (a couple of years after SVr4 was generally available,
 160 and after the C standard was published),
 161 other developers updated the library,
 162 using \fI\%stdarg.h\fP internally in 4.4BSD
 163 .I curses.
 164 Even with this improvement,
 165 BSD
 166 .I curses
 167 did not use function prototypes
 168 (nor even declare functions)
 169 in \fI\%curses.h\fP until 1992.
 170 .PP
 171 SVr2 (1984) documented \fB\%printw\fP and \fB\%wprintw\fP tersely as
 172 \*(``printf on \fB\%stdscr\fP\*('' and
 173 \*(``printf on \fIwin\fP\*('',
 174 respectively.
 175 .PP
 176 SVr3 (1987) added \fB\%mvprintw\fP and \fB\%mvwprintw\fP,
 177 with a three-line summary asserting that they were analogous to
 178 \fI\%printf\fP(3),
 179 explaining that the string that \fI\%printf\fP(3) would write to the
 180 standard output stream would instead be output using \fB\%waddstr\fP to
 181 the given window.
 182 SVr3 also implemented \fB\%vwprintw\fP,
 183 describing its third parameter as a \fI\%va_list\fP,
 184 defined in \fI\%varargs.h\fP,
 185 and referred the reader to the manual pages for \fI\%varargs\fP and
 186 \fI\%vprintf\fP for detailed descriptions.
 187 .PP
 188 SVr4 (1989) introduced no new variations of \fI\%printw\fP,
 189 but provided for using either \fI\%varargs.h\fP or \fI\%stdarg.h\fP to
 190 define the \fI\%va_list\fP type.
 191 .\" either header declares "va_list", but only one can be used
 192 .PP
 193 X/Open Curses, Issue 4 (1995),
 194 defined \fB\%vw_printw\fP to replace \fB\%vwprintw\fP,
 195 stating that its \fI\%va_list\fP type is defined in \fI\%stdarg.h\fP.
 196 .SH SEE ALSO
 197 \fB\%curses\fP(3X),
 198 \fB\%curs_addstr\fP(3X),
 199 \fB\%curs_scanw\fP(3X),
 200 \fB\%printf\fP(3),
 201 \fB\%vprintf\fP(3)