annotate src/atimer.h @ 56468:fc5aa4dbf48e

*** empty log message ***
author Luc Teirlinck <teirllm@auburn.edu>
date Sun, 18 Jul 2004 14:03:01 +0000
parents 5407da499273
children a8fa7c632ee4 4c90ffeb71c5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27433
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1 /* Asynchronous timers.
56135
5407da499273 Update copyright.
Kim F. Storm <storm@cua.dk>
parents: 52539
diff changeset
2 Copyright (C) 2000, 2003 Free Software Foundation, Inc.
27433
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
3
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
4 This file is part of GNU Emacs.
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
5
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
9 any later version.
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
10
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
11 GNU Emacs is distributed in the hope that it will be useful,
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
14 GNU General Public License for more details.
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
15
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
20
29927
cc1255965fcc Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27671
diff changeset
21 #ifndef EMACS_ATIMER_H
cc1255965fcc Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27671
diff changeset
22 #define EMACS_ATIMER_H
cc1255965fcc Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27671
diff changeset
23
52539
70b6f248b802 Don't include lisp.h.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
24 /* Declare the prototype for a general external function. */
70b6f248b802 Don't include lisp.h.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
25 #if defined (PROTOTYPES) || defined (WINDOWSNT)
70b6f248b802 Don't include lisp.h.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
26 #define P_(proto) proto
70b6f248b802 Don't include lisp.h.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
27 #else
70b6f248b802 Don't include lisp.h.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
28 #define P_(proto) ()
70b6f248b802 Don't include lisp.h.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
29 #endif
70b6f248b802 Don't include lisp.h.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
30
29927
cc1255965fcc Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27671
diff changeset
31 #include "systime.h" /* for EMACS_TIME */
cc1255965fcc Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27671
diff changeset
32
27433
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
33 /* Forward declaration. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
34
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
35 struct atimer;
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
36
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
37 /* Types of timers. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
38
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
39 enum atimer_type
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
40 {
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
41 /* Timer is ripe at some absolute time. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
42 ATIMER_ABSOLUTE,
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
43
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
44 /* Timer is ripe at now plus an offset. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
45 ATIMER_RELATIVE,
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
46
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
47 /* Timer runs continously. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
48 ATIMER_CONTINUOUS
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
49 };
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
50
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
51 /* Type of timer callback functions. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
52
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
53 typedef void (* atimer_callback) P_ ((struct atimer *timer));
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
54
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
55 /* Structure describing an asynchronous timer. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
56
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
57 struct atimer
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
58 {
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
59 /* The type of this timer. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
60 enum atimer_type type;
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 39667
diff changeset
61
27433
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
62 /* Time when this timer is ripe. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
63 EMACS_TIME expiration;
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
64
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
65 /* Interval of this timer. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
66 EMACS_TIME interval;
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
67
39667
7ca787d18982 *** empty log message ***
Pavel Janík <Pavel@Janik.cz>
parents: 29927
diff changeset
68 /* Function to call when timer is ripe. Interrupt input is
7ca787d18982 *** empty log message ***
Pavel Janík <Pavel@Janik.cz>
parents: 29927
diff changeset
69 guaranteed to not be blocked when this function is called. */
27433
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
70 atimer_callback fn;
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
71
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
72 /* Additional user-specified data to pass to FN. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
73 void *client_data;
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
74
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
75 /* Next in list of active or free atimers. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
76 struct atimer *next;
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
77 };
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
78
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
79 /* Function prototypes. */
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
80
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
81 struct atimer *start_atimer P_ ((enum atimer_type, EMACS_TIME,
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
82 atimer_callback, void *));
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
83 void cancel_atimer P_ ((struct atimer *));
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
84 void do_pending_atimers P_ ((void));
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
85 void init_atimer P_ ((void));
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
86 void turn_on_atimers P_ ((int));
27671
466a99bee7fd (stop_other_atimers, run_all_atimers)
Gerd Moellmann <gerd@gnu.org>
parents: 27433
diff changeset
87 void stop_other_atimers P_ ((struct atimer *));
466a99bee7fd (stop_other_atimers, run_all_atimers)
Gerd Moellmann <gerd@gnu.org>
parents: 27433
diff changeset
88 void run_all_atimers P_ ((void));
466a99bee7fd (stop_other_atimers, run_all_atimers)
Gerd Moellmann <gerd@gnu.org>
parents: 27433
diff changeset
89 Lisp_Object unwind_stop_other_atimers P_ ((Lisp_Object));
27433
87dcc6a2c31b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
90
29927
cc1255965fcc Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27671
diff changeset
91 #endif /* EMACS_ATIMER_H */
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52275
diff changeset
92
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52275
diff changeset
93 /* arch-tag: 02c7c1c8-45bd-4222-b874-4ca44662f60b
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52275
diff changeset
94 (do not change this comment) */