typo
[disorder] / disobedience / playlists.c
index add990d..bf6d185 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder
- * Copyright (C) 2008 Richard Kettlewell
+ * Copyright (C) 2008, 2009 Richard Kettlewell
  *
  * 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
 /** @file disobedience/playlists.c
  * @brief Playlist for Disobedience
  *
+ * The playlists management window contains:
+ * - a list of all playlists
+ * - an add button
+ * - a delete button
+ * - a drag+drop capable view of the playlist
+ * - a close button
  */
 #include "disobedience.h"
+#include "queue-generic.h"
+#include "popup.h"
+
+#if PLAYLISTS
 
 static void playlists_updated(void *v,
                               const char *err,
                               int nvec, char **vec);
 
+/** @brief Playlist editing window */
+static GtkWidget *playlists_window;
+
+/** @brief Tree model for list of playlists */
+static GtkListStore *playlists_list;
+
+/** @brief Selection for list of playlists */
+static GtkTreeSelection *playlists_selection;
+
+/** @brief Currently selected playlist */
+static const char *playlists_selected;
+
+/** @brief Delete button */
+static GtkWidget *playlists_delete_button;
+
 /** @brief Current list of playlists or NULL */
 char **playlists;
 
 /** @brief Count of playlists */
 int nplaylists;
 
