chiark / gitweb /
Disobedience drag+drop code is now part of queue-generic.* (and still
authorRichard Kettlewell <rjk@greenend.org.uk>
Sat, 6 Dec 2008 16:49:27 +0000 (16:49 +0000)
committerRichard Kettlewell <rjk@greenend.org.uk>
Sat, 6 Dec 2008 16:49:27 +0000 (16:49 +0000)
works), allowing it to be used in the future for playlist
rearrangement.

disobedience/queue-generic.c
disobedience/queue-generic.h
disobedience/queue.c

index 8c7458a..daf5a6b 100644 (file)
@@ -143,7 +143,7 @@ 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) {
@@ -399,6 +399,120 @@ void ql_new_queue(struct queuelike *ql,
   --suppress_actions;
 }
 
+/* Drag and drop has to be figured out experimentally, because it is not well
+ * documented.
+ *
+ * First you get a row-inserted.  The path argument points to the destination
+ * row but this will not yet have had its values set.  The source row is still
+ * present.  AFAICT the iter argument points to the same place.
+ *
+ * Then you get a row-deleted.  The path argument identifies the row that was
+ * deleted.  By this stage the row inserted above has acquired its values.
+ *
+ * A complication is that the deletion will move the inserted row.  For
+ * instance, if you do a drag that moves row 1 down to after the track that was
+ * formerly on row 9, in the row-inserted call it will show up as row 10, but
+ * in the row-deleted call, row 1 will have been deleted thus making the
+ * inserted row be row 9.
+ *
+ * So when we see the row-inserted we have no idea what track to move.
+ * Therefore we stash it until we see a row-deleted.
+ */
+
+/** @brief row-inserted callback */
+static void ql_row_inserted(GtkTreeModel attribute((unused)) *treemodel,
+                            GtkTreePath *path,
+                            GtkTreeIter attribute((unused)) *iter,
+                            gpointer user_data) {
+  struct queuelike *const ql = user_data;
+  if(!suppress_actions) {
+#if 0
+    char *ps = gtk_tree_path_to_string(path);
+    GtkTreeIter piter[1];
+    gboolean pi = gtk_tree_model_get_iter(treemodel, piter, path);
+    struct queue_entry *pq = pi ? ql_iter_to_q(treemodel, piter) : 0;
+    struct queue_entry *iq = ql_iter_to_q(treemodel, iter);
+
+    fprintf(stderr, "row-inserted %s path=%s pi=%d pq=%p path=%s iq=%p iter=%s\n",
+            ql->name,
+            ps,
+            pi,
+            pq,
+            (pi
+             ? (pq ? pq->track : "(pq=0)")
+             : "(pi=FALSE)"),
+            iq,
+            iq ? iq->track : "(iq=0)");
+
+    GtkTreeIter j[1];
+    gboolean jt = gtk_tree_model_get_iter_first(treemodel, j);
+    int row = 0;
+    while(jt) {
+      struct queue_entry *q = ql_iter_to_q(treemodel, j);
+      fprintf(stderr, " %2d %s\n", row++, q ? q->track : "(no q)");
+      jt = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), j);
+    }
+    g_free(ps);
+#endif
+    /* Remember an iterator pointing at the insertion target */
+    if(ql->drag_target)
+      gtk_tree_path_free(ql->drag_target);
+    ql->drag_target = gtk_tree_path_copy(path);
+  }
+}
+
+/** @brief row-deleted callback */
+static void ql_row_deleted(GtkTreeModel attribute((unused)) *treemodel,
+                           GtkTreePath *path,
+                           gpointer user_data) {
+  struct queuelike *const ql = user_data;
+
+  if(!suppress_actions) {
+#if 0
+    char *ps = gtk_tree_path_to_string(path);
+    fprintf(stderr, "row-deleted %s path=%s ql->drag_target=%s\n",
+            ql->name, ps, gtk_tree_path_to_string(ql->drag_target));
+    GtkTreeIter j[1];
+    gboolean jt = gtk_tree_model_get_iter_first(treemodel, j);
+    int row = 0;
+    while(jt) {
+      struct queue_entry *q = ql_iter_to_q(treemodel, j);
+      fprintf(stderr, " %2d %s\n", row++, q ? q->track : "(no q)");
+      jt = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), j);
+    }
+    g_free(ps);
+#endif
+    if(!ql->drag_target) {
+      error(0, "%s: unsuppressed row-deleted with no row-inserted",
+            ql->name);
+      return;
+    }
+
+    /* Get the source and destination row numbers. */
+    int srcrow = gtk_tree_path_get_indices(path)[0];
+    int dstrow = gtk_tree_path_get_indices(ql->drag_target)[0];
+    //fprintf(stderr, "srcrow=%d dstrow=%d\n", srcrow, dstrow);
+
+    /* Note that the source row is computed AFTER the destination has been
+     * inserted, since GTK+ does the insert before the delete.  Therefore if
+     * the source row is south (higher row number) of the destination, it will
+     * be one higher than expected.
+     *
+     * For instance if we drag row 1 to before row 0 we will see row-inserted
+     * for row 0 but then a row-deleted for row 2.
+     */
+    if(srcrow > dstrow)
+      --srcrow;
+
+    /* Tell the queue implementation */
+    ql->drop(srcrow, dstrow);
+
+    /* Dispose of stashed data */
+    gtk_tree_path_free(ql->drag_target);
+    ql->drag_target = 0;
+  }
+}
+
 /** @brief Initialize a @ref queuelike */
 GtkWidget *init_queuelike(struct queuelike *ql) {
   D(("init_queuelike"));
@@ -444,6 +558,17 @@ 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) {
+    gtk_tree_view_set_reorderable(GTK_TREE_VIEW(ql->view), TRUE);
+    g_signal_connect(ql->store,
+                     "row-inserted",
+                     G_CALLBACK(ql_row_inserted), ql);
+    g_signal_connect(ql->store,
+                     "row-deleted",
+                     G_CALLBACK(ql_row_deleted), ql);
+  }
+  
   /* TODO style? */
 
   ql->init();
