mpdclient: update the "source" documentation

[ncmpc.git] / src / mpdclient.h

diff --git a/src/mpdclient.h b/src/mpdclient.h
index b6027da7be83c43a1db3704e5cce02b8610e7213..fb083b9c4fe2cd23d21644cfe85698250b7cca60 100644 (file)
--- a/src/mpdclient.h
+++ b/src/mpdclient.h
@@ -2,6 +2,7 @@
 #define MPDCLIENT_H
 
 #include "playlist.h"
+#include "Compiler.h"
 
 #include <mpd/client.h>
 
@@ -12,6 +13,25 @@ struct mpdclient {
        struct mpdclient_playlist playlist;
 
        struct mpd_connection *connection;
+
+       /**
+        * This attribute is incremented whenever the connection changes
+        * (i.e. on disconnection and (re-)connection).
+        */
+       unsigned connection_id;
+
+       /**
+        * Tracks idle events.  It is automatically called by
+        * mpdclient_get_connection() and mpdclient_put_connection().
+        */
+       struct mpd_glib_source *source;
+
+       /**
+        * This attribute is true when the connection is currently in
+        * "idle" mode, and the #mpd_glib_source waits for an event.
+        */
+       bool idle;
+
        struct mpd_status *status;
        const struct mpd_song *song;
 
@@ -19,40 +39,74 @@ struct mpdclient {
        unsigned update_id;
 
        /**
-        * A bit mask of idle events occured since the last update.
+        * A bit mask of idle events occurred since the last update.
         */
        enum mpd_idle events;
 };
 
+enum {
+       /**
+        * all idle events the version of libmpdclient, ncmpc is compiled
+        * against, supports
+        */
+       MPD_IDLE_ALL = MPD_IDLE_DATABASE
+               | MPD_IDLE_STORED_PLAYLIST
+               | MPD_IDLE_QUEUE
+               | MPD_IDLE_PLAYER
+               | MPD_IDLE_MIXER
+               | MPD_IDLE_OUTPUT
+               | MPD_IDLE_OPTIONS
+               | MPD_IDLE_UPDATE
+               | MPD_IDLE_STICKER
+               | MPD_IDLE_SUBSCRIPTION
+               | MPD_IDLE_MESSAGE
+};
+
 /** functions ***************************************************************/
 
 bool
 mpdclient_handle_error(struct mpdclient *c);
 
+static inline bool
+mpdclient_finish_command(struct mpdclient *c)
+{
+       return mpd_response_finish(c->connection)
+               ? true : mpdclient_handle_error(c);
+}
+
 struct mpdclient *
 mpdclient_new(void);
 
 void mpdclient_free(struct mpdclient *c);
 
+gcc_pure
 static inline bool
 mpdclient_is_connected(const struct mpdclient *c)
 {
        return c->connection != NULL;
 }
 
+gcc_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);
+}
+
+gcc_pure
 static inline const struct mpd_song *
 mpdclient_get_current_song(const struct mpdclient *c)
 {
-       return c->song != NULL && c->status != NULL &&
-               (mpd_status_get_state(c->status) == MPD_STATE_PLAY ||
-                mpd_status_get_state(c->status) == MPD_STATE_PAUSE)
+       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);
+                 unsigned timeout_ms, const gchar *password);
 
 void
 mpdclient_disconnect(struct mpdclient *c);
@@ -66,18 +120,8 @@ mpdclient_get_connection(struct mpdclient *c);
 void
 mpdclient_put_connection(struct mpdclient *c);
 
-/**
- * To be implemented by the application: mpdclient.c calls this to
- * display an error message.
- */
-void
-mpdclient_ui_error(const char *message);
-
 /*** MPD Commands  **********************************************************/
 
-bool
-mpdclient_cmd_play(struct mpdclient *c, gint index);
-
 bool
 mpdclient_cmd_crop(struct mpdclient *c);
 
@@ -106,11 +150,23 @@ bool
 mpdclient_cmd_delete_range(struct mpdclient *c, unsigned start, unsigned end);
 
 bool
-mpdclient_cmd_move(struct mpdclient *c, gint old_index, gint new_index);
+mpdclient_cmd_move(struct mpdclient *c, unsigned dest, unsigned src);
 
-/* list functions */
-GList *mpdclient_get_artists(struct mpdclient *c);
-GList *mpdclient_get_albums(struct mpdclient *c, const gchar *artist_utf8);
+bool
+mpdclient_cmd_subscribe(struct mpdclient *c, const char *channel);
+
+bool
+mpdclient_cmd_unsubscribe(struct mpdclient *c, const char *channel);
+
+bool
+mpdclient_cmd_send_message(struct mpdclient *c, const char *channel,
+                          const char *text);
+
+bool
+mpdclient_send_read_messages(struct mpdclient *c);
+
+struct mpd_message *
+mpdclient_recv_message(struct mpdclient *c);
 
 /*** playlist functions  **************************************************/
 
@@ -126,7 +182,4 @@ mpdclient_playlist_update_changes(struct mpdclient *c);
 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);
-
 #endif