CPViewController.j

Go to the documentation of this file.

/*
 * CPViewController.j
 * AppKit
 *
 * Created by Nicholas Small and Francisco Tolmasky.
 * Copyright 2009, 280 North, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */




@global CPApp


var CPViewControllerCachedCibs;

@implementation CPViewController : CPResponder
{
    CPView          _view;
    BOOL            _isLoading;
    BOOL            _isLazy;
    BOOL            _isViewLoaded;

    id              _representedObject;
    CPString        _title;

    CPString        _cibName;
    CPBundle        _cibBundle;
    CPDictionary    _cibExternalNameTable;
}

+ (void)initialize
{
    if (self !== [CPViewController class])
        return;

    CPViewControllerCachedCibs = @{};
}

- (id)init
{
    return [self initWithCibName:nil bundle:nil];
}

- (id)initWithCibName:(CPString)aCibNameOrNil bundle:(CPBundle)aCibBundleOrNil
{
    return [self initWithCibName:aCibNameOrNil bundle:aCibBundleOrNil externalNameTable:nil];
}

- (id)initWithCibName:(CPString)aCibNameOrNil bundle:(CPBundle)aCibBundleOrNil owner:(id)anOwner
{
    return [self initWithCibName:aCibNameOrNil bundle:aCibBundleOrNil externalNameTable:@{ CPCibOwner: anOwner }];
}

- (id)initWithCibName:(CPString)aCibNameOrNil bundle:(CPBundle)aCibBundleOrNil externalNameTable:(CPDictionary)anExternalNameTable
{
    self = [super init];

    if (self)
    {
        // Don't load the cib until someone actually requests the view. The user may just be intending to use setView:.
        _cibName = aCibNameOrNil;
        _cibBundle = aCibBundleOrNil || [CPBundle mainBundle];
        _cibExternalNameTable = anExternalNameTable || @{ CPCibOwner: self };

        _isLoading = NO;
        _isLazy = NO;
    }

    return self;
}

- (void)loadView
{
    if (_view)
        return;

    if (_cibName)
    {
        // check if a cib is already cached for the current _cibName
        var cib = [CPViewControllerCachedCibs objectForKey:_cibName];

        if (!cib)
        {
            // if the cib isn't cached yet : fetch it and cache it
            cib = [[CPCib alloc] initWithCibNamed:_cibName bundle:_cibBundle];
            [CPViewControllerCachedCibs setObject:cib forKey:_cibName];
        }

        [cib instantiateCibWithExternalNameTable:_cibExternalNameTable];
    }
    else
        _view = [CPView new];
}

- (void)loadViewWithCompletionHandler:(Function/*(view, error)*/)aHandler
{
    if (_view)
        return;

    if (_cibName)
    {
        // check if a cib is already cached for the current _cibName
        var cib = [CPViewControllerCachedCibs objectForKey:_cibName];

        if (!cib)
        {
            var cibName = _cibName;

            if (![cibName hasSuffix:@".cib"])
                cibName = [cibName stringByAppendingString:@".cib"];

            // If aBundle is nil, use mainBundle, but ONLY for searching for the nib, not for resources later.
            var bundle = _cibBundle || [CPBundle mainBundle],
                url = [bundle _cibPathForResource:cibName];

            // if the cib isn't cached yet : fetch it and cache it
            [CPURLConnection sendAsynchronousRequest:[CPURLRequest requestWithURL:url] queue:[CPOperationQueue mainQueue] completionHandler:function(aResponse, aData, anError)
            {
                if (anError == nil)
                {
                    var data = [CPData dataWithRawString:aData],
                          aCib = [[CPCib alloc] _initWithData:data bundle:_cibBundle cibName:_cibName];

                    [CPViewControllerCachedCibs setObject:aCib forKey:_cibName];
                    [aCib instantiateCibWithExternalNameTable:_cibExternalNameTable];
                    [self _viewDidLoadWithCompletionHandler:aHandler];
                }
                else
                {
                    aHandler(nil, anError);
                }
            }];
        }
        else
        {
            [cib instantiateCibWithExternalNameTable:_cibExternalNameTable];
            [self _viewDidLoadWithCompletionHandler:aHandler];
        }
    }
    else
    {
        _view = [CPView new];
        [self _viewDidLoadWithCompletionHandler:aHandler];
    }
}

- (CPView)view
{
    if (!_view)
    {
        _isLoading = YES;

        var cibOwner = [_cibExternalNameTable objectForKey:CPCibOwner];

        if ([cibOwner respondsToSelector:@selector(viewControllerWillLoadCib:)])
            [cibOwner viewControllerWillLoadCib:self];

        [self loadView];

        if (_view === nil && [cibOwner isKindOfClass:[CPDocument class]])
            [self setView:[cibOwner valueForKey:@"view"]];

        if (!_view)
        {
            var reason = [CPString stringWithFormat:@"View for %@ could not be loaded from Cib or no view specified. Override loadView to load the view manually.", self];

            [CPException raise:CPInternalInconsistencyException reason:reason];
        }

        if ([cibOwner respondsToSelector:@selector(viewControllerDidLoadCib:)])
            [cibOwner viewControllerDidLoadCib:self];

        _isLoading = NO;
        _isLazy = NO;
        [self _viewDidLoad];
    }
    else if (_isLazy)
    {
        _isLazy = NO;
        [self _viewDidLoad];
    }

    return _view;
}

