Blame time/time.h

Packit 6c4009
/* Copyright (C) 1991-2018 Free Software Foundation, Inc.
Packit 6c4009
   This file is part of the GNU C Library.
Packit 6c4009
Packit 6c4009
   The GNU C Library is free software; you can redistribute it and/or
Packit 6c4009
   modify it under the terms of the GNU Lesser General Public
Packit 6c4009
   License as published by the Free Software Foundation; either
Packit 6c4009
   version 2.1 of the License, or (at your option) any later version.
Packit 6c4009
Packit 6c4009
   The GNU C Library is distributed in the hope that it will be useful,
Packit 6c4009
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 6c4009
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 6c4009
   Lesser General Public License for more details.
Packit 6c4009
Packit 6c4009
   You should have received a copy of the GNU Lesser General Public
Packit 6c4009
   License along with the GNU C Library; if not, see
Packit 6c4009
   <http://www.gnu.org/licenses/>.  */
Packit 6c4009
Packit 6c4009
/*
Packit 6c4009
 *	ISO C99 Standard: 7.23 Date and time	<time.h>
Packit 6c4009
 */
Packit 6c4009
Packit 6c4009
#ifndef	_TIME_H
Packit 6c4009
#define _TIME_H	1
Packit 6c4009
Packit 6c4009
#include <features.h>
Packit 6c4009
Packit 6c4009
#define __need_size_t
Packit 6c4009
#define __need_NULL
Packit 6c4009
#include <stddef.h>
Packit 6c4009
Packit 6c4009
/* This defines CLOCKS_PER_SEC, which is the number of processor clock
Packit 6c4009
   ticks per second, and possibly a number of other constants.   */
Packit 6c4009
#include <bits/time.h>
Packit 6c4009
Packit 6c4009
/* Many of the typedefs and structs whose official home is this header
Packit 6c4009
   may also need to be defined by other headers.  */
Packit 6c4009
#include <bits/types/clock_t.h>
Packit 6c4009
#include <bits/types/time_t.h>
Packit 6c4009
#include <bits/types/struct_tm.h>
Packit 6c4009
Packit 6c4009
#if defined __USE_POSIX199309 || defined __USE_ISOC11
Packit 6c4009
# include <bits/types/struct_timespec.h>
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#ifdef __USE_POSIX199309
Packit 6c4009
# include <bits/types/clockid_t.h>
Packit 6c4009
# include <bits/types/timer_t.h>
Packit 6c4009
# include <bits/types/struct_itimerspec.h>
Packit 6c4009
struct sigevent;
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#ifdef __USE_XOPEN2K
Packit 6c4009
# ifndef __pid_t_defined
Packit 6c4009
typedef __pid_t pid_t;
Packit 6c4009
#  define __pid_t_defined
Packit 6c4009
# endif
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#ifdef __USE_XOPEN2K8
Packit 6c4009
# include <bits/types/locale_t.h>
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#ifdef __USE_ISOC11
Packit 6c4009
/* Time base values for timespec_get.  */
Packit 6c4009
# define TIME_UTC 1
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
__BEGIN_DECLS
Packit 6c4009
Packit 6c4009
/* Time used by the program so far (user time + system time).
Packit 6c4009
   The result / CLOCKS_PER_SEC is program time in seconds.  */
Packit 6c4009
extern clock_t clock (void) __THROW;
Packit 6c4009
Packit 6c4009
/* Return the current time and put it in *TIMER if TIMER is not NULL.  */
Packit 6c4009
extern time_t time (time_t *__timer) __THROW;
Packit 6c4009
Packit 6c4009
/* Return the difference between TIME1 and TIME0.  */
Packit 6c4009
extern double difftime (time_t __time1, time_t __time0)
Packit 6c4009
     __THROW __attribute__ ((__const__));
