gg_structs.h

Go to the documentation of this file.

/*
 gg_structs.h -- Gaia common support for geometries: structures
  
 version 5.0, 2020 August 1

 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-2020
the Initial Developer. All Rights Reserved.

Contributor(s):


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.
 
*/


#ifndef _GG_STRUCTS_H
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define _GG_STRUCTS_H
#endif

#include <sys/types.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C"
{
#endif

/* supporting files bigger than 2 GB */
#ifdef _WIN32                   /* windows */
#define gaia_off_t      __int64
#define gaia_fseek      _fseeki64
#else                           /* not windows */
#define gaia_off_t      off_t
#define gaia_fseek      fseeko
#endif

    typedef struct gaiaPointStruct
    {
/* an OpenGis POINT */
        double X;               /* X,Y coordinates */
        double Y;
        double Z;               /* Z coordinate */
        double M;               /* M measure */
        int DimensionModel;     /* (x,y), (x,y,z), (x,y,m) or (x,y,z,m) */
        struct gaiaPointStruct *Next;   /* for double-linked list */
        struct gaiaPointStruct *Prev;   /* for double-linked list */
    } gaiaPoint;
    typedef gaiaPoint *gaiaPointPtr;

    typedef struct gaiaDynamicLineStruct
    {
/* a generic DYNAMIC LINE object */
        int Error;
        int Srid;
        gaiaPointPtr First;     /* Points linked list - first */
        gaiaPointPtr Last;      /* Points linked list - last */
    } gaiaDynamicLine;
    typedef gaiaDynamicLine *gaiaDynamicLinePtr;

    typedef struct gaiaLinestringStruct
    {
/* an OpenGis LINESTRING */
        int Points;             /* number of vertices */
        double *Coords;         /* X,Y [vertices] array */
        double MinX;            /* MBR - BBOX */
        double MinY;            /* MBR - BBOX */
        double MaxX;            /* MBR - BBOX */
        double MaxY;            /* MBR - BBOX */
        int DimensionModel;     /* (x,y), (x,y,z), (x,y,m) or (x,y,z,m) */
        struct gaiaLinestringStruct *Next;      /* for linked list */
    } gaiaLinestring;
    typedef gaiaLinestring *gaiaLinestringPtr;

    typedef struct gaiaRingStruct
    {
/* a GIS ring - OpenGis LINESTRING, closed */
        int Points;             /* number of vertices */
        double *Coords;         /* X,Y [vertices] array */
        int Clockwise;          /* clockwise / counterclockwise */
        double MinX;            /* MBR - BBOX */
        double MinY;            /* MBR - BBOX */
        double MaxX;            /* MBR - BBOX */
        double MaxY;            /* MBR - BBOX */
        int DimensionModel;     /* (x,y), (x,y,z), (x,y,m) or (x,y,z,m) */
        struct gaiaRingStruct *Next;    /* for linked list */
        struct gaiaPolygonStruct *Link; /* polygon reference */
    } gaiaRing;
    typedef gaiaRing *gaiaRingPtr;

    typedef struct gaiaPolygonStruct
    {
/* an OpenGis POLYGON */
        gaiaRingPtr Exterior;   /* exterior ring */
        int NumInteriors;       /* number of interior rings */
        gaiaRingPtr Interiors;  /* interior rings array */
        int NextInterior;       /* first free interior ring */
        double MinX;            /* MBR - BBOX */
        double MinY;            /* MBR - BBOX */
        double MaxX;            /* MBR - BBOX */
        double MaxY;            /* MBR - BBOX */
        int DimensionModel;     /* (x,y), (x,y,z), (x,y,m) or (x,y,z,m) */
        struct gaiaPolygonStruct *Next; /* for linked list */
    } gaiaPolygon;
    typedef gaiaPolygon *gaiaPolygonPtr;

    typedef struct gaiaGeomCollStruct
    {
/* OpenGis GEOMETRYCOLLECTION */
        int Srid;               /* the SRID value for this GEOMETRY */
        char endian_arch;       /* littleEndian - bigEndian arch for target CPU */
        char endian;            /* littleEndian - bigEndian */
        const unsigned char *blob;      /* WKB encoded buffer */
        unsigned long size;     /* buffer size */
        unsigned long offset;   /* current offset [for parsing] */
        gaiaPointPtr FirstPoint;        /* Points linked list - first */
        gaiaPointPtr LastPoint; /* Points linked list - last */
        gaiaLinestringPtr FirstLinestring;      /* Linestrings linked list - first */
        gaiaLinestringPtr LastLinestring;       /* Linestrings linked list - last */
        gaiaPolygonPtr FirstPolygon;    /* Polygons linked list - first */
        gaiaPolygonPtr LastPolygon;     /* Polygons linked list - last */
        double MinX;            /* MBR - BBOX */
        double MinY;            /* MBR - BBOX */
        double MaxX;            /* MBR - BBOX */
        double MaxY;            /* MBR - BBOX */
        int DimensionModel;     /* (x,y), (x,y,z), (x,y,m) or (x,y,z,m) */
        int DeclaredType;       /* the declared TYPE for this Geometry */
        struct gaiaGeomCollStruct *Next;        /* Vanuatu - used for linked list */
    } gaiaGeomColl;
    typedef gaiaGeomColl *gaiaGeomCollPtr;

    typedef struct gaiaPreRingStruct
    {
/* a LINESTRING used to build rings */
        gaiaLinestringPtr Line; /* a LINESTRING pointer */
        int AlreadyUsed;        /* a switch to mark an already used line element */
        struct gaiaPreRingStruct *Next; /* for linked list */
    } gaiaPreRing;
    typedef gaiaPreRing *gaiaPreRingPtr;

    typedef struct gaiaValueStruct
    {
/* a DBF field multitype value */
        short Type;             /* the type */
        char *TxtValue;         /* the text value */
        sqlite3_int64 IntValue; /* the integer value */
        double DblValue;        /* the double value */
    } gaiaValue;
    typedef gaiaValue *gaiaValuePtr;

    typedef struct gaiaDbfFieldStruct
    {
/* a DBF field definition - shapefile attribute */
        char *Name;             /* field name */
        unsigned char Type;     /* field type */
        int Offset;             /* buffer offset [this field begins at *buffer+offset* and extends for *length* bytes */
        unsigned char Length;   /* field total length [in bytes] */
        unsigned char Decimals; /* decimal positions */
        gaiaValuePtr Value;     /* the current multitype value for this attribute */
        struct gaiaDbfFieldStruct *Next;        /* pointer to next element in linked list */
    } gaiaDbfField;
    typedef gaiaDbfField *gaiaDbfFieldPtr;

    typedef struct gaiaDbfListStruct
    {
/* a linked list to contain the DBF fields definitions - shapefile attributes */
        int RowId;              /* the current RowId */
        gaiaGeomCollPtr Geometry;       /* geometry for current entity */
        gaiaDbfFieldPtr First;  /* pointer to first element in linked list */
        gaiaDbfFieldPtr Last;   /* pointer to last element in linker list */
    } gaiaDbfList;
    typedef gaiaDbfList *gaiaDbfListPtr;

    typedef struct gaiaMemFileStruct
    {
/* Memory File Type */
        char *path;
        void *buf;
        uint32_t size;
        uint32_t offset;
    } gaiaMemFile;
    typedef gaiaMemFile *gaiaMemFilePtr;

    typedef struct gaiaDbfStruct
    {
/* DBF TYPE */
        int endian_arch;
        int Valid;              /* 1 = ready to process */
        char *Path;             /* the DBF path */
        FILE *flDbf;            /* the DBF file handle */
        gaiaMemFilePtr memDbf;  /* the DBF memory file */
        gaiaDbfListPtr Dbf;     /* the DBF attributes list */
        unsigned char *BufDbf;  /* the DBF I/O buffer */
        int DbfHdsz;            /* the DBF header length */
        int DbfReclen;          /* the DBF record length */
        int DbfSize;            /* current DBF size */
        int DbfRecno;           /* current DBF record number */
        void *IconvObj;         /* opaque reference to ICONV converter */
        char *LastError;        /* last error message */
    } gaiaDbf;
    typedef gaiaDbf *gaiaDbfPtr;

    typedef struct gaiaShapefileStruct
    {
/* SHAPEFILE TYPE */
        int endian_arch;
        int Valid;              /* 1 = ready to process */
        int ReadOnly;           /* read or write mode */
        char *Path;             /* the shapefile abstract path [no suffixes] */
        FILE *flShx;            /* the SHX file handle */
        FILE *flShp;            /* the SHP file handle */
        FILE *flDbf;            /* the DBF file handle */
        gaiaMemFilePtr memShx;  /* the SHX memory file */
        gaiaMemFilePtr memShp;  /* the SHP memory file */
        gaiaMemFilePtr memDbf;  /* the DBF memory file */
        int Shape;              /* the SHAPE code for the whole shapefile */
        gaiaDbfListPtr Dbf;     /* the DBF attributes list */
        unsigned char *BufDbf;  /* the DBF I/O buffer */
        int DbfHdsz;            /* the DBF header length */
        int DbfReclen;          /* the DBF record length */
        int DbfSize;            /* current DBF size */
        int DbfRecno;           /* current DBF record number */
        unsigned char *BufShp;  /* the SHP I/O buffer */
        int ShpBfsz;            /* the SHP buffer current size */
        int ShpSize;            /* current SHP size */
        int ShxSize;            /* current SHX size */
        double MinX;            /* the MBR/BBOX for the whole shapefile */
        double MinY;
        double MaxX;
        double MaxY;
        void *IconvObj;         /* opaque reference to ICONV converter */
        char *LastError;        /* last error message */
        int EffectiveType;      /* the effective Geometry-type, as determined by gaiaShpAnalyze() */
        int EffectiveDims;      /* the effective Dimensions [XY, XYZ, XYM, XYZM], as determined by gaiaShpAnalyze() */
    } gaiaShapefile;
    typedef gaiaShapefile *gaiaShapefilePtr;

    typedef struct gaiaOutBufferStruct
    {
/* a struct handling a dynamically growing output buffer */
        char *Buffer;
        int WriteOffset;
        int BufferSize;
        int Error;
    } gaiaOutBuffer;
    typedef gaiaOutBuffer *gaiaOutBufferPtr;

#ifndef OMIT_ICONV              /* ICONV enabled: supporting text reader */

#define VRTTXT_FIELDS_MAX       65535

#define VRTTXT_BLOCK_MAX 65535

#define VRTTXT_TEXT             1

#define VRTTXT_INTEGER  2

#define VRTTXT_DOUBLE   3

#define VRTTXT_NULL     4

    struct vrttxt_line
    {
/* a struct representing a full LINE (aka Record) */
        gaia_off_t offset;
        int len;
        int field_offsets[VRTTXT_FIELDS_MAX];
        int num_fields;
        int error;
    };

    struct vrttxt_row
    {
/* a struct storing Row offsets */
        int line_no;
        gaia_off_t offset;
        int len;
        int num_fields;
    };

    struct vrttxt_row_block
    {
/*
/ for efficiency sake, individual Row offsets 
/ are grouped in reasonably sized blocks
*/
        struct vrttxt_row rows[VRTTXT_BLOCK_MAX];
        int num_rows;
        int min_line_no;
        int max_line_no;
        struct vrttxt_row_block *next;
    };

    struct vrttxt_column_header
    {
/* a struct representing a Column (aka Field) header */
        char *name;
        int type;
    };

    typedef struct vrttxt_reader
    {
/* the main TXT-Reader struct */
        struct vrttxt_column_header columns[VRTTXT_FIELDS_MAX];
        FILE *text_file;
        void *toUtf8;           /* the UTF-8 ICONV converter */
        char field_separator;
        char text_separator;
        char decimal_separator;
        int first_line_titles;
        int error;
        struct vrttxt_row_block *first;
        struct vrttxt_row_block *last;
        struct vrttxt_row **rows;
        int num_rows;
        int line_no;
        int max_fields;
        int current_buf_sz;
        int current_buf_off;
        char *line_buffer;
        char *field_buffer;
        int field_offsets[VRTTXT_FIELDS_MAX];
        int field_lens[VRTTXT_FIELDS_MAX];
        int max_current_field;
        int current_line_ready;
    } gaiaTextReader;
    typedef gaiaTextReader *gaiaTextReaderPtr;

#endif                          /* end ICONV (text reader) */

    typedef struct gaiaLayerExtentInfos
    {
        int Count;
        double MinX;            /* MBR - BBOX */
        double MinY;            /* MBR - BBOX */
        double MaxX;            /* MBR - BBOX */
        double MaxY;            /* MBR - BBOX */
    } gaiaLayerExtent;

    typedef gaiaLayerExtent *gaiaLayerExtentPtr;

    typedef struct gaiaLayerAuthInfos
    {
        int IsReadOnly;
        int IsHidden;
        int HasTriggerInsert;
        int HasTriggerUpdate;
        int HasTriggerDelete;
    } gaiaLayerAuth;

    typedef gaiaLayerAuth *gaiaLayerAuthPtr;

    typedef struct gaiaAttributeFieldMaxSizeInfos
    {
        int MaxSize;
    } gaiaAttributeFieldMaxSize;

    typedef gaiaAttributeFieldMaxSize *gaiaAttributeFieldMaxSizePtr;

    typedef struct gaiaAttributeFieldIntRangeInfos
    {
        sqlite3_int64 MinValue;
        sqlite3_int64 MaxValue;
    } gaiaAttributeFieldIntRange;

    typedef gaiaAttributeFieldIntRange *gaiaAttributeFieldIntRangePtr;

    typedef struct gaiaAttributeFieldDoubleRangeInfos
    {
        double MinValue;
        double MaxValue;
    } gaiaAttributeFieldDoubleRange;

    typedef gaiaAttributeFieldDoubleRange *gaiaAttributeFieldDoubleRangePtr;

    typedef struct gaiaLayerAttributeFieldInfos
    {
        int Ordinal;
        char *AttributeFieldName;
        int NullValuesCount;
        int IntegerValuesCount;
        int DoubleValuesCount;
        int TextValuesCount;
        int BlobValuesCount;
        gaiaAttributeFieldMaxSizePtr MaxSize;
        gaiaAttributeFieldIntRangePtr IntRange;
        gaiaAttributeFieldDoubleRangePtr DoubleRange;
        struct gaiaLayerAttributeFieldInfos *Next;
    } gaiaLayerAttributeField;

    typedef gaiaLayerAttributeField *gaiaLayerAttributeFieldPtr;

    typedef struct gaiaVectorLayerItem
    {
        int LayerType;
        char *TableName;
        char *GeometryName;
        int Srid;
        int GeometryType;
        int Dimensions;
        int SpatialIndex;
        gaiaLayerExtentPtr ExtentInfos;
        gaiaLayerAuthPtr AuthInfos;
        gaiaLayerAttributeFieldPtr First;
        gaiaLayerAttributeFieldPtr Last;
        struct gaiaVectorLayerItem *Next;
    } gaiaVectorLayer;

    typedef gaiaVectorLayer *gaiaVectorLayerPtr;

    typedef struct gaiaVectorLayersListStr
    {
        gaiaVectorLayerPtr First;
        gaiaVectorLayerPtr Last;
        gaiaVectorLayerPtr Current;
    } gaiaVectorLayersList;

    typedef gaiaVectorLayersList *gaiaVectorLayersListPtr;

    typedef struct gaiaProjAreaStr
    {
        double WestLongitude;
        double SouthLatitude;
        double EastLongitude;
        double NorthLatitude;
    } gaiaProjArea;

    typedef gaiaProjArea *gaiaProjAreaPtr;

#ifdef __cplusplus
}
#endif

#endif                          /* _GG_STRUCTS_H */