ncurses 6.2 - patch 20210911
[ncurses.git] / man / curs_insstr.3x
1 .\"***************************************************************************
2 .\" Copyright 2019-2020,2021 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_insstr.3x,v 1.27 2021/06/17 21:26:02 tom Exp $
31 .TH curs_insstr 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .SH NAME
37 \fBinsstr\fR,
38 \fBinsnstr\fR,
39 \fBwinsstr\fR,
40 \fBwinsnstr\fR,
41 \fBmvinsstr\fR,
42 \fBmvinsnstr\fR,
43 \fBmvwinsstr\fR,
44 \fBmvwinsnstr\fR \- insert string before cursor in a \fBcurses\fR window
45 .SH SYNOPSIS
46 \fB#include <curses.h>\fR
47 .br
48 \fBint insstr(const char *\fP\fIstr\fP\fB);\fR
49 .br
50 \fBint insnstr(const char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR
51 .br
52 \fBint winsstr(WINDOW *\fP\fIwin\fP\fB, const char *\fP\fIstr\fP\fB);\fR
53 .br
54 \fBint winsnstr(WINDOW *\fP\fIwin\fP\fB, const char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR
55 .sp
56 \fBint mvinsstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const char *\fP\fIstr\fP\fB);\fR
57 .br
58 \fBint mvinsnstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR
59 .br
60 \fBint mvwinsstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const char *\fP\fIstr\fP\fB);\fR
61 .br
62 \fBint mvwinsnstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const char *\fP\fIstr\fP\fB, int \fP\fIn\fP\fB);\fR
63 .br
64 .SH DESCRIPTION
65 These routines insert a character string
66 (as many characters as will fit on the line)
67 before the character under the cursor.
68 All characters to the right of the cursor are shifted right
69 with the possibility of the rightmost characters on the line being lost.
70 The cursor position does not change
71 (after moving to \fIy\fR, \fIx\fR, if specified).
72 The functions with \fIn\fR as the last argument
73 insert a leading substring of at most \fIn\fR characters.
74 If \fIn\fR<=0, then the entire string is inserted.
75 .PP
76 Special characters are handled as in \fBaddch\fP.
77 .SH RETURN VALUE
78 All routines that return an integer return \fBERR\fR upon failure and \fBOK\fP
79 (SVr4 specifies only "an integer value other than \fBERR\fR")
80 upon successful completion,
81 unless otherwise noted in the preceding routine descriptions.
82 .PP
83 X/Open defines no error conditions.
84 In this implementation,
85 if the window parameter is null or the str parameter is null,
86 an error is returned.
87 .PP
88 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
89 \fBwmove\fP, and return an error if the position is outside the window,
90 or if the window pointer is null.
91 .SH NOTES
92 Note that all but \fBwinsnstr\fR may be macros.
93 .SH PORTABILITY
94 These functions are described in the XSI Curses standard, Issue 4, which adds
95 const qualifiers to the arguments.
96 .LP
97 The Single Unix Specification, Version 2 states that
98 \fBinsnstr\fP and \fBwinsnstr\fP perform wrapping.
99 This is probably an error, since it makes this group of functions inconsistent.
100 Also, no implementation of curses documents this inconsistency.
101 .SH SEE ALSO
102 \fBcurses\fR(3X),
103 \fBcurs_util\fR(3X),
104 \fBcurs_clear\fR(3X),
105 \fBcurs_inch\fR(3X).