gdkcolor.c 8.52 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GDK - The GIMP Drawing Kit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

27
#include <time.h>
Owen Taylor's avatar
Started  
Owen Taylor committed
28

29
#include "gdkscreen.h"
Owen Taylor's avatar
Started  
Owen Taylor committed
30
#include "gdkcolor.h"
31
#include "gdkinternals.h"
Elliot Lee's avatar
Elliot Lee committed
32

Matthias Clasen's avatar
Matthias Clasen committed
33 34
/**
 * gdk_colormap_ref:
Owen Taylor's avatar
Owen Taylor committed
35
 * @cmap: a #GdkColormap
Matthias Clasen's avatar
Matthias Clasen committed
36 37 38 39 40
 *
 * Deprecated function; use g_object_ref() instead.
 *
 * Return value: the colormap
 **/
Elliot Lee's avatar
Elliot Lee committed
41 42 43
GdkColormap*
gdk_colormap_ref (GdkColormap *cmap)
{
44
  return (GdkColormap *) g_object_ref (cmap);
Elliot Lee's avatar
Elliot Lee committed
45 46
}

Matthias Clasen's avatar
Matthias Clasen committed
47 48
/**
 * gdk_colormap_unref:
Owen Taylor's avatar
Owen Taylor committed
49
 * @cmap: a #GdkColormap
Matthias Clasen's avatar
Matthias Clasen committed
50 51 52
 *
 * Deprecated function; use g_object_ref() instead.
 **/
Elliot Lee's avatar
Elliot Lee committed
53 54 55
void
gdk_colormap_unref (GdkColormap *cmap)
{
56
  g_object_unref (cmap);
Elliot Lee's avatar
Elliot Lee committed
57 58
}

Matthias Clasen's avatar
Matthias Clasen committed
59 60 61 62 63 64 65 66 67

/**
 * gdk_colormap_get_visual:
 * @colormap: a #GdkColormap.
 * 
 * Returns the visual for which a given colormap was created.
 * 
 * Return value: the visual of the colormap.
 **/
68 69 70
GdkVisual *
gdk_colormap_get_visual (GdkColormap *colormap)
{
71
  g_return_val_if_fail (GDK_IS_COLORMAP (colormap), NULL);
72

73
  return colormap->visual;
74
}
Matthias Clasen's avatar
Matthias Clasen committed
75 76 77 78 79 80 81 82 83 84 85

/**
 * gdk_colors_store:
 * @colormap: a #GdkColormap.
 * @colors: the new color values.
 * @ncolors: the number of colors to change.
 * 
 * Changes the value of the first @ncolors colors in
 * a private colormap. This function is obsolete and
 * should not be used. See gdk_color_change().
 **/     
Elliot Lee's avatar
Elliot Lee committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
void
gdk_colors_store (GdkColormap   *colormap,
		  GdkColor      *colors,
		  gint           ncolors)
{
  gint i;

  for (i = 0; i < ncolors; i++)
    {
      colormap->colors[i].pixel = colors[i].pixel;
      colormap->colors[i].red = colors[i].red;
      colormap->colors[i].green = colors[i].green;
      colormap->colors[i].blue = colors[i].blue;
    }

  gdk_colormap_change (colormap, ncolors);
}

104 105
static GMemChunk *color_chunk;

Matthias Clasen's avatar
Matthias Clasen committed
106 107 108 109 110 111 112 113 114
/**
 * gdk_color_copy:
 * @color: a #GdkColor.
 * 
 * Makes a copy of a color structure. The result
 * must be freed using gdk_color_free().
 * 
 * Return value: a copy of @color.
 **/
115
GdkColor*
Owen Taylor's avatar
Owen Taylor committed
116
gdk_color_copy (const GdkColor *color)
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
{
  GdkColor *new_color;
  
  g_return_val_if_fail (color != NULL, NULL);

  if (color_chunk == NULL)
    color_chunk = g_mem_chunk_new ("colors",
				   sizeof (GdkColor),
				   4096,
				   G_ALLOC_AND_FREE);

  new_color = g_chunk_new (GdkColor, color_chunk);
  *new_color = *color;
  return new_color;
}

