bitbake/lib/event.bb:
[bitbake.git] / lib / bb / event.py
1 #!/usr/bin/env python
2 # ex:ts=4:sw=4:sts=4:et
3 # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
4 """
5 BitBake 'Event' implementation
6
7 Classes and functions for manipulating 'events' in the
8 BitBake build tools.
9
10 Copyright (C) 2003, 2004  Chris Larson
11
12 This program is free software; you can redistribute it and/or modify it under
13 the terms of the GNU General Public License as published by the Free Software
14 Foundation; either version 2 of the License, or (at your option) any later
15 version.
16
17 This program is distributed in the hope that it will be useful, but WITHOUT
18 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License along with
22 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
23 Place, Suite 330, Boston, MA 02111-1307 USA. 
24 """
25
26 import os, re
27 import bb.data
28
29 class Event:
30     """Base class for events"""
31     type = "Event"
32
33     def __init__(self, d = bb.data.init()):
34         self._data = d
35
36     def getData(self):
37         return self._data
38
39     def setData(self, data):
40         self._data = data
41
42     data = property(getData, setData, None, "data property")
43
44 NotHandled = 0
45 Handled = 1
46 handlers = []
47
48 def tmpHandler(event):
49     """Default handler for code events"""
50     return NotHandled
51
52 def defaultTmpHandler():
53     tmp = "def tmpHandler(e):\n\t\"\"\"heh\"\"\"\n\treturn 0"
54     comp = compile(tmp, "tmpHandler(e)", "exec")
55     return comp
56
57 def fire(event):
58     """Fire off an Event"""
59     for h in handlers:
60         if type(h).__name__ == "code":
61             exec(h)
62             if tmpHandler(event) == Handled:
63                 return Handled
64         else:
65             if h(event) == Handled:
66                 return Handled
67     return NotHandled
68
69 def register(handler):
70     """Register an Event handler"""
71     if handler is not None:
72 #       handle string containing python code
73         if type(handler).__name__ == "str":
74             return registerCode(handler)
75 #       prevent duplicate registration
76         if not handler in handlers:
77             handlers.append(handler)
78
79 def registerCode(handlerStr):
80     """Register a 'code' Event.
81        Deprecated interface; call register instead.
82
83        Expects to be passed python code as a string, which will
84        be passed in turn to compile() and then exec().  Note that
85        the code will be within a function, so should have had
86        appropriate tabbing put in place."""
87     tmp = "def tmpHandler(e):\n%s" % handlerStr
88     comp = compile(tmp, "tmpHandler(e)", "exec")
89 #   prevent duplicate registration
90     if not comp in handlers:
91         handlers.append(comp)
92
93 def remove(handler):
94     """Remove an Event handler"""
95     for h in handlers:
96         if type(handler).__name__ == "str":
97             return removeCode(handler)
98
99         if handler is h:
100             handlers.remove(handler)
101
102 def removeCode(handlerStr):
103     """Remove a 'code' Event handler
104        Deprecated interface; call remove instead."""
105     tmp = "def tmpHandler(e):\n%s" % handlerStr
106     comp = compile(tmp, "tmpHandler(e)", "exec")
107     handlers.remove(comp)
108
109 def getName(e):
110     """Returns the name of a class or class instance"""
111     if getattr(e, "__name__", None) == None:
112         return e.__class__.__name__
113     else:
114         return e.__name__
115
116
117 class PkgBase(Event):
118     """Base class for package events"""
119
120     def __init__(self, t, d = {}):
121         self._pkg = t
122         Event.__init__(self, d)
123
124     def getPkg(self):
125         return self._pkg
126
127     def setPkg(self, pkg):
128         self._pkg = pkg
129
130     pkg = property(getPkg, setPkg, None, "pkg property")
131
132
133 class BuildBase(Event):
134     """Base class for bbmake run events"""
135
136     def __init__(self, n, p, c, failures = 0):
137         self._name = n
138         self._pkgs = p
139         Event.__init__(self, c)
140         self._failures = failures
141
142     def getPkgs(self):
143         return self._pkgs
144
145     def setPkgs(self, pkgs):
146         self._pkgs = pkgs
147
148     def getName(self):
149         return self._name
150
151     def setName(self, name):
152         self._name = name
153
154     def getCfg(self):
155         return self.data
156
157     def setCfg(self, cfg):
158         self.data = cfg
159
160     def getFailures(self):
161         """
162         Return the number of failed packages
163         """
164         return self._failures
165
166     pkgs = property(getPkgs, setPkgs, None, "pkgs property")
167     name = property(getName, setName, None, "name property")
168     cfg = property(getCfg, setCfg, None, "cfg property")
169
170
171 class DepBase(PkgBase):
172     """Base class for dependency events"""
173
174     def __init__(self, t, data, d):
175         self._dep = d
176         PkgBase.__init__(self, t, data)
177
178     def getDep(self):
179         return self._dep
180
181     def setDep(self, dep):
182         self._dep = dep
183
184     dep = property(getDep, setDep, None, "dep property")
185
186
187 class PkgStarted(PkgBase):
188     """Package build started"""
189
190
191 class PkgFailed(PkgBase):
192     """Package build failed"""
193
194
195 class PkgSucceeded(PkgBase):
196     """Package build completed"""
197
198
199 class BuildStarted(BuildBase):
200     """bbmake build run started"""
201
202
203 class BuildCompleted(BuildBase):
204     """bbmake build run completed"""
205
206
207 class UnsatisfiedDep(DepBase):
208     """Unsatisfied Dependency"""
209
210
211 class RecursiveDep(DepBase):
212     """Recursive Dependency"""
213
214
215 class MultipleProviders(Event):
216     """Multiple Providers"""
217
218     def  __init__(self, item, candidates, data, runtime = False):
219         Event.__init__(self, data)
220         self._item = item
221         self._candidates = candidates
222         self._is_runtime = runtime
223
224     def isRuntime(self):
225         """
226         Is this a runtime issue?
227         """
228         return self._is_runtime
229
230     def getItem(self):
231         """
232         The name for the to be build item
233         """
234         return self._item
235
236     def getCandidates(self):
237         """
238         Get the possible Candidates for a PROVIDER.
239         """
240         return self._candidates