Code

mpdclient.h: fix the spelling of "occurred"
[ncmpc.git] / src / mpdclient.h
index 787839193cbbcab1ce68a17100e766aaba51d52c..383634fb78398c2e10726ca88d3acc7f03e4cb19 100644 (file)
 #ifndef MPDCLIENT_H
 #define MPDCLIENT_H
 
-#include "libmpdclient.h"
+#include "playlist.h"
 
-#include <glib.h>
+#include <mpd/client.h>
 
-#define MPD_VERSION_EQ(c,x,y,z) (c->connection->version[0] == x && \
-                                 c->connection->version[1] == y && \
-                                 c->connection->version[2] == z )
+struct filelist;
 
-#define MPD_VERSION_LT(c,x,y,z) ( c->connection->version[0]<x  || \
- (c->connection->version[0]==x && c->connection->version[1]<y) || \
- (c->connection->version[0]==x && c->connection->version[1]==y && \
-  c->connection->version[2]<z) )
+struct mpdclient {
+       /* playlist */
+       struct mpdclient_playlist playlist;
 
+       struct mpd_connection *connection;
 
+       /**
+        * If this object is non-NULL, it tracks idle events.  It is
+        * automatically called by mpdclient_get_connection() and
+        * mpdclient_put_connection().  It is not created by the
+        * mpdclient library; the user of this library has to
+        * initialize it.  However, it is freed when the MPD
+        * connection is closed.
+        */
+       struct mpd_glib_source *source;
 
-/****************************************************************************/
-/* Playlist */
-/****************************************************************************/
+       /**
+        * This attribute is true when the connection is currently in
+        * "idle" mode, and the #mpd_glib_source waits for an event.
+        */
+       bool idle;
 
-typedef struct
-{
-  /* playlist id */
-  long long id;
-  /* true if the list is updated */
-  gboolean updated;
-  /* the list */
-  GArray *list;
-
-} mpdclient_playlist_t;
+       struct mpd_status *status;
+       const struct mpd_song *song;
 
+       int volume;
+       unsigned update_id;
 
-typedef struct
-{
-  guint flags;
-  mpd_InfoEntity *entity;
-} filelist_entry_t;
-
-typedef struct
-{
-  /* path */
-  gchar *path;
-  /* list length */
-  guint length;
-  /* true if the list is updated */
-  gboolean updated;
-  /* the list */
-  GList *list;
-
-} mpdclient_filelist_t;
-
-typedef struct
-{
-  /* playlist */
-  mpdclient_playlist_t playlist;
-
-  /* Callbacks */
-  GList *error_callbacks;
-  GList *playlist_callbacks;
-  GList *browse_callbacks;
-
-  mpd_Connection *connection;
-  mpd_Status     *status;
-  mpd_Song       *song;
-
-  gboolean       need_update;
-
-} mpdclient_t;
+       /**
+        * A bit mask of idle events occurred since the last update.
+        */
+       enum mpd_idle events;
+};
 
 /** functions ***************************************************************/
 
-gint
-mpdclient_finish_command(mpdclient_t *c);
+bool
+mpdclient_handle_error(struct mpdclient *c);
 
-mpdclient_t *mpdclient_new(void);
-mpdclient_t *mpdclient_free(mpdclient_t *c);
-gint mpdclient_connect(mpdclient_t *c, gchar *host, gint port,
-                      gfloat timeout, gchar *password);
-gint mpdclient_disconnect(mpdclient_t *c);
-gint mpdclient_update(mpdclient_t *c);
+struct mpdclient *
+mpdclient_new(void);
 
+void mpdclient_free(struct mpdclient *c);
 
