35365620e4
Use a more-functional style in timefns.c, rather than passing pointers to objects that are filled in. Although this does not change behavior, it should help future improvements to the code. * src/keyboard.c (decode_timer): Return a possibly-invalid struct timespec instead of storing a timespec into a location specified by an arg, and returning bool. All callers changed. * src/systime.h (struct lisp_time): Move from here to src/timefns.c, since the type is private to timefns.c. * src/timefns.c (decode_float_time, decode_ticks_hz): Return timestamp instead of storing it into a location specified by an arg. All callers changed. (enum cform, union c_time, struct err_time, struct form_time): New types, to aid functional style. (decode_time_components): Return struct err_time instead of returning err and storing timestamp into a location specified by an arg. New arg cform. All callers changed. (decode_lisp_time): Return struct form_time instead of returning form and storing timestamp into a location specified by an arg. New arg cform, replacing decode_secs_only. All callers changed. (list4_to_timespec): Return possibly-invalid timestamp instead of returning a bool and storing timestamp into a location specified by an arg. All callers changed. (lisp_time_struct): Omit no-longer-needed arg PFORM. All callers changed.
94 lines
2.8 KiB
C
94 lines
2.8 KiB
C
/* systime.h - System-dependent definitions for time manipulations.
|
||
Copyright (C) 1993-1994, 2002-2024 Free Software Foundation, Inc.
|
||
|
||
This file is part of GNU Emacs.
|
||
|
||
GNU Emacs is free software: you can redistribute it and/or modify
|
||
it under the terms of the GNU General Public License as published by
|
||
the Free Software Foundation, either version 3 of the License, or (at
|
||
your option) any later version.
|
||
|
||
GNU Emacs is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License
|
||
along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
|
||
|
||
#ifndef EMACS_SYSTIME_H
|
||
#define EMACS_SYSTIME_H
|
||
|
||
#include "lisp.h"
|
||
#include <timespec.h>
|
||
|
||
INLINE_HEADER_BEGIN
|
||
|
||
#ifdef HAVE_X_WINDOWS
|
||
# include <X11/X.h>
|
||
#elif defined HAVE_HAIKU
|
||
# include <support/SupportDefs.h>
|
||
typedef int64 Time;
|
||
#else
|
||
typedef unsigned long Time;
|
||
#endif
|
||
|
||
/* On some configurations (hpux8.0, X11R4), sys/time.h and X11/Xos.h
|
||
disagree about the name of the guard symbol. */
|
||
#ifdef HPUX
|
||
#ifdef _STRUCT_TIMEVAL
|
||
#ifndef __TIMEVAL__
|
||
#define __TIMEVAL__
|
||
#endif
|
||
#endif
|
||
#endif
|
||
|
||
#include <sys/time.h> /* for 'struct timeval' */
|
||
|
||
#undef hz /* AIX <sys/param.h> #defines this. */
|
||
|
||
/* Emacs uses struct timespec to represent nonnegative temporal intervals.
|
||
|
||
WARNING: Since tv_sec might be an unsigned value, do not use struct
|
||
timespec as a general-purpose data type for adding or subtracting
|
||
arbitrary time values! When computing A + B or A - B, typically A
|
||
should be an absolute time since the epoch and B a nonnegative offset. */
|
||
|
||
/* Return an invalid timespec. */
|
||
INLINE struct timespec
|
||
invalid_timespec (void)
|
||
{
|
||
return make_timespec (0, -1);
|
||
}
|
||
|
||
/* Return true if TIME is a valid timespec. This currently doesn't worry
|
||
about whether tv_nsec is less than TIMESPEC_HZ; leap seconds might
|
||
cause a problem if it did. */
|
||
INLINE bool
|
||
timespec_valid_p (struct timespec t)
|
||
{
|
||
return t.tv_nsec >= 0;
|
||
}
|
||
|
||
/* defined in keyboard.c */
|
||
extern void set_waiting_for_input (struct timespec *);
|
||
|
||
/* Emacs uses the integer list (HI LO US PS) to represent the time
|
||
(HI << LO_TIME_BITS) + LO + US / 1e6 + PS / 1e12. */
|
||
enum { LO_TIME_BITS = 16 };
|
||
|
||
/* defined in timefns.c */
|
||
extern struct timeval make_timeval (struct timespec) ATTRIBUTE_CONST;
|
||
extern Lisp_Object make_lisp_time (struct timespec);
|
||
extern Lisp_Object timespec_to_lisp (struct timespec);
|
||
extern struct timespec list4_to_timespec (Lisp_Object, Lisp_Object,
|
||
Lisp_Object, Lisp_Object);
|
||
extern struct timespec lisp_time_argument (Lisp_Object);
|
||
extern double float_time (Lisp_Object);
|
||
extern void init_timefns (void);
|
||
extern void syms_of_timefns (void);
|
||
|
||
INLINE_HEADER_END
|
||
|
||
#endif /* EMACS_SYSTIME_H */
|