-
Notifications
You must be signed in to change notification settings - Fork 1
/
CWQueue.m
254 lines (211 loc) · 6.91 KB
/
CWQueue.m
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
/*
// CWQueue.m
// Zangetsu
//
// Created by Colin Wheeler on 10/29/11.
// Copyright (c) 2012. All rights reserved.
//
Copyright (c) 2013, Colin Wheeler
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
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.
*/
#import "CWQueue.h"
#import <libkern/OSAtomic.h>
@interface CWQueue()
//private internal ivar
@property(nonatomic, strong) NSMutableArray *dataStore;
@property(nonatomic) dispatch_queue_t queue;
@end
static int64_t queueCounter = 0;
@implementation CWQueue
/**
Note on the usage of dispatch_barrier_sync(_storageQueue, ^{ });
these are synchronization points. Anytime a "batch operation" ie
a method that alters more than 1 object in the queue appears then
these are needed to ensure that all operations before that point
complete and any ones at the end of the method ensure that all
operations enqueued complete before going on.
*/
#pragma mark Initiailziation -
/**
Initializes a CWQueue object with no contents
Initializes & returns an empty CWQueue object ready to
accept objects to be added to it.
@return a CWQueue object ready to accept objects to be added to it.
*/
-(instancetype)init {
self = [super init];
if (self == nil) return nil;
_dataStore = [NSMutableArray array];
const char *label = [[NSString stringWithFormat:@"com.Zangetsu.CWStack_%lli",
OSAtomicIncrement64(&queueCounter)] UTF8String];
_queue = dispatch_queue_create(label, DISPATCH_QUEUE_SERIAL);
return self;
}
-(instancetype)initWithObjectsFromArray:(NSArray *)array {
self = [super init];
if (self == nil) return nil;
_dataStore = [NSMutableArray arrayWithArray:array];
const char *label = [[NSString stringWithFormat:@"com.Zangetsu.CWStack_%lli",
OSAtomicIncrement64(&queueCounter)] UTF8String];
_queue = dispatch_queue_create(label, DISPATCH_QUEUE_SERIAL);
return self;
}
#pragma mark Add & Remove Objects -
-(id)dequeue {
__block id object = nil;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
if (sself.dataStore.count == 0) return;
object = sself.dataStore[0];
[sself.dataStore removeObjectAtIndex:0];
});
return object;
}
-(void)enqueue:(id)object {
if (object == nil) return;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
[sself.dataStore addObject:object];
});
}
-(void)enqueueObjectsFromArray:(NSArray *)objects {
if(objects.count == 0) return;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
[sself.dataStore addObjectsFromArray:objects];
});
}
-(void)removeAllObjects {
__typeof(self) __weak wself = self;
dispatch_async(self.queue, ^{
__typeof(wself) __strong sself = wself;
[sself.dataStore removeAllObjects];
});
}
#pragma mark Query Methods -
-(BOOL)containsObject:(id)object {
__block BOOL contains = NO;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
contains = [sself.dataStore containsObject:object];
});
return contains;
}
-(BOOL)containsObjectWithBlock:(BOOL (^)(id obj))block {
__block BOOL contains = NO;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
NSUInteger index = [sself.dataStore indexOfObjectPassingTest:^BOOL(id obj, NSUInteger idx, BOOL *stop) {
return block(obj);
}];
contains = (index != NSNotFound);
});
return contains;
}
-(id)peek {
__block id object = nil;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
if (sself.dataStore.count >= 1) {
object = sself.dataStore[0];
}
});
return object;
}
#pragma mark Enumeration Methods -
-(void)enumerateObjectsInQueue:(void(^)(id object, BOOL *stop))block {
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
BOOL shouldStop = NO;
for (id object in sself.dataStore) {
block(object,&shouldStop);
if (shouldStop) return;
}
});
}
-(void)dequeueOueueWithBlock:(void(^)(id object, BOOL *stop))block {
if(self.dataStore.count == 0) return;
BOOL shouldStop = NO;
id dequeuedObject = nil;
do {
dequeuedObject = [self dequeue];
if(dequeuedObject){
block(dequeuedObject,&shouldStop);
}
} while ((shouldStop == NO) && (dequeuedObject));
}
-(void)dequeueToObject:(id)targetObject
withBlock:(void(^)(id object))block {
if (![self.dataStore containsObject:targetObject]) return;
[self dequeueOueueWithBlock:^(id object, BOOL *stop) {
block(object);
if ([object isEqual:targetObject]) *stop = YES;
}];
}
#pragma mark Debug Information -
/**
Returns an NSString with a description of the queues storage
@return a NSString detailing the queues internal storage
*/
-(NSString *)description {
__block NSString *queueDescription = nil;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
queueDescription = [sself.dataStore description];
});
return queueDescription;
}
-(NSUInteger)count {
__block NSUInteger queueCount = 0;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
queueCount = sself.dataStore.count;
});
return queueCount;
}
-(BOOL)isEmpty {
__block BOOL queueEmpty = YES;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
queueEmpty = (sself.dataStore.count == 0);
});
return queueEmpty;
}
#pragma mark Comparison -
-(BOOL)isEqualToQueue:(CWQueue *)aQueue {
__block BOOL isEqual = NO;
__typeof(self) __weak wself = self;
dispatch_sync(self.queue, ^{
__typeof(wself) __strong sself = wself;
isEqual = [sself.dataStore isEqual:aQueue.dataStore];
});
return isEqual;
}
@end