darling-cocotron/AppKit/NSTextField.m

/* Copyright (c) 2006-2007 Christopher J. W. Lloyd

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
#import "NSKeyValueBinding/NSObject+BindingSupport.h"
#import "NSKeyValueBinding/NSTextFieldBinder.h"
#import <AppKit/NSApplication.h>
#import <AppKit/NSCursor.h>
#import <AppKit/NSDragging.h>
#import <AppKit/NSPasteboard.h>
#import <AppKit/NSTextField.h>
#import <AppKit/NSTextFieldCell.h>
#import <AppKit/NSTextStorage.h>
#import <AppKit/NSTextView.h>
#import <AppKit/NSWindow.h>

@interface NSTextFieldCell (Private)

- (CGFloat) _fontSize;
- (void) _setFontSize: (CGFloat) fontSize;
- (NSString *) _fontFamilyName;
- (void) _setFontFamilyName: (NSString *) familyName;

@end

@implementation NSTextField

+ (Class) cellClass {
    return [NSTextFieldCell class];
}

+ (Class) _binderClassForBinding: (id) binding {
    if ([binding isEqual: @"value"])
        return [_NSTextFieldBinder class];
    else
        return [super _binderClassForBinding: binding];
}

- initWithCoder: (NSCoder *) coder {
    NSLog(@"NSTextField initWithCoder");
    [super initWithCoder: coder];
    [self registerForDraggedTypes:
                    [NSArray arrayWithObject: NSStringPboardType]];

    if ([coder allowsKeyedCoding]) {
        NSKeyedUnarchiver *keyed = (NSKeyedUnarchiver *) coder;

        [self setDelegate: [keyed decodeObjectForKey: @"NSDelegate"]];
        _errorAction = NSSelectorFromString(
                [keyed decodeObjectForKey: @"NSErrorAction"]);

        double maxLayoutWidth =
                [keyed decodeDoubleForKey: @"NSPreferredMaxLayoutWidth"];
        // TODO
    } else {
        NSInteger version = [coder versionForClassName: @"NSTextField"];

        if (version < 25) {
            [self setNextKeyView: [coder decodeObject]];
            [self setNextKeyView: [coder decodeObject]];
        }

        [self setDelegate: [coder decodeObject]];
        [coder decodeValuesOfObjCTypes: ":", &_errorAction];
    }
    return self;
}

- initWithFrame: (NSRect) frame {
    [super initWithFrame: frame];
    // Default for a NSTextFieldCell is NOT the same as NSTextField
    [_cell setEditable: YES];
    [_cell setSelectable: YES];
    [_cell setBezeled: YES];
    [self registerForDraggedTypes:
                    [NSArray arrayWithObject: NSStringPboardType]];
    return self;
}

- (BOOL) isFlipped {
    return YES;
}

- (BOOL) isOpaque {
    return [_cell drawsBackground] || [_cell isBezeled];
}

- (void) resetCursorRects {
    [_cell resetCursorRect: [self bounds] inView: self];
}

- delegate {
    return _delegate;
}

- (void) setDelegate: delegate {
    NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
    struct {
        SEL selector;
        NSString *name;
    } notes[] = {{@selector(controlTextDidBeginEditing:),
                  NSControlTextDidBeginEditingNotification},
                 {@selector(controlTextDidChange:),
                  NSControlTextDidChangeNotification},
                 {@selector(controlTextDidEndEditing:),
                  NSControlTextDidEndEditingNotification},
                 {NULL, nil}};
    int i;

    if (_delegate != nil)
        for (i = 0; notes[i].selector != NULL; i++)
            [center removeObserver: _delegate name: notes[i].name object: self];

    _delegate = delegate;

    for (i = 0; notes[i].selector != NULL; i++)
        if ([_delegate respondsToSelector: notes[i].selector])
            [center addObserver: _delegate
                       selector: notes[i].selector
                           name: notes[i].name
                         object: self];
}

- (NSColor *) backgroundColor {
    return [_cell backgroundColor];
}

- (NSColor *) textColor {
    return [_cell textColor];
}

- (BOOL) drawsBackground {
    return [_cell drawsBackground];
}

- (void) setBackgroundColor: (NSColor *) color {
    [_cell setBackgroundColor: color];
    [self setNeedsDisplay: YES];
}

- (void) setTextColor: (NSColor *) color {
    [_cell setTextColor: color];
    [self setNeedsDisplay: YES];
}

- (void) setDrawsBackground: (BOOL) flag {
    [_cell setDrawsBackground: flag];
    [self setNeedsDisplay: YES];
}

- (NSString *) placeholderString {
    return [_cell placeholderString];
}

- (void) setPlaceholderString: (NSString *) placeholderString {
    [_cell setPlaceholderString: placeholderString];
}

- (NSAttributedString *) placeholderAttributedString {
    return [_cell placeholderAttributedString];
}

- (void) setPlaceholderAttributedString:
        (NSAttributedString *) placeholderAttributedString
{
    [_cell setPlaceholderAttributedString: placeholderAttributedString];
}

- (NSInteger) maximumNumberOfLines {
    // TODO
    return 0;
}

- (void) setMaximumNumberOfLines: (NSInteger) maximumNumberOfLines {
    // TODO
}

- (BOOL) acceptsFirstResponder {
    return YES;
}

- (BOOL) canBecomeKeyView {
    if (![self isEditable])
        return NO;

    return [super canBecomeKeyView];
}

- (BOOL) needsPanelToBecomeKey {
    return YES;
}

- (BOOL) becomeFirstResponder {
    [self selectText: nil];
    return YES;
}

- (void) _selectTextWithRange: (NSRange) range {
    NSTextFieldCell *cell = [self selectedCell];

    if (![cell isEnabled])
        return;

    if ([cell isEditable] || [cell isSelectable]) {
        if (_currentEditor == nil) {
            NSText *editor = [[self window] fieldEditor: YES forObject: self];
            _currentEditor = [[cell setUpFieldEditorAttributes: editor] retain];
            [_currentEditor setDelegate: self];
            [_currentEditor registerForDraggedTypes: [self _draggedTypes]];
            [_currentEditor becomeFirstResponder];
        }

        [cell selectWithFrame: [self bounds]
                       inView: self
                       editor: _currentEditor
                     delegate: self
                        start: range.location
                       length: range.length];
    }
}

- (void) selectText: sender {
    [self _selectTextWithRange: NSMakeRange(0, [[self stringValue] length])];
}

- (void) setPreviousText: text {
    // FIX, not sure how to implement this
    //   [self setPreviousKeyView:text];
}

- (void) setNextText: text {
    [self setNextKeyView: text];
}

- previousText {
    return [self previousKeyView];
}

- nextText {
    return [self nextKeyView];
}

- (void) validateEditing {
    if (_currentEditor) {
        NSString *string = [_currentEditor string];
        BOOL acceptsString = YES;
        NSFormatter *formatter = [self formatter];
        if (formatter) {
            acceptsString = NO;

            id objectValue = nil;
            NSString *error = nil;
            if ([formatter getObjectValue: &objectValue
                                forString: string
                         errorDescription: &error] == YES) {
                [[self selectedCell] setObjectValue: objectValue];
            } else {
                // Ask the delegate what to do
                SEL sel = @selector(control:
                        didFailToFormatString:errorDescription:);
                if ([_delegate respondsToSelector: sel]) {
                    acceptsString = [_delegate control: self
                                 didFailToFormatString: string
                                      errorDescription: error];
                }
            }
        }
        if (acceptsString) {
            if ([_currentEditor isRichText]) {
                if ([_currentEditor isKindOfClass: [NSTextView class]]) {
                    NSTextView *textview = (NSTextView *) _currentEditor;
                    NSAttributedString *text = [textview textStorage];
                    NSAttributedString *string = [[[NSAttributedString alloc]
                            initWithAttributedString: text] autorelease];
                    [[self selectedCell] setAttributedStringValue: string];
                } else {
                    [[self selectedCell] setStringValue: string];
                }
            } else {
                [[self selectedCell] setStringValue: string];
            }
        }
    }
}

- (void) textDidEndEditing: (NSNotification *) note {

    int movement = [[[note userInfo] objectForKey: @"NSTextMovement"] intValue];

    [super textDidEndEditing: note];

    if (movement == NSReturnTextMovement ||
        [[self selectedCell] sendsActionOnEndEditing])
        [self sendAction: [self action] to: [self target]];

    if (movement == NSTabTextMovement)
        [[self window] selectKeyViewFollowingView: self];

    if (movement == NSBacktabTextMovement)
        [[self window] selectKeyViewPrecedingView: self];
}

- (void) mouseDown: (NSEvent *) event {
    NSTextFieldCell *cell = [self selectedCell];

    if (![cell isEnabled])
        return;

    if ([[self window] firstResponder] != self) {
        // This will create our editor if needed
        [[self window] makeFirstResponder: self];
    }

    NSPoint point = [self convertPoint: [event locationInWindow] fromView: nil];
    NSRect editingFrame = [cell titleRectForBounds: [self bounds]];

    // In case we get the mouse down because we hadn't an editor yet, propagate
    // the mouse event to the editor
    if (_currentEditor &&
        NSMouseInRect(point, editingFrame, [self isFlipped])) {
        [_currentEditor mouseDown: event];
    } else {
        [super mouseDown: event];
    }
}

- (BOOL) textShouldBeginEditing: (NSText *) text {
    if ([_delegate respondsToSelector: @selector(control:
                                               textShouldBeginEditing:)])
        if ([_delegate control: self textShouldBeginEditing: text] == NO) {
            NSBeep();
            return NO;
        }
    return YES;
}

- (BOOL) textShouldEndEditing: (NSText *) text {
    if ([_delegate respondsToSelector: @selector(control:
                                               textShouldEndEditing:)])
        if ([_delegate control: self textShouldEndEditing: text] == NO) {
            NSBeep();
            return NO;
        }

    NSFormatter *formatter = [[self selectedCell] formatter];
    BOOL acceptsString = YES;
    if (formatter) {
        // Ask the formatter if the string is valid
        // If it's not, then we'll present an error and refuse the end of the
        // editing

        NSString *string = [text string];
        id objectValue;
        NSError *error = nil;
        if ([formatter isKindOfClass: [NSNumberFormatter class]]) {
            NSNumberFormatter *numberFormatter =
                    (NSNumberFormatter *) formatter;
            acceptsString = [numberFormatter getObjectValue: &objectValue
                                                  forString: string
                                                      range: NULL
                                                      error: &error];
        } else {
            NSString *errorString;
            if ([formatter getObjectValue: &objectValue
                                forString: string
                         errorDescription: &errorString] == NO) {

                acceptsString = NO;
                NSDictionary *info = nil;
                if (errorString == nil) {
                    // Just in case we get no error from the formatter
                    errorString = NSLocalizedStringFromTableInBundle(
                            @"Invalid number", nil,
                            [NSBundle bundleForClass: [NSTextField class]],
                            @"");
                }
                info = [NSDictionary
                        dictionaryWithObject: errorString
                                      forKey: NSLocalizedDescriptionKey];
                error = [NSError errorWithDomain: NSCocoaErrorDomain
                                            code: 2048
                                        userInfo: info];
            }
        }
        if (error) {
            [self presentError: error];
        }
    }
    return acceptsString;
}

- (void) setEditable: (BOOL) flag {
    [super setEditable: flag];
    [_currentEditor setEditable: [self isEditable]];
}

- (void) setSelectable: (BOOL) flag {
    [super setSelectable: flag];
    [_currentEditor setSelectable: [self isSelectable]];
}

- (void) setStringValue: (NSString *) value {
    if (!_currentEditor)
        [super setStringValue: value];
    else {
        NSRange selectedRange = [_currentEditor selectedRange];
        BOOL isEntireString =
                NSEqualRanges(selectedRange,
                              NSMakeRange(0, [[_currentEditor string] length]));

        [super setStringValue: value];
        [_currentEditor setString: [self stringValue]];
        NSRange entireString = NSMakeRange(0, [[_currentEditor string] length]);

        if (isEntireString) {
            // NSTextField will re-select entire string on a setString: if the
            // previous value is completely selected
            [_currentEditor setSelectedRange: entireString];
        } else {
            // otherwise it will re-select what it can
            selectedRange = NSIntersectionRange(selectedRange, entireString);

            if (selectedRange.length == 0) // 0 on intersection is undefined
                                           // location, so we have to set it
                selectedRange.location = 0;
            [_currentEditor setSelectedRange: entireString];
        }
    }
}

- (void) setFont: (NSFont *) font {
    // Don't do extra work if we don't need to...
    if (font != [self font]) {
        [super setFont: font];
        [_currentEditor setFont: [self font]];
    }
}

- (void) setAlignment: (NSTextAlignment) alignment {
    [super setAlignment: alignment];
    [_currentEditor setAlignment: [self alignment]];
}

- (void) setRefusesFirstResponder: (BOOL) flag {
    [_cell setRefusesFirstResponder: flag];
}

- (void) doCommandBySelector: (SEL) selector {
    BOOL didSelector = NO;

    if ([_delegate respondsToSelector: @selector(control:
                                                textView:doCommandBySelector:)])
        didSelector = [_delegate control: self
                                textView: (NSTextView *) _currentEditor
                     doCommandBySelector: selector];

    if (!didSelector)
        [super doCommandBySelector: selector];
}

- (void) setTitleWithMnemonic: (NSString *) value {
    [self setStringValue: value];
}

@end

@implementation NSTextField (Bindings)

- (CGFloat) _fontSize {
    return [(NSTextFieldCell *) _cell _fontSize];
}
- (void) _setFontSize: (CGFloat) fontSize {
    [(NSTextFieldCell *) _cell _setFontSize: fontSize];
}
- (NSString *) _fontFamilyName {
    return [(NSTextFieldCell *) _cell _fontFamilyName];
}
- (void) _setFontFamilyName: (NSString *) familyName {
    [(NSTextFieldCell *) _cell _setFontFamilyName: familyName];
}

@end