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_connection;
  26 struct mpd_song;
  27
  28 struct filelist_entry {
  29         guint flags;
  30         struct mpd_entity *entity;
  31 };
  32
  33 struct filelist {
  34         /* the list */
  35         GPtrArray *entries;
  36 };
  37
  38 struct filelist *
  39 filelist_new(void);
  40
  41 void
  42 filelist_free(struct filelist *filelist);
  43
  44 static inline guint
  45 filelist_length(const struct filelist *filelist)
  46 {
  47         return filelist->entries->len;
  48 }
  49
  50 static inline gboolean
  51 filelist_is_empty(const struct filelist *filelist)
  52 {
  53         return filelist_length(filelist) == 0;
  54 }
  55
  56 static inline struct filelist_entry *
  57 filelist_get(const struct filelist *filelist, guint i)
  58 {
  59         return g_ptr_array_index(filelist->entries, i);
  60 }
  61
  62 struct filelist_entry *
  63 filelist_append(struct filelist *filelist, struct mpd_entity *entity);
  64
  65 void
  66 filelist_move(struct filelist *filelist, struct filelist *from);
  67
  68 gint
  69 compare_filelist_entry_path(gconstpointer filelist_entry1,
  70                             gconstpointer filelist_entry2);
  71
  72 /* Sorts the whole filelist, at the moment used by filelist_search */
  73 void
  74 filelist_sort_all(struct filelist *filelist, GCompareFunc compare_func);
  75
  76 /* Only sorts the directories and playlist files.
  77  * The songs stay in the order it came from mpd. */
  78 void
  79 filelist_sort_dir_play(struct filelist *filelist, GCompareFunc compare_func);
  80
  81 /**
  82  * Eliminates duplicate songs from the filelist.
  83  */
  84 void
  85 filelist_no_duplicates(struct filelist *filelist);
  86
  87 int
  88 filelist_find_song(struct filelist *flist, const struct mpd_song *song);
  89
  90 int
  91 filelist_find_directory(struct filelist *filelist, const char *name);
  92
  93 /**
  94  * Receives entities from the connection, and appends them to the
  95  * specified filelist.  This does not finish the response, and does
  96  * not check for errors.
  97  */
  98 void
  99 filelist_recv(struct filelist *filelist, struct mpd_connection *connection);
 100
 101 /**
 102  * Creates a new filelist and receives entities from the connection.
 103  * This does not finish the response, and does not check for errors.
 104  */
 105 struct filelist *
 106 filelist_new_recv(struct mpd_connection *connection);
 107
 108 #endif