- (void)_viewDidLoad
{
    [self willChangeValueForKey:"isViewLoaded"];
    [self viewDidLoad];
    _isViewLoaded = YES;
    [self didChangeValueForKey:"isViewLoaded"];
}

- (void)_viewDidLoadWithCompletionHandler:(Function)aHandler
{
    [self _registerOrUnregister:YES notificationsForView:_view];

    [self willChangeValueForKey:"isViewLoaded"];
    aHandler(_view, nil);
    _isViewLoaded = YES;
    [self didChangeValueForKey:"isViewLoaded"];
}

- (void)viewDidLoad
{

}

- (void)viewWillAppear
{

}

- (void)viewDidAppear
{

}

- (void)viewWillDisappear
{

}

- (void)viewDidDisappear
{

}

- (void)setView:(CPView)aView
{
    var willChangeIsViewLoaded = (_isViewLoaded == NO && aView != nil) || (_isViewLoaded == YES && aView == nil);

    [self _registerOrUnregister:NO notificationsForView:_view];
    [self _registerOrUnregister:YES notificationsForView:aView];

    if (willChangeIsViewLoaded)
        [self willChangeValueForKey:"isViewLoaded"];

    _view = aView;
    _isViewLoaded = aView !== nil;

    if (willChangeIsViewLoaded)
        [self didChangeValueForKey:"isViewLoaded"];
}

- (BOOL)automaticallyNotifiesObserversOfIsViewLoaded
{
    return NO;
}

- (void)_registerOrUnregister:(BOOL)shouldRegister notificationsForView:(CPView)aView
{
    if (aView === nil)
        return;

    var center = [CPNotificationCenter defaultCenter],
        notifs_to_sel = @{_CPViewWillAppearNotification : @"viewWillAppear",
                          _CPViewDidAppearNotification : @"viewDidAppear",
                          _CPViewWillDisappearNotification : @"viewWillDisappear",
                          _CPViewDidDisappearNotification : @"viewDidDisappear"};

    [notifs_to_sel enumerateKeysAndObjectsUsingBlock:function(notif, selString, stop)
    {
        var selector = CPSelectorFromString(selString);
        if ([self implementsSelector:selector])
        {
            if (shouldRegister)
                [center addObserver:self selector:selector name:notif object:aView];
            else
                [center removeObserver:self name:notif object:aView];
        }
    }];
}

@end


var CPViewControllerViewKey     = @"CPViewControllerViewKey",
    CPViewControllerTitleKey    = @"CPViewControllerTitleKey",
    CPViewControllerCibNameKey  = @"CPViewControllerCibNameKey",
    CPViewControllerBundleKey   = @"CPViewControllerBundleKey";

@implementation CPViewController (CPCoding)

- (id)initWithCoder:(CPCoder)aCoder
{
    self = [super initWithCoder:aCoder];

    if (self)
    {
        _view = [aCoder decodeObjectForKey:CPViewControllerViewKey];
        _title = [aCoder decodeObjectForKey:CPViewControllerTitleKey];
        _cibName = [aCoder decodeObjectForKey:CPViewControllerCibNameKey];

        var bundlePath = [aCoder decodeObjectForKey:CPViewControllerBundleKey];
        _cibBundle = bundlePath ? [CPBundle bundleWithPath:bundlePath] : [CPBundle mainBundle];

        _cibExternalNameTable = @{ CPCibOwner: self };
        _isLazy = YES;
    }

    return self;
}

- (void)encodeWithCoder:(CPCoder)aCoder
{
    [super encodeWithCoder:aCoder];

    [aCoder encodeObject:_view forKey:CPViewControllerViewKey];
    [aCoder encodeObject:_title forKey:CPViewControllerTitleKey];
    [aCoder encodeObject:_cibName forKey:CPViewControllerCibNameKey];
    [aCoder encodeObject:[_cibBundle bundlePath] forKey:CPViewControllerBundleKey];
}

@end

@implementation CPViewController (CPSynthesizedAccessors)

- (CPView)view
{
    return _view;
}

- (void)setView:(CPView)aValue
{
    _view = aValue;
}

- (BOOL)isViewLoaded
{
    return _isViewLoaded;
}

- (id)representedObject
{
    return _representedObject;
}

- (void)setRepresentedObject:(id)aValue
{
    _representedObject = aValue;
}

- (CPString)title
{
    return _title;
}

- (void)setTitle:(CPString)aValue
{
    _title = aValue;
}

- (CPString)cibName
{
    return _cibName;
}

- (CPBundle)cibBundle
{
    return _cibBundle;
}

- (CPDictionary)cibExternalNameTable
{
    return _cibExternalNameTable;
}

@end