File: shpgeo.c

package info (click to toggle)
shapelib 1.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,852 kB
  • sloc: ansic: 10,310; sh: 4,620; cpp: 645; makefile: 191; pascal: 159
file content (1452 lines) | stat: -rw-r--r-- 45,615 bytes parent folder | download
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
/******************************************************************************
 * Copyright (c) 1999, Carl Anderson
 *
 * This code is based in part on the earlier work of 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.
 ******************************************************************************
 *
 * requires shapelib 1.2
 *   gcc shpproj shpopen.o dbfopen.o -lm -lproj -o shpproj
 *
 * this may require linking with the PROJ4 projection library available from
 *
 * http://www.remotesensing.org/proj
 *
 * use -DPROJ4 to compile in Projection support
 *
 */

#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "shapefil.h"

#include "shpgeo.h"

#if defined(_MSC_VER) && _MSC_VER < 1800
#include <float.h>
#define INFINITY (DBL_MAX + DBL_MAX)
#define NAN (INFINITY - INFINITY)
#endif

/* I'm using some shorthand throughout this file
 *      R+ is a Clockwise Ring and is the positive portion of an object
 *      R- is a CounterClockwise Ring and is a hole in a R+
 *      A complex object is one having at least one R-
 *      A compound object is one having more than one R+
 *	A simple object has one and only one element (R+ or R-)
 *
 *	The closed ring constraint is for polygons and assumed here
 *	Arcs or LineStrings I am calling Rings (generically open or closed)
 *	Point types are vertices or lists of vertices but not Rings
 *
 *   SHPT_POLYGON, SHPT_POLYGONZ, SHPT_POLYGONM and SHPT_MULTIPATCH
 *   can have SHPObjects that are compound as well as complex
 *
 *   SHP_POINT and its Z and M derivatives are strictly simple
 *   MULTI_POINT, SHPT_ARC and their derivatives may be simple or compound
 *
 */

/* **************************************************************************
 * asFileName
 *
 * utility function, toss part of filename after last dot
 *
 * **************************************************************************/
char *asFileName(const char *fil, const char *ext)
{
    /* -------------------------------------------------------------------- */
    /*	Compute the base (layer) name.  If there is any extension	*/
    /*	on the passed in filename we will strip it off.			*/
    /* -------------------------------------------------------------------- */
    char pszBasename[120];
    strcpy(pszBasename, fil);
    int i = (int)strlen(pszBasename) - 1;
    for (; i > 0 && pszBasename[i] != '.' && pszBasename[i] != '/' &&
           pszBasename[i] != '\\';
         i--)
    {
    }

    if (pszBasename[i] == '.')
        pszBasename[i] = '\0';

    /* -------------------------------------------------------------------- */
    /*	Note that files pulled from					*/
    /*	a PC to Unix with upper case filenames won't work!		*/
    /* -------------------------------------------------------------------- */
    static char pszFullname[256];
    sprintf(pszFullname, "%s.%s", pszBasename, ext);

    return pszFullname;
}

/* **************************************************************************
 * SHPOGisType
 *
 * Convert Both ways from and to OGIS Geometry Types
 *
 * **************************************************************************/
int SHPOGisType(int GeomType, int toOGis)
{

    if (toOGis == 0) /* connect OGis -> SHP types  					*/
        switch (GeomType)
        {
            case (OGIST_POINT):
                return (SHPT_POINT);
                break;
            case (OGIST_LINESTRING):
                return (SHPT_ARC);
                break;
            case (OGIST_POLYGON):
                return (SHPT_POLYGON);
                break;
            case (OGIST_MULTIPOINT):
                return (SHPT_MULTIPOINT);
                break;
            case (OGIST_MULTILINE):
                return (SHPT_ARC);
                break;
            case (OGIST_MULTIPOLYGON):
                return (SHPT_POLYGON);
                break;
        }
    else /* ok so its SHP->OGis types 									*/
        switch (GeomType)
        {
            case (SHPT_POINT):
                return (OGIST_POINT);
                break;
            case (SHPT_POINTM):
                return (OGIST_POINT);
                break;
            case (SHPT_POINTZ):
                return (OGIST_POINT);
                break;
            case (SHPT_ARC):
                return (OGIST_LINESTRING);
                break;
            case (SHPT_ARCZ):
                return (OGIST_LINESTRING);
                break;
            case (SHPT_ARCM):
                return (OGIST_LINESTRING);
                break;
            case (SHPT_POLYGON):
                return (OGIST_MULTIPOLYGON);
                break;
            case (SHPT_POLYGONZ):
                return (OGIST_MULTIPOLYGON);
                break;
            case (SHPT_POLYGONM):
                return (OGIST_MULTIPOLYGON);
                break;
            case (SHPT_MULTIPOINT):
                return (OGIST_MULTIPOINT);
                break;
            case (SHPT_MULTIPOINTZ):
                return (OGIST_MULTIPOINT);
                break;
            case (SHPT_MULTIPOINTM):
                return (OGIST_MULTIPOINT);
                break;
            case (SHPT_MULTIPATCH):
                return (OGIST_GEOMCOLL);
                break;
        }

    return 0;
}

