]> git.wincent.com - WOTest.git/blob - WOStub.m
Code clean-up for garbage collection
[WOTest.git] / WOStub.m
1 //
2 //  WOStub.m
3 //  WOTest
4 //
5 //  Created by Wincent Colaiuta on 14 June 2005.
6 //
7 //  Copyright 2005-2007 Wincent Colaiuta.
8 //  This program is free software: you can redistribute it and/or modify
9 //  it under the terms of the GNU General Public License as published by
10 //  the Free Software Foundation, either version 3 of the License, or
11 //  (at your option) any later version.
12 //
13 //  This program is distributed in the hope that it will be useful,
14 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
15 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 //  GNU General Public License for more details.
17 //
18 //  You should have received a copy of the GNU General Public License
19 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 //
21
22 // class header
23 #import "WOStub.h"
24
25 // system headers
26 #import <objc/objc-class.h>
27
28 // framework headers
29 #import "NSInvocation+WOTest.h"
30 #import "NSMethodSignature+WOTest.h"
31 #import "NSObject+WOTest.h"
32 #import "NSProxy+WOTest.h"
33 #import "NSValue+WOTest.h"
34 #import "WOMock.h"
35
36 @implementation WOStub
37
38 - (id)init
39 {
40     return self; // super (NSProxy) has no init method
41 }
42
43 - (id)anyArguments
44 {
45     [self setAcceptsAnyArguments:YES];
46     return self;
47 }
48
49 #pragma mark -
50 #pragma mark Recording
51
52 - (id)returning:(NSValue *)aValue
53 {
54     NSAssert(([self returnValue] == nil), @"WOStub returning: invoked but return value already recorded");
55     [self setReturnValue:aValue];
56     return self;
57 }
58
59 - (id)raising:(id)anException
60 {
61     NSAssert(([self exception] == nil), @"WOStub raising: invoked but exception already recorded");
62     [self setException:anException];
63     return self;
64 }
65
66 #pragma mark -
67 #pragma mark Testing equality
68
69 - (BOOL)matchesInvocation:(NSInvocation *)anInvocation
70 {
71     NSParameterAssert(anInvocation != nil);
72     NSInvocation *recordedInvocation = [self invocation];
73     NSAssert((recordedInvocation != nil), @"WOStub sent matchesInvocation but no invocation yet recorded");
74     return ([anInvocation WOTest_isEqualToInvocation:recordedInvocation] ||
75             ([self acceptsAnyArguments] && [anInvocation WOTest_isEqualToInvocationIgnoringArguments:recordedInvocation]));
76 }
77
78 #pragma mark -
79 #pragma mark Proxy methods
80
81 - (void)forwardInvocation:(NSInvocation *)anInvocation
82 {
83     NSAssert(([self invocation] == nil), @"WOStub sent message but message previously recorded");
84     [self setInvocation:anInvocation];
85     [anInvocation retainArguments];
86 }
87
88 /*
89
90  http://lists.apple.com/archives/cocoa-dev/2004/Jun/msg00990.html
91
92  "On PPC, the prearg area is used to store the 13 floating-point parameter registers, which may contain method parameters that need to be restored when the marg_list is used. The i386 function call ABI has no additional registers to be saved, so its prearg area is empty. The implementations of _objc_msgForward() and objc_msgSendv() in objc4's objc-msg-ppc.s contain more details that may be useful to you.
93
94  In general, you probably want to avoid marg_list and objc_msgSendv(). Together they are primarily an implementation detail of forward:: ."
95
96  (Greg Parker, Apple)
97
98  */
99
100 - forward:(SEL)sel :(marg_list)args
101 {
102     NSAssert(([self invocation] == nil), @"WOStub sent message but message previously recorded");
103
104     // let standard event flow take place (but note that NSProxy implementation raises so subclasses must do the real work)
105     if ([self methodSignatureForSelector:sel])
106       return [super forward:sel :args];
107
108     // fallback to internal lookup
109     NSMethodSignature *signature = [[delegate methodSignatures] objectForKey:NSStringFromSelector(sel)];
110
111     // at this point it would be great to be able to improvise but it's not possible to figure out an accurate method signature
112     NSAssert((signature != nil), ([NSString stringWithFormat:@"no method signature for selector %@", NSStringFromSelector(sel)]));
113
114     NSInvocation *forwardInvocation = [NSInvocation invocationWithMethodSignature:signature];
115     [forwardInvocation setSelector:sel];
116
117
118     // store arguments in invocation
119     int offset = 0;
120     for (unsigned i = 0, max = [signature numberOfArguments]; i < max; i++)
121     {
122         const char *type = [signature getArgumentTypeAtIndex:i];    // always id, SEL, ...
123
124 #if defined(__ppc__)
125
126         // TODO: finish this implementation and copy it (or otherwise make it available) to WOMock.m
127         // leave the compiler warnings about "unused variable 'type'" and "unused variable 'offset'" to remind me to do it
128
129         // the PPC ABI has special conventions for floats, doubles, structs
130
131         // contents of floating point registers f1 through f13 stored at args + 0 through args + 96
132         // register based params go in r3 (receiver id), r4 (SEL), and r5 through r10
133         // these params are respectively at:
134         // 1st param: r3 (receiver id) args + (13 * 8) + 24 (24 bytes in the linkage area not sure what it's for)
135         // 2nd param: r4 (SEL) args + (13 * 8) + 28
136         // 3rd param: r5 args + (13 * 8) + 32
137         // 4th param: r6 args + (13 * 8) + 36
138         // 5th param: r7 args + (13 * 8) + 40
139         // 6th param: r8 args + (13 * 8) + 44
140         // 7th param: r9 args + (13 * 8) + 48
141         // 8th param: r10 args + (13 * 8) + 52
142         // the remaining parameters are on the stack (starting at args + (13 * 8) + 56)
143         // note that marg_prearg_size is defined in the headers for ppc and equals 128 (13 * 8 + 24 bytes for linkage area)
144
145         // from http://darwinsource.opendarwin.org/10.4.3/objc4-267/runtime/Messengers.subproj/objc-msg-ppc.s
146 //        typedef struct objc_sendv_margs {
147 //            double    floatingPointArgs[13];
148 //            int       linkageArea[6];
149 //            int       registerArgs[8];
150 //            int       stackArgs[variable];
151 //        };
152 //
153 //        if (strcmp(type, @encode(float)) == 0)
154 //        {}
155 //        else if (strcmp(type, @encode(double)) == 0)
156 //        {}
157 //        else
158
159 #elif defined(__i386__)
160
161         // on i386 the marg_getRef macro and its helper, marg_adjustedOffset, should work fine
162         if (strcmp(type, @encode(id)) == 0)
163         {
164             id *ref = marg_getRef(args, offset, id);
165             [forwardInvocation WOTest_setArgumentValue:[NSValue valueWithBytes:ref objCType:type] atIndex:i];
166         }
167         else if (strcmp(type, @encode(SEL)) == 0)
168         {
169             SEL *ref = marg_getRef(args, offset, SEL);
170             [forwardInvocation WOTest_setArgumentValue:[NSValue valueWithBytes:ref objCType:type] atIndex:i];
171         }
172         else
173             [NSException raise:NSGenericException format:@"type %s not supported", type];
174
175         offset += [NSValue WOTest_sizeForType:[NSString stringWithUTF8String:type]];
176
177 #elif defined(__ppc64__)
178         // there is no objc-msg-ppc.s so for now just omit support rather than make assumptions
179 #error ppc64 not supported yet
180
181 #else
182
183 #error Unsupported architecture
184
185 #endif
186
187     }
188     [self forwardInvocation:forwardInvocation];
189     return nil; // nobody cares what a stub returns
190 }
191
192 #pragma mark -
193 #pragma mark Accessors
194
195 - (NSInvocation *)recordedInvocation
196 {
197     NSInvocation *recordedInvocation = [self invocation];
198     NSAssert((recordedInvocation != nil), @"WOStub sent recordedInvocation but no invocation yet recorded");
199     return recordedInvocation;
200 }
201
202 @synthesize invocation;
203 @synthesize returnValue;
204 @synthesize acceptsAnyArguments;
205 @synthesize exception;
206
207 @end