X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/83fb99f9459f4f6a270d2b75c8dd0137d2f2ccde..846b01c278ea82514b09b029fb7c6b3aa8345f90:/disobedience/queue-generic.c diff --git a/disobedience/queue-generic.c b/disobedience/queue-generic.c index c4b5b32..179998a 100644 --- a/disobedience/queue-generic.c +++ b/disobedience/queue-generic.c @@ -1,24 +1,22 @@ /* * This file is part of DisOrder - * Copyright (C) 2006-2008 Richard Kettlewell + * Copyright (C) 2006-2009 Richard Kettlewell * - * This program is free software; you can redistribute it and/or modify + * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 - * USA + * along with this program. If not, see . */ /** @file disobedience/queue-generic.c - * @brief Queue widgets + * @brief Disobedience queue widgets * * This file provides contains code shared between all the queue-like * widgets - the queue, the recent list and the added tracks list. @@ -37,137 +35,33 @@ * status to everything else found in that list. * * To do: - * - drag and drop queue rearrangement * - display playing row in a different color? */ #include "disobedience.h" +#include "popup.h" #include "queue-generic.h" - -static struct queuelike *const queuelikes[] = { - &ql_queue, &ql_recent, &ql_added +#include "multidrag.h" + +static const GtkTargetEntry queuelike_targets[] = { + { + (char *)"text/x-disorder-queued-tracks", /* drag type */ + GTK_TARGET_SAME_WIDGET, /* rearrangement within a widget */ + 0 /* ID value */ + }, + { + (char *)"text/x-disorder-playable-tracks", /* drag type */ + GTK_TARGET_SAME_APP|GTK_TARGET_OTHER_WIDGET, /* copying between widgets */ + 1 /* ID value */ + }, }; -#define NQUEUELIKES (sizeof queuelikes / sizeof *queuelikes) /* Track detail lookup ----------------------------------------------------- */ -static int namepart_lookups_outstanding; -static const struct cache_type cachetype_string = { 3600 }; -static const struct cache_type cachetype_integer = { 3600 }; - -/** @brief Called when a namepart lookup has completed or failed - * - * When there are no lookups in flight a redraw is provoked. This might well - * provoke further lookups. - */ -static void namepart_completed_or_failed(void) { - --namepart_lookups_outstanding; - if(!namepart_lookups_outstanding) { - /* There are no more lookups outstanding, so we update the display */ - for(unsigned n = 0; n < NQUEUELIKES; ++n) - ql_update_list_store(queuelikes[n]); - } -} - -/** @brief Called when a namepart lookup has completed */ -static void namepart_completed(void *v, const char *error, const char *value) { - D(("namepart_completed")); - if(error) { - gtk_label_set_text(GTK_LABEL(report_label), error); - value = "?"; - } - const char *key = v; - - cache_put(&cachetype_string, key, value); - namepart_completed_or_failed(); -} - -/** @brief Called when a length lookup has completed */ -static void length_completed(void *v, const char *error, long l) { - D(("length_completed")); - if(error) { - gtk_label_set_text(GTK_LABEL(report_label), error); - l = -1; - } - const char *key = v; - long *value; - - D(("namepart_completed")); - value = xmalloc(sizeof *value); - *value = l; - cache_put(&cachetype_integer, key, value); - namepart_completed_or_failed(); -} - -/** @brief Arrange to fill in a namepart cache entry */ -static void namepart_fill(const char *track, - const char *context, - const char *part, - const char *key) { - D(("namepart_fill %s %s %s %s", track, context, part, key)); - /* We limit the total number of lookups in flight */ - ++namepart_lookups_outstanding; - D(("namepart_lookups_outstanding -> %d\n", namepart_lookups_outstanding)); - disorder_eclient_namepart(client, namepart_completed, - track, context, part, (void *)key); -} - -/** @brief Look up a namepart - * @param track Track name - * @param context Context - * @param part Name part - * @param lookup If nonzero, will schedule a lookup for unknown values - * - * If it is in the cache then just return its value. If not then look it up - * and arrange for the queues to be updated when its value is available. */ -static const char *namepart(const char *track, - const char *context, - const char *part) { - char *key; - const char *value; - - D(("namepart %s %s %s", track, context, part)); - byte_xasprintf(&key, "namepart context=%s part=%s track=%s", - context, part, track); - value = cache_get(&cachetype_string, key); - if(!value) { - D(("deferring...")); - namepart_fill(track, context, part, key); - value = "?"; - } - return value; -} - -/** @brief Called from @ref disobedience/properties.c when we know a name part has changed */ -void namepart_update(const char *track, - const char *context, - const char *part) { - char *key; - - byte_xasprintf(&key, "namepart context=%s part=%s track=%s", - context, part, track); - /* Only refetch if it's actually in the cache. */ - if(cache_get(&cachetype_string, key)) - namepart_fill(track, context, part, key); -} - -/** @brief Look up a track length - * - * If it is in the cache then just return its value. If not then look it up - * and arrange for the queues to be updated when its value is available. */ -static long getlength(const char *track) { - char *key; - const long *value; - - D(("getlength %s", track)); - byte_xasprintf(&key, "length track=%s", track); - value = cache_get(&cachetype_integer, key); - if(value) - return *value; - D(("deferring..."));; - ++namepart_lookups_outstanding; - D(("namepart_lookups_outstanding -> %d\n", namepart_lookups_outstanding)); - disorder_eclient_length(client, length_completed, track, key); - return -1; +static void queue_lookups_completed(const char attribute((unused)) *event, + void attribute((unused)) *eventdata, + void *callbackdata) { + struct queuelike *ql = callbackdata; + ql_update_list_store(ql); } /* Column formatting -------------------------------------------------------- */ @@ -229,7 +123,7 @@ const char *column_length(const struct queue_entry *q, char *played = 0, *length = 0; /* Work out what to say for the length */ - l = getlength(q->track); + l = namepart_length(q->track); if(l > 0) byte_xasprintf(&length, "%ld:%02ld", l / 60, l % 60); else @@ -242,7 +136,9 @@ const char *column_length(const struct queue_entry *q, if(last_state & DISORDER_TRACK_PAUSED) l = playing_track->sofar; else { - time(&now); + if(!last_playing) + return NULL; + xtime(&now); l = playing_track->sofar + (now - last_playing); } byte_xasprintf(&played, "%ld:%02ld/%s", l / 60, l % 60, length); @@ -256,20 +152,33 @@ const char *column_length(const struct queue_entry *q, /** @brief Return the @ref queue_entry corresponding to @p iter * @param model Model that owns @p iter * @param iter Tree iterator - * @return ID string + * @return Pointer to queue entry */ struct queue_entry *ql_iter_to_q(GtkTreeModel *model, GtkTreeIter *iter) { struct queuelike *ql = g_object_get_data(G_OBJECT(model), "ql"); GValue v[1]; memset(v, 0, sizeof v); - gtk_tree_model_get_value(model, iter, ql->ncolumns, v); + gtk_tree_model_get_value(model, iter, ql->ncolumns + QUEUEPOINTER_COLUMN, v); assert(G_VALUE_TYPE(v) == G_TYPE_POINTER); struct queue_entry *const q = g_value_get_pointer(v); g_value_unset(v); return q; } +/** @brief Return the @ref queue_entry corresponding to @p path + * @param model Model to query + * @param path Path into tree + * @return Pointer to queue entry or NULL + */ +struct queue_entry *ql_path_to_q(GtkTreeModel *model, + GtkTreePath *path) { + GtkTreeIter iter[1]; + if(!gtk_tree_model_get_iter(model, iter, path)) + return NULL; + return ql_iter_to_q(model, iter); +} + /** @brief Update one row of a list store * @param q Queue entry * @param iter Iterator referring to row or NULL to work it out @@ -291,13 +200,27 @@ void ql_update_row(struct queue_entry *q, iter = my_iter; } /* Update all the columns */ - for(int col = 0; col < ql->ncolumns; ++col) + for(int col = 0; col < ql->ncolumns; ++col) { + const char *const v = ql->columns[col].value(q, + ql->columns[col].data); + if(v) + gtk_list_store_set(ql->store, iter, + col, v, + -1); + } + gtk_list_store_set(ql->store, iter, + ql->ncolumns + QUEUEPOINTER_COLUMN, q, + -1); + if(q == playing_track) gtk_list_store_set(ql->store, iter, - col, ql->columns[col].value(q, - ql->columns[col].data), + ql->ncolumns + BACKGROUND_COLUMN, BG_PLAYING, + ql->ncolumns + FOREGROUND_COLUMN, FG_PLAYING, + -1); + else + gtk_list_store_set(ql->store, iter, + ql->ncolumns + BACKGROUND_COLUMN, (char *)0, + ql->ncolumns + FOREGROUND_COLUMN, (char *)0, -1); - /* The hidden extra column is the queue entry */ - gtk_list_store_set(ql->store, iter, ql->ncolumns, q, -1); } /** @brief Update the list store @@ -400,7 +323,9 @@ void ql_new_queue(struct queuelike *ql, const struct newqueue_data *nqd = hash_find(h, q->id); if(nqd->new) { /* Tell this row that it belongs to the new version of the queue */ - gtk_list_store_set(ql->store, iter, ql->ncolumns, nqd->new, -1); + gtk_list_store_set(ql->store, iter, + ql->ncolumns + QUEUEPOINTER_COLUMN, nqd->new, + -1); it = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter); ++kept; } else { @@ -421,7 +346,6 @@ void ql_new_queue(struct queuelike *ql, for(struct queue_entry *q = newq; q; q = q->next) { const struct newqueue_data *nqd = hash_find(h, q->id); if(!nqd->old) { - GtkTreeIter iter[1]; if(after) { /* Try to insert at the right sort of place */ GtkTreeIter where[1]; @@ -435,7 +359,9 @@ void ql_new_queue(struct queuelike *ql, gtk_list_store_append(ql->store, iter); } else gtk_list_store_prepend(ql->store, iter); - gtk_list_store_set(ql->store, iter, ql->ncolumns, q, -1); + gtk_list_store_set(ql->store, iter, + ql->ncolumns + QUEUEPOINTER_COLUMN, q, + -1); //fprintf(stderr, " add %s", q->id); ++inserted; } @@ -495,20 +421,258 @@ void ql_new_queue(struct queuelike *ql, ql->q = newq; /* Set the rest of the columns in new rows */ ql_update_list_store(ql); - /* Update menu sensitivity */ - menu_update(-1); --suppress_actions; } +/** @brief Called when a drag moves within a candidate destination + * @param w Destination widget + * @param dc Drag context + * @param x Current pointer location + * @param y Current pointer location + * @param time_ Current time + * @param user_data Pointer to queuelike + * @return TRUE in a dropzone, otherwise FALSE + */ +static gboolean ql_drag_motion(GtkWidget *w, + GdkDragContext *dc, + gint x, + gint y, + guint time_, + gpointer attribute((unused)) user_data) { + //struct queuelike *const ql = user_data; + GdkDragAction action = 0; + + // GTK_DEST_DEFAULT_MOTION vets actions as follows: + // 1) if dc->suggested_action is in the gtk_drag_dest_set actions + // then dc->suggested_action is taken as the action. + // 2) otherwise if dc->actions intersects the gtk_drag_dest_set actions + // then the lowest-numbered member of the intersection is chosen. + // 3) otherwise no member is chosen and gdk_drag_status() is called + // with action=0 to refuse the drop. + if(dc->suggested_action) { + if(dc->suggested_action & (GDK_ACTION_MOVE|GDK_ACTION_COPY)) + action = dc->suggested_action; + } else if(dc->actions & GDK_ACTION_MOVE) + action = GDK_ACTION_MOVE; + else if(dc->actions & GDK_ACTION_COPY) + action = GDK_ACTION_COPY; + /*fprintf(stderr, "suggested %#x actions %#x result %#x\n", + dc->suggested_action, dc->actions, action);*/ + if(action) { + // If the action is acceptable then we see if this widget is acceptable + if(gtk_drag_dest_find_target(w, dc, NULL) == GDK_NONE) + action = 0; + } + // Report the status + gdk_drag_status(dc, action, time_); + if(action) { + // Highlight the drop area + GtkTreePath *path; + GtkTreeViewDropPosition pos; + + if(gtk_tree_view_get_dest_row_at_pos(GTK_TREE_VIEW(w), + x, y, + &path, + &pos)) { + //fprintf(stderr, "gtk_tree_view_get_dest_row_at_pos() -> TRUE\n"); + // Normalize drop position + switch(pos) { + case GTK_TREE_VIEW_DROP_INTO_OR_BEFORE: + pos = GTK_TREE_VIEW_DROP_BEFORE; + break; + case GTK_TREE_VIEW_DROP_INTO_OR_AFTER: + pos = GTK_TREE_VIEW_DROP_AFTER; + break; + default: break; + } + // Highlight drop target + gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW(w), path, pos); + } else { + //fprintf(stderr, "gtk_tree_view_get_dest_row_at_pos() -> FALSE\n"); + gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW(w), NULL, 0); + } + } + return TRUE; +} + +/** @brief Called when a drag moves leaves a candidate destination + * @param w Destination widget + * @param dc Drag context + * @param time_ Current time + * @param user_data Pointer to queuelike + */ +static void ql_drag_leave(GtkWidget *w, + GdkDragContext attribute((unused)) *dc, + guint attribute((unused)) time_, + gpointer attribute((unused)) user_data) { + //struct queuelike *const ql = user_data; + + gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW(w), NULL, 0); +} + +/** @brief Callback to add selected tracks to the selection data + * + * Called from ql_drag_data_get(). + */ +static void ql_drag_data_get_collect(GtkTreeModel *model, + GtkTreePath attribute((unused)) *path, + GtkTreeIter *iter, + gpointer data) { + struct dynstr *const result = data; + struct queue_entry *const q = ql_iter_to_q(model, iter); + + dynstr_append_string(result, q->id); + dynstr_append(result, '\n'); + dynstr_append_string(result, q->track); + dynstr_append(result, '\n'); +} + +/** @brief Called to extract the dragged data from the source queuelike + * @param w Source widget (the tree view) + * @param dc Drag context + * @param data Where to put the answer + * @param info_ Target @c info parameter + * @param time_ Time data requested (for some reason not a @c time_t) + * @param user_data The queuelike + */ +static void ql_drag_data_get(GtkWidget attribute((unused)) *w, + GdkDragContext attribute((unused)) *dc, + GtkSelectionData *data, + guint attribute((unused)) info_, + guint attribute((unused)) time_, + gpointer user_data) { + struct queuelike *const ql = user_data; + struct dynstr result[1]; + + /* The list of tracks is converted into a single string, consisting of IDs + * and track names. Each is terminated by a newline. Including both ID and + * track name means that the receiver can use whichever happens to be more + * convenient. */ + dynstr_init(result); + gtk_tree_selection_selected_foreach(ql->selection, + ql_drag_data_get_collect, + result); + // TODO must not be able to drag playing track! + //fprintf(stderr, "drag-data-get: %.*s\n", + // result->nvec, result->vec); + /* gtk_selection_data_set_text() insists that data->target is one of a + * variety of stringy atoms. TODO: where does this value actually come + * from? */ + gtk_selection_data_set(data, + GDK_TARGET_STRING, + 8, (guchar *)result->vec, result->nvec); +} + +/** @brief Called when drag data is received + * @param w Target widget (the tree view) + * @param dc Drag context + * @param x The drop location + * @param y The drop location + * @param data The selection data + * @param info_ The target type that was chosen + * @param time_ Time data received (for some reason not a @c time_t) + * @param user_data The queuelike + */ +static void ql_drag_data_received(GtkWidget attribute((unused)) *w, + GdkDragContext attribute((unused)) *dc, + gint x, + gint y, + GtkSelectionData *data, + guint attribute((unused)) info_, + guint attribute((unused)) time_, + gpointer user_data) { + struct queuelike *const ql = user_data; + char *result, *p; + struct vector ids[1], tracks[1]; + int parity = 0; + + //fprintf(stderr, "drag-data-received: %d,%d info_=%u\n", x, y, info_); + /* Get the selection string */ + p = result = (char *)gtk_selection_data_get_text(data); + if(!result) { + //fprintf(stderr, "gtk_selection_data_get_text() returned NULL\n"); + return; + } + //fprintf(stderr, "%s--\n", result); + /* Parse it back into IDs and track names */ + vector_init(ids); + vector_init(tracks); + while(*p) { + char *nl = strchr(p, '\n'); + if(!nl) + break; + *nl = 0; + //fprintf(stderr, " %s\n", p); + vector_append(parity++ & 1 ? tracks : ids, xstrdup(p)); + p = nl + 1; + } + g_free(result); + if(ids->nvec != tracks->nvec) { + //fprintf(stderr, " inconsistent drag data!\n"); + return; + } + vector_terminate(ids); + vector_terminate(tracks); + /* Figure out which row the drop precedes (if any) */ + GtkTreePath *path; + GtkTreeViewDropPosition pos; + struct queue_entry *q; + if(!gtk_tree_view_get_dest_row_at_pos(GTK_TREE_VIEW(ql->view), x, y, + &path, &pos)) { + //fprintf(stderr, "gtk_tree_view_get_dest_row_at_pos returned FALSE\n"); + /* This generally means a drop past the end of the queue. We find the last + * element in the queue and ask to move after that. */ + for(q = ql->q; q && q->next; q = q->next) + ; + } else { + /* Convert the path to a queue entry pointer. */ + q = ql_path_to_q(GTK_TREE_MODEL(ql->store), path); + //fprintf(stderr, " tree view likes to drop near %s\n", + // q->id ? q->id : "NULL"); + /* TODO interpretation of q=NULL */ + /* Q should point to the entry just before the insertion point, so that + * moveafter works, or NULL to insert right at the start. We don't support + * dropping into a row, since that doesn't make sense for us. */ + switch(pos) { + case GTK_TREE_VIEW_DROP_BEFORE: + case GTK_TREE_VIEW_DROP_INTO_OR_BEFORE: + if(q) { + q = q->prev; + //fprintf(stderr, " ...but we like to drop near %s\n", + // q ? q->id : "NULL"); + } + break; + default: + break; + } + } + /* Guarantee we never drop an empty list */ + if(!tracks->nvec) + return; + /* Note that q->id can match one of ids[]. This doesn't matter for + * moveafter but TODO may matter for playlist support. */ + switch(info_) { + case 0: + /* Rearrangement. Send ID and track data. */ + ql->drop(ql, tracks->nvec, tracks->vec, ids->vec, q); + break; + case 1: + /* Copying between widgets. IDs mean nothing so don't send them. */ + ql->drop(ql, tracks->nvec, tracks->vec, NULL, q); + break; + } +} + /** @brief Initialize a @ref queuelike */ GtkWidget *init_queuelike(struct queuelike *ql) { D(("init_queuelike")); - /* Create the list store. We add an extra column to hold the ID. */ - GType *types = xcalloc(ql->ncolumns + 1, sizeof (GType)); - for(int n = 0; n < ql->ncolumns; ++n) + /* Create the list store. We add an extra column to hold a pointer to the + * queue_entry. */ + GType *types = xcalloc(ql->ncolumns + EXTRA_COLUMNS, sizeof (GType)); + for(int n = 0; n < ql->ncolumns + EXTRA_COLUMNS; ++n) types[n] = G_TYPE_STRING; - types[ql->ncolumns] = G_TYPE_POINTER; - ql->store = gtk_list_store_newv(ql->ncolumns + 1, types); + types[ql->ncolumns + QUEUEPOINTER_COLUMN] = G_TYPE_POINTER; + ql->store = gtk_list_store_newv(ql->ncolumns + EXTRA_COLUMNS, types); g_object_set_data(G_OBJECT(ql->store), "ql", (void *)ql); /* Create the view */ @@ -526,6 +690,8 @@ GtkWidget *init_queuelike(struct queuelike *ql) { (ql->columns[n].name, r, "text", n, + "background", ql->ncolumns + BACKGROUND_COLUMN, + "foreground", ql->ncolumns + FOREGROUND_COLUMN, (char *)0); gtk_tree_view_column_set_resizable(c, TRUE); gtk_tree_view_column_set_reorderable(c, TRUE); @@ -542,11 +708,65 @@ GtkWidget *init_queuelike(struct queuelike *ql) { g_signal_connect(ql->view, "button-press-event", G_CALLBACK(ql_button_release), ql); + /* Drag+drop*/ + if(ql->drop) { + /* Originally this was: + * + * gtk_tree_view_set_reorderable(GTK_TREE_VIEW(ql->view), TRUE); + * + * However this has a two deficiencies: + * + * 1) Only one row can be dragged at once. It would be nice + * to be able to do bulk rearrangements since the server + * can cope with that well. + * 2) Dragging between windows is not possible. When playlist + * support appears, it should be possible to drag tracks + * from the choose tag into the playlist. + * + * At the time of writing neither of these problems are fully solved, the + * code as it stands is just a stepping stone in that direction. + */ + + /* This view will act as a drag source */ + gtk_drag_source_set(ql->view, + GDK_BUTTON1_MASK, + queuelike_targets, + sizeof queuelike_targets / sizeof *queuelike_targets, + GDK_ACTION_MOVE); + /* This view will act as a drag destination */ + gtk_drag_dest_set(ql->view, + GTK_DEST_DEFAULT_HIGHLIGHT|GTK_DEST_DEFAULT_DROP, + queuelike_targets, + sizeof queuelike_targets / sizeof *queuelike_targets, + GDK_ACTION_MOVE|GDK_ACTION_COPY); + g_signal_connect(ql->view, "drag-motion", + G_CALLBACK(ql_drag_motion), ql); + g_signal_connect(ql->view, "drag-leave", + G_CALLBACK(ql_drag_leave), ql); + g_signal_connect(ql->view, "drag-data-get", + G_CALLBACK(ql_drag_data_get), ql); + g_signal_connect(ql->view, "drag-data-received", + G_CALLBACK(ql_drag_data_received), ql); + make_treeview_multidrag(ql->view); + } else { + /* For queues that cannot accept a drop we still accept a copy out */ + gtk_drag_source_set(ql->view, + GDK_BUTTON1_MASK, + queuelike_targets, + sizeof queuelike_targets / sizeof *queuelike_targets, + GDK_ACTION_COPY); + g_signal_connect(ql->view, "drag-data-get", + G_CALLBACK(ql_drag_data_get), ql); + make_treeview_multidrag(ql->view); + } + /* TODO style? */ - /* TODO drag+drop */ - ql->init(); + ql->init(ql); + /* Update display text when lookups complete */ + event_register("lookups-completed", queue_lookups_completed, ql); + GtkWidget *scrolled = scroll_widget(ql->view); g_object_set_data(G_OBJECT(scrolled), "type", (void *)ql_tabtype(ql)); return scrolled;