27433
|
1 /* Asynchronous timers.
|
56135
|
2 Copyright (C) 2000, 2003 Free Software Foundation, Inc.
|
27433
|
3
|
|
4 This file is part of GNU Emacs.
|
|
5
|
|
6 GNU Emacs is free software; you can redistribute it and/or modify
|
|
7 it under the terms of the GNU General Public License as published by
|
|
8 the Free Software Foundation; either version 2, or (at your option)
|
|
9 any later version.
|
|
10
|
|
11 GNU Emacs is distributed in the hope that it will be useful,
|
|
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
14 GNU General Public License for more details.
|
|
15
|
|
16 You should have received a copy of the GNU General Public License
|
|
17 along with GNU Emacs; see the file COPYING. If not, write to
|
64084
|
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
19 Boston, MA 02110-1301, USA. */
|
27433
|
20
|
29927
|
21 #ifndef EMACS_ATIMER_H
|
|
22 #define EMACS_ATIMER_H
|
|
23
|
52539
|
24 /* Declare the prototype for a general external function. */
|
|
25 #if defined (PROTOTYPES) || defined (WINDOWSNT)
|
|
26 #define P_(proto) proto
|
|
27 #else
|
|
28 #define P_(proto) ()
|
|
29 #endif
|
|
30
|
29927
|
31 #include "systime.h" /* for EMACS_TIME */
|
|
32
|
27433
|
33 /* Forward declaration. */
|
|
34
|
|
35 struct atimer;
|
|
36
|
|
37 /* Types of timers. */
|
|
38
|
|
39 enum atimer_type
|
|
40 {
|
|
41 /* Timer is ripe at some absolute time. */
|
|
42 ATIMER_ABSOLUTE,
|
|
43
|
|
44 /* Timer is ripe at now plus an offset. */
|
|
45 ATIMER_RELATIVE,
|
|
46
|
|
47 /* Timer runs continously. */
|
|
48 ATIMER_CONTINUOUS
|
|
49 };
|
|
50
|
|
51 /* Type of timer callback functions. */
|
|
52
|
|
53 typedef void (* atimer_callback) P_ ((struct atimer *timer));
|
|
54
|
|
55 /* Structure describing an asynchronous timer. */
|
|
56
|
|
57 struct atimer
|
|
58 {
|
|
59 /* The type of this timer. */
|
|
60 enum atimer_type type;
|
49600
|
61
|
27433
|
62 /* Time when this timer is ripe. */
|
|
63 EMACS_TIME expiration;
|
|
64
|
|
65 /* Interval of this timer. */
|
|
66 EMACS_TIME interval;
|
|
67
|
39667
|
68 /* Function to call when timer is ripe. Interrupt input is
|
|
69 guaranteed to not be blocked when this function is called. */
|
27433
|
70 atimer_callback fn;
|
|
71
|
|
72 /* Additional user-specified data to pass to FN. */
|
|
73 void *client_data;
|
|
74
|
|
75 /* Next in list of active or free atimers. */
|
|
76 struct atimer *next;
|
|
77 };
|
|
78
|
|
79 /* Function prototypes. */
|
|
80
|
|
81 struct atimer *start_atimer P_ ((enum atimer_type, EMACS_TIME,
|
|
82 atimer_callback, void *));
|
|
83 void cancel_atimer P_ ((struct atimer *));
|
|
84 void do_pending_atimers P_ ((void));
|
|
85 void init_atimer P_ ((void));
|
|
86 void turn_on_atimers P_ ((int));
|
27671
|
87 void stop_other_atimers P_ ((struct atimer *));
|
|
88 void run_all_atimers P_ ((void));
|
|
89 Lisp_Object unwind_stop_other_atimers P_ ((Lisp_Object));
|
27433
|
90
|
29927
|
91 #endif /* EMACS_ATIMER_H */
|
52401
|
92
|
|
93 /* arch-tag: 02c7c1c8-45bd-4222-b874-4ca44662f60b
|
|
94 (do not change this comment) */
|