Start rewriting Disobedience choose tab using native tree. Much

[disorder] / disobedience / choose.c

/*
 * This file is part of DisOrder
 * Copyright (C) 2008 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
 * the Free Software Foundation; either version 2 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.
 *
 * 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
 */
/** @file disobedience/choose.c
 * @brief Hierarchical track selection and search
 *
 * We now use an ordinary GtkTreeStore/GtkTreeView.
 *
 * We have an extra column with per-row data.  This isn't referenced from
 * anywhere the GC can see so explicit memory management is required.
 * (TODO perhaps we could fix this using a gobject?)
 *
 * We don't want to pull the entire tree in memory, but we want directories to
 * show up as having children.  Therefore we give directories a placeholder
 * child and replace their children when they are opened.  Placeholders have a
 * null choosedata pointer.
 *
 * TODO We do a period sweep which kills contracted nodes, putting back
 * placeholders, and updating expanded nodes to keep up with server-side
 * changes.  (We could trigger the latter off rescan complete notifications?)
 * 
 * TODO:
 * - sweep up contracted nodes
 * - update when content may have changed (e.g. after a rescan)
 * - popup menu
 * - playing state
 * - display length of tracks
 */

#include "disobedience.h"

/** @brief Extra data at each node */
struct choosedata {
  /** @brief Node type */
  int type;

  /** @brief Full track or directory name */
  gchar *track;

  /** @brief Sort key */
  gchar *sort;
};

/** @brief Track name column number */
#define NAME_COLUMN 0

/** @brief Hidden column number */
#define CHOOSEDATA_COLUMN 1

/** @brief @ref choosedata node is a file */
#define CHOOSE_FILE 0

/** @brief @ref choosedata node is a directory */
#define CHOOSE_DIRECTORY 1

/** @brief The current selection tree */
static GtkTreeStore *choose_store;

/** @brief The view onto the selection tree */
static GtkWidget *choose_view;

/** @brief The selection tree's selection */
static GtkTreeSelection *choose_selection;

/** @brief Popup menu */
//static GtkWidget *choose_menu;

/** @brief Map choosedata types to names */
static const char *const choose_type_map[] = { "track", "dir" };

/** @brief Return the choosedata given an interator */
static struct choosedata *choose_iter_to_data(GtkTreeIter *iter) {
  GValue v[1];
  memset(v, 0, sizeof v);
  gtk_tree_model_get_value(GTK_TREE_MODEL(choose_store), iter, CHOOSEDATA_COLUMN, v);
  assert(G_VALUE_TYPE(v) == G_TYPE_POINTER);
  struct choosedata *const cd = g_value_get_pointer(v);
  g_value_unset(v);
  return cd;
}

/** @brief Remove node @p it and all its children
 * @param Iterator, updated to point to next
 * @return True if iterator remains valid
 */
static gboolean choose_remove_node(GtkTreeIter *it) {
  GtkTreeIter child[1];
  gboolean childv = gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store),
                                                 child,
                                                 it);
  while(childv)
    childv = choose_remove_node(child);
  struct choosedata *cd = choose_iter_to_data(it);
  if(cd) {
    g_free(cd->track);
    g_free(cd->sort);
    g_free(cd);
  }
  return gtk_tree_store_remove(choose_store, it);
}

/** @brief (Re-)populate a node
 * @param parent_ref Node to populate or NULL to fill root
 * @param nvec Number of children to add
 * @param vec Children
 * @param dirs True if children are directories
 *
 * Adjusts the set of files (or directories) below @p parent_ref to match those
 * listed in @p nvec and @p vec.
 *
 * @parent_ref will be destroyed.
 */
