modules/gui/macosx/SPInvocationGrabbing.m

   1 /*
   2  Copyright (c) 2011, Joachim Bengtsson
   3  All rights reserved.
   4
   5  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
   6
   7  * Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
   8
   9  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  10  */
  11
  12 #import "SPInvocationGrabbing.h"
  13 #import <execinfo.h>
  14
  15 #pragma mark Invocation grabbing
  16 @interface SPInvocationGrabber ()
  17 @property (readwrite, retain, nonatomic) id object;
  18 @property (readwrite, retain, nonatomic) NSInvocation *invocation;
  19
  20 @end
  21
  22 @implementation SPInvocationGrabber
  23 - (id)initWithObject:(id)obj;
  24 {
  25     return [self initWithObject:obj stacktraceSaving:YES];
  26 }
  27
  28 -(id)initWithObject:(id)obj stacktraceSaving:(BOOL)saveStack;
  29 {
  30     self.object = obj;
  31     if(saveStack)
  32         [self saveBacktrace];
  33
  34     return self;
  35 }
  36
  37 -(void)dealloc;
  38 {
  39     free(frameStrings);
  40     self.object = nil;
  41     self.invocation = nil;
  42 }
  43
  44 - (void)runInBackground;
  45 {
  46     @autoreleasepool {
  47         @try {
  48             [self invoke];
  49         }
  50         @finally {
  51             ;
  52         }
  53     }
  54 }
  55
  56
  57 - (void)forwardInvocation:(NSInvocation *)anInvocation {
  58     [anInvocation retainArguments];
  59     anInvocation.target = _object;
  60     self.invocation = anInvocation;
  61
  62     if(_backgroundAfterForward)
  63         [NSThread detachNewThreadSelector:@selector(runInBackground) toTarget:self withObject:nil];
  64     else if(_onMainAfterForward)
  65         [self performSelectorOnMainThread:@selector(invoke) withObject:nil waitUntilDone:_waitUntilDone];
  66 }
  67
  68 - (NSMethodSignature *)methodSignatureForSelector:(SEL)inSelector {
  69     NSMethodSignature *signature = [super methodSignatureForSelector:inSelector];
  70     if (signature == NULL)
  71         signature = [_object methodSignatureForSelector:inSelector];
  72
  73     return signature;
  74 }
  75
  76 - (void)invoke;
  77 {
  78     @try {
  79         [_invocation invoke];
  80     }
  81
  82     @catch (NSException * e) {
  83         NSLog(@"SPInvocationGrabber's target raised %@:\n\t%@\nInvocation was originally scheduled at:", e.name, e);
  84         [self printBacktrace];
  85         printf("\n");
  86         [e raise];
  87     }
  88
  89     self.invocation = nil;
  90     self.object = nil;
  91 }
  92
  93 -(void)saveBacktrace;
  94 {
  95     void *backtraceFrames[128];
  96     frameCount = backtrace(&backtraceFrames[0], 128);
  97     frameStrings = backtrace_symbols(&backtraceFrames[0], frameCount);
  98 }
  99
 100 -(void)printBacktrace;
 101 {
 102     for(int x = 3; x < frameCount; x++) {
 103         if(frameStrings[x] == NULL) { break; }
 104         printf("%s\n", frameStrings[x]);
 105     }
 106 }
 107 @end
 108
 109 @implementation NSObject (SPInvocationGrabbing)
 110 -(id)grab;
 111 {
 112     return [[SPInvocationGrabber alloc] initWithObject:self];
 113 }
 114
 115 -(id)invokeAfter:(NSTimeInterval)delta;
 116 {
 117     id grabber = [self grab];
 118     [NSTimer scheduledTimerWithTimeInterval:delta target:grabber selector:@selector(invoke) userInfo:nil repeats:NO];
 119     return grabber;
 120 }
 121
 122 - (id)nextRunloop;
 123 {
 124     return [self invokeAfter:0];
 125 }
 126
 127 -(id)inBackground;
 128 {
 129     SPInvocationGrabber *grabber = [self grab];
 130     grabber.backgroundAfterForward = YES;
 131     return grabber;
 132 }
 133
 134 -(id)onMainAsync:(BOOL)async;
 135 {
 136     SPInvocationGrabber *grabber = [self grab];
 137     grabber.onMainAfterForward = YES;
 138     grabber.waitUntilDone = !async;
 139     return grabber;
 140 }
 141
 142 @end