Matthias Clasen's avatar
Matthias Clasen committed
133 134 135 136 137 138 139
/**
 * gdk_color_free:
 * @color: a #GdkColor.
 * 
 * Frees a color structure created with 
 * gdk_color_copy().
 **/
140 141 142 143 144 145 146 147 148
void
gdk_color_free (GdkColor *color)
{
  g_assert (color_chunk != NULL);
  g_return_if_fail (color != NULL);

  g_mem_chunk_free (color_chunk, color);
}

Matthias Clasen's avatar
Matthias Clasen committed
149 150 151 152 153 154 155 156 157 158
/**
 * gdk_color_white:
 * @colormap: a #GdkColormap.
 * @color: the location to store the color.
 * 
 * Returns the white color for a given colormap. The resulting
 * value has already allocated been allocated. 
 * 
 * Return value: %TRUE if the allocation succeeded.
 **/
159
gboolean
Elliot Lee's avatar
Elliot Lee committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
gdk_color_white (GdkColormap *colormap,
		 GdkColor    *color)
{
  gint return_val;

  g_return_val_if_fail (colormap != NULL, FALSE);

  if (color)
    {
      color->red = 65535;
      color->green = 65535;
      color->blue = 65535;

      return_val = gdk_color_alloc (colormap, color);
    }
  else
    return_val = FALSE;

  return return_val;
}

Matthias Clasen's avatar
Matthias Clasen committed
181 182 183 184 185 186 187 188 189 190
/**
 * gdk_color_black:
 * @colormap: a #GdkColormap.
 * @color: the location to store the color.
 * 
 * Returns the black color for a given colormap. The resulting
 * value has already benn allocated. 
 * 
 * Return value: %TRUE if the allocation succeeded.
 **/
191
gboolean
Elliot Lee's avatar
Elliot Lee committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
gdk_color_black (GdkColormap *colormap,
		 GdkColor    *color)
{
  gint return_val;

  g_return_val_if_fail (colormap != NULL, FALSE);

  if (color)
    {
      color->red = 0;
      color->green = 0;
      color->blue = 0;

      return_val = gdk_color_alloc (colormap, color);
    }
  else
    return_val = FALSE;

  return return_val;
}

213 214 215 216
/********************
 * Color allocation *
 ********************/

Matthias Clasen's avatar
Matthias Clasen committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
/**
 * gdk_colormap_alloc_color:
 * @colormap: a #GdkColormap.
 * @color: the color to allocate. On return the
 *    <structfield>pixel</structfield> field will be
 *    filled in if allocation succeeds.
 * @writeable: If %TRUE, the color is allocated writeable
 *    (their values can later be changed using gdk_color_change()).
 *    Writeable colors cannot be shared between applications.
 * @best_match: If %TRUE, GDK will attempt to do matching against
 *    existing colors if the color cannot be allocated as requested.
 *
 * Allocates a single color from a colormap.
 * 
 * Return value: %TRUE if the allocation succeeded.
 **/
233 234 235 236 237 238 239 240 241 242 243 244 245 246
gboolean
gdk_colormap_alloc_color (GdkColormap *colormap,
			  GdkColor    *color,
			  gboolean     writeable,
			  gboolean     best_match)
{
  gboolean success;

  gdk_colormap_alloc_colors (colormap, color, 1, writeable, best_match,
			     &success);

  return success;
}

Matthias Clasen's avatar
Matthias Clasen committed
247 248 249 250 251 252 253 254 255 256 257
/**
 * gdk_color_alloc:
 * @colormap: a #GdkColormap.
 * @color: The color to allocate. On return, the 
 *    <structfield>pixel</structfield> field will be filled in.
 * 
 * Allocates a single color from a colormap.
 * This function is obsolete. See gdk_colormap_alloc_color().
 * 
 * Return value: %TRUE if the allocation succeeded.
 **/
