ObjFW  Check-in [c084907c2c]

Overview
Comment:Multiple OFDate changes.

* Don't expose time_t to the user.
* Use better return types for -[minute] etc.
* Add +[dateWithTimeIntervalSinceNow:].
* Add -[dateByAddingTimeInterval:].

Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: c084907c2ce5281d8ca372abccf750055652597d5342945d1890e88010e93ac1
User & Date: js on 2011-01-01 16:12:03
Other Links: manifest | tags
Context
2011-01-01
16:33
Makefile: Show in which files the version needs to be updated. check-in: ca6b476809 user: js tags: trunk
16:12
Multiple OFDate changes. check-in: c084907c2c user: js tags: trunk
14:58
Add +[distantFuture] and +[distantPast] to OFDate. check-in: c57f9fe4fb user: js tags: trunk
Changes

Modified src/OFDate.h from [3a80b7e602] to [5536148640].

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
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
161

162
163
164
165
166

167
168
169
170
171

172
173
174
175
176

177
178
179
180
181
182
183
184











-
-




-
-
-
-
-
-
-
-





-
-
+
+











-
+






-
-
+
+


+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





+
+










-
+








-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+







/*
 * Copyright (c) 2008 - 2010
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE included in
 * the packaging of this file.
 */

#include <sys/time.h>

#import "OFObject.h"

@class OFString;

#ifdef __MINGW32__
/*
 * They think they don't need suseconds_t and can use long instead in
 * struct timeval... POSIX demands suseconds_t, of course.
 */
typedef long suseconds_t;
#endif

/**
 * \brief A class for storing, accessing and comparing dates.
 */
@interface OFDate: OFObject <OFCopying, OFComparing>
{
	time_t sec;
	suseconds_t usec;
	int64_t sec;
	uint32_t usec;
}

/**
 * \return A new, autoreleased OFDate with the current date and time
 */
+ date;

/**
 * \param sec The seconds since 1970-01-01 00:00:00
 * \return A new, autoreleased OFDate with the specified date and time
 */
+ dateWithTimeIntervalSince1970: (time_t)sec;
+ dateWithTimeIntervalSince1970: (int64_t)sec;

/**
 * \param sec The seconds since 1970-01-01 00:00:00
 * \param usec The microsecond part of the time
 * \return A new, autoreleased OFDate with the specified date and time
 */
+ dateWithTimeIntervalSince1970: (time_t)sec
		   microseconds: (suseconds_t)usec;
+ dateWithTimeIntervalSince1970: (int64_t)sec
		   microseconds: (uint32_t)usec;

/**
 * \param sec The seconds since now
 * \return A new, autoreleased OFDate with the specified date and time
 */
+ dateWithTimeIntervalSinceNow: (int64_t)sec;

/**
 * \param sec The seconds since now
 * \param usec The microsecond part of the time
 * \return A new, autoreleased OFDate with the specified date and time
 */
+ dateWithTimeIntervalSinceNow: (int64_t)sec
		  microseconds: (uint32_t)usec;

/**
 * Returns a date in the distant future. The date is system-dependant.
 *
 * \return A date in the distant future
 */
+ distantFuture;

/**
 * Returns a date in the distant past. The date is system-dependant.
 *
 * \return A date in the distant past
 */
+ distantPast;

/**
 * Initializes an already allocated OFDate with the specified date and time.
 *
 * \param sec The seconds since 1970-01-01 00:00:00
 * \return An initialized OFDate with the specified date and time
 */
- initWithTimeIntervalSince1970: (time_t)sec;
- initWithTimeIntervalSince1970: (int64_t)sec;

/**
 * Initializes an already allocated OFDate with the specified date and time.
 *
 * \param sec The seconds since 1970-01-01 00:00:00
 * \param usec The microsecond part of the time
 * \return An initialized OFDate with the specified date and time
 */
- initWithTimeIntervalSince1970: (time_t)sec
		   microseconds: (suseconds_t)usec;
- initWithTimeIntervalSince1970: (int64_t)sec
		   microseconds: (uint32_t)usec;

/**
 * Initializes an already allocated OFDate with the specified date and time.
 *
 * \param sec The seconds since now
 * \param usec The microsecond part of the time
 * \return A new, autoreleased OFDate with the specified date and time
 */
- initWithTimeIntervalSinceNow: (int64_t)sec;

/**
 * Initializes an already allocated OFDate with the specified date and time.
 *
 * \param sec The seconds since now
 * \param usec The microsecond part of the time
 * \return A new, autoreleased OFDate with the specified date and time
 */
- initWithTimeIntervalSinceNow: (int64_t)sec
		  microseconds: (uint32_t)usec;

/**
 * \return The microsecond of the date
 */
