1 #ifndef SHAPEFILE_H_INCLUDED
2 #define SHAPEFILE_H_INCLUDED
4 /******************************************************************************
5 * $Id: shapefil.h,v 1.52 2011-12-11 22:26:46 fwarmerdam Exp $
8 * Purpose: Primary include file for Shapelib.
9 * Author: Frank Warmerdam, warmerdam@pobox.com
11 ******************************************************************************
12 * Copyright (c) 1999, Frank Warmerdam
14 * This software is available under the following "MIT Style" license,
15 * or at the option of the licensee under the LGPL (see LICENSE.LGPL). This
16 * option is discussed in more detail in shapelib.html.
20 * Permission is hereby granted, free of charge, to any person obtaining a
21 * copy of this software and associated documentation files (the "Software"),
22 * to deal in the Software without restriction, including without limitation
23 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
24 * and/or sell copies of the Software, and to permit persons to whom the
25 * Software is furnished to do so, subject to the following conditions:
27 * The above copyright notice and this permission notice shall be included
28 * in all copies or substantial portions of the Software.
30 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
31 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
32 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
33 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
34 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
35 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
36 * DEALINGS IN THE SOFTWARE.
37 ******************************************************************************
39 * $Log: shapefil.h,v $
40 * Revision 1.52 2011-12-11 22:26:46 fwarmerdam
41 * upgrade .qix access code to use SAHooks (gdal #3365)
43 * Revision 1.51 2011-07-24 05:59:25 fwarmerdam
44 * minimize use of CPLError in favor of SAHooks.Error()
46 * Revision 1.50 2011-05-13 17:35:17 fwarmerdam
47 * added DBFReorderFields() and DBFAlterFields() functions (from Even)
49 * Revision 1.49 2011-04-16 14:38:21 fwarmerdam
50 * avoid warnings with gcc on SHP_CVSID
52 * Revision 1.48 2010-08-27 23:42:52 fwarmerdam
53 * add SHPAPI_CALL attribute in code
55 * Revision 1.47 2010-01-28 11:34:34 fwarmerdam
56 * handle the shape file length limits more gracefully (#3236)
58 * Revision 1.46 2008-11-12 14:28:15 fwarmerdam
59 * DBFCreateField() now works on files with records
61 * Revision 1.45 2008/11/11 17:47:10 fwarmerdam
62 * added DBFDeleteField() function
64 * Revision 1.44 2008/01/16 20:05:19 bram
65 * Add file hooks that accept UTF-8 encoded filenames on some platforms. Use SASetupUtf8Hooks
66 * tosetup the hooks and check SHPAPI_UTF8_HOOKS for its availability. Currently, this
67 * is only available on the Windows platform that decodes the UTF-8 filenames to wide
68 * character strings and feeds them to _wfopen and _wremove.
70 * Revision 1.43 2008/01/10 16:35:30 fwarmerdam
71 * avoid _ prefix on #defined symbols (bug 1840)
73 * Revision 1.42 2007/12/18 18:28:14 bram
74 * - create hook for client specific atof (bugzilla ticket 1615)
75 * - check for NULL handle before closing cpCPG file, and close after reading.
77 * Revision 1.41 2007/12/15 20:25:32 bram
78 * dbfopen.c now reads the Code Page information from the DBF file, and exports
79 * this information as a string through the DBFGetCodePage function. This is
80 * either the number from the LDID header field ("LDID/<number>") or as the
81 * content of an accompanying .CPG file. When creating a DBF file, the code can
82 * be set using DBFCreateEx.
84 * Revision 1.40 2007/12/06 07:00:25 fwarmerdam
85 * dbfopen now using SAHooks for fileio
87 * Revision 1.39 2007/12/04 20:37:56 fwarmerdam
88 * preliminary implementation of hooks api for io and errors
90 * Revision 1.38 2007/11/21 22:39:56 fwarmerdam
91 * close shx file in readonly mode (GDAL #1956)
93 * Revision 1.37 2007/10/27 03:31:14 fwarmerdam
94 * limit default depth of tree to 12 levels (gdal ticket #1594)
96 * Revision 1.36 2007/09/10 23:33:15 fwarmerdam
97 * Upstreamed support for visibility flag in SHPAPI_CALL for the needs
98 * of GDAL (gdal ticket #1810).
100 * Revision 1.35 2007/09/03 19:48:10 fwarmerdam
101 * move DBFReadAttribute() static dDoubleField into dbfinfo
103 * Revision 1.34 2006/06/17 15:33:32 fwarmerdam
104 * added pszWorkField - bug 1202 (rso)
106 * Revision 1.33 2006/02/15 01:14:30 fwarmerdam
107 * added DBFAddNativeFieldType
109 * Revision 1.32 2006/01/26 15:07:32 fwarmerdam
110 * add bMeasureIsUsed flag from Craig Bruce: Bug 1249
112 * Revision 1.31 2006/01/05 01:27:27 fwarmerdam
113 * added dbf deletion mark/fetch
115 * Revision 1.30 2005/01/03 22:30:13 fwarmerdam
116 * added support for saved quadtrees
118 * Revision 1.29 2004/09/26 20:09:35 fwarmerdam
119 * avoid rcsid warnings
121 * Revision 1.28 2003/12/29 06:02:18 fwarmerdam
122 * added cpl_error.h option
124 * Revision 1.27 2003/04/21 18:30:37 warmerda
125 * added header write/update public methods
127 * Revision 1.26 2002/09/29 00:00:08 warmerda
128 * added FTLogical and logical attribute read/write calls
130 * Revision 1.25 2002/05/07 13:46:30 warmerda
131 * added DBFWriteAttributeDirectly().
133 * Revision 1.24 2002/04/10 16:59:54 warmerda
134 * added SHPRewindObject
136 * Revision 1.23 2002/01/15 14:36:07 warmerda
137 * updated email address
139 * Revision 1.22 2002/01/15 14:32:00 warmerda
140 * try to improve SHPAPI_CALL docs
146 #include <dbmalloc.h>
153 /************************************************************************/
154 /* Configuration options. */
155 /************************************************************************/
157 /* -------------------------------------------------------------------- */
158 /* Should the DBFReadStringAttribute() strip leading and */
159 /* trailing white space? */
160 /* -------------------------------------------------------------------- */
161 #define TRIM_DBF_WHITESPACE
163 /* -------------------------------------------------------------------- */
164 /* Should we write measure values to the Multipatch object? */
165 /* Reportedly ArcView crashes if we do write it, so for now it */
167 /* -------------------------------------------------------------------- */
168 #define DISABLE_MULTIPATCH_MEASURE
170 /* -------------------------------------------------------------------- */
173 /* The following two macros are present to allow forcing */
174 /* various calling conventions on the Shapelib API. */
176 /* To force __stdcall conventions (needed to call Shapelib */
177 /* from Visual Basic and/or Dephi I believe) the makefile could */
178 /* be modified to define: */
180 /* /DSHPAPI_CALL=__stdcall */
182 /* If it is desired to force export of the Shapelib API without */
183 /* using the shapelib.def file, use the following definition. */
185 /* /DSHAPELIB_DLLEXPORT */
187 /* To get both at once it will be necessary to hack this */
188 /* include file to define: */
190 /* #define SHPAPI_CALL __declspec(dllexport) __stdcall */
191 /* #define SHPAPI_CALL1 __declspec(dllexport) * __stdcall */
193 /* The complexity of the situtation is partly caused by the */
194 /* peculiar requirement of Visual C++ that __stdcall appear */
195 /* after any "*"'s in the return value of a function while the */
196 /* __declspec(dllexport) must appear before them. */
197 /* -------------------------------------------------------------------- */
200 #define SHAPELIB_DLLEXPORT 1
203 #ifdef SHAPELIB_DLLEXPORT
204 # define SHPAPI_CALL __declspec(dllexport)
205 # define SHPAPI_CALL1(x) __declspec(dllexport) x
209 # if defined(USE_GCC_VISIBILITY_FLAG)
210 # define SHPAPI_CALL __attribute__ ((visibility("default")))
211 # define SHPAPI_CALL1(x) __attribute__ ((visibility("default"))) x
218 # define SHPAPI_CALL1(x) x SHPAPI_CALL
221 /* -------------------------------------------------------------------- */
222 /* Macros for controlling CVSID and ensuring they don't appear */
223 /* as unreferenced variables resulting in lots of warnings. */
224 /* -------------------------------------------------------------------- */
225 #ifndef DISABLE_CVSID
226 # if defined(__GNUC__) && __GNUC__ >= 4
227 # define SHP_CVSID(string) static char cpl_cvsid[] __attribute__((used)) = string;
229 # define SHP_CVSID(string) static char cpl_cvsid[] = string; \
230 static char *cvsid_aw() { return( cvsid_aw() ? ((char *) NULL) : cpl_cvsid ); }
233 # define SHP_CVSID(string)
236 /* -------------------------------------------------------------------- */
237 /* On some platforms, additional file IO hooks are defined that */
238 /* UTF-8 encoded filenames Unicode filenames */
239 /* -------------------------------------------------------------------- */
240 #if defined(_WIN32) || defined(__WIN32__) || defined(WIN32)
241 # define SHPAPI_WINDOWS
242 # define SHPAPI_UTF8_HOOKS
245 /* -------------------------------------------------------------------- */
246 /* IO/Error hook functions. */
247 /* -------------------------------------------------------------------- */
251 typedef unsigned long SAOffset;
255 SAFile (*FOpen) ( const char *filename, const char *access);
256 SAOffset (*FRead) ( void *p, SAOffset size, SAOffset nmemb, SAFile file);
257 SAOffset (*FWrite)( void *p, SAOffset size, SAOffset nmemb, SAFile file);
258 SAOffset (*FSeek) ( SAFile file, SAOffset offset, int whence );
259 SAOffset (*FTell) ( SAFile file );
260 int (*FFlush)( SAFile file );
261 int (*FClose)( SAFile file );
262 int (*Remove) ( const char *filename );
264 void (*Error) ( const char *message );
265 double (*Atof) ( const char *str );
268 void SHPAPI_CALL SASetupDefaultHooks( SAHooks *psHooks );
269 #ifdef SHPAPI_UTF8_HOOKS
270 void SHPAPI_CALL SASetupUtf8Hooks( SAHooks *psHooks );
273 /************************************************************************/
275 /************************************************************************/
283 int nShapeType; /* SHPT_* */
285 unsigned int nFileSize; /* SHP file */
289 unsigned int *panRecOffset;
290 unsigned int *panRecSize;
292 double adBoundsMin[4];
293 double adBoundsMax[4];
297 unsigned char *pabyRec;
301 typedef SHPInfo * SHPHandle;
303 /* -------------------------------------------------------------------- */
304 /* Shape types (nSHPType) */
305 /* -------------------------------------------------------------------- */
309 #define SHPT_POLYGON 5
310 #define SHPT_MULTIPOINT 8
311 #define SHPT_POINTZ 11
313 #define SHPT_POLYGONZ 15
314 #define SHPT_MULTIPOINTZ 18
315 #define SHPT_POINTM 21
317 #define SHPT_POLYGONM 25
318 #define SHPT_MULTIPOINTM 28
319 #define SHPT_MULTIPATCH 31
322 /* -------------------------------------------------------------------- */
323 /* Part types - everything but SHPT_MULTIPATCH just uses */
325 /* -------------------------------------------------------------------- */
327 #define SHPP_TRISTRIP 0
328 #define SHPP_TRIFAN 1
329 #define SHPP_OUTERRING 2
330 #define SHPP_INNERRING 3
331 #define SHPP_FIRSTRING 4
334 /* -------------------------------------------------------------------- */
335 /* SHPObject - represents on shape (without attributes) read */
336 /* from the .shp file. */
337 /* -------------------------------------------------------------------- */
342 int nShapeId; /* -1 is unknown/unassigned */
367 /* -------------------------------------------------------------------- */
368 /* SHP API Prototypes */
369 /* -------------------------------------------------------------------- */
371 /* If pszAccess is read-only, the fpSHX field of the returned structure */
372 /* will be NULL as it is not necessary to keep the SHX file open */
373 SHPHandle SHPAPI_CALL
374 SHPOpen( const char * pszShapeFile, const char * pszAccess );
375 SHPHandle SHPAPI_CALL
376 SHPOpenLL( const char *pszShapeFile, const char *pszAccess,
378 SHPHandle SHPAPI_CALL
379 SHPCreate( const char * pszShapeFile, int nShapeType );
380 SHPHandle SHPAPI_CALL
381 SHPCreateLL( const char * pszShapeFile, int nShapeType,
384 SHPGetInfo( SHPHandle hSHP, int * pnEntities, int * pnShapeType,
385 double * padfMinBound, double * padfMaxBound );
387 SHPObject SHPAPI_CALL1(*)
388 SHPReadObject( SHPHandle hSHP, int iShape );
390 SHPWriteObject( SHPHandle hSHP, int iShape, SHPObject * psObject );
393 SHPDestroyObject( SHPObject * psObject );
395 SHPComputeExtents( SHPObject * psObject );
396 SHPObject SHPAPI_CALL1(*)
397 SHPCreateObject( int nSHPType, int nShapeId, int nParts,
398 const int * panPartStart, const int * panPartType,
400 const double * padfX, const double * padfY,
401 const double * padfZ, const double * padfM );
402 SHPObject SHPAPI_CALL1(*)
403 SHPCreateSimpleObject( int nSHPType, int nVertices,
404 const double * padfX,
405 const double * padfY,
406 const double * padfZ );
409 SHPRewindObject( SHPHandle hSHP, SHPObject * psObject );
411 void SHPAPI_CALL SHPClose( SHPHandle hSHP );
412 void SHPAPI_CALL SHPWriteHeader( SHPHandle hSHP );
414 const char SHPAPI_CALL1(*)
415 SHPTypeName( int nSHPType );
416 const char SHPAPI_CALL1(*)
417 SHPPartTypeName( int nPartType );
419 /* -------------------------------------------------------------------- */
420 /* Shape quadtree indexing API. */
421 /* -------------------------------------------------------------------- */
423 /* this can be two or four for binary or quad tree */
424 #define MAX_SUBNODE 4
426 /* upper limit of tree levels for automatic estimation */
427 #define MAX_DEFAULT_TREE_DEPTH 12
429 typedef struct shape_tree_node
431 /* region covered by this node */
432 double adfBoundsMin[4];
433 double adfBoundsMax[4];
435 /* list of shapes stored at this node. The papsShapeObj pointers
436 or the whole list can be NULL */
439 SHPObject **papsShapeObj;
442 struct shape_tree_node *apsSubNode[MAX_SUBNODE];
457 SHPTree SHPAPI_CALL1(*)
458 SHPCreateTree( SHPHandle hSHP, int nDimension, int nMaxDepth,
459 double *padfBoundsMin, double *padfBoundsMax );
461 SHPDestroyTree( SHPTree * hTree );
464 SHPWriteTree( SHPTree *hTree, const char * pszFilename );
467 SHPTreeAddShapeId( SHPTree * hTree, SHPObject * psObject );
469 SHPTreeRemoveShapeId( SHPTree * hTree, int nShapeId );
472 SHPTreeTrimExtraNodes( SHPTree * hTree );
475 SHPTreeFindLikelyShapes( SHPTree * hTree,
476 double * padfBoundsMin,
477 double * padfBoundsMax,
480 SHPCheckBoundsOverlap( double *, double *, double *, double *, int );
483 SHPSearchDiskTree( FILE *fp,
484 double *padfBoundsMin, double *padfBoundsMax,
488 typedef struct SHPDiskTreeInfo* SHPTreeDiskHandle;
490 SHPTreeDiskHandle SHPAPI_CALL
491 SHPOpenDiskTree( const char* pszQIXFilename,
495 SHPCloseDiskTree( SHPTreeDiskHandle hDiskTree );
498 SHPSearchDiskTreeEx( SHPTreeDiskHandle hDiskTree,
499 double *padfBoundsMin, double *padfBoundsMax,
503 SHPWriteTreeLL(SHPTree *hTree, const char *pszFilename, SAHooks *psHooks );
505 /************************************************************************/
507 /************************************************************************/
521 int *panFieldDecimals;
527 int bCurrentRecordModified;
528 char *pszCurrentRecord;
530 int nWorkFieldLength;
536 double dfDoubleField;
542 typedef DBFInfo * DBFHandle;
552 #define XBASE_FLDHDR_SZ 32
555 DBFHandle SHPAPI_CALL
556 DBFOpen( const char * pszDBFFile, const char * pszAccess );
557 DBFHandle SHPAPI_CALL
558 DBFOpenLL( const char * pszDBFFile, const char * pszAccess,
560 DBFHandle SHPAPI_CALL
561 DBFCreate( const char * pszDBFFile );
562 DBFHandle SHPAPI_CALL
563 DBFCreateEx( const char * pszDBFFile, const char * pszCodePage );
564 DBFHandle SHPAPI_CALL
565 DBFCreateLL( const char * pszDBFFile, const char * pszCodePage, SAHooks *psHooks );
568 DBFGetFieldCount( DBFHandle psDBF );
570 DBFGetRecordCount( DBFHandle psDBF );
572 DBFAddField( DBFHandle hDBF, const char * pszFieldName,
573 DBFFieldType eType, int nWidth, int nDecimals );
576 DBFAddNativeFieldType( DBFHandle hDBF, const char * pszFieldName,
577 char chType, int nWidth, int nDecimals );
580 DBFDeleteField( DBFHandle hDBF, int iField );
583 DBFReorderFields( DBFHandle psDBF, int* panMap );
586 DBFAlterFieldDefn( DBFHandle psDBF, int iField, const char * pszFieldName,
587 char chType, int nWidth, int nDecimals );
589 DBFFieldType SHPAPI_CALL
590 DBFGetFieldInfo( DBFHandle psDBF, int iField,
591 char * pszFieldName, int * pnWidth, int * pnDecimals );
594 DBFGetFieldIndex(DBFHandle psDBF, const char *pszFieldName);
597 DBFReadIntegerAttribute( DBFHandle hDBF, int iShape, int iField );
599 DBFReadDoubleAttribute( DBFHandle hDBF, int iShape, int iField );
600 const char SHPAPI_CALL1(*)
601 DBFReadStringAttribute( DBFHandle hDBF, int iShape, int iField );
602 const char SHPAPI_CALL1(*)
603 DBFReadLogicalAttribute( DBFHandle hDBF, int iShape, int iField );
605 DBFIsAttributeNULL( DBFHandle hDBF, int iShape, int iField );
608 DBFWriteIntegerAttribute( DBFHandle hDBF, int iShape, int iField,
611 DBFWriteDoubleAttribute( DBFHandle hDBF, int iShape, int iField,
612 double dFieldValue );
614 DBFWriteStringAttribute( DBFHandle hDBF, int iShape, int iField,
615 const char * pszFieldValue );
617 DBFWriteNULLAttribute( DBFHandle hDBF, int iShape, int iField );
620 DBFWriteLogicalAttribute( DBFHandle hDBF, int iShape, int iField,
621 const char lFieldValue);
623 DBFWriteAttributeDirectly(DBFHandle psDBF, int hEntity, int iField,
625 const char SHPAPI_CALL1(*)
626 DBFReadTuple(DBFHandle psDBF, int hEntity );
628 DBFWriteTuple(DBFHandle psDBF, int hEntity, void * pRawTuple );
630 int SHPAPI_CALL DBFIsRecordDeleted( DBFHandle psDBF, int iShape );
631 int SHPAPI_CALL DBFMarkRecordDeleted( DBFHandle psDBF, int iShape,
634 DBFHandle SHPAPI_CALL
635 DBFCloneEmpty(DBFHandle psDBF, const char * pszFilename );
638 DBFClose( DBFHandle hDBF );
640 DBFUpdateHeader( DBFHandle hDBF );
642 DBFGetNativeFieldType( DBFHandle hDBF, int iField );
644 const char SHPAPI_CALL1(*)
645 DBFGetCodePage(DBFHandle psDBF );
651 #endif /* ndef SHAPEFILE_H_INCLUDED */