annotate src/systime.h @ 617:af57a77cbc92

[xemacs-hg @ 2001-06-18 07:09:50 by ben] --------------------------------------------------------------- DOCUMENTATION FIXES: --------------------------------------------------------------- eval.c: Correct documentation. elhash.c: Doc correction. --------------------------------------------------------------- LISP OBJECT CLEANUP: --------------------------------------------------------------- bytecode.h, buffer.h, casetab.h, chartab.h, console-msw.h, console.h, database.c, device.h, eldap.h, elhash.h, events.h, extents.h, faces.h, file-coding.h, frame.h, glyphs.h, gui-x.h, gui.h, keymap.h, lisp-disunion.h, lisp-union.h, lisp.h, lrecord.h, lstream.h, mule-charset.h, objects.h, opaque.h, postgresql.h, process.h, rangetab.h, specifier.h, toolbar.h, tooltalk.h, ui-gtk.h: Add wrap_* to all objects (it was already there for a few of them) -- an expression to encapsulate a pointer into a Lisp object, rather than the inconvenient XSET*. "wrap" was chosen because "make" as in make_int(), make_char() is not appropriate. (It implies allocation. The issue does not exist for ints and chars because they are not allocated.) Full error checking has been added to these expressions. When used without error checking, non-union build, use of these expressions will incur no loss of efficiency. (In fact, XSET* is now defined in terms of wrap_* in a non-union build.) In a union build, you will also get no loss of efficiency provided that you have a decent optimizing compiler, and a compiler that either understands inlines or automatically inlines those particular functions. (And since people don't normally do their production builds on union, it doesn't matter.) Update the sample Lisp object definition in lrecord.h accordingly. dumper.c: Fix places in dumper that referenced wrap_object to reference its new name, wrap_pointer_1. buffer.c, bufslots.h, conslots.h, console.c, console.h, devslots.h, device.c, device.h, frame.c, frame.h, frameslots.h, window.c, window.h, winslots.h: -- Extract out the Lisp objects of `struct device' into devslots.h, just like for the other structures. -- Extract out the remaining (not copied into the window config) Lisp objects in `struct window' into winslots.h; use different macros (WINDOW_SLOT vs. WINDOW_SAVED_SLOT) to differentiate them. -- Eliminate the `dead' flag of `struct frame', since it duplicates information already available in `framemeths', and fix FRAME_LIVE_P accordingly. (Devices and consoles already work this way.) -- In *slots.h, switch to system where MARKED_SLOT is automatically undef'd at the end of the file. (Follows what winslots.h already does.) -- Update the comments at the beginning of *slots.h to be accurate. -- When making any of the above objects dead, zero it out entirely and reset all Lisp object slots to Qnil. (We were already doing this somewhat, but not consistently.) This (1) Eliminates the possibility of extra objects hanging around that ought to be GC'd, (2) Causes an immediate crash if anyone tries to access a structure in one of these objects, (3) Ensures consistent behavior wrt dead objects. dialog-msw.c: Use internal_object_printer, since this object should not escape. --------------------------------------------------------------- FIXING A CRASH THAT I HIT ONCE (AND A RELATED BAD BEHAVIOR): --------------------------------------------------------------- eval.c: Fix up some comments about the FSF implementation. Fix two nasty bugs: (1) condition_case_unwind frees the conses sitting in the catch->tag slot too quickly, resulting in a crash that I hit. (2) catches need to be unwound one at a time when calling unwind-protect code, rather than all at once at the end; otherwise, incorrect behavior can result. (A comment shows exactly how.) backtrace.h: Improve comment about FSF differences in the handler stack. --------------------------------------------------------------- FIXING A CRASH THAT I REPEATEDLY HIT WHEN USING THE MOUSE WHEEL UNDER MSWINDOWS: --------------------------------------------------------------- Basic idea: My crash is due either to a dead, non-marked, GC-collected frame inside of a window mirror, or a prematurely freed window mirror. We need to mark the Lisp objects inside of window mirrors. Tracking the lifespan of window mirrors and scrollbar instances is extremely hard, and there may well be lurking bugs where such objects are freed too soon. The only safe way to fix these problems (and it fixes both problems at once) is to make both of these structures Lisp objects. lrecord.h, emacs.c, inline.c, scrollbar-gtk.c, scrollbar-msw.c, scrollbar-x.c, scrollbar.c, scrollbar.h, symsinit.h: Make scrollbar instances actual Lisp objects. Mark the window mirrors in them. inline.c needs to know about scrollbar.h now. Record the new type in lrecord.h. Fix up scrollbar-*.c appropriately. Create a hash table in scrollbar-msw.c so that the scrollbar instances stored in scrollbar HWND's are properly GC-protected. Create complex_vars_of_scrollbar_mswindows() to create the hash table at startup, and call it from emacs.c. Don't store the scrollbar instance as a property of the GTK scrollbar, as it's not used and if we did this, we'd have to separately GC-protect it in a hash table, like in MS Windows. lrecord.h, frame.h, frame.c, frameslots.h, redisplay.c, window.c, window.h: Move mark_window_mirror from redisplay.c to window.c. Make window mirrors actual Lisp objects. Tell lrecord.h about them. Change the window mirror member of struct frame from a pointer to a Lisp object, and add XWINDOW_MIRROR in appropriate places. Mark the scrollbar instances in the window mirror. redisplay.c, redisplay.h, alloc.c: Delete mark_redisplay. Don't call mark_redisplay. We now mark frame-specific structures in mark_frame. NOTE: I also deleted an extremely questionable call to update_frame_window_mirrors(). It was extremely questionable before, and now totally impossible, since it will create Lisp objects during redisplay. frame.c: Mark the scrollbar instances, which are now Lisp objects. Call mark_gutter() here, not in mark_redisplay(). gutter.c: Update comments about correct marking. --------------------------------------------------------------- ISSUES BROUGHT UP BY MARTIN: --------------------------------------------------------------- buffer.h: Put back these macros the way Steve T and I think they ought to be. I already explained in a previous changelog entry why I think these macros should be the way I'd defined them. Once again: We fix these macros so they don't care about the type of their lvalues. The non-C-string equivalents of these already function in the same way, and it's correct because it should be OK to pass in a CBufbyte *, a BufByte *, a Char_Binary *, an UChar_Binary *, etc. The whole reason for these different types is to work around errors caused by signed-vs-unsigned non-matching types. Any possible error that might be caught in a DFC macro would also be caught wherever the argument is used elsewhere. So creating multiple macro versions would add no useful error-checking and just further complicate an already complicated area. As for Martin's "ANSI aliasing" bug, XEmacs is not ANSI-aliasing clean and probably never will be. Unless the board agrees to change XEmacs in this way (and we really don't want to go down that road), this is not a bug. sound.h: Undo Martin's type change. signal.c: Fix problem identified by Martin with Linux and g++ due to non-standard declaration of setitimer(). systime.h: Update the docs for "qxe_" to point out why making the encapsulation explicit is always the right way to go. (setitimer() itself serves as an example.) For 21.4: update-elc-2.el: Correct misplaced parentheses, making lisp/mule not get recompiled.
author ben
date Mon, 18 Jun 2001 07:10:32 +0000
parents 38db05db9cb5
children 943eaba38521
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 /* systime.h - System-dependent definitions for time manipulations.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 XEmacs is free software; you can redistribute it and/or modify it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 under the terms of the GNU General Public License as published by the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 Free Software Foundation; either version 2, or (at your option) any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 along with XEmacs; see the file COPYING. If not, write to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 /* Synched up with: FSF 19.30. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
23 #ifndef INCLUDED_systime_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
24 #define INCLUDED_systime_h_
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 #ifdef TIME_WITH_SYS_TIME
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
27 # include <sys/time.h>
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
28 # include <time.h>
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 #else
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
30 # ifdef HAVE_SYS_TIME_H
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
31 # include <sys/time.h>
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
32 # else
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
33 # include <time.h>
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
34 # endif
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 /* select() is supposed to be (Unix98) defined in sys/time.h,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 but FreeBSD and Irix 5 put it in unistd.h instead.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 If we have it, including it can't hurt. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 #ifdef HAVE_UNISTD_H
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 #include <unistd.h>
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
44 #ifdef WIN32_NATIVE
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
45
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
46 /* This defines struct timeval */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
47 #include <winsock.h>
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
48
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
49 struct timezone
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
50 {
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
51 int tz_minuteswest; /* minutes west of Greenwich */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
52 int tz_dsttime; /* type of dst correction */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
53 };
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
54
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
55 #ifdef HAVE_X_WINDOWS
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 /* Provides gettimeofday etc */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 #include <X11/Xw32defs.h>
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 #include <X11/Xos.h>
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
59 #else
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
60 /* X11R6 on NT provides the single parameter version of this command */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
61 void gettimeofday (struct timeval *, struct timezone *);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
62 #endif /* HAVE_X_WINDOWS */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
63
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
64 #endif /* WIN32_NATIVE */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65
592
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
66 /* struct utimbuf */
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
67
460
223736d75acb Import from CVS: tag r21-2-45
cvs
parents: 442
diff changeset
68 #ifdef HAVE_UTIME
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 # include <utime.h>
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71
592
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
72 #ifdef WIN32_NATIVE
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
73 # include <sys/utime.h>
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
74 #endif
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
75
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
76 #if defined(HAVE_TZNAME) && !defined(WIN32_NATIVE) && !defined(CYGWIN)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 #ifndef tzname /* For SGI. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 extern char *tzname[]; /* RS6000 and others want it this way. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 /* On some configurations (hpux8.0, X11R4), sys/time.h and X11/Xos.h
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 disagree about the name of the guard symbol. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 #ifdef HPUX
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 #ifdef _STRUCT_TIMEVAL
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 #ifndef __TIMEVAL__
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 #define __TIMEVAL__
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 /* EMACS_TIME is the type to use to represent temporal intervals.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 At one point this was 'struct timeval' on some systems, int on others.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 But this is stupid. Other things than select() code like to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 manipulate time values, and so microsecond precision should be
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 maintained. Separate typedefs and conversion functions are provided
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97 for select().
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99 EMACS_SECS (TIME) is an rvalue for the seconds component of TIME.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 EMACS_SET_SECS (TIME, SECONDS) sets that to SECONDS.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102 EMACS_USECS (TIME) is an rvalue for the microseconds component of TIME.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 EMACS_SET_USECS (TIME, MICROSECONDS) sets that to MICROSECONDS.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 Note that all times are returned in "normalized" format (i.e. the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 usecs value is in the range 0 <= value < 1000000) and are assumed
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 to be passed in in this format.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 EMACS_SET_SECS_USECS (TIME, SECS, USECS) sets both components of TIME.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111 EMACS_GET_TIME (TIME) stores the current system time in TIME, which
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 should be an lvalue.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 set_file_times (PATH, ATIME, MTIME) changes the last-access and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 last-modification times of the file named PATH to ATIME and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 MTIME, which are EMACS_TIMEs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 EMACS_NORMALIZE_TIME (TIME) coerces TIME into normalized format.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 result in DEST. Either or both may be negative.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 stores the result in DEST. Either or both may be negative.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 EMACS_TIME_NEG_P (TIME) is true iff TIME is negative.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 EMACS_TIME_EQUAL (TIME1, TIME2) is true iff TIME1 is the same as TIME2.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129 EMACS_TIME_GREATER (TIME1, TIME2) is true iff TIME1 is greater than
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 TIME2.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131 EMACS_TIME_EQUAL_OR_GREATER (TIME1, TIME2) is true iff TIME1 is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 greater than or equal to TIME2.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136 #ifdef HAVE_TIMEVAL
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 #define EMACS_SELECT_TIME struct timeval
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 #define EMACS_TIME_TO_SELECT_TIME(time, select_time) ((select_time) = (time))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 #else /* not HAVE_TIMEVAL */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 struct timeval
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 long tv_sec; /* seconds */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 long tv_usec; /* microseconds */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149 #define EMACS_SELECT_TIME int
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 #define EMACS_TIME_TO_SELECT_TIME(time, select_time) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151 EMACS_TIME_TO_INT (time, select_time)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 #endif /* not HAVE_TIMEVAL */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 #define EMACS_TIME_TO_INT(time, intvar) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156 do { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 EMACS_TIME tmptime = time; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159 if (tmptime.tv_usec > 0) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 (intvar) = tmptime.tv_sec + 1; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161 else \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162 (intvar) = tmptime.tv_sec; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
163 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165 #define EMACS_TIME struct timeval
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166 #define EMACS_SECS(time) ((time).tv_sec + 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167 #define EMACS_USECS(time) ((time).tv_usec + 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168 #define EMACS_SET_SECS(time, seconds) ((time).tv_sec = (seconds))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169 #define EMACS_SET_USECS(time, microseconds) ((time).tv_usec = (microseconds))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171 #if !defined (HAVE_GETTIMEOFDAY)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
172 int gettimeofday (struct timeval *, void *);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
173 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175 /* On SVR4, the compiler may complain if given this extra BSD arg. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
176 #ifdef GETTIMEOFDAY_ONE_ARGUMENT
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
177 #define EMACS_GETTIMEOFDAY(time) gettimeofday(time)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
178 #else
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
179 #define EMACS_GETTIMEOFDAY(time) gettimeofday(time,0)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
180 #endif
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
181
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
182 /* According to the Xt sources, some NTP daemons on some systems may
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
183 return non-normalized values. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
184 #define EMACS_GET_TIME(time) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
185 do { \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
186 EMACS_GETTIMEOFDAY (&(time)); \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187 EMACS_NORMALIZE_TIME (time); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
188 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
189
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
190 #define EMACS_NORMALIZE_TIME(time) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
191 do { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
192 while ((time).tv_usec >= 1000000) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
193 { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
194 (time).tv_usec -= 1000000; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
195 (time).tv_sec++; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
196 } \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
197 while ((time).tv_usec < 0) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
198 { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
199 (time).tv_usec += 1000000; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
200 (time).tv_sec--; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201 } \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
204 #define EMACS_ADD_TIME(dest, src1, src2) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
205 do { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
206 (dest).tv_sec = (src1).tv_sec + (src2).tv_sec; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
207 (dest).tv_usec = (src1).tv_usec + (src2).tv_usec; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
208 EMACS_NORMALIZE_TIME (dest); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
209 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
210
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
211 #define EMACS_SUB_TIME(dest, src1, src2) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
212 do { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
213 (dest).tv_sec = (src1).tv_sec - (src2).tv_sec; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214 (dest).tv_usec = (src1).tv_usec - (src2).tv_usec; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
215 EMACS_NORMALIZE_TIME (dest); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
216 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
217
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218 #define EMACS_TIME_NEG_P(time) ((long)(time).tv_sec < 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 #define EMACS_TIME_EQUAL(time1, time2) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
221 ((time1).tv_sec == (time2).tv_sec && \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
222 (time1).tv_usec == (time2).tv_usec)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 #define EMACS_TIME_GREATER(time1, time2) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
225 ((time1).tv_sec > (time2).tv_sec || \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 ((time1).tv_sec == (time2).tv_sec && \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227 (time1).tv_usec > (time2).tv_usec))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
229 #define EMACS_TIME_EQUAL_OR_GREATER(time1, time2) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 ((time1).tv_sec > (time2).tv_sec || \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
231 ((time1).tv_sec == (time2).tv_sec && \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
232 (time1).tv_usec >= (time2).tv_usec))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
233
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 #define EMACS_SET_SECS_USECS(time, secs, usecs) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
235 (EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
236
592
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
237 #ifdef emacs
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
238 int set_file_times (Lisp_Object path, EMACS_TIME atime, EMACS_TIME mtime);
4f6ba8f1fb3d [xemacs-hg @ 2001-05-31 12:03:37 by adrian]
adrian
parents: 558
diff changeset
239 #endif
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
240
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
241 void get_process_times (double *user_time, double *system_time,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242 double *real_time);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243
611
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
244 #ifdef WIN32_NATIVE
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245
611
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
246 /* setitimer emulation for Win32 (see win32.c) */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
248 struct itimerval
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
249 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
250 struct timeval it_value;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
251 struct timeval it_interval;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
252 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
253
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
254 #define ITIMER_REAL 1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
255 #define ITIMER_PROF 2
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
256
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
257 #endif /* WIN32_NATIVE */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
258
611
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
259 #if defined (WIN32_NATIVE) || defined (CYGWIN)
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
260
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
261 int mswindows_setitimer (int kind, const struct itimerval *itnew,
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
262 struct itimerval *itold);
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
263
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
264 #endif /* defined (WIN32_NATIVE) || defined (CYGWIN) */
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
265
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
266 /* #### Move this comment elsewhere when we figure out the place.
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
267
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
268 "qxe" is a unique prefix used to identify encapsulations of standard
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
269 library functions. We used to play pre-processing games but in
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
270 general this leads to nothing but trouble because someone first
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
271 encountering the code will have no idea that what appears to be a
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
272 call to a library function has actually been redefined to be a call
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
273 somewhere else. This is doubly true when the redefinition occurs
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
274 in out-of-the way s+m files and only on certainly systems.
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
275
617
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
276 The name "qxe" was chosen because it is a unique string that is not
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
277 going to be found anywhere else in the sources (unlike, for example,
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
278 the prefixes "xemacs" or "sys") and is easy to type. Alternative
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
279 names are certainly possible, and suggestions are welcome.
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
280
611
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
281 By making the encapsulation explicit we might be making the code
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
282 that uses is slightly less pretty, but this is more than compensated
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
283 for by the huge increase in clarity.
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
284
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
285 "Standard library function" can refer to any function in any
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
286 standard library. If we are explicitly changing the semantics
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
287 (e.g. Mule-encapsulating), we should use an extended version of
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
288 the prefix, e.g. perhaps "qxe_xlat_" for functions that Mule-
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
289 encapsulate, or "qxe_retry_" for functions that automatically
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
290 retry a system call interrupted by EINTR. In general, if there
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
291 is no prefix extension, it means the function is trying to
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
292 provide (more or less) the same semantics as the standard library
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
293 function; but be aware that the reimplementation may be incomplete
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
294 or differ in important respects. This is especially the case
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
295 when attempts are made to implement Unix functions on MS Windows.
617
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
296
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
297 (The comment on the particular encapsulation should describe what
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
298 standard function is being emulated, if this is not obvious, and
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
299 what the differences, if any, from that standard function are.)
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
300
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
301 An example of this is the qxe_setitimer() function. This attempts
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
302 to emulate the POSIX (Unix98?) standard setitimer(), as found on
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
303 all modern versions of Unix. Normally, we just call the system-
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
304 provided setitimer() function. When emulated on MS Windows and
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
305 Cygwin, however, the ITNEW and ITOLD values cannot be different
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
306 from each other if both are non-zero, due to limitations in the
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
307 underlying multimedia-timer API. By simply using setitimer() with
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
308 preprocessor tricks, a programmer would almost have to be a
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
309 mind-reader to figure this out. With the explicit encapsulation, a
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
310 programmer need only look at the definition of qxe_setitimer() to
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 611
diff changeset
311 see what its semantics are.
611
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
312 */
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
313
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
314 int qxe_setitimer (int kind, const struct itimerval *itnew,
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
315 struct itimerval *itold);
38db05db9cb5 [xemacs-hg @ 2001-06-08 12:21:09 by ben]
ben
parents: 592
diff changeset
316
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
317 #endif /* INCLUDED_systime_h_ */