]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - ncurses/base/lib_color.c
ncurses 5.7 - patch 20090221
[ncurses.git] / ncurses / base / lib_color.c
index 86c3fba32cbb057579bf0078904ed358988b9094..e5985798c4ee5eda15c45af26832455657af6c1c 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2001,2002 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2007,2009 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
@@ -29,6 +29,8 @@
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Thomas E. Dickey                        1996-on                 *
+ *     and: Juergen Pfeifer                         2009                    *
  ****************************************************************************/
 
 /* lib_color.c
 #include <term.h>
 #include <tic.h>
 
-MODULE_ID("$Id: lib_color.c,v 1.62 2002/09/28 20:40:05 tom Exp $")
+MODULE_ID("$Id: lib_color.c,v 1.88 2009/02/15 00:33:02 tom Exp $")
 
 /*
  * These should be screen structure members.  They need to be globals for
  * historical reasons.  So we assign them in start_color() and also in
  * set_term()'s screen-switching logic.
  */
+#if USE_REENTRANT
+NCURSES_EXPORT(int)
+NCURSES_PUBLIC_VAR(COLOR_PAIRS) (void)
+{
+    return SP ? SP->_pair_count : -1;
+}
+NCURSES_EXPORT(int)
+NCURSES_PUBLIC_VAR(COLORS) (void)
+{
+    return SP ? SP->_color_count : -1;
+}
+#else
 NCURSES_EXPORT_VAR(int) COLOR_PAIRS = 0;
 NCURSES_EXPORT_VAR(int) COLORS = 0;
+#endif
 
 #define DATA(r,g,b) {r,g,b, 0,0,0, 0}
 
+#define TYPE_CALLOC(type,elts) typeCalloc(type, (unsigned)(elts))
+
+#define MAX_PALETTE    8
+
+#define OkColorHi(n)   (((n) < COLORS) && ((n) < max_colors))
+#define InPalette(n)   ((n) >= 0 && (n) < MAX_PALETTE)
+
 /*
  * Given a RGB range of 0..1000, we'll normally set the individual values
  * to about 2/3 of the maximum, leaving full-range for bold/bright colors.
@@ -87,6 +109,13 @@ static const color_t hls_palette[] =
 };
 /* *INDENT-ON* */
 
+/*
+ * Ensure that we use color pairs only when colors have been started, and also
+ * that the index is within the limits of the table which we allocated.
+ */
+#define ValidPair(pair) \
+    ((SP != 0) && (pair >= 0) && (pair < SP->_pair_limit) && SP->_coloron)
+
 #if NCURSES_EXT_FUNCS
 /*
  * These are called from _nc_do_color(), which in turn is called from
@@ -130,10 +159,10 @@ set_background_color(int bg, int (*outc) (int))
 {
     if (set_a_background) {
        TPUTS_TRACE("set_a_background");
-       tputs(tparm(set_a_background, bg), 1, outc);
+       tputs(TPARM_1(set_a_background, bg), 1, outc);
     } else {
        TPUTS_TRACE("set_background");
-       tputs(tparm(set_background, toggled_colors(bg)), 1, outc);
+       tputs(TPARM_1(set_background, toggled_colors(bg)), 1, outc);
     }
 }
 
@@ -142,10 +171,10 @@ set_foreground_color(int fg, int (*outc) (int))
 {
     if (set_a_foreground) {
        TPUTS_TRACE("set_a_foreground");
-       tputs(tparm(set_a_foreground, fg), 1, outc);
+       tputs(TPARM_1(set_a_foreground, fg), 1, outc);
     } else {
        TPUTS_TRACE("set_foreground");
-       tputs(tparm(set_foreground, toggled_colors(fg)), 1, outc);
+       tputs(TPARM_1(set_foreground, toggled_colors(fg)), 1, outc);
     }
 }
 
@@ -157,10 +186,10 @@ init_color_table(void)
 
     tp = (hue_lightness_saturation) ? hls_palette : cga_palette;
     for (n = 0; n < COLORS; n++) {
-       if (n < 8) {
+       if (InPalette(n)) {
            SP->_color_table[n] = tp[n];
        } else {
-           SP->_color_table[n] = tp[n % 8];
+           SP->_color_table[n] = tp[n % MAX_PALETTE];
            if (hue_lightness_saturation) {
                SP->_color_table[n].green = 100;
            } else {
@@ -216,13 +245,17 @@ _nc_reset_colors(void)
 }
 
 NCURSES_EXPORT(int)
-start_color(void)
+NCURSES_SP_NAME(start_color) (NCURSES_SP_DCL0)
 {
     int result = ERR;
 
     T((T_CALLED("start_color()")));
 
-    if (!SP->_coloron) {
+    if (SP_PARM == 0) {
+       result = ERR;
+    } else if (SP_PARM->_coloron) {
+       result = OK;
+    } else {
 
        if (reset_color_pair() != TRUE) {
            set_foreground_color(default_fg(), _nc_outch);
@@ -230,29 +263,55 @@ start_color(void)
        }
 
        if (max_pairs > 0 && max_colors > 0) {
-           COLOR_PAIRS = SP->_pair_count = max_pairs;
-           COLORS = SP->_color_count = max_colors;
+           SP_PARM->_pair_limit = max_pairs;
 
-           if ((SP->_color_pairs = typeCalloc(unsigned short,
-                                                (unsigned) max_pairs)) != 0) {
-               if ((SP->_color_table = typeCalloc(color_t, max_colors)) != 0) {
-                   SP->_color_pairs[0] = PAIR_OF(default_fg(), default_bg());
+#if NCURSES_EXT_FUNCS
+           /*
+            * If using default colors, allocate extra space in table to
+            * allow for default-color as a component of a color-pair.
+            */
+           SP_PARM->_pair_limit += (1 + (2 * max_colors));
+#endif
+           SP_PARM->_pair_count = max_pairs;
+           SP_PARM->_color_count = max_colors;
+#if !USE_REENTRANT
+           COLOR_PAIRS = max_pairs;
+           COLORS = max_colors;
+#endif
+
+           SP_PARM->_color_pairs = TYPE_CALLOC(colorpair_t,
+                                               SP_PARM->_pair_limit);
+           if (SP_PARM->_color_pairs != 0) {
+               SP_PARM->_color_table = TYPE_CALLOC(color_t, max_colors);
+               if (SP_PARM->_color_table != 0) {
+                   SP_PARM->_color_pairs[0] = PAIR_OF(default_fg(),
+                                                      default_bg());
                    init_color_table();
 
                    T(("started color: COLORS = %d, COLOR_PAIRS = %d",
                       COLORS, COLOR_PAIRS));
 
-                   SP->_coloron = 1;
+                   SP_PARM->_coloron = 1;
                    result = OK;
-               } else {
-                   FreeAndNull(SP->_color_pairs);
+               } else if (SP_PARM->_color_pairs != 0) {
+                   FreeAndNull(SP_PARM->_color_pairs);
                }
            }
+       } else {
+           result = OK;
        }
     }
-    returnCode(OK);
+    returnCode(result);
 }
 
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+start_color(void)
+{
+    return NCURSES_SP_NAME(start_color) (CURRENT_SCREEN);
+}
+#endif
+
 /* This function was originally written by Daniel Weaver <danw@znyx.com> */
 static void
 rgb2hls(short r, short g, short b, short *h, short *l, short *s)
@@ -296,29 +355,77 @@ rgb2hls(short r, short g, short b, short *h, short *l, short *s)
  * values.
  */
 NCURSES_EXPORT(int)