Packit 6c4009
Packit 6c4009
/* Return the `time_t' representation of TP and normalize TP.  */
Packit 6c4009
extern time_t mktime (struct tm *__tp) __THROW;
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Format TP into S according to FORMAT.
Packit 6c4009
   Write no more than MAXSIZE characters and return the number
Packit 6c4009
   of characters written, or 0 if it would exceed MAXSIZE.  */
Packit 6c4009
extern size_t strftime (char *__restrict __s, size_t __maxsize,
Packit 6c4009
			const char *__restrict __format,
Packit 6c4009
			const struct tm *__restrict __tp) __THROW;
Packit 6c4009
Packit 6c4009
#ifdef __USE_XOPEN
Packit 6c4009
/* Parse S according to FORMAT and store binary time information in TP.
Packit 6c4009
   The return value is a pointer to the first unparsed character in S.  */
Packit 6c4009
extern char *strptime (const char *__restrict __s,
Packit 6c4009
		       const char *__restrict __fmt, struct tm *__tp)
Packit 6c4009
     __THROW;
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#ifdef __USE_XOPEN2K8
Packit 6c4009
/* Similar to the two functions above but take the information from
Packit 6c4009
   the provided locale and not the global locale.  */
Packit 6c4009
Packit 6c4009
extern size_t strftime_l (char *__restrict __s, size_t __maxsize,
Packit 6c4009
			  const char *__restrict __format,
Packit 6c4009
			  const struct tm *__restrict __tp,
Packit 6c4009
			  locale_t __loc) __THROW;
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#ifdef __USE_GNU
Packit 6c4009
extern char *strptime_l (const char *__restrict __s,
Packit 6c4009
			 const char *__restrict __fmt, struct tm *__tp,
Packit 6c4009
			 locale_t __loc) __THROW;
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Return the `struct tm' representation of *TIMER
Packit 6c4009
   in Universal Coordinated Time (aka Greenwich Mean Time).  */
Packit 6c4009
extern struct tm *gmtime (const time_t *__timer) __THROW;
Packit 6c4009
Packit 6c4009
/* Return the `struct tm' representation
Packit 6c4009
   of *TIMER in the local timezone.  */
Packit 6c4009
extern struct tm *localtime (const time_t *__timer) __THROW;
Packit 6c4009
Packit 6c4009
#ifdef __USE_POSIX
Packit 6c4009
/* Return the `struct tm' representation of *TIMER in UTC,
Packit 6c4009
   using *TP to store the result.  */
Packit 6c4009
extern struct tm *gmtime_r (const time_t *__restrict __timer,
Packit 6c4009
			    struct tm *__restrict __tp) __THROW;
Packit 6c4009
Packit 6c4009
/* Return the `struct tm' representation of *TIMER in local time,
Packit 6c4009
   using *TP to store the result.  */
Packit 6c4009
extern struct tm *localtime_r (const time_t *__restrict __timer,
Packit 6c4009
			       struct tm *__restrict __tp) __THROW;
Packit 6c4009
#endif	/* POSIX */
Packit 6c4009
Packit 6c4009
/* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
Packit 6c4009
   that is the representation of TP in this format.  */
Packit 6c4009
extern char *asctime (const struct tm *__tp) __THROW;
Packit 6c4009
Packit 6c4009
/* Equivalent to `asctime (localtime (timer))'.  */
Packit 6c4009
extern char *ctime (const time_t *__timer) __THROW;
Packit 6c4009
Packit 6c4009
#ifdef __USE_POSIX
Packit 6c4009
/* Reentrant versions of the above functions.  */
Packit 6c4009
Packit 6c4009
/* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
Packit 6c4009
   that is the representation of TP in this format.  */
Packit 6c4009
extern char *asctime_r (const struct tm *__restrict __tp,
Packit 6c4009
			char *__restrict __buf) __THROW;