/* **************************************************************************
 * SHPWriteSHPStream
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
static int SHPWriteSHPStream(WKBStreamObj *stream_obj,
                             const SHPObject *psCShape)
{
    int need_swap = 1;
    need_swap = ((char *)(&need_swap))[0];

    /*realloc (stream_obj, obj_storage );*/

    if (need_swap)
    {
    }
    else
    {
        memcpy(stream_obj, psCShape, 4 * sizeof(int));
        memcpy(stream_obj, psCShape, 4 * sizeof(double));
        // TODO(schwehr): What?
        // const int use_Z = 0;
        // const int use_M = 0;
        // if ( use_Z )
        //   memcpy (stream_obj, psCShape, 2 * sizeof (double) );
        // if ( use_M )
        //   memcpy (stream_obj, psCShape, 2 * sizeof (double) );

        memcpy(stream_obj, psCShape, psCShape->nParts * 2 * sizeof(int));
        memcpy(stream_obj, psCShape, psCShape->nVertices * 2 * sizeof(double));
        // if ( use_Z )
        //   memcpy (stream_obj, psCShape, psCShape->nVertices * 2 * sizeof (double) );
        // if ( use_M )
        //   memcpy (stream_obj, psCShape, psCShape->nVertices * 2 * sizeof (double) );
    }

    return (0);
}

/* **************************************************************************
 * WKBStreamWrite
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
static int WKBStreamWrite(WKBStreamObj *wso, const void *this, int tcount,
                          int tsize)
{
    if (wso->NeedSwap)
        SwapG(&(wso->wStream[wso->StreamPos]), this, tcount, tsize);
    else
        memcpy(&(wso->wStream[wso->StreamPos]), this, tsize * tcount);

    wso->StreamPos += tsize;

    return 0;
}

/* **************************************************************************
 * WKBStreamRead
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
static int WKBStreamRead(WKBStreamObj *wso, void *this, int tcount, int tsize)
{
    if (wso->NeedSwap)
        SwapG(this, &(wso->wStream[wso->StreamPos]), tcount, tsize);
    else
        memcpy(this, &(wso->wStream[wso->StreamPos]), tsize * tcount);

    wso->StreamPos += tsize;

    return 0;
}

/* **************************************************************************
 * SHPReadOGisWKB
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
SHPObject *SHPReadOGisWKB(WKBStreamObj *stream_obj)
{
    char WKB_order;
    WKBStreamRead(stream_obj, &WKB_order, 1, sizeof(char));
    int my_order = 1;
    my_order = ((char *)(&my_order))[0];
    stream_obj->NeedSwap = !(WKB_order & my_order);

    /* convert OGis Types to SHP types  */
    int GeoType = 0;
    const int nSHPType = SHPOGisType(GeoType, 0);

    WKBStreamRead(stream_obj, &GeoType, 1, sizeof(int));

    const int thisDim = SHPDimension(nSHPType);

    // SHPObject *psCShape;
    if (thisDim & SHPD_AREA)
    {
        /* psCShape = */ SHPReadOGisPolygon(stream_obj);
    }
    else
    {
        if (thisDim & SHPD_LINE)
        {
            /* psCShape = */ SHPReadOGisLine(stream_obj);
        }
        else
        {
            if (thisDim & SHPD_POINT)
            {
                /* psCShape = */ SHPReadOGisPoint(stream_obj);
            }
        }
    }

    return (0);
}

/* **************************************************************************
 * SHPWriteOGisWKB
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
int SHPWriteOGisWKB(WKBStreamObj *stream_obj, const SHPObject *psCShape)
{
    /* OGis WKB can handle either byte order, but if I get to choose I'd	*/
    /* rather have it predicatable system-to-system							*/

    if (stream_obj)
    {
        if (stream_obj->wStream)
            free(stream_obj->wStream);
    }
    else
    {
        stream_obj = calloc(3, sizeof(int));
    }

    /* object size needs to be 9 bytes for the wrapper, and for each polygon	*/
    /* another 9 bytes all plus twice the total number of vertices				*/
    /* times the sizeof (double) and just pad with 10 more chars for fun		*/
    stream_obj->wStream =
        calloc(1, (9 * (psCShape->nParts + 1)) +
                      (sizeof(double) * 2 * psCShape->nVertices) + 10);

#ifdef DEBUG2
    printf(" I just allocated %d bytes to wkbObj \n",
           (int)(sizeof(int) + sizeof(int) + sizeof(int) +
                 (sizeof(int) * psCShape->nParts + 1) +
                 (sizeof(double) * 2 * psCShape->nVertices) + 10));
#endif

    /* indicate that this WKB is in LSB Order	*/
    int my_order = 1;
    my_order = ((char *)(&my_order))[0];
    /* Need to swap if this system is not  LSB (Intel Order)					*/
    char LSB = 1;
    stream_obj->NeedSwap = (my_order != LSB);

    stream_obj->StreamPos = 0;

#ifdef DEBUG2
    printf("this system is (%d) LSB recorded as needSwap %d\n", my_order,
           stream_obj->NeedSwap);
#endif

    WKBStreamWrite(stream_obj, &LSB, 1, sizeof(char));

#ifdef DEBUG2
    printf("this system in LSB \n");
#endif

    /* convert SHP Types to OGis types  */
    int GeoType = SHPOGisType(psCShape->nSHPType, 1);
    WKBStreamWrite(stream_obj, &GeoType, 1, sizeof(int));

    const int thisDim = SHPDimension(psCShape->nSHPType);

    if (thisDim & SHPD_AREA)
    {
        SHPWriteOGisPolygon(stream_obj, psCShape);
    }
    else
    {
        if (thisDim & SHPD_LINE)
        {
            SHPWriteOGisLine(stream_obj, psCShape);
        }
        else
        {
            if (thisDim & SHPD_POINT)
            {
                SHPWriteOGisPoint(stream_obj, psCShape);
            }
        }
    }

#ifdef DEBUG2
    printf("(SHPWriteOGisWKB) outta here when stream pos is %d \n",
           stream_obj->StreamPos);
#endif
    return (0);
}

