1 /****************************************************************************
2 * Copyright (c) 2017,2018 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Thomas E. Dickey *
31 ****************************************************************************/
34 * Common type definitions and macros for new_pair.c, lib_color.c
36 * $Id: new_pair.h,v 1.9 2018/03/01 15:02:12 tom Exp $
43 #define LIMIT_TYPED(n,t) \
44 (t)(((n) > MAX_OF_TYPE(t)) \
46 : ((n) < -MAX_OF_TYPE(t)) \
50 #define limit_COLOR(n) LIMIT_TYPED(n,NCURSES_COLOR_T)
51 #define limit_PAIRS(n) LIMIT_TYPED(n,NCURSES_PAIRS_T)
53 #define MAX_XCURSES_PAIR MAX_OF_TYPE(NCURSES_PAIRS_T)
55 #if NCURSES_EXT_COLORS
56 #define OPTIONAL_PAIR GCC_UNUSED
57 #define get_extended_pair(opts, color_pair) \
58 if ((opts) != NULL) { \
59 *(int*)(opts) = color_pair; \
61 #define set_extended_pair(opts, color_pair) \
62 if ((opts) != NULL) { \
63 color_pair = *(const int*)(opts); \
66 #define OPTIONAL_PAIR /* nothing */
67 #define get_extended_pair(opts, color_pair) /* nothing */
68 #define set_extended_pair(opts, color_pair) \
69 if ((opts) != NULL) { \
74 #ifdef NEW_PAIR_INTERNAL
77 cpKEEP = -1, /* color pair 0 */
78 cpFREE = 0, /* free for use */
79 cpINIT = 1, /* init_pair() */
80 cpAUTO = 1 /* alloc_pair() */
83 typedef struct _color_pairs
87 #if NCURSES_EXT_COLORS
88 int mode; /* tells if the entry is allocated or free */
89 int prev; /* index of previous item */
90 int next; /* index of next item */
95 #define MakeColorPair(target,f,b) target.fg = f, target.bg = b
96 #define isSamePair(a,b) ((a).fg == (b).fg && (a).bg == (b).bg)
97 #define FORE_OF(c) (c).fg
98 #define BACK_OF(c) (c).bg
101 * Ensure that we use color pairs only when colors have been started, and also
102 * that the index is within the limits of the table which we allocated.
104 #define ValidPair(sp,pair) \
105 ((sp != 0) && (pair >= 0) && (pair < sp->_pair_limit) && sp->_coloron)
107 #if NCURSES_EXT_COLORS
108 extern NCURSES_EXPORT(void) _nc_copy_pairs(SCREEN*, colorpair_t*, colorpair_t*, int);
109 extern NCURSES_EXPORT(void) _nc_free_ordered_pairs(SCREEN*);
110 extern NCURSES_EXPORT(void) _nc_reset_color_pair(SCREEN*, int, colorpair_t*);
111 extern NCURSES_EXPORT(void) _nc_set_color_pair(SCREEN*, int, int);
113 #define _nc_free_ordered_pairs(sp) /* nothing */
114 #define _nc_reset_color_pair(sp, pair, data) /* nothing */
115 #define _nc_set_color_pair(sp, pair, mode) /* nothing */
120 typedef struct _color_pairs colorpair_t;
122 #endif /* NEW_PAIR_INTERNAL */
125 extern NCURSES_EXPORT(void) _nc_new_pair_leaks(SCREEN*);
130 #endif /* NEW_PAIR_H */