chiark - git - mdw - disorder/blob - lib/selection.c

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2006, 2007 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20 /** @file lib/selection.c
  21  * @brief Select management for Disobedience
  22  */
  23
  24 #include <config.h>
  25 #include "types.h"
  26
  27 #include "mem.h"
  28 #include "hash.h"
  29 #include "selection.h"
  30
  31 /** @brief Create a new selection manager
  32  * @return Pointer to @ref hash used to manage the selection
  33  */
  34 hash *selection_new(void) {
  35   return hash_new(sizeof (int));
  36 }
  37
  38 /** @brief Add or remove a key in a selection
  39  * @param h Hash representing selection
  40  * @param key Key to insert
  41  * @param selected non-0 if key is selected, 0 if it is not
  42  *
  43  * @p key is copied so the pointer need not remain valid.  Newly selected keys
  44  * are not marked as live.
  45  */
  46 void selection_set(hash *h, const char *key, int selected) {
  47   if(selected)
  48     hash_add(h, key, xmalloc_noptr(sizeof (int)), HASH_INSERT_OR_REPLACE);
  49   else
  50     hash_remove(h, key);
  51 }
  52
  53 /** @brief Test whether a key is set in a selection
  54  * @param h Hash representing selection
  55  * @param key Key to check
  56  * @return non-0 if key is present, 0 if it is not
  57  */
  58 int selection_selected(hash *h, const char *key) {
  59   return hash_find(h, key) != 0;
  60 }
  61
  62 /** @brief Invert a key's selection status
  63  * @param h Hash representing selection
  64  * @param key Key to flip
  65  *
  66  * If the key is selected as a result it is not marked as live.
  67  */
  68 void selection_flip(hash *h, const char *key) {
  69   selection_set(h, key, !selection_selected(h, key));
  70 }
  71
  72 /** @brief Mark a selection key as live
  73  * @param h Hash representing selection
  74  * @param key Key to mark as live
  75  *
  76  * Live keys will survive a call to selection_cleanup().  @p need not be in the
  77  * selection (if it is not then the call will be ignored).
  78  */
  79 void selection_live(hash *h, const char *key) {
  80   int *ptr = hash_find(h, key);
  81
  82   if(ptr)
  83     *ptr = 1;
  84 }
  85
  86 static int selection_cleanup_callback(const char *key,
  87                                       void *value,
  88                                       void *v) {
  89   if(*(int *)value)
  90     *(int *)value = 0;
  91   else
  92     hash_remove((hash *)v, key);
  93   return 0;
  94 }
  95
  96 /** @brief Delete all non-live keys from a selection
  97  * @param h Hash representing selection
  98  *
  99  * See selection_live().
 100  */
 101 void selection_cleanup(hash *h) {
 102   hash_foreach(h, selection_cleanup_callback, h);
 103 }
 104
 105 static int selection_empty_callback(const char *key,
 106                                     void attribute((unused)) *value,
 107                                     void *v) {
 108   hash_remove((hash *)v, key);
 109   return 0;
 110 }
 111
 112 /** @brief Remove all keys from a selection
 113  * @param h Hash representing selection
 114  */
 115 void selection_empty(hash *h) {
 116   hash_foreach(h, selection_empty_callback, h);
 117 }
 118
 119 /*
 120 Local Variables:
 121 c-basic-offset:2
 122 comment-column:40
 123 fill-column:79
 124 indent-tabs-mode:nil
 125 End:
 126 */