src/app/eventutils.py

   1 # -*- coding: utf-8 -*-
   2 """
   3 Décorateur, métaclasse et classe mixin pour faciliter
   4 l'implémentation des gestionnaires d'événements pygame.
   5
   6 Utilisation :
   7 - hériter de EventHandlerMixin
   8 - décorer les méthodes gestionnaires d'événements avec le décorateur 'event_handler'
   9   en passant en paramètre un ou plusieurs codes d'événement pygame
  10
  11 Il n'existe aucune contrainte sur le nommage de la méthode décorée.
  12 La méthode gestionnaire d'événement reçoit l'événement pygame comme unique paramètre.
  13
  14 par exemple :
  15
  16 import pygame
  17 class Machin(pygame.sprite.Sprite, EventHandlerMixin) :
  18
  19     # .../...
  20
  21     @event_handler(pygame.KEYDOWN)
  22     def handleKeyDown(self, event) :
  23         pass
  24
  25
  26 $Id$
  27 $URL$
  28 """
  29 import types
  30 import pygame
  31 from StringIO import StringIO
  32 from log import console, eventLogger
  33
  34 class _EventDispatcher :
  35     def __init__(self) :
  36         self.registry = {}
  37
  38     def addEventListener(self, eventType, listener) :
  39         if self.registry.has_key(eventType) :
  40             self.registry[eventType][listener] = True
  41         else :
  42             self.registry[eventType] = {listener:True}
  43
  44     def removeEventListener(self, eventType, listener) :
  45         try :
  46             del self.registry[eventType][listener]
  47         except KeyError :
  48             console.debug("no listener to remove")
  49
  50     def dispatchEvents(self) :
  51         events = pygame.event.get()
  52         for event in events :
  53             eventLogger.info(event)
  54             listeners = self.registry.get(event.type, {})
  55             for listener in listeners.keys() :
  56                 listener(event)
  57
  58     def reset(self) :
  59         self.registry = {}
  60
  61     def __repr__(self) :
  62         out = StringIO()
  63         keys = self.registry.keys()
  64         keys.sort()
  65         for k in keys :
  66             print >> out, "event", k
  67             for listener in self.registry[k].keys() :
  68                 print >> out, listener.__name__
  69         out.seek(0)
  70         return out.read()
  71
  72
  73 EventDispatcher = _EventDispatcher()
  74
  75 def event_handler(*eventTypes) :
  76     def markFunctionAsListener(m) :
  77         m.__islistener__ = True
  78         m.__eventtypes__ = eventTypes
  79         return m
  80     return markFunctionAsListener
  81
  82
  83 class EventInitializer(type):
  84
  85     def __init__(cls, name, bases, dict) :
  86         def init_listeners(self) :
  87             for k, v in dict.items() :
  88                 if isinstance(v, types.FunctionType) and hasattr(v, '__islistener__') :
  89                     listener = getattr(self, k)
  90                     for eventType in v.__eventtypes__ :
  91                         EventDispatcher.addEventListener(eventType, listener)
  92
  93         def ctor(self, *args, **kw) :
  94             default_ctor = dict.get('__init__')
  95             if not default_ctor :
  96                 super(cls, self).__init__(*args, **kw)
  97             else :
  98                 default_ctor(self, *args, **kw)
  99             init_listeners(self)
 100
 101         cls.__init__ = ctor
 102
 103
 104 class EventHandlerMixin(object) :
 105     __metaclass__ = EventInitializer