/* **************************************************************************
 * SHPWriteOGisPolygon
 *
 * for this pass code to more generic OGis MultiPolygon Type
 * later add support for OGis Polygon Type
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
int SHPWriteOGisPolygon(WKBStreamObj *stream_obj, const SHPObject *psCShape)
{
    /* cannot have more than nParts complex objects in this object */
    SHPObject **ppsC = calloc(psCShape->nParts, sizeof(int));

    int nextring = 0;
    int cParts = 0;
    while (nextring >= 0)
    {
        ppsC[cParts] = SHPUnCompound(psCShape, &nextring);
        cParts++;
    }

#ifdef DEBUG2
    printf("(SHPWriteOGisPolygon) Uncompounded into %d parts \n", cParts);
#endif

    WKBStreamWrite(stream_obj, &cParts, 1, sizeof(int));

    int GeoType = OGIST_POLYGON;

    char Flag = 1;
    for (int cpart = 0; cpart < cParts; cpart++)
    {
        WKBStreamWrite(stream_obj, &Flag, 1, sizeof(char));
        WKBStreamWrite(stream_obj, &GeoType, 1, sizeof(int));

        SHPObject *psC = (SHPObject *)ppsC[cpart];
        WKBStreamWrite(stream_obj, &(psC->nParts), 1, sizeof(int));

        for (int ring = 0; (ring < (psC->nParts)) && (psC->nParts > 0); ring++)
        {
            int rVertices;
            if (ring < (psC->nParts - 2))
            {
                rVertices =
                    psC->panPartStart[ring + 1] - psC->panPartStart[ring];
            }
            else
            {
                rVertices = psC->nVertices - psC->panPartStart[ring];
            }
#ifdef DEBUG2
            printf("(SHPWriteOGisPolygon) scanning part %d, ring %d %d vtxs \n",
                   cpart, ring, rVertices);
#endif
            const int rPart = psC->panPartStart[ring];
            WKBStreamWrite(stream_obj, &rVertices, 1, sizeof(int));
            for (int j = rPart; j < (rPart + rVertices); j++)
            {
                WKBStreamWrite(stream_obj, &(psC->padfX[j]), 1, sizeof(double));
                WKBStreamWrite(stream_obj, &(psC->padfY[j]), 1, sizeof(double));
            } /* for each vertex */
        } /* for each ring */
    } /* for each complex part */

#ifdef DEBUG2
    printf("(SHPWriteOGisPolygon) outta here \n");
#endif
    return (1);
}

/* **************************************************************************
 * SHPWriteOGisLine
 *
 * for this pass code to more generic OGis MultiXXXXXXX Type
 * later add support for OGis LineString Type
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
int SHPWriteOGisLine(WKBStreamObj *stream_obj, const SHPObject *psCShape)
{
    return (SHPWriteOGisPolygon(stream_obj, psCShape));
}

/* **************************************************************************
 * SHPWriteOGisPoint
 *
 * for this pass code to more generic OGis MultiPoint Type
 * later add support for OGis Point Type
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
int SHPWriteOGisPoint(WKBStreamObj *stream_obj, const SHPObject *psCShape)
{
    WKBStreamWrite(stream_obj, &(psCShape->nVertices), 1, sizeof(int));

    for (int j = 0; j < psCShape->nVertices; j++)
    {
        WKBStreamWrite(stream_obj, &(psCShape->padfX[j]), 1, sizeof(double));
        WKBStreamWrite(stream_obj, &(psCShape->padfY[j]), 1, sizeof(double));
    } /* for each vertex */

    return (1);
}

/* **************************************************************************
 * SHPReadOGisPolygon
 *
 * for this pass code to more generic OGis MultiPolygon Type
 * later add support for OGis Polygon Type
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
SHPObject *SHPReadOGisPolygon(WKBStreamObj *stream_obj)
{
    SHPObject *psC = SHPCreateObject(SHPT_POLYGON, -1, 0, NULL, NULL, 0, NULL,
                                     NULL, NULL, NULL);
    /* initialize a blank SHPObject */

    int cParts;
    WKBStreamRead(stream_obj, &cParts, 1, sizeof(char));

    int totParts = cParts;
    int totVertices = 0;

    psC->panPartStart = realloc(psC->panPartStart, cParts * sizeof(int));
    psC->panPartType = realloc(psC->panPartType, cParts * sizeof(int));

    int rVertices;
    int nParts;
    for (int cpart = 0; cpart < cParts; cpart++)
    {
        WKBStreamRead(stream_obj, &nParts, 1, sizeof(int));
        const int pRings = nParts;
        /* pRings is the number of rings prior to the Ring loop below */

        if (nParts > 1)
        {
            totParts += nParts - 1;
            psC->panPartStart =
                realloc(psC->panPartStart, totParts * sizeof(int));
            psC->panPartType =
                realloc(psC->panPartType, totParts * sizeof(int));
        }

        int rPart = 0;
        for (int ring = 0; ring < (nParts - 1); ring++)
        {
            WKBStreamRead(stream_obj, &rVertices, 1, sizeof(int));
            totVertices += rVertices;

            psC->panPartStart[ring + pRings] = rPart;
            if (ring == 0)
            {
                psC->panPartType[ring + pRings] = SHPP_OUTERRING;
            }
            else
            {
                psC->panPartType[ring + pRings] = SHPP_INNERRING;
            }

            psC->padfX = realloc(psC->padfX, totVertices * sizeof(double));
            psC->padfY = realloc(psC->padfY, totVertices * sizeof(double));

            for (int j = rPart; j < (rPart + rVertices); j++)
            {
                WKBStreamRead(stream_obj, &(psC->padfX[j]), 1, sizeof(double));
                WKBStreamRead(stream_obj, &(psC->padfY[j]), 1, sizeof(double));
            } /* for each vertex */
            rPart += rVertices;
        } /* for each ring */
    } /* for each complex part */

    return (psC);
}

