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, hiddenEvents, pprinters
  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.warn("no listener to remove")
  49
  50     def dispatchEvents(self) :
  51         events = pygame.event.get()
  52         for event in events :
  53             listeners = self.registry.get(event.type, {})
  54             if not hiddenEvents.has_key(event.type):
  55                 eventLogger.info(event)
  56             for listener in listeners.keys() :
  57                 listener(event)
  58
  59     def reset(self) :
  60         self.registry = {}
  61
  62     def __repr__(self) :
  63         out = StringIO()
  64         keys = self.registry.keys()
  65         keys.sort()
  66         for k in keys :
  67             print >> out, "event", k
  68             for listener in self.registry[k].keys() :
  69                 print >> out, listener.__name__
  70         out.seek(0)
  71         return out.read()
  72
  73
  74 EventDispatcher = _EventDispatcher()
  75
  76 def event_handler(*eventTypes) :
  77     def markFunctionAsListener(m) :
  78         m.__islistener__ = True
  79         m.__eventtypes__ = eventTypes
  80         return m
  81     return markFunctionAsListener
  82
  83
  84 class EventInitializer(type):
  85
  86     def __init__(cls, name, bases, dict) :
  87         def init_listeners(self) :
  88             for k, v in dict.items() :
  89                 if isinstance(v, types.FunctionType) and hasattr(v, '__islistener__') :
  90                     listener = getattr(self, k)
  91                     for eventType in v.__eventtypes__ :
  92                         EventDispatcher.addEventListener(eventType, listener)
  93
  94         def ctor(self, *args, **kw) :
  95             default_ctor = dict.get('__init__')
  96             if not default_ctor :
  97                 super(cls, self).__init__(*args, **kw)
  98             else :
  99                 default_ctor(self, *args, **kw)
 100             init_listeners(self)
 101
 102         cls.__init__ = ctor
 103
 104
 105 class EventHandlerMixin(object) :
 106     __metaclass__ = EventInitializer