source: trunk/Cocoa/Pester/Source/PSAlarms.m@ 105

Last change on this file since 105 was 105, checked in by Nicholas Riley, 22 years ago

PSAlarm.m: Fixed logic bug with invalid date/time combination. Added
repeating indicator to -description. Fixed plist archiving to
properly handle repeating alarms which expire while the app is quit
(1).

PSAlarmAlertController.m: Restore some debugging.

PSPowerManager.m: Properly return pmuReference (fixes compiler
warning, and 2).

Read Me.rtfd: Fixed some wording.

File size: 9.3 KB
Line 
1//
2// PSAlarms.m
3// Pester
4//
5// Created by Nicholas Riley on Fri Oct 11 2002.
6// Copyright (c) 2002 Nicholas Riley. All rights reserved.
7//
8
9#import "PSAlarms.h"
10#import "PSAlarm.h"
11#import "PSTimer.h"
12#import "NSDictionary-NJRExtensions.h"
13
14NSString * const PSAlarmImportException = @"PSAlarmImportException";
15
16NSString * const PSAlarmsDidChangeNotification = @"PSAlarmsDidChangeNotification";
17NSString * const PSAlarmsNextAlarmDidChangeNotification = @"PSAlarmsNextAlarmDidChangeNotification";
18
19// NSUserDefaults key
20static NSString * const PSPendingAlarms = @"Pester pending alarms"; // 1.0 Ð 1.1a3
21static NSString * const PSAllAlarms = @"Pester alarms"; // 1.1a4 Ð
22
23// property list keys
24static NSString * const PLAlarmsPending = @"pending";
25static NSString * const PLAlarmsExpired = @"expired";
26
27static PSAlarms *PSAlarmsAllAlarms = nil;
28
29@interface PSAlarms (Private)
30
31- (void)_updateNextAlarm;
32
33@end
34
35@implementation PSAlarms
36
37+ (void)setUp;
38{
39 [PSTimer setUp];
40 if (PSAlarmsAllAlarms == nil) {
41 NSDictionary *plAlarms = [[NSUserDefaults standardUserDefaults] objectForKey: PSAllAlarms];
42 if (plAlarms == nil) {
43 PSAlarmsAllAlarms = [[self alloc] init];
44 } else {
45 PSAlarmsAllAlarms = [[self alloc] initWithPropertyList: plAlarms];
46 }
47 [PSAlarmsAllAlarms _updateNextAlarm]; // only generate notifications after singleton established
48 }
49}
50
51+ (PSAlarms *)allAlarms;
52{
53 NSAssert(PSAlarmsAllAlarms != nil, @"Attempt to use +[PSAlarms allAlarms] before setup complete");
54 return PSAlarmsAllAlarms;
55}
56
57#pragma mark private
58
59- (void)_changed;
60{
61 NSMutableArray *alarmsData = [[NSMutableArray alloc] init];
62 NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
63 [self _updateNextAlarm];
64 // NSLog(@"PSAlarms _changed:\n%@", alarms);
65 [defaults setObject: [self propertyListRepresentation] forKey: PSAllAlarms];
66 [defaults synchronize];
67 [alarmsData release];
68 [[NSNotificationCenter defaultCenter] postNotificationName: PSAlarmsDidChangeNotification object: self];
69}
70
71- (void)_alarmTimerExpired:(NSNotification *)notification;
72{
73 PSAlarm *alarm = [notification object];
74 // NSLog(@"timer expired: %@ retainCount %d", alarm, [alarm retainCount]);
75 [expiredAlarms addObject: alarm];
76 // NSLog(@"expired alarms: %@", [expiredAlarms description]);
77 [alarms removeObject: alarm];
78 [self _changed];
79}
80
81- (void)_alarmTimerSet:(NSNotification *)notification;
82{
83 PSAlarm *alarm = [notification object];
84 // NSLog(@"timer set: %@ retainCount %d", alarm, [alarm retainCount]);
85 [alarms addObject: alarm];
86 [expiredAlarms removeObject: alarm];
87 [self _changed];
88}
89
90- (void)_alarmDied:(NSNotification *)notification;
91{
92 PSAlarm *alarm = [notification object];
93 // NSLog(@"alarm died: %@ retainCount %d", alarm, [alarm retainCount]);
94 [alarms removeObject: alarm];
95 [expiredAlarms removeObject: alarm];
96 [self _changed];
97}
98
99- (void)_updateNextAlarm;
100{
101 NSEnumerator *e;
102 PSAlarm *alarm, *oldNextAlarm = nextAlarm;
103 [nextAlarm release];
104 nextAlarm = nil;
105 // sort alarms so earliest is first
106 [alarms sortUsingSelector: @selector(compareDate:)];
107 // find first un-expired alarm
108 e = [alarms objectEnumerator];
109 while ( (alarm = [e nextObject]) != nil) {
110 if ([alarm isValid]) {
111 nextAlarm = [alarm retain];
112 break;
113 }
114 }
115 if (oldNextAlarm != nextAlarm)
116 [[NSNotificationCenter defaultCenter] postNotificationName: PSAlarmsNextAlarmDidChangeNotification object: nextAlarm];
117}
118
119- (void)_setUpNotifications;
120{
121 [[NSNotificationCenter defaultCenter] addObserver: self selector: @selector(_alarmTimerSet:) name: PSAlarmTimerSetNotification object: nil];
122 [[NSNotificationCenter defaultCenter] addObserver: self selector: @selector(_alarmTimerExpired:) name: PSAlarmTimerExpiredNotification object: nil];
123 [[NSNotificationCenter defaultCenter] addObserver: self selector: @selector(_alarmDied:) name: PSAlarmDiedNotification object: nil];
124}
125
126#pragma mark initialize-release
127
128- (id)init;
129{
130 if ( (self = [super init]) != nil) {
131 alarms = [[NSMutableArray alloc] init];
132 expiredAlarms = [[NSMutableSet alloc] init];
133 [self _setUpNotifications];
134 }
135 return self;
136}
137
138- (void)dealloc;
139{
140 [alarms release];
141 [expiredAlarms release];
142 [[NSNotificationCenter defaultCenter] removeObserver: self];
143 [super dealloc];
144}
145
146#pragma mark accessing
147
148- (NSArray *)alarms;
149{
150 return alarms;
151}
152
153- (PSAlarm *)nextAlarm;
154{
155 return nextAlarm;
156}
157
158- (int)alarmCount;
159{
160 return [alarms count];
161}
162
163- (PSAlarm *)alarmAtIndex:(int)index;
164{
165 return [alarms objectAtIndex: index];
166}
167
168- (void)removeAlarmAtIndex:(int)index;
169{
170 [(PSAlarm *)[alarms objectAtIndex: index] cancelTimer];
171 [alarms removeObjectAtIndex: index];
172}
173
174- (void)removeAlarmsAtIndices:(NSArray *)indices;
175{
176 NSEnumerator *e = [indices objectEnumerator];
177 NSNumber *n;
178 int indexCount = [indices count], i = 0, alarmIndex;
179 int *indexArray = (int *)malloc(indexCount * sizeof(int));
180 NS_DURING
181 while ( (n = [e nextObject]) != nil) {
182 alarmIndex = [n intValue];
183 [(PSAlarm *)[alarms objectAtIndex: alarmIndex] cancelTimer];
184 indexArray[i] = alarmIndex;
185 i++;
186 }
187 [alarms removeObjectsFromIndices: indexArray numIndices: indexCount];
188 free(indexArray); indexArray = NULL;
189 [self _changed];
190 NS_HANDLER
191 free(indexArray);
192 [self _changed];
193 [localException raise];
194 NS_ENDHANDLER
195}
196
197- (void)removeAlarms:(NSSet *)alarmsToRemove;
198{
199 NSEnumerator *e = [alarms objectEnumerator];
200 PSAlarm *alarm;
201 NSMutableArray *indices = [NSMutableArray arrayWithCapacity: [alarmsToRemove count]];
202 int alarmIndex = 0;
203
204 while ( (alarm = [e nextObject]) != nil) {
205 if ([alarmsToRemove containsObject: alarm])
206 [indices addObject: [NSNumber numberWithInt: alarmIndex]];
207 alarmIndex++;
208 }
209 [self removeAlarmsAtIndices: indices];
210}
211
212- (BOOL)alarmsExpiring;
213{
214 return [expiredAlarms count] != 0;
215}
216
217#pragma mark printing
218
219- (NSString *)description;
220{
221 return [NSString stringWithFormat: @"%@ pending %@\n%@\n",
222 [super description], alarms,
223 [expiredAlarms count] > 0 ? [NSString stringWithFormat: @"expired %@\n", expiredAlarms]
224 : @""];
225}
226
227#pragma mark property list serialization (Pester 1.1)
228
229- (NSDictionary *)propertyListRepresentation;
230{
231 NSMutableArray *plPendingAlarms = [[NSMutableArray alloc] initWithCapacity: [alarms count]];
232 NSMutableArray *plExpiredAlarms = [[NSMutableArray alloc] initWithCapacity: [expiredAlarms count]];
233 NSDictionary *plAllAlarms, *plAlarm;
234 NSEnumerator *e;
235 PSAlarm *alarm;
236
237 e = [alarms objectEnumerator];
238 while ( (alarm = [e nextObject]) != nil) {
239 plAlarm = [alarm propertyListRepresentation];
240 if (plAlarm != nil)
241 [plPendingAlarms addObject: plAlarm];
242 }
243
244 e = [expiredAlarms objectEnumerator];
245 while ( (alarm = [e nextObject]) != nil) {
246 plAlarm = [alarm propertyListRepresentation];
247 if (plAlarm != nil)
248 [plExpiredAlarms addObject: plAlarm];
249 }
250
251 plAllAlarms = [NSDictionary dictionaryWithObjectsAndKeys:
252 plPendingAlarms, PLAlarmsPending, plExpiredAlarms, PLAlarmsExpired, nil];
253 [plPendingAlarms release];
254 [plExpiredAlarms release];
255
256 return plAllAlarms;
257}
258
259- (id)initWithPropertyList:(NSDictionary *)dict;
260{
261 if ( (self = [super init]) != nil) {
262 NSArray *plPendingAlarms = [dict objectForRequiredKey: PLAlarmsPending];
263 NSArray *plExpiredAlarms = [dict objectForRequiredKey: PLAlarmsExpired];
264 NSEnumerator *e;
265 NSDictionary *plAlarm;
266 PSAlarm *alarm;
267
268 alarms = [[NSMutableArray alloc] initWithCapacity: [plPendingAlarms count]];
269 e = [plPendingAlarms objectEnumerator];
270 while ( (plAlarm = [e nextObject]) != nil) {
271 [alarms addObject: [[PSAlarm alloc] initWithPropertyList: plAlarm]];
272 }
273
274 e = [plExpiredAlarms objectEnumerator];
275 while ( (plAlarm = [e nextObject]) != nil) {
276 // expired alarms may be just that, or they may have outstanding repeats - if the latter, PSAlarm will reschedule the alarm.
277 if ( (alarm = [[PSAlarm alloc] initWithPropertyList: plAlarm]) != nil)
278 [alarms addObject: alarm];
279 }
280 expiredAlarms = [[NSMutableSet alloc] init];
281
282 [self _setUpNotifications];
283 }
284 return self;
285}
286
287#pragma mark archiving (Pester 1.0)
288
289- (unsigned)countOfVersion1Alarms;
290{
291 return [[[NSUserDefaults standardUserDefaults] objectForKey: PSPendingAlarms] count];
292}
293
294- (void)discardVersion1Alarms;
295{
296 NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
297 [defaults removeObjectForKey: PSPendingAlarms];
298 [defaults synchronize];
299}
300
301- (void)importVersion1Alarms;
302{
303 NSArray *alarmsData = [[NSUserDefaults standardUserDefaults] arrayForKey: PSPendingAlarms];
304 NSEnumerator *e = [alarmsData objectEnumerator];
305 NSData *alarmData;
306 PSAlarm *alarm;
307 while ( (alarmData = [e nextObject]) != nil) {
308 NS_DURING
309 alarm = [NSUnarchiver unarchiveObjectWithData: alarmData];
310 NS_HANDLER
311 alarm = nil;
312 // XXX
313 NS_ENDHANDLER
314 if (alarm != nil)
315 [alarms addObject: alarm];
316 }
317}
318
319@end
Note: See TracBrowser for help on using the repository browser.