/* **************************************************************************
 * SHPReadOGisLine
 *
 * for this pass code to more generic OGis MultiLineString Type
 * later add support for OGis LineString Type
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
SHPObject *SHPReadOGisLine(WKBStreamObj *stream_obj)
{
    SHPObject *psC =
        SHPCreateObject(SHPT_ARC, -1, 0, NULL, NULL, 0, NULL, NULL, NULL, NULL);
    /* initialize a blank SHPObject */

    int cParts;
    WKBStreamRead(stream_obj, &cParts, 1, sizeof(int));

    int totParts = cParts;
    int totVertices = 0;

    psC->panPartStart = realloc(psC->panPartStart, cParts * sizeof(int));
    psC->panPartType = realloc(psC->panPartType, cParts * sizeof(int));

    int rVertices;
    int nParts;
    for (int cpart = 0; cpart < cParts; cpart++)
    {
        WKBStreamRead(stream_obj, &nParts, 1, sizeof(int));
        int pRings = totParts;
        /* pRings is the number of rings prior to the Ring loop below			*/

        if (nParts > 1)
        {
            totParts += nParts - 1;
            psC->panPartStart =
                realloc(psC->panPartStart, totParts * sizeof(int));
            psC->panPartType =
                realloc(psC->panPartType, totParts * sizeof(int));
        }

        int rPart = 0;
        for (int ring = 0; ring < (nParts - 1); ring++)
        {
            WKBStreamRead(stream_obj, &rVertices, 1, sizeof(int));
            totVertices += rVertices;

            psC->panPartStart[ring + pRings] = rPart;
            if (ring == 0)
            {
                psC->panPartType[ring + pRings] = SHPP_OUTERRING;
            }
            else
            {
                psC->panPartType[ring + pRings] = SHPP_INNERRING;
            }

            psC->padfX = realloc(psC->padfX, totVertices * sizeof(double));
            psC->padfY = realloc(psC->padfY, totVertices * sizeof(double));

            for (int j = rPart; j < (rPart + rVertices); j++)
            {
                WKBStreamRead(stream_obj, &(psC->padfX[j]), 1, sizeof(double));
                WKBStreamRead(stream_obj, &(psC->padfY[j]), 1, sizeof(double));
            } /* for each vertex */
            rPart += rVertices;
        } /* for each ring */
    } /* for each complex part */

    return (psC);
}

/* **************************************************************************
 * SHPReadOGisPoint
 *
 * Encapsulate entire SHPObject for use with Postgresql
 *
 * **************************************************************************/
SHPObject *SHPReadOGisPoint(WKBStreamObj *stream_obj)
{
    SHPObject *psC = SHPCreateObject(SHPT_MULTIPOINT, -1, 0, NULL, NULL, 0,
                                     NULL, NULL, NULL, NULL);
    /* initialize a blank SHPObject */

    int nVertices;
    WKBStreamRead(stream_obj, &nVertices, 1, sizeof(int));

    psC->padfX = realloc(psC->padfX, nVertices * sizeof(double));
    psC->padfY = realloc(psC->padfY, nVertices * sizeof(double));

    for (int j = 0; j < nVertices; j++)
    {
        WKBStreamRead(stream_obj, &(psC->padfX[j]), 1, sizeof(double));
        WKBStreamRead(stream_obj, &(psC->padfY[j]), 1, sizeof(double));
    } /* for each vertex */

    return (psC);
}

/* **************************************************************************
 * SHPDimension
 *
 * Return the Dimensionality of the SHPObject
 * a handy utility function
 *
 * **************************************************************************/
int SHPDimension(int SHPType)
{
    int dimension = 0;

    switch (SHPType)
    {
        case SHPT_POINT:
            dimension = SHPD_POINT;
            break;
        case SHPT_ARC:
            dimension = SHPD_LINE;
            break;
        case SHPT_POLYGON:
            dimension = SHPD_AREA;
            break;
        case SHPT_MULTIPOINT:
            dimension = SHPD_POINT;
            break;
        case SHPT_POINTZ:
            dimension = SHPD_POINT | SHPD_Z;
            break;
        case SHPT_ARCZ:
            dimension = SHPD_LINE | SHPD_Z;
            break;
        case SHPT_POLYGONZ:
            dimension = SHPD_AREA | SHPD_Z;
            break;
        case SHPT_MULTIPOINTZ:
            dimension = SHPD_POINT | SHPD_Z;
            break;
        case SHPT_POINTM:
            dimension = SHPD_POINT | SHPD_MEASURE;
            break;
        case SHPT_ARCM:
            dimension = SHPD_LINE | SHPD_MEASURE;
            break;
        case SHPT_POLYGONM:
            dimension = SHPD_AREA | SHPD_MEASURE;
            break;
        case SHPT_MULTIPOINTM:
            dimension = SHPD_POINT | SHPD_MEASURE;
            break;
        case SHPT_MULTIPATCH:
            dimension = SHPD_AREA;
            break;
    }

    return (dimension);
}

/* **************************************************************************
 * SHPPointinPoly_2d
 *
 * Return a Point inside an R+ of a potentially
 * complex/compound SHPObject suitable for labelling
 * return only one point even if if is a compound object
 *
 * reject non area SHP Types
 *
 * **************************************************************************/
PT SHPPointinPoly_2d(const SHPObject *psCShape)
{
    PT rPT;
    if (!(SHPDimension(psCShape->nSHPType) & SHPD_AREA))
    {
        rPT.x = NAN;
        rPT.y = NAN;
        return rPT;
    }

    PT *sPT = SHPPointsinPoly_2d(psCShape);
    if (sPT)
    {
        rPT.x = sPT[0].x;
        rPT.y = sPT[0].y;
    }
    else
    {
        rPT.x = NAN;
        rPT.y = NAN;
    }
    return (rPT);
}