- (suseconds_t)microsecond;
- (uint32_t)microsecond;

/**
 * \return The seconds of the date
 */
- (int)second;
- (uint8_t)second;

/**
 * \return The minute of the date
 */
- (int)minute;
- (uint8_t)minute;

/**
 * \return The hour of the date
 */
- (int)hour;
- (uint8_t)hour;

/**
 * \return The hour of the date in local time
 */
- (int)localHour;
- (uint8_t)localHour;

/**
 * \return The day of the month of the date
 */
- (int)dayOfMonth;
- (uint8_t)dayOfMonth;

/**
 * \return The day of the month of the date in local time
 */
- (int)localDayOfMonth;
- (uint8_t)localDayOfMonth;

/**
 * \return The month of the year of the date
 */
- (int)monthOfYear;
- (uint8_t)monthOfYear;

/**
 * \return The month of the year of the date in local time
 */
- (int)localMonthOfYear;
- (uint8_t)localMonthOfYear;

/**
 * \return The year of the date
 */
- (int)year;
- (uint16_t)year;

/**
 * \return The day of the week of the date
 */
- (int)dayOfWeek;
- (uint8_t)dayOfWeek;

/**
 * \return The day of the week of the date in local time
 */
- (int)localDayOfWeek;
- (uint8_t)localDayOfWeek;

/**
 * \return The day of the year of the date
 */
- (int)dayOfYear;
- (uint16_t)dayOfYear;

/**
 * \return The day of the year of the date in local time
 */
- (int)localDayOfYear;
- (uint16_t)localDayOfYear;

/**
 * Creates a string of the date with the specified format.
 *
 * See the manpage for strftime for information on the format.
 *
 * \param fmt The format for the date string
176
177
178
179
180
181
182


















183
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228







+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

- (OFDate*)earlierDate: (OFDate*)date;

/**
 * \param date Another date
 * \return The later date of the two dates
 */
- (OFDate*)laterDate: (OFDate*)date;

/**
 * Returns a new date with the specified time interval added.
 *
 * \param sec The seconds after the date
 * \return A new, autoreleased OFDate
 */
- (OFDate*)dateByAddingTimeInterval: (int64_t)sec;

/**
 * Returns a new date with the specified time interval added.
 *
 * \param sec The seconds after the date
 * \param usec The microseconds after the date
 * \return A new, autoreleased OFDate
 */
- (OFDate*)dateByAddingTimeInterval: (int64_t)sec
		   withMicroseconds: (uint32_t)usec;
@end

Modified src/OFDate.m from [ba324e05e2] to [a3f6814aa0].

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
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







+


+
+
+
-
+




+


+
+
+
-
+






+


+
+
+



-
+







+


+
+
+



-
+








+


+
+
+
-
+




+


+
+
+
-
+







# import "OFThread.h"

static OFMutex *mutex;
#endif

#ifdef HAVE_GMTIME_R
# define GMTIME_RET(field)						  \
	time_t sec_ = sec;						  \
	struct tm tm;							  \
									  \
	if (sec != sec_)						  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	if (gmtime_r(&sec, &tm) == NULL)				  \
	if (gmtime_r(&sec_, &tm) == NULL)				  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	return tm.field;
# define LOCALTIME_RET(field)						  \
	time_t sec_ = sec;						  \
	struct tm tm;							  \
									  \
	if (sec != sec_)						  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	if (localtime_r(&sec, &tm) == NULL)				  \
	if (localtime_r(&sec_, &tm) == NULL)				  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	return tm.field;
#else
# ifdef OF_THREADS
#  define GMTIME_RET(field)						  \
	time_t sec_ = sec;						  \
	struct tm *tm;							  \
									  \
	if (sec != sec_)						  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	[mutex lock];							  \
									  \
	@try {								  \
		if ((tm = gmtime(&sec)) == NULL)			  \
		if ((tm = gmtime(&sec_)) == NULL)			  \
			@throw [OFOutOfRangeException newWithClass: isa]; \
									  \
		return tm->field;					  \
	} @finally {							  \
		[mutex unlock];						  \
	}
#  define LOCALTIME_RET(field)						  \
	time_t sec_ = sec;						  \
	struct tm *tm;							  \
									  \
	if (sec != sec_)						  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	[mutex lock];							  \
									  \
	@try {								  \
		if ((tm = localtime(&sec)) == NULL)			  \
		if ((tm = localtime(&sec_)) == NULL)			  \
			@throw [OFOutOfRangeException newWithClass: isa]; \
									  \
		return tm->field;					  \
	} @finally {							  \
		[mutex unlock];						  \
	}