Packit 6c4009
Packit 6c4009
/* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
Packit 6c4009
extern char *ctime_r (const time_t *__restrict __timer,
Packit 6c4009
		      char *__restrict __buf) __THROW;
Packit 6c4009
#endif	/* POSIX */
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Defined in localtime.c.  */
Packit 6c4009
extern char *__tzname[2];	/* Current timezone names.  */
Packit 6c4009
extern int __daylight;		/* If daylight-saving time is ever in use.  */
Packit 6c4009
extern long int __timezone;	/* Seconds west of UTC.  */
Packit 6c4009
Packit 6c4009
Packit 6c4009
#ifdef	__USE_POSIX
Packit 6c4009
/* Same as above.  */
Packit 6c4009
extern char *tzname[2];
Packit 6c4009
Packit 6c4009
/* Set time conversion information from the TZ environment variable.
Packit 6c4009
   If TZ is not defined, a locale-dependent default is used.  */
Packit 6c4009
extern void tzset (void) __THROW;
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#if defined __USE_MISC || defined __USE_XOPEN
Packit 6c4009
extern int daylight;
Packit 6c4009
extern long int timezone;
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#ifdef __USE_MISC
Packit 6c4009
/* Set the system time to *WHEN.
Packit 6c4009
   This call is restricted to the superuser.  */