-init_pair(short pair, short f, short b)
+NCURSES_SP_NAME(init_pair) (NCURSES_SP_DCLx short pair, short f, short b)
 {
-    unsigned result;
+    colorpair_t result;
+    colorpair_t previous;
 
     T((T_CALLED("init_pair(%d,%d,%d)"), pair, f, b));
 
-    if ((pair < 0) || (pair >= COLOR_PAIRS))
+    if (!ValidPair(pair))
        returnCode(ERR);
+
+    previous = SP_PARM->_color_pairs[pair];
 #if NCURSES_EXT_FUNCS
-    if (SP->_default_color) {
-       if (f < 0)
-           f = C_MASK;
-       if (b < 0)
-           b = C_MASK;
-       if (f >= COLORS && f != C_MASK)
+    if (SP_PARM->_default_color) {
+       bool isDefault = FALSE;
+       bool wasDefault = FALSE;
+       int default_pairs = SP_PARM->_default_pairs;
+
+       /*
+        * Map caller's color number, e.g., -1, 0, 1, .., 7, etc., into
+        * internal unsigned values which we will store in the _color_pairs[]
+        * table.
+        */
+       if (isDefaultColor(f)) {
+           f = COLOR_DEFAULT;
+           isDefault = TRUE;
+       } else if (!OkColorHi(f)) {
            returnCode(ERR);
-       if (b >= COLORS && b != C_MASK)
+       }
+
+       if (isDefaultColor(b)) {
+           b = COLOR_DEFAULT;
+           isDefault = TRUE;
+       } else if (!OkColorHi(b)) {
            returnCode(ERR);
+       }
+
+       /*
+        * Check if the table entry that we are going to init/update used
+        * default colors.
+        */
+       if ((FORE_OF(previous) == COLOR_DEFAULT)
+           || (BACK_OF(previous) == COLOR_DEFAULT))
+           wasDefault = TRUE;
+
+       /*
+        * Keep track of the number of entries in the color pair table which
+        * used a default color.
+        */
+       if (isDefault && !wasDefault) {
+           ++default_pairs;
+       } else if (wasDefault && !isDefault) {
+           --default_pairs;
+       }
+
+       /*
+        * As an extension, ncurses allows the pair number to exceed the
+        * terminal's color_pairs value for pairs using a default color.
+        *
+        * Note that updating a pair which used a default color with one
+        * that does not will decrement the count - and possibly interfere
+        * with sequentially adding new pairs.
+        */
+       if (pair > (SP_PARM->_pair_count + default_pairs)) {
+           returnCode(ERR);
+       }
+       SP_PARM->_default_pairs = default_pairs;
     } else
 #endif
     {
-       if ((f < 0) || (f >= COLORS)
-           || (b < 0) || (b >= COLORS)
+       if ((f < 0) || !OkColorHi(f)
+           || (b < 0) || !OkColorHi(b)
            || (pair < 1))
            returnCode(ERR);
     }
@@ -329,16 +436,15 @@ init_pair(short pair, short f, short b)
      * pair colors with the new ones).
      */
     result = PAIR_OF(f, b);
-    if (SP->_color_pairs[pair] != 0
-       && SP->_color_pairs[pair] != result) {
+    if (previous != 0
+       && previous != result) {
        int y, x;
-       attr_t z = COLOR_PAIR(pair);
 
        for (y = 0; y <= curscr->_maxy; y++) {
            struct ldat *ptr = &(curscr->_line[y]);
            bool changed = FALSE;
            for (x = 0; x <= curscr->_maxx; x++) {
-               if ((AttrOf(ptr->text[x]) & A_COLOR) == z) {
+               if (GetPair(ptr->text[x]) == pair) {
                    /* Set the old cell to zero to ensure it will be
                       updated on the next doupdate() */
                    SetChar(ptr->text[x], 0, 0);
@@ -350,76 +456,102 @@ init_pair(short pair, short f, short b)
                _nc_make_oldhash(y);
        }
     }
-    SP->_color_pairs[pair] = result;
-    if ((int) (SP->_current_attr & A_COLOR) == COLOR_PAIR(pair))
-       SP->_current_attr |= A_COLOR;   /* force attribute update */
+    SP_PARM->_color_pairs[pair] = result;
+    if (GET_SCREEN_PAIR(SP_PARM) == pair)
+       SET_SCREEN_PAIR(SP_PARM, (chtype) (~0));        /* force attribute update */
 
-    if (initialize_pair) {
+    if (initialize_pair && InPalette(f) && InPalette(b)) {
        const color_t *tp = hue_lightness_saturation ? hls_palette : cga_palette;
 
-       T(("initializing pair: pair = %d, fg=(%d,%d,%d), bg=(%d,%d,%d)",
-          pair,
-          tp[f].red, tp[f].green, tp[f].blue,
-          tp[b].red, tp[b].green, tp[b].blue));
-
-       if (initialize_pair) {
-           TPUTS_TRACE("initialize_pair");
-           putp(tparm(initialize_pair,
-                      pair,
-                      tp[f].red, tp[f].green, tp[f].blue,
-                      tp[b].red, tp[b].green, tp[b].blue));
-       }
+       TR(TRACE_ATTRS,
+          ("initializing pair: pair = %d, fg=(%d,%d,%d), bg=(%d,%d,%d)",
+           pair,
+           tp[f].red, tp[f].green, tp[f].blue,
+           tp[b].red, tp[b].green, tp[b].blue));
+
+       TPUTS_TRACE("initialize_pair");
+       putp(TPARM_7(initialize_pair,
+                    pair,
+                    tp[f].red, tp[f].green, tp[f].blue,
+                    tp[b].red, tp[b].green, tp[b].blue));
     }
 
     returnCode(OK);
 }
 
-#define okRGB(n) ((n) >= 0 && (n) < 1000)
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+init_pair(short pair, short f, short b)
+{
+    return NCURSES_SP_NAME(init_pair) (CURRENT_SCREEN, pair, f, b);
+}
+#endif
+
+#define okRGB(n) ((n) >= 0 && (n) <= 1000)
 
 NCURSES_EXPORT(int)
-init_color(short color, short r, short g, short b)
+NCURSES_SP_NAME(init_color) (NCURSES_SP_DCLx
+                            short color, short r, short g, short b)
 {
     int result = ERR;
 
     T((T_CALLED("init_color(%d,%d,%d,%d)"), color, r, g, b));
 
     if (initialize_color != NULL
-       && (color >= 0 && color < COLORS)
+       && SP_PARM != 0
+       && SP_PARM->_coloron
+       && (color >= 0 && OkColorHi(color))
        && (okRGB(r) && okRGB(g) && okRGB(b))) {
 
-       SP->_color_table[color].init = 1;
-       SP->_color_table[color].r = r;
-       SP->_color_table[color].g = g;
-       SP->_color_table[color].b = b;
+       SP_PARM->_color_table[color].init = 1;
+       SP_PARM->_color_table[color].r = r;
+       SP_PARM->_color_table[color].g = g;
+       SP_PARM->_color_table[color].b = b;
 
        if (hue_lightness_saturation) {
            rgb2hls(r, g, b,
-                   &SP->_color_table[color].red,
-                   &SP->_color_table[color].green,
-                   &SP->_color_table[color].blue);
+                   &SP_PARM->_color_table[color].red,
+                   &SP_PARM->_color_table[color].green,
+                   &SP_PARM->_color_table[color].blue);
        } else {
-           SP->_color_table[color].red = r;
-           SP->_color_table[color].green = g;
-           SP->_color_table[color].blue = b;
+           SP_PARM->_color_table[color].red = r;
+           SP_PARM->_color_table[color].green = g;
+           SP_PARM->_color_table[color].blue = b;
        }
 
        TPUTS_TRACE("initialize_color");
-       putp(tparm(initialize_color, color, r, g, b));
-       SP->_color_defs = max(color + 1, SP->_color_defs);
+       putp(TPARM_4(initialize_color, color, r, g, b));
+       SP_PARM->_color_defs = max(color + 1, SP_PARM->_color_defs);
        result = OK;
     }
     returnCode(result);
 }
 
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+init_color(short color, short r, short g, short b)
+{
+    return NCURSES_SP_NAME(init_color) (CURRENT_SCREEN, color, r, g, b);
+}
+#endif
+
 NCURSES_EXPORT(bool)
-can_change_color(void)
+NCURSES_SP_NAME(can_change_color) (NCURSES_SP_DCL0)
 {
     T((T_CALLED("can_change_color()")));
     returnCode((can_change != 0) ? TRUE : FALSE);
 }
 
+#if NCURSES_SP_FUNCS
 NCURSES_EXPORT(bool)
-has_colors(void)
+can_change_color(void)
+{
+    return NCURSES_SP_NAME(can_change_color) (CURRENT_SCREEN);
+}
+#endif
+
+NCURSES_EXPORT(bool)
+NCURSES_SP_NAME(has_colors) (NCURSES_SP_DCL0)
 {
     T((T_CALLED("has_colors()")));
     returnCode((VALID_NUMERIC(max_colors) && VALID_NUMERIC(max_pairs)
@@ -430,71 +562,127 @@ has_colors(void)
                    || set_color_pair)) ? TRUE : FALSE);
 }
 
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(bool)
+has_colors(void)
+{
+    return NCURSES_SP_NAME(has_colors) (CURRENT_SCREEN);
+}
+#endif
+
 NCURSES_EXPORT(int)
-color_content(short color, short *r, short *g, short *b)
+NCURSES_SP_NAME(color_content) (NCURSES_SP_DCLx short color, short *r,
+                               short *g, short *b)
 {
+    int result;
+
     T((T_CALLED("color_content(%d,%p,%p,%p)"), color, r, g, b));
-    if (color < 0 || color >= COLORS)
-       returnCode(ERR);
+    if (color < 0 || !OkColorHi(color) || SP_PARM == 0 || !SP_PARM->_coloron) {
+       result = ERR;
+    } else {
+       NCURSES_COLOR_T c_r = SP_PARM->_color_table[color].red;
+       NCURSES_COLOR_T c_g = SP_PARM->_color_table[color].green;
+       NCURSES_COLOR_T c_b = SP_PARM->_color_table[color].blue;
+
+       if (r)
+           *r = c_r;
+       if (g)
+           *g = c_g;
+       if (b)
+           *b = c_b;
+
+       TR(TRACE_ATTRS, ("...color_content(%d,%d,%d,%d)",
+                        color, c_r, c_g, c_b));
+       result = OK;
+    }
+    returnCode(result);
+}
 
-    if (r)
-       *r = SP->_color_table[color].red;
-    if (g)
-       *g = SP->_color_table[color].green;
-    if (b)
-       *b = SP->_color_table[color].blue;
-    T(("...color_content(%d,%d,%d,%d)", color, *r, *g, *b));
-    returnCode(OK);
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+color_content(short color, short *r, short *g, short *b)
+{
+    return NCURSES_SP_NAME(color_content) (CURRENT_SCREEN, color, r, g, b);
 }
+#endif
 
 NCURSES_EXPORT(int)
-pair_content(short pair, short *f, short *b)
+NCURSES_SP_NAME(pair_content) (NCURSES_SP_DCLx short pair, short *f,
+                              short *b)
 {
+    int result;
+
     T((T_CALLED("pair_content(%d,%p,%p)"), pair, f, b));
 
-    if ((pair < 0) || (pair >= COLOR_PAIRS))
-       returnCode(ERR);
-    if (f)
-       *f = ((SP->_color_pairs[pair] >> C_SHIFT) & C_MASK);
-    if (b)
-       *b = (SP->_color_pairs[pair] & C_MASK);
+    if (!ValidPair(pair)) {
+       result = ERR;
+    } else {
+       NCURSES_COLOR_T fg = FORE_OF(SP_PARM->_color_pairs[pair]);
+       NCURSES_COLOR_T bg = BACK_OF(SP_PARM->_color_pairs[pair]);
 
-    T(("...pair_content(%d,%d,%d)", pair, *f, *b));
-    returnCode(OK);
+#if NCURSES_EXT_FUNCS
+       if (fg == COLOR_DEFAULT)
+           fg = -1;
+       if (bg == COLOR_DEFAULT)
+           bg = -1;
+#endif
+
+       if (f)
+           *f = fg;
+       if (b)
+           *b = bg;
+
+       TR(TRACE_ATTRS, ("...pair_content(%d,%d,%d)", pair, fg, bg));
+       result = OK;
+    }
+    returnCode(result);
 }
 
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+pair_content(short pair, short *f, short *b)
+{
+    return NCURSES_SP_NAME(pair_content) (CURRENT_SCREEN, pair, f, b);
+}
+#endif
+
 NCURSES_EXPORT(void)
-_nc_do_color(int old_pair, int pair, bool reverse, int (*outc) (int))
+_nc_do_color(short old_pair, short pair, bool reverse, int (*outc) (int))
 {
-    NCURSES_COLOR_T fg = C_MASK, bg = C_MASK;
+    NCURSES_COLOR_T fg = COLOR_DEFAULT;
+    NCURSES_COLOR_T bg = COLOR_DEFAULT;
     NCURSES_COLOR_T old_fg, old_bg;
 
-    if (pair < 0 || pair >= COLOR_PAIRS) {
+    if (!ValidPair(pair)) {
        return;
     } else if (pair != 0) {
        if (set_color_pair) {
            TPUTS_TRACE("set_color_pair");
-           tputs(tparm(set_color_pair, pair), 1, outc);
+           tputs(TPARM_1(set_color_pair, pair), 1, outc);
            return;
        } else if (SP != 0) {
-           pair_content(pair, &fg, &bg);
+           pair_content((short) pair, &fg, &bg);
        }
     }
 
     if (old_pair >= 0
        && SP != 0
        && pair_content(old_pair, &old_fg, &old_bg) != ERR) {
-       if ((fg == C_MASK && old_fg != C_MASK)
-           || (bg == C_MASK && old_bg != C_MASK)) {
+       if ((isDefaultColor(fg) && !isDefaultColor(old_fg))
+           || (isDefaultColor(bg) && !isDefaultColor(old_bg))) {
 #if NCURSES_EXT_FUNCS
            /*
             * A minor optimization - but extension.  If "AX" is specified in
             * the terminal description, treat it as screen's indicator of ECMA
             * SGR 39 and SGR 49, and assume the two sequences are independent.
             */
-           if (SP->_has_sgr_39_49 && old_bg == C_MASK && old_fg != C_MASK) {
+           if (SP->_has_sgr_39_49
+               && isDefaultColor(old_bg)
+               && !isDefaultColor(old_fg)) {
                tputs("\033[39m", 1, outc);
-           } else if (SP->_has_sgr_39_49 && old_fg == C_MASK && old_bg != C_MASK) {
+           } else if (SP->_has_sgr_39_49
+                      && isDefaultColor(old_fg)
+                      && !isDefaultColor(old_bg)) {
                tputs("\033[49m", 1, outc);
            } else
 #endif
@@ -507,9 +695,9 @@ _nc_do_color(int old_pair, int pair, bool reverse, int (*outc) (int))
     }
 
 #if NCURSES_EXT_FUNCS
-    if (fg == C_MASK)
+    if (isDefaultColor(fg))
        fg = default_fg();
-    if (bg == C_MASK)
+    if (isDefaultColor(bg))
        bg = default_bg();
 #endif
 
@@ -522,10 +710,10 @@ _nc_do_color(int old_pair, int pair, bool reverse, int (*outc) (int))
     TR(TRACE_ATTRS, ("setting colors: pair = %d, fg = %d, bg = %d", pair,
                     fg, bg));
 
-    if (fg != C_MASK) {
+    if (!isDefaultColor(fg)) {
        set_foreground_color(fg, outc);
     }
-    if (bg != C_MASK) {
+    if (!isDefaultColor(bg)) {
        set_background_color(bg, outc);
     }
 }