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 le code 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
  33 class _EventDispatcher :
  34     def __init__(self) :
  35         self.registry = {}
  36
  37     def addEventListener(self, eventType, listener) :
  38         if self.registry.has_key(eventType) :
  39             self.registry[eventType].append(listener)
  40         else :
  41             self.registry[eventType] = [listener]
  42
  43     def dispatchEvents(self) :
  44         events = pygame.event.get()
  45         for event in events :
  46             listeners = self.registry.get(event.type, [])
  47             for listener in listeners :
  48                 listener(event)
  49
  50     def __repr__(self) :
  51         out = StringIO()
  52         keys = self.registry.keys()
  53         keys.sort()
  54         for k in keys :
  55             print >> out, "event", k
  56             for listener in self.registry[k] :
  57                 print >> out, listener.__name__
  58         out.seek(0)
  59         return out.read()
  60
  61
  62 EventDispatcher = _EventDispatcher()
  63
  64 def event_handler(eventType) :
  65     def markFunctionAsListener(m) :
  66         m.__islistener__ = True
  67         m.__eventtype__ = eventType
  68         return m
  69     return markFunctionAsListener
  70
  71
  72 class EventInitializer(type):
  73
  74     def __init__(cls, name, bases, dict) :
  75         def init_listeners(self) :
  76             for k, v in dict.items() :
  77                 if isinstance(v, types.FunctionType) and hasattr(v, '__islistener__') :
  78                     listener = getattr(self, k)
  79                     EventDispatcher.addEventListener(v.__eventtype__, listener)
  80
  81         def ctor(self, *args, **kw) :
  82             init_listeners(self)
  83             default_ctor = dict.get('__init__')
  84             if not default_ctor :
  85                 super(cls, self).__init__(*args, **kw)
  86             else :
  87                 default_ctor(self, *args, **kw)
  88
  89         cls.__init__ = ctor
  90
  91
  92 class EventHandlerMixin(object) :
  93     __metaclass__ = EventInitializer
  94
  95     #def input(self) :
  96     #    event = pygame.event.wait()
  97     #    handler = getattr(self, 'eventHandler%s' % event.type, lambda e:None)
  98     #    handler(event)