X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_insstr.3x.html;h=55bcbe1bc6085806acbc3f15501752ee97b318e0;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=266cae1b2b3096efbcab600b57f5ed1026774391;hpb=0ac2306dd3aaab1338d8b1458c15a7e476cfc3ff;p=ncurses.git diff --git a/doc/html/man/curs_insstr.3x.html b/doc/html/man/curs_insstr.3x.html index 266cae1b..55bcbe1b 100644 --- a/doc/html/man/curs_insstr.3x.html +++ b/doc/html/man/curs_insstr.3x.html @@ -1,7 +1,7 @@ - - +
-- -curs_insstr(3x) curs_insstr(3x) +curs_insstr(3x) Library calls curs_insstr(3x) --
- insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr, - mvwinsstr, mvwinsnstr - insert string before cursor in a - curses window +
+ insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr, mvwinsstr, + mvwinsnstr - insert a string in a curses window --
+
#include <curses.h> - int insstr(const char *str); - int insnstr(const char *str, int n); - int winsstr(WINDOW *win, const char *str); - int winsnstr(WINDOW *win, const char *str, int n); - int mvinsstr(int y, int x, const char *str); - int mvinsnstr(int y, int x, const char *str, int n); - int mvwinsstr(WINDOW *win, int y, int x, const char *str); - int mvwinsnstr(WINDOW *win, int y, int x, const char *str, - int n); + int insstr(const char *str); + int insnstr(const char *str, int n); + int winsstr(WINDOW *win, const char *str); + int winsnstr(WINDOW *win, const char *str, int n); + int mvinsstr(int y, int x, const char *str); + int mvinsnstr(int y, int x, const char *str, int n); + int mvwinsstr(WINDOW *win, int y, int x, const char *str); + int mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n); --
- These routines insert a character string (as many charac- - ters as will fit on the line) before the character under - the cursor. All characters to the right of the cursor are - shifted right with the possibility of the rightmost char- - acters on the line being lost. The cursor position does - not change (after moving to y, x, if specified). The - functions with n as the last argument insert a leading - substring of at most n characters. If n<=0, then the - entire string is inserted. - Special characters are handled as in addch. +
+ These routines insert a character string (as many characters as will + fit on the line) before the character under the cursor, as if calling + winsch(3x). All characters to the right of the cursor are shifted + right, with the possibility of the rightmost characters on the line + being lost. No wrapping is performed. + The cursor position does not change (after moving to y, x, if + specified). --
- All routines that return an integer return ERR upon fail- - ure and OK (SVr4 specifies only "an integer value other - than ERR") upon successful completion, unless otherwise - noted in the preceding routine descriptions. + The functions with n as the last argument insert a leading substring of + at most n characters. If n is less than zero, the entire string is + inserted (stopping on a NUL character). - X/Open defines no error conditions. In this implementa- - tion, if the window parameter is null or the str parameter - is null, an error is returned. + Special characters are handled as in waddch(3x). - Functions with a "mv" prefix first perform a cursor move- - ment using wmove, and return an error if the position is - outside the window, or if the window pointer is null. +
+ All functions return the integer ERR upon failure and OK on success. --
- Note that all but winsnstr may be macros. + X/Open Curses does not specify any error conditions. This + implementation returns ERR + o if the win parameter is null or --
- These functions are described in the XSI Curses standard, - Issue 4, which adds const qualifiers to the arguments. + o if the str parameter is null or - The Single Unix Specification, Version 2 states that - insnstr and winsnstr perform wrapping. This is probably - an error, since it makes this group of functions inconsis- - tent. Also, no implementation of curses documents this - inconsistency. + o the winsch(3x) function returns ERR. + Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries. --
- curses(3x), curs_util(3x), curs_clear(3x), curs_inch(3x). + +
+ All but winsnstr may be macros. + + +
+ X/Open Curses, Issue 4 describes these functions. It specifies no + error conditions for them. + + Issue 4 distinguished insnstr and winsnstr by stating they "do not + perform wrapping". This was probably an error, since it makes this + group of functions inconsistent. No implementation of curses documents + this inconsistency, and Issue 7 removed it. + + Issue 4 states that the entire string is inserted if n is less than 1. + This is probably an error, because it is inconsistent with other + functions, and differs from the SVr4 curses and Solaris xcurses + implementations. Nevertheless, Issue 7 retains it. + + +
+ curs_ins_wstr(3x) describes comparable functions of the ncurses library + in its wide-character configuration (ncursesw). + + curses(3x), curs_inch(3x), curs_ins_wstr(3x), curs_util(3x) - curs_insstr(3x) +ncurses 6.5 2024-06-08 curs_insstr(3x)-