source: trunk/Cocoa/Pester/Source/PSAlarmSetController.m@ 21

//
//  PSAlarmSetController.m
//  Pester
//
//  Created by Nicholas Riley on Tue Oct 08 2002.
//  Copyright (c) 2002 Nicholas Riley. All rights reserved.
//

#import "PSAlarmSetController.h"
#import "PSAlarmNotifierController.h"
#import "NJRDateFormatter.h"

// XXX Bugs to file:
// XXX any trailing spaces: -> exception for +[NSCalendarDate dateWithNaturalLanguageString]:
// > NSCalendarDate dateWithNaturalLanguageString: '12 '
// format error: internal error

// XXX NSDate natural language stuff in NSCalendarDate (why?), misspelled category name
// XXX NSCalendarDate natural language stuff behaves differently from NSDateFormatter (AM/PM has no effect, shouldn't they share code?)
// XXX NSDateFormatter doc class description gives two examples for natural language that are incorrect, no link to NSDate doc that describes exactly how natural language dates are parsed
// XXX NSTimeFormatString does not include %p when it should, meaning that AM/PM is stripped yet 12-hour time is still used
// XXX NSNextDayDesignations, NSNextNextDayDesignations are noted as 'a string' in NSUserDefaults docs, but maybe they are actually an array, or either an array or a string, given their names?
// XXX "Setting the Format for Dates" does not document how to get 1:15 AM, the answer is %1I - strftime has no exact equivalent; the closest is %l.  strftime does not permit numeric prefixes.  It also refers to "NSCalendar" when no such class exists.
// XXX none of many mentions of NSAMPMDesignation indicates that they include the leading spaces (" AM", " PM").  In "Setting the Format for Dates", needs to mention that the leading spaces are not included in %p with strftime.
// XXX descriptions for %X and %x are reversed (time zone is in %X, not %x)
// XXX too hard to implement date-only or time-only formatters
// XXX should be able to specify that natural language favors date or time (10 = 10th of month, not 10am)
// XXX please expose the iCal controls!


@implementation PSAlarmSetController

- (void)awakeFromNib;
{
    // NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    [[self window] center];
    // XXX bugs prevent these from working (sigh...)
    // [timeOfDay setFormatter: [[NJRDateFormatter alloc] initWithDateFormat: [defaults objectForKey: NSTimeFormatString] allowNaturalLanguage: YES]];
    // [timeDate setFormatter: [[NJRDateFormatter alloc] initWithDateFormat: [defaults objectForKey: NSShortDateFormatString] allowNaturalLanguage: YES]];
    [self inAtChanged: nil];
}

- (void)setStatus:(NSString *)aString;
{
    if (aString != status) {
        [status release]; status = nil;
        status = [aString retain];
        [timeSummary setStringValue: status];
    }
}

- (id)objectValueForTextField:(NSTextField *)field whileEditing:(id)sender;
{
    if (sender == field) {
        NSString *stringValue = [[[self window] fieldEditor: NO forObject: field] string];
        id obj = nil;
        [[field formatter] getObjectValue: &obj forString: stringValue errorDescription: NULL];
        // NSLog(@"from field editor: %@", obj);
        return obj;
    } else {
        // NSLog(@"from field: %@", [field objectValue]);
        return [field objectValue];
    }
}

- (void)setAlarmDateAndInterval:(id)sender;
{
    [alarmDate release];
    alarmDate = nil;
    alarmInterval = 0;
    if (isIn) {
        alarmInterval = [[self objectValueForTextField: timeInterval whileEditing: sender] intValue] * [timeIntervalUnits selectedTag];
        if (alarmInterval == 0) {
            [self setStatus: @"Please specify an alarm interval."]; return;
        }
        alarmDate = [NSCalendarDate dateWithTimeIntervalSinceNow: alarmInterval];
        [alarmDate retain];
    } else {
        NSDate *time = [self objectValueForTextField: timeOfDay whileEditing: sender];
        NSDate *date = [self objectValueForTextField: timeDate whileEditing: sender];
        NSCalendarDate *calTime, *calDate;
        if (time == nil && date == nil) {
            [self setStatus: @"Please specify an alarm date and time."]; return;
        }
        if (time == nil) {
            [self setStatus: @"Please specify an alarm time."]; return;
        }
        if (date == nil) {
            [self setStatus: @"Please specify an alarm date."]; return;
        }
        // XXX if calTime's date is different from the default date, complain
        calTime = [NSCalendarDate dateWithTimeIntervalSinceReferenceDate: [time timeIntervalSinceReferenceDate]];
        calDate = [NSCalendarDate dateWithTimeIntervalSinceReferenceDate: [date timeIntervalSinceReferenceDate]];
        if (time == nil || date == nil) {
            [self setStatus: @"Please specify a reasonable date and time."];
        }
        alarmDate = [[NSCalendarDate alloc] initWithYear: [calDate yearOfCommonEra]
                                                   month: [calDate monthOfYear]
                                                     day: [calDate dayOfMonth]
                                                    hour: [calTime hourOfDay]
                                                  minute: [calTime minuteOfHour]
                                                  second: [calTime secondOfMinute]
                                                timeZone: nil];
        alarmInterval = [alarmDate timeIntervalSinceNow];
        if (alarmInterval <= 0) {
            [self setStatus: @"Please specify an alarm time in the future."];
            [alarmDate release];
            alarmDate = nil;
            return;
        }
    }
}

