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