+/** @brief Columns for the playlist editor */
+static const struct queue_column playlist_columns[] = {
+  { "Artist", column_namepart, "artist", COL_EXPAND|COL_ELLIPSIZE },
+  { "Album",  column_namepart, "album",  COL_EXPAND|COL_ELLIPSIZE },
+  { "Title",  column_namepart, "title",  COL_EXPAND|COL_ELLIPSIZE },
+  { "Length", column_length,   0,        COL_RIGHT }
+};
+
+/** @brief Pop-up menu for playlist editor */
+// TODO some of these may not be generic enough yet - check!
+static struct menuitem playlist_menuitems[] = {
+  { "Track properties", ql_properties_activate, ql_properties_sensitive, 0, 0 },
+  { "Play track", ql_play_activate, ql_play_sensitive, 0, 0 },
+  //{ "Play playlist", ql_playall_activate, ql_playall_sensitive, 0, 0 },
+  { "Remove track from queue", ql_remove_activate, ql_remove_sensitive, 0, 0 },
+  { "Select all tracks", ql_selectall_activate, ql_selectall_sensitive, 0, 0 },
+  { "Deselect all tracks", ql_selectnone_activate, ql_selectnone_sensitive, 0, 0 },
+};
+
+/** @brief Queuelike for editing a playlist */
+static struct queuelike ql_playlist = {
+  .name = "playlist",
+  .columns = playlist_columns,
+  .ncolumns = sizeof playlist_columns / sizeof *playlist_columns,
+  .menuitems = playlist_menuitems,
+  .nmenuitems = sizeof playlist_menuitems / sizeof *playlist_menuitems,
+  //.drop = playlist_drop  //TODO
+};
+
+/* Maintaining the list of playlists ---------------------------------------- */
+
 /** @brief Schedule an update to the list of playlists */
 static void playlists_update(const char attribute((unused)) *event,
                              void attribute((unused)) *eventdata,
@@ -83,13 +139,33 @@ static void playlists_updated(void attribute((unused)) *v,
   event_raise("playlists-updated", 0);
 }
 
-/** @brief Called to activate a playlist */
+/* Playlists menu ----------------------------------------------------------- */
+
+/** @brief Play received playlist contents
+ *
+ * Passed as a completion callback by menu_activate_playlist().
+ */
+static void playlist_play_content(void attribute((unused)) *v,
+                                  const char *err,
+                                  int nvec, char **vec) {
+  if(err) {
+    popup_protocol_error(0, err);
+    return;
+  }
+  for(int n = 0; n < nvec; ++n)
+    disorder_eclient_play(client, vec[n], NULL, NULL);
+}
+
+/** @brief Called to activate a playlist
+ *
+ * Called when the menu item for a playlist is clicked.
+ */
 static void menu_activate_playlist(GtkMenuItem *menuitem,
                                    gpointer attribute((unused)) user_data) {
   GtkLabel *label = GTK_LABEL(GTK_BIN(menuitem)->child);
   const char *playlist = gtk_label_get_text(label);
 
-  fprintf(stderr, "activate playlist %s\n", playlist); /* TODO */
+  disorder_eclient_playlist_get(client, playlist_play_content, playlist, NULL);
 }
 
 /** @brief Called when the playlists change */
@@ -100,7 +176,9 @@ static void menu_playlists_changed(const char attribute((unused)) *event,
     return;                             /* OMG too soon */
   GtkMenuShell *menu = GTK_MENU_SHELL(playlists_menu);
   /* TODO: we could be more sophisticated and only insert/remove widgets as
-   * needed.  For now that's too much effort. */
+   * needed.  The current logic trashes the selection which is not acceptable
+   * and interacts badly with one playlist being currently locked and
+   * edited. */
   while(menu->children)
     gtk_container_remove(GTK_CONTAINER(menu), GTK_WIDGET(menu->children->data));
   /* NB nplaylists can be -1 as well as 0 */
@@ -110,16 +188,219 @@ static void menu_playlists_changed(const char attribute((unused)) *event,
     gtk_widget_show(w);
     gtk_menu_shell_append(menu, w);
   }
-  gtk_widget_set_sensitive(playlists_widget,
+  gtk_widget_set_sensitive(menu_playlists_widget,
                            nplaylists > 0);
-  gtk_widget_set_sensitive(editplaylists_widget,
+  gtk_widget_set_sensitive(menu_editplaylists_widget,
                            nplaylists >= 0);
 }
 
- void edit_playlists(gpointer attribute((unused)) callback_data,
+/* Playlists window (list of playlists) ------------------------------------- */
+
+/** @brief (Re-)populate the playlist tree model */
+static void playlists_fill(const char attribute((unused)) *event,
+                           void attribute((unused)) *eventdata,
+                           void attribute((unused)) *callbackdata) {
+  GtkTreeIter iter[1];
+
+  if(!playlists_list)
+    playlists_list = gtk_list_store_new(1, G_TYPE_STRING);
+  gtk_list_store_clear(playlists_list);
+  for(int n = 0; n < nplaylists; ++n)
+    gtk_list_store_insert_with_values(playlists_list, iter, n/*position*/,
+                                      0, playlists[n],        /* column 0 */
+                                      -1);                    /* no more cols */
+  // TODO reselect whatever was formerly selected if possible, if not then
+  // zap the contents view
+}
+
+/** @brief Called when the selection might have changed */
+static void playlists_selection_changed(GtkTreeSelection attribute((unused)) *treeselection,
+                                        gpointer attribute((unused)) user_data) {
+  GtkTreeIter iter;
+  char *gselected, *selected;
+  
+  /* Identify the current selection */
+  if(gtk_tree_selection_get_selected(playlists_selection, 0, &iter)) {
+    gtk_tree_model_get(GTK_TREE_MODEL(playlists_list), &iter,
+                       0, &gselected, -1);
+    selected = xstrdup(gselected);
+    g_free(gselected);
+  } else
+    selected = 0;
+  /* Eliminate no-change cases */
+  if(!selected && !playlists_selected)
+    return;
+  if(selected && playlists_selected && !strcmp(selected, playlists_selected))
+    return;
+  /* There's been a change */
+  playlists_selected = selected;
+  if(playlists_selected) {
+    fprintf(stderr, "playlists selection changed\n'"); /* TODO */
+    gtk_widget_set_sensitive(playlists_delete_button, 1);
+  } else
+    gtk_widget_set_sensitive(playlists_delete_button, 0);
+}
+
+/** @brief Called when the 'add' button is pressed */
+static void playlists_add(GtkButton attribute((unused)) *button,
+                          gpointer attribute((unused)) userdata) {
+  /* Unselect whatever is selected */
+  gtk_tree_selection_unselect_all(playlists_selection);
+  fprintf(stderr, "playlists_add\n");/* TODO */
+  /* We need to pop up a window asking for:
+   * - the name for the playlist
+   * - whether it is to be a public, private or shared playlist
+   * Moreover we should keep track of the known playlists and grey out OK
+   * if the name is a clash (as well as if it's actually invalid).
+   */
+}
+
+/** @brief Called when the 'Delete' button is pressed */
+static void playlists_delete(GtkButton attribute((unused)) *button,
+                             gpointer attribute((unused)) userdata) {
+  GtkWidget *yesno;
+  int res;
+
+  if(!playlists_selected)
+    return;                             /* shouldn't happen */
+  yesno = gtk_message_dialog_new(GTK_WINDOW(playlists_window),
+                                 GTK_DIALOG_MODAL,
+                                 GTK_MESSAGE_QUESTION,
+                                 GTK_BUTTONS_YES_NO,
+                                 "Do you really want to delete playlist %s?"
+                                 " This action cannot be undone.",
+                                 playlists_selected);
+  res = gtk_dialog_run(GTK_DIALOG(yesno));
+  gtk_widget_destroy(yesno);
+  if(res == GTK_RESPONSE_YES) {
+    disorder_eclient_playlist_delete(client,
+                                     NULL/*playlists_delete_completed*/,
+                                     playlists_selected,
+                                     NULL);
+  }
+}
+
+/** @brief Table of buttons below the playlist list */
+static struct button playlists_buttons[] = {
+  {
+    GTK_STOCK_ADD,
+    playlists_add,
+    "Create a new playlist",
+    0
+  },
+  {
+    GTK_STOCK_REMOVE,
+    playlists_delete,
+    "Delete a playlist",
+    0
+  },
+};
+#define NPLAYLISTS_BUTTONS (sizeof playlists_buttons / sizeof *playlists_buttons)
+
+/** @brief Create the list of playlists for the edit playlists window */
+static GtkWidget *playlists_window_list(void) {
+  /* Create the list of playlist and populate it */
+  playlists_fill(NULL, NULL, NULL);
+  /* Create the tree view */
+  GtkWidget *tree = gtk_tree_view_new_with_model(GTK_TREE_MODEL(playlists_list));
+  /* ...and the renderers for it */
+  GtkCellRenderer *cr = gtk_cell_renderer_text_new();
+  GtkTreeViewColumn *col = gtk_tree_view_column_new_with_attributes("Playlist",
+                                                                    cr,
+                                                                    "text", 0,
+                                                                    NULL);
+  gtk_tree_view_append_column(GTK_TREE_VIEW(tree), col);
+  /* Get the selection for the view; set its mode; arrange for a callback when
+   * it changes */
+  playlists_selected = NULL;
+  playlists_selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(tree));
+  gtk_tree_selection_set_mode(playlists_selection, GTK_SELECTION_BROWSE);
+  g_signal_connect(playlists_selection, "changed",
+                   G_CALLBACK(playlists_selection_changed), NULL);
+
+  /* Create the control buttons */
+  GtkWidget *buttons = create_buttons_box(playlists_buttons,
+                                          NPLAYLISTS_BUTTONS,
+                                          gtk_hbox_new(FALSE, 1));
+  playlists_delete_button = playlists_buttons[1].widget;
+
+  /* Buttons live below the list */
+  GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
+  gtk_box_pack_start(GTK_BOX(vbox), scroll_widget(tree), TRUE/*expand*/, TRUE/*fill*/, 0);
+  gtk_box_pack_start(GTK_BOX(vbox), buttons, FALSE/*expand*/, FALSE, 0);
+
+  return vbox;
+}
+
+/* Playlists window (edit current playlist) --------------------------------- */
+
+static GtkWidget *playlists_window_edit(void) {
+  assert(ql_playlist.view == NULL);     /* better not be set up already */
+  GtkWidget *w = init_queuelike(&ql_playlist);
+  return w;
+}
+
+/* Playlists window --------------------------------------------------------- */
+
+/** @brief Keypress handler */
+static gboolean playlists_keypress(GtkWidget attribute((unused)) *widget,
+                                   GdkEventKey *event,
+                                   gpointer attribute((unused)) user_data) {
+  if(event->state)
+    return FALSE;
+  switch(event->keyval) {
+  case GDK_Escape:
+    gtk_widget_destroy(playlists_window);
+    return TRUE;
+  default:
+    return FALSE;
+  }
+}
+
+/** @brief Called when the playlist window is destroyed */
+static void playlists_window_destroyed(GtkWidget attribute((unused)) *widget,
+                                       GtkWidget **widget_pointer) {
+  fprintf(stderr, "playlists_window_destroy\n");
+  destroy_queuelike(&ql_playlist);
+  *widget_pointer = NULL;
+}
+
+/** @brief Pop up the playlists window
+ *
+ * Called when the playlists menu item is selected
+ */
+void edit_playlists(gpointer attribute((unused)) callback_data,
                      guint attribute((unused)) callback_action,
                      GtkWidget attribute((unused)) *menu_item) {
-  fprintf(stderr, "edit playlists\n");  /* TODO */
+  /* If the window already exists, raise it */
+  if(playlists_window) {
+    gtk_window_present(GTK_WINDOW(playlists_window));
+    return;
+  }
+  /* Create the window */
+  playlists_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
+  gtk_widget_set_style(playlists_window, tool_style);
+  g_signal_connect(playlists_window, "destroy",
+                  G_CALLBACK(playlists_window_destroyed), &playlists_window);
+  gtk_window_set_title(GTK_WINDOW(playlists_window), "Playlists Management");
+  /* TODO loads of this is very similar to (copied from!) users.c - can we
+   * de-dupe? */
+  /* Keyboard shortcuts */
+  g_signal_connect(playlists_window, "key-press-event",
+                   G_CALLBACK(playlists_keypress), 0);
+  /* default size is too small */
+  gtk_window_set_default_size(GTK_WINDOW(playlists_window), 240, 240);
+
+  GtkWidget *hbox = gtk_hbox_new(FALSE, 0);
+  gtk_box_pack_start(GTK_BOX(hbox), playlists_window_list(),
+                     FALSE/*expand*/, FALSE, 0);
+  gtk_box_pack_start(GTK_BOX(hbox), gtk_event_box_new(),
+                     FALSE/*expand*/, FALSE, 2);
+  gtk_box_pack_start(GTK_BOX(hbox), playlists_window_edit(),
+                     TRUE/*expand*/, TRUE/*fill*/, 0);
+
+  gtk_container_add(GTK_CONTAINER(playlists_window), frame_widget(hbox, NULL));
+  gtk_widget_show_all(playlists_window);
 }
 
 /** @brief Initialize playlist support */
@@ -137,6 +418,8 @@ void playlists_init(void) {
   playlists_update(0, 0, 0);
 }
 
+#endif
+
 /*
 Local Variables:
 c-basic-offset:2