ncurses/new_pair.h

   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 /****************************************************************************
  31  *  Author: Thomas E. Dickey                                                *
  32  ****************************************************************************/
  33
  34 /*
  35  * Common type definitions and macros for new_pair.c, lib_color.c
  36  *
  37  * $Id: new_pair.h,v 1.10 2020/02/02 23:34:34 tom Exp $
  38  */
  39
  40 #ifndef NEW_PAIR_H
  41 #define NEW_PAIR_H 1
  42 /* *INDENT-OFF* */
  43
  44 #define LIMIT_TYPED(n,t) \
  45         (t)(((n) > MAX_OF_TYPE(t)) \
  46             ? MAX_OF_TYPE(t) \
  47             : ((n) < -MAX_OF_TYPE(t)) \
  48                ? -MAX_OF_TYPE(t) \
  49                : (n))
  50
  51 #define limit_COLOR(n) LIMIT_TYPED(n,NCURSES_COLOR_T)
  52 #define limit_PAIRS(n) LIMIT_TYPED(n,NCURSES_PAIRS_T)
  53
  54 #define MAX_XCURSES_PAIR MAX_OF_TYPE(NCURSES_PAIRS_T)
  55
  56 #if NCURSES_EXT_COLORS
  57 #define OPTIONAL_PAIR   GCC_UNUSED
  58 #define get_extended_pair(opts, color_pair) \
  59         if ((opts) != NULL) { \
  60             *(int*)(opts) = color_pair; \
  61         }
  62 #define set_extended_pair(opts, color_pair) \
  63         if ((opts) != NULL) { \
  64             color_pair = *(const int*)(opts); \
  65         }
  66 #else
  67 #define OPTIONAL_PAIR   /* nothing */
  68 #define get_extended_pair(opts, color_pair) /* nothing */
  69 #define set_extended_pair(opts, color_pair) \
  70         if ((opts) != NULL) { \
  71             color_pair = -1; \
  72         }
  73 #endif
  74
  75 #ifdef NEW_PAIR_INTERNAL
  76
  77 typedef enum {
  78     cpKEEP = -1,                /* color pair 0 */
  79     cpFREE = 0,                 /* free for use */
  80     cpINIT = 1,                 /* init_pair() */
  81     cpAUTO = 1                  /* alloc_pair() */
  82 } CPMODE;
  83
  84 typedef struct _color_pairs
  85 {
  86     int fg;
  87     int bg;
  88 #if NCURSES_EXT_COLORS
  89     int mode;                   /* tells if the entry is allocated or free */
  90     int prev;                   /* index of previous item */
  91     int next;                   /* index of next item */
  92 #endif
  93 }
  94 colorpair_t;
  95
  96 #define MakeColorPair(target,f,b) target.fg = f, target.bg = b
  97 #define isSamePair(a,b)         ((a).fg == (b).fg && (a).bg == (b).bg)
  98 #define FORE_OF(c)              (c).fg
  99 #define BACK_OF(c)              (c).bg
 100
 101 /*
 102  * Ensure that we use color pairs only when colors have been started, and also
 103  * that the index is within the limits of the table which we allocated.
 104  */
 105 #define ValidPair(sp,pair) \
 106     ((sp != 0) && (pair >= 0) && (pair < sp->_pair_limit) && sp->_coloron)
 107
 108 #if NCURSES_EXT_COLORS
 109 extern NCURSES_EXPORT(void)     _nc_copy_pairs(SCREEN*, colorpair_t*, colorpair_t*, int);
 110 extern NCURSES_EXPORT(void)     _nc_free_ordered_pairs(SCREEN*);
 111 extern NCURSES_EXPORT(void)     _nc_reset_color_pair(SCREEN*, int, colorpair_t*);
 112 extern NCURSES_EXPORT(void)     _nc_set_color_pair(SCREEN*, int, int);
 113 #else
 114 #define _nc_free_ordered_pairs(sp) /* nothing */
 115 #define _nc_reset_color_pair(sp, pair, data) /* nothing */
 116 #define _nc_set_color_pair(sp, pair, mode) /* nothing */
 117 #endif
 118
 119 #else
 120
 121 typedef struct _color_pairs colorpair_t;
 122
 123 #endif /* NEW_PAIR_INTERNAL */
 124
 125 #if NO_LEAKS
 126 extern NCURSES_EXPORT(void)     _nc_new_pair_leaks(SCREEN*);
 127 #endif
 128
 129 /* *INDENT-ON* */
 130
 131 #endif /* NEW_PAIR_H */