lib/skin/colors.c

lib/skin/colors.c
/* */
This source file includes following definitions.
mc_skin_color_get_from_hash
mc_skin_color_remove_from_hash
mc_skin_color_add_to_hash
mc_skin_color_get_with_defaults
mc_skin_color_look_up_alias
mc_skin_color_get_from_ini_file
mc_skin_color_set_default_for_terminal
mc_skin_color_cache_init
mc_skin_color_check_inisection
mc_skin_color_check_bw_mode
mc_skin_color_parse_ini_file
mc_skin_color_get
   1 /*
   2    Skins engine.
   3    Work with colors
   4 
   5    Copyright (C) 2009-2025
   6    Free Software Foundation, Inc.
   7 
   8    Written by:
   9    Slava Zanko <slavazanko@gmail.com>, 2009
  10    Egmont Koblinger <egmont@gmail.com>, 2010
  11    Andrew Borodin <aborodin@vmail.ru>, 2012
  12 
  13    This file is part of the Midnight Commander.
  14 
  15    The Midnight Commander is free software: you can redistribute it
  16    and/or modify it under the terms of the GNU General Public License as
  17    published by the Free Software Foundation, either version 3 of the License,
  18    or (at your option) any later version.
  19 
  20    The Midnight Commander is distributed in the hope that it will be useful,
  21    but WITHOUT ANY WARRANTY; without even the implied warranty of
  22    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23    GNU General Public License for more details.
  24 
  25    You should have received a copy of the GNU General Public License
  26    along with this program.  If not, see <https://www.gnu.org/licenses/>.
  27  */
  28 
  29 #include <config.h>
  30 #include <string.h>
  31 
  32 #include "internal.h"
  33 
  34 #include "lib/tty/color.h"
  35 
  36 /*** global variables ****************************************************************************/
  37 
  38 int mc_skin_color__cache[MC_SKIN_COLOR_CACHE_COUNT];
  39 
  40 /*** file scope macro definitions ****************************************************************/
  41 
  42 /*** file scope type declarations ****************************************************************/
  43 
  44 /*** forward declarations (file scope functions) *************************************************/
  45 
  46 /*** file scope variables ************************************************************************/
  47 
  48 /* --------------------------------------------------------------------------------------------- */
  49 /*** file scope functions ************************************************************************/
  50 /* --------------------------------------------------------------------------------------------- */
  51 
  52 static tty_color_pair_t *
  53 mc_skin_color_get_from_hash (mc_skin_t *mc_skin, const gchar *group, const gchar *key)
     /*   */
  54 {
  55     gchar kname[BUF_TINY];
  56     tty_color_pair_t *mc_skin_color;
  57 
  58     if (group == NULL || key == NULL)
  59         return NULL;
  60 
  61     if (mc_skin == NULL)
  62         mc_skin = &mc_skin__default;
  63 
  64     g_snprintf (kname, sizeof (kname), "%s.%s", group, key);
  65     mc_skin_color = (tty_color_pair_t *) g_hash_table_lookup (mc_skin->colors, (gpointer) kname);
  66 
  67     return mc_skin_color;
  68 }
  69 
  70 /* --------------------------------------------------------------------------------------------- */
  71 
  72 #if 0
  73 static void
  74 mc_skin_color_remove_from_hash (mc_skin_t *mc_skin, const gchar *group, const gchar *key)
     /*   */
  75 {
  76     gchar kname[BUF_TINY];
  77     if (group == NULL || key == NULL)
  78         return;
  79 
  80     if (mc_skin == NULL)
  81         mc_skin = &mc_skin__default;
  82 
  83     g_snprintf (kname, sizeof (kname), "%s.%s", group, key);
  84     g_hash_table_remove (mc_skin->colors, (gpointer) kname);
  85 }
  86 #endif
  87 
  88 /* --------------------------------------------------------------------------------------------- */
  89 
  90 static void
  91 mc_skin_color_add_to_hash (mc_skin_t *mc_skin, const gchar *group, const gchar *key,
     /*   */
  92                            tty_color_pair_t *mc_skin_color)
  93 {
  94     gchar *kname;
  95 
  96     kname = g_strdup_printf ("%s.%s", group, key);
  97     if (kname != NULL)
  98     {
  99         if (g_hash_table_lookup (mc_skin->colors, (gpointer) kname) != NULL)
 100             g_hash_table_remove (mc_skin->colors, (gpointer) kname);
 101 
 102         g_hash_table_insert (mc_skin->colors, (gpointer) kname, (gpointer) mc_skin_color);
 103     }
 104 }
 105 
 106 /* --------------------------------------------------------------------------------------------- */
 107 
 108 static tty_color_pair_t *
 109 mc_skin_color_get_with_defaults (const gchar *group, const gchar *name)
     /*   */
 110 {
 111     tty_color_pair_t *mc_skin_color;
 112 
 113     mc_skin_color = mc_skin_color_get_from_hash (NULL, group, name);
 114     if (mc_skin_color != NULL)
 115         return mc_skin_color;
 116 
 117     mc_skin_color = mc_skin_color_get_from_hash (NULL, group, "_default_");
 118     if (mc_skin_color != NULL)
 119         return mc_skin_color;
 120 
 121     mc_skin_color = mc_skin_color_get_from_hash (NULL, "core", "_default_");
 122     return mc_skin_color;
 123 }
 124 
 125 /* --------------------------------------------------------------------------------------------- */
 126 
 127 /* If an alias is found, alloc a new string for the resolved value and free the input parameter.
 128    Otherwise it's a no-op returning the original string. */
 129 static gchar *
 130 mc_skin_color_look_up_alias (mc_skin_t *mc_skin, gchar *str)
     /*   */
 131 {
 132     gchar *orig, *str2;
 133     int hop = 0;
 134 
 135     orig = g_strdup (str);
 136     str2 = g_strdup (str);
 137 
 138     while (TRUE)
 139     {
 140         gchar **values;
 141         gsize items_count;
 142 
 143         values = mc_config_get_string_list (mc_skin->config, "aliases", str, &items_count);
 144         if (items_count != 1)
 145         {
 146             // No such alias declaration found, that is, we've got the resolved value.
 147             g_strfreev (values);
 148             g_free (str2);
 149             g_free (orig);
 150             return str;
 151         }
 152 
 153         g_free (str);
 154         str = g_strdup (values[0]);
 155         g_strfreev (values);
 156 
 157         // str2 resolves at half speed than str. This is used for loop detection.
 158         if (hop++ % 2 != 0)
 159         {
 160             values = mc_config_get_string_list (mc_skin->config, "aliases", str2, &items_count);
 161             g_assert (items_count == 1);
 162             g_free (str2);
 163             str2 = g_strdup (values[0]);
 164             g_strfreev (values);
 165 
 166             if (strcmp (str, str2) == 0)
 167             {
 168                 // Loop detected.
 169                 fprintf (stderr,
 170                          "Loop detected while trying to resolve alias \"%s\" in skin \"%s\"\n",
 171                          orig, mc_skin->name);
 172                 g_free (str);
 173                 g_free (str2);
 174                 return orig;
 175             }
 176         }
 177     }
 178 }
 179 
 180 /* --------------------------------------------------------------------------------------------- */
 181 
 182 static tty_color_pair_t *
 183 mc_skin_color_get_from_ini_file (mc_skin_t *mc_skin, const gchar *group, const gchar *key)
     /*   */
 184 {
 185     gsize items_count;
 186     gchar **values;
 187     tty_color_pair_t *mc_skin_color, *tmp;
 188 
 189     values = mc_config_get_string_list (mc_skin->config, group, key, &items_count);
 190     if (values == NULL || values[0] == NULL)
 191     {
 192         g_strfreev (values);
 193         return NULL;
 194     }
 195 
 196     mc_skin_color = g_try_new0 (tty_color_pair_t, 1);
 197     if (mc_skin_color == NULL)
 198     {
 199         g_strfreev (values);
 200         return NULL;
 201     }
 202 
 203     tmp = mc_skin_color_get_with_defaults (group, "_default_");
 204     mc_skin_color->fg = (items_count > 0 && values[0][0])
 205         ? mc_skin_color_look_up_alias (mc_skin, g_strstrip (g_strdup (values[0])))
 206         : (tmp != NULL) ? g_strdup (tmp->fg)
 207                         : NULL;
 208     mc_skin_color->bg = (items_count > 1 && values[1][0])
 209         ? mc_skin_color_look_up_alias (mc_skin, g_strstrip (g_strdup (values[1])))
 210         : (tmp != NULL) ? g_strdup (tmp->bg)
 211                         : NULL;
 212     mc_skin_color->attrs = (items_count > 2 && values[2][0])
 213         ? mc_skin_color_look_up_alias (mc_skin, g_strstrip (g_strdup (values[2])))
 214         : (tmp != NULL) ? g_strdup (tmp->attrs)
 215                         : NULL;
 216 
 217     g_strfreev (values);
 218 
 219     mc_skin_color->pair_index = tty_try_alloc_color_pair (mc_skin_color, FALSE);
 220 
 221     return mc_skin_color;
 222 }
 223 
 224 /* --------------------------------------------------------------------------------------------- */
 225 
 226 static void
 227 mc_skin_color_set_default_for_terminal (mc_skin_t *mc_skin)
     /*   */
 228 {
 229     tty_color_pair_t *mc_skin_color;
 230 
 231     mc_skin_color = g_try_new0 (tty_color_pair_t, 1);
 232     if (mc_skin_color != NULL)
 233     {
 234         mc_skin_color->fg = g_strdup ("default");
 235         mc_skin_color->bg = g_strdup ("default");
 236         mc_skin_color->attrs = NULL;
 237         mc_skin_color->pair_index = tty_try_alloc_color_pair (mc_skin_color, FALSE);
 238         mc_skin_color_add_to_hash (mc_skin, "skin", "terminal_default_color", mc_skin_color);
 239     }
 240 }
 241 
 242 /* --------------------------------------------------------------------------------------------- */
 243 
 244 static void
 245 mc_skin_color_cache_init (void)
     /*   */
 246 {
 247     DEFAULT_COLOR = mc_skin_color_get ("skin", "terminal_default_color");
 248     NORMAL_COLOR = mc_skin_color_get ("core", "_default_");
 249     MARKED_COLOR = mc_skin_color_get ("core", "marked");
 250     SELECTED_COLOR = mc_skin_color_get ("core", "selected");
 251     MARKED_SELECTED_COLOR = mc_skin_color_get ("core", "markselect");
 252     DISABLED_COLOR = mc_skin_color_get ("core", "disabled");
 253     REVERSE_COLOR = mc_skin_color_get ("core", "reverse");
 254     HEADER_COLOR = mc_skin_color_get ("core", "header");
 255     COMMAND_MARK_COLOR = mc_skin_color_get ("core", "commandlinemark");
 256     SHADOW_COLOR = mc_skin_color_get ("core", "shadow");
 257 
 258     COLOR_NORMAL = mc_skin_color_get ("dialog", "_default_");
 259     COLOR_FOCUS = mc_skin_color_get ("dialog", "dfocus");
 260     COLOR_HOT_NORMAL = mc_skin_color_get ("dialog", "dhotnormal");
 261     COLOR_HOT_FOCUS = mc_skin_color_get ("dialog", "dhotfocus");
 262     COLOR_TITLE = mc_skin_color_get ("dialog", "dtitle");
 263 
 264     ERROR_COLOR = mc_skin_color_get ("error", "_default_");
 265     ERROR_FOCUS = mc_skin_color_get ("error", "errdfocus");
 266     ERROR_HOT_NORMAL = mc_skin_color_get ("error", "errdhotnormal");
 267     ERROR_HOT_FOCUS = mc_skin_color_get ("error", "errdhotfocus");
 268     ERROR_TITLE = mc_skin_color_get ("error", "errdtitle");
 269 
 270     MENU_ENTRY_COLOR = mc_skin_color_get ("menu", "_default_");
 271     MENU_SELECTED_COLOR = mc_skin_color_get ("menu", "menusel");
 272     MENU_HOT_COLOR = mc_skin_color_get ("menu", "menuhot");
 273     MENU_HOTSEL_COLOR = mc_skin_color_get ("menu", "menuhotsel");
 274     MENU_INACTIVE_COLOR = mc_skin_color_get ("menu", "menuinactive");
 275 
 276     PMENU_ENTRY_COLOR = mc_skin_color_get ("popupmenu", "_default_");
 277     PMENU_SELECTED_COLOR = mc_skin_color_get ("popupmenu", "menusel");
 278     PMENU_TITLE_COLOR = mc_skin_color_get ("popupmenu", "menutitle");
 279 
 280     BUTTONBAR_HOTKEY_COLOR = mc_skin_color_get ("buttonbar", "hotkey");
 281     BUTTONBAR_BUTTON_COLOR = mc_skin_color_get ("buttonbar", "button");
 282 
 283     STATUSBAR_COLOR = mc_skin_color_get ("statusbar", "_default_");
 284 
 285     GAUGE_COLOR = mc_skin_color_get ("core", "gauge");
 286     INPUT_COLOR = mc_skin_color_get ("core", "input");
 287     INPUT_HISTORY_COLOR = mc_skin_color_get ("core", "inputhistory");
 288     COMMAND_HISTORY_COLOR = mc_skin_color_get ("core", "commandhistory");
 289     INPUT_MARK_COLOR = mc_skin_color_get ("core", "inputmark");
 290     INPUT_UNCHANGED_COLOR = mc_skin_color_get ("core", "inputunchanged");
 291 
 292     HELP_NORMAL_COLOR = mc_skin_color_get ("help", "_default_");
 293     HELP_ITALIC_COLOR = mc_skin_color_get ("help", "helpitalic");
 294     HELP_BOLD_COLOR = mc_skin_color_get ("help", "helpbold");
 295     HELP_LINK_COLOR = mc_skin_color_get ("help", "helplink");
 296     HELP_SLINK_COLOR = mc_skin_color_get ("help", "helpslink");
 297     HELP_TITLE_COLOR = mc_skin_color_get ("help", "helptitle");
 298 
 299     VIEW_NORMAL_COLOR = mc_skin_color_get ("viewer", "_default_");
 300     VIEW_BOLD_COLOR = mc_skin_color_get ("viewer", "viewbold");
 301     VIEW_UNDERLINED_COLOR = mc_skin_color_get ("viewer", "viewunderline");
 302     VIEW_SELECTED_COLOR = mc_skin_color_get ("viewer", "viewselected");
 303 
 304     EDITOR_NORMAL_COLOR = mc_skin_color_get ("editor", "_default_");
 305     EDITOR_BOLD_COLOR = mc_skin_color_get ("editor", "editbold");
 306     EDITOR_MARKED_COLOR = mc_skin_color_get ("editor", "editmarked");
 307     EDITOR_WHITESPACE_COLOR = mc_skin_color_get ("editor", "editwhitespace");
 308     EDITOR_NONPRINTABLE_COLOR = mc_skin_color_get ("editor", "editnonprintable");
 309     EDITOR_RIGHT_MARGIN_COLOR = mc_skin_color_get ("editor", "editrightmargin");
 310     LINE_STATE_COLOR = mc_skin_color_get ("editor", "editlinestate");
 311     EDITOR_BACKGROUND = mc_skin_color_get ("editor", "editbg");
 312     EDITOR_FRAME = mc_skin_color_get ("editor", "editframe");
 313     EDITOR_FRAME_ACTIVE = mc_skin_color_get ("editor", "editframeactive");
 314     EDITOR_FRAME_DRAG = mc_skin_color_get ("editor", "editframedrag");
 315 
 316     BOOK_MARK_COLOR = mc_skin_color_get ("editor", "bookmark");
 317     BOOK_MARK_FOUND_COLOR = mc_skin_color_get ("editor", "bookmarkfound");
 318 
 319     DFF_ADD_COLOR = mc_skin_color_get ("diffviewer", "added");
 320     DFF_CHG_COLOR = mc_skin_color_get ("diffviewer", "changedline");
 321     DFF_CHH_COLOR = mc_skin_color_get ("diffviewer", "changednew");
 322     DFF_CHD_COLOR = mc_skin_color_get ("diffviewer", "changed");
 323     DFF_DEL_COLOR = mc_skin_color_get ("diffviewer", "removed");
 324     DFF_ERROR_COLOR = mc_skin_color_get ("diffviewer", "error");
 325 }
 326 
 327 /* --------------------------------------------------------------------------------------------- */
 328 
 329 static gboolean
 330 mc_skin_color_check_inisection (const gchar *group)
     /*   */
 331 {
 332     return !((strcasecmp ("skin", group) == 0) || (strcasecmp ("aliases", group) == 0)
 333              || (strcasecmp ("lines", group) == 0) || (strncasecmp ("widget-", group, 7) == 0));
 334 }
 335 
 336 /* --------------------------------------------------------------------------------------------- */
 337 
 338 static void
 339 mc_skin_color_check_bw_mode (mc_skin_t *mc_skin)
     /*   */
 340 {
 341     gchar **groups, **orig_groups;
 342 
 343     if (tty_use_colors () && !mc_global.tty.disable_colors)
 344         return;
 345 
 346     orig_groups = mc_config_get_groups (mc_skin->config, NULL);
 347 
 348     for (groups = orig_groups; *groups != NULL; groups++)
 349         if (mc_skin_color_check_inisection (*groups))
 350             mc_config_del_group (mc_skin->config, *groups);
 351 
 352     g_strfreev (orig_groups);
 353 
 354     mc_skin_hardcoded_blackwhite_colors (mc_skin);
 355 }
 356 
 357 /* --------------------------------------------------------------------------------------------- */
 358 /*** public functions ****************************************************************************/
 359 /* --------------------------------------------------------------------------------------------- */
 360 
 361 gboolean
 362 mc_skin_color_parse_ini_file (mc_skin_t *mc_skin)
     /*   */
 363 {
 364     gboolean ret = FALSE;
 365     gsize items_count;
 366     gchar **groups, **orig_groups;
 367     tty_color_pair_t *mc_skin_color;
 368 
 369     mc_skin_color_check_bw_mode (mc_skin);
 370 
 371     orig_groups = mc_config_get_groups (mc_skin->config, &items_count);
 372     if (*orig_groups == NULL)
 373         goto ret;
 374 
 375     // as first, need to set up default colors
 376     mc_skin_color_set_default_for_terminal (mc_skin);
 377     mc_skin_color = mc_skin_color_get_from_ini_file (mc_skin, "core", "_default_");
 378     if (mc_skin_color == NULL)
 379         goto ret;
 380 
 381     tty_color_set_defaults (mc_skin_color);
 382     mc_skin_color_add_to_hash (mc_skin, "core", "_default_", mc_skin_color);
 383 
 384     for (groups = orig_groups; *groups != NULL; groups++)
 385     {
 386         gchar **keys, **orig_keys;
 387 
 388         if (!mc_skin_color_check_inisection (*groups))
 389             continue;
 390 
 391         orig_keys = mc_config_get_keys (mc_skin->config, *groups, NULL);
 392 
 393         for (keys = orig_keys; *keys != NULL; keys++)
 394         {
 395             mc_skin_color = mc_skin_color_get_from_ini_file (mc_skin, *groups, *keys);
 396             if (mc_skin_color != NULL)
 397                 mc_skin_color_add_to_hash (mc_skin, *groups, *keys, mc_skin_color);
 398         }
 399         g_strfreev (orig_keys);
 400     }
 401 
 402     mc_skin_color_cache_init ();
 403 
 404     ret = TRUE;
 405 
 406 ret:
 407     g_strfreev (orig_groups);
 408     return ret;
 409 }
 410 
 411 /* --------------------------------------------------------------------------------------------- */
 412 
 413 int
 414 mc_skin_color_get (const gchar *group, const gchar *name)
     /*   */
 415 {
 416     tty_color_pair_t *mc_skin_color;
 417 
 418     mc_skin_color = mc_skin_color_get_with_defaults (group, name);
 419 
 420     return (mc_skin_color != NULL) ? mc_skin_color->pair_index : 0;
 421 }
 422 
 423 /* --------------------------------------------------------------------------------------------- */
/* */
root/lib/skin/colors.c

DEFINITIONS
