/usr/include/spatialite/gg_formats.h is in libspatialite-dev 4.1.1-5ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 | /*
gg_formats.h -- Gaia common support for geometries: formats
version 4.1, 2013 May 8
Author: Sandro Furieri a.furieri@lqt.it
------------------------------------------------------------------------------
Version: MPL 1.1/GPL 2.0/LGPL 2.1
The contents of this file are subject to the Mozilla Public License Version
1.1 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.mozilla.org/MPL/
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the
License.
The Original Code is the SpatiaLite library
The Initial Developer of the Original Code is Alessandro Furieri
Portions created by the Initial Developer are Copyright (C) 2008-2013
the Initial Developer. All Rights Reserved.
Contributor(s):
Klaus Foerster klaus.foerster@svg.cc
Alternatively, the contents of this file may be used under the terms of
either the GNU General Public License Version 2 or later (the "GPL"), or
the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
in which case the provisions of the GPL or the LGPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of either the GPL or the LGPL, and not to allow others to
use your version of this file under the terms of the MPL, indicate your
decision by deleting the provisions above and replace them with the notice
and other provisions required by the GPL or the LGPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the MPL, the GPL or the LGPL.
*/
/**
\file gg_formats.h
Geometry handling functions: formats
*/
#ifndef _GG_FORMATS_H
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define _GG_FORMATS_H
#endif
#ifdef __cplusplus
extern "C"
{
#endif
/* function prototypes */
/**
Test CPU endianness
\return 0 if big-endian: any other value if little-endian
*/
GAIAGEO_DECLARE int gaiaEndianArch (void);
/**
Import an INT-16 value in endian-aware fashion
\param p endian-dependent representation (input buffer).
\param little_endian 0 if the input buffer is big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\return the internal SHORT value
\sa gaiaEndianArch, gaiaExport16
\note you are expected to pass an input buffer corresponding to an
allocation size of (at least) 2 bytes.
*/
GAIAGEO_DECLARE short gaiaImport16 (const unsigned char *p,
int little_endian,
int little_endian_arch);
/**
Import an INT-32 value in endian-aware fashion
\param p endian-dependent representation (input buffer).
\param little_endian 0 if the input buffer is big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\return the internal INT value
\sa gaiaEndianArch, gaiaExport32
\note you are expected to pass an input buffer corresponding to an
allocation size of (at least) 4 bytes.
*/
GAIAGEO_DECLARE int gaiaImport32 (const unsigned char *p, int little_endian,
int little_endian_arch);
/**
Import an UINT-32 value in endian-aware fashion
\param p endian-dependent representation (input buffer).
\param little_endian 0 if the input buffer is big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\return the internal UINT value
\sa gaiaEndianArch, gaiaExportU32
\note you are expected to pass an input buffer corresponding to an
allocation size of (at least) 4 bytes.
*/
GAIAGEO_DECLARE unsigned int gaiaImportU32 (const unsigned char *p,
int little_endian,
int little_endian_arch);
/**
Import a FLOAT-32 value in endian-aware fashion
\param p endian-dependent representation (input buffer).
\param little_endian 0 if the input buffer is big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\return the internal FLOAT value
\sa gaiaEndianArch, gaiaExportF32
\note you are expected to pass an input buffer corresponding to an
allocation size of (at least) 4 bytes.
*/
GAIAGEO_DECLARE float gaiaImportF32 (const unsigned char *p,
int little_endian,
int little_endian_arch);
/**
Import an DOUBLE-64 in endian-aware fashion
\param p endian-dependent representation (input buffer).
\param little_endian 0 if the input buffer is big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\return the internal DOUBLE value
\sa gaiaEndianArch, gaiaExport64
\note you are expected to pass an input buffer corresponding to an
allocation size of (at least) 8 bytes.
*/
GAIAGEO_DECLARE double gaiaImport64 (const unsigned char *p,
int little_endian,
int little_endian_arch);
/**
Import an INT-64 in endian-aware fashion
\param p endian-dependent representation (input buffer).
\param little_endian 0 if the input buffer is big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\return the internal INT-64 value
\sa gaiaEndianArch, gaiaExportI64
\note you are expected to pass an input buffer corresponding to an
allocation size of (at least) 8 bytes.
*/
GAIAGEO_DECLARE sqlite3_int64 gaiaImportI64 (const unsigned char *p,
int little_endian,
int little_endian_arch);
/**
Export an INT-16 value in endian-aware fashion
\param p endian-dependent representation (output buffer).
\param value the internal value to be exported.
\param little_endian 0 if the output buffer has to be big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\sa gaiaEndianArch, gaiaImport16
\note you are expected to pass an output buffer corresponding to an
allocation size of (at least) 2 bytes.
*/
GAIAGEO_DECLARE void gaiaExport16 (unsigned char *p, short value,
int little_endian,
int little_endian_arch);
/**
Export an INT-32 value in endian-aware fashion
\param p endian-dependent representation (output buffer).
\param value the internal value to be exported.
\param little_endian 0 if the output buffer has to be big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\sa gaiaEndianArch, gaiaImport32
\note you are expected to pass an output buffer corresponding to an
allocation size of (at least) 4 bytes.
*/
GAIAGEO_DECLARE void gaiaExport32 (unsigned char *p, int value,
int little_endian,
int little_endian_arch);
/**
Export an UINT-32 value in endian-aware fashion
\param p endian-dependent representation (output buffer).
\param value the internal value to be exported.
\param little_endian 0 if the output buffer has to be big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\sa gaiaEndianArch, gaiaImportU32
\note you are expected to pass an output buffer corresponding to an
allocation size of (at least) 4 bytes.
*/
GAIAGEO_DECLARE void gaiaExportU32 (unsigned char *p, unsigned int value,
int little_endian,
int little_endian_arch);
/**
Export a FLOAT-32 value in endian-aware fashion
\param p endian-dependent representation (output buffer).
\param value the internal value to be exported.
\param little_endian 0 if the output buffer has to be big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\sa gaiaEndianArch, gaiaImportF32
\note you are expected to pass an output buffer corresponding to an
allocation size of (at least) 4 bytes.
*/
GAIAGEO_DECLARE void gaiaExportF32 (unsigned char *p, float value,
int little_endian,
int little_endian_arch);
/**
Export a DOUBLE value in endian-aware fashion
\param p endian-dependent representation (output buffer).
\param value the internal value to be exported.
\param little_endian 0 if the output buffer has to be big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\sa gaiaEndianArch, gaiaImport64
\note you are expected to pass an output buffer corresponding to an
allocation size of (at least) 8 bytes.
*/
GAIAGEO_DECLARE void gaiaExport64 (unsigned char *p, double value,
int little_endian,
int little_endian_arch);
/**
Export an INT-64 value in endian-aware fashion
\param p endian-dependent representation (output buffer).
\param value the internal value to be exported.
\param little_endian 0 if the output buffer has to be big-endian: any other value
for little-endian.
\param little_endian_arch the value returned by gaiaEndianArch()
\sa gaiaEndianArch, gaiaImportI64
\note you are expected to pass an output buffer corresponding to an
allocation size of (at least) 8 bytes.
*/
GAIAGEO_DECLARE void gaiaExportI64 (unsigned char *p, sqlite3_int64 value,
int little_endian,
int little_endian_arch);
/**
Initializes a dynamically growing Text output buffer
\param buf pointer to gaiaOutBufferStruct structure
\sa gaiaOutBufferReset, gaiaAppendToOutBuffer
\note Text notations representing Geometry objects may easily require
a huge storage amount: the gaiaOutBufferStruct automatically supports
a dynamically growing output buffer.
\n You are required to initialize this structure before attempting
any further operation;
and you are responsible to cleanup any related memory allocation
when it's any longer required.
*/
GAIAGEO_DECLARE void gaiaOutBufferInitialize (gaiaOutBufferPtr buf);
/**
Resets a dynamically growing Text output buffer to its initial (empty) state
\param buf pointer to gaiaOutBufferStruct structure
\sa gaiaOutBufferInitialize, gaiaAppendToOutBuffer
\note You are required to initialize this structure before attempting
any further operation:
this function will release any related memory allocation.
*/
GAIAGEO_DECLARE void gaiaOutBufferReset (gaiaOutBufferPtr buf);
/**
Appends a text string at the end of Text output buffer
\param buf pointer to gaiaOutBufferStruct structure.
\param text the text string to be appended.
\sa gaiaOutBufferInitialize, gaiaOutBufferReset
\note You are required to initialize this structure before attempting
any further operation:
the dynamically growing Text buffer will be automatically allocated
and/or extended as required.
*/
GAIAGEO_DECLARE void gaiaAppendToOutBuffer (gaiaOutBufferPtr buf,
const char *text);
/**
Creates a BLOB-Geometry representing a Point
\param x Point X coordinate.
\param y Point Y coordinate.
\param srid the SRID to be set for the Point.
\param result on completion will containt a pointer to BLOB-Geometry:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\sa gaiaFromSpatiaLiteBlobWkb
\note the BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaMakePoint (double x, double y, int srid,
unsigned char **result, int *size);
/**
Creates a BLOB-Geometry representing a PointZ
\param x Point X coordinate.
\param y Point Y coordinate.
\param z Point Z coordinate.
\param srid the SRID to be set for the Point.
\param result on completion will containt a pointer to BLOB-Geometry:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\sa gaiaFromSpatiaLiteBlobWkb
\note the BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaMakePointZ (double x, double y, double z, int srid,
unsigned char **result, int *size);
/**
Creates a BLOB-Geometry representing a PointM
\param x Point X coordinate.
\param y Point Y coordinate.
\param m Point M coordinate.
\param srid the SRID to be set for the Point.
\param result on completion will containt a pointer to BLOB-Geometry:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\sa gaiaFromSpatiaLiteBlobWkb
\note the BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaMakePointM (double x, double y, double m, int srid,
unsigned char **result, int *size);
/**
Creates a BLOB-Geometry representing a PointZM
\param x Point X coordinate.
\param y Point Y coordinate.
\param z Point Z coordinate.
\param m Point M coordinate.
\param srid the SRID to be set for the Point.
\param result on completion will containt a pointer to BLOB-Geometry:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\sa gaiaFromSpatiaLiteBlobWkb
\note the BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaMakePointZM (double x, double y, double z,
double m, int srid,
unsigned char **result, int *size);
/**
Creates a BLOB-Geometry representing a Segment (2-Points Linestring)
\param geom1 pointer to first Geometry object (expected to represent a Point).
\param geom2 pointer to second Geometry object (expected to represent a Point).
\param result on completion will containt a pointer to BLOB-Geometry:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\sa gaiaFromSpatiaLiteBlobWkb
\note the BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaMakeLine (gaiaGeomCollPtr geom1,
gaiaGeomCollPtr geom2,
unsigned char **result, int *size);
/**
Creates a Geometry object from the corresponding BLOB-Geometry
\param blob pointer to BLOB-Geometry
\param size the BLOB's size
\return the pointer to the newly created Geometry object: NULL on failure
\sa gaiaFreeGeomColl, gaiaToSpatiaLiteBlobWkb, gaiaToCompressedBlobWkb
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaFromSpatiaLiteBlobWkb (const unsigned
char *blob,
unsigned int
size);
/**
Creates a BLOB-Geometry corresponding to a Geometry object
\param geom pointer to the Geometry object.
\param result on completion will containt a pointer to BLOB-Geometry:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\sa gaiaFromSpatiaLiteBlobWkb, gaiaToCompressedBlobWkb
\note the BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaToSpatiaLiteBlobWkb (gaiaGeomCollPtr geom,
unsigned char **result,
int *size);
/**
Creates a Compressed BLOB-Geometry corresponding to a Geometry object
\param geom pointer to the Geometry object.
\param result on completion will containt a pointer to Compressed BLOB-Geometry:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\sa gaiaFromSpatiaLiteBlobWkb, gaiaToSpatiaLiteBlobWkb
\note this function will apply compression to any Linestring / Ring found
within the Geometry to be encoded.
\n the returned BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaToCompressedBlobWkb (gaiaGeomCollPtr geom,
unsigned char **result,
int *size);
/**
Creates a Geometry object from WKB notation
\param blob pointer to WKB buffer
\param size the BLOB's size (in bytes)
\return the pointer to the newly created Geometry object: NULL on failure.
\sa gaiaToWkb, gaiaToHexWkb, gaiaFromEWKB, gaiaToEWKB
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaFromWkb (const unsigned char *blob,
unsigned int size);
/**
Encodes a Geometry object into WKB notation
\param geom pointer to Geometry object
\param result on completion will containt a pointer to the WKB buffer [BLOB]:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\sa gaiaFromWkb, gaiaToHexWkb, gaiaFromEWKB, gaiaToEWKB
\note this function will apply 3D WKB encoding as internally intended by
SpatiaLite: not necessarily intended by other OGC-like implementations.
\n Anyway, 2D WKB is surely standard and safely interoperable.
\n the returned BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaToWkb (gaiaGeomCollPtr geom,
unsigned char **result, int *size);
/**
Encodes a Geometry object into (hex) WKB notation
\param geom pointer to Geometry object
\return the pointer to a text buffer containing WKB translated into plain
hexadecimal: NULL on failure.
\sa gaiaFromWkb, gaiaToWkb, gaiaFromEWKB, gaiaToEWKB
\note the returned buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE char *gaiaToHexWkb (gaiaGeomCollPtr geom);
/**
Encodes a Geometry object into EWKB notation
\param out_buf pointer to dynamically growing Text buffer
\param geom pointer to Geometry object
\sa gaiaFromWkb, gaiaToWkb, gaiaToHexWkb, gaiaFromEWKB, gaiaToEWKB
\note this function will produce strictly conformat EWKB; you can
safely use this for PostGIS data exchange.
*/
GAIAGEO_DECLARE void gaiaToEWKB (gaiaOutBufferPtr out_buf,
gaiaGeomCollPtr geom);
/**
Creates a Geometry object from EWKB notation
\param in_buffer pointer to EWKB buffer
\return the pointer to the newly created Geometry object: NULL on failure.
\sa gaiaToWkb, gaiaToHexWkb, gaiaParseHexEWKB, gaiaToEWKB, gaiaEwkbGetPoint,
gaiaEwkbGetLinestring, gaiaEwkbGetPolygon, gaiaEwkbGetMultiGeometry
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaFromEWKB (const unsigned char
*in_buffer);
/**
Translates an EWKB notation from hexadecimal into binary
\param blob_hex pointer to EWKB input buffer (hexadecimal text string)
\param blob_size lenght (in bytes) of the input buffer; if succesfull will
contain the lenght of the returned output buffer.
\return the pointer to the newly created EWKB binary buffer: NULL on failure.
\sa gaiaToWkb, gaiaToHexWkb, gaiaFromEWKB, gaiaToEWKB
\note you are responsible to destroy (before or after) any buffer allocated by
gaiaParseHexEWKB()
*/
GAIAGEO_DECLARE unsigned char *gaiaParseHexEWKB (const unsigned char
*blob_hex, int *blob_size);
/**
Attempts to decode a Point from within an EWKB binary buffer
\param geom pointer to an existing Geometry object; if succesfull the parsed Point
will be inserted into this Geometry
\param blob pointer to EWKB input buffer
\param offset the offset (in bytes) on the input buffer where the Point definition is expected to start.
\param blob_size lenght (in bytes) of the input buffer.
\param endian (boolean) states if the EWKB input buffer is little- or big-endian encode.
\param endian_arch (boolean) states if the target CPU has a little- or big-endian architecture.
\param dims dimensions: one of GAIA_XY, GAIA_XY_Z, GAIA_XY_M or GAIA_XY_Z_M
\return -1 on failure; otherwise the offset where the next object starts.
\sa gaiaEwkbGetLinestring, gaiaEwkbGetPolygon, gaiaEwkbGetMultiGeometry
\note these functions are mainly intended for internal usage.
*/
GAIAGEO_DECLARE int
gaiaEwkbGetPoint (gaiaGeomCollPtr geom, unsigned char *blob,
int offset, int blob_size, int endian,
int endian_arch, int dims);
/**
Attempts to decode a Point from within an EWKB binary buffer
\param geom pointer to an existing Geometry object; if succesfull the parsed Linestring
will be inserted into this Geometry
\param blob pointer to EWKB input buffer
\param offset the offset (in bytes) on the input buffer where the Point definition is expected to start.
\param blob_size lenght (in bytes) of the input buffer.
\param endian (boolean) states if the EWKB input buffer is little- or big-endian encode.
\param endian_arch (boolean) states if the target CPU has a little- or big-endian architecture.
\param dims dimensions: one of GAIA_XY, GAIA_XY_Z, GAIA_XY_M or GAIA_XY_Z_M
\return -1 on failure; otherwise the offset where the next object starts.
\sa gaiaEwkbGetPoint, gaiaEwkbGetPolygon, gaiaEwkbGetMultiGeometry
\note these functions are mainly intended for internal usage.
*/
GAIAGEO_DECLARE int
gaiaEwkbGetLinestring (gaiaGeomCollPtr geom, unsigned char *blob,
int offset, int blob_size, int endian,
int endian_arch, int dims);
/**
Attempts to decode a Polygon from within an EWKB binary buffer
\param geom pointer to an existing Geometry object; if succesfull the parsed Polygon
will be inserted into this Geometry
\param blob pointer to EWKB input buffer
\param offset the offset (in bytes) on the input buffer where the Point definition is expected to start.
\param blob_size lenght (in bytes) of the input buffer.
\param endian (boolean) states if the EWKB input buffer is little- or big-endian encode.
\param endian_arch (boolean) states if the target CPU has a little- or big-endian architecture.
\param dims dimensions: one of GAIA_XY, GAIA_XY_Z, GAIA_XY_M or GAIA_XY_Z_M
\return -1 on failure; otherwise the offset where the next object starts.
\sa gaiaEwkbGetPoint, gaiaEwkbGetPolygon, gaiaEwkbGetMultiGeometry
*/
GAIAGEO_DECLARE int
gaiaEwkbGetPolygon (gaiaGeomCollPtr geom, unsigned char *blob,
int offset, int blob_size, int endian,
int endian_arch, int dims);
/**
Attempts to decode a MultiGeometry from within an EWKB binary buffer
\param geom pointer to an existing Geometry object; if succesfull the parsed MultiGeometry
will be inserted into this Geometry
\param blob pointer to EWKB input buffer
\param offset the offset (in bytes) on the input buffer where the Point definition is expected to start.
\param blob_size lenght (in bytes) of the input buffer.
\param endian (boolean) states if the EWKB input buffer is little- or big-endian encode.
\param endian_arch (boolean) states if the target CPU has a little- or big-endian architecture.
\param dims dimensions: one of GAIA_XY, GAIA_XY_Z, GAIA_XY_M or GAIA_XY_Z_M
\return -1 on failure; otherwise the offset where the next object starts.
\sa gaiaEwkbGetPoint, gaiaEwkbGetLinestring, gaiaEwkbGetPolygon
\note these functions are mainly intended for internal usage.
*/
GAIAGEO_DECLARE int
gaiaEwkbGetMultiGeometry (gaiaGeomCollPtr geom, unsigned char *blob,
int offset, int blob_size, int endian,
int endian_arch, int dims);
/**
Creates a Geometry object from FGF notation
\param blob pointer to FGF buffer
\param size the BLOB's size (in bytes)
\return the pointer to the newly created Geometry object: NULL on failure.
\sa gaiaToFgf
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaFromFgf (const unsigned char *blob,
unsigned int size);
/**
Encodes a Geometry object into FGF notation
\param geom pointer to Geometry object
\param result on completion will containt a pointer to the FGF buffer [BLOB]:
NULL on failure.
\param size on completion this variable will contain the BLOB's size (in bytes)
\param coord_dims one of: GAIA_XY, GAIA_XY_Z, GAIA_XY_M, GAIA_XY_ZM
\sa gaiaFromFgf
\note the returned BLOB buffer corresponds to dynamically allocated memory:
so you are responsible to free() it [unless SQLite will take care
of memory cleanup via buffer binding].
*/
GAIAGEO_DECLARE void gaiaToFgf (gaiaGeomCollPtr geom,
unsigned char **result, int *size,
int coord_dims);
/**
Creates a Geometry object from WKT notation
\param in_buffer pointer to WKT buffer
\param type the expected Geometry Class Type
\n if actual type defined in WKT doesn't corresponds to this, an error will
be raised.
\return the pointer to the newly created Geometry object: NULL on failure
\sa gaiaOutWkt, gaiaOutWktStrict, gaiaParseEWKT, gaiaToEWKT
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaParseWkt (const unsigned char
*in_buffer, short type);
/**
Encodes a Geometry object into WKT notation
\param out_buf pointer to dynamically growing Text buffer
\param geom pointer to Geometry object
\sa gaiaParseWkt, gaiaOutWktStrict, gaiaParseEWKT, gaiaToEWKT
\note this function will apply 3D WKT encoding as internally intended by
SpatiaLite: not necessarily intended by other OGC-like implementations.
\n Anyway, 2D WKT is surely standard and safely interoperable.
*/
GAIAGEO_DECLARE void gaiaOutWkt (gaiaOutBufferPtr out_buf,
gaiaGeomCollPtr geom);
/**
Encodes a Geometry object into strict 2D WKT notation
\param out_buf pointer to dynamically growing Text buffer
\param geom pointer to Geometry object
\param precision decimal digits to be used for coordinates
\sa gaiaParseWkt, gaiaOutWkt, gaiaParseEWKT, gaiaToEWKT
\note this function will apply strict 2D WKT encoding, so to be surely
standard and safely interoperable.
\n Dimensions will be automatically casted to 2D [XY] when required.
*/
GAIAGEO_DECLARE void gaiaOutWktStrict (gaiaOutBufferPtr out_buf,
gaiaGeomCollPtr geom, int precision);
/**
Creates a Geometry object from EWKT notation
\param in_buffer pointer to EWKT buffer
\return the pointer to the newly created Geometry object: NULL on failure
\sa gaiaParseWkt, gaiaOutWkt, gaiaOutWktStrict, gaiaToEWKT
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaParseEWKT (const unsigned char
*in_buffer);
/**
Encodes a Geometry object into EWKT notation
\param out_buf pointer to dynamically growing Text buffer
\param geom pointer to Geometry object
\sa gaiaParseWkt, gaiaOutWkt, gaiaOutWktStrict, gaiaParseEWKT
\note this function will apply PostGIS own EWKT encoding.
*/
GAIAGEO_DECLARE void gaiaToEWKT (gaiaOutBufferPtr out_buf,
gaiaGeomCollPtr geom);
/**
Encodes a WKT 3D Point [XYZ]
\param out_buf pointer to dynamically growing Text buffer
\param point pointer to Point object
\sa gaiaOutLinestringZ, gaiaOutPolygonZ
\remark mainly intended for internal usage.
*/
GAIAGEO_DECLARE void gaiaOutPointZ (gaiaOutBufferPtr out_buf,
gaiaPointPtr point);
/**
Encodes a WKT 3D Linestring [XYZ]
\param out_buf pointer to dynamically growing Text buffer
\param linestring pointer to Linestring object
\sa gaiaOutPointZ, gaiaOutPolygonZ
\remark mainly intended for internal usage.
*/
GAIAGEO_DECLARE void gaiaOutLinestringZ (gaiaOutBufferPtr out_buf,
gaiaLinestringPtr linestring);
/**
Encodes a WKT 3D Polygon [XYZ]
\param out_buf pointer to dynamically growing Text buffer
\param polygon pointer to Point object
\sa gaiaOutPointZ, gaiaOutLinestringZ
\remark mainly intended for internal usage.
*/
GAIAGEO_DECLARE void gaiaOutPolygonZ (gaiaOutBufferPtr out_buf,
gaiaPolygonPtr polygon);
/**
Creates a Geometry object from KML notation
\param in_buffer pointer to KML buffer
\return the pointer to the newly created Geometry object: NULL on failure
\sa gaiaOutBareKml, gaiaOutFullKml
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaParseKml (const unsigned char
*in_buffer);
/**
Encodes a Geometry object into KML notation
\param out_buf pointer to dynamically growing Text buffer
\param geom pointer to Geometry object
\param precision decimal digits to be used for coordinates
\sa gaiaParseKml, gaiaOutFullKml
\note this function will export the simplest KML notation (no descriptions).
*/
GAIAGEO_DECLARE void gaiaOutBareKml (gaiaOutBufferPtr out_buf,
gaiaGeomCollPtr geom, int precision);
/**
Encodes a Geometry object into KML notation
\param out_buf pointer to dynamically growing Text buffer
\param name text string to be set as KML \e name
\param desc text string to se set as KML \e description
\param geom pointer to Geometry object
\param precision decimal digits to be used for coordinates
\sa gaiaParseKml, gaiaOutBareKml
\note this function will export the simplest KML notation (no descriptions).
*/
GAIAGEO_DECLARE void gaiaOutFullKml (gaiaOutBufferPtr out_buf,
const char *name, const char *desc,
gaiaGeomCollPtr geom, int precision);
/**
Creates a Geometry object from GML notation
\param in_buffer pointer to GML buffer
\param sqlite_handle handle to current DB connection
\return the pointer to the newly created Geometry object: NULL on failure
\sa gaiaOutGml
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaParseGml (const unsigned char
*in_buffer,
sqlite3 * sqlite_handle);
/**
Encodes a Geometry object into GML notation
\param out_buf pointer to dynamically growing Text buffer
\param version GML version
\param precision decimal digits to be used for coordinates
\param geom pointer to Geometry object
\sa gaiaParseGml
\note if \e version is set to \b 3, then GMLv3 will be used;
in any other case GMLv2 will be assumed by default.
*/
GAIAGEO_DECLARE void gaiaOutGml (gaiaOutBufferPtr out_buf, int version,
int precision, gaiaGeomCollPtr geom);
/**
Creates a Geometry object from GeoJSON notation
\param in_buffer pointer to GeoJSON buffer
\return the pointer to the newly created Geometry object: NULL on failure
\sa gaiaOutGeoJSON
\note you are responsible to destroy (before or after) any allocated Geometry,
unless you've passed ownership of the Geometry object to some further object:
in this case destroying the higher order object will implicitly destroy any
contained child object.
*/
GAIAGEO_DECLARE gaiaGeomCollPtr gaiaParseGeoJSON (const unsigned char
*in_buffer);
/**
Encodes a Geometry object into GeoJSON notation
\param out_buf pointer to dynamically growing Text buffer
\param geom pointer to Geometry object
\param precision decimal digits to be used for coordinates
\param options GeoJSON specific options
\sa gaiaParseGeoJSON
\note \e options can assume the following values:
\li 1 = BBOX, no CRS
\li 2 = no BBOX, short form CRS
\li 3 = BBOX, short form CRS
\li 4 = no BBOX, long form CRS
\li 5 = BBOX, long form CRS
\li any other value: no BBOX and no CRS
*/
GAIAGEO_DECLARE void gaiaOutGeoJSON (gaiaOutBufferPtr out_buf,
gaiaGeomCollPtr geom, int precision,
int options);
/**
Encodes a Geometry object into SVG notation
\param out_buf pointer to dynamically growing Text buffer
\param geom pointer to Geometry object
\param relative flag: relative or absolute coordinates
\param precision decimal digits to be used for coordinates
\note if \e relative is set to \b 1, then SVG relative coords will be used:
in any other case SVG absolute coords will be assumed by default.
*/
GAIAGEO_DECLARE void gaiaOutSvg (gaiaOutBufferPtr out_buf,
gaiaGeomCollPtr geom, int relative,
int precision);
/**
Allocates a new DBF Field Value object [duplicating an existing one]
\param org pointer to input DBF Field Value object.
\return the pointer to newly created DBF Field object.
\sa gaiaAllocDbfField, gaiaFreeDbfField, gaiaCloneDbfField, gaiaCloneValue,
gaiaSetNullValue, gaiaSetIntValue, gaiaSetDoubleValue,
gaiaSetStrValue
\note the newly created object is an exact copy of the original one.
*/
GAIAGEO_DECLARE gaiaValuePtr gaiaCloneValue (gaiaValuePtr org);
/**
Resets a DBF Field Value object to its initial empty state
\param p pointer to DBF Field Value object
\sa gaiaAllocDbfField, gaiaCloneDbfField, gaiaCloneValue,
gaiaSetNullValue, gaiaSetIntValue, gaiaSetDoubleValue,
gaiaSetStrValue, gaiaResetDbfEntity
*/
GAIAGEO_DECLARE void gaiaFreeValue (gaiaValuePtr p);
/**
Allocates a new DBF Field object
\param name text string: DBF Field name.
\param type identifier of the corresponding DBF data type.
\param offset corresponding offset into the DBF I/O buffer.
\param length max field length (in bytes).
\param decimals precision: number of decimal digits.
\return the pointer to newly created DBF Field object.
\sa gaiaFreeDbfField, gaiaCloneDbfField, gaiaFreeValue,
gaiaSetNullValue, gaiaSetIntValue, gaiaSetDoubleValue,
gaiaSetStrValue
\note you are responsible to destroy (before or after) any allocated DBF Field,
unless you've passed ownership to some further object: in this case destroying the higher order object will implicitly destroy any contained child object.
\n supported DBF data types are:
\li 'C' text string [default]
\li 'N' numeric
\li 'D' date
\li 'L' boolean
*/
GAIAGEO_DECLARE gaiaDbfFieldPtr gaiaAllocDbfField (char *name,
unsigned char type,
int offset,
unsigned char length,
unsigned char decimals);
/**
Destroys a DBF Field object
\param p pointer to DBF Field object
\sa gaiaAllocDbfField, gaiaCloneDbfField, gaiaCloneValue,
gaiaFreeValue, gaiaSetNullValue, gaiaSetIntValue, gaiaSetDoubleValue,
gaiaSetStrValue
*/
GAIAGEO_DECLARE void gaiaFreeDbfField (gaiaDbfFieldPtr p);
/**
Allocates a new DBF Field object [duplicating an existing one]
\param org pointer to input DBF Field object.
\return the pointer to newly created DBF Field object.
\sa gaiaAllocDbfField, gaiaFreeDbfField, gaiaCloneDbfField,
gaiaFreeValue, gaiaSetNullValue, gaiaSetIntValue, gaiaSetDoubleValue,
gaiaSetStrValue
\note the newly created object is an exact copy of the original one
[this including an evantual Field Value].
*/
GAIAGEO_DECLARE gaiaDbfFieldPtr gaiaCloneDbfField (gaiaDbfFieldPtr org);
/**
Sets a NULL current value for a DBF Field object
\param field pointer to DBF Field object
\sa gaiaAllocDbfField, gaiaFreeDbfField, gaiaCloneDbfField,
gaiaFreeValue, gaiaSetIntValue, gaiaSetDoubleValue,
gaiaSetStrValue
*/
GAIAGEO_DECLARE void gaiaSetNullValue (gaiaDbfFieldPtr field);
/**
Sets an INTEGER current value for a DBF Field object
\param field pointer to DBF Field object.
\param value integer value to be set.
\sa gaiaAllocDbfField, gaiaFreeDbfField, gaiaCloneDbfField,
gaiaFreeValue, gaiaSetNullValue, gaiaSetDoubleValue,
gaiaSetStrValue
*/
GAIAGEO_DECLARE void gaiaSetIntValue (gaiaDbfFieldPtr field,
sqlite3_int64 value);
/**
Sets a DOUBLE current value for a DBF Field object
\param field pointer to DBF Field object.
\param value double value to be set.
\sa gaiaAllocDbfField, gaiaFreeDbfField, gaiaCloneDbfField,
gaiaFreeValue, gaiaSetNullValue, gaiaSetIntValue, gaiaSetStrValue
*/
GAIAGEO_DECLARE void gaiaSetDoubleValue (gaiaDbfFieldPtr field,
double value);
/**
Sets a TEXT current value for a DBF Field object
\param field pointer to DBF Field object.
\param str text string value to be set.
\sa gaiaAllocDbfField, gaiaFreeDbfField, gaiaCloneDbfField,
gaiaFreeValue, gaiaSetNullValue, gaiaSetIntValue, gaiaSetDoubleValue
*/
GAIAGEO_DECLARE void gaiaSetStrValue (gaiaDbfFieldPtr field, char *str);
/**
Creates an initially empty DBF List object
\return the pointer to newly allocated DBF List object: NULL on failure.
\sa gaiaFreeDbfList, gaiaIsValidDbfList,
gaiaResetDbfEntity, gaiaCloneDbfEntity, gaiaAddDbfField
\note you are responsible to destroy (before or after) any allocated DBF List,
unless you've passed ownership to some further object: in this case destroying
the higher order object will implicitly destroy any contained child object.
*/
GAIAGEO_DECLARE gaiaDbfListPtr gaiaAllocDbfList (void);
/**
Destroys a DBF List object
\param list pointer to the DBF List object
\sa gaiaAllocDbfList, gaiaIsValidDbfList,
gaiaResetDbfEntity, gaiaCloneDbfEntity, gaiaAddDbfField
\note attempting to destroy any DBF List object whose ownnership has already
been transferred to some other (higher order) object is a serious error,
and will easily cause severe memory corruption.
*/
GAIAGEO_DECLARE void gaiaFreeDbfList (gaiaDbfListPtr list);
/**
Checks a DBF List object for validity
\param list pointer to the DBF List object.
\return 0 if not valid: any other value if valid.
\sa gaiaAllocDbfList, gaiaFreeDbfList, gaiaIsValidDbfList,
gaiaResetDbfEntity, gaiaCloneDbfEntity, gaiaAddDbfField
*/
GAIAGEO_DECLARE int gaiaIsValidDbfList (gaiaDbfListPtr list);
/**
Inserts a further DBF Field object into a DBF List object
\param list pointer to the DBF List object.
\param name text string: DBF Field name.
\param type identifier of the corresponding DBF data type.
\param offset corresponding offset into the DBF I/O buffer.
\param length max field length (in bytes).
\param decimals precision: number of decimal digits.
\return the pointer to newly created DBF Field object.
\sa gaiaAllocDbfField
\note supported DBF data types are:
\li 'C' text string [default]
\li 'N' numeric
\li 'D' date
\li 'L' boolean
*/
GAIAGEO_DECLARE gaiaDbfFieldPtr gaiaAddDbfField (gaiaDbfListPtr list,
char *name,
unsigned char type,
int offset,
unsigned char length,
unsigned char decimals);
/**
Resets a DBF List object to its initial empty state
\param list pointer to the DBF List object.
\sa gaiaFreeValue
\note any DBF Field associated to the List object will be reset to its
initial empty state (i.e. \e no \e value at all).
*/
GAIAGEO_DECLARE void gaiaResetDbfEntity (gaiaDbfListPtr list);
/**
Allocates a new DBF List object [duplicating an existing one]
\param org pointer to input DBF List object.
\return the pointer to newly created DBF List object.
\sa gaiaCloneDbfField, gaiaCloneValue,
\note the newly created object is an exact copy of the original one.
\n this including any currently set Field Value.
*/
GAIAGEO_DECLARE gaiaDbfListPtr gaiaCloneDbfEntity (gaiaDbfListPtr org);
/**
Allocates a new Shapefile object.
\return the pointer to newly created Shapefile object.
\sa gaiaFreeShapefile, gaiaOpenShpRead, gaiaOpenShpWrite,
gaiaReadShpEntity, gaiaShpAnalyze, gaiaWriteShpEntity, gaiaFlushShpHeaders
\note you are responsible to destroy (before or after) any allocated Shapefile.
\n you should phisically open the Shapefile in \e read or \e write mode
before performing any actual I/O operation.
*/
GAIAGEO_DECLARE gaiaShapefilePtr gaiaAllocShapefile (void);
/**
Destroys a Shapefile object
\param shp pointer to the Shapefile object.
\sa gaiaAllocShapefile, gaiaOpenShpRead, gaiaOpenShpWrite,
gaiaReadShpEntity, gaiaShpAnalyze, gaiaWriteShpEntity, gaiaFlushShpHeaders
\note destroying the Shapefile object will close any related file:
anyway you a responsible to explicitly call gaiaFlushShpHeader
before destroyng a Shapefile opened in \e write mode.
*/
GAIAGEO_DECLARE void gaiaFreeShapefile (gaiaShapefilePtr shp);
/**
Open a Shapefile in read mode
\param shp pointer to the Shapefile object.
\param path \e abstract pathname to the corresponding file-system files.
\param charFrom GNU ICONV name identifying the input charset encoding.
\param charTo GNU ICONV name identifying the output charset encoding.
\sa gaiaAllocShapefile, gaiaFreeShapefile, gaiaOpenShpWrite,
gaiaReadShpEntity, gaiaShpAnalyze, gaiaWriteShpEntity, gaiaFlushShpHeaders
\note on failure the object member \e Valid will be set to 0; and the
object member \e LastError will contain the appropriate error message.
\n the \e abstract pathname should not contain any suffix at all.
*/
GAIAGEO_DECLARE void gaiaOpenShpRead (gaiaShapefilePtr shp,
const char *path,
const char *charFrom,
const char *charTo);
/**
Open a Shapefile in read mode
\param shp pointer to the Shapefile object.
\param path \e abstract pathname to the corresponding file-system files.
\param shape the SHAPE code; expected to be one of GAIA_SHP_POINT,
GAIA_SHP_POLYLINE, GAIA_SHP_POLYGON, GAIA_SHP_MULTIPOINT, GAIA_SHP_POINTZ,
GAIA_SHP_POLYLINEZ, GAIA_SHP_POLYGONZ, GAIA_SHP_MULTIPOINTZ,
GAIA_SHP_POINTM, GAIA_SHP_POLYLINEM, GAIA_SHP_POLYGONM, GAIA_SHP_MULTIPOINTM
\param list pointer to DBF List object representing the corresponding
data attributes.
\param charFrom GNU ICONV name identifying the input charset encoding.
\param charTo GNU ICONV name identifying the output charset encoding.
\sa gaiaAllocShapefile, gaiaFreeShapefile, gaiaOpenShpRead,
gaiaReadShpEntity, gaiaShpAnalyze, gaiaWriteShpEntity, gaiaFlushShpHeaders
\note on failure the object member \e Valid will be set to 0; and the
object member \e LastError will contain the appropriate error message.
\n the \e abstract pathname should not contain any suffix at all.
*/
GAIAGEO_DECLARE void gaiaOpenShpWrite (gaiaShapefilePtr shp,
const char *path, int shape,
gaiaDbfListPtr list,
const char *charFrom,
const char *charTo);
/**
Reads a feature from a Shapefile object
\param shp pointer to the Shapefile object.
\param current_row the row number identifying the feature to be read.
\param srid feature's SRID
\return 0 on failure: any other value on success.
\sa gaiaAllocShapefile, gaiaFreeShapefile, gaiaOpenShpRead, gaiaOpenShpWrite,
gaiaShpAnalyze, gaiaWriteShpEntity, gaiaFlushShpHeaders
\note on completion the Shapefile's \e Dbf member will contain the feature
read:
\li the \e Dbf->Geometry member will contain the corresponding Geometry
\li and the \e Dbf->First member will point to the linked list containing
the corresponding data attributes [both data formats and values].
\remark the Shapefile object should be opened in \e read mode.
*/
GAIAGEO_DECLARE int gaiaReadShpEntity (gaiaShapefilePtr shp,
int current_row, int srid);
/**
Prescans a Shapefile object gathering informations
\param shp pointer to the Shapefile object.
\sa gaiaAllocShapefile, gaiaFreeShapefile, gaiaOpenShpRead, gaiaOpenShpWrite,
gaiaReadShpEntity, gaiaWriteShpEntity, gaiaFlushShpHeaders
\note on completion the Shapefile's \e EffectiveType will containt the
Geometry type corresponding to features actually found.
\remark the Shapefile object should be opened in \e read mode.
*/
GAIAGEO_DECLARE void gaiaShpAnalyze (gaiaShapefilePtr shp);
/**
Writes a feature into a Shapefile object
\param shp pointer to the Shapefile object.
\param entity pointer to DBF List object containing both Geometry and Field
values.
\return 0 on failure: any other value on success.
\sa gaiaAllocShapefile, gaiaFreeShapefile, gaiaOpenShpRead, gaiaOpenShpWrite,
gaiaReadShpEntity, gaiaShpAnalyze, gaiaFlushShpHeaders
\remark the Shapefile object should be opened in \e write mode.
*/
GAIAGEO_DECLARE int gaiaWriteShpEntity (gaiaShapefilePtr shp,
gaiaDbfListPtr entity);
/**
Writes into an output Shapefile any required header / footer
\param shp pointer to the Shapefile object.
\sa gaiaAllocShapefile, gaiaFreeShapefile, gaiaOpenShpRead, gaiaOpenShpWrite,
gaiaReadShpEntity, gaiaShpAnalyze, gaiaWriteShpEntity
\note forgetting to call gaiaFlushShpHeader for any Shapefile opened in
\e write mode immediately before destroying the object, will surely
cause severe file corruption.
*/
GAIAGEO_DECLARE void gaiaFlushShpHeaders (gaiaShapefilePtr shp);
/**
Allocates a new DBF File object.
\return the pointer to newly created DBF File object.
\sa gaiaFreeDbf, gaiaOpenDbfRead, gaiaOpenDbfWrite,
gaiaReadDbfEntity, gaiaWriteDbfEntity, gaiaFlushDbfHeader
\note you are responsible to destroy (before or after) any allocated DBF File.
\n you should phisically open the DBF File in \e read or \e write mode
before performing any actual I/O operation.
*/
GAIAGEO_DECLARE gaiaDbfPtr gaiaAllocDbf (void);
/**
Destroys a DBF File object
\param dbf pointer to the DBF File object.
\sa gaiaAllocDbf, gaiaFreeDbf, gaiaOpenDbfWrite,
gaiaReadDbfEntity, gaiaWriteDbfEntity, gaiaFlushDbfHeader
\note destroying the Shapefile object will close any related file:
anyway you a responsible to explicitly call gaiaFlushShpHeader
before destroyng a Shapefile opened in \e write mode.
*/
GAIAGEO_DECLARE void gaiaFreeDbf (gaiaDbfPtr dbf);
/**
Open a DBF File in read mode
\param dbf pointer to the DBF File object.
\param path pathname to the corresponding file-system file.
\param charFrom GNU ICONV name identifying the input charset encoding.
\param charTo GNU ICONV name identifying the output charset encoding.
\sa gaiaAllocDbf, gaiaFreeDbf, gaiaOpenDbfWrite,
gaiaReadDbfEntity, gaiaWriteDbfEntity, gaiaFlushDbfHeader
\note on failure the object member \e Valid will be set to 0; and the
object member \e LastError will contain the appropriate error message.
*/
GAIAGEO_DECLARE void gaiaOpenDbfRead (gaiaDbfPtr dbf,
const char *path,
const char *charFrom,
const char *charTo);
/**
Open a DBF File in write mode
\param dbf pointer to the DBF File object.
\param path pathname to the corresponding file-system file.
\param charFrom GNU ICONV name identifying the input charset encoding.
\param charTo GNU ICONV name identifying the output charset encoding.
\sa gaiaAllocDbf, gaiaFreeDbf, gaiaOpenDbfRead,
gaiaReadDbfEntity, gaiaWriteDbfEntity, gaiaFlushDbfHeader
\note on failure the object member \e Valid will be set to 0; and the
object member \e LastError will contain the appropriate error message.
*/
GAIAGEO_DECLARE void gaiaOpenDbfWrite (gaiaDbfPtr dbf,
const char *path,
const char *charFrom,
const char *charTo);
/**
Reads a record from a DBF File object
\param dbf pointer to the DBF File object.
\param current_row the row number identifying the record to be read.
\param deleted on completion this variable will contain 0 if the record
just read is valid: any other value if the record just read is marked as
\e logically \e deleted.
\return 0 on failure: any other value on success.
\sa gaiaAllocDbf, gaiaFreeDbf, gaiaOpenDbfRead, gaiaOpenDbfWrite,
gaiaFlushDbfHeader
\note on completion the DBF File \e First member will point to the
linked list containing the corresponding data attributes [both data
formats and values].
\remark the DBF File object should be opened in \e read mode.
*/
GAIAGEO_DECLARE int gaiaReadDbfEntity (gaiaDbfPtr dbf, int current_row,
int *deleted);
/**
Writes a record into a DBF File object
\param dbf pointer to the DBF File object.
\param entity pointer to DBF List object containing Fields and corresponding
values.
\return 0 on failure: any other value on success.
\sa gaiaAllocDbf, gaiaFreeDbf, gaiaOpenDbfRead, gaiaOpenDbfWrite,
gaiaReadDbfEntity, gaiaFlushDbfHeader
\remark the DBF File object should be opened in \e write mode.
*/
GAIAGEO_DECLARE int gaiaWriteDbfEntity (gaiaDbfPtr dbf,
gaiaDbfListPtr entity);
/**
Writes into an output DBF File any required header / footer
\param dbf pointer to the DBF File object.
\sa gaiaAllocDbf, gaiaFreeDbf, gaiaOpenDbfRead, gaiaOpenDbfWrite,
gaiaReadDbfEntity, gaiaWriteDbfEntity
\note forgetting to call gaiaFlushDbfHeader for any DBF File opened in
\e write mode immediately before destroying the object, will surely
cause severe file corruption.
*/
GAIAGEO_DECLARE void gaiaFlushDbfHeader (gaiaDbfPtr dbf);
#ifndef OMIT_ICONV /* ICONV enabled: supporting text reader */
/**
Creates a Text Reader object
\param path to the corresponding file-system file.
\param field_separator the character acting as a separator between adjacent
fields.
\param text_separator the character used to quote text strings.
\param decimal_separator the character used as a separator between integer
and decimal digits for real numeric values.
\param first_line_titles 0 if the first line contains regular values:
any other value if the first line contains column names.
\param encoding GNU ICONV name identifying the input charset encoding.
\return the pointer to the newly created Text Reader object: NULL on failure
\sa gaiaTextReaderDestroy, gaiaTextReaderParse,
gaiaTextReaderGetRow, gaiaTextReaderFetchField
\note you are responsible to destroy (before or after) any allocated Text
Reader object.
*/
GAIAGEO_DECLARE gaiaTextReaderPtr gaiaTextReaderAlloc (const char *path,
char field_separator,
char text_separator,
char
decimal_separator,
int
first_line_titles,
const char
*encoding);
/**
Destroys a Text Reader object
\param reader pointer to Text Reader object.
\sa gaiaTextReaderAlloc, gaiaTextReaderParse,
gaiaTextReaderGetRow, gaiaTextReaderFetchField
*/
GAIAGEO_DECLARE void gaiaTextReaderDestroy (gaiaTextReaderPtr reader);
/**
Prescans the external file associated to a Text Reade object
\param reader pointer to Text Reader object.
\return 0 on failure: any other value on success.
\sa gaiaTextReaderAlloc, gaiaTextReaderDestroy,
gaiaTextReaderGetRow, gaiaTextReaderFetchField
\note this preliminary step is required so to ensure:
\li file consistency: checking expected formatting rules.
\li identifying the number / type / name of fields [aka columns].
\li identifying the actual number of lines within the file.
*/
GAIAGEO_DECLARE int gaiaTextReaderParse (gaiaTextReaderPtr reader);
/**
Reads a line from a Text Reader object
\param reader pointer to Text Reader object.
\param row_num the Line Number identifying the Line to be read.
\return 0 on failure: any other value on success.
\sa gaiaTextReaderAlloc, gaiaTextReaderDestroy, gaiaTextReaderParse,
gaiaTextReaderFetchField
\note this function will load the requested Line into the current buffer:
you can then use gaiaTextReaderFetchField in order to retrieve
any individual field [aka column] value.
*/
GAIAGEO_DECLARE int gaiaTextReaderGetRow (gaiaTextReaderPtr reader,
int row_num);
/**
Retrieves an individual field value from the current Line
\param reader pointer to Text Reader object.
\param field_num relative field [aka column] index: first field has index 0.
\param type on completion this variable will contain the value type.
\param value on completion this variable will contain the current field value.
\return 0 on failure: any other value on success.
\sa gaiaTextReaderAlloc, gaiaTextReaderDestroy, gaiaTextReaderParse,
gaiaTextReaderGetRow
*/
GAIAGEO_DECLARE int gaiaTextReaderFetchField (gaiaTextReaderPtr reader,
int field_num, int *type,
const char **value);
#endif /* end ICONV (text reader) */
#ifdef __cplusplus
}
#endif
#endif /* _GG_FORMATS_H */
|