/* **************************************************************************
 * SHPPointsinPoly_2d
 *
 * Return a Point inside each R+ of a potentially
 * complex/compound SHPObject suitable for labelling
 * return one point for each R+ even if it is a compound object
 *
 * reject non area SHP Types
 *
 * **************************************************************************/
PT *SHPPointsinPoly_2d(const SHPObject *psCShape)
{
    if (!(SHPDimension(psCShape->nSHPType) & SHPD_AREA))
        return NULL;

    PT *PIP = NULL;
    int cRing = 0;
    int nPIP = 0;
    int rMpart, ring_nVertices;
    // TODO(schwehr): Is this a bug?  Should rLen be zero'ed on each loop?
    double rLen = 0;
    double rLenMax = 0;

    SHPObject *psO;
    while ((psO = SHPUnCompound(psCShape, &cRing)) != NULL)
    {
        double *CLx = calloc(4, sizeof(double));
        double *CLy = calloc(4, sizeof(double));
        int *CLst = calloc(2, sizeof(int));
        int *CLstt = calloc(2, sizeof(int));
        // TODO(schwehr): Check for allocation failures

        // a horizontal & vertical compound line though the middle of the extents
        CLx[0] = psO->dfXMin;
        CLy[0] = (psO->dfYMin + psO->dfYMax) * 0.5;
        CLx[1] = psO->dfXMax;
        CLy[1] = (psO->dfYMin + psO->dfYMax) * 0.5;

        CLx[2] = (psO->dfXMin + psO->dfXMax) * 0.5;
        CLy[2] = psO->dfYMin;
        CLx[3] = (psO->dfXMin + psO->dfXMax) * 0.5;
        CLy[3] = psO->dfYMax;

        CLst[0] = 0;
        CLst[1] = 2;
        CLstt[0] = SHPP_RING;
        CLstt[1] = SHPP_RING;

        SHPObject *CLine = SHPCreateObject(SHPT_POINT, -1, 2, CLst, CLstt, 4,
                                           CLx, CLy, NULL, NULL);

        /* with the H & V centrline compound object, intersect it with the OBJ	*/
        SHPObject *psInt = SHPIntersect_2d(CLine, psO);
        /* return SHP type is lowest common dimensionality of the input types 	*/

        // find the longest linestring returned by the intersection
        int ring_vtx = psInt->nVertices;
        for (int ring = (psInt->nParts - 1); ring >= 0; ring--)
        {
            ring_nVertices = ring_vtx - psInt->panPartStart[ring];

            rLen += RingLength_2d(
                ring_nVertices,
                (double *)&(psInt->padfX[psInt->panPartStart[ring]]),
                (double *)&(psInt->padfY[psInt->panPartStart[ring]]));

            if (rLen > rLenMax)
            {
                rLenMax = rLen;
                rMpart = psInt->panPartStart[ring];
            }
            ring_vtx = psInt->panPartStart[ring];
        }

        // add the centerpoint of the longest ARC of the intersection to the PIP list
        nPIP++;
        PIP = realloc(PIP, sizeof(double) * 2 * nPIP);
        PIP[nPIP].x = (psInt->padfX[rMpart] + psInt->padfX[rMpart]) * 0.5;
        PIP[nPIP].y = (psInt->padfY[rMpart] + psInt->padfY[rMpart]) * 0.5;

        SHPDestroyObject(psO);
        SHPDestroyObject(CLine);

        // does SHPCreateobject use preallocated memory or does it copy the
        // contents.  To be safe conditionally release CLx, CLy, CLst, CLstt
        free(CLx);
        free(CLy);
        free(CLst);
        free(CLstt);
    }

    return (PIP);
}

/* **************************************************************************
 * SHPCentrd_2d
 *
 * Return the single mathematical / geometric centroid of a potentially
 * complex/compound SHPObject
 *
 * reject non area SHP Types
 *
 * **************************************************************************/
PT SHPCentrd_2d(const SHPObject *psCShape)
{
    PT C;
    if (!(SHPDimension(psCShape->nSHPType) & SHPD_AREA))
    {
        C.x = NAN;
        C.y = NAN;
        return C;
    }

#ifdef DEBUG
    printf("for Object with %d vtx, %d parts [ %d, %d] \n", psCShape->nVertices,
           psCShape->nParts, psCShape->panPartStart[0],
           psCShape->panPartStart[1]);
#endif

    double Area = 0;
    C.x = 0.0;
    C.y = 0.0;

    /* for each ring in compound / complex object calc the ring cntrd		*/

    double ringArea;
    PT ringCentrd;
    int ringPrev = psCShape->nVertices;
    for (int ring = (psCShape->nParts - 1); ring >= 0; ring--)
    {
        const int rStart = psCShape->panPartStart[ring];
        const int ring_nVertices = ringPrev - rStart;

        RingCentroid_2d(ring_nVertices, (double *)&(psCShape->padfX[rStart]),
                        (double *)&(psCShape->padfY[rStart]), &ringCentrd,
                        &ringArea);

#ifdef DEBUG
        printf(
            "(SHPCentrd_2d)  Ring %d, vtxs %d, area: %f, ring centrd %f, %f \n",
            ring, ring_nVertices, ringArea, ringCentrd.x, ringCentrd.y);
#endif

        /* use Superposition of these rings to build a composite Centroid		*/
        /* sum the ring centrds * ringAreas,  at the end divide by total area	*/
        C.x += ringCentrd.x * ringArea;
        C.y += ringCentrd.y * ringArea;
        Area += ringArea;
        ringPrev = rStart;
    }

    /* hold on the division by AREA until were at the end					*/
    C.x = C.x / Area;
    C.y = C.y / Area;
#ifdef DEBUG
    printf("SHPCentrd_2d) Overall Area: %f, Centrd %f, %f \n", Area, C.x, C.y);
#endif
    return (C);
}

/* **************************************************************************
 * RingCentroid_2d
 *
 * Return the mathematical / geometric centroid of a single closed ring
 *
 * **************************************************************************/
int RingCentroid_2d(int nVertices, const double *a, const double *b, PT *C,
                    double *Area)
{
    /* the centroid of a closed Ring is defined as
 *
 *      Cx = sum (cx * dArea ) / Total Area
 *  and
 *      Cy = sum (cy * dArea ) / Total Area
 */
    double x_base = a[0];
    double y_base = b[0];

    double Cy_accum = 0.0;
    double Cx_accum = 0.0;

    double ppx = a[1] - x_base;
    double ppy = b[1] - y_base;
    *Area = 0;

    /* Skip the closing vector */
    for (int iv = 2; iv <= nVertices - 2; iv++)
    {
        const double x = a[iv] - x_base;
        const double y = b[iv] - y_base;

        /* calc the area and centroid of triangle built out of an arbitrary 	*/
        /* base_point on the ring and each successive pair on the ring			*/

        /* Area of a triangle is the cross product of its defining vectors		*/
        /* Centroid of a triangle is the average of its vertices				*/

        const double dx_Area = ((x * ppy) - (y * ppx)) * 0.5;
        *Area += dx_Area;

        Cx_accum += (ppx + x) * dx_Area;
        Cy_accum += (ppy + y) * dx_Area;
#ifdef DEBUG2
        printf("(ringcentrd_2d)  Pp( %f, %f), P(%f, %f)\n", ppx, ppy, x, y);
        printf("(ringcentrd_2d)    dA: %f, sA: %f, Cx: %f, Cy: %f \n", dx_Area,
               *Area, Cx_accum, Cy_accum);
#endif
        ppx = x;
        ppy = y;
    }

#ifdef DEBUG2
    printf("(ringcentrd_2d)  Cx: %f, Cy: %f \n", (Cx_accum / (*Area * 3)),
           (Cy_accum / (*Area * 3)));
#endif

    /* adjust back to world coords 											*/
    C->x = (Cx_accum / (*Area * 3)) + x_base;
    C->y = (Cy_accum / (*Area * 3)) + y_base;

    return (1);
}

/* **************************************************************************
 * SHPRingDir_2d
 *
 * Test Polygon for CW / CCW  ( R+ / R- )
 *
 * return 1  for R+
 * return -1 for R-
 * return 0  for error
 * **************************************************************************/
int SHPRingDir_2d(const SHPObject *psCShape, int Ring)
{
    if (Ring >= psCShape->nParts)
        return (0);

    double tX = 0.0;
    const double *a = psCShape->padfX;
    const double *b = psCShape->padfY;

    int last_vtx;
    if (Ring >= psCShape->nParts - 1)
    {
        last_vtx = psCShape->nVertices;
    }
    else
    {
        last_vtx = psCShape->panPartStart[Ring + 1];
    }

    /* All vertices at the corners of the extrema (rightmost lowest, leftmost lowest, 	*/
    /* topmost rightest, ...) must be less than pi wide.  If they weren't, they couldn't be	*/
    /* extrema.																			*/
    /* of course the following will fail if the Extents are even a little wrong 			*/

    int ti;
    for (int i = psCShape->panPartStart[Ring]; i < last_vtx; i++)
    {
        if (b[i] == psCShape->dfYMax && a[i] > tX)
        {
            ti = i;
        }
    }

#ifdef DEBUG2
    printf("(shpgeo:SHPRingDir) highest Rightmost Pt is vtx %d (%f, %f)\n", ti,
           a[ti], b[ti]);
#endif

    /* cross product */
    /* the sign of the cross product of two vectors indicates the right or left half-plane	*/
    /* which we can use to indicate Ring Dir													*/
    double dx0;
    double dx1;
    double dy0;
    double dy1;
    if (ti > psCShape->panPartStart[Ring] && ti < last_vtx)
    {
        dx0 = a[ti - 1] - a[ti];
        dx1 = a[ti + 1] - a[ti];
        dy0 = b[ti - 1] - b[ti];
        dy1 = b[ti + 1] - b[ti];
    }
    else
    /* if the tested vertex is at the origin then continue from 0 */
    {
        dx1 = a[1] - a[0];
        dx0 = a[last_vtx] - a[0];
        dy1 = b[1] - b[0];
        dy0 = b[last_vtx] - b[0];
    }

    //   v1 = ( (dy0 * 0) - (0 * dy1) );
    //   v2 = ( (0 * dx1) - (dx0 * 0) );
    /* these above are always zero so why do the math */
    const double v3 = ((dx0 * dy1) - (dx1 * dy0));

#ifdef DEBUG2
    printf("(shpgeo:SHPRingDir)  cross product for vtx %d was %f \n", ti, v3);
#endif

    if (v3 > 0)
    {
        return (1);
    }
    else
    {
        return (-1);
    }
}

/* **************************************************************************
 * SHPArea_2d
 *
 * Calculate the XY Area of Polygon ( can be compound / complex )
 *
 * **************************************************************************/
double SHPArea_2d(const SHPObject *psCShape)
{
    if (!(SHPDimension(psCShape->nSHPType) & SHPD_AREA))
        return (-1);

    double cArea = 0;

    /* Walk each ring adding its signed Area,  R- will return a negative 	*/
    /* area, so we don't have to test for them								*/

    /* I just start at the last ring and work down to the first				*/
    int ring_vtx = psCShape->nVertices;
    for (int ring = (psCShape->nParts - 1); ring >= 0; ring--)
    {
        const int ring_nVertices = ring_vtx - psCShape->panPartStart[ring];

#ifdef DEBUG2
        printf("(shpgeo:SHPArea_2d) part %d, vtx %d \n", ring, ring_nVertices);
#endif
        cArea += RingArea_2d(
            ring_nVertices,
            (double *)&(psCShape->padfX[psCShape->panPartStart[ring]]),
            (double *)&(psCShape->padfY[psCShape->panPartStart[ring]]));

        ring_vtx = psCShape->panPartStart[ring];
    }

#ifdef DEBUG2
    printf("(shpgeo:SHPArea_2d) Area = %f \n", cArea);
#endif

    /* Area is signed, negative Areas are R-									*/
    return (cArea);
}

