chiark / gitweb /
*.pyx: Add some rather laconic docstrings.
[mLib-python] / sig.pyx
1 ### -*-pyrex-*-
2 ###
3 ### In-band signals
4 ###
5 ### (c) 2005 Straylight/Edgeware
6 ###
7
8 ###----- Licensing notice ---------------------------------------------------
9 ###
10 ### This file is part of the Python interface to mLib.
11 ###
12 ### mLib/Python is free software; you can redistribute it and/or modify
13 ### it under the terms of the GNU General Public License as published by
14 ### the Free Software Foundation; either version 2 of the License, or
15 ### (at your option) any later version.
16 ###
17 ### mLib/Python is distributed in the hope that it will be useful,
18 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 ### GNU General Public License for more details.
21 ###
22 ### You should have received a copy of the GNU General Public License
23 ### along with mLib/Python; if not, write to the Free Software Foundation,
24 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25
26 import signal
27
28 cdef class SelSignal:
29   """
30   SelSignal(SIG, [signalledproc = None])
31
32   Collect signals from the event loop.
33   """
34   cdef sig s
35   cdef int _activep
36   cdef readonly int signal
37   cdef _signalled
38   def __cinit__(me, int sig, signalledproc = None, *hunoz, **hukairz):
39     if sig < 0 or sig >= signal.NSIG:
40       raise ValueError, 'signal number out of range'
41     me.signal = sig
42     me._signalled = _checkcallable(signalledproc, 'signalled proc')
43     me._activep = 0
44   def __dealloc__(me):
45     if me._activep:
46       sig_remove(&me.s)
47   property activep:
48     """SS.activep -> BOOL: is the handler still active?"""
49     def __get__(me):
50       return _tobool(me._activep)
51   property signalledproc:
52     """SS.signalledproc -> FUNC: call FUNC() when the signal is received"""
53     def __get__(me):
54       return me._signalled
55     def __set__(me, proc):
56       me._signalled = _checkcallable(proc, 'signalled proc')
57     def __del__(me):
58       me._signalled = None
59   def enable(me):
60     """SS.enable(): enable the handler"""
61     if me._activep:
62       raise ValueError, 'already enabled'
63     sig_add(&me.s, me.signal, _sigfunc, <void *>me)
64     me._enabled()
65     return me
66   def disable(me):
67     """SS.disable(): disable the handler"""
68     if not me._activep:
69       raise ValueError, 'already disabled'
70     sig_remove(&me.s)
71     me._disabled()
72     return me
73   cdef _enabled(me):
74     me._activep = 1
75     me.enabled()
76   cdef _disabled(me):
77     me._activep = 0
78     me.disabled()
79   def enabled(me):
80     """SS.enabled(): called when handler is enabled"""
81     pass
82   def disabled(me):
83     """SS.disabled(): called when handler is disabled"""
84     pass
85   def signalled(me):
86     """SS.signalled(): called when the signal is received"""
87     return _maybecall(me._signalled, ())
88
89 cdef void _sigfunc(int sig, void *arg):
90   cdef SelSignal s
91   s = <SelSignal>arg
92   s.signalled()
93
94 sig_init(&_sel)
95
96 ###----- That's all, folks --------------------------------------------------