summaryrefslogtreecommitdiff
path: root/include/apr_time.h
blob: 271508ceaa2b9032f1a91dc0b06b0027b7c20abf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

#ifndef APR_TIME_H
#define APR_TIME_H

#include "apr_general.h"
#include "apr_errno.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

API_VAR_IMPORT const char ap_month_snames[12][4];
API_VAR_IMPORT const char ap_day_snames[7][4];

/* number of microseconds since 00:00:00 january 1, 1970 UTC */
typedef ap_int64_t ap_time_t;

#ifdef WIN32
#define AP_USEC_PER_SEC ((LONGLONG) 1000000)
#else
/* XXX: this is wrong -- the LL is only required if int64 is implemented as
 * a long long, it could be just a long on some platforms.  the C99
 * correct way of doing this is to use INT64_C(1000000) which comes
 * from stdint.h.  we'd probably be doing a Good Thing to check for
 * INT64_C in autoconf... or otherwise define an AP_INT64_C(). -dean
 */
#define AP_USEC_PER_SEC (1000000LL)
#endif

/* ***APRDOC********************************************************
 * ap_time_t ap_now(void)
 *    return the current time
 */
ap_time_t ap_now(void);

/* a structure similar to ANSI struct tm with the following differences:
   - tm_usec isn't an ANSI field
   - tm_gmtoff isn't an ANSI field (it's a bsdism)
*/
typedef struct {
    ap_int32_t tm_usec;	/* microseconds past tm_sec */
    ap_int32_t tm_sec;	/* (0-61) seconds past tm_min */
    ap_int32_t tm_min;  /* (0-59) minutes past tm_hour */
    ap_int32_t tm_hour; /* (0-23) hours past midnight */
    ap_int32_t tm_mday; /* (1-31) day of the month */
    ap_int32_t tm_mon;  /* (0-11) month of the year */
    ap_int32_t tm_year; /* year since 1900 */
    ap_int32_t tm_wday; /* (0-6) days since sunday */
    ap_int32_t tm_yday; /* (0-365) days since jan 1 */
    ap_int32_t tm_isdst; /* daylight saving time */
    ap_int32_t tm_gmtoff; /* seconds east of UTC */
} ap_exploded_time_t;

/* ***APRDOC********************************************************
 * ap_status_t ap_ansi_time_to_ap_time(ap_time_t *result, time_t input)
 *    convert an ansi time_t to an ap_time_t
 * arg 1) the resulting ap_time_t
 * arg 2) the time_t to convert
 */
ap_status_t ap_ansi_time_to_ap_time(ap_time_t *result, time_t input);

/* ***APRDOC********************************************************
 * ap_status_t ap_explode_gmt(ap_exploded_time_t *result, ap_time_t input)
 *   convert a time to its human readable components in GMT timezone
 * arg 1) the exploded time
 * arg 2) the time to explode
 */
ap_status_t ap_explode_gmt(ap_exploded_time_t *result, ap_time_t input);

/* ***APRDOC********************************************************
 * ap_status_t ap_explode_localtime(ap_exploded_time_t *result, ap_time_t input)
 *   convert a time to its human readable components in local timezone
 * arg 1) the exploded time
 * arg 2) the time to explode
 */
ap_status_t ap_explode_localtime(ap_exploded_time_t *result, ap_time_t input);

/* ***APRDOC********************************************************
 * ap_status_t ap_implode_time(ap_time_t *t, ap_exploded_time_t *xt)
 *    Convert time value from human readable format to number of seconds 
 *    since epoch
 * arg 1) the resulting imploded time
 * arg 2) the input exploded time
 */
ap_status_t ap_implode_time(ap_time_t *result, ap_exploded_time_t *input);

/* ap_rfc822_date formats dates in the RFC822
   format in an efficient manner.  it is a fixed length
   format and requires the indicated amount of storage
   including trailing \0 */
#define AP_RFC822_DATE_LEN (30)
ap_status_t ap_rfc822_date(char *date_str, ap_time_t t);

/* ap_ctime formats dates in the ctime() format
   in an efficient manner.  it is a fixed length format
   and requires the indicated amount of storage
   including trailing \0 */
#define AP_CTIME_LEN (25)
ap_status_t ap_ctime(char *date_str, ap_time_t t);

ap_status_t ap_strftime(char *s, ap_size_t *retsize, ap_size_t max, const char *format, ap_exploded_time_t *tm);

#ifdef __cplusplus
}
#endif

#endif  /* ! APR_TIME_H */