dbf.h

Go to the documentation of this file.

/*
 * Read ESRI shapefiles
 *
 * Copyright (C) 2023 Andreas Vögele
 *
 * This library is free software; you can redistribute it and/or modify it
 * under either the terms of the ISC License or the same terms as Perl.
 */
 
/* SPDX-License-Identifier: ISC OR Artistic-1.0-Perl OR GPL-1.0-or-later */
 
#ifndef _SHAPEREADER_DBF_H
#define _SHAPEREADER_DBF_H
 
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <time.h>
 
typedef enum dbf_version_t {
    DBF_VERSION_UNKNOWN = 0x00,
    DBF_VERSION_DBASE2 = 0x02,
    DBF_VERSION_DBASE3 = 0x03,
    DBF_VERSION_DBASE4 = 0x04,
    DBF_VERSION_DBASE5 = 0x05,
    DBF_VERSION_VISUAL_OBJECTS = 0x07,
    DBF_VERSION_VISUAL_FOXPRO = 0x30,
    DBF_VERSION_VISUAL_FOXPRO_AUTO = 0x31,
    DBF_VERSION_VISUAL_FOXPRO_VARIFIELD = 0x32,
    DBF_VERSION_DBASE3_MEMO = 0x83,
    DBF_VERSION_VISUAL_OBJECTS_MEMO = 0x87,
    DBF_VERSION_DBASE4_MEMO = 0x8b,
    DBF_VERSION_DBASE7 = 0x8c,
    DBF_VERSION_FOXPRO_MEMO = 0xf5
} dbf_version_t;
 
typedef enum dbf_type_t {
    DBF_TYPE_AUTOINCREMENT = '+',
    DBF_TYPE_BINARY_OR_DOUBLE = 'B',
    DBF_TYPE_BLOB = 'W',
    DBF_TYPE_CHARACTER = 'C',
    DBF_TYPE_CURRENCY = 'Y',
    DBF_TYPE_DATE = 'D',
    DBF_TYPE_DATETIME = 'T',
    DBF_TYPE_DOUBLE = 'O',
    DBF_TYPE_FLOAT = 'F',
    DBF_TYPE_GENERAL = 'G',
    DBF_TYPE_INTEGER = 'I',
    DBF_TYPE_LOGICAL = 'L',
    DBF_TYPE_MEMO = 'M',
    DBF_TYPE_NULLFLAGS = '0',
    DBF_TYPE_NUMBER = 'N',
    DBF_TYPE_PICTURE = 'P',
    DBF_TYPE_TIMESTAMP = '@',
    DBF_TYPE_VARBINARY = 'Q',
    DBF_TYPE_VARCHAR = 'V'
} dbf_type_t;
 
typedef struct dbf_field_t {
    struct dbf_field_t *next;   
    char name[32];              
    dbf_type_t type;            
    size_t length;              
    size_t decimal_places;      
    unsigned char reserved[14]; 
    size_t size;                /* Size in bytes */
    size_t offset;              /* Position in the record buffer */
} dbf_field_t;
 
typedef struct dbf_header_t {
    dbf_version_t version;      
    int year;                   
    int month;                  
    int day;                    
    size_t num_records;         
    size_t header_size;         
    size_t record_size;         
    unsigned char reserved[20]; 
    int num_fields;             
    dbf_field_t *fields;        
} dbf_header_t;
 
typedef struct dbf_record_t {
    char *bytes; /* Raw data of length record_size */
} dbf_record_t;
 
extern void dbf_jd_to_tm(int32_t jd, int32_t jt, struct tm *tm);
 
extern int dbf_yyyymmdd_to_tm(const char *ymd, size_t n, struct tm *tm);
 
extern void dbf_record_bytes(const dbf_record_t *record,
                             const dbf_field_t *field, const char **pbytes,
                             size_t *len);
 
extern int dbf_record_date(const dbf_record_t *record,
                           const dbf_field_t *field, struct tm *tm);
 
extern int dbf_record_datetime(const dbf_record_t *record,
                               const dbf_field_t *field, struct tm *tm);
 
extern int dbf_record_double(const dbf_record_t *record,
                             const dbf_field_t *field, double *value);
 
extern int dbf_record_int32(const dbf_record_t *record,
                            const dbf_field_t *field, int32_t *value);
 
extern int dbf_record_int64(const dbf_record_t *record,
                            const dbf_field_t *field, int64_t *value);
 
extern int dbf_record_is_deleted(const dbf_record_t *record);
 
extern int dbf_record_is_null(const dbf_record_t *record,
                              const dbf_field_t *field);
 
extern int dbf_record_logical(const dbf_record_t *record,
                              const dbf_field_t *field);
 
extern int dbf_record_logical_is_false(const dbf_record_t *record,
                                       const dbf_field_t *field);
 
extern int dbf_record_logical_is_true(const dbf_record_t *record,
                                      const dbf_field_t *field);
 
extern char *dbf_record_strdup(const dbf_record_t *record,
                               const dbf_field_t *field);
 
extern void dbf_record_string(const dbf_record_t *record,
                              const dbf_field_t *field, const char **pstr,
                              size_t *len);
 
extern int dbf_record_strtod(const dbf_record_t *record,
                             const dbf_field_t *field, double *value);
 
extern int dbf_record_strtol(const dbf_record_t *record,
                             const dbf_field_t *field, int base, long *value);
 
extern int dbf_record_strtold(const dbf_record_t *record,
                              const dbf_field_t *field, long double *value);
 
extern int dbf_record_strtoll(const dbf_record_t *record,
                              const dbf_field_t *field, int base,
                              long long *value);
 
extern int dbf_record_strtoul(const dbf_record_t *record,
                              const dbf_field_t *field, int base,
                              unsigned long *value);
 
extern int dbf_record_strtoull(const dbf_record_t *record,
                               const dbf_field_t *field, int base,
                               unsigned long long *value);
 
typedef struct dbf_file_t {
    /* File pointer */
    void *stream;
    /* Read bytes from the stream */
    size_t (*fread)(struct dbf_file_t *fh, void *buf, size_t count);
    /* Test the stream's end-of-file indicator */
    int (*feof)(struct dbf_file_t *fh);
    /* Test the stream's error indicator */
    int (*ferror)(struct dbf_file_t *fh);
    /* Set the stream's file position */
    int (*fsetpos)(struct dbf_file_t *fh, size_t offset);
    void *user_data;
    size_t num_bytes;
    char error[128];
    /* Header size */
    size_t header_size;
    /* Record size */
    size_t record_size;
} dbf_file_t;
 
extern dbf_file_t *dbf_init_file(dbf_file_t *fh, FILE *stream,
                                 void *user_data);
 
#ifdef __GNUC__
extern void dbf_set_error(dbf_file_t *fh, const char *format, ...)
    __attribute__((format(printf, 2, 3)));
#else
extern void dbf_set_error(dbf_file_t *fh, const char *format, ...);
#endif
 
typedef int (*dbf_header_callback_t)(dbf_file_t *fh,
                                     const dbf_header_t *header);
 
typedef int (*dbf_record_callback_t)(dbf_file_t *fh,
                                     const dbf_header_t *header,
                                     const dbf_record_t *record,
                                     size_t file_offset);
 
extern int dbf_read(dbf_file_t *fh, dbf_header_callback_t handle_header,
                    dbf_record_callback_t handle_record);
 
extern int dbf_read_header(dbf_file_t *fh, dbf_header_t **pheader);
 
extern int dbf_read_record(dbf_file_t *fh, dbf_record_t **precord);
 
extern int dbf_seek_record(dbf_file_t *fh, size_t file_offset,
                           dbf_record_t **precord);
 
#endif