efa1f7ef3bf84f723e39096bff772112f8d97f00
[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 from logging import getLogger, basicConfig, DEBUG
33 import sys
34 basicConfig(level=DEBUG, stream = sys.stdout)
35 console = getLogger('minwii.eventutils')
36
37 class _EventDispatcher :
38 def __init__(self) :
39 self.registry = {}
40
41 def addEventListener(self, eventType, listener) :
42 if self.registry.has_key(eventType) :
43 self.registry[eventType][listener] = True
44 else :
45 self.registry[eventType] = {listener:True}
46
47 def removeEventListener(self, eventType, listener) :
48 try :
49 del self.registry[eventType][listener]
50 except KeyError :
51 console.warn("no listener to remove")
52
53 def dispatchEvents(self) :
54 events = pygame.event.get()
55 for event in events :
56 listeners = self.registry.get(event.type, {})
57 for listener in listeners.keys() :
58 listener(event)
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(eventType) :
77 def markFunctionAsListener(m) :
78 m.__islistener__ = True
79 m.__eventtype__ = eventType
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 EventDispatcher.addEventListener(v.__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
106
107 #def input(self) :
108 # event = pygame.event.wait()
109 # handler = getattr(self, 'eventHandler%s' % event.type, lambda e:None)
110 # handler(event)