Mercurial > emacs
annotate src/atimer.h @ 96708:ceb7b0d5c55f
(cl-do-pop, cl-mapcar-many): Declare for compiler.
(cl-hack-byte-compiler): Load cl-macs and run cl-hack-bytecomp-hook
directly. Provide cl before loading cl-macs.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Wed, 16 Jul 2008 02:49:35 +0000 |
parents | 29adfc9354e7 |
children | e038c1a8307c |
rev | line source |
---|---|
27433 | 1 /* Asynchronous timers. |
75227
e90d04cd455a
Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents:
68651
diff
changeset
|
2 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, |
79759 | 3 2006, 2007, 2008 Free Software Foundation, Inc. |
27433 | 4 |
5 This file is part of GNU Emacs. | |
6 | |
94994
29adfc9354e7
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
79759
diff
changeset
|
7 GNU Emacs is free software: you can redistribute it and/or modify |
27433 | 8 it under the terms of the GNU General Public License as published by |
94994
29adfc9354e7
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
79759
diff
changeset
|
9 the Free Software Foundation, either version 3 of the License, or |
29adfc9354e7
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
79759
diff
changeset
|
10 (at your option) any later version. |
27433 | 11 |
12 GNU Emacs is distributed in the hope that it will be useful, | |
13 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 GNU General Public License for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
94994
29adfc9354e7
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
79759
diff
changeset
|
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
27433 | 19 |
29927
cc1255965fcc
Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents:
27671
diff
changeset
|
20 #ifndef EMACS_ATIMER_H |
cc1255965fcc
Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents:
27671
diff
changeset
|
21 #define EMACS_ATIMER_H |
cc1255965fcc
Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents:
27671
diff
changeset
|
22 |
52539 | 23 /* Declare the prototype for a general external function. */ |
24 #if defined (PROTOTYPES) || defined (WINDOWSNT) | |
25 #define P_(proto) proto | |
26 #else | |
27 #define P_(proto) () | |
28 #endif | |
29 | |
29927
cc1255965fcc
Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents:
27671
diff
changeset
|
30 #include "systime.h" /* for EMACS_TIME */ |
cc1255965fcc
Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents:
27671
diff
changeset
|
31 |
27433 | 32 /* Forward declaration. */ |
33 | |
34 struct atimer; | |
35 | |
36 /* Types of timers. */ | |
37 | |
38 enum atimer_type | |
39 { | |
40 /* Timer is ripe at some absolute time. */ | |
41 ATIMER_ABSOLUTE, | |
42 | |
43 /* Timer is ripe at now plus an offset. */ | |
44 ATIMER_RELATIVE, | |
45 | |
46 /* Timer runs continously. */ | |
47 ATIMER_CONTINUOUS | |
48 }; | |
49 | |
50 /* Type of timer callback functions. */ | |
51 | |
52 typedef void (* atimer_callback) P_ ((struct atimer *timer)); | |
53 | |
54 /* Structure describing an asynchronous timer. */ | |
55 | |
56 struct atimer | |
57 { | |
58 /* The type of this timer. */ | |
59 enum atimer_type type; | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39667
diff
changeset
|
60 |
27433 | 61 /* Time when this timer is ripe. */ |
62 EMACS_TIME expiration; | |
63 | |
64 /* Interval of this timer. */ | |
65 EMACS_TIME interval; | |
66 | |
39667 | 67 /* Function to call when timer is ripe. Interrupt input is |
68 guaranteed to not be blocked when this function is called. */ | |
27433 | 69 atimer_callback fn; |
70 | |
71 /* Additional user-specified data to pass to FN. */ | |
72 void *client_data; | |
73 | |
74 /* Next in list of active or free atimers. */ | |
75 struct atimer *next; | |
76 }; | |
77 | |
78 /* Function prototypes. */ | |
79 | |
80 struct atimer *start_atimer P_ ((enum atimer_type, EMACS_TIME, | |
81 atimer_callback, void *)); | |
82 void cancel_atimer P_ ((struct atimer *)); | |
83 void do_pending_atimers P_ ((void)); | |
84 void init_atimer P_ ((void)); | |
85 void turn_on_atimers P_ ((int)); | |
27671
466a99bee7fd
(stop_other_atimers, run_all_atimers)
Gerd Moellmann <gerd@gnu.org>
parents:
27433
diff
changeset
|
86 void stop_other_atimers P_ ((struct atimer *)); |
466a99bee7fd
(stop_other_atimers, run_all_atimers)
Gerd Moellmann <gerd@gnu.org>
parents:
27433
diff
changeset
|
87 void run_all_atimers P_ ((void)); |
466a99bee7fd
(stop_other_atimers, run_all_atimers)
Gerd Moellmann <gerd@gnu.org>
parents:
27433
diff
changeset
|
88 Lisp_Object unwind_stop_other_atimers P_ ((Lisp_Object)); |
27433 | 89 |
29927
cc1255965fcc
Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents:
27671
diff
changeset
|
90 #endif /* EMACS_ATIMER_H */ |
52401 | 91 |
92 /* arch-tag: 02c7c1c8-45bd-4222-b874-4ca44662f60b | |
93 (do not change this comment) */ |