forked from tomaz/appledoc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Store.m
452 lines (378 loc) · 16.8 KB
/
Store.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
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
//
// Store.m
// appledoc
//
// Created by Tomaž Kragelj on 3/19/12.
// Copyright (c) 2012 Tomaz Kragelj. All rights reserved.
//
#import "Objects.h"
#import "Store.h"
@interface Store ()
@property (nonatomic, readonly) id previousRegistrationObject;
@property (nonatomic, strong) id lastPoppedRegistrationObject;
@property (nonatomic, strong) PKToken *currentSourceInfo;
@property (nonatomic, strong) NSMutableArray *registrationStack;
@end
#pragma mark -
@implementation Store
#pragma mark - StoreRegistrar and related stuff
- (BOOL)expectCurrentRegistrationObjectRespondTo:(SEL)selector {
if (self.registrationStack.count == 0) {
LogStoWarn(@"Expecting at least one object responding to %@ on registration stack!", NSStringFromSelector(selector));
return NO;
}
if (![self.currentRegistrationObject respondsToSelector:selector]) {
LogStoWarn(@"Current object %@ on registration stack doesn't respond to %@!", self.currentRegistrationObject, NSStringFromSelector(selector));
return NO;
}
return YES;
}
- (BOOL)doesCurrentRegistrationObjectRespondTo:(SEL)selector {
if (self.registrationStack.count == 0) return NO;
if (![self.currentRegistrationObject respondsToSelector:selector]) return NO;
return YES;
}
- (BOOL)doesPreviousRegistrationObjectRespondTo:(SEL)selector {
id object = self.previousRegistrationObject;
if (!object) return NO;
if (![object respondsToSelector:selector]) return NO;
return YES;
}
- (void)pushRegistrationObject:(id)object {
LogStoDebug(@"Pushing object %@ to registration stack...", object);
[self.registrationStack addObject:object];
}
- (id)popRegistrationObject {
id result = self.currentRegistrationObject;
self.lastPoppedRegistrationObject = result;
[self.registrationStack removeLastObject];
return result;
}
- (id)currentRegistrationObject {
return [self.registrationStack lastObject];
}
- (id)previousRegistrationObject {
if (self.registrationStack.count < 2) return nil;
NSUInteger index = self.registrationStack.count - 2;
return (self.registrationStack)[index];
}
- (NSMutableArray *)registrationStack {
if (_registrationStack) return _registrationStack;
LogIntDebug(@"Initializing registration stack due to first access...");
_registrationStack = [[NSMutableArray alloc] init];
return _registrationStack;
}
#pragma mark - Common functionality
- (void)createCommentFromText:(NSString *)text registerTo:(id)object {
LogStoVerbose(@"Creating comment from %@ for %@...", [text gb_description], object);
CommentInfo *info = [[CommentInfo alloc] init];
info.sourceToken = self.currentSourceInfo;
info.sourceString = text;
[object setComment:info];
}
#pragma mark - Customized modifiers
- (void)setCurrentSourceInfo:(PKToken *)value {
LogIntDebug(@"Changing current source info to line %lu...", value.location.y);
_currentSourceInfo = value;
if ([self doesCurrentRegistrationObjectRespondTo:@selector(setCurrentSourceInfo:)]) {
LogIntDebug(@"Passing source info to current registration object...");
[self.currentRegistrationObject setCurrentSourceInfo:value];
}
}
#pragma mark - Properties
- (NSMutableArray *)storeClasses {
if (_storeClasses) return _storeClasses;
LogIntDebug(@"Initializing store classes array due to first access...");
_storeClasses = [[NSMutableArray alloc] init];
return _storeClasses;
}
- (NSMutableArray *)storeExtensions {
if (_storeExtensions) return _storeExtensions;
LogIntDebug(@"Initializing store extensions array due to first access...");
_storeExtensions = [[NSMutableArray alloc] init];
return _storeExtensions;
}
- (NSMutableArray *)storeCategories {
if (_storeCategories) return _storeCategories;
LogIntDebug(@"Initializing store categories array due to first access...");
_storeCategories = [[NSMutableArray alloc] init];
return _storeCategories;
}
- (NSMutableArray *)storeProtocols {
if (_storeProtocols) return _storeProtocols;
LogIntDebug(@"Initializing store protocols array due to first access...");
_storeProtocols = [[NSMutableArray alloc] init];
return _storeProtocols;
}
- (NSMutableArray *)storeEnumerations {
if (_storeEnumerations) return _storeEnumerations;
LogIntDebug(@"Initializing store enumerations array due to first access...");
_storeEnumerations = [[NSMutableArray alloc] init];
return _storeEnumerations;
}
- (NSMutableArray *)storeStructs {
if (_storeStructs) return _storeStructs;
LogIntDebug(@"Initializing store structs array due to first access...");
_storeStructs = [[NSMutableArray alloc] init];
return _storeStructs;
}
- (NSMutableArray *)storeConstants {
if (_storeConstants) return _storeConstants;
LogIntDebug(@"Initializing store constants array due to first access...");
_storeConstants = [[NSMutableArray alloc] init];
return _storeConstants;
}
@end
#pragma mark -
@implementation Store (Registrations)
#pragma mark - Classes, categories and protocols handling
- (void)beginClassWithName:(NSString *)name derivedFromClassWithName:(NSString *)derived {
LogStoInfo(@"Starting class %@ derived from %@...", name, derived);
ClassInfo *info = [[ClassInfo alloc] initWithRegistrar:self];
info.sourceToken = self.currentSourceInfo;
info.nameOfClass = name;
info.nameOfSuperClass = derived;
[self.storeClasses addObject:info];
[self pushRegistrationObject:info];
}
- (void)beginExtensionForClassWithName:(NSString *)name {
LogStoInfo(@"Starting class extenstion for class %@...", name);
CategoryInfo *info = [[CategoryInfo alloc] initWithRegistrar:self];
info.sourceToken = self.currentSourceInfo;
info.nameOfClass = name;
info.nameOfCategory = nil;
[self.storeExtensions addObject:info];
[self pushRegistrationObject:info];
}
- (void)beginCategoryWithName:(NSString *)category forClassWithName:(NSString *)name {
LogStoInfo(@"Starting category %@ for class %@...", category, name);
CategoryInfo *info = [[CategoryInfo alloc] initWithRegistrar:self];
info.sourceToken = self.currentSourceInfo;
info.nameOfClass = name;
info.nameOfCategory = category;
[self.storeCategories addObject:info];
[self pushRegistrationObject:info];
}
- (void)beginProtocolWithName:(NSString *)name {
LogStoInfo(@"Starting protocol %@...", name);
ProtocolInfo *info = [[ProtocolInfo alloc] initWithRegistrar:self];
info.sourceToken = self.currentSourceInfo;
info.nameOfProtocol = name;
[self.storeProtocols addObject:info];
[self pushRegistrationObject:info];
}
- (void)appendAdoptedProtocolWithName:(NSString *)name {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding adopted protocol registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendAdoptedProtocolWithName:name];
}
#pragma mark - Method groups
- (void)appendMethodGroupWithDescription:(NSString *)description {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding method group description registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendMethodGroupWithDescription:description];
}
#pragma mark - Properties
- (void)beginPropertyDefinition {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding property definition registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginPropertyDefinition];
}
- (void)beginPropertyAttributes {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding property attributes registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginPropertyAttributes];
}
- (void)beginPropertyTypes {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding property types registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginPropertyTypes];
}
- (void)beginPropertyDescriptors {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding property descriptors registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginPropertyDescriptors];
}
- (void)appendPropertyName:(NSString *)name {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding property name registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendPropertyName:name];
}
#pragma mark - Methods
- (void)beginMethodDefinitionWithType:(NSString *)type {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding method definition registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginMethodDefinitionWithType:type];
}
- (void)beginMethodResults {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding method results registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginMethodResults];
}
- (void)beginMethodArgument {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding method arguments registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginMethodArgument];
}
- (void)beginMethodArgumentTypes {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding method argument types registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginMethodArgumentTypes];
}
- (void)beginMethodDescriptors {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding method descriptors registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginMethodDescriptors];
}
- (void)appendMethodArgumentSelector:(NSString *)name {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding method argument selector registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendMethodArgumentSelector:name];
}
- (void)appendMethodArgumentVariable:(NSString *)name {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding method argument variable registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendMethodArgumentVariable:name];
}
#pragma mark - Enumerations
- (void)beginEnumeration {
LogStoInfo(@"Starting enumeration...");
EnumInfo *info = [[EnumInfo alloc] initWithRegistrar:self];
info.sourceToken = self.currentSourceInfo;
[self.storeEnumerations addObject:info];
[self pushRegistrationObject:info];
}
- (void)appendEnumerationName:(NSString *)name {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding enumeration name registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendEnumerationName:name];
}
- (void)appendEnumerationItem:(NSString *)name {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding enumeration item registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendEnumerationItem:name];
}
- (void)appendEnumerationValue:(NSString *)value {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding enumeration value registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendEnumerationValue:value];
}
#pragma mark - Structs
- (void)beginStruct {
LogStoInfo(@"Starting C struct...");
StructInfo *info = [[StructInfo alloc] initWithRegistrar:self];
info.sourceToken = self.currentSourceInfo;
[self.storeStructs addObject:info];
[self pushRegistrationObject:info];
}
- (void)appendStructName:(NSString *)name {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoVerbose(@"Forwarding struct name registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendStructName:name];
}
#pragma mark - Constants
- (void)beginConstant {
if ([self doesCurrentRegistrationObjectRespondTo:_cmd]) {
LogStoDebug(@"Forwarding constant registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginConstant];
return;
}
LogStoInfo(@"Starting constant...");
ConstantInfo *info = [[ConstantInfo alloc] initWithRegistrar:self];
info.sourceToken = self.currentSourceInfo;
[self.storeConstants addObject:info];
[self pushRegistrationObject:info];
}
- (void)beginConstantTypes {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding constant types registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginConstantTypes];
}
- (void)beginConstantDescriptors {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding constant descriptors registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject beginConstantDescriptors];
}
- (void)appendConstantName:(NSString *)name {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding constant name registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendConstantName:name];
}
#pragma mark - General objects
- (void)appendType:(NSString *)type {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding type registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendType:type];
}
- (void)appendAttribute:(NSString *)attribute {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding attribute registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendAttribute:attribute];
}
- (void)appendDescriptor:(NSString *)descriptor {
if (![self expectCurrentRegistrationObjectRespondTo:_cmd]) return;
LogStoDebug(@"Forwarding descriptor registration to %@...", self.currentRegistrationObject);
[self.currentRegistrationObject appendDescriptor:descriptor];
}
#pragma mark - Comments
- (void)appendCommentToCurrentObject:(NSString *)comment {
if (![self expectCurrentRegistrationObjectRespondTo:@selector(setComment:)]) return;
[self createCommentFromText:comment registerTo:self.currentRegistrationObject];
}
- (void)appendCommentToPreviousObject:(NSString *)comment {
id object = self.lastPoppedRegistrationObject;
if (!object) {
LogStoWarn(@"No previous object, can't register comment!");
return;
}
if (![object respondsToSelector:@selector(setComment:)]) {
LogStoWarn(@"%@ doesn't respond to setComment:, can't register comment!", object);
return;
}
[self createCommentFromText:comment registerTo:object];
}
#pragma mark - Finalizing registration for current object
- (void)endCurrentObject {
if ([self doesPreviousRegistrationObjectRespondTo:_cmd]) {
LogStoDebug(@"Forwarding end current object to %@...", self.previousRegistrationObject);
[self.previousRegistrationObject endCurrentObject];
}
LogStoInfo(@"Finalizing %@...", self.currentRegistrationObject);
[self popRegistrationObject];
}
- (void)cancelCurrentObject {
// Note that we must forward to object that's currently handling a child, hence previous registration object! However if there's only single object available, it's one of the top-level objects, so we should remove it from our arrays.
if ([self doesPreviousRegistrationObjectRespondTo:_cmd]) {
LogStoDebug(@"Forwarding cancel current object to %@...", self.previousRegistrationObject);
[self.previousRegistrationObject cancelCurrentObject];
} else if (self.currentRegistrationObject) {
LogStoInfo(@"Cancelling %@...", self.currentRegistrationObject);
if ([self.currentRegistrationObject isKindOfClass:[ClassInfo class]]) {
LogStoDebug(@"Removing from classes array...");
[self.storeClasses removeLastObject];
} else if ([self.currentRegistrationObject isKindOfClass:[CategoryInfo class]]) {
if ([self.currentRegistrationObject isExtension]) {
LogStoDebug(@"Removing from extensions array...");
[self.storeExtensions removeLastObject];
} else {
LogStoDebug(@"Removing from categories array...");
[self.storeCategories removeLastObject];
}
} else if ([self.currentRegistrationObject isKindOfClass:[ProtocolInfo class]]) {
LogStoDebug(@"Removing from protocols array...");
[self.storeProtocols removeLastObject];
} else if ([self.currentRegistrationObject isKindOfClass:[EnumInfo class]]) {
LogStoDebug(@"Removing from enumerations array...");
[self.storeEnumerations removeLastObject];
} else if ([self.currentRegistrationObject isKindOfClass:[StructInfo class]]) {
LogStoDebug(@"Removing from structs array...");
[self.storeStructs removeLastObject];
} else if ([self.currentRegistrationObject isKindOfClass:[ConstantInfo class]]) {
LogStoDebug(@"Removing from constants array...");
[self.storeConstants removeLastObject];
}
}
LogStoDebug(@"Popping object from registration stack...");
[self popRegistrationObject];
}
@end