static void choose_populate(GtkTreeRowReference *parent_ref,
                            int nvec, char **vec,
                            int type) {
  /* Compute parent_* */
  GtkTreeIter pit[1], *parent_it;
  GtkTreePath *parent_path;
  if(parent_ref) {
    parent_path = gtk_tree_row_reference_get_path(parent_ref);
    parent_it = pit;
    gboolean pitv = gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store),
                                            pit, parent_path);
    assert(pitv);
    /*fprintf(stderr, "choose_populate %s: parent path is [%s]\n",
            choose_type_map[type],
            gtk_tree_path_to_string(parent_path));*/
  } else {
    parent_path = 0;
    parent_it = 0;
    /*fprintf(stderr, "choose_populate %s: populating the root\n",
            choose_type_map[type]);*/
  }
  /* Remove unwanted nodes and find out which we must add */
  //fprintf(stderr, " trimming unwanted %s nodes\n", choose_type_map[type]);
  char *found = xmalloc(nvec);
  GtkTreeIter it[1];
  gboolean itv = gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store),
                                              it,
                                              parent_it);
  while(itv) {
    struct choosedata *cd = choose_iter_to_data(it);
    int keep;

    if(!cd)  {
      /* Always kill placeholders */
      //fprintf(stderr, "  kill a placeholder\n");
      keep = 0;
    } else if(cd->type == type) {
      /* This is the type we care about */
      //fprintf(stderr, "  %s is a %s\n", cd->track, choose_type_map[cd->type]);
      int n;
      for(n = 0; n < nvec && strcmp(vec[n], cd->track); ++n)
        ;
      if(n < nvec) {
        //fprintf(stderr, "   ... and survives\n");
        found[n] = 1;
        keep = 1;
      } else {
        //fprintf(stderr, "   ... and is to be removed\n");
        keep = 0;
      }
    } else {
      /* Keep wrong-type entries */
      //fprintf(stderr, "  %s is a %s\n", cd->track, choose_type_map[cd->type]);
      keep = 1;
    }
    if(keep)
      itv = gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store), it);
    else
      itv = choose_remove_node(it);
  }
  /* Add nodes we don't have */
  int inserted = 0;
  //fprintf(stderr, " inserting new %s nodes\n", choose_type_map[type]);
  for(int n = 0; n < nvec; ++n) {
    if(!found[n]) {
      //fprintf(stderr, "  %s was not found\n", vec[n]);
      struct choosedata *cd = g_malloc0(sizeof *cd);
      cd->type = type;
      cd->track = g_strdup(vec[n]);
      cd->sort = g_strdup(trackname_transform(choose_type_map[type],
                                              vec[n],
                                              "sort"));
      gtk_tree_store_append(choose_store, it, parent_it);
      gtk_tree_store_set(choose_store, it,
                         NAME_COLUMN, trackname_transform(choose_type_map[type],
                                                          vec[n],
                                                          "display"),
                         CHOOSEDATA_COLUMN, cd,
                         -1);
      ++inserted;
      /* If we inserted a directory, insert a placeholder too, so it appears to
       * have children; it will be deleted when we expand the directory. */
      if(type == CHOOSE_DIRECTORY) {
        //fprintf(stderr, "  inserting a placeholder\n");
        GtkTreeIter placeholder[1];

        gtk_tree_store_append(choose_store, placeholder, it);
        gtk_tree_store_set(choose_store, placeholder,
                           NAME_COLUMN, "Waddling...",
                           CHOOSEDATA_COLUMN, (void *)0,
                           -1);
      }
    }
  }
  //fprintf(stderr, " %d nodes inserted\n", inserted);
  if(inserted) {
    /* TODO sort the children */
  }
  if(parent_ref) {
    /* If we deleted a placeholder then we must re-expand the row */
    gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view), parent_path, FALSE);
    gtk_tree_row_reference_free(parent_ref);
    gtk_tree_path_free(parent_path);
  }
}

static void choose_dirs_completed(void *v,
                                  const char *error,
                                  int nvec, char **vec) {
  if(error) {
    popup_protocol_error(0, error);
    return;
  }
  choose_populate(v, nvec, vec, CHOOSE_DIRECTORY);
}