index 1888602..2bf33e7 100644 (file)
@@ -89,6 +89,18 @@ struct queuelike {
 
   /** @brief Menu callbacks */
   struct tabtype tabtype;
+
+  /** @brief Drag-drop callback, or NULL for no drag+drop
+   * @param src Row to move
+   * @param dst Destination position
+   *
+   * If the rearrangement is impossible then the displayed queue must be put
+   * back.
+   */
+  void (*drop)(int src, int dst);
+
+  /** @brief Stashed drag target row */
+  GtkTreePath *drag_target;
 };
 
 enum {
index db013d3..c35b90b 100644 (file)
@@ -146,6 +146,61 @@ static void queue_init(void) {
   g_timeout_add(1000/*ms*/, playing_periodic, 0);
 }
 
+static void queue_move_completed(void attribute((unused)) *v,
+                                 const char *err) {
+  if(err) {
+    popup_protocol_error(0, err);
+    return;
+  }
+  /* The log should tell us the queue changed so we do no more here */
+}
+
+/** @brief Called when drag+drop completes */
+static void queue_drop(int src, int dst) {
+  struct queue_entry *sq, *dq;
+  int n;
+
+  //fprintf(stderr, "queue_drop %d -> %d\n", src, dst);
+  if(playing_track) {
+    /* If there's a playing track then you can't drag it anywhere  */
+    if(src == 0) {
+      //fprintf(stderr, "cannot drag playing track\n");
+      queue_playing_changed();
+      return;
+    }
+    /* If you try to drop before the playing track we assume you missed and
+     * mean after instead */
+    if(!dst)
+      dst = 1;
+    //fprintf(stderr, "...adjusted to %d -> %d\n\n", src, dst);
+  }
+  /* Find the entry to move */
+  for(n = 0, sq = ql_queue.q; n < src; ++n)
+    sq = sq->next;
+  /*fprintf(stderr, "source=%s (%s)\n",
+          sq->id, sq->track);*/
+  const int after = dst - 1;
+  if(after == -1)
+    dq = 0;
+  else
+    /* Find the entry to insert after */
+    for(n = 0, dq = ql_queue.q; n < after; ++n)
+      dq = dq->next;
+  if(dq == playing_track)
+    dq = 0;
+#if 0
+  if(dq)
+    fprintf(stderr, "after=%s (%s)\n",
+            dq->id, dq->track);
+  else
+    fprintf(stderr, "after=NULL\n");
+#endif
+  disorder_eclient_moveafter(client,
+                             dq ? dq->id : "",
+                             1, &sq->id,
+                             queue_move_completed, NULL);
+}
+
 /** @brief Columns for the queue */
 static const struct queue_column queue_columns[] = {
   { "When",   column_when,     0,        COL_RIGHT },
@@ -171,161 +226,10 @@ struct queuelike ql_queue = {
   .columns = queue_columns,
   .ncolumns = sizeof queue_columns / sizeof *queue_columns,
   .menuitems = queue_menuitems,
-  .nmenuitems = sizeof queue_menuitems / sizeof *queue_menuitems
+  .nmenuitems = sizeof queue_menuitems / sizeof *queue_menuitems,
+  .drop = queue_drop
 };
 
-/* Drag and drop has to be figured out experimentally, because it is not well
- * documented.
- *
- * First you get a row-inserted.  The path argument points to the destination
- * row but this will not yet have had its values set.  The source row is still
- * present.  AFAICT the iter argument points to the same place.
- *
- * Then you get a row-deleted.  The path argument identifies the row that was
- * deleted.  By this stage the row inserted above has acquired its values.
- *
- * A complication is that the deletion will move the inserted row.  For
- * instance, if you do a drag that moves row 1 down to after the track that was
- * formerly on row 9, in the row-inserted call it will show up as row 10, but
- * in the row-deleted call, row 1 will have been deleted thus making the
- * inserted row be row 9.
- *
- * So when we see the row-inserted we have no idea what track to move.
- * Therefore we stash it until we see a row-deleted.
- */
-
-/** @brief Target row for drag */
-static int queue_drag_target = -1;
-
-static void queue_move_completed(void attribute((unused)) *v,
-                                 const char *err) {
-  if(err) {
-    popup_protocol_error(0, err);
-    return;
-  }
-  /* The log should tell us the queue changed so we do no more here */
-}
-
-static void queue_row_deleted(GtkTreeModel *treemodel,
-                              GtkTreePath *path,
-                              gpointer attribute((unused)) user_data) {
-  if(!suppress_actions) {
-#if 0
-    char *ps = gtk_tree_path_to_string(path);
-    fprintf(stderr, "row-deleted path=%s queue_drag_target=%d\n",
-            ps, queue_drag_target);
-    GtkTreeIter j[1];
-    gboolean jt = gtk_tree_model_get_iter_first(treemodel, j);
-    int row = 0;
-    while(jt) {
-      struct queue_entry *q = ql_iter_to_q(treemodel, j);
-      fprintf(stderr, " %2d %s\n", row++, q ? q->track : "(no q)");
-      jt = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql_queue.store), j);
-    }
-    g_free(ps);
-#endif
-    if(queue_drag_target < 0) {
-      error(0, "unsuppressed row-deleted with no row-inserted");
-      return;
-    }
-    int drag_source = gtk_tree_path_get_indices(path)[0];
-
-    /* If the drag is downwards (=towards higher row numbers) then the target
-     * will have been moved upwards (=towards lower row numbers) by one row. */
-    if(drag_source < queue_drag_target)
-      --queue_drag_target;
-    
-    /* Find the track to move */
-    GtkTreeIter src[1];
-    gboolean srcv = gtk_tree_model_iter_nth_child(treemodel, src, NULL,
-                                                  queue_drag_target);
-    if(!srcv) {
-      error(0, "cannot get iterator to drag target %d", queue_drag_target);
-      queue_playing_changed();
-      queue_drag_target = -1;
-      return;
-    }
-    struct queue_entry *srcq = ql_iter_to_q(treemodel, src);
-    assert(srcq);
-    //fprintf(stderr, "move %s %s\n", srcq->id, srcq->track);
-    
-    /* Don't allow the currently playing track to be moved.  As above, we put
-     * the queue back into the right order straight away. */
-    if(srcq == playing_track) {
-      //fprintf(stderr, "cannot move currently playing track\n");
-      queue_playing_changed();
-      queue_drag_target = -1;
-      return;
-    }
-
-    /* Find the destination */
-    struct queue_entry *dstq;
-    if(queue_drag_target) {
-      GtkTreeIter dst[1];
-      gboolean dstv = gtk_tree_model_iter_nth_child(treemodel, dst, NULL,
-                                                    queue_drag_target - 1);
-      if(!dstv) {
-        error(0, "cannot get iterator to drag target predecessor %d",
-              queue_drag_target - 1);
-        queue_playing_changed();
-        queue_drag_target = -1;
-        return;
-      }
-      dstq = ql_iter_to_q(treemodel, dst);
-      assert(dstq);
-      if(dstq == playing_track)
-        dstq = 0;
-    } else
-      dstq = 0;
-    /* NB if the user attempts to move a queued track before the currently
-     * playing track we assume they just missed a bit, and put it after. */
-    //fprintf(stderr, " target %s %s\n", dstq ? dstq->id : "(none)", dstq ? dstq->track : "(none)");
-    /* Now we know what is to be moved.  We need to know the preceding queue
-     * entry so we can move it. */
-    disorder_eclient_moveafter(client,
-                               dstq ? dstq->id : "",
-                               1, &srcq->id,
-                               queue_move_completed, NULL);
-    queue_drag_target = -1;
-  }
-}
-
-static void queue_row_inserted(GtkTreeModel attribute((unused)) *treemodel,
-                               GtkTreePath *path,
-                               GtkTreeIter attribute((unused)) *iter,
-                               gpointer attribute((unused)) user_data) {
-  if(!suppress_actions) {
-#if 0
-    char *ps = gtk_tree_path_to_string(path);
-    GtkTreeIter piter[1];
-    gboolean pi = gtk_tree_model_get_iter(treemodel, piter, path);
-    struct queue_entry *pq = pi ? ql_iter_to_q(treemodel, piter) : 0;
-    struct queue_entry *iq = ql_iter_to_q(treemodel, iter);
-
-    fprintf(stderr, "row-inserted path=%s pi=%d pq=%p path=%s iq=%p iter=%s\n",
-            ps,
-            pi,
-            pq,
-            (pi
-             ? (pq ? pq->track : "(pq=0)")
-             : "(pi=FALSE)"),
-            iq,
-            iq ? iq->track : "(iq=0)");
-
-    GtkTreeIter j[1];
-    gboolean jt = gtk_tree_model_get_iter_first(treemodel, j);
-    int row = 0;
-    while(jt) {
-      struct queue_entry *q = ql_iter_to_q(treemodel, j);
-      fprintf(stderr, " %2d %s\n", row++, q ? q->track : "(no q)");
-      jt = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql_queue.store), j);
-    }
-    g_free(ps);
-#endif
-    queue_drag_target = gtk_tree_path_get_indices(path)[0];
-  }
-}
-
 /** @brief Called when a key is pressed in the queue tree view */
 static gboolean queue_key_press(GtkWidget attribute((unused)) *widget,
                                 GdkEventKey *event,
@@ -346,14 +250,6 @@ static gboolean queue_key_press(GtkWidget attribute((unused)) *widget,
 GtkWidget *queue_widget(void) {
   GtkWidget *const w = init_queuelike(&ql_queue);
 
-  /* Enable drag+drop */
-  gtk_tree_view_set_reorderable(GTK_TREE_VIEW(ql_queue.view), TRUE);
-  g_signal_connect(ql_queue.store,
-                   "row-inserted",
-                   G_CALLBACK(queue_row_inserted), &ql_queue);
-  g_signal_connect(ql_queue.store,
-                   "row-deleted",
-                   G_CALLBACK(queue_row_deleted), &ql_queue);
   /* Catch keypresses */
   g_signal_connect(ql_queue.view, "key-press-event",
                    G_CALLBACK(queue_key_press), &ql_queue);