src/filelist.h

   1 /*
   2  * (c) 2004 by Kalle Wallin <kaw@linux.se>
   3  * (c) 2008 Max Kellermann <max@duempel.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  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  *
  18  */
  19
  20 #ifndef FILELIST_H
  21 #define FILELIST_H
  22
  23 #include <glib.h>
  24
  25 struct mpd_song;
  26
  27 typedef struct filelist_entry {
  28         guint flags;
  29         struct mpd_InfoEntity *entity;
  30 } filelist_entry_t;
  31
  32 typedef struct filelist {
  33         /* path */
  34         gchar *path;
  35
  36         /* list length */
  37         guint length;
  38
  39         /* true if the list is updated */
  40         gboolean updated;
  41
  42         /* the list */
  43         GList *list;
  44 } mpdclient_filelist_t;
  45
  46 struct filelist *
  47 filelist_new(const char *path);
  48
  49 void
  50 filelist_free(struct filelist *filelist);
  51
  52 static inline guint
  53 filelist_length(const struct filelist *filelist)
  54 {
  55         return filelist->length;
  56 }
  57
  58 static inline gboolean
  59 filelist_is_empty(const struct filelist *filelist)
  60 {
  61         return filelist_length(filelist) == 0;
  62 }
  63
  64 static inline struct filelist_entry *
  65 filelist_get(const struct filelist *filelist, guint i)
  66 {
  67         return (struct filelist_entry*)
  68                 g_list_nth_data(filelist->list, i);
  69 }
  70
  71 struct filelist_entry *
  72 filelist_append(struct filelist *filelist, struct mpd_InfoEntity *entity);
  73
  74 struct filelist_entry *
  75 filelist_prepend(struct filelist *filelist, struct mpd_InfoEntity *entity);
  76
  77 void
  78 filelist_move(struct filelist *filelist, struct filelist *from);
  79
  80 void
  81 filelist_sort(struct filelist *filelist, GCompareFunc compare_func);
  82
  83 struct filelist_entry *
  84 filelist_find_song(struct filelist *flist, const struct mpd_song *song);
  85
  86 #endif