static void choose_files_completed(void *v,
                                   const char *error,
                                   int nvec, char **vec) {
  if(error) {
    popup_protocol_error(0, error);
    return;
  }
  choose_populate(v, nvec, vec, CHOOSE_FILE);
}

static void choose_row_expanded(GtkTreeView attribute((unused)) *treeview,
                                GtkTreeIter *iter,
                                GtkTreePath *path,
                                gpointer attribute((unused)) user_data) {
  /*fprintf(stderr, "row-expanded path=[%s]\n",
          gtk_tree_path_to_string(path));*/
  /* We update a node's contents whenever it is expanded, even if it was
   * already populated; the effect is that contracting and expanding a node
   * suffices to update it to the latest state on the server. */
  struct choosedata *cd = choose_iter_to_data(iter);
  disorder_eclient_files(client, choose_files_completed,
                         xstrdup(cd->track),
                         NULL,
                         gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store),
                                                    path));
  disorder_eclient_dirs(client, choose_dirs_completed,
                        xstrdup(cd->track),
                        NULL,
                        gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store),
                                                   path));
  /* The row references are destroyed in the _completed handlers. */
}

static int choose_tab_selectall_sensitive(void attribute((unused)) *extra) {
  return TRUE;
}
  
static void choose_tab_selectall_activate(void attribute((unused)) *extra) {
  gtk_tree_selection_select_all(choose_selection);
}
  
static int choose_tab_selectnone_sensitive(void attribute((unused)) *extra) {
  return gtk_tree_selection_count_selected_rows(choose_selection) > 0;
}
  
static void choose_tab_selectnone_activate(void attribute((unused)) *extra) {
  gtk_tree_selection_unselect_all(choose_selection);
}
  
static int choose_tab_properties_sensitive(void attribute((unused)) *extra) {
  return TRUE;
}
  
static void choose_tab_properties_activate(void attribute((unused)) *extra) {
  fprintf(stderr, "TODO choose_tab_properties_activate\n");
}

static const struct tabtype choose_tabtype = {
  choose_tab_properties_sensitive,
  choose_tab_selectall_sensitive,
  choose_tab_selectnone_sensitive,
  choose_tab_properties_activate,
  choose_tab_selectall_activate,
  choose_tab_selectnone_activate,
  0,
  0
};

/** @brief Create the choose tab */
GtkWidget *choose_widget(void) {
  /* Create the tree store. */
  choose_store = gtk_tree_store_new(1 + CHOOSEDATA_COLUMN,
                                    G_TYPE_STRING,
                                    G_TYPE_POINTER);

  /* Create the view */
  choose_view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(choose_store));

  /* Create cell renderers and columns */
  GtkCellRenderer *r = gtk_cell_renderer_text_new();
  GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
    ("Track",
     r,
     "text", 0,
     (char *)0);
  gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
  
  /* The selection should support multiple things being selected */
  choose_selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(choose_view));
  gtk_tree_selection_set_mode(choose_selection, GTK_SELECTION_MULTIPLE);

  /* Catch button presses */
  /*g_signal_connect(choose_view, "button-press-event",
    G_CALLBACK(choose_button_release), 0);*/
  /* Catch row expansions so we can fill in placeholders */
  g_signal_connect(choose_view, "row-expanded",
                   G_CALLBACK(choose_row_expanded), 0);
  
  /* Fill the root */
  disorder_eclient_files(client, choose_files_completed, "", NULL, NULL); 
  disorder_eclient_dirs(client, choose_dirs_completed, "", NULL, NULL); 
  
  /* Make the widget scrollable */
  GtkWidget *scrolled = scroll_widget(choose_view);
  g_object_set_data(G_OBJECT(scrolled), "type", (void *)&choose_tabtype);
  return scrolled;
}

/*
Local Variables:
c-basic-offset:2
comment-column:40
fill-column:79
indent-tabs-mode:nil
End:
*/