-
Notifications
You must be signed in to change notification settings - Fork 336
/
CPOperation.j
295 lines (264 loc) · 6.81 KB
/
CPOperation.j
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
/*
* CPOperation.j
*
* Created by Johannes Fahrenkrug.
* Copyright 2009, Springenwerk.
*
* 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
*/
@import "CPArray.j"
@import "CPObject.j"
/*!
Operations receive very low priority for execution.
@global
@group CPOperationQueuePriority
*/
CPOperationQueuePriorityVeryLow = -8;
/*!
Operations receive low priority for execution.
@global
@group CPOperationQueuePriority
*/
CPOperationQueuePriorityLow = -4;
/*!
Operations receive normal priority for execution.
@global
@group CPOperationQueuePriority
*/
CPOperationQueuePriorityNormal = 0;
/*!
Operations receive high priority for execution.
@global
@group CPOperationQueuePriority
*/
CPOperationQueuePriorityHigh = 4;
/*!
Operations receive very high priority for execution.
@global
@group CPOperationQueuePriority
*/
CPOperationQueuePriorityVeryHigh = 8;
/*!
@class CPOperation
@brief Represents an operation that can be run in an CPOperationQueue
It should be subclassed an the subclass should implement its own main method to do the actual work.
*/
@implementation CPOperation : CPObject
{
CPArray operations;
BOOL _cancelled;
BOOL _executing;
BOOL _finished;
BOOL _ready;
int _queuePriority;
JSObject _completionFunction;
CPArray _dependencies;
}
- (void)main
{
// should be overridden in child class
}
- (id)init
{
self = [super init];
if (self)
{
_cancelled = NO;
_executing = NO;
_finished = NO;
_ready = YES;
_dependencies = [[CPArray alloc] init];
_queuePriority = CPOperationQueuePriorityNormal;
}
return self;
}
/*!
Starts the operation (runs the main method), sets all the status flags and runs the completion function if it's set
*/
- (void)start
{
if (!_cancelled)
{
[self willChangeValueForKey:@"isExecuting"];
_executing = YES;
[self didChangeValueForKey:@"isExecuting"];
[self main];
if (_completionFunction)
{
_completionFunction();
}
[self willChangeValueForKey:@"isExecuting"];
_executing = NO;
[self didChangeValueForKey:@"isExecuting"];
[self willChangeValueForKey:@"isFinished"];
_finished = YES;
[self didChangeValueForKey:@"isFinished"];
}
}
/*!
Indicates if this operation has been cancelled
@return if this operation has been cancelled
*/
- (BOOL)isCancelled
{
return _cancelled;
}
/*!
Indicates if this operation is currently executing
@return if this operation is currently executing
*/
- (BOOL)isExecuting
{
return _executing;
}
/*!
Indicates if this operation has finished running
@return if this operation has finished running
*/
- (BOOL)isFinished
{
return _finished;
}
/*!
Just added for Cocoa compatibility
@return always false
*/
- (BOOL)isConcurrent
{
return NO;
}
/*!
Indicates if this operation is ready to be executed. Takes the "isFinished" state of dependent operations into account
@return if this operation is ready to run
*/
- (BOOL)isReady
{
return _ready;
}
/*!
The JS function that should be run after the main method
@return JS function
*/
- (JSObject)completionFunction
{
return _completionFunction;
}
/*!
Sets the JS function that should be run after the main method
*/
- (void)setCompletionFunction:(JSObject)aJavaScriptFunction
{
_completionFunction = aJavaScriptFunction;
}
/*!
Makes the receiver dependent on the completion of the specified operation.
@param anOperation the operation that the receiver should depend on
*/
- (void)addDependency:(CPOperation)anOperation
{
[self willChangeValueForKey:@"dependencies"];
[anOperation addObserver:self
forKeyPath:@"isFinished"
options:(CPKeyValueObservingOptionNew)
context:NULL];
[_dependencies addObject:anOperation];
[self didChangeValueForKey:@"dependencies"];
[self _updateIsReadyState];
}
/*!
Removes the receiver’s dependence on the specified operation.
@param anOperation the operation that the receiver should no longer depend on
*/
- (void)removeDependency:(CPOperation)anOperation
{
[self willChangeValueForKey:@"dependencies"];
[_dependencies removeObject:anOperation];
[anOperation removeObserver:self
forKeyPath:@"isFinished"];
[self didChangeValueForKey:@"dependencies"];
[self _updateIsReadyState];
}
/*!
The operations that the receiver depends on
@return array of operations
*/
- (CPArray)dependencies
{
return _dependencies;
}
/*!
Just added for Cocoa compatibility, doesn't do anything
*/
- (void)waitUntilFinished
{
}
/*!
Advises the operation object that it should stop executing its task.
*/
- (void)cancel
{
[self willChangeValueForKey:@"isCancelled"];
_cancelled = YES;
[self didChangeValueForKey:@"isCancelled"];
}
/*!
Sets the priority of the operation when used in an operation queue.
@param priority the priority
*/
- (void)setQueuePriority:(int)priority
{
_queuePriority = priority;
}
/*!
The priority of the operation when used in an operation queue.
@return the priority
*/
- (int)queuePriority
{
return _queuePriority;
}
// We need to observe the "isFinished" key of our dependent operations so we can update our own "isReady" state
- (void)observeValueForKeyPath:(CPString)keyPath
ofObject:(id)object
change:(CPDictionary)change
context:(void)context
{
if (keyPath == @"isFinished")
{
[self _updateIsReadyState];
}
}
- (void)_updateIsReadyState
{
var newReady = YES;
if (_dependencies && [_dependencies count] > 0)
{
var i = 0;
for (i = 0; i < [_dependencies count]; i++)
{
if (![[_dependencies objectAtIndex:i] isFinished])
{
newReady = NO;
}
}
}
if (newReady != _ready)
{
[self willChangeValueForKey:@"isReady"];
_ready = newReady;
[self didChangeValueForKey:@"isReady"];
}
}
@end