// XXX should set timer to update status every second while configuration is valid, application is in front, and isIn

// XXX use OACalendar?

// Be careful not to hook up any of the text fields' actions to update: because we handle them in controlTextDidChange: instead.  If we could get the active text field somehow via public API (guess we could use controlTextDidBegin/controlTextDidEndEditing) then we'd not need to overload the update sender for this purpose.  Or, I guess, we could use another method other than update.  It should not be this hard to implement what is essentially standard behavior.  Sigh.

- (IBAction)update:(id)sender;
{
    // NSLog(@"update: %@", sender);
    [self setAlarmDateAndInterval: sender];
    if (alarmDate != nil) {
        [self setStatus: [alarmDate descriptionWithCalendarFormat: @"Alarm will be set for %X on %x" timeZone: nil locale: nil]];
        [setButton setEnabled: YES];
    } else {
        [setButton setEnabled: NO];
    }
}

- (IBAction)inAtChanged:(id)sender;
{
    isIn = ([inAtMatrix selectedTag] == 0);
    [timeInterval setEnabled: isIn];
    [timeIntervalUnits setEnabled: isIn];
    [timeOfDay setEnabled: !isIn];
    [timeDate setEnabled: !isIn];
    [timeDateCompletions setEnabled: !isIn];
    if (sender != nil)
        [[self window] makeFirstResponder: isIn ? timeInterval : timeOfDay];
    // NSLog(@"UPDATING FROM inAtChanged");
    [self update: nil];
}

- (void)control:(NSControl *)control didFailToValidatePartialString:(NSString *)string errorDescription:(NSString *)error;
{
    unichar c;
    int tag;
    unsigned length = [string length];
    if (control != timeInterval || length == 0) return;
    c = [string characterAtIndex: length - 1];
    switch (c) {
        case 's': case 'S': tag = 1; break;
        case 'm': case 'M': tag = 60; break;
        case 'h': case 'H': tag = 60 * 60; break;
        default: return;
    }
    [timeIntervalUnits selectItemAtIndex:
        [timeIntervalUnits indexOfItemWithTag: tag]];
    // NSLog(@"UPDATING FROM validation");
    [self update: timeInterval]; // make sure we still examine the field editor, otherwise if the existing numeric string is invalid, it'll be cleared
}

- (IBAction)dateCompleted:(NSPopUpButton *)sender;
{
    [timeDate setStringValue: [sender titleOfSelectedItem]];
}

// to ensure proper updating of interval, this should be the only method by which the window is shown (e.g. from the Alarm menu)
- (IBAction)showWindow:(id)sender;
{
    if (![[self window] isVisible]) {
        // NSLog(@"UPDATING FROM showWindow");
        [self update: self];
    }
    [super showWindow: sender];
    
}

- (IBAction)setAlarm:(NSButton *)sender;
{
    PSAlarmNotifierController *notifier = [PSAlarmNotifierController alloc];
    NSTimer *timer;
    [self setAlarmDateAndInterval: sender];
    if (notifier == nil || alarmDate == nil) {
        [self setStatus: @"Unable to set alarm (time just passed?)"];
        return;
    }
    // XXX should use alarm object instead for userInfo
    timer = [NSTimer scheduledTimerWithTimeInterval: alarmInterval
                                             target: notifier
                                           selector: @selector(initWithTimer:)
                                           userInfo: [messageField stringValue]
                                            repeats: NO];
    [self setStatus: [alarmDate descriptionWithCalendarFormat: @"Alarm set for %x at %X" timeZone: nil locale: nil]];
    [[self window] close];
}

// called because we're the delegate

- (void)controlTextDidChange:(NSNotification *)notification;
{
    // NSLog(@"UPDATING FROM controlTextDidChange");
    [self update: [notification object]];
}

@end