/* **************************************************************************
 * SHPLength_2d
 *
 * Calculate the Planar ( XY ) Length of Polygon ( can be compound / complex )
 *    or Polyline ( can be compound ).  Length on Polygon is its Perimeter
 *
 * **************************************************************************/
double SHPLength_2d(const SHPObject *psCShape)
{
    if (!(SHPDimension(psCShape->nSHPType) & (SHPD_AREA | SHPD_LINE)))
        return -1.0;

    double Length = 0;
    int j = 1;
    for (int i = 1; i < psCShape->nVertices; i++)
    {
        if (psCShape->panPartStart[j] == i)
        {
            j++;
        }
        /* skip the moves with "pen up" from ring to ring */
        else
        {
            const double dx = psCShape->padfX[i] - psCShape->padfX[i - 1];
            const double dy = psCShape->padfY[i] - psCShape->padfY[i - 1];
            Length += sqrt((dx * dx) + (dy * dy));
        }
        /* simplify this equation */
    }

    return Length;
}

/* **************************************************************************
 * RingLength_2d
 *
 * Calculate the Planar ( XY ) Length of Polygon ( can be compound / complex )
 *    or Polyline ( can be compound ).  Length of Polygon is its Perimeter
 *
 * **************************************************************************/
double RingLength_2d(int nVertices, const double *a, const double *b)
{
    double Length = 0;
    // int j = 1;
    for (int i = 1; i < nVertices; i++)
    {
        const double dx = a[i] - b[i - 1];
        const double dy = b[i] - b[i - 1];
        Length += sqrt((dx * dx) + (dy * dy));
        /* simplify this equation */
    }

    return (Length);
}

/* **************************************************************************
 * RingArea_2d
 *
 * Calculate the Planar Area of a single closed ring
 *
 * **************************************************************************/
double RingArea_2d(int nVertices, const double *a, const double *b)
{
    const double x_base = a[0];
    const double y_base = b[0];

    double ppx = a[1] - x_base;
    double ppy = b[1] - y_base;
    static double Area = 0.0;

#ifdef DEBUG2
    printf("(shpgeo:RingArea) %d vertices \n", nVertices);
#endif
    for (int iv = 2; iv <= (nVertices - 1); iv++)
    {
        const double x = a[iv] - x_base;
        const double y = b[iv] - y_base;

        /* Area of a triangle is the cross product of its defining vectors		*/

        const double dx_Area = ((x * ppy) - (y * ppx)) * 0.5;

        Area += dx_Area;
#ifdef DEBUG2
        printf("(shpgeo:RingArea)  dxArea %f  sArea %f for pt(%f, %f)\n",
               dx_Area, Area, x, y);
#endif

        ppx = x;
        ppy = y;
    }

#ifdef DEBUG2
    printf("(shpgeo:RingArea)  total RingArea %f \n", Area);
#endif
    return Area;
}

/* **************************************************************************
 * SHPUnCompound
 *
 * ESRI calls this function explode
 * Return a non compound ( possibly complex ) object
 *
 * ring_number is R+ number corresponding to object
 *
 * ignore complexity in Z dimension for now
 *
 * **************************************************************************/
SHPObject *SHPUnCompound(const SHPObject *psCShape, int *ringNumber)
{
    if (*ringNumber >= psCShape->nParts || *ringNumber == -1)
    {
        *ringNumber = -1;
        return NULL;
    }

    if (*ringNumber == (psCShape->nParts - 1))
    {
        *ringNumber = -1;
        return (SHPClone(psCShape, (psCShape->nParts - 1), -1));
    }

    const int lRing = *ringNumber;
    int ringDir = -1;
    int ring = (lRing + 1);
    for (; (ring < psCShape->nParts) && (ringDir < 0); ring++)
        ringDir = SHPRingDir_2d(psCShape, ring);

    if (ring == psCShape->nParts)
        *ringNumber = -1;
    else
        *ringNumber = ring;
        /*    I am strictly assuming that all R- parts of a complex object
 *	   directly follow their R+, so when we hit a new R+ its a
 *	   new part of a compound object
 *         a SHPClean may be needed to enforce this as it is not part
 *	   of ESRI's definition of a SHPfile
 */

#ifdef DEBUG2
    printf("(SHPUnCompound) asked for ring %d, lastring is %d \n", lRing, ring);
#endif
    return (SHPClone(psCShape, lRing, ring));
}

/* **************************************************************************
 * SHPIntersect_2d
 *
 *
 * prototype only for now
 *
 * return object with lowest common dimensionality of objects
 *
 * **************************************************************************/
SHPObject *SHPIntersect_2d(const SHPObject *a, const SHPObject *b)
{
    if ((SHPDimension(a->nSHPType) && SHPD_POINT) ||
        (SHPDimension(b->nSHPType) && SHPD_POINT))
        return (NULL);
    /* there is no intersect function like this for points  */

    SHPObject *C = SHPClone(a, 0, -1);

    return C;
}