Packit 6c4009
extern int stime (const time_t *__when) __THROW;
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Nonzero if YEAR is a leap year (every 4 years,
Packit 6c4009
   except every 100th isn't, and every 400th is).  */
Packit 6c4009
#define __isleap(year)	\
Packit 6c4009
  ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
Packit 6c4009
Packit 6c4009
Packit 6c4009
#ifdef __USE_MISC
Packit 6c4009
/* Miscellaneous functions many Unices inherited from the public domain
Packit 6c4009
   localtime package.  These are included only for compatibility.  */
Packit 6c4009
Packit 6c4009
/* Like `mktime', but for TP represents Universal Time, not local time.  */
Packit 6c4009
extern time_t timegm (struct tm *__tp) __THROW;
Packit 6c4009
Packit 6c4009
/* Another name for `mktime'.  */
Packit 6c4009
extern time_t timelocal (struct tm *__tp) __THROW;
Packit 6c4009
Packit 6c4009
/* Return the number of days in YEAR.  */
Packit 6c4009
extern int dysize (int __year) __THROW  __attribute__ ((__const__));
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
Packit 6c4009
#ifdef __USE_POSIX199309
Packit 6c4009
/* Pause execution for a number of nanoseconds.
Packit 6c4009
Packit 6c4009
   This function is a cancellation point and therefore not marked with
Packit 6c4009
   __THROW.  */
Packit 6c4009
extern int nanosleep (const struct timespec *__requested_time,
Packit 6c4009
		      struct timespec *__remaining);
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Get resolution of clock CLOCK_ID.  */
Packit 6c4009
extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
Packit 6c4009
Packit 6c4009
/* Get current value of clock CLOCK_ID and store it in TP.  */
Packit 6c4009
extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
Packit 6c4009
Packit 6c4009
/* Set clock CLOCK_ID to value TP.  */
Packit 6c4009
extern int clock_settime (clockid_t __clock_id, const struct timespec *__tp)
Packit 6c4009
     __THROW;
Packit 6c4009
Packit 6c4009
# ifdef __USE_XOPEN2K
Packit 6c4009
/* High-resolution sleep with the specified clock.
Packit 6c4009
Packit 6c4009
   This function is a cancellation point and therefore not marked with
Packit 6c4009
   __THROW.  */
Packit 6c4009
extern int clock_nanosleep (clockid_t __clock_id, int __flags,
Packit 6c4009
			    const struct timespec *__req,
Packit 6c4009
			    struct timespec *__rem);
Packit 6c4009
Packit 6c4009
/* Return clock ID for CPU-time clock.  */
Packit 6c4009
extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
Packit 6c4009
# endif
Packit 6c4009
Packit 6c4009
Packit 6c4009
/* Create new per-process timer using CLOCK_ID.  */
Packit 6c4009
extern int timer_create (clockid_t __clock_id,
Packit 6c4009
			 struct sigevent *__restrict __evp,
Packit 6c4009
			 timer_t *__restrict __timerid) __THROW;
Packit 6c4009
Packit 6c4009
/* Delete timer TIMERID.  */
Packit 6c4009
extern int timer_delete (timer_t __timerid) __THROW;
Packit 6c4009
Packit 6c4009
/* Set timer TIMERID to VALUE, returning old value in OVALUE.  */
Packit 6c4009
extern int timer_settime (timer_t __timerid, int __flags,
Packit 6c4009
			  const struct itimerspec *__restrict __value,
Packit 6c4009
			  struct itimerspec *__restrict __ovalue) __THROW;
Packit 6c4009
Packit 6c4009
/* Get current value of timer TIMERID and store it in VALUE.  */
Packit 6c4009
extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
Packit 6c4009
     __THROW;
Packit 6c4009
Packit 6c4009
/* Get expiration overrun for timer TIMERID.  */
Packit 6c4009
extern int timer_getoverrun (timer_t __timerid) __THROW;
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
Packit 6c4009
#ifdef __USE_ISOC11
Packit 6c4009
/* Set TS to calendar time based in time base BASE.  */
Packit 6c4009
extern int timespec_get (struct timespec *__ts, int __base)
Packit 6c4009
     __THROW __nonnull ((1));
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
Packit 6c4009
#ifdef __USE_XOPEN_EXTENDED
Packit 6c4009
/* Set to one of the following values to indicate an error.
Packit 6c4009
     1  the DATEMSK environment variable is null or undefined,
Packit 6c4009
     2  the template file cannot be opened for reading,
Packit 6c4009
     3  failed to get file status information,
Packit 6c4009
     4  the template file is not a regular file,
Packit 6c4009
     5  an error is encountered while reading the template file,
Packit 6c4009
     6  memory allication failed (not enough memory available),
Packit 6c4009
     7  there is no line in the template that matches the input,
Packit 6c4009
     8  invalid input specification Example: February 31 or a time is
Packit 6c4009
	specified that can not be represented in a time_t (representing
Packit 6c4009
	the time in seconds since 00:00:00 UTC, January 1, 1970) */
Packit 6c4009
extern int getdate_err;
Packit 6c4009
Packit 6c4009
/* Parse the given string as a date specification and return a value
Packit 6c4009
   representing the value.  The templates from the file identified by
Packit 6c4009
   the environment variable DATEMSK are used.  In case of an error
Packit 6c4009
   `getdate_err' is set.
Packit 6c4009
Packit 6c4009
   This function is a possible cancellation point and therefore not
Packit 6c4009
   marked with __THROW.  */
Packit 6c4009
extern struct tm *getdate (const char *__string);
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
#ifdef __USE_GNU
Packit 6c4009
/* Since `getdate' is not reentrant because of the use of `getdate_err'
Packit 6c4009
   and the static buffer to return the result in, we provide a thread-safe
Packit 6c4009
   variant.  The functionality is the same.  The result is returned in
Packit 6c4009
   the buffer pointed to by RESBUFP and in case of an error the return
Packit 6c4009
   value is != 0 with the same values as given above for `getdate_err'.
Packit 6c4009
Packit 6c4009
   This function is not part of POSIX and therefore no official
Packit 6c4009
   cancellation point.  But due to similarity with an POSIX interface
Packit 6c4009
   or due to the implementation it is a cancellation point and
Packit 6c4009
   therefore not marked with __THROW.  */
Packit 6c4009
extern int getdate_r (const char *__restrict __string,
Packit 6c4009
		      struct tm *__restrict __resbufp);
Packit 6c4009
#endif
Packit 6c4009
Packit 6c4009
__END_DECLS
Packit 6c4009
Packit 6c4009
#endif /* time.h.  */