| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>IRCClient: DDInvocationGrabber.h Source File</title> |
| 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.7.1 --> |
| 8 |
<div class="navigation" id="top"> |
| 9 |
<div class="tabs"> |
| 10 |
<ul> |
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 12 |
<li><a href="annotated.html"><span>Classes</span></a></li> |
| 13 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
| 14 |
</ul> |
| 15 |
</div> |
| 16 |
<div class="tabs"> |
| 17 |
<ul> |
| 18 |
<li><a href="files.html"><span>File List</span></a></li> |
| 19 |
</ul> |
| 20 |
</div> |
| 21 |
<h1>DDInvocationGrabber.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> |
| 22 |
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2007-2008 Dave Dribin</span> |
| 23 |
<a name="l00003"></a>00003 <span class="comment"> * </span> |
| 24 |
<a name="l00004"></a>00004 <span class="comment"> * Permission is hereby granted, free of charge, to any person</span> |
| 25 |
<a name="l00005"></a>00005 <span class="comment"> * obtaining a copy of this software and associated documentation</span> |
| 26 |
<a name="l00006"></a>00006 <span class="comment"> * files (the "Software"), to deal in the Software without</span> |
| 27 |
<a name="l00007"></a>00007 <span class="comment"> * restriction, including without limitation the rights to use, copy,</span> |
| 28 |
<a name="l00008"></a>00008 <span class="comment"> * modify, merge, publish, distribute, sublicense, and/or sell copies</span> |
| 29 |
<a name="l00009"></a>00009 <span class="comment"> * of the Software, and to permit persons to whom the Software is</span> |
| 30 |
<a name="l00010"></a>00010 <span class="comment"> * furnished to do so, subject to the following conditions:</span> |
| 31 |
<a name="l00011"></a>00011 <span class="comment"> * </span> |
| 32 |
<a name="l00012"></a>00012 <span class="comment"> * The above copyright notice and this permission notice shall be</span> |
| 33 |
<a name="l00013"></a>00013 <span class="comment"> * included in all copies or substantial portions of the Software.</span> |
| 34 |
<a name="l00014"></a>00014 <span class="comment"> *</span> |
| 35 |
<a name="l00015"></a>00015 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span> |
| 36 |
<a name="l00016"></a>00016 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> |
| 37 |
<a name="l00017"></a>00017 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span> |
| 38 |
<a name="l00018"></a>00018 <span class="comment"> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS</span> |
| 39 |
<a name="l00019"></a>00019 <span class="comment"> * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN</span> |
| 40 |
<a name="l00020"></a>00020 <span class="comment"> * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span> |
| 41 |
<a name="l00021"></a>00021 <span class="comment"> * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span> |
| 42 |
<a name="l00022"></a>00022 <span class="comment"> * SOFTWARE.</span> |
| 43 |
<a name="l00023"></a>00023 <span class="comment"> */</span> |
| 44 |
<a name="l00024"></a>00024 |
| 45 |
<a name="l00025"></a>00025 |
| 46 |
<a name="l00026"></a>00026 <span class="comment">/*</span> |
| 47 |
<a name="l00027"></a>00027 <span class="comment"> * This class is based on CInvocationGrabber:</span> |
| 48 |
<a name="l00028"></a>00028 <span class="comment"> *</span> |
| 49 |
<a name="l00029"></a>00029 <span class="comment"> * Copyright (c) 2007, Toxic Software</span> |
| 50 |
<a name="l00030"></a>00030 <span class="comment"> * All rights reserved.</span> |
| 51 |
<a name="l00031"></a>00031 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span> |
| 52 |
<a name="l00032"></a>00032 <span class="comment"> * modification, are permitted provided that the following conditions are</span> |
| 53 |
<a name="l00033"></a>00033 <span class="comment"> * met:</span> |
| 54 |
<a name="l00034"></a>00034 <span class="comment"> * </span> |
| 55 |
<a name="l00035"></a>00035 <span class="comment"> * * Redistributions of source code must retain the above copyright notice,</span> |
| 56 |
<a name="l00036"></a>00036 <span class="comment"> * this list of conditions and the following disclaimer.</span> |
| 57 |
<a name="l00037"></a>00037 <span class="comment"> * </span> |
| 58 |
<a name="l00038"></a>00038 <span class="comment"> * * Redistributions in binary form must reproduce the above copyright</span> |
| 59 |
<a name="l00039"></a>00039 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span> |
| 60 |
<a name="l00040"></a>00040 <span class="comment"> * documentation and/or other materials provided with the distribution.</span> |
| 61 |
<a name="l00041"></a>00041 <span class="comment"> * </span> |
| 62 |
<a name="l00042"></a>00042 <span class="comment"> * * Neither the name of the Toxic Software nor the names of its</span> |
| 63 |
<a name="l00043"></a>00043 <span class="comment"> * contributors may be used to endorse or promote products derived from</span> |
| 64 |
<a name="l00044"></a>00044 <span class="comment"> * this software without specific prior written permission.</span> |
| 65 |
<a name="l00045"></a>00045 <span class="comment"> * </span> |
| 66 |
<a name="l00046"></a>00046 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND</span> |
| 67 |
<a name="l00047"></a>00047 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span> |
| 68 |
<a name="l00048"></a>00048 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span> |
| 69 |
<a name="l00049"></a>00049 <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE</span> |
| 70 |
<a name="l00050"></a>00050 <span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span> |
| 71 |
<a name="l00051"></a>00051 <span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span> |
| 72 |
<a name="l00052"></a>00052 <span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span> |
| 73 |
<a name="l00053"></a>00053 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span> |
| 74 |
<a name="l00054"></a>00054 <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span> |
| 75 |
<a name="l00055"></a>00055 <span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF</span> |
| 76 |
<a name="l00056"></a>00056 <span class="comment"> * THE POSSIBILITY OF SUCH DAMAGE.</span> |
| 77 |
<a name="l00057"></a>00057 <span class="comment"> *</span> |
| 78 |
<a name="l00058"></a>00058 <span class="comment"> */</span> |
| 79 |
<a name="l00059"></a>00059 |
| 80 |
<a name="l00060"></a>00060 <span class="preprocessor">#import <Foundation/Foundation.h></span> |
| 81 |
<a name="l00061"></a>00061 |
| 82 |
<a name="l00062"></a>00062 <span class="comment">/*</span> |
| 83 |
<a name="l00063"></a>00063 <span class="comment"> * @class DDInvocationGrabber</span> |
| 84 |
<a name="l00064"></a>00064 <span class="comment"> * @discussion DDInvocationGrabber is a helper object that makes it very easy to construct instances of NSInvocation for later use. The object is inspired by NSUndoManager's prepareWithInvocationTarget method. To use a DDInvocationGrabber object, you set its target to some object, then send it a message as if it were the target object (the DDInvocationGrabber object acts as a proxy), if the target message understands the message the DDInvocationGrabber object stores the message invocation.</span> |
| 85 |
<a name="l00065"></a>00065 <span class="comment"> </span> |
| 86 |
<a name="l00066"></a>00066 <span class="comment"> DDInvocationGrabber *theGrabber = [DDInvocationGrabber invocationGrabber];</span> |
| 87 |
<a name="l00067"></a>00067 <span class="comment"> [theGrabber setTarget:someObject]</span> |
| 88 |
<a name="l00068"></a>00068 <span class="comment"> [theGrabber doSomethingWithParameter:someParameter]; // Send messages to 'theGrabber' as if it were 'someObject'</span> |
| 89 |
<a name="l00069"></a>00069 <span class="comment"> NSInvocation *theInvocation = [theGrabber invocation];</span> |
| 90 |
<a name="l00070"></a>00070 <span class="comment"> </span> |
| 91 |
<a name="l00071"></a>00071 <span class="comment"> A slightly more concise version (using the covenience category) follows:</span> |
| 92 |
<a name="l00072"></a>00072 <span class="comment"> </span> |
| 93 |
<a name="l00073"></a>00073 <span class="comment"> DDInvocationGrabber *theGrabber = [DDInvocationGrabber invocationGrabber];</span> |
| 94 |
<a name="l00074"></a>00074 <span class="comment"> [[theGrabber prepareWithInvocationTarget:someObject] doSomethingWithParameter:someParameter];</span> |
| 95 |
<a name="l00075"></a>00075 <span class="comment"> NSInvocation *theInvocation = [theGrabber invocation];</span> |
| 96 |
<a name="l00076"></a>00076 <span class="comment"> </span> |
| 97 |
<a name="l00077"></a>00077 <span class="comment"> */</span> |
| 98 |
<a name="l00078"></a>00078 <span class="keyword">@interface </span>DDInvocationGrabber : NSProxy |
| 99 |
<a name="l00079"></a>00079 { |
| 100 |
<a name="l00080"></a>00080 <span class="keywordtype">id</span> _target; |
| 101 |
<a name="l00081"></a>00081 NSInvocation * _invocation; |
| 102 |
<a name="l00082"></a>00082 BOOL _forwardInvokesOnMainThread; |
| 103 |
<a name="l00083"></a>00083 BOOL _waitUntilDone; |
| 104 |
<a name="l00084"></a>00084 } |
| 105 |
<a name="l00085"></a>00085 |
| 106 |
<a name="l00086"></a>00086 <span class="comment">/*</span> |
| 107 |
<a name="l00087"></a>00087 <span class="comment"> * @method invocationGrabber</span> |
| 108 |
<a name="l00088"></a>00088 <span class="comment"> * @abstract Returns a newly allocated, inited, autoreleased DDInvocationGrabber object.</span> |
| 109 |
<a name="l00089"></a>00089 <span class="comment"> */</span> |
| 110 |
<a name="l00090"></a>00090 + (id)invocationGrabber; |
| 111 |
<a name="l00091"></a>00091 |
| 112 |
<a name="l00092"></a>00092 - (id)target; |
| 113 |
<a name="l00093"></a>00093 - (void)setTarget:(<span class="keywordtype">id</span>)inTarget; |
| 114 |
<a name="l00094"></a>00094 |
| 115 |
<a name="l00095"></a>00095 - (NSInvocation *)invocation; |
| 116 |
<a name="l00096"></a>00096 - (void)setInvocation:(NSInvocation *)inInvocation; |
| 117 |
<a name="l00097"></a>00097 |
| 118 |
<a name="l00098"></a>00098 - (BOOL)forwardInvokesOnMainThread; |
| 119 |
<a name="l00099"></a>00099 - (void)setForwardInvokesOnMainThread:(BOOL)forwardInvokesOnMainThread; |
| 120 |
<a name="l00100"></a>00100 |
| 121 |
<a name="l00101"></a>00101 - (BOOL)waitUntilDone; |
| 122 |
<a name="l00102"></a>00102 - (void)setWaitUntilDone:(BOOL)waitUntilDone; |
| 123 |
<a name="l00103"></a>00103 |
| 124 |
<a name="l00104"></a>00104 <span class="keyword">@end</span> |
| 125 |
<a name="l00105"></a>00105 |
| 126 |
<a name="l00106"></a>00106 <span class="keyword">@interface </span>DDInvocationGrabber (DDInvocationGrabber_Conveniences) |
| 127 |
<a name="l00107"></a>00107 |
| 128 |
<a name="l00108"></a>00108 <span class="comment">/*</span> |
| 129 |
<a name="l00109"></a>00109 <span class="comment"> * @method prepareWithInvocationTarget:</span> |
| 130 |
<a name="l00110"></a>00110 <span class="comment"> * @abstract Sets the target object of the receiver and returns itself. The sender can then send a message to the </span> |
| 131 |
<a name="l00111"></a>00111 <span class="comment"> */</span> |
| 132 |
<a name="l00112"></a>00112 - (id)prepareWithInvocationTarget:(<span class="keywordtype">id</span>)inTarget; |
| 133 |
<a name="l00113"></a>00113 |
| 134 |
<a name="l00114"></a>00114 <span class="keyword">@end</span> |
| 135 |
</pre></div></div> |
| 136 |
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 10 18:10:37 2009 for IRCClient by |
| 137 |
<a href="http://www.doxygen.org/index.html"> |
| 138 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address> |
| 139 |
</body> |
| 140 |
</html> |