ncurses 6.2 - patch 20201017
[ncurses.git] / man / new_pair.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
3 .\" Copyright 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 .\" Author: Thomas E. Dickey
31 .\"
32 .\" $Id: new_pair.3x,v 1.15 2020/10/17 23:54:50 tom Exp $
33 .TH new_pair 3X ""
34 .ie \n(.g .ds `` \(lq
35 .el       .ds `` ``
36 .ie \n(.g .ds '' \(rq
37 .el       .ds '' ''
38 .de bP
39 .ie n  .IP \(bu 4
40 .el    .IP \(bu 2
41 ..
42 .de NS
43 .ie n  .sp
44 .el    .sp .5
45 .ie n  .in +4
46 .el    .in +2
47 .nf
48 .ft C                   \" Courier
49 ..
50 .de NE
51 .fi
52 .ft R
53 .ie n  .in -4
54 .el    .in -2
55 ..
56 .SH NAME
57 \fBalloc_pair\fP,
58 \fBfind_pair\fP,
59 \fBfree_pair\fP \- new curses color-pair functions
60 .SH SYNOPSIS
61 \fB#include <curses.h>\fP
62 .sp
63 \fBint alloc_pair(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP
64 .br
65 \fBint find_pair(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP
66 .br
67 \fBint free_pair(int \fP\fIpair\fP\fB);\fP
68 .SH DESCRIPTION
69 These functions are an extension to the curses library.
70 They permit an application to dynamically allocate a color pair using
71 the foreground/background colors rather than assign a fixed color pair number,
72 and return an unused pair to the pool.
73 .PP
74 The number of colors may be related to the number of possible color
75 pairs for a given terminal, or it may not:
76 .bP
77 While almost all terminals allow setting the color \fIattributes\fP
78 independently,
79 it is unlikely that your terminal allows you to modify the attributes
80 of a given character cell without rewriting it.
81 That is, the foreground and background colors are applied as a pair.
82 .bP
83 Color pairs are the curses library's way of managing a color palette
84 on a terminal.
85 If the library does not keep track of the \fIcombinations\fP of 
86 colors which are displayed, it will be inefficient.
87 .bP
88 For simple terminal emulators
89 with only a few dozen color combinations,
90 it is convenient to use the maximum number of combinations
91 as the limit on color pairs:
92 .NS
93 \fBCOLORS\fP\fI * \fP\fBCOLORS\fP
94 .NE
95 .bP
96 Terminals which support \fIdefault colors\fP distinct
97 from \*(``ANSI colors\*('' 
98 add to the possible combinations, producing this total:
99 .NS
100 \fI( \fP\fBCOLORS\fP\fI + 1 ) * ( \fP\fBCOLORS\fP\fI + 1 )\fP
101 .NE
102 .bP
103 An application might use up to a few dozen color pairs to
104 implement a predefined color scheme.
105 .IP
106 Beyond that lies in the realm of programs using the foreground
107 and background colors for \*(``ASCII art\*('' 
108 (or some other non-textual application).
109 .IP
110 Also beyond those few dozen pairs, the required size for a table
111 to represent the combinations grows rapidly with an increasing number of colors.
112 .IP
113 These functions allow a developer to let the screen library
114 manage color pairs.
115 .SS alloc_pair
116 The \fBalloc_pair\fP function accepts parameters for
117 foreground and background color, and
118 checks if that color combination is already associated with a color pair.
119 .bP
120 If the combination already exists,
121 \fBalloc_pair\fP returns the existing pair.
122 .bP
123 If the combination does not exist,
124 \fBalloc_pair\fP allocates a new color pair and returns that.
125 .bP
126 If the table fills up, \fBalloc_pair\fP discards the least-recently
127 allocated entry using \fBfree_pair\fP and allocates a new color pair.
128 .PP
129 All of the color pairs are allocated from a table of possible color pairs.
130 The size of the table is determined by the terminfo \fIpairs\fP capability.
131 The table is shared with \fBinit_pair\fP;
132 in fact \fBalloc_pair\fP calls \fBinit_pair\fP after
133 updating the ncurses library's fast index to the colors versus color pairs.
134 .SS find_pair
135 The \fBfind_pair\fP function accepts parameters for
136 foreground and background color, and
137 checks if that color combination is already associated with a color pair,
138 returning the pair number if it has been allocated.
139 Otherwise it returns \-1.
140 .SS free_pair
141 Marks the given color pair as unused,
142 i.e., like color pair 0.
143 .SH RETURN VALUE
144 .PP
145 The \fBalloc_pair\fP function returns a color pair number in the range
146 1 through \fBCOLOR_PAIRS\fP\-1, unless it encounters an error updating
147 its fast index to the color pair values, preventing it from allocating
148 a color pair.
149 In that case, it returns \-1.
150 .PP
151 The \fBfind_pair\fP function returns a color pair number if the
152 given color combination has been associated with a color pair,
153 or \-1 if not.
154 .PP
155 Likewise, \fBfree_pair\fP returns \fBOK\fP unless it encounters an
156 error updating the fast index or if no such color pair is in use.
157 .SH PORTABILITY
158 These routines are specific to ncurses.
159 They were not supported on
160 Version 7, BSD or System V implementations.
161 It is recommended that
162 any code depending on them be conditioned using NCURSES_VERSION.
163 .SH SEE ALSO
164 \fBcurs_color\fR(3X).
165 .SH AUTHOR
166 Thomas Dickey.