-
Notifications
You must be signed in to change notification settings - Fork 0
/
CSVDocument.m
477 lines (374 loc) · 12.3 KB
/
CSVDocument.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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
//
// CSVDocument.m
// QuickLookCSV
//
// Created by Pascal Pfiffner on 03.07.09.
// This sourcecode is released under the Apache License, Version 2.0
// http://www.apache.org/licenses/LICENSE-2.0.html
//
#import "CSVDocument.h"
#import "CSVRow.h"
#import "CSVColumn.h"
#import "CSVRowController.h"
#import "PPStringFormat.h"
@interface CSVDocument (Private)
- (void) setColumnDict:(NSDictionary *)newColumnDict;
@end
@implementation CSVDocument
@synthesize delegate, separator, rows, numRows, columnDict, rowController, parseSuccessful, autoDetectSeparator, headerRow, mustAbortImport, didAbortImport;
@synthesize columns;
@dynamic firstRowIsHeaderRow;
- (id) init
{
self = [super init];
if (nil != self) {
self.separator = @",";
[self setNewColumns:[NSArray arrayWithObject:[CSVColumn columnWithKey:@"col_0"]]];
self.rows = [NSMutableArray array];
self.rowController = [[[CSVRowController alloc] initWithContent:rows] autorelease];
rowController.document = self;
}
return self;
}
+ (id) csvDocument
{
return [[[self alloc] init] autorelease];
}
- (void) dealloc
{
self.delegate = nil;
self.separator = nil;
self.rows = nil;
self.columns = nil;
self.rowController = nil;
self.headerRow = nil;
[super dealloc];
}
#pragma mark -
#pragma mark KVC
- (void) setColumnDict:(NSDictionary *)newColumnDict
{
if (newColumnDict != columnDict) {
[columnDict release];
columnDict = [newColumnDict retain];
}
}
- (BOOL) firstRowIsHeaderRow
{
return firstRowIsHeaderRow;
}
- (void) setFirstRowIsHeaderRow:(BOOL)isHeaderRow
{
// copy data from row 0 to the header and remove row 0
if (isHeaderRow) {
if ([rows count] > 0) {
[self changeHeaderRow:[[rowController arrangedObjects] objectAtIndex:0]];
[rowController removeObjectAtArrangedObjectIndex:0];
}
}
// copy data from the header to a newly inserted row 0
else {
if (nil != headerRow) {
CSVRow *headerCopy = [headerRow copy];
[rowController insertObject:headerCopy atArrangedObjectIndex:0];
[headerCopy release];
}
}
// update num rows
[self setNumRowsWithInt:[rows count]];
firstRowIsHeaderRow = isHeaderRow;
}
- (void) setNumRowsWithInt:(NSInteger)num_rows
{
[self willChangeValueForKey:@"numRows"];
self.numRows = [NSNumber numberWithInt:num_rows];
[self didChangeValueForKey:@"numRows"];
}
#pragma mark -
#pragma mark Parsing
- (NSUInteger) numRowsToExpect:(NSString *)string
{
return [[string componentsSeparatedByCharactersInSet:[NSCharacterSet newlineCharacterSet]] count];
}
- (BOOL) parseCSVString:(NSString *)string error:(NSError **)error
{
return [self parseCSVString:string maxRows:0 error:error];
}
- (BOOL) parseCSVString:(NSString *)string maxRows:(NSUInteger)maxRows error:(NSError **)error
{
NSUInteger num_rows = 0;
BOOL success = YES;
// this thing is thread safe
[string retain];
NSAutoreleasePool *outerPool = [[NSAutoreleasePool alloc] init];
// String is non-empty
if ([string length] > 0) {
[rows removeAllObjects];
BOOL sendStatusUpdateToDelegate = (nil != delegate) && [delegate respondsToSelector:@selector(csvDocumentDidParseNumRows:)];
// collect the columns
NSMutableArray *newColumns = [NSMutableArray array];
// Check whether the file uses ";" or TAB as separator by comparing relative occurrences in the first 200 chars
if (autoDetectSeparator) {
self.separator = @",";
NSUInteger testStringLength = ([string length] > 200) ? 200 : [string length];
NSString *testString = [string substringToIndex:testStringLength];
NSArray *possSeparators = [NSArray arrayWithObjects:@";", @" ", nil];
for(NSString *s in possSeparators) {
if ([[testString componentsSeparatedByString:s] count] > [[testString componentsSeparatedByString:separator] count]) {
self.separator = s;
}
}
}
// Get newline character set
NSMutableCharacterSet *newlineCharacterSet = [NSMutableCharacterSet whitespaceAndNewlineCharacterSet];
[newlineCharacterSet formIntersectionWithCharacterSet:[[NSCharacterSet whitespaceCharacterSet] invertedSet]];
// Characters where the parser should stop
NSMutableCharacterSet *importantCharactersSet = [NSMutableCharacterSet characterSetWithCharactersInString:[NSString stringWithFormat:@"%@\"", separator]];
[importantCharactersSet formUnionWithCharacterSet:newlineCharacterSet];
// Create scanner and scan the string
// ideas for the following block from Drew McCormack >> http://www.macresearch.org/cocoa-scientists-part-xxvi-parsing-csv-data
BOOL insideQuotes = NO; // needed to determine whether we're inside doublequotes
BOOL finishedRow = NO; // used for the inner while loop
NSMutableString *currentCellString = [NSMutableString string];
NSUInteger colIndex = 0;
CSVColumn *column;
// our NSScanner
NSScanner *scanner = [NSScanner scannerWithString:string];
[scanner setCharactersToBeSkipped:nil];
// an inner pool for the loop
NSAutoreleasePool *innerPool = [[NSAutoreleasePool alloc] init];
while (![scanner isAtEnd]) {
if (self.mustAbortImport) {
self.didAbortImport = YES;
break;
}
// we'll end up here after every row
insideQuotes = NO;
finishedRow = NO;
[currentCellString setString:@""];
colIndex = 0;
CSVRow *newRow = [CSVRow rowForDocument:self];
// Scan row up to the next terminator
while (!finishedRow) {
NSString *tempString;
// get the current column
if ([newColumns count] > colIndex) {
column = [newColumns objectAtIndex:colIndex];
}
else {
column = [CSVColumn columnWithKey:[NSString stringWithFormat:@"col_%i", colIndex]];
column.active = YES;
[newColumns addObject:column];
}
// Scan characters into our string
if ([scanner scanUpToCharactersFromSet:importantCharactersSet intoString:&tempString] ) {
[currentCellString appendString:tempString];
}
// found the separator
if ([scanner scanString:separator intoString:NULL]) {
if (insideQuotes) { // Separator character inside double quotes
[currentCellString appendString:separator];
}
else { // This is a column separating comma
[newRow setValue:[currentCellString copy] forColumn:column];
if (![column hasName]) {
column.name = [newRow valueForColumn:column];
}
// on to the next column/cell!
[currentCellString setString:@""];
[scanner scanCharactersFromSet:[NSCharacterSet whitespaceCharacterSet] intoString:NULL];
colIndex++;
}
}
// found a doublequote (")
else if ([scanner scanString:@"\"" intoString:NULL]) {
if (insideQuotes && [scanner scanString:@"\"" intoString:NULL]) { // Replace double - doublequotes with a single doublequote in our string.
[currentCellString appendString:@"\""];
}
else { // Start or end of a quoted string.
insideQuotes = !insideQuotes;
}
}
// found a newline
else if ([scanner scanCharactersFromSet:newlineCharacterSet intoString:&tempString]) {
if (insideQuotes) { // We're inside quotes - add line break to column text
[currentCellString appendString:tempString];
}
else { // End of row
[newRow setValue:[currentCellString copy] forColumn:column];
if (![column hasName]) {
column.name = [newRow valueForColumn:column];
}
finishedRow = YES;
}
}
// found the end
else if ([scanner isAtEnd]) {
[newRow setValue:[currentCellString copy] forColumn:column];
if (![column hasName]) {
column.name = [newRow valueForColumn:column];
}
finishedRow = YES;
}
}
// one row scanned - add to the lines array
if ([newColumns count] > 0) {
[rows addObject:newRow];
}
num_rows++;
if ((maxRows > 0) && (num_rows > maxRows)) {
break;
}
// clean the pool and update status
if (0 == (num_rows % 100)) {
[innerPool release];
innerPool = [[NSAutoreleasePool alloc] init];
if (sendStatusUpdateToDelegate) {
[delegate csvDocumentDidParseNumRows:num_rows];
}
}
}
[innerPool release];
// finished scanning our string; make first row the headerRow
[self setNewColumns:newColumns];
if ([rows count] > 0) {
[self changeHeaderRow:[rows objectAtIndex:0]];
}
}
// empty string
else {
NSDictionary *errorDict = [NSDictionary dictionaryWithObject:@"Cannot parse a nil string" forKey:@"userInfo"];
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:1 userInfo:errorDict];
success = NO;
}
// clean the outer pool
[outerPool release];
[string release];
self.numRows = [NSNumber numberWithInt:num_rows];
self.parseSuccessful = success;
// tell the delegate
if (nil != delegate) {
[delegate csvDocumentDidParseString:self];
}
return success;
}
#pragma mark -
#pragma mark Returning as String
- (NSString *) stringInFormat:(PPStringFormat *)format withColumns:(NSArray *)columnArray forRowIndexes:(NSIndexSet *)rowIndexes writeHeader:(BOOL)headerFlag
{
if ([columnArray count] < 1) {
return @"";
}
if (nil == format) {
format = [PPStringFormat csvFormat];
}
// extract keys from column objects
NSMutableArray *columnKeys = [NSMutableArray arrayWithCapacity:[columnArray count]];
for (CSVColumn *column in columnArray) {
[columnKeys addObject:column.key];
}
// get header row
NSArray *headerRows = nil;
if(headerFlag && (nil != headerRow)) {
headerRows = [NSArray arrayWithObject:headerRow];
}
// get desired row indexes if not given
if (nil == rowIndexes) {
if (NSNotFound == [rowController selectionIndex]) {
NSRange fullRange = NSMakeRange(0, [rows count]);
rowIndexes = [NSIndexSet indexSetWithIndexesInRange:fullRange];
}
else {
rowIndexes = [rowController selectionIndexes];
}
}
NSArray *exportRows = [[rowController arrangedObjects] objectsAtIndexes:rowIndexes];
// get the string from the formatter
return [format stringForRows:exportRows headerRows:headerRows withKeys:columnKeys];
}
#pragma mark -
#pragma mark Column Handling
- (void) changeHeaderRow:(CSVRow *)newHeaderRow
{
if (newHeaderRow != headerRow) {
[self willChangeValueForKey:@"headerRow"];
self.headerRow = newHeaderRow;
[self didChangeValueForKey:@"headerRow"];
// update column names
if (nil != headerRow) {
for (CSVColumn *column in columns) {
column.name = [headerRow valueForColumn:column];
}
}
}
}
- (void) setNewColumns:(NSArray *)newColumns
{
if (columns != newColumns) {
self.columns = newColumns;
// we also represent the columns in a hash, mostly due to faster access and bindability
if (nil != newColumns) {
NSMutableDictionary *columnHash = [NSMutableDictionary dictionaryWithCapacity:[columns count]];
for (CSVColumn *column in columns) {
[columnHash setObject:column forKey:column.key];
}
[self setColumnDict:columnHash];
}
}
}
- (BOOL) isFirstColumnKey:(NSString *)columnKey
{
if ((nil != columns) && ([columns count] > 0)) {
CSVColumn *firstColumn = [columns objectAtIndex:0];
return [columnKey isEqualToString:firstColumn.name];
}
return NO;
}
- (BOOL) hasColumnKey:(NSString *)columnKey
{
return (nil != [columnDict objectForKey:columnKey]);
}
- (void) setColumnOrderByKeys:(NSArray *)newOrderKeys
{
NSMutableArray *arr = [NSMutableArray arrayWithCapacity:[newOrderKeys count]];
for (NSString *columnKey in newOrderKeys) {
CSVColumn *column = [columnDict objectForKey:columnKey];
if (nil != column) {
[arr addObject:column];
}
}
self.columns = arr;
NSLog(@"columns: %@", columns);
}
- (NSString *) nameForColumn:(NSString *)columnKey
{
return [self nameForColumn:columnKey quoted:NO];
}
- (NSString *) nameForColumn:(NSString *)columnKey quoted:(BOOL)quoted
{
NSString *name = ((CSVColumn *)[columnDict objectForKey:columnKey]).name;
return quoted ? [NSString stringWithFormat:@"\"%@\"", name] : name;
}
- (void) setHeaderName:(NSString *)newName forColumnKey:(NSString *)columnKey
{
CSVColumn *column = [columnDict objectForKey:columnKey];
column.name = newName;
}
- (void) setHeaderActive:(BOOL)active forColumnKey:(NSString *)columnKey
{
CSVColumn *column = [columnDict objectForKey:columnKey];
column.active = active;
}
#pragma mark -
#pragma mark Row Handling
- (CSVRow *) rowAtIndex:(NSUInteger)rowIndex
{
return [rows objectAtIndex:rowIndex];
}
#pragma mark -
#pragma mark Utilities
- (NSString *) description
{
return [NSString stringWithFormat:@"%@ <0x%X>; %@ rows", [self className], self, numRows];
}
@end