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 logging import getLogger, basicConfig, DEBUG
  33 import sys
  34 from events import TIMEOUT, COLOVER, eventNames
  35 basicConfig(level=DEBUG, stream = sys.stdout)
  36 console = getLogger('minwii')
  37 eventLog = getLogger('minwii.events')
  38
  39 hiddenEvents = {pygame.MOUSEMOTION:True,
  40                 TIMEOUT:True,
  41                 #COLOVER:True,
  42                 }
  43 from event_pprinters import pprinters
  44
  45 class _EventDispatcher :
  46     def __init__(self) :
  47         self.registry = {}
  48
  49     def addEventListener(self, eventType, listener) :
  50         if self.registry.has_key(eventType) :
  51             self.registry[eventType][listener] = True
  52         else :
  53             self.registry[eventType] = {listener:True}
  54
  55     def removeEventListener(self, eventType, listener) :
  56         try :
  57             del self.registry[eventType][listener]
  58         except KeyError :
  59             console.warn("no listener to remove")
  60
  61     def dispatchEvents(self) :
  62         events = pygame.event.get()
  63         for event in events :
  64             listeners = self.registry.get(event.type, {})
  65             if listeners and not hiddenEvents.has_key(event.type) :
  66                 eventLog.info(pprinters[event.type](event))
  67             for listener in listeners.keys() :
  68                 listener(event)
  69
  70     def reset(self) :
  71         self.registry = {}
  72
  73     def __repr__(self) :
  74         out = StringIO()
  75         keys = self.registry.keys()
  76         keys.sort()
  77         for k in keys :
  78             print >> out, "event", k
  79             for listener in self.registry[k].keys() :
  80                 print >> out, listener.__name__
  81         out.seek(0)
  82         return out.read()
  83
  84
  85 EventDispatcher = _EventDispatcher()
  86
  87 def event_handler(*eventTypes) :
  88     def markFunctionAsListener(m) :
  89         m.__islistener__ = True
  90         m.__eventtypes__ = eventTypes
  91         return m
  92     return markFunctionAsListener
  93
  94
  95 class EventInitializer(type):
  96
  97     def __init__(cls, name, bases, dict) :
  98         def init_listeners(self) :
  99             for k, v in dict.items() :
 100                 if isinstance(v, types.FunctionType) and hasattr(v, '__islistener__') :
 101                     listener = getattr(self, k)
 102                     for eventType in v.__eventtypes__ :
 103                         EventDispatcher.addEventListener(eventType, listener)
 104
 105         def ctor(self, *args, **kw) :
 106             default_ctor = dict.get('__init__')
 107             if not default_ctor :
 108                 super(cls, self).__init__(*args, **kw)
 109             else :
 110                 default_ctor(self, *args, **kw)
 111             init_listeners(self)
 112
 113         cls.__init__ = ctor
 114
 115
 116 class EventHandlerMixin(object) :
 117     __metaclass__ = EventInitializer