# else
#  define GMTIME_RET(field)						  \
	time_t sec_ = sec;						  \
	struct tm *tm;							  \
									  \
	if (sec != sec_)						  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	if ((tm = gmtime(&sec)) == NULL)				  \
	if ((tm = gmtime(&sec_)) == NULL)				  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	return tm->field;
#  define LOCALTIME_RET(field)						  \
	time_t sec_ = sec;						  \
	struct tm *tm;							  \
									  \
	if (sec != sec_)						  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	if ((tm = localtime(&sec)) == NULL)				  \
	if ((tm = localtime(&sec_)) == NULL)				  \
		@throw [OFOutOfRangeException newWithClass: isa];	  \
									  \
	return tm->field;
# endif
#endif

@implementation OFDate
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
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
161
162
163

164
165
166
167
168

169
170
171
172
173
174
175
176
177







-
+




-
-
+
+




+
+
+
+
+
+
+
+
+
+
+
+





-
+
+


-
+
+



-
+
+







#endif

+ date
{
	return [[[self alloc] init] autorelease];
}

+ dateWithTimeIntervalSince1970: (time_t)sec
+ dateWithTimeIntervalSince1970: (int64_t)sec
{
	return [[[self alloc] initWithTimeIntervalSince1970: sec] autorelease];
}

+ dateWithTimeIntervalSince1970: (time_t)sec
		   microseconds: (suseconds_t)usec
+ dateWithTimeIntervalSince1970: (int64_t)sec
		   microseconds: (uint32_t)usec
{
	return [[[self alloc] initWithTimeIntervalSince1970: sec
					       microseconds: usec] autorelease];
}

+ dateWithTimeIntervalSinceNow: (int64_t)sec
{
	return [[[self alloc] initWithTimeIntervalSinceNow: sec] autorelease];
}

+ dateWithTimeIntervalSinceNow: (int64_t)sec
		  microseconds: (uint32_t)usec
{
	return [[[self alloc] initWithTimeIntervalSinceNow: sec
					      microseconds: usec] autorelease];
}

+ distantFuture
{
	if (sizeof(time_t) == sizeof(int64_t))
		return [[[self alloc]
		    initWithTimeIntervalSince1970: INT64_MAX] autorelease];
		    initWithTimeIntervalSince1970: INT64_MAX
				     microseconds: 999999] autorelease];
	if (sizeof(time_t) == sizeof(int32_t))
		return [[[self alloc]
		    initWithTimeIntervalSince1970: INT32_MAX] autorelease];
		    initWithTimeIntervalSince1970: INT32_MAX
				     microseconds: 999999] autorelease];

	/* Neither 64 nor 32 bit. But it's guaranteed to be at least an int */
	return [[[self alloc]
	    initWithTimeIntervalSince1970: INT_MAX] autorelease];
	    initWithTimeIntervalSince1970: INT_MAX
			     microseconds: 999999] autorelease];
}

+ distantPast
{
	/* We don't know if time_t is signed or unsigned. Use 0 to be safe */
	return [[[self alloc] initWithTimeIntervalSince1970: 0] autorelease];
}
147
148
149
150
151
152
153
154

155
156
157
158
159
160
161


162
163
164
165
166






















167
168
169
170
171
172
173
186
187
188
189
190
191
192

193
194
195
196
197
198


199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234







-
+





-
-
+
+





+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+







		@throw [OFInitializationFailedException newWithClass: c];
	}

	return [self initWithTimeIntervalSince1970: t.tv_sec
				      microseconds: t.tv_usec];
}

- initWithTimeIntervalSince1970: (time_t)sec_
- initWithTimeIntervalSince1970: (int64_t)sec_
{
	return [self initWithTimeIntervalSince1970: sec_
				      microseconds: 0];
}

- initWithTimeIntervalSince1970: (time_t)sec_
		   microseconds: (suseconds_t)usec_
- initWithTimeIntervalSince1970: (int64_t)sec_
		   microseconds: (uint32_t)usec_
{
	self = [super init];

	sec = sec_;
	usec = usec_;

	return self;
}

- initWithTimeIntervalSinceNow: (int64_t)sec_
{
	return [self initWithTimeIntervalSinceNow: sec_
				     microseconds: 0];
}

- initWithTimeIntervalSinceNow: (int64_t)sec_
		  microseconds: (uint32_t)usec_
{
	self = [self init];

	sec += sec_;
	usec += usec_;

	while (usec > 999999) {
		usec -= 999999;
		sec++;
	}

	return self;
}

