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