/* **************************************************************************
 * SHPClean
 *
 * Test and fix normalization problems in shapes
 * Different tests need to be implemented for different SHPTypes
 * 	SHPT_POLYGON	check ring directions CW / CCW   ( R+ / R- )
 *				put all R- after the R+ they are members of
 *				i.e. each complex object is completed before the
 *     				next object is started
 *				check for closed rings
 *				ring must not intersect itself, even on edge
 *
 *  no other types implemented yet
 *
 * not sure why but return object in place
 * use for object casting and object verification
 * **************************************************************************/
int SHPClean(SHPObject *psCShape)
{
    return (0);
}

/* **************************************************************************
 * SHPClone
 *
 * Clone a SHPObject, replicating all data
 *
 * **************************************************************************/
SHPObject *SHPClone(const SHPObject *psCShape, int lowPart, int highPart)
{
    if (highPart >= psCShape->nParts || highPart == -1)
        highPart = psCShape->nParts;

#ifdef DEBUG
    printf(" cloning SHP (%d parts) from ring %d to ring %d \n",
           psCShape->nParts, lowPart, highPart);
#endif

    const int newParts = highPart - lowPart;
    if (newParts == 0)
    {
        return (NULL);
    }

    SHPObject *psObject = (SHPObject *)calloc(1, sizeof(SHPObject));
    psObject->nSHPType = psCShape->nSHPType;
    psObject->nShapeId = psCShape->nShapeId;

    psObject->nParts = newParts;
    if (psCShape->padfX)
    {
        psObject->panPartStart = (int *)calloc(newParts, sizeof(int));
        memcpy(psObject->panPartStart, psCShape->panPartStart,
               newParts * sizeof(int));

        psObject->panPartType = (int *)calloc(newParts, sizeof(int));
        memcpy(psObject->panPartType, (int *)&(psCShape->panPartType[lowPart]),
               newParts * sizeof(int));
    }

    int newVertices;
    if (highPart != psCShape->nParts)
    {
        newVertices =
            psCShape->panPartStart[highPart] - psCShape->panPartStart[lowPart];
    }
    else
    {
        newVertices = psCShape->nVertices - psCShape->panPartStart[lowPart];
    }

#ifdef DEBUG
    int i;
    if (highPart = psCShape->nParts)
        i = psCShape->nVertices;
    else
        i = psCShape->panPartStart[highPart];
    printf(" from part %d (%d) to %d (%d) is %d vertices \n", lowPart,
           psCShape->panPartStart[lowPart], highPart, i, newVertices);
#endif
    psObject->nVertices = newVertices;
    if (psCShape->padfX)
    {
        psObject->padfX = (double *)calloc(newVertices, sizeof(double));
        memcpy(psObject->padfX,
               (double *)&(psCShape->padfX[psCShape->panPartStart[lowPart]]),
               newVertices * sizeof(double));
    }
    if (psCShape->padfY)
    {
        psObject->padfY = (double *)calloc(newVertices, sizeof(double));
        memcpy(psObject->padfY,
               (double *)&(psCShape->padfY[psCShape->panPartStart[lowPart]]),
               newVertices * sizeof(double));
    }
    if (psCShape->padfZ)
    {
        psObject->padfZ = (double *)calloc(newVertices, sizeof(double));
        memcpy(psObject->padfZ,
               (double *)&(psCShape->padfZ[psCShape->panPartStart[lowPart]]),
               newVertices * sizeof(double));
    }
    if (psCShape->padfM)
    {
        psObject->padfM = (double *)calloc(newVertices, sizeof(double));
        memcpy(psObject->padfM,
               (double *)&(psCShape->padfM[psCShape->panPartStart[lowPart]]),
               newVertices * sizeof(double));
    }

    psObject->dfXMin = psCShape->dfXMin;
    psObject->dfYMin = psCShape->dfYMin;
    psObject->dfZMin = psCShape->dfZMin;
    psObject->dfMMin = psCShape->dfMMin;

    psObject->dfXMax = psCShape->dfXMax;
    psObject->dfYMax = psCShape->dfYMax;
    psObject->dfZMax = psCShape->dfZMax;
    psObject->dfMMax = psCShape->dfMMax;

    SHPComputeExtents(psObject);
    return (psObject);
}

/************************************************************************/
/*  SwapG 				                              	*/
/*                                                                      */
/*      Swap a 2, 4 or 8 byte word.                                     */
/************************************************************************/
void SwapG(void *so, const void *in, int this_cnt, int this_size)
{
    // return to a new pointer otherwise it would invalidate existing data
    // as prevent further use of it
    for (int j = 0; j < this_cnt; j++)
    {
        for (int i = 0; i < this_size / 2; i++)
        {
            ((unsigned char *)so)[i] = ((unsigned char *)in)[this_size - i - 1];
            ((unsigned char *)so)[this_size - i - 1] = ((unsigned char *)in)[i];
        }
    }
}

/* **************************************************************************
 * SwapW
 *
 * change byte order on an array of 16 bit words
 * need to change this over to shapelib, Frank Warmerdam's functions
 *
 * **************************************************************************/
void swapW(void *so, const unsigned char *in, long bytes)
{
    const unsigned char map[4] = {3, 2, 1, 0};
    unsigned char *out = so;
    for (int i = 0; i <= (bytes / 4); i++)
        for (int j = 0; j < 4; j++)
            out[(i * 4) + map[j]] = in[(i * 4) + j];
}

/* **************************************************************************
 * SwapD
 *
 * change byte order on an array of (double) 32 bit words
 * need to change this over to shapelib, Frank Warmerdam's functions
 *
 * **************************************************************************/
void swapD(void *so, const unsigned char *in, long bytes)
{
    const unsigned char map[8] = {7, 6, 5, 4, 3, 2, 1, 0};
    unsigned char *out = so;
    for (int i = 0; i <= (bytes / 8); i++)
        for (int j = 0; j < 8; j++)
            out[(i * 8) + map[j]] = in[(i * 8) + j];
}