- (BOOL)isEqual: (id)obj
{
	if (![obj isKindOfClass: [OFDate class]])
203
204
205
206
207
208
209
210

211
212
213
214
215

216
217
218
219
220

221
222
223
224
225

226
227
228
229
230

231
232
233
234
235

236
237
238
239
240

241
242
243
244
245

246
247
248
249
250

251
252
253
254
255

256
257
258
259
260

261
262
263
264
265

266
267
268
269
270

271
272
273
274
275

276
277
278
279
280
281

282
283
284



285
286

287
288
289
290
291
292
293
264
265
266
267
268
269
270

271
272
273
274
275

276
277
278
279
280

281
282
283
284
285

286
287
288
289
290

291
292
293
294
295

296
297
298
299
300

301
302
303
304
305

306
307
308
309
310

311
312
313
314
315

316
317
318
319
320

321
322
323
324
325

326
327
328
329
330

331
332
333
334
335

336
337
338
339
340
341
342
343
344
345
346
347
348
349
350

351
352
353
354
355
356
357
358







-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+




-
+






+



+
+
+

-
+







}

- (OFString*)description
{
	return [self dateStringWithFormat: @"%Y-%m-%dT%H:%M:%SZ"];
}

- (suseconds_t)microsecond
- (uint32_t)microsecond
{
	return usec;
}

- (int)second
- (uint8_t)second
{
	GMTIME_RET(tm_sec)
}

- (int)minute
- (uint8_t)minute
{
	GMTIME_RET(tm_min)
}

- (int)hour
- (uint8_t)hour
{
	GMTIME_RET(tm_hour)
}

- (int)localHour
- (uint8_t)localHour
{
	LOCALTIME_RET(tm_hour)
}

- (int)dayOfMonth
- (uint8_t)dayOfMonth
{
	GMTIME_RET(tm_mday)
}

- (int)localDayOfMonth
- (uint8_t)localDayOfMonth
{
	LOCALTIME_RET(tm_mday)
}

- (int)monthOfYear
- (uint8_t)monthOfYear
{
	GMTIME_RET(tm_mon + 1)
}

- (int)localMonthOfYear
- (uint8_t)localMonthOfYear
{
	LOCALTIME_RET(tm_mon + 1)
}

- (int)year
- (uint16_t)year
{
	GMTIME_RET(tm_year + 1900)
}

- (int)dayOfWeek
- (uint8_t)dayOfWeek
{
	GMTIME_RET(tm_wday)
}

- (int)localDayOfWeek
- (uint8_t)localDayOfWeek
{
	LOCALTIME_RET(tm_wday)
}

- (int)dayOfYear
- (uint16_t)dayOfYear
{
	GMTIME_RET(tm_yday + 1)
}

- (int)localDayOfYear
- (uint16_t)localDayOfYear
{
	LOCALTIME_RET(tm_yday + 1)
}

- (OFString*)dateStringWithFormat: (OFString*)fmt
{
	time_t sec_ = sec;
	struct tm tm;
	char *buf;

	if (sec != sec_)
		@throw [OFOutOfRangeException newWithClass: isa];

#ifdef HAVE_GMTIME_R
	if (gmtime_r(&sec, &tm) == NULL)
	if (gmtime_r(&sec_, &tm) == NULL)
		@throw [OFOutOfRangeException newWithClass: isa];
#else
# ifdef OF_THREADS
	[mutex lock];

	@try {
# endif
314
315
316
317
318
319
320

321
322
323



324
325

326
327
328
329
330
331
332
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393

394
395
396
397
398
399
400
401







+



+
+
+

-
+







	} @finally {
		[self freeMemory: buf];
	}
}

- (OFString*)localDateStringWithFormat: (OFString*)fmt
{
	time_t sec_ = sec;
	struct tm tm;
	char *buf;

	if (sec != sec_)
		@throw [OFOutOfRangeException newWithClass: isa];

#ifdef HAVE_LOCALTIME_R
	if (localtime_r(&sec, &tm) == NULL)
	if (localtime_r(&sec_, &tm) == NULL)
		@throw [OFOutOfRangeException newWithClass: isa];
#else
# ifdef OF_THREADS
	[mutex lock];

	@try {
# endif
366
367
368
369
370
371
372





















373
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463







+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

- (OFDate*)laterDate: (OFDate*)date
{
	if ([self compare: date] == OF_ORDERED_ASCENDING)
		return [[date retain] autorelease];

	return [[self retain] autorelease];
}

- (OFDate*)dateByAddingTimeInterval: (int64_t)sec_
{
	return [self dateByAddingTimeInterval: sec_
			     withMicroseconds: 0];
}

- (OFDate*)dateByAddingTimeInterval: (int64_t)sec_
		   withMicroseconds: (uint32_t)usec_
{
	sec_ += sec;
	usec_ += usec;

	while (usec_ > 999999) {
		usec_ -= 999999;
		sec_++;
	}

	return [OFDate dateWithTimeIntervalSince1970: sec_
					microseconds: usec_];
}
@end