]> pd.if.org Git - pdclib/blobdiff - includes/time.h
PDCLib includes with quotes, not <>.
[pdclib] / includes / time.h
index c527cc31b68003aa1c54a89e55228da5464a25ea..a2b659688cfa4bb661a553a671b8510296e93997 100644 (file)
@@ -1,45 +1,81 @@
-// ----------------------------------------------------------------------------
-// $Id$
-// ----------------------------------------------------------------------------
-// Public Domain C Library - http://pdclib.sourceforge.net
-// This code is Public Domain. Use, modify, and redistribute at will.
-// ----------------------------------------------------------------------------
-// Date and time
-// ----------------------------------------------------------------------------
+/* Date and time <time.h>
 
-#ifndef __TIME_H
-#define __TIME_H __TIME_H
+   This file is part of the Public Domain C Library (PDCLib).
+   Permission is granted to use, modify, and / or redistribute at will.
+*/
 
-// TODO: Documentation.
+#ifndef _PDCLIB_TIME_H
+#define _PDCLIB_TIME_H _PDCLIB_TIME_H
+#include "_PDCLIB_aux.h"
+#include "_PDCLIB_int.h"
 
-// ----------------------------------------------------------------------------
-// MACROS
+#ifdef __cplusplus
+extern "C" {
+#endif
 
-#include "__NULL.h"
+#ifndef _PDCLIB_SIZE_T_DEFINED
+#define _PDCLIB_SIZE_T_DEFINED _PDCLIB_SIZE_T_DEFINED
+typedef _PDCLIB_size_t size_t;
+#endif
 
-#define CLOCKS_PER_SEC // TODO - personality?
+#ifndef _PDCLIB_NULL_DEFINED
+#define _PDCLIB_NULL_DEFINED _PDCLIB_NULL_DEFINED
+#define NULL _PDCLIB_NULL
+#endif
 
-// ----------------------------------------------------------------------------
-// TYPES
+typedef _PDCLIB_time_t  time_t;
+typedef _PDCLIB_clock_t clock_t;
 
-#include "__size_t.h"
-#include "__tm.h"
+#define CLOCKS_PER_SEC _PDCLIB_CLOCKS_PER_SEC
+#define TIME_UTC _PDCLIB_TIME_UTC
 
-typedef clock_t; // TODO - personality?
-typedef time_t;  // TODO - personality?
+struct timespec
+{
+    time_t tv_sec;
+    long tv_nsec;
+};
 
-// ----------------------------------------------------------------------------
-// FUNCTIONS
+struct tm
+{
+    int tm_sec;   /* 0-60 */
+    int tm_min;   /* 0-59 */
+    int tm_hour;  /* 0-23 */
+    int tm_mday;  /* 1-31 */
+    int tm_mon;   /* 0-11 */
+    int tm_year;  /* years since 1900 */
+    int tm_wday;  /* 0-6 */
+    int tm_yday;  /* 0-365 */
+    int tm_isdst; /* >0 DST, 0 no DST, <0 information unavailable */
+};
 
-char * asctime( const struct tm * tptr );
-clock_t clock( void );
-char * ctime( const time_t * tod );
-double difftime( time_t t1, time_t t0 );
-struct tm * gmtime( const time_t * tod );
-struct tm * localtime( const time_t * tod );
-time_t mktime( struct tm * tptr );
-size_t strftime( char * restrict s, size_t n, const char * restrict format,
-                 const struct tm * restrict tptr );
-time_t time( time_t * tod );
+/* Returns the number of "clocks" in processor time since the invocation
+   of the program. Divide by CLOCKS_PER_SEC to get the value in seconds.
+   Returns -1 if the value cannot be represented in the return type or is
+   not available.
+*/
+clock_t clock( void ) _PDCLIB_nothrow;
 
-#endif // __TIME_H
+/* Returns the difference between two calendar times in seconds. */
+double difftime( time_t time1, time_t time0 ) _PDCLIB_nothrow;
+
+time_t mktime( struct tm * timeptr ) _PDCLIB_nothrow;
+
+time_t time( time_t * timer ) _PDCLIB_nothrow;
+
+int timespec_get( struct timespec * ts, int base ) _PDCLIB_nothrow;
+
+char * asctime( const struct tm * timeptr ) _PDCLIB_nothrow;
+
+char * ctime( const time_t * timer ) _PDCLIB_nothrow;
+
+struct tm * gmtime( const time_t * timer ) _PDCLIB_nothrow;
+
+struct tm * localtime( const time_t * timer ) _PDCLIB_nothrow;
+
+size_t strftime( char * _PDCLIB_restrict s, size_t maxsize, const char * _PDCLIB_restrict format, const struct tm * _PDCLIB_restrict timeptr );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif