src/strset.h

   1 /*
   2  * Copyright (C) 2003-2010 The Music Player Daemon Project
   3  * http://www.musicpd.org
   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,
  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 along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 /**
  21  * "struct strset" is a hashed string set: you can add strings to this
  22  * library, and it stores them as a set of unique strings.  You can
  23  * get the size of the set, and you can enumerate through all values.
  24  *
  25  * It is important to note that the strset does not copy the string
  26  * values - it stores the exact pointers it was given in strset_add().
  27  */
  28
  29 #ifndef MPD_STRSET_H
  30 #define MPD_STRSET_H
  31
  32 #include <glib.h>
  33
  34 struct strset;
  35
  36 G_GNUC_MALLOC struct strset *strset_new(void);
  37
  38 void strset_free(struct strset *set);
  39
  40 void strset_add(struct strset *set, const char *value);
  41
  42 int strset_get(const struct strset *set, const char *value);
  43
  44 unsigned strset_size(const struct strset *set);
  45
  46 void strset_rewind(struct strset *set);
  47
  48 const char *strset_next(struct strset *set);
  49
  50 #endif