common/rgbcolor.h

   1 /****************************************************************************
   2  Freeciv - Copyright (C) 2010 - The Freeciv Team
   3    This program is free software; you can redistribute it and/or modify
   4    it under the terms of the GNU General Public License as published by
   5    the Free Software Foundation; either version 2, or (at your option)
   6    any later version.
   7
   8    This program is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11    GNU General Public License for more details.
  12 ****************************************************************************/
  13 #ifndef FC__RGBCOLOR_H
  14 #define FC__RGBCOLOR_H
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif /* __cplusplus */
  19
  20 /* utility */
  21 #include "shared.h"
  22
  23 struct section_file;
  24
  25 /* Used for the color system in the client and the definition of the terrain
  26  * colors used in the overview/map images. The values are read from the
  27  * rulesets. */
  28 struct color;
  29
  30 /* An RGBcolor contains the R,G,B bitvalues for a color.  The color itself
  31  * holds the color structure for this color but may be NULL (it's allocated
  32  * on demand at runtime). */
  33 struct rgbcolor {
  34   int r, g, b;
  35   struct color *color;
  36 };
  37
  38 /* get 'struct color_list' and related functions: */
  39 #define SPECLIST_TAG rgbcolor
  40 #define SPECLIST_TYPE struct rgbcolor
  41 #include "speclist.h"
  42
  43 #define rgbcolor_list_iterate(rgbcolorlist, prgbcolor)                      \
  44     TYPED_LIST_ITERATE(struct rgbcolor, rgbcolorlist, prgbcolor)
  45 #define rgbcolor_list_iterate_end  LIST_ITERATE_END
  46
  47 /* Check the RGB color values. If a value is not in the interval [0, 255]
  48  * clip it to the interval boundaries. */
  49 #define CHECK_RGBCOLOR(_str, _c, _colorname)                                \
  50   {                                                                         \
  51     int _color_save = _c;                                                   \
  52                                                                             \
  53     _c = CLIP(0, _c, 255);                                                  \
  54     if (_c != _color_save) {                                                \
  55       log_error("Invalid value for '%s' in color definition '%s' (%d). "    \
  56                 "Setting it to '%d'.", _colorname, _str, _color_save, _c);  \
  57     }                                                                       \
  58   }
  59 #define rgbcolor_check(_str, _r, _g, _b)                                    \
  60   {                                                                         \
  61     CHECK_RGBCOLOR(_str, _r, "red");                                        \
  62     CHECK_RGBCOLOR(_str, _g, "green");                                      \
  63     CHECK_RGBCOLOR(_str, _b, "blue");                                       \
  64   }
  65
  66 struct rgbcolor *rgbcolor_new(int r, int g, int b);
  67 struct rgbcolor *rgbcolor_copy(const struct rgbcolor *prgbcolor);
  68 bool rgbcolors_are_equal(const struct rgbcolor *c1, const struct rgbcolor *c2);
  69 void rgbcolor_destroy(struct rgbcolor *prgbcolor);
  70
  71 bool rgbcolor_load(struct section_file *file, struct rgbcolor **prgbcolor,
  72                    char *path, ...)
  73                    fc__attribute((__format__ (__printf__, 3, 4)));
  74 void rgbcolor_save(struct section_file *file,
  75                    const struct rgbcolor *prgbcolor, char *path, ...)
  76                    fc__attribute((__format__ (__printf__, 3, 4)));
  77
  78 bool rgbcolor_to_hex(const struct rgbcolor *prgbcolor, char *hex,
  79                      size_t hex_len);
  80 bool rgbcolor_from_hex(struct rgbcolor **prgbcolor, const char *hex);
  81
  82 int rgbcolor_brightness_score(struct rgbcolor *prgbcolor);
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif /* __cplusplus */
  87
  88 #endif  /* FC__RGBCOLOR_H */