-/*** MPD Commands  **********************************************************/
-gint mpdclient_cmd_play(mpdclient_t *c, gint index);
-gint mpdclient_cmd_pause(mpdclient_t *c, gint value);
-gint mpdclient_cmd_stop(mpdclient_t *c);
-gint mpdclient_cmd_next(mpdclient_t *c);
-gint mpdclient_cmd_prev(mpdclient_t *c);
-gint mpdclient_cmd_seek(mpdclient_t *c, gint id, gint pos);
-gint mpdclient_cmd_shuffle(mpdclient_t *c);
-gint mpdclient_cmd_clear(mpdclient_t *c);
-gint mpdclient_cmd_repeat(mpdclient_t *c, gint value);
-gint mpdclient_cmd_random(mpdclient_t *c, gint value);
-gint mpdclient_cmd_crossfade(mpdclient_t *c, gint value);
-gint mpdclient_cmd_db_update_utf8(mpdclient_t *c, gchar *path);
-gint mpdclient_cmd_volume(mpdclient_t *c, gint value);
-gint mpdclient_cmd_add_path(mpdclient_t *c, gchar *path);
-gint mpdclient_cmd_add_path_utf8(mpdclient_t *c, gchar *path);
-
-gint mpdclient_cmd_add(mpdclient_t *c, mpd_Song *song);
-gint mpdclient_cmd_delete(mpdclient_t *c, gint index);
-gint mpdclient_cmd_move(mpdclient_t *c, gint old_index, gint new_index);
-
-gint mpdclient_cmd_save_playlist(mpdclient_t *c, gchar *filename);
-gint mpdclient_cmd_save_playlist_utf8(mpdclient_t *c, gchar *filename);
-gint mpdclient_cmd_load_playlist_utf8(mpdclient_t *c, gchar *filename_utf8);
-gint mpdclient_cmd_delete_playlist(mpdclient_t *c, gchar *filename);
-gint mpdclient_cmd_delete_playlist_utf8(mpdclient_t *c, gchar *filename_utf8);
-
-/* list functions */
-GList *mpdclient_get_artists_utf8(mpdclient_t *c);
-GList *mpdclient_get_albums_utf8(mpdclient_t *c, gchar *artist_utf8);
-
-
-/*** error callbacks *****************************************************/ 
-
-#define IS_ACK_ERROR(n)       (n & MPD_ERROR_ACK)
-#define GET_ACK_ERROR_CODE(n) ((n & 0xFF00) >> 8)
-
-typedef void (*mpdc_error_cb_t) (mpdclient_t *c, gint error, const gchar *msg);
-
-void mpdclient_install_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
-void mpdclient_remove_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
-
-/*** playlist functions  **************************************************/
-
-/* free a playlist */
-gint mpdclient_playlist_free(mpdclient_playlist_t *playlist);
-/* update the complete playlist */
-gint mpdclient_playlist_update(mpdclient_t *c);
-/* get playlist changes */
-gint mpdclient_playlist_update_changes(mpdclient_t *c);
+static inline bool
+mpdclient_is_connected(const struct mpdclient *c)
+{
+       return c->connection != NULL;
+}
 
-mpd_Song *playlist_lookup_song(mpdclient_t *c, gint id);
-mpd_Song *playlist_get_song(mpdclient_t *c, gint index);
-gint playlist_get_index(mpdclient_t *c, mpd_Song *song);
-gint playlist_get_index_from_id(mpdclient_t *c, gint id);
-gint playlist_get_index_from_file(mpdclient_t *c, gchar *filename);
+G_GNUC_PURE
+static inline bool
+mpdclient_is_playing(const struct mpdclient *c)
+{
+       return c->status != NULL &&
+               (mpd_status_get_state(c->status) == MPD_STATE_PLAY ||
+                mpd_status_get_state(c->status) == MPD_STATE_PAUSE);
+}
 
+static inline const struct mpd_song *
+mpdclient_get_current_song(const struct mpdclient *c)
+{
+       return c->song != NULL && mpdclient_is_playing(c)
+               ? c->song
+               : NULL;
+}
 
+bool
+mpdclient_connect(struct mpdclient *c, const gchar *host, gint port,
+                 gfloat timeout_, const gchar *password);
 
-/*** mpdclient playlist callbacks *****************************************/
+void
+mpdclient_disconnect(struct mpdclient *c);
 
-#define PLAYLIST_EVENT_UPDATED     0x01
-#define PLAYLIST_EVENT_CLEAR       0x02
-#define PLAYLIST_EVENT_DELETE      0x03
-#define PLAYLIST_EVENT_ADD         0x04
-#define PLAYLIST_EVENT_MOVE        0x05
+bool
+mpdclient_update(struct mpdclient *c);
 
