HCoop / bpt / emacs.git / blame
| Commit | Line | Data |
|---|---|---|
| e12489f9 | 1 | /* Asynchronous timers. |
| 429ab54e | 2 | Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, |
| 114f9c96 | 3 | 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
| e12489f9 GM |
4 | |
| 5 | This file is part of GNU Emacs. | |
| 6 | ||
| b9b1cc14 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
| e12489f9 | 8 | it under the terms of the GNU General Public License as published by |
| b9b1cc14 GM |
9 | the Free Software Foundation, either version 3 of the License, or |
| 10 | (at your option) any later version. | |
| e12489f9 GM |
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 | |
| b9b1cc14 | 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
| e12489f9 | 19 | |
| ffd8f46e DL |
20 | #ifndef EMACS_ATIMER_H |
| 21 | #define EMACS_ATIMER_H | |
| 22 | ||
| 82377c38 RS |
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 | ||
| ffd8f46e DL |
30 | #include "systime.h" /* for EMACS_TIME */ |
| 31 | ||
| e12489f9 GM |
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; | |
| 177c0ea7 | 60 | |
| e12489f9 GM |
61 | /* Time when this timer is ripe. */ |
| 62 | EMACS_TIME expiration; | |
| 63 | ||
| 64 | /* Interval of this timer. */ | |
| 65 | EMACS_TIME interval; | |
| 66 | ||
| 5f351ff1 PJ |
67 | /* Function to call when timer is ripe. Interrupt input is |
| 68 | guaranteed to not be blocked when this function is called. */ | |
| e12489f9 GM |
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)); | |
| 67a516c6 GM |
86 | void stop_other_atimers P_ ((struct atimer *)); |
| 87 | void run_all_atimers P_ ((void)); | |
| 88 | Lisp_Object unwind_stop_other_atimers P_ ((Lisp_Object)); | |
| e12489f9 | 89 | |
| ffd8f46e | 90 | #endif /* EMACS_ATIMER_H */ |
| ab5796a9 MB |
91 | |
| 92 | /* arch-tag: 02c7c1c8-45bd-4222-b874-4ca44662f60b | |
| 93 | (do not change this comment) */ |