forked from OSGeo/gdal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcpl_csv.cpp
1509 lines (1271 loc) · 55.4 KB
/
cpl_csv.cpp
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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/******************************************************************************
*
* Project: CPL - Common Portability Library
* Purpose: CSV (comma separated value) file access.
* Author: Frank Warmerdam, [email protected]
*
******************************************************************************
* Copyright (c) 1999, Frank Warmerdam
* Copyright (c) 2009-2012, Even Rouault <even dot rouault at spatialys.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#include "cpl_port.h"
#include "cpl_csv.h"
#include <cstddef>
#include <cstdlib>
#include <cstring>
#if HAVE_FCNTL_H
#include <fcntl.h>
#endif
#include "cpl_conv.h"
#include "cpl_error.h"
#include "cpl_multiproc.h"
#include "gdal_csv.h"
CPL_CVSID("$Id$")
/* ==================================================================== */
/* The CSVTable is a persistent set of info about an open CSV */
/* table. While it doesn't currently maintain a record index, */
/* or in-memory copy of the table, it could be changed to do so */
/* in the future. */
/* ==================================================================== */
typedef struct ctb {
VSILFILE *fp;
struct ctb *psNext;
char *pszFilename;
char **papszFieldNames;
int *panFieldNamesLength;
char **papszRecFields;
int nFields;
int iLastLine;
bool bNonUniqueKey;
/* Cache for whole file */
int nLineCount;
char **papszLines;
int *panLineIndex;
char *pszRawData;
} CSVTable;
static void CSVDeaccessInternal( CSVTable **ppsCSVTableList, bool bCanUseTLS,
const char * pszFilename );
/************************************************************************/
/* CSVFreeTLS() */
/************************************************************************/
static void CSVFreeTLS( void* pData )
{
CSVDeaccessInternal( static_cast<CSVTable **>( pData ), false, nullptr );
CPLFree(pData);
}
/* It would likely be better to share this list between threads, but
that will require some rework. */
/************************************************************************/
/* CSVAccess() */
/* */
/* This function will fetch a handle to the requested table. */
/* If not found in the ``open table list'' the table will be */
/* opened and added to the list. Eventually this function may */
/* become public with an abstracted return type so that */
/* applications can set options about the table. For now this */
/* isn't done. */
/************************************************************************/
static CSVTable *CSVAccess( const char * pszFilename )
{
/* -------------------------------------------------------------------- */
/* Fetch the table, and allocate the thread-local pointer to it */
/* if there isn't already one. */
/* -------------------------------------------------------------------- */
int bMemoryError = FALSE;
CSVTable **ppsCSVTableList = static_cast<CSVTable **>(
CPLGetTLSEx( CTLS_CSVTABLEPTR, &bMemoryError ) );
if( bMemoryError )
return nullptr;
if( ppsCSVTableList == nullptr )
{
ppsCSVTableList = static_cast<CSVTable **>(
VSI_CALLOC_VERBOSE( 1, sizeof(CSVTable*) ) );
if( ppsCSVTableList == nullptr )
return nullptr;
CPLSetTLSWithFreeFunc( CTLS_CSVTABLEPTR, ppsCSVTableList, CSVFreeTLS );
}
/* -------------------------------------------------------------------- */
/* Is the table already in the list. */
/* -------------------------------------------------------------------- */
for( CSVTable *psTable = *ppsCSVTableList;
psTable != nullptr;
psTable = psTable->psNext )
{
if( EQUAL(psTable->pszFilename, pszFilename) )
{
/*
* Eventually we should consider promoting to the front of
* the list to accelerate frequently accessed tables.
*/
return psTable;
}
}
/* -------------------------------------------------------------------- */
/* If not, try to open it. */
/* -------------------------------------------------------------------- */
VSILFILE *fp = VSIFOpenL( pszFilename, "rb" );
if( fp == nullptr )
return nullptr;
/* -------------------------------------------------------------------- */
/* Create an information structure about this table, and add to */
/* the front of the list. */
/* -------------------------------------------------------------------- */
CSVTable * const psTable = static_cast<CSVTable *>(
VSI_CALLOC_VERBOSE( sizeof(CSVTable), 1 ) );
if( psTable == nullptr )
{
VSIFCloseL(fp);
return nullptr;
}
psTable->fp = fp;
psTable->pszFilename = VSI_STRDUP_VERBOSE( pszFilename );
if( psTable->pszFilename == nullptr )
{
VSIFree(psTable);
VSIFCloseL(fp);
return nullptr;
}
psTable->bNonUniqueKey = false; // As far as we know now.
psTable->psNext = *ppsCSVTableList;
*ppsCSVTableList = psTable;
/* -------------------------------------------------------------------- */
/* Read the table header record containing the field names. */
/* -------------------------------------------------------------------- */
psTable->papszFieldNames = CSVReadParseLineL( fp );
psTable->nFields = CSLCount(psTable->papszFieldNames);
psTable->panFieldNamesLength = static_cast<int*>(
CPLMalloc(sizeof(int) * psTable->nFields));
for(int i = 0; i < psTable->nFields &&
/* null-pointer check to avoid a false positive from CLang S.A. */
psTable->papszFieldNames != nullptr; i++ )
{
psTable->panFieldNamesLength[i] = static_cast<int>(
strlen(psTable->papszFieldNames[i]));
}
return psTable;
}
/************************************************************************/
/* CSVDeaccess() */
/************************************************************************/
static void CSVDeaccessInternal( CSVTable **ppsCSVTableList, bool bCanUseTLS,
const char * pszFilename )
{
if( ppsCSVTableList == nullptr )
return;
/* -------------------------------------------------------------------- */
/* A NULL means deaccess all tables. */
/* -------------------------------------------------------------------- */
if( pszFilename == nullptr )
{
while( *ppsCSVTableList != nullptr )
CSVDeaccessInternal( ppsCSVTableList, bCanUseTLS,
(*ppsCSVTableList)->pszFilename );
return;
}
/* -------------------------------------------------------------------- */
/* Find this table. */
/* -------------------------------------------------------------------- */
CSVTable *psLast = nullptr;
CSVTable *psTable = *ppsCSVTableList;
for( ;
psTable != nullptr && !EQUAL(psTable->pszFilename, pszFilename);
psTable = psTable->psNext )
{
psLast = psTable;
}
if( psTable == nullptr )
{
if( bCanUseTLS )
CPLDebug( "CPL_CSV", "CPLDeaccess( %s ) - no match.", pszFilename );
return;
}
/* -------------------------------------------------------------------- */
/* Remove the link from the list. */
/* -------------------------------------------------------------------- */
if( psLast != nullptr )
psLast->psNext = psTable->psNext;
else
*ppsCSVTableList = psTable->psNext;
/* -------------------------------------------------------------------- */
/* Free the table. */
/* -------------------------------------------------------------------- */
if( psTable->fp != nullptr )
VSIFCloseL( psTable->fp );
CSLDestroy( psTable->papszFieldNames );
CPLFree( psTable->panFieldNamesLength );
CSLDestroy( psTable->papszRecFields );
CPLFree( psTable->pszFilename );
CPLFree( psTable->panLineIndex );
CPLFree( psTable->pszRawData );
CPLFree( psTable->papszLines );
CPLFree( psTable );
if( bCanUseTLS )
CPLReadLine( nullptr );
}
void CSVDeaccess( const char * pszFilename )
{
/* -------------------------------------------------------------------- */
/* Fetch the table, and allocate the thread-local pointer to it */
/* if there isn't already one. */
/* -------------------------------------------------------------------- */
int bMemoryError = FALSE;
CSVTable **ppsCSVTableList = static_cast<CSVTable **>(
CPLGetTLSEx( CTLS_CSVTABLEPTR, &bMemoryError ) );
CSVDeaccessInternal(ppsCSVTableList, true, pszFilename);
}
/************************************************************************/
/* CSVSplitLine() */
/* */
/* Tokenize a CSV line into fields in the form of a string */
/* list. This is used instead of the CPLTokenizeString() */
/* because it provides correct CSV escaping and quoting */
/* semantics. */
/************************************************************************/
static char **CSVSplitLine( const char *pszString,
const char *pszDelimiter,
bool bKeepLeadingAndClosingQuotes,
bool bMergeDelimiter )
{
CPLStringList aosRetList;
if( pszString == nullptr )
return static_cast<char **>(CPLCalloc(sizeof(char *), 1));
char *pszToken = static_cast<char *>(CPLCalloc(10, 1));
int nTokenMax = 10;
const size_t nDelimiterLength = strlen(pszDelimiter);
const char* pszIter = pszString;
while( *pszIter != '\0' )
{
bool bInString = false;
int nTokenLen = 0;
// Try to find the next delimiter, marking end of token.
do
{
// End if this is a delimiter skip it and break.
if( !bInString && strncmp(pszIter, pszDelimiter, nDelimiterLength) == 0 )
{
pszIter += nDelimiterLength;
if( bMergeDelimiter )
{
while( strncmp(pszIter, pszDelimiter, nDelimiterLength) == 0 )
pszIter += nDelimiterLength;
}
break;
}
if( *pszIter == '"' )
{
if( !bInString || pszIter[1] != '"' )
{
bInString = !bInString;
if( !bKeepLeadingAndClosingQuotes )
continue;
}
else // Doubled quotes in string resolve to one quote.
{
pszIter++;
}
}
if( nTokenLen >= nTokenMax - 2 )
{
nTokenMax = nTokenMax * 2 + 10;
pszToken = static_cast<char *>(CPLRealloc(pszToken, nTokenMax));
}
pszToken[nTokenLen] = *pszIter;
nTokenLen++;
} while( *(++pszIter) != '\0' );
pszToken[nTokenLen] = '\0';
aosRetList.AddString(pszToken);
// If the last token is an empty token, then we have to catch
// it now, otherwise we won't reenter the loop and it will be lost.
if( *pszIter == '\0' &&
pszIter - pszString >= static_cast<int>(nDelimiterLength) &&
strncmp(pszIter - nDelimiterLength, pszDelimiter, nDelimiterLength) == 0 )
{
aosRetList.AddString("");
}
}
CPLFree(pszToken);
if( aosRetList.Count() == 0 )
return static_cast<char **>(CPLCalloc(sizeof(char *), 1));
else
return aosRetList.StealList();
}
/************************************************************************/
/* CSVFindNextLine() */
/* */
/* Find the start of the next line, while at the same time zero */
/* terminating this line. Take into account that there may be */
/* newline indicators within quoted strings, and that quotes */
/* can be escaped with a backslash. */
/************************************************************************/
static char *CSVFindNextLine( char *pszThisLine )
{
int i = 0; // i is used after the for loop.
for( int nQuoteCount = 0; pszThisLine[i] != '\0'; i++ )
{
if( pszThisLine[i] == '\"'
&& (i == 0 || pszThisLine[i-1] != '\\') )
nQuoteCount++;
if( (pszThisLine[i] == 10 || pszThisLine[i] == 13)
&& (nQuoteCount % 2) == 0 )
break;
}
while( pszThisLine[i] == 10 || pszThisLine[i] == 13 )
pszThisLine[i++] = '\0';
if( pszThisLine[i] == '\0' )
return nullptr;
return pszThisLine + i;
}
/************************************************************************/
/* CSVIngest() */
/* */
/* Load entire file into memory and setup index if possible. */
/************************************************************************/
// TODO(schwehr): Clean up all the casting in CSVIngest.
static void CSVIngest( CSVTable *psTable )
{
if( psTable->pszRawData != nullptr )
return;
/* -------------------------------------------------------------------- */
/* Ingest whole file. */
/* -------------------------------------------------------------------- */
if( VSIFSeekL( psTable->fp, 0, SEEK_END ) != 0 )
{
CPLError( CE_Failure, CPLE_FileIO,
"Failed using seek end and tell to get file length: %s",
psTable->pszFilename );
return;
}
const vsi_l_offset nFileLen = VSIFTellL( psTable->fp );
if( static_cast<long>(nFileLen) == -1 )
{
CPLError( CE_Failure, CPLE_FileIO,
"Failed using seek end and tell to get file length: %s",
psTable->pszFilename );
return;
}
VSIRewindL( psTable->fp );
psTable->pszRawData = static_cast<char *>(
VSI_MALLOC_VERBOSE( static_cast<size_t>(nFileLen) + 1) );
if( psTable->pszRawData == nullptr )
return;
if( VSIFReadL( psTable->pszRawData, 1,
static_cast<size_t>(nFileLen), psTable->fp )
!= static_cast<size_t>(nFileLen) )
{
CPLFree( psTable->pszRawData );
psTable->pszRawData = nullptr;
CPLError( CE_Failure, CPLE_FileIO, "Read of file %s failed.",
psTable->pszFilename );
return;
}
psTable->pszRawData[nFileLen] = '\0';
/* -------------------------------------------------------------------- */
/* Get count of newlines so we can allocate line array. */
/* -------------------------------------------------------------------- */
int nMaxLineCount = 0;
for( int i = 0; i < static_cast<int>(nFileLen); i++ )
{
if( psTable->pszRawData[i] == 10 )
nMaxLineCount++;
}
psTable->papszLines = static_cast<char **>(
VSI_CALLOC_VERBOSE( sizeof(char*), nMaxLineCount ) );
if( psTable->papszLines == nullptr )
return;
/* -------------------------------------------------------------------- */
/* Build a list of record pointers into the raw data buffer */
/* based on line terminators. Zero terminate the line */
/* strings. */
/* -------------------------------------------------------------------- */
/* skip header line */
char *pszThisLine = CSVFindNextLine( psTable->pszRawData );
int iLine = 0;
while( pszThisLine != nullptr && iLine < nMaxLineCount )
{
if( pszThisLine[0] != '#' )
psTable->papszLines[iLine++] = pszThisLine;
pszThisLine = CSVFindNextLine( pszThisLine );
}
psTable->nLineCount = iLine;
/* -------------------------------------------------------------------- */
/* Allocate and populate index array. Ensure they are in */
/* ascending order so that binary searches can be done on the */
/* array. */
/* -------------------------------------------------------------------- */
psTable->panLineIndex = static_cast<int *>(
VSI_MALLOC_VERBOSE( sizeof(int) * psTable->nLineCount ) );
if( psTable->panLineIndex == nullptr )
return;
for( int i = 0; i < psTable->nLineCount; i++ )
{
psTable->panLineIndex[i] = atoi(psTable->papszLines[i]);
if( i > 0 && psTable->panLineIndex[i] < psTable->panLineIndex[i-1] )
{
CPLFree( psTable->panLineIndex );
psTable->panLineIndex = nullptr;
break;
}
}
psTable->iLastLine = -1;
/* -------------------------------------------------------------------- */
/* We should never need the file handle against, so close it. */
/* -------------------------------------------------------------------- */
VSIFCloseL( psTable->fp );
psTable->fp = nullptr;
}
static void CSVIngest( const char *pszFilename )
{
CSVTable *psTable = CSVAccess( pszFilename );
if( psTable == nullptr )
{
CPLError( CE_Failure, CPLE_FileIO, "Failed to open file: %s",
pszFilename );
return;
}
CSVIngest(psTable);
}
/************************************************************************/
/* CSVDetectSeperator() */
/************************************************************************/
/** Detect which field separator is used.
*
* Currently, it can detect comma, semicolon, space or tabulation. In case of
* ambiguity or no separator found, comma will be considered as the separator.
*
* @return ',', ';', ' ' or tabulation character.
*/
char CSVDetectSeperator( const char* pszLine )
{
bool bInString = false;
char chDelimiter = '\0';
int nCountSpace = 0;
for( ; *pszLine != '\0'; pszLine++ )
{
if( !bInString && ( *pszLine == ',' || *pszLine == ';'
|| *pszLine == '\t'))
{
if( chDelimiter == '\0' )
{
chDelimiter = *pszLine;
}
else if( chDelimiter != *pszLine )
{
// The separator is not consistent on the line.
CPLDebug( "CSV", "Inconsistent separator. '%c' and '%c' found. "
"Using ',' as default",
chDelimiter, *pszLine);
chDelimiter = ',';
break;
}
}
else if( !bInString && *pszLine == ' ' )
{
nCountSpace++;
}
else if( *pszLine == '"' )
{
if( !bInString || pszLine[1] != '"' )
{
bInString = !bInString;
continue;
}
else /* doubled quotes in string resolve to one quote */
{
pszLine++;
}
}
}
if( chDelimiter == '\0' )
{
if( nCountSpace > 0 )
chDelimiter = ' ';
else
chDelimiter = ',';
}
return chDelimiter;
}
/************************************************************************/
/* CSVReadParseLine3L() */
/* */
/* Read one line, and return split into fields. The return */
/* result is a stringlist, in the sense of the CSL functions. */
/************************************************************************/
static
char **CSVReadParseLineGeneric( void* fp,
const char* (*pfnReadLine)(void*, size_t),
size_t nMaxLineSize,
const char* pszDelimiter,
bool bHonourStrings,
bool bKeepLeadingAndClosingQuotes,
bool bMergeDelimiter,
bool bSkipBOM )
{
const char *pszLine = pfnReadLine(fp, nMaxLineSize);
if( pszLine == nullptr )
return nullptr;
if( bSkipBOM )
{
// Skip BOM.
const GByte *pabyData = reinterpret_cast<const GByte *>(pszLine);
if( pabyData[0] == 0xEF && pabyData[1] == 0xBB && pabyData[2] == 0xBF )
pszLine += 3;
}
// Special fix to read NdfcFacilities.xls with un-balanced double quotes.
if( !bHonourStrings )
{
return CSLTokenizeStringComplex(pszLine, pszDelimiter, FALSE, TRUE);
}
// If there are no quotes, then this is the simple case.
// Parse, and return tokens.
if( strchr(pszLine,'\"') == nullptr )
return CSVSplitLine(pszLine, pszDelimiter,
bKeepLeadingAndClosingQuotes,
bMergeDelimiter);
try
{
// We must now count the quotes in our working string, and as
// long as it is odd, keep adding new lines.
std::string osWorkLine(pszLine);
size_t i = 0;
int nCount = 0;
while( true )
{
for( ; i < osWorkLine.size(); i++ )
{
if( osWorkLine[i] == '\"' )
nCount++;
}
if( nCount % 2 == 0 )
break;
pszLine = pfnReadLine(fp, nMaxLineSize);
if( pszLine == nullptr )
break;
osWorkLine.append("\n");
osWorkLine.append(pszLine);
}
char **papszReturn =
CSVSplitLine(osWorkLine.c_str(),
pszDelimiter,
bKeepLeadingAndClosingQuotes,
bMergeDelimiter);
return papszReturn;
}
catch( const std::exception& e )
{
CPLError(CE_Failure, CPLE_OutOfMemory, "%s", e.what());
return nullptr;
}
}
/************************************************************************/
/* CSVReadParseLine() */
/* */
/* Read one line, and return split into fields. The return */
/* result is a stringlist, in the sense of the CSL functions. */
/* */
/* Deprecated. Replaced by CSVReadParseLineL(). */
/************************************************************************/
char **CSVReadParseLine( FILE * fp )
{
return CSVReadParseLine2(fp, ',');
}
static const char* ReadLineClassicalFile(void* fp, size_t /* nMaxLineSize */)
{
return CPLReadLine(static_cast<FILE*>(fp));
}
char **CSVReadParseLine2( FILE * fp, char chDelimiter )
{
CPLAssert( fp != nullptr );
if( fp == nullptr )
return nullptr;
char szDelimiter[2] = { chDelimiter, 0 };
return CSVReadParseLineGeneric( fp, ReadLineClassicalFile,
0, // nMaxLineSize,
szDelimiter,
true, // bHonourStrings
false, // bKeepLeadingAndClosingQuotes
false, // bMergeDelimiter
true /* bSkipBOM */);
}
/************************************************************************/
/* CSVReadParseLineL() */
/* */
/* Read one line, and return split into fields. The return */
/* result is a stringlist, in the sense of the CSL functions. */
/* */
/* Replaces CSVReadParseLine(). These functions use the VSI */
/* layer to allow reading from other file containers. */
/************************************************************************/
char **CSVReadParseLineL( VSILFILE * fp )
{
return CSVReadParseLine2L(fp, ',');
}
char **CSVReadParseLine2L( VSILFILE * fp, char chDelimiter )
{
CPLAssert( fp != nullptr );
if( fp == nullptr )
return nullptr;
char szDelimiter[2] = { chDelimiter, 0 };
return CSVReadParseLine3L( fp,
0, //nMaxLineSize
szDelimiter,
true, // bHonourStrings
false, // bKeepLeadingAndClosingQuotes
false, // bMergeDelimiter
true /* bSkipBOM */);
}
/************************************************************************/
/* ReadLineLargeFile() */
/************************************************************************/
static const char* ReadLineLargeFile(void* fp, size_t nMaxLineSize )
{
int nBufLength = 0;
return CPLReadLine3L( static_cast<VSILFILE*>(fp),
nMaxLineSize == 0 ?
-1 :
static_cast<int>(nMaxLineSize),
&nBufLength,
nullptr );
}
/************************************************************************/
/* CSVReadParseLine3L() */
/* */
/* Read one line, and return split into fields. The return */
/* result is a stringlist, in the sense of the CSL functions. */
/************************************************************************/
/** Read one line, and return split into fields.
* The return result is a stringlist, in the sense of the CSL functions.
*
* @param fp File handle. Must not be NULL
* @param nMaxLineSize Maximum line size, or 0 for unlimited.
* @param pszDelimiter Delimiter sequence for readers (can be multiple bytes)
* @param bHonourStrings Should be true, unless double quotes should not be
* considered when separating fields.
* @param bKeepLeadingAndClosingQuotes Whether the leading and closing double
* quote characters should be kept.
* @param bMergeDelimiter Whether consecutive delimiters should be considered
* as a single one. Should generally be set to false.
* @param bSkipBOM Whether leading UTF-8 BOM should be skipped.
*/
char **CSVReadParseLine3L( VSILFILE *fp,
size_t nMaxLineSize,
const char* pszDelimiter,
bool bHonourStrings,
bool bKeepLeadingAndClosingQuotes,
bool bMergeDelimiter,
bool bSkipBOM )
{
return CSVReadParseLineGeneric( fp, ReadLineLargeFile,
nMaxLineSize,
pszDelimiter,
bHonourStrings,
bKeepLeadingAndClosingQuotes,
bMergeDelimiter,
bSkipBOM );
}
/************************************************************************/
/* CSVCompare() */
/* */
/* Compare a field to a search value using a particular */
/* criteria. */
/************************************************************************/
static bool CSVCompare( const char * pszFieldValue, const char * pszTarget,
CSVCompareCriteria eCriteria )
{
if( eCriteria == CC_ExactString )
{
return( strcmp( pszFieldValue, pszTarget ) == 0 );
}
else if( eCriteria == CC_ApproxString )
{
return EQUAL( pszFieldValue, pszTarget );
}
else if( eCriteria == CC_Integer )
{
return( CPLGetValueType(pszFieldValue) == CPL_VALUE_INTEGER &&
atoi(pszFieldValue) == atoi(pszTarget) );
}
return false;
}
/************************************************************************/
/* CSVScanLines() */
/* */
/* Read the file scanline for lines where the key field equals */
/* the indicated value with the suggested comparison criteria. */
/* Return the first matching line split into fields. */
/* */
/* Deprecated. Replaced by CSVScanLinesL(). */
/************************************************************************/
char **CSVScanLines( FILE *fp, int iKeyField, const char * pszValue,
CSVCompareCriteria eCriteria )
{
CPLAssert( pszValue != nullptr );
CPLAssert( iKeyField >= 0 );
CPLAssert( fp != nullptr );
bool bSelected = false;
const int nTestValue = atoi(pszValue);
char **papszFields = nullptr;
while( !bSelected ) {
papszFields = CSVReadParseLine( fp );
if( papszFields == nullptr )
return nullptr;
if( CSLCount( papszFields ) < iKeyField+1 )
{
/* not selected */
}
else if( eCriteria == CC_Integer
&& atoi(papszFields[iKeyField]) == nTestValue )
{
bSelected = true;
}
else
{
bSelected = CSVCompare( papszFields[iKeyField], pszValue,
eCriteria );
}
if( !bSelected )
{
CSLDestroy( papszFields );
papszFields = nullptr;
}
}
return papszFields;
}
/************************************************************************/
/* CSVScanLinesL() */
/* */
/* Read the file scanline for lines where the key field equals */
/* the indicated value with the suggested comparison criteria. */
/* Return the first matching line split into fields. */
/************************************************************************/
char **CSVScanLinesL( VSILFILE *fp, int iKeyField, const char * pszValue,
CSVCompareCriteria eCriteria )
{
CPLAssert( pszValue != nullptr );
CPLAssert( iKeyField >= 0 );
CPLAssert( fp != nullptr );
bool bSelected = false;
const int nTestValue = atoi(pszValue);
char **papszFields = nullptr;
while( !bSelected ) {
papszFields = CSVReadParseLineL( fp );
if( papszFields == nullptr )
return nullptr;
if( CSLCount( papszFields ) < iKeyField+1 )
{
/* not selected */
}
else if( eCriteria == CC_Integer
&& atoi(papszFields[iKeyField]) == nTestValue )
{
bSelected = true;
}
else
{
bSelected = CSVCompare( papszFields[iKeyField], pszValue,
eCriteria );
}
if( !bSelected )
{
CSLDestroy( papszFields );
papszFields = nullptr;
}
}
return papszFields;
}
/************************************************************************/
/* CSVScanLinesIndexed() */
/* */
/* Read the file scanline for lines where the key field equals */
/* the indicated value with the suggested comparison criteria. */
/* Return the first matching line split into fields. */
/************************************************************************/
static char **
CSVScanLinesIndexed( CSVTable *psTable, int nKeyValue )
{
CPLAssert( psTable->panLineIndex != nullptr );
/* -------------------------------------------------------------------- */
/* Find target record with binary search. */
/* -------------------------------------------------------------------- */
int iTop = psTable->nLineCount-1;
int iBottom = 0;
int iResult = -1;
while( iTop >= iBottom )
{
const int iMiddle = (iTop + iBottom) / 2;
if( psTable->panLineIndex[iMiddle] > nKeyValue )
iTop = iMiddle - 1;
else if( psTable->panLineIndex[iMiddle] < nKeyValue )
iBottom = iMiddle + 1;
else
{
iResult = iMiddle;
// if a key is not unique, select the first instance of it.
while( iResult > 0
&& psTable->panLineIndex[iResult-1] == nKeyValue )
{
psTable->bNonUniqueKey = true;
iResult--;
}
break;
}
}
if( iResult == -1 )
return nullptr;
/* -------------------------------------------------------------------- */
/* Parse target line, and update iLastLine indicator. */
/* -------------------------------------------------------------------- */
psTable->iLastLine = iResult;
return CSVSplitLine( psTable->papszLines[iResult], ",", false, false );
}
/************************************************************************/
/* CSVScanLinesIngested() */
/* */
/* Read the file scanline for lines where the key field equals */
/* the indicated value with the suggested comparison criteria. */
/* Return the first matching line split into fields. */
/************************************************************************/
static char **
CSVScanLinesIngested( CSVTable *psTable, int iKeyField, const char * pszValue,
CSVCompareCriteria eCriteria )
{
CPLAssert( pszValue != nullptr );
CPLAssert( iKeyField >= 0 );
const int nTestValue = atoi(pszValue);
/* -------------------------------------------------------------------- */
/* Short cut for indexed files. */
/* -------------------------------------------------------------------- */
if( iKeyField == 0 && eCriteria == CC_Integer
&& psTable->panLineIndex != nullptr )
return CSVScanLinesIndexed( psTable, nTestValue );
/* -------------------------------------------------------------------- */