1 /****************************************************************************
2 * Copyright 2018-2020,2021 Thomas E. Dickey *
3 * Copyright 2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Thomas E. Dickey *
32 ****************************************************************************/
35 * Common type definitions and macros for new_pair.c, lib_color.c
37 * $Id: new_pair.h,v 1.12 2021/08/18 19:18:12 tom Exp $
44 #include <ncurses_cfg.h>
45 #include <ncurses_dll.h>
47 #include <sys/types.h>
49 typedef struct screen SCREEN;
51 #define LIMIT_TYPED(n,t) \
52 (t)(((n) > MAX_OF_TYPE(t)) \
54 : ((n) < -MAX_OF_TYPE(t)) \
58 #define limit_COLOR(n) LIMIT_TYPED(n,NCURSES_COLOR_T)
59 #define limit_PAIRS(n) LIMIT_TYPED(n,NCURSES_PAIRS_T)
61 #define MAX_XCURSES_PAIR MAX_OF_TYPE(NCURSES_PAIRS_T)
63 #if NCURSES_EXT_COLORS
64 #define OPTIONAL_PAIR GCC_UNUSED
65 #define get_extended_pair(opts, color_pair) \
66 if ((opts) != NULL) { \
67 *(int*)(opts) = color_pair; \
69 #define set_extended_pair(opts, color_pair) \
70 if ((opts) != NULL) { \
71 color_pair = *(const int*)(opts); \
74 #define OPTIONAL_PAIR /* nothing */
75 #define get_extended_pair(opts, color_pair) /* nothing */
76 #define set_extended_pair(opts, color_pair) \
77 if ((opts) != NULL) { \
82 #ifdef NEW_PAIR_INTERNAL
85 cpKEEP = -1, /* color pair 0 */
86 cpFREE = 0, /* free for use */
87 cpINIT = 1 /* initialized */
90 typedef struct _color_pairs
94 #if NCURSES_EXT_COLORS
95 int mode; /* tells if the entry is allocated or free */
96 int prev; /* index of previous item */
97 int next; /* index of next item */
102 #define MakeColorPair(target,f,b) target.fg = f, target.bg = b
103 #define isSamePair(a,b) ((a).fg == (b).fg && (a).bg == (b).bg)
104 #define FORE_OF(c) (c).fg
105 #define BACK_OF(c) (c).bg
108 * Ensure that we use color pairs only when colors have been started, and also
109 * that the index is within the limits of the table which we allocated.
111 #define ValidPair(sp,pair) \
112 ((sp != 0) && (pair >= 0) && (pair < sp->_pair_limit) && sp->_coloron)
114 #if NCURSES_EXT_COLORS
115 extern NCURSES_EXPORT(void) _nc_copy_pairs(SCREEN*, colorpair_t*, colorpair_t*, int);
116 extern NCURSES_EXPORT(void) _nc_free_ordered_pairs(SCREEN*);
117 extern NCURSES_EXPORT(void) _nc_reset_color_pair(SCREEN*, int, colorpair_t*);
118 extern NCURSES_EXPORT(void) _nc_set_color_pair(SCREEN*, int, int);
120 #define _nc_free_ordered_pairs(sp) /* nothing */
121 #define _nc_reset_color_pair(sp, pair, data) /* nothing */
122 #define _nc_set_color_pair(sp, pair, mode) /* nothing */
127 typedef struct _color_pairs colorpair_t;
129 #endif /* NEW_PAIR_INTERNAL */
132 extern NCURSES_EXPORT(void) _nc_new_pair_leaks(SCREEN*);
137 #endif /* NEW_PAIR_H */