258 259 260 261 262 263 264 265 266
gboolean
gdk_color_alloc (GdkColormap *colormap,
		 GdkColor    *color)
{
  gboolean success;

  gdk_colormap_alloc_colors (colormap, color, 1, FALSE, TRUE, &success);

  return success;
Elliot Lee's avatar
Elliot Lee committed
267 268
}

Matthias Clasen's avatar
Matthias Clasen committed
269 270 271 272 273 274 275 276 277
/**
 * gdk_color_hash:
 * @colora: a #GdkColor.
 * 
 * A hash function suitable for using for a hash
 * table that stores #GdkColor's.
 * 
 * Return value: The hash function appled to @colora
 **/
278
guint
279
gdk_color_hash (const GdkColor *colora)
280 281 282 283 284 285 286
{
  return ((colora->red) +
	  (colora->green << 11) +
	  (colora->blue << 22) +
	  (colora->blue >> 6));
}

Matthias Clasen's avatar
Matthias Clasen committed
287 288 289 290 291 292 293 294 295
/**
 * gdk_color_equal:
 * @colora: a #GdkColor.
 * @colorb: another #GdkColor.
 * 
 * Compares two colors. 
 * 
 * Return value: %TRUE if the two colors compare equal
 **/
Owen Taylor's avatar
Owen Taylor committed
296
gboolean
297 298
gdk_color_equal (const GdkColor *colora,
		 const GdkColor *colorb)
Elliot Lee's avatar
Elliot Lee committed
299 300 301 302 303 304 305 306
{
  g_return_val_if_fail (colora != NULL, FALSE);
  g_return_val_if_fail (colorb != NULL, FALSE);

  return ((colora->red == colorb->red) &&
	  (colora->green == colorb->green) &&
	  (colora->blue == colorb->blue));
}
307 308 309 310 311 312 313 314 315

GType
gdk_color_get_type (void)
{
  static GType our_type = 0;
  
  if (our_type == 0)
    our_type = g_boxed_type_register_static ("GdkColor",
					     (GBoxedCopyFunc)gdk_color_copy,
316
					     (GBoxedFreeFunc)gdk_color_free);
317 318
  return our_type;
}
319

Matthias Clasen's avatar
Matthias Clasen committed
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
/**
 * gdk_color_parse:
 * @spec: the string specifying the color.
 * @color: the #GdkColor to fill in
 * 
 * Parses a textual specification of a color and fill in
 * the <structfield>red</structfield>,
 * <structfield>green</structfield>, and 
 * <structfield>blue</structfield> fields of a 
 * #GdkColor structure. The color is <emphasis>not</emphasis> 
 * allocated, you must call gdk_colormap_alloc_color() yourself.
 * The text string can be in any of the forms accepted
 * by <function>XParseColor</function>; these include
 * name for a color from <filename>rgb.txt</filename>, such as
 * <literal>DarkSlateGray</literal>, or a hex specification
 * such as <literal>305050</literal>.
 * 
 * Return value: %TRUE if the parsing succeeded.
 **/
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
gboolean
gdk_color_parse (const gchar *spec,
		 GdkColor    *color)
{
  PangoColor pango_color;

  if (pango_color_parse (&pango_color, spec))
    {
      color->red = pango_color.red;
      color->green = pango_color.green;
      color->blue = pango_color.blue;

      return TRUE;
    }
  else
    return FALSE;
}
356 357 358 359 360 361 362 363 364 365 366 367

/**
 * gdk_colormap_get_system:
 * 
 * Gets the system's default colormap for the default screen. (See
 * gdk_colormap_get_system_for_screen ())
 * 
 * Return value: the default colormap.
 **/
GdkColormap*
gdk_colormap_get_system (void)
{
Owen Taylor's avatar
Owen Taylor committed
368
  return gdk_screen_get_system_colormap (gdk_screen_get_default ());
369 370
}