-
Notifications
You must be signed in to change notification settings - Fork 4
/
ddfrecord.cpp
1941 lines (1602 loc) · 74.4 KB
/
ddfrecord.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
/******************************************************************************
* $Id: ddfrecord.cpp,v 1.29 2006/02/24 15:59:24 fwarmerdam Exp $
*
* Project: ISO 8211 Access
* Purpose: Implements the DDFRecord class.
* Author: Frank Warmerdam, [email protected]
*
******************************************************************************
* Copyright (c) 1999, Frank Warmerdam
*
* 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.
******************************************************************************
*
* $Log: ddfrecord.cpp,v $
* Revision 1.29 2006/02/24 15:59:24 fwarmerdam
* Added error checking on record buffer memory allocation.
*
* Revision 1.28 2005/10/16 04:09:20 fwarmerdam
* Avoid warnings in sprintf()s.
*
* Revision 1.27 2004/06/24 00:35:59 warmerda
* fixed bug in my last 'fix' for resizing records
*
* Revision 1.26 2004/06/23 19:03:59 warmerda
* fixed some serious problems in ResizeField(), especially with shrinking
*
* Revision 1.25 2004/03/10 18:09:35 warmerda
* Avoid warning on casting result of pointer subtraction.
*
* Revision 1.24 2004/02/18 14:09:42 warmerda
* doc fixups
*
* Revision 1.23 2003/12/08 20:32:48 warmerda
* Added some improved error checking in DDFRecord() on the leader values.
* Try reading extra bytes to find field terminator if the last byte in
* a record isn't the field terminator.
*
* Revision 1.22 2003/12/02 16:50:21 warmerda
* fixed problems with writing some kinds of records
*
* Revision 1.21 2003/11/12 21:21:55 warmerda
* fixed to include field terminators when creating fields
*
* Revision 1.20 2003/09/17 21:11:07 warmerda
* try to create new default field instance when needed
*
* Revision 1.19 2003/09/15 20:46:53 warmerda
* supressed some warnings in SetFieldRaw if field empty
*
* Revision 1.18 2003/09/11 19:56:35 warmerda
* avoid warnings
*
* Revision 1.17 2003/09/03 20:36:26 warmerda
* added subfield writing support
*
* Revision 1.16 2003/07/03 15:38:46 warmerda
* some write capabilities added
*
* Revision 1.15 2002/08/08 12:39:18 warmerda
* Added support for variable length records as per bugzilla bug 181.
*
* Revision 1.14 2001/08/30 21:08:19 warmerda
* expand tabs
*
* Revision 1.13 2001/08/27 19:09:00 warmerda
* added GetInstanceData() method on DDFField
*
* Revision 1.12 2001/08/24 19:41:19 warmerda
* fixed cloning problems
*
* Revision 1.11 2001/08/24 16:30:55 warmerda
* added DDFRecord update in place methods for S57 updating
*
* Revision 1.10 2001/07/18 04:51:57 warmerda
* added CPL_CVSID
*
* Revision 1.9 2000/02/15 17:55:53 warmerda
* Improved error message for corrupt DDF files.
*
* Revision 1.8 1999/11/18 19:03:04 warmerda
* expanded tabs
*
* Revision 1.7 1999/09/03 14:14:39 warmerda
* fix cloning
*
* Revision 1.6 1999/09/02 03:10:01 warmerda
* fixed subtle problem with rewinding modules with reusable headers
*
* Revision 1.5 1999/05/08 20:16:20 warmerda
* added some record validity testing
*
* Revision 1.4 1999/05/07 14:12:24 warmerda
* added record cloning, and subfield value fetches
*
* Revision 1.3 1999/05/06 14:48:28 warmerda
* Fixed EOF handling in files with reused headers
*
* Revision 1.2 1999/05/06 14:24:29 warmerda
* minor optimization, don't emit an error on EOF
*
* Revision 1.1 1999/04/27 18:45:05 warmerda
* New
*
*/
#include "iso8211.h"
#include "cpl_conv.h"
CPL_CVSID("$Id: ddfrecord.cpp,v 1.29 2006/02/24 15:59:24 fwarmerdam Exp $");
static const size_t nLeaderSize = 24;
/************************************************************************/
/* DDFRecord() */
/************************************************************************/
DDFRecord::DDFRecord( DDFModule * poModuleIn )
{
poModule = poModuleIn;
nReuseHeader = FALSE;
nFieldOffset = 0;
nDataSize = 0;
pachData = NULL;
nFieldCount = 0;
paoFields = NULL;
bIsClone = FALSE;
_sizeFieldTag = 4;
_sizeFieldPos = 0;
_sizeFieldLength = 0;
}
/************************************************************************/
/* ~DDFRecord() */
/************************************************************************/
DDFRecord::~DDFRecord()
{
Clear();
if( bIsClone )
poModule->RemoveCloneRecord( this );
}
/************************************************************************/
/* Dump() */
/************************************************************************/
/**
* Write out record contents to debugging file.
*
* A variety of information about this record, and all it's fields and
* subfields is written to the given debugging file handle. Note that
* field definition information (ala DDFFieldDefn) isn't written.
*
* @param fp The standard io file handle to write to. ie. stderr
*/
void DDFRecord::Dump( FILE * fp )
{
fprintf( fp, "DDFRecord:\n" );
fprintf( fp, " nReuseHeader = %d\n", nReuseHeader );
fprintf( fp, " nDataSize = %d\n", nDataSize );
fprintf( fp,
" _sizeFieldLength=%d, _sizeFieldPos=%d, _sizeFieldTag=%d\n",
_sizeFieldLength, _sizeFieldPos, _sizeFieldTag );
for( int i = 0; i < nFieldCount; i++ )
{
paoFields[i].Dump( fp );
}
}
/************************************************************************/
/* Read() */
/* */
/* Read a record of data from the file, and parse the header to */
/* build a field list for the record (or reuse the existing one */
/* if reusing headers). It is expected that the file pointer */
/* will be positioned at the beginning of a data record. It is */
/* the DDFModule's responsibility to do so. */
/* */
/* This method should only be called by the DDFModule class. */
/************************************************************************/
int DDFRecord::Read()
{
/* -------------------------------------------------------------------- */
/* Redefine the record on the basis of the header if needed. */
/* As a side effect this will read the data for the record as well.*/
/* -------------------------------------------------------------------- */
if( !nReuseHeader )
{
return( ReadHeader() );
}
/* -------------------------------------------------------------------- */
/* Otherwise we read just the data and carefully overlay it on */
/* the previous records data without disturbing the rest of the */
/* record. */
/* -------------------------------------------------------------------- */
size_t nReadBytes;
nReadBytes = VSIFRead( pachData + nFieldOffset, 1,
nDataSize - nFieldOffset,
poModule->GetFP() );
if( nReadBytes != (size_t) (nDataSize - nFieldOffset)
&& nReadBytes == 0
&& VSIFEof( poModule->GetFP() ) )
{
return FALSE;
}
else if( nReadBytes != (size_t) (nDataSize - nFieldOffset) )
{
CPLError( CE_Failure, CPLE_FileIO,
"Data record is short on DDF file.\n" );
return FALSE;
}
// notdef: eventually we may have to do something at this point to
// notify the DDFField's that their data values have changed.
return TRUE;
}
/************************************************************************/
/* Write() */
/************************************************************************/
/**
* Write record out to module.
*
* This method writes the current record to the module to which it is
* attached. Normally this would be at the end of the file, and only used
* for modules newly created with DDFModule::Create(). Rewriting existing
* records is not supported at this time. Calling Write() multiple times
* on a DDFRecord will result it multiple copies being written at the end of
* the module.
*
* @return TRUE on success or FALSE on failure.
*/
int DDFRecord::Write()
{
if( !ResetDirectory() )
return FALSE;
/* -------------------------------------------------------------------- */
/* Prepare leader. */
/* -------------------------------------------------------------------- */
char szLeader[nLeaderSize+1];
memset( szLeader, ' ', nLeaderSize );
sprintf( szLeader+0, "%05d", (int) (nDataSize + nLeaderSize) );
szLeader[5] = ' ';
szLeader[6] = 'D';
sprintf( szLeader + 12, "%05d", (int) (nFieldOffset + nLeaderSize) );
szLeader[17] = ' ';
szLeader[20] = (char) ('0' + _sizeFieldLength);
szLeader[21] = (char) ('0' + _sizeFieldPos);
szLeader[22] = '0';
szLeader[23] = (char) ('0' + _sizeFieldTag);
/* notdef: lots of stuff missing */
/* -------------------------------------------------------------------- */
/* Write the leader. */
/* -------------------------------------------------------------------- */
VSIFWrite( szLeader, nLeaderSize, 1, poModule->GetFP() );
/* -------------------------------------------------------------------- */
/* Write the remainder of the record. */
/* -------------------------------------------------------------------- */
VSIFWrite( pachData, nDataSize, 1, poModule->GetFP() );
return TRUE;
}
/************************************************************************/
/* Clear() */
/* */
/* Clear any information associated with the last header in */
/* preparation for reading a new header. */
/************************************************************************/
void DDFRecord::Clear()
{
if( paoFields != NULL )
delete[] paoFields;
paoFields = NULL;
nFieldCount = 0;
if( pachData != NULL )
CPLFree( pachData );
pachData = NULL;
nDataSize = 0;
nReuseHeader = FALSE;
}
/************************************************************************/
/* ReadHeader() */
/* */
/* This perform the header reading and parsing job for the */
/* Read() method. It reads the header, and builds a field */
/* list. */
/************************************************************************/
int DDFRecord::ReadHeader()
{
/* -------------------------------------------------------------------- */
/* Clear any existing information. */
/* -------------------------------------------------------------------- */
Clear();
/* -------------------------------------------------------------------- */
/* Read the 24 byte leader. */
/* -------------------------------------------------------------------- */
char achLeader[nLeaderSize];
int nReadBytes;
nReadBytes = VSIFRead(achLeader,1,nLeaderSize,poModule->GetFP());
if( nReadBytes == 0 && VSIFEof( poModule->GetFP() ) )
{
return FALSE;
}
else if( nReadBytes != (int) nLeaderSize )
{
CPLError( CE_Failure, CPLE_FileIO,
"Leader is short on DDF file." );
return FALSE;
}
/* -------------------------------------------------------------------- */
/* Extract information from leader. */
/* -------------------------------------------------------------------- */
int _recLength, _fieldAreaStart;
char _leaderIden;
_recLength = DDFScanInt( achLeader+0, 5 );
_leaderIden = achLeader[6];
_fieldAreaStart = DDFScanInt(achLeader+12,5);
_sizeFieldLength = achLeader[20] - '0';
_sizeFieldPos = achLeader[21] - '0';
_sizeFieldTag = achLeader[23] - '0';
if( _sizeFieldLength < 0 || _sizeFieldLength > 9
|| _sizeFieldPos < 0 || _sizeFieldPos > 9
|| _sizeFieldTag < 0 || _sizeFieldTag > 9 )
{
CPLError( CE_Failure, CPLE_AppDefined,
"ISO8211 record leader appears to be corrupt." );
return FALSE;
}
if( _leaderIden == 'R' )
nReuseHeader = TRUE;
nFieldOffset = _fieldAreaStart - nLeaderSize;
/* -------------------------------------------------------------------- */
/* Is there anything seemly screwy about this record? */
/* -------------------------------------------------------------------- */
if(( _recLength < 24 || _recLength > 100000000
|| _fieldAreaStart < 24 || _fieldAreaStart > 100000 )
&& (_recLength != 0))
{
CPLError( CE_Failure, CPLE_FileIO,
"Data record appears to be corrupt on DDF file.\n"
" -- ensure that the files were uncompressed without modifying\n"
"carriage return/linefeeds (by default WINZIP does this)." );
return FALSE;
}
/* ==================================================================== */
/* Handle the normal case with the record length available. */
/* ==================================================================== */
if(_recLength != 0) {
/* -------------------------------------------------------------------- */
/* Read the remainder of the record. */
/* -------------------------------------------------------------------- */
nDataSize = _recLength - nLeaderSize;
pachData = (char *) CPLMalloc(nDataSize);
if( VSIFRead( pachData, 1, nDataSize, poModule->GetFP()) !=
(size_t) nDataSize )
{
CPLError( CE_Failure, CPLE_FileIO,
"Data record is short on DDF file." );
return FALSE;
}
/* -------------------------------------------------------------------- */
/* If we don't find a field terminator at the end of the record */
/* we will read extra bytes till we get to it. */
/* -------------------------------------------------------------------- */
while( pachData[nDataSize-1] != DDF_FIELD_TERMINATOR )
{
nDataSize++;
pachData = (char *) CPLRealloc(pachData,nDataSize);
if( VSIFRead( pachData + nDataSize - 1, 1, 1, poModule->GetFP() )
!= 1 )
{
CPLError( CE_Failure, CPLE_FileIO,
"Data record is short on DDF file." );
return FALSE;
}
CPLDebug( "ISO8211",
"Didn't find field terminator, read one more byte." );
}
/* -------------------------------------------------------------------- */
/* Loop over the directory entries, making a pass counting them. */
/* -------------------------------------------------------------------- */
int i;
int nFieldEntryWidth;
nFieldEntryWidth = _sizeFieldLength + _sizeFieldPos + _sizeFieldTag;
nFieldCount = 0;
for( i = 0; i < nDataSize; i += nFieldEntryWidth )
{
if( pachData[i] == DDF_FIELD_TERMINATOR )
break;
nFieldCount++;
}
/* -------------------------------------------------------------------- */
/* Allocate, and read field definitions. */
/* -------------------------------------------------------------------- */
paoFields = new DDFField[nFieldCount];
for( i = 0; i < nFieldCount; i++ )
{
char szTag[128];
int nEntryOffset = i*nFieldEntryWidth;
int nFieldLength, nFieldPos;
/* -------------------------------------------------------------------- */
/* Read the position information and tag. */
/* -------------------------------------------------------------------- */
strncpy( szTag, pachData+nEntryOffset, _sizeFieldTag );
szTag[_sizeFieldTag] = '\0';
nEntryOffset += _sizeFieldTag;
nFieldLength = DDFScanInt( pachData+nEntryOffset, _sizeFieldLength );
nEntryOffset += _sizeFieldLength;
nFieldPos = DDFScanInt( pachData+nEntryOffset, _sizeFieldPos );
/* -------------------------------------------------------------------- */
/* Find the corresponding field in the module directory. */
/* -------------------------------------------------------------------- */
DDFFieldDefn *poFieldDefn = poModule->FindFieldDefn( szTag );
if( poFieldDefn == NULL )
{
CPLError( CE_Failure, CPLE_AppDefined,
"Undefined field `%s' encountered in data record.",
szTag );
return FALSE;
}
/* -------------------------------------------------------------------- */
/* Assign info the DDFField. */
/* -------------------------------------------------------------------- */
paoFields[i].Initialize( poFieldDefn,
pachData + _fieldAreaStart + nFieldPos - nLeaderSize,
nFieldLength );
}
return TRUE;
}
/* ==================================================================== */
/* Handle the exceptional case where the record length is */
/* zero. In this case we have to read all the data based on */
/* the size of data items as per ISO8211 spec Annex C, 1.5.1. */
/* */
/* See Bugzilla bug 181 and test with file US4CN21M.000. */
/* ==================================================================== */
else {
CPLDebug( "ISO8211",
"Record with zero length, use variant (C.1.5.1) logic." );
/* ----------------------------------------------------------------- */
/* _recLength == 0, handle the large record. */
/* */
/* Read the remainder of the record. */
/* ----------------------------------------------------------------- */
nDataSize = 0;
pachData = NULL;
/* ----------------------------------------------------------------- */
/* Loop over the directory entries, making a pass counting them. */
/* ----------------------------------------------------------------- */
int nFieldEntryWidth = _sizeFieldLength + _sizeFieldPos + _sizeFieldTag;
nFieldCount = 0;
int i=0;
char *tmpBuf = (char*)VSIMalloc(nFieldEntryWidth);
if( tmpBuf == NULL )
{
CPLError( CE_Failure, CPLE_OutOfMemory,
"Attempt to allocate %d byte ISO8211 record buffer failed.",
nFieldEntryWidth );
return FALSE;
}
// while we're not at the end, store this entry,
// and keep on reading...
do {
// read an Entry:
if(nFieldEntryWidth !=
(int) VSIFRead(tmpBuf, 1, nFieldEntryWidth, poModule->GetFP())) {
CPLError(CE_Failure, CPLE_FileIO,
"Data record is short on DDF file.");
return FALSE;
}
// move this temp buffer into more permanent storage:
char *newBuf = (char*)CPLMalloc(nDataSize+nFieldEntryWidth);
if(pachData!=NULL) {
memcpy(newBuf, pachData, nDataSize);
CPLFree(pachData);
}
memcpy(&newBuf[nDataSize], tmpBuf, nFieldEntryWidth);
pachData = newBuf;
nDataSize += nFieldEntryWidth;
if(DDF_FIELD_TERMINATOR != tmpBuf[0]) {
nFieldCount++;
}
}
while(DDF_FIELD_TERMINATOR != tmpBuf[0]);
// Now, rewind a little. Only the TERMINATOR should have been read:
int rewindSize = nFieldEntryWidth - 1;
FILE *fp = poModule->GetFP();
long pos = ftell(fp) - rewindSize;
fseek(fp, pos, SEEK_SET);
nDataSize -= rewindSize;
// --------------------------------------------------------------------
// Okay, now let's populate the heck out of pachData...
// --------------------------------------------------------------------
for(i=0; i<nFieldCount; i++) {
int nEntryOffset = (i*nFieldEntryWidth) + _sizeFieldTag;
int nFieldLength = DDFScanInt(pachData + nEntryOffset,
_sizeFieldLength);
char *tmpBuf = (char*)CPLMalloc(nFieldLength);
// read an Entry:
if(nFieldLength !=
(int) VSIFRead(tmpBuf, 1, nFieldLength, poModule->GetFP())) {
CPLError(CE_Failure, CPLE_FileIO,
"Data record is short on DDF file.");
return FALSE;
}
// move this temp buffer into more permanent storage:
char *newBuf = (char*)CPLMalloc(nDataSize+nFieldLength);
memcpy(newBuf, pachData, nDataSize);
CPLFree(pachData);
memcpy(&newBuf[nDataSize], tmpBuf, nFieldLength);
CPLFree(tmpBuf);
pachData = newBuf;
nDataSize += nFieldLength;
}
/* ----------------------------------------------------------------- */
/* Allocate, and read field definitions. */
/* ----------------------------------------------------------------- */
paoFields = new DDFField[nFieldCount];
for( i = 0; i < nFieldCount; i++ )
{
char szTag[128];
int nEntryOffset = i*nFieldEntryWidth;
int nFieldLength, nFieldPos;
/* ------------------------------------------------------------- */
/* Read the position information and tag. */
/* ------------------------------------------------------------- */
strncpy( szTag, pachData+nEntryOffset, _sizeFieldTag );
szTag[_sizeFieldTag] = '\0';
nEntryOffset += _sizeFieldTag;
nFieldLength = DDFScanInt( pachData+nEntryOffset, _sizeFieldLength );
nEntryOffset += _sizeFieldLength;
nFieldPos = DDFScanInt( pachData+nEntryOffset, _sizeFieldPos );
/* ------------------------------------------------------------- */
/* Find the corresponding field in the module directory. */
/* ------------------------------------------------------------- */
DDFFieldDefn *poFieldDefn = poModule->FindFieldDefn( szTag );
if( poFieldDefn == NULL )
{
CPLError( CE_Failure, CPLE_AppDefined,
"Undefined field `%s' encountered in data record.",
szTag );
return FALSE;
}
/* ------------------------------------------------------------- */
/* Assign info the DDFField. */
/* ------------------------------------------------------------- */
paoFields[i].Initialize( poFieldDefn,
pachData + _fieldAreaStart
+ nFieldPos - nLeaderSize,
nFieldLength );
}
return TRUE;
}
}
/************************************************************************/
/* FindField() */
/************************************************************************/
/**
* Find the named field within this record.
*
* @param pszName The name of the field to fetch. The comparison is
* case insensitive.
* @param iFieldIndex The instance of this field to fetch. Use zero (the
* default) for the first instance.
*
* @return Pointer to the requested DDFField. This pointer is to an
* internal object, and should not be freed. It remains valid until
* the next record read.
*/
DDFField * DDFRecord::FindField( const char * pszName, int iFieldIndex )
{
for( int i = 0; i < nFieldCount; i++ )
{
if( EQUAL(paoFields[i].GetFieldDefn()->GetName(),pszName) )
{
if( iFieldIndex == 0 )
return paoFields + i;
else
iFieldIndex--;
}
}
return NULL;
}
/************************************************************************/
/* GetField() */
/************************************************************************/
/**
* Fetch field object based on index.
*
* @param i The index of the field to fetch. Between 0 and GetFieldCount()-1.
*
* @return A DDFField pointer, or NULL if the index is out of range.
*/
DDFField *DDFRecord::GetField( int i )
{
if( i < 0 || i >= nFieldCount )
return NULL;
else
return paoFields + i;
}
/************************************************************************/
/* GetIntSubfield() */
/************************************************************************/
/**
* Fetch value of a subfield as an integer. This is a convenience
* function for fetching a subfield of a field within this record.
*
* @param pszField The name of the field containing the subfield.
* @param iFieldIndex The instance of this field within the record. Use
* zero for the first instance of this field.
* @param pszSubfield The name of the subfield within the selected field.
* @param iSubfieldIndex The instance of this subfield within the record.
* Use zero for the first instance.
* @param pnSuccess Pointer to an int which will be set to TRUE if the fetch
* succeeds, or FALSE if it fails. Use NULL if you don't want to check
* success.
* @return The value of the subfield, or zero if it failed for some reason.
*/
int DDFRecord::GetIntSubfield( const char * pszField, int iFieldIndex,
const char * pszSubfield, int iSubfieldIndex,
int * pnSuccess )
{
DDFField *poField;
int nDummyErr;
if( pnSuccess == NULL )
pnSuccess = &nDummyErr;
*pnSuccess = FALSE;
/* -------------------------------------------------------------------- */
/* Fetch the field. If this fails, return zero. */
/* -------------------------------------------------------------------- */
poField = FindField( pszField, iFieldIndex );
if( poField == NULL )
return 0;
/* -------------------------------------------------------------------- */
/* Get the subfield definition */
/* -------------------------------------------------------------------- */
DDFSubfieldDefn *poSFDefn;
poSFDefn = poField->GetFieldDefn()->FindSubfieldDefn( pszSubfield );
if( poSFDefn == NULL )
return 0;
/* -------------------------------------------------------------------- */
/* Get a pointer to the data. */
/* -------------------------------------------------------------------- */
int nBytesRemaining;
const char *pachData = poField->GetSubfieldData(poSFDefn,
&nBytesRemaining,
iSubfieldIndex);
/* -------------------------------------------------------------------- */
/* Return the extracted value. */
/* -------------------------------------------------------------------- */
*pnSuccess = TRUE;
return( poSFDefn->ExtractIntData( pachData, nBytesRemaining, NULL ) );
}
/************************************************************************/
/* GetFloatSubfield() */
/************************************************************************/
/**
* Fetch value of a subfield as a float (double). This is a convenience
* function for fetching a subfield of a field within this record.
*
* @param pszField The name of the field containing the subfield.
* @param iFieldIndex The instance of this field within the record. Use
* zero for the first instance of this field.
* @param pszSubfield The name of the subfield within the selected field.
* @param iSubfieldIndex The instance of this subfield within the record.
* Use zero for the first instance.
* @param pnSuccess Pointer to an int which will be set to TRUE if the fetch
* succeeds, or FALSE if it fails. Use NULL if you don't want to check
* success.
* @return The value of the subfield, or zero if it failed for some reason.
*/
double DDFRecord::GetFloatSubfield( const char * pszField, int iFieldIndex,
const char * pszSubfield, int iSubfieldIndex,
int * pnSuccess )
{
DDFField *poField;
int nDummyErr;
if( pnSuccess == NULL )
pnSuccess = &nDummyErr;
*pnSuccess = FALSE;
/* -------------------------------------------------------------------- */
/* Fetch the field. If this fails, return zero. */
/* -------------------------------------------------------------------- */
poField = FindField( pszField, iFieldIndex );
if( poField == NULL )
return 0;
/* -------------------------------------------------------------------- */
/* Get the subfield definition */
/* -------------------------------------------------------------------- */
DDFSubfieldDefn *poSFDefn;
poSFDefn = poField->GetFieldDefn()->FindSubfieldDefn( pszSubfield );
if( poSFDefn == NULL )
return 0;
/* -------------------------------------------------------------------- */
/* Get a pointer to the data. */
/* -------------------------------------------------------------------- */
int nBytesRemaining;
const char *pachData = poField->GetSubfieldData(poSFDefn,
&nBytesRemaining,
iSubfieldIndex);
/* -------------------------------------------------------------------- */
/* Return the extracted value. */
/* -------------------------------------------------------------------- */
*pnSuccess = TRUE;
return( poSFDefn->ExtractFloatData( pachData, nBytesRemaining, NULL ) );
}
/************************************************************************/
/* GetStringSubfield() */
/************************************************************************/
/**
* Fetch value of a subfield as a string. This is a convenience
* function for fetching a subfield of a field within this record.
*
* @param pszField The name of the field containing the subfield.
* @param iFieldIndex The instance of this field within the record. Use
* zero for the first instance of this field.
* @param pszSubfield The name of the subfield within the selected field.
* @param iSubfieldIndex The instance of this subfield within the record.
* Use zero for the first instance.
* @param pnSuccess Pointer to an int which will be set to TRUE if the fetch
* succeeds, or FALSE if it fails. Use NULL if you don't want to check
* success.
* @return The value of the subfield, or NULL if it failed for some reason.
* The returned pointer is to internal data and should not be modified or
* freed by the application.
*/
const char *
DDFRecord::GetStringSubfield( const char * pszField, int iFieldIndex,
const char * pszSubfield, int iSubfieldIndex,
int * pnSuccess )
{
DDFField *poField;
int nDummyErr;
if( pnSuccess == NULL )
pnSuccess = &nDummyErr;
*pnSuccess = FALSE;
/* -------------------------------------------------------------------- */
/* Fetch the field. If this fails, return zero. */
/* -------------------------------------------------------------------- */
poField = FindField( pszField, iFieldIndex );
if( poField == NULL )
return NULL;
/* -------------------------------------------------------------------- */
/* Get the subfield definition */
/* -------------------------------------------------------------------- */
DDFSubfieldDefn *poSFDefn;
poSFDefn = poField->GetFieldDefn()->FindSubfieldDefn( pszSubfield );
if( poSFDefn == NULL )
return NULL;
/* -------------------------------------------------------------------- */
/* Get a pointer to the data. */
/* -------------------------------------------------------------------- */
int nBytesRemaining;
const char *pachData = poField->GetSubfieldData(poSFDefn,
&nBytesRemaining,
iSubfieldIndex);
/* -------------------------------------------------------------------- */
/* Return the extracted value. */
/* -------------------------------------------------------------------- */
*pnSuccess = TRUE;
return( poSFDefn->ExtractStringData( pachData, nBytesRemaining, NULL ) );
}
/************************************************************************/
/* Clone() */
/************************************************************************/
/**
* Make a copy of a record.
*
* This method is used to make a copy of a record that will become (mostly)
* the properly of application. However, it is automatically destroyed if
* the DDFModule it was created relative to is destroyed, as it's field
* and subfield definitions relate to that DDFModule. However, it does
* persist even when the record returned by DDFModule::ReadRecord() is
* invalidated, such as when reading a new record. This allows an application
* to cache whole DDFRecords.
*
* @return A new copy of the DDFRecord. This can be delete'd by the
* application when no longer needed, otherwise it will be cleaned up when
* the DDFModule it relates to is destroyed or closed.
*/
DDFRecord * DDFRecord::Clone()
{
DDFRecord *poNR;
poNR = new DDFRecord( poModule );
poNR->nReuseHeader = FALSE;
poNR->nFieldOffset = nFieldOffset;
poNR->nDataSize = nDataSize;
poNR->pachData = (char *) CPLMalloc(nDataSize);
memcpy( poNR->pachData, pachData, nDataSize );
poNR->nFieldCount = nFieldCount;
poNR->paoFields = new DDFField[nFieldCount];
for( int i = 0; i < nFieldCount; i++ )
{
int nOffset;
nOffset = (paoFields[i].GetData() - pachData);
poNR->paoFields[i].Initialize( paoFields[i].GetFieldDefn(),
poNR->pachData + nOffset,
paoFields[i].GetDataSize() );
}
poNR->bIsClone = TRUE;
poModule->AddCloneRecord( poNR );
return poNR;
}
/************************************************************************/
/* CloneOn() */
/************************************************************************/
/**
* Recreate a record referencing another module.
*
* Works similarly to the DDFRecord::Clone() method, but creates the
* new record with reference to a different DDFModule. All DDFFieldDefn
* references are transcribed onto the new module based on field names.
* If any fields don't have a similarly named field on the target module
* the operation will fail. No validation of field types and properties
* is done, but this operation is intended only to be used between
* modules with matching definitions of all affected fields.
*
* The new record will be managed as a clone by the target module in
* a manner similar to regular clones.
*
* @param poTargetModule the module on which the record copy should be
* created.
*
* @return NULL on failure or a pointer to the cloned record.
*/
DDFRecord *DDFRecord::CloneOn( DDFModule *poTargetModule )
{
/* -------------------------------------------------------------------- */
/* Verify that all fields have a corresponding field definition */
/* on the target module. */
/* -------------------------------------------------------------------- */
int i;
for( i = 0; i < nFieldCount; i++ )