CPObject.j

Go to the documentation of this file.

/*
 * CPObject.j
 * Foundation
 *
 * Created by Francisco Tolmasky.
 * Copyright 2008, 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 CPInvalidArgumentException


@protocol CPObject

- (BOOL)isEqual:(id)object;
- (CPUInteger)hash;

- (Class)superclass;
- (Class)class;
- (id)self;

- (id)performSelector:(SEL)aSelector;
- (id)performSelector:(SEL)aSelector withObject:(id)object;
- (id)performSelector:(SEL)aSelector withObject:(id)object1 withObject:(id)object2;

- (BOOL)isProxy;

- (BOOL)isKindOfClass:(Class)aClass;
- (BOOL)isMemberOfClass:(Class)aClass;
- (BOOL)conformsToProtocol:(Protocol)aProtocol;

- (BOOL)respondsToSelector:(SEL)aSelector;

- (CPString)description;
@optional
- (CPString)debugDescription;

@end

@protocol CPCoding

- (void)encodeWithCoder:(CPCoder)aCoder;
- (id)initWithCoder:(CPCoder)aDecoder;

@end

@implementation CPObject <CPObject>
{
    id   isa;
}

+ (void)load
{
}

+ (void)initialize
{
//    CPLog("calling initialize "+self.name);
}

+ (id)new
{
    return [[self alloc] init];
}

+ (id)alloc
{
//    CPLog("calling alloc on " + self.name + ".");
    return class_createInstance(self);
}

+ (id)allocWithCoder:(CPCoder)aCoder
{
    return [self alloc];
}

- (id)init
{
    return self;
}

- (id)copy
{
    return self;
}

- (id)mutableCopy
{
    return [self copy];
}

- (void)dealloc
{
}

// Identifying classes
+ (Class)class
{
    return self;
}

- (Class)class
{
    return isa;
}

+ (Class)superclass
{
    return self.super_class;
}

+ (BOOL)isSubclassOfClass:(Class)aClass
{
    var theClass = self;

    for (; theClass; theClass = theClass.super_class)
        if (theClass === aClass)
            return YES;

    return NO;
}

- (BOOL)isKindOfClass:(Class)aClass
{
    return [isa isSubclassOfClass:aClass];
}

+ (BOOL)isKindOfClass:(Class)aClass
{
    return [self isSubclassOfClass:aClass];
}

- (BOOL)isMemberOfClass:(Class)aClass
{
    return self.isa === aClass;
}

+ (BOOL)isMemberOfClass:(Class)aClass
{
    return self === aClass;
}

- (BOOL)isProxy
{
    return NO;
}

// Testing class functionality
+ (BOOL)instancesRespondToSelector:(SEL)aSelector
{
    return !!class_getInstanceMethod(self, aSelector);
}

- (BOOL)respondsToSelector:(SEL)aSelector
{
    // isa is isa.isa in class case.
    return !!class_getInstanceMethod(isa, aSelector);
}

+ (BOOL)instancesImplementSelector:(SEL)aSelector
{
    var methods = class_copyMethodList(self),
        count = methods.length;

    while (count--)
        if (method_getName(methods[count]) === aSelector)
            return YES;

    return NO;
}

- (BOOL)implementsSelector:(SEL)aSelector
{
    return [[self class] instancesImplementSelector:aSelector];
}

+ (BOOL)conformsToProtocol:(Protocol)aProtocol
{
    return class_conformsToProtocol(self, aProtocol);
}

- (BOOL)conformsToProtocol:(Protocol)aProtocol
{
    return class_conformsToProtocol(isa, aProtocol);
}

// Obtaining method information

- (IMP)methodForSelector:(SEL)aSelector
{
    return class_getMethodImplementation(isa, aSelector);
}

+ (IMP)instanceMethodForSelector:(SEL)aSelector
{
    return class_getMethodImplementation(self, aSelector);
}

- (CPMethodSignature)methodSignatureForSelector:(SEL)aSelector
{
    // FIXME: We need to implement method signatures.
    return nil;
}

// Describing objects
- (CPString)description
{
    return "<" + class_getName(isa) + " 0x" + [CPString stringWithHash:[self UID]] + ">";
}

+ (CPString)description
{
    return class_getName(self.isa);
}

// Sending Messages
- (id)performSelector:(SEL)aSelector
{
    return self.isa.objj_msgSend0(self, aSelector);
}

- (id)performSelector:(SEL)aSelector withObject:(id)anObject
{
    return self.isa.objj_msgSend1(self, aSelector, anObject);
}

- (id)performSelector:(SEL)aSelector withObject:(id)anObject withObject:(id)anotherObject
{
    return self.isa.objj_msgSend2(self, aSelector, anObject, anotherObject);
}

- (id)performSelector:(SEL)aSelector withObjects:(id)anObject, ...
{
    var params = [self, aSelector].concat(Array.prototype.slice.apply(arguments, [3]));
    return objj_msgSend.apply(this, params);
}

- (id)forwardingTargetForSelector:(SEL)aSelector
{
    return nil;
}

// Forwarding Messages
- (void)forwardInvocation:(CPInvocation)anInvocation
{
    [self doesNotRecognizeSelector:[anInvocation selector]];
}

// Error Handling
- (void)doesNotRecognizeSelector:(SEL)aSelector
{
    [CPException raise:CPInvalidArgumentException reason:
        (class_isMetaClass(isa) ? "+" : "-") + " [" + [self className] + " " + aSelector + "] unrecognized selector sent to " +
        (class_isMetaClass(isa) ? "class " + class_getName(isa) : "instance 0x" + [CPString stringWithHash:[self UID]])];
}

// Archiving
- (id)awakeAfterUsingCoder:(CPCoder)aCoder
{
    return self;
}

- (Class)classForKeyedArchiver
{
    return [self classForCoder];
}

- (Class)classForCoder
{
    return [self class];
}

- (id)replacementObjectForArchiver:(CPArchiver)anArchiver
{
    return [self replacementObjectForCoder:anArchiver];
}

- (id)replacementObjectForKeyedArchiver:(CPKeyedArchiver)anArchiver
{
    return [self replacementObjectForCoder:anArchiver];
}

- (id)replacementObjectForCoder:(CPCoder)aCoder
{
    return self;
}

+ (void)setVersion:(int)aVersion
{
    class_setVersion(self, aVersion);
}

+ (int)version
{
    return class_getVersion(self);
}

// Scripting (?)
- (CPString)className
{
    // FIXME: Why doesn't this work in KVO???
    // return class_getName([self class]);
    return isa.name;
}

// Extras
- (id)autorelease
{
    return self;
}

- (unsigned)hash
{
    return [self UID];
}

- (CPString)UID
{
    if (typeof self._UID === "undefined")
        self._UID = objj_generateObjectUID();

    return self._UID + "";
}

- (BOOL)isEqual:(id)anObject
{
    return self === anObject || [self UID] === [anObject UID];
}

- (id)retain
{
    return self;
}

- (void)release
{
}

- (id)self
{
    return self;
}

- (Class)superclass
{
    return isa.super_class;
}

@end

function CPDescriptionOfObject(anObject, maximumRecursionDepth)
{
    if (anObject === nil)
        return "nil";

    if (anObject === undefined)
        return "undefined";

    if (anObject === window)
        return "window";

    if (maximumRecursionDepth === 0)
        return "...";

    if (anObject.isa)
    {
        if ([anObject isKindOfClass:CPString])
            return '@"' + [anObject description] + '"';

        if ([anObject respondsToSelector:@selector(_descriptionWithMaximumDepth:)])
            return [anObject _descriptionWithMaximumDepth:maximumRecursionDepth !== undefined ? maximumRecursionDepth - 1 : maximumRecursionDepth];

        return [anObject description];
    }

    if (typeof(anObject) !== "object")
        return String(anObject);

    var properties = [],
        desc;

    for (var property in anObject)
        if (anObject.hasOwnProperty(property))
            properties.push(property);

    properties.sort();

    if (properties.length === 2 && anObject.hasOwnProperty("width") && anObject.hasOwnProperty("height"))
        desc = [CPString stringWithFormat:@"CGSize: (%f, %f)", anObject.width, anObject.height];
    else if (properties.length === 2 && anObject.hasOwnProperty("x") && anObject.hasOwnProperty("y"))
        desc = [CPString stringWithFormat:@"CGPoint: (%f, %f)", anObject.x, anObject.y];
    else if (properties.length === 2 && anObject.hasOwnProperty("origin") && anObject.hasOwnProperty("size"))
        desc = [CPString stringWithFormat:@"CGRect: (%f, %f), (%f, %f)", anObject.origin.x, anObject.origin.y, anObject.size.width, anObject.size.height];
    else if (properties.length === 4 && anObject.hasOwnProperty("top") && anObject.hasOwnProperty("right") && anObject.hasOwnProperty("bottom") && anObject.hasOwnProperty("left"))
        desc = [CPString stringWithFormat:@"CGInset: { top:%f, right:%f, bottom:%f, left:%f }", anObject.top, anObject.right, anObject.bottom, anObject.left];
    else
    {
        desc = "{";

        for (var i = 0; i < properties.length; ++i)
        {
            if (i === 0)
                desc += "\n";

            var value = anObject[properties[i]],
                valueDescription = CPDescriptionOfObject(value, maximumRecursionDepth !== undefined ? maximumRecursionDepth - 1 : maximumRecursionDepth).split("\n").join("\n    ");

            desc += "    " + properties[i] + ": " + valueDescription;

            if (i < properties.length - 1)
                desc += ",\n";
            else
                desc += "\n";
        }

        desc += "}";
    }

    return desc;
}