[beast: 17/26] BSE: add SuperSeq and migrate Project.get_supers() into bseapi.idl

[Tim Janik <timj src gnome org>]

commit 02950237d9f949e1e2b6875123e891a7beded4a3
Author: Tim Janik <timj gnu org>
Date:   Tue May 31 13:41:16 2016 +0200

    BSE: add SuperSeq and migrate Project.get_supers() into bseapi.idl
    
    Signed-off-by: Tim Janik <timj gnu org>

 beast-gtk/bstapp.cc |  111 ++++++++++++++++++++++++--------------------------
 bse/bseapi.idl      |    7 +++-
 bse/bseproject.cc   |   13 ++++++
 bse/bseproject.hh   |    1 +
 bse/bseproject.proc |   29 -------------
 5 files changed, 73 insertions(+), 88 deletions(-)
---
diff --git a/beast-gtk/bstapp.cc b/beast-gtk/bstapp.cc
index b3ed95a..32ddb1e 100644
--- a/beast-gtk/bstapp.cc
+++ b/beast-gtk/bstapp.cc
@@ -13,6 +13,7 @@
 #include "bstprofiler.hh"
 #include "bstusermessage.hh"
 #include <string.h>
+#include <algorithm>
 
 
 /* --- prototypes --- */
@@ -439,20 +440,6 @@ bst_app_get_current_super (BstApp *app)
   return 0;
 }
 
-static gint
-proxy_rate_item (SfiProxy p)
-{
-  if (BSE_IS_WAVE_REPO (p))
-    return 1;
-  else if (BSE_IS_SONG (p))
-    return 2;
-  else if (BSE_IS_MIDI_SYNTH (p))
-    return 4;
-  else if (BSE_IS_CSYNTH (p))
-    return 3;
-  return 5;
-}
-
 static void
 app_update_page_item (SfiProxy     item,
                       const gchar *property_name,
@@ -523,16 +510,24 @@ bst_app_add_page_item (BstApp  *self,
   g_free (tip);
 }
 
-static gint
-proxyp_cmp_items (gconstpointer v1,
-                  gconstpointer v2,
-                  gpointer      data)
+static int
+proxy_rate_item (SfiProxy p)
 {
-  const SfiProxy *p1 = (const SfiProxy*) v1;
-  const SfiProxy *p2 = (const SfiProxy*) v2;
-  if (*p1 == *p2)
-    return 0;
-  return proxy_rate_item (*p1) - proxy_rate_item (*p2);
+  if (BSE_IS_WAVE_REPO (p))
+    return 1;
+  else if (BSE_IS_SONG (p))
+    return 2;
+  else if (BSE_IS_MIDI_SYNTH (p))
+    return 4;
+  else if (BSE_IS_CSYNTH (p))
+    return 3;
+  return 5;
+}
+
+static bool
+super_rating_lesser (Bse::SuperH &a, Bse::SuperH &b)
+{
+  return proxy_rate_item (a.proxy_id()) < proxy_rate_item (b.proxy_id());
 }
 
 static void
@@ -543,31 +538,30 @@ bst_app_reload_pages (BstApp *self)
   GtkWidget *old_focus = GTK_WINDOW (self)->focus_widget;
   if (old_focus)
     gtk_widget_ref (old_focus);
-  SfiProxy old_item = self->ppages->selected ? (SfiProxy) self->ppages->selected->user_data : 0;
-
-  /* collect page objects */
-  BseIt3mSeq *iseq = bse_project_get_supers (self->project.proxy_id());
-  SfiRing *ring, *proxies = NULL;
-  guint i;
-  for (i = 0; i < iseq->n_items; i++)
-    if (!bse_item_internal (iseq->items[i]) || BST_DBG_EXT)
-      proxies = sfi_ring_append (proxies, iseq->items + i);
-  /* sort proxies */
-  proxies = sfi_ring_sort (proxies, proxyp_cmp_items, NULL);
-
-  /* remove outdated project pages */
+  SfiProxy old_super = self->ppages->selected ? (SfiProxy) self->ppages->selected->user_data : 0;
+
+  // collect Super objects that need their own view
+  Bse::SuperSeq sseq = self->project.get_supers();
+  // sort out internal objects
+  for (Bse::SuperSeq::iterator it = sseq.begin(); it != sseq.end();)
+    if (!BST_DBG_EXT && bse_item_internal (it->proxy_id()))
+      it = sseq.erase (it);
+    else
+      ++it;
+  // sort Super objects according to UI display preference
+  std::sort (sseq.begin(), sseq.end(), super_rating_lesser);
+
+  // remove views for pruned Super objects
   SfiRing *outdated = NULL;
-  GSList *slist;
-  for (slist = self->ppages->entries; slist; slist = slist->next)
+  for (GSList *slist = self->ppages->entries; slist; slist = slist->next)
     {
       GxkAssortmentEntry *entry = (GxkAssortmentEntry*) slist->data;
-      for (ring = proxies; ring; ring = sfi_ring_next (ring, proxies))
-        {
-          SfiProxy *pp = (SfiProxy*) ring->data, item = *pp;
-          if (item == (SfiProxy) entry->user_data)
-            break;
-        }
-      if (!ring)
+      const SfiProxy view_proxy = (SfiProxy) entry->user_data;
+      Bse::SuperH super;
+      for (auto &candidate : sseq)
+        if (candidate.proxy_id() == view_proxy)
+          super = candidate;
+      if (!super)
         outdated = sfi_ring_append (outdated, entry);
     }
   while (outdated)
@@ -576,31 +570,32 @@ bst_app_reload_pages (BstApp *self)
       gxk_assortment_remove (self->ppages, entry);
     }
 
-  /* add missing project pages */
+  // create views for new Super objects
   SfiProxy first_unseen = 0, first_synth = 0;
-  i = 0;
-  for (ring = proxies; ring; ring = sfi_ring_next (ring, proxies), i++)
+  size_t pos = 0;
+  for (auto &super : sseq)
     {
-      SfiProxy *pp = (SfiProxy*) ring->data, item = *pp;
-      if (!gxk_assortment_find_data (self->ppages, (void*) item))
+      SfiProxy view_proxy = super.proxy_id();
+      if (!gxk_assortment_find_data (self->ppages, (void*) view_proxy))
         {
-          bst_app_add_page_item (self, i, item);
+          bst_app_add_page_item (self, pos, view_proxy);
           if (!first_unseen)
-            first_unseen = item;
+            first_unseen = view_proxy;
         }
-      if (!first_synth && BSE_IS_SNET (item))
-        first_synth = item;
+      if (!first_synth && BSE_IS_SNET (view_proxy))
+        first_synth = view_proxy;
+      pos++;
     }
 
-  /* select/restore current page */
+  // re-select current page
   if (first_unseen && self->select_unseen_super)
     gxk_assortment_select_data (self->ppages, (void*) first_unseen);
-  else if (old_item && gxk_assortment_find_data (self->ppages, (void*) old_item))
-    gxk_assortment_select_data (self->ppages, (void*) old_item);
+  else if (old_super && gxk_assortment_find_data (self->ppages, (void*) old_super))
+    gxk_assortment_select_data (self->ppages, (void*) old_super);
   else if (first_synth)
     gxk_assortment_select_data (self->ppages, (void*) first_synth);
   self->select_unseen_super = FALSE;
-  /* restore focus */
+  // restore focus
   if (old_focus)
     {
       if (gxk_widget_ancestry_viewable (old_focus) &&
diff --git a/bse/bseapi.idl b/bse/bseapi.idl
index 47a2cbf..68edcc6 100644
--- a/bse/bseapi.idl
+++ b/bse/bseapi.idl
@@ -627,6 +627,11 @@ interface Container : Source {
 interface Super : Container {
 };
 
+/// A list of Super type objects.
+sequence SuperSeq {
+  Super supers;
+};
+
 /// Base interface type for all kinds of synthesis networks.
 interface SNet : Super {
   bool        supports_user_synths ();                ///< Check whether users may edit synthesis modules of 
this network.
@@ -844,7 +849,7 @@ interface Project : Container {
   void         clear_undo          (); ///< Delete all recorded undo or redo steps.
   void         clean_dirty         (); ///< Clear a project's dirty flags.
   bool         is_dirty            (); ///< Check whether a project needs saving.
-  //ItemSeq      get_supers          (); ///< Retrieve all Super type objects of this project.
+  SuperSeq     get_supers          (); ///< Retrieve all Super type objects of this project.
   //Error        store_bse           (Super super, String file_name, bool self_contained);
   //Song         create_song         (String name); ///< Create a song for this project.
   //WaveRepo     get_wave_repo       ();            ///< Retrieve the project's unique wave repository.
diff --git a/bse/bseproject.cc b/bse/bseproject.cc
index 9b0f329..b102bbe 100644
--- a/bse/bseproject.cc
+++ b/bse/bseproject.cc
@@ -1178,4 +1178,17 @@ ProjectImpl::get_state ()
   return self->state;
 }
 
+SuperSeq
+ProjectImpl::get_supers ()
+{
+  BseProject *self = as<BseProject*>();
+  SuperSeq sseq;
+  for (GSList *slist = self->supers; slist; slist = slist->next)
+    {
+      BseItem *bseitem = (BseItem*) slist->data;
+      sseq.push_back (bseitem->as<SuperIfaceP>());
+    }
+  return sseq;
+}
+
 } // Bse
diff --git a/bse/bseproject.hh b/bse/bseproject.hh
index 2a399ad..1147b1c 100644
--- a/bse/bseproject.hh
+++ b/bse/bseproject.hh
@@ -97,6 +97,7 @@ public:
   virtual Error              import_midi_file    (const String &file_name) override;
   virtual Error              restore_from_file   (const String &file_name) override;
   virtual ProjectState       get_state           () override;
+  virtual SuperSeq           get_supers          () override;
 };
 
 } // Bse
diff --git a/bse/bseproject.proc b/bse/bseproject.proc
index aa17632..4e00b72 100644
--- a/bse/bseproject.proc
+++ b/bse/bseproject.proc
@@ -257,32 +257,3 @@ METHOD (BseProject, remove-snet) {
 
   return Bse::Error::NONE;
 }
-
-METHOD (BseProject, get-supers) {
-  HELP  = "Retrieve all supers of this project.";
-  IN    = bse_param_spec_object ("project", NULL, NULL,
-                                 BSE_TYPE_PROJECT, SFI_PARAM_STANDARD);
-  OUT   = bse_param_spec_boxed ("super_list", NULL, NULL, BSE_TYPE_IT3M_SEQ, SFI_PARAM_STANDARD);
-} BODY (BseProcedureClass *proc,
-        const GValue      *in_values,
-        GValue            *out_values)
-{
-  /* extract parameter values */
-  BseProject *project = (BseProject*) bse_value_get_object (in_values++);
-  BseIt3mSeq *iseq;
-  GSList *slist;
-
-  /* check parameters */
-  if (!BSE_IS_PROJECT (project))
-    return Bse::Error::PROC_PARAM_INVAL;
-
-  /* action */
-  iseq = bse_it3m_seq_new ();
-  for (slist = project->supers; slist; slist = slist->next)
-    bse_it3m_seq_append (iseq, (BseItem*) slist->data);
-
-  /* set output parameters */
-  bse_value_take_boxed (out_values++, iseq);
-
-  return Bse::Error::NONE;
-}