src/filelist.h

   1 /* ncmpc (Ncurses MPD Client)
   2  * (c) 2004-2009 The Music Player Daemon Project
   3  * Project homepage: http://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 #ifndef FILELIST_H
  21 #define FILELIST_H
  22
  23 #include <glib.h>
  24
  25 struct mpd_song;
  26
  27 struct filelist_entry {
  28         guint flags;
  29         struct mpd_entity *entity;
  30 };
  31
  32 struct filelist {
  33         /* the list */
  34         GPtrArray *entries;
  35 };
  36
  37 struct filelist *
  38 filelist_new(void);
  39
  40 void
  41 filelist_free(struct filelist *filelist);
  42
  43 static inline guint
  44 filelist_length(const struct filelist *filelist)
  45 {
  46         return filelist->entries->len;
  47 }
  48
  49 static inline gboolean
  50 filelist_is_empty(const struct filelist *filelist)
  51 {
  52         return filelist_length(filelist) == 0;
  53 }
  54
  55 static inline struct filelist_entry *
  56 filelist_get(const struct filelist *filelist, guint i)
  57 {
  58         return g_ptr_array_index(filelist->entries, i);
  59 }
  60
  61 struct filelist_entry *
  62 filelist_append(struct filelist *filelist, struct mpd_entity *entity);
  63
  64 struct filelist_entry *
  65 filelist_prepend(struct filelist *filelist, struct mpd_entity *entity);
  66
  67 void
  68 filelist_move(struct filelist *filelist, struct filelist *from);
  69
  70 /* Sorts the whole filelist, at the moment used by filelist_search */
  71 void
  72 filelist_sort_all(struct filelist *filelist, GCompareFunc compare_func);
  73
  74 /* Only sorts the directories and playlist files.
  75  * The songs stay in the order it came from mpd. */
  76 void
  77 filelist_sort_dir_play(struct filelist *filelist, GCompareFunc compare_func);
  78
  79 int
  80 filelist_find_song(struct filelist *flist, const struct mpd_song *song);
  81
  82 int
  83 filelist_find_directory(struct filelist *filelist, const char *name);
  84
  85 #endif