+struct mpd_connection *
+mpdclient_get_connection(struct mpdclient *c);
 
-typedef void (*mpdc_list_cb_t) (mpdclient_t *c, int event, gpointer data);
+void
+mpdclient_put_connection(struct mpdclient *c);
 
-/* install a playlist callback function */
-void mpdclient_install_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
+/**
+ * To be implemented by the application: mpdclient.c calls this to
+ * display an error message.
+ */
+void
+mpdclient_ui_error(const char *message);
 
-/* remove a playlist callback function */
-void mpdclient_remove_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
+/*** MPD Commands  **********************************************************/
 
+bool
+mpdclient_cmd_crop(struct mpdclient *c);
 
-/* issue a playlist callback */
-void mpdclient_playlist_callback(mpdclient_t *c, int event, gpointer data);
+bool
+mpdclient_cmd_clear(struct mpdclient *c);
 
+bool
+mpdclient_cmd_volume(struct mpdclient *c, gint value);
 
-/*** filelist functions  ***************************************************/
-mpdclient_filelist_t *mpdclient_filelist_free(mpdclient_filelist_t *filelist);
-mpdclient_filelist_t *mpdclient_filelist_get(mpdclient_t *c, const gchar *path);
-mpdclient_filelist_t *mpdclient_filelist_search(mpdclient_t *c, 
-                                               int exact_match,
-                                               int table,
-                                               gchar *path);
-mpdclient_filelist_t *mpdclient_filelist_search_utf8(mpdclient_t *c, 
-                                                    int exact_match,
-                                                    int table,
-                                                    gchar *path);
-mpdclient_filelist_t *mpdclient_filelist_update(mpdclient_t *c, 
-                                               mpdclient_filelist_t *flist);
+bool
+mpdclient_cmd_volume_up(struct mpdclient *c);
 
-#define HIGHLIGHT  (0x01)
-void mpdclient_filelist_set_flags(mpdclient_filelist_t *flist, 
-                                 mpd_Song *song,
-                                 guint flags);
+bool
+mpdclient_cmd_volume_down(struct mpdclient *c);
 
-void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
-void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
-filelist_entry_t *mpdclient_filelist_find_song(mpdclient_filelist_t *flist,
-                                              mpd_Song *song);
+bool
+mpdclient_cmd_add_path(struct mpdclient *c, const gchar *path);
 
-/* add all songs in filelist to the playlist */
-int mpdclient_filelist_add_all(mpdclient_t *c, mpdclient_filelist_t *fl);
+bool
+mpdclient_cmd_add(struct mpdclient *c, const struct mpd_song *song);
 
-/*** mpdclient browse callbacks ********************************************/
+bool
+mpdclient_cmd_delete(struct mpdclient *c, gint index);
 
-#define BROWSE_DB_UPDATED          0x01
-#define BROWSE_PLAYLIST_SAVED      0x02
-#define BROWSE_PLAYLIST_DELETED    0x03
+bool
+mpdclient_cmd_delete_range(struct mpdclient *c, unsigned start, unsigned end);
 
+bool
+mpdclient_cmd_move(struct mpdclient *c, unsigned dest, unsigned src);
 
-/* install a playlist callback function */
-void mpdclient_install_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
+/*** playlist functions  **************************************************/
 
-/* remove a playlist callback function */
-void mpdclient_remove_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
+/* update the complete playlist */
+bool
+mpdclient_playlist_update(struct mpdclient *c);
 
+/* get playlist changes */
+bool
+mpdclient_playlist_update_changes(struct mpdclient *c);
 
-/* issue a playlist callback */
-void mpdclient_browse_callback(mpdclient_t *c, int event, gpointer data);
+/* add all songs in filelist to the playlist */
+bool
+mpdclient_filelist_add_all(struct mpdclient *c, struct filelist *fl);
 
 /* sort by list-format */
 gint compare_filelistentry_format(gconstpointer filelist_entry1, gconstpointer filelist_entry2);