hooke/ui/gui/panel/playlist.py

   1 # Copyright (C) 2010-2012 W. Trevor King <wking@drexel.edu>
   2 #
   3 # This file is part of Hooke.
   4 #
   5 # Hooke is free software: you can redistribute it and/or modify it under the
   6 # terms of the GNU Lesser General Public License as published by the Free
   7 # Software Foundation, either version 3 of the License, or (at your option) any
   8 # later version.
   9 #
  10 # Hooke is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  13 # details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public License
  16 # along with Hooke.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 """Playlist panel for Hooke.
  19
  20 Provides a nice GUI interface to the
  21 :class:`~hooke.plugin.playlist.PlaylistPlugin`.
  22 """
  23
  24 import logging
  25 import types
  26
  27 import wx
  28
  29 from ....util.callback import callback, in_callback
  30 from . import Panel
  31
  32
  33 class Menu (wx.Menu):
  34     """Popup menu for selecting playlist :class:`Tree` actions.
  35     """
  36     def __init__(self, on_delete, *args, **kwargs):
  37         super(Menu, self).__init__(*args, **kwargs)
  38         self._c = {
  39             'delete': self.Append(id=wx.ID_ANY, text='Delete'),
  40             }
  41         self.Bind(wx.EVT_MENU, on_delete)
  42
  43
  44 class Tree (wx.TreeCtrl):
  45     """:class:`wx.TreeCtrl` subclass handling playlist and curve selection.
  46     """
  47     def __init__(self, *args, **kwargs):
  48         self.log = logging.getLogger('hooke')
  49         self._panel = kwargs['parent']
  50         self._callbacks = self._panel._callbacks # TODO: CallbackClass.set_callback{,s}()
  51         super(Tree, self).__init__(*args, **kwargs)
  52         imglist = wx.ImageList(width=16, height=16, mask=True, initialCount=2)
  53         imglist.Add(wx.ArtProvider.GetBitmap(
  54                 wx.ART_FOLDER, wx.ART_OTHER, wx.Size(16, 16)))
  55         imglist.Add(wx.ArtProvider.GetBitmap(
  56                 wx.ART_NORMAL_FILE, wx.ART_OTHER, wx.Size(16, 16)))
  57         self.AssignImageList(imglist)
  58         self.image = {
  59             'root': 0,
  60             'playlist': 0,
  61             'curve': 1,
  62             }
  63         self._c = {
  64             'menu': Menu(self._on_delete),
  65             'root': self.AddRoot(text='Playlists', image=self.image['root'])
  66             }
  67         self.Bind(wx.EVT_RIGHT_DOWN, self._on_context_menu)
  68         self.Bind(wx.EVT_TREE_SEL_CHANGED, self._on_select)
  69
  70         self._setup_playlists()
  71
  72     def _setup_playlists(self):
  73         self._playlists = {}    # {name: hooke.playlist.Playlist()}
  74
  75         # In both of the following dicts, curve names are
  76         # (playlist.name, curve.name) to avoid cross-playlist
  77         # collisions.  See ._is_curve().
  78         self._id_for_name = {}  # {name: id}
  79         self._name_for_id = {}  # {id: name}
  80
  81     def _is_curve(self, name):  # name from ._id_for_name / ._name_for_id
  82         """Return `True` if `name` corresponds to a :class:`hooke.curve.Curve`.
  83         """
  84         # Playlist names are strings, Curve names are tuples.
  85         # See ._setup_playlists().
  86         return not isinstance(name, types.StringTypes)
  87
  88     def _canonical_id(self, _id):
  89         """Return a canonical form of `_id` suitable for accessing `._name_for_id`.
  90
  91         For some reason, `.GetSelection()`, etc. return items that
  92         hash differently than the original `.AppendItem()`-returned
  93         IDs.  This means that `._name_for_id[self.GetSelection()]`
  94         will raise `KeyError`, even if there is an id `X` in
  95         `._name_for_id` for which `X == self.GetSelection()` will
  96         return `True`.  This method "canonicalizes" IDs so that the
  97         hashing is consistent.
  98         """
  99         for c_id in self._name_for_id.keys():
 100             if c_id == _id:
 101                 return c_id
 102         raise KeyError(_id)
 103
 104
 105     # Context menu
 106
 107     def _on_context_menu(self, event):
 108         """Launch a popup :class:`Menu` with per-playlist/curve activities.
 109         """
 110         hit_id,hit_flags = self.HitTest(event.GetPosition())
 111         if (hit_flags & wx.TREE_HITTEST_ONITEM) != 0:
 112             self._hit_id = self._canonical_id(hit_id)  # store for callbacks
 113             menu = Menu(self._on_delete)
 114             self.PopupMenu(menu, event.GetPosition())
 115             menu.Destroy()
 116
 117     # Add
 118     #   add_* called directly by HookeFrame
 119     #   _add_* called on every addition
 120
 121     def add_playlist(self, playlist):
 122         """Add a :class:`hooke.playlist.Playlist` to the tree.
 123
 124         Calls :meth:`_add_playlist` and triggers a callback.
 125         """
 126         self._add_playlist(playlist)
 127         in_callback(self, playlist)
 128
 129     def _add_playlist(self, playlist):
 130         """Add a class:`hooke.playlist.Playlist` to the tree.
 131
 132         No callback triggered.
 133         """
 134         if playlist.name not in self._playlists:
 135             pass
 136         else:
 137             raise ValueError('duplicate playlist: %s' % playlist.name)
 138         self._playlists[playlist.name] = playlist
 139         p_id = self.AppendItem(
 140             parent=self._c['root'],
 141             text=self._panel._hooke_frame._file_name(playlist.name),
 142             image=self.image['playlist'])
 143         self._id_for_name[playlist.name] = p_id
 144         self._name_for_id[p_id] = playlist.name
 145         for curve in playlist:
 146             self._add_curve(playlist.name, curve)
 147
 148     def add_curve(self, playlist_name, curve):
 149         """Add a :class:`hooke.curve.Curve` to a curently loaded playlist.
 150
 151         Calls :meth:`_add_curve` and triggers a callback.
 152         """
 153         self._add_curve(playlist_name, curve)
 154         playlist = self._playlists[playlist_name]
 155         in_callback(self, playlist, curve)
 156
 157     def _add_curve(self, playlist_name, curve):
 158         """Add a class:`hooke.curve.Curve` to the tree.
 159
 160         No callback triggered.
 161         """
 162         p = self._playlists[playlist_name]
 163         if curve not in p:
 164             p.append(curve)
 165         c_id = self.AppendItem(
 166             parent=self._id_for_name[playlist_name],
 167             text=self._panel._hooke_frame._file_name(curve.name),
 168             image=self.image['curve'])
 169         self._id_for_name[(p.name, curve.name)] = c_id
 170         self._name_for_id[c_id] = (p.name, curve.name)
 171
 172     @callback
 173     def generate_new_playlist(self):
 174         pass  # TODO
 175
 176     def _GetUniquePlaylistName(self, name):  # TODO
 177         playlist_name = name
 178         count = 1
 179         while playlist_name in self.playlists:
 180             playlist_name = ''.join([name, str(count)])
 181             count += 1
 182         return playlist_name
 183
 184     # Delete
 185     #   delete_* called by _on_delete handler (user click) or HookeFrame
 186     #   _delete_* called on every deletion
 187
 188     def _on_delete(self, event):
 189         """Handler for :class:`Menu`'s `Delete` button.
 190
 191         Determines the clicked item and calls the appropriate
 192         `.delete_*()` method on it.
 193         """
 194         #if hasattr(self, '_hit_id'):  # called via ._c['menu']
 195         _id = self._hit_id
 196         del(self._hit_id)
 197         name = self._name_for_id[_id]
 198         if self._is_curve(name):
 199             self.delete_curve(playlist_name=name[0], name=name[1])
 200         else:
 201             self.delete_playlist(name)
 202
 203     def delete_playlist(self, name):
 204         """Delete a :class:`hooke.playlist.Playlist` by name.
 205
 206         Called by the :meth:`_on_delete` handler.
 207
 208         Removes the playlist and its curves from the tree, then calls
 209         :meth:`_delete_playlist`.
 210         """
 211         _id = self._id_for_name[name]
 212         self.Delete(_id)
 213         playlist = self._playlists[name]
 214         self._delete_playlist(playlist)
 215         in_callback(self, playlist)
 216
 217     def _delete_playlist(self, playlist):
 218         """Adjust name/id caches for the playlist and its curves.
 219
 220         Called on *every* playlist deletion.
 221         """
 222         self._playlists.pop(playlist.name)
 223         _id = self._id_for_name.pop(playlist.name)
 224         del(self._name_for_id[_id])
 225         for curve in playlist:
 226             self._delete_curve(playlist, curve)
 227         in_callback(self, playlist)
 228
 229     def delete_curve(self, playlist_name, name):
 230         """Delete a :class:`hooke.curve.Curve` by name.
 231
 232         Called by the :meth:`_on_delete` handler.
 233
 234         Removes the curve from the tree, then calls
 235         :meth:`_delete_curve`.
 236         """
 237         _id = self._id_for_name[(playlist_name, name)]
 238         self.Delete(_id)
 239         playlist = self._playlists[playlist_name]
 240         curve = None
 241         for i,c in enumerate(playlist):
 242             if c.name == name:
 243                 curve = c
 244                 break
 245         if curve is None:
 246             raise ValueError(name)
 247         self._delete_curve(playlist=playlist, curve=curve)
 248         in_callback(self, playlist, curve)
 249
 250     def _delete_curve(self, playlist, curve):
 251         """Adjust name/id caches.
 252
 253         Called on _every_ curve deletion.
 254         """
 255         _id = self._id_for_name.pop((playlist.name, curve.name))
 256         del(self._name_for_id[_id])
 257         in_callback(self, playlist=playlist, curve=curve)
 258
 259     # Get selection
 260
 261     def get_selected_playlist(self):
 262         """Return the selected :class:`hooke.playlist.Playlist`.
 263         """
 264         _id = self.GetSelection()
 265         try:
 266             _id = self._canonical_id(_id)
 267         except KeyError:  # no playlist selected
 268             return None
 269         name = self._name_for_id[_id]
 270         if self._is_curve(name):
 271             name = name[0]
 272         return self._playlists[name]
 273
 274     def get_selected_curve(self):
 275         """Return the selected :class:`hooke.curve.Curve`.
 276         """
 277         _id = self.GetSelection()
 278         name = self._name_for_id[self._canonical_id(_id)]
 279         if self._is_curve(name):
 280             p_name,c_name = name
 281             playlist = self._playlists[p_name]
 282             c = playlist.current()
 283             assert c.name == c_name, '%s != %s' % (c.name, c_name)
 284         else:
 285             playlist = self._playlists[name]
 286         return playlist.current()
 287
 288     # Set selection (via user interaction with this panel)
 289     #
 290     # These are hooks for HookeFrame callbacks which will send
 291     # the results back via 'get curve' calling 'set_selected_curve'.
 292
 293     def _on_select(self, event):
 294         """Select the clicked-on curve/playlist.
 295         """
 296         _id = self.GetSelection()
 297         name = self._name_for_id[self._canonical_id(_id)]
 298         if self._is_curve(name):
 299             p_name,c_name = name
 300             self._on_set_selected_curve(p_name, c_name)
 301         else:
 302             self._on_set_selected_playlist(name)
 303
 304     def _on_set_selected_playlist(self, name):
 305         self.log.debug('playlist tree selecting playlist %s' % name)
 306         in_callback(self, self._playlists[name])
 307
 308     def _on_set_selected_curve(self, playlist_name, name):
 309         self.log.debug('playlist tree selecting curve %s in %s'
 310                        % (name, playlist_name))
 311         playlist = self._playlists[playlist_name]
 312         curve = None
 313         for i,c in enumerate(playlist):
 314             if c.name == name:
 315                 curve = c
 316                 break
 317         if curve == None:
 318             raise ValueError(name)
 319         in_callback(self, playlist, curve)
 320
 321     # Set selection (from the HookeFrame)
 322
 323     def set_selected_curve(self, playlist, curve):
 324         """Make the curve the playlist's current curve.
 325         """
 326         self.log.debug('playlist tree expanding %s' % playlist.name)
 327         self.Expand(self._id_for_name[playlist.name])
 328         self.Unbind(wx.EVT_TREE_SEL_CHANGED)
 329         self.log.debug('playlist tree selecting %s' % curve.name)
 330         self.SelectItem(self._id_for_name[(playlist.name, curve.name)])
 331         self.Bind(wx.EVT_TREE_SEL_CHANGED, self._on_select)
 332
 333     def update_playlist(self, playlist):
 334         """Absorb changed `.index()`, etc.
 335         """
 336         self._playlists[playlist.name] = playlist
 337         cnames = []
 338         for curve in playlist:
 339             if (playlist.name, curve.name) not in self._id_for_name:
 340                 self._add_curve(playlist.name, curve)
 341             cnames.append(curve.name)
 342         dc = self._callbacks['delete_curve']
 343         _dc = self._callbacks['_delete_curve']
 344         self._callbacks['delete_curve'] = None
 345         self._callbacks['_delete_curve'] = None
 346         for name in self._id_for_name.keys():
 347             if not self._is_curve(name):
 348                 continue
 349             pname,cname = name
 350             if pname != playlist.name:
 351                 continue
 352             if cname not in cnames:
 353                 self.delete_curve(playlist.name, cname)
 354         self._callbacks['delete_curve'] = dc
 355         self._callbacks['_delete_curve'] = _dc
 356
 357     def is_playlist_loaded(self, playlist):
 358         """Return `True` if `playlist` is loaded, `False` otherwise.
 359         """
 360         return self.is_playlist_name_loaded(playlist.name)
 361
 362     def is_playlist_name_loaded(self, name):
 363         """Return `True` if a playlist named `name` is loaded, `False`
 364         otherwise.
 365         """
 366         return name in self._playlists
 367
 368
 369 class Playlist (Panel, wx.Panel):
 370     """:class:`wx.Panel` subclass wrapper for :class:`Tree`.
 371     """
 372     def __init__(self, callbacks=None, **kwargs):
 373         # Use the WANTS_CHARS style so the panel doesn't eat the Return key.
 374         super(Playlist, self).__init__(
 375             name='playlist', callbacks=callbacks, **kwargs)
 376         self._c = {
 377             'tree': Tree(
 378                 parent=self,
 379                 size=wx.Size(160, 250),
 380                 style=wx.TR_DEFAULT_STYLE | wx.NO_BORDER | wx.TR_HIDE_ROOT),
 381             }
 382
 383         sizer = wx.BoxSizer(wx.VERTICAL)
 384         sizer.Add(self._c['tree'], 1, wx.EXPAND)
 385         self.SetSizer(sizer)
 386         sizer.Fit(self)
 387
 388         # Expose all Tree's public curve/playlist methods directly.
 389         # Following DRY and the LoD.
 390         for attribute_name in dir(self._c['tree']):
 391             if (attribute_name.startswith('_')
 392                 or ('playlist' not in attribute_name
 393                     and 'curve' not in attribute_name)):
 394                 continue  # not an attribute we're interested in
 395             attr = getattr(self._c['tree'], attribute_name)
 396             if hasattr(attr, '__call__'):  # attr is a function / method
 397                 setattr(self, attribute_name, attr)  # expose it