ncurses 6.0 - patch 20171118
[ncurses.git] / man / new_pair.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 2017 Free Software Foundation, Inc.                        *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" Author: Thomas E. Dickey
30 .\"
31 .\" $Id: new_pair.3x,v 1.10 2017/11/18 23:48:44 tom Exp $
32 .TH new_pair 3X ""
33 .ie \n(.g .ds `` \(lq
34 .el       .ds `` ``
35 .ie \n(.g .ds '' \(rq
36 .el       .ds '' ''
37 .de bP
38 .ie n  .IP \(bu 4
39 .el    .IP \(bu 2
40 ..
41 .de NS
42 .ie n  .sp
43 .el    .sp .5
44 .ie n  .in +4
45 .el    .in +2
46 .nf
47 .ft C                   \" Courier
48 ..
49 .de NE
50 .fi
51 .ft R
52 .in -4
53 ..
54 .SH NAME
55 \fBalloc_pair\fP,
56 \fBfind_pair\fP,
57 \fBfree_pair\fP \- new curses color-pair functions
58 .SH SYNOPSIS
59 \fB#include <curses.h>\fP
60 .sp
61 \fBint alloc_pair(int fg, int bg);\fP
62 .br
63 \fBint find_pair(int fg, int bg);\fP
64 .br
65 \fBint free_pair(int pair);\fP
66 .SH DESCRIPTION
67 These functions are an extension to the curses library.
68 They permit an application to dynamically allocate a color pair using
69 the foreground/background colors rather than assign a fixed color pair number,
70 and return an unused pair to the pool.
71 .PP
72 The number of colors may be related to the number of possible color
73 pairs for a given terminal, or it may not:
74 .bP
75 While almost all terminals allow setting the color \fIattributes\fP
76 independently,
77 it is unlikely that your terminal allows you to modify the attributes
78 of a given character cell without rewriting it.
79 That is, the foreground and background colors are applied as a pair.
80 .bP
81 Color pairs are the curses library's way of managing a color palette
82 on a terminal.
83 If the library does not keep track of the \fIcombinations\fP of 
84 colors which are displayed, it will be inefficient.
85 .bP
86 For simple terminal emulators
87 with only a few dozen color combinations,
88 it is convenient to use the maximum number of combinations
89 as the limit on color pairs:
90 .NS
91 \fBCOLORS\fP\fI * \fP\fBCOLORS\fP
92 .NE
93 .bP
94 Terminals which support \fIdefault colors\fP distinct from \*(``ANSI colors\*('' 
95 add to the possible combinations, producing this total:
96 .NS
97 \fI( \fP\fBCOLORS\fP\fI + 1 ) * ( \fP\fBCOLORS\fP\fI + 1 )\fP
98 .NE
99 .bP
100 An application might use up to a few dozen color pairs to
101 implement a predefined color scheme.
102 .IP
103 Beyond that lies in the realm of programs using the foreground
104 and background colors for \*(``ASCII art\*('' 
105 (or some other non-textual application).
106 .IP
107 Also beyond those few dozen pairs, the required size for a table
108 to represent the combinations grows rapidly with an increasing number of colors.
109 .IP
110 These functions allow a developer to let the screen library
111 manage color pairs.
112 .SS alloc_pair
113 The \fBalloc_pair\fP function accepts parameters for
114 foreground and background color, and
115 checks if that color combination is already associated with a color pair.
116 .bP
117 If the combination already exists, \fBalloc_pair\fP returns the existing pair.
118 .bP
119 If the combination does not exist, \fBalloc_pair\fP allocates a new color pair and returns that.
120 .bP
121 If the table fills up, \fBalloc_pair\fP discards the least-recently
122 allocated entry using \fBfree_pair\fP and allocates a new color pair.
123 .PP
124 All of the color pairs are allocated from a table of possible color pairs.
125 The size of the table is determined by the terminfo \fIpairs\fP capability.
126 The table is shared with \fBinit_pair\fP;
127 in fact \fBalloc_pair\fP calls \fBinit_pair\fP after
128 updating the ncurses library's fast index to the colors versus color pairs.
129 .SS find_pair
130 The \fBfind_pair\fP function accepts parameters for
131 foreground and background color, and
132 checks if that color combination is already associated with a color pair,
133 returning the pair number if it has been allocated.
134 Otherwise it returns \-1.
135 .SS free_pair
136 Marks the given color pair as unused,
137 i.e., like color pair 0.
138 .SH RETURN VALUE
139 .PP
140 The \fBalloc_pair\fP function returns a color pair number in the range
141 1 through \fBCOLOR_PAIRS\fP\-1, unless it encounters an error updating
142 its fast index to the color pair values, preventing it from allocating
143 a color pair.  In that case, it returns \-1.
144 .PP
145 The \fBfind_pair\fP function returns a color pair number if the
146 given color combination has been associated with a color pair,
147 or \-1 if not.
148 .PP
149 Likewise, \fBfree_pair\fP returns \fBOK\fP unless it encounters an
150 error updating the fast index or if no such color pair is in use.
151 .SH PORTABILITY
152 These routines are specific to ncurses.  They were not supported on
153 Version 7, BSD or System V implementations.  It is recommended that
154 any code depending on them be conditioned using NCURSES_VERSION.
155 .SH SEE ALSO
156 \fBinit_pair\fR(3X).
157 .SH AUTHOR
158 Thomas Dickey.