ncurses 6.5 - patch 20240504

[ncurses.git] / man / curs_getcchar.3x

diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x
index 1ebcdb57dc8109951296bb14f25e8c5da769e181..523cc99df92c9c73b7192c1cfe7243fd8fa51a10 100644 (file)
--- a/man/curs_getcchar.3x
+++ b/man/curs_getcchar.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2019-2021,2023 Thomas E. Dickey                                *
+.\" Copyright 2019-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 2001-2015,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 2001-2015,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,71 +27,64 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_getcchar.3x,v 1.31 2023/07/01 15:43:20 tom Exp $
-.TH curs_getcchar 3X 2023-07-01 "ncurses 6.4" "Library calls"
+.\" $Id: curs_getcchar.3x,v 1.49 2024/04/20 18:55:09 tom Exp $
+.TH curs_getcchar 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME

-\fBgetcchar\fP,
-\fBsetcchar\fP \- Get a wide character string and rendition from a \fBcchar_t\fP or set a \fBcchar_t\fP from a wide-character string
+\fB\%getcchar\fP,
+\fB\%setcchar\fP \-
+convert between a wide-character string and a \fIcurses\fR complex character

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fP
-.sp
-\fBint getcchar(\fP
-.br
-.B "        const cchar_t *\fIwcval\fP,"
-.br
-.B "        wchar_t *\fIwch\fP,"
-.br
+.nf
+\fB#include <curses.h>
+.PP
+\fBint getcchar(
+.B "        const cchar_t *\fIwch\fP,"
+.B "        wchar_t *\fIwc\fP,"

 .B "        attr_t *\fIattrs\fP,"
 .B "        attr_t *\fIattrs\fP,"

-.br

 .B "        short *\fIcolor_pair\fP,"
 .B "        short *\fIcolor_pair\fP,"

-.br

 .B "        void *\fIopts\fP );"
 .B "        void *\fIopts\fP );"

-.sp
+.PP

 .B "int setcchar("
 .B "int setcchar("

-.br
-.B "        cchar_t *\fIwcval\fP,"
-.br
-.B "        const wchar_t *\fIwch\fP,"
-.br
+.B "        cchar_t *\fIwch\fP,"
+.B "        const wchar_t *\fIwc\fP,"

 .B "        const attr_t \fIattrs\fP,"
 .B "        const attr_t \fIattrs\fP,"

-.br

 .B "        short \fIcolor_pair\fP,"
 .B "        short \fIcolor_pair\fP,"

-.br

 .B "        const void *\fIopts\fP );"
 .B "        const void *\fIopts\fP );"

+.fi

 .SH DESCRIPTION
 .SS getcchar
 The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.
 .SH DESCRIPTION
 .SS getcchar
 The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.

-When \fIwch\fP is not a null pointer,
+When \fIwc\fP is not a null pointer,

 the \fBgetcchar\fP function does the following:
 .bP
 the \fBgetcchar\fP function does the following:
 .bP

-Extracts information from a \fBcchar_t\fP value \fIwcval\fP
+Extracts information from a \fBcchar_t\fP value \fIwch\fP

 .bP
 Stores the character attributes in the location pointed to by \fIattrs\fP
 .bP
 .bP
 Stores the character attributes in the location pointed to by \fIattrs\fP
 .bP

-Stores the color-pair in the location pointed to by \fIcolor_pair\fP
+Stores the color pair in the location pointed to by \fIcolor_pair\fP

 .bP
 Stores the wide-character string,
 .bP
 Stores the wide-character string,

-characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP.
+characters referenced by \fIwch\fP, into the array pointed to by \fIwc\fP.

 .PP
 When
 .PP
 When

-\fIwch\fP
+\fIwc\fP

 is a null pointer, the
 \fBgetcchar\fP
 function does the following:
 .bP
 is a null pointer, the
 \fBgetcchar\fP
 function does the following:
 .bP

-Obtains the number of wide characters pointed to by \fIwcval\fP
+Obtains the number of wide characters pointed to by \fIwch\fP

 .bP
 Does not change the data referenced by
 \fIattrs\fP
 or
 \fIcolor_pair\fP
 .SS setcchar
 .bP
 Does not change the data referenced by
 \fIattrs\fP
 or
 \fIcolor_pair\fP
 .SS setcchar

-The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
+The \fBsetcchar\fP function initializes the location pointed to by \fIwch\fP

 by using:
 .bP
 The character attributes in
 by using:
 .bP
 The character attributes in


@@ -100,21 +93,37 @@ The character attributes in
 The color pair in
 \fIcolor_pair\fP
 .bP
 The color pair in
 \fIcolor_pair\fP
 .bP

-The wide-character string pointed to by \fIwch\fP.
-The string must be L'\\0' terminated,
+The wide-character string pointed to by \fIwc\fP.
+The string must be L'\e0' terminated,

 contain at most one spacing character,
 which must be the first.
 .IP
 contain at most one spacing character,
 which must be the first.
 .IP

-Up to \fBCCHARW_MAX\fP\-1 nonspacing characters may follow.
-Additional nonspacing characters are ignored.
+Up to \fBCCHARW_MAX\fP\-1 non-spacing characters may follow.
+Additional non-spacing characters are ignored.

 .IP
 The string may contain a single control character instead.
 .IP
 The string may contain a single control character instead.

-In that case, no nonspacing characters are allowed.
+In that case, no non-spacing characters are allowed.
+.SH RETURN VALUE
+When \fIwc\fP is a null pointer,
+\fBgetcchar\fP returns the number of wide characters referenced by
+\fIwch\fP,
+including one for a trailing null.
+.PP
+When \fIwc\fP is not a null pointer,
+\fBgetcchar\fP returns \fBOK\fP upon successful completion,
+and \fBERR\fP otherwise.
+.PP
+Upon successful completion, \fBsetcchar\fP returns \fBOK\fP.
+Otherwise, it returns \fBERR\fP.
+.SH NOTES
+The \fIwch\fP argument may be a value generated by a call to
+\fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument.
+If \fIwch\fP is constructed by any other means, the effect is unspecified.

 .SH EXTENSIONS
 X/Open Curses documents the \fIopts\fP argument as reserved for future use,
 saying that it must be null.
 This implementation
 .SH EXTENSIONS
 X/Open Curses documents the \fIopts\fP argument as reserved for future use,
 saying that it must be null.
 This implementation

-uses that parameter in ABI 6 for the functions which have a color-pair
+uses that parameter in ABI 6 for the functions which have a color pair

 parameter to support extended color pairs:
 .bP
 For  functions  which modify the color, e.g., \fBsetcchar\fP,
 parameter to support extended color pairs:
 .bP
 For  functions  which modify the color, e.g., \fBsetcchar\fP,


@@ -125,24 +134,8 @@ For functions which retrieve the color, e.g., \fBgetcchar\fP,
 if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
 and  used  to  retrieve  the color pair as an \fBint\fP value,
 in addition retrieving it via the standard pointer to \fBshort\fP parameter.
 if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
 and  used  to  retrieve  the color pair as an \fBint\fP value,
 in addition retrieving it via the standard pointer to \fBshort\fP parameter.

-.SH NOTES
-The \fIwcval\fP argument may be a value generated by a call to
-\fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument.
-If \fIwcval\fP is constructed by any other means, the effect is unspecified.
-.SH RETURN VALUE
-When \fIwch\fP is a null pointer,
-\fBgetcchar\fP returns the number of wide characters referenced by
-\fIwcval\fP,
-including one for a trailing null.
-.PP
-When \fIwch\fP is not a null pointer,
-\fBgetcchar\fP returns \fBOK\fP upon successful completion,
-and \fBERR\fP otherwise.
-.PP
-Upon successful completion, \fBsetcchar\fP returns \fBOK\fP.
-Otherwise, it returns \fBERR\fP.

 .SH PORTABILITY
 .SH PORTABILITY

-The \fBCCHARW_MAX\fP symbol is specific to ncurses.
+The \fBCCHARW_MAX\fP symbol is specific to \fI\%ncurses\fP.

 X/Open Curses does not provide details for the layout of the \fBcchar_t\fP
 structure.
 It tells what data are stored in it:
 X/Open Curses does not provide details for the layout of the \fBcchar_t\fP
 structure.
 It tells what data are stored in it:


@@ -189,8 +182,7 @@ including using them for ligatures between characters
 Unicode does not limit the (analogous) number of combining characters,
 so some applications may be affected.
 .SH SEE ALSO
 Unicode does not limit the (analogous) number of combining characters,
 so some applications may be affected.
 .SH SEE ALSO

-Functions:
-\fBcurs_attr\fP(3X),
-\fBcurs_color\fP(3X),
-\fBcurses\fP(3X),
-\fBwcwidth\fP(3).
+\fB\%curses\fP(3X),
+\fB\%curs_attr\fP(3X),
+\fB\%curs_color\fP(3X),
+\fB\%wcwidth\fP(3)