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

   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 3 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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU 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, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/selection.h
  19  * @brief Select management for Disobedience
  20  */
  21
  22 #ifndef SELECTION_H
  23 #define SELECTION_H
  24
  25 #include "hash.h"
  26
  27 /* Represent a selection using a hash */
  28
  29 hash *selection_new(void);
  30
  31 void selection_set(hash *h, const char *key, int selected);
  32 /* Set the selection status of KEY */
  33
  34 void selection_flip(hash *h, const char *key);
  35 /* Flip the selection status of KEY */
  36
  37 int selection_selected(hash *h, const char *key);
  38 /* Test whether KEY is selected.  Always returns 0 or 1. */
  39
  40 void selection_live(hash *h, const char *key);
  41 /* Mark KEY as live.  Ignored if KEY is not selected. */
  42
  43 void selection_cleanup(hash *h);
  44 /* Discard dead items (and mark everything left as dead) */
  45
  46 void selection_empty(hash *h);
  47 /* Empty the selection */
  48
  49 #endif /* SELECTION_H */
  50
  51 /*
  52 Local Variables:
  53 c-basic-offset:2
  54 comment-column:40
  55 fill-column:79
  56 indent-tabs-mode:nil
  57 End:
  58 */