Checking Objective-C block type?

by

Can do, kinda sorta.

But first, let’s disambiguate. -[NSObject isKindOfClass:] can tell you it’s a block, and that’s about it. E.g. I believe this line of code — ostensibly & unfortunately A BAD IDEA — will return YES for blocks on present Lion & iOS 5.x:

[myBlock isKindOfClass:NSClassFromString(@"NSBlock")]

That won’t help you distinguish the block’s function signature.

But it can be done, by snagging the signature from the block’s documented internal struct. Code follows for an example OS X command-line app, much of which ripped from Mike Ash’s MABlockClosure (great detailed explanation). (UPDATE: Github project CTObjectiveCRuntimeAdditions also apparently provides library code for just this purpose.)

#import <Foundation/Foundation.h>

struct BlockDescriptor {
    unsigned long reserved;
    unsigned long size;
    void *rest[1];
};

struct Block {
    void *isa;
    int flags;
    int reserved;
    void *invoke;
    struct BlockDescriptor *descriptor;
};

static const char *BlockSig(id blockObj)
{
    struct Block *block = (void *)blockObj;
    struct BlockDescriptor *descriptor = block->descriptor;

    int copyDisposeFlag = 1 << 25;
    int signatureFlag = 1 << 30;

    assert(block->flags & signatureFlag);

    int index = 0;
    if(block->flags & copyDisposeFlag)
        index += 2;

    return descriptor->rest[index];
}

int main(int argc, const char * argv[])
{
    @autoreleasepool {

        int (^block)(NSNumber *) = ^(NSNumber *num) { 
            NSLog(@"%@ %@", NSStringFromClass([num class]), num); 
            return [num intValue]; 
        };
        NSLog(@"signature %s", BlockSig(block));
        NSLog(@"retval %d", (int)block([NSNumber numberWithInt:42]));
    }
    return 0;
}

Run this and you should get something like:

[58003:403] signature i16@?0@8
[58003:403] __NSCFNumber 42
[58003:403] retval 42

The numbers in the signature (I’m told they are offsets) can be stripped for simpler i@?@.

The signature is in the @encode format, which isn’t perfect (e.g. most objects map to same @), but should afford you some ability to distinguish blocks with different signatures at runtime.

While it’s not documented in the Apple link, my testing points to @? being the code for a block type, which makes sense of the signature above. I found a clang-developers discussion on this issue which seems to back this up.

More Related Contents:

  1. What is the difference between class and instance methods?
  2. Use of alloc init instead of new
  3. How do I declare class-level properties in Objective-C?
  4. How do I avoid capturing self in blocks when implementing an API?
  5. What does the “__block” keyword mean?
  6. Get an object properties list in Objective-C
  7. Objective-C Introspection/Reflection
  8. Retain cycle on `self` with blocks
  9. Custom completion block for my own method [duplicate]
  10. When to use enumerateObjectsUsingBlock vs. for
  11. Assign a variable inside a Block to a variable outside a Block
  12. Implementing a method taking a block to use as callback
  13. What does this caret ^ syntax, with void on either side mean? [duplicate]
  14. Caret character between types rather than variables, surrounded by parentheses
  15. Block Declaration Syntax List
  16. What is the difference between inheritance and Categories in Objective-C
  17. Get property name as a string
  18. Why can’t we use a dispatch_sync on the current queue?
  19. Alternatives to dispatch_get_current_queue() for completion blocks in iOS 6?
  20. property type or class using reflection
  21. How to dispatch on main queue synchronously without a deadlock?
  22. How to simplify callback logic with a Block?
  23. When should I call super?
  24. Call instance method from class method
  25. What is Protocol Oriented Programming in Swift? What added value does it bring?
  26. Using __block and __weak
  27. How does a Block capture the variables outside of its enclosing scope?
  28. Why do nil / NULL blocks cause bus errors when run?
  29. How do I list all fields of an object in Objective-C?
  30. What is the difference between a __weak and a __block reference?

Leave a Comment