spatialite.h

Go to the documentation of this file.

/* 
 spatialite.h -- Gaia spatial support for SQLite 
  
 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 DOXYGEN_SHOULD_SKIP_THIS
#ifdef _WIN32
#ifdef DLL_EXPORT
#define SPATIALITE_DECLARE __declspec(dllexport)
#else
#define SPATIALITE_DECLARE extern
#endif
#else
#define SPATIALITE_DECLARE __attribute__ ((visibility("default")))
#endif
#endif

#ifndef _SPATIALITE_H
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define _SPATIALITE_H
#endif

#define SPLITE_AXIS_1           0x51
#define SPLITE_AXIS_2           0x52
#define SPLITE_AXIS_NAME        0x3e
#define SPLITE_AXIS_ORIENTATION 0x3f

#ifdef __cplusplus
extern "C"
{
#endif

#include <spatialite/gaiageo.h>

#ifdef LOADABLE_EXTENSION
    SPATIALITE_DECLARE int
        sqlite3_spatialite_init (sqlite3 * db, char **pzErrMsg,
                                 const sqlite3_api_routines * pApi);
#endif

    SPATIALITE_DECLARE void spatialite_initialize (void);

    SPATIALITE_DECLARE void spatialite_shutdown (void);

    SPATIALITE_DECLARE const char *spatialite_version (void);

    SPATIALITE_DECLARE const char *spatialite_target_cpu (void);

    SPATIALITE_DECLARE void *spatialite_alloc_connection (void);

    SPATIALITE_DECLARE void spatialite_set_silent_mode (const void *ptr);

    SPATIALITE_DECLARE void spatialite_set_verbode_mode (const void *ptr);

    SPATIALITE_DECLARE void spatialite_init (int verbose);

    SPATIALITE_DECLARE void spatialite_init_ex (sqlite3 * db_handle,
                                                const void *ptr, int verbose);

    SPATIALITE_DECLARE void spatialite_init_geos (void);

    SPATIALITE_DECLARE void spatialite_cleanup (void);

    SPATIALITE_DECLARE void spatialite_cleanup_ex (const void *ptr);

    SPATIALITE_DECLARE void spatialite_finalize_topologies (const void *ptr);

    SPATIALITE_DECLARE void enable_tiny_point (const void *ptr);

    SPATIALITE_DECLARE void disable_tiny_point (const void *ptr);

    SPATIALITE_DECLARE int is_tiny_point_enabled (const void *ptr);

    SPATIALITE_DECLARE int dump_shapefile (sqlite3 * sqlite, char *table,
                                           char *column, char *shp_path,
                                           char *charset, char *geom_type,
                                           int verbose, int *rows,
                                           char *err_msg);

    SPATIALITE_DECLARE int dump_shapefile_ex (sqlite3 * sqlite, char *table,
                                              char *column, char *shp_path,
                                              char *charset, char *geom_type,
                                              int verbose, int *rows,
                                              int colcase_name, char *err_msg);

    SPATIALITE_DECLARE int dump_shapefile_ex2 (sqlite3 * sqlite, void *proj_ctx,
                                               char *table, char *column,
                                               char *shp_path, char *charset,
                                               char *geom_type, int verbose,
                                               int *rows, int colcase_name,
                                               char *err_msg);

    SPATIALITE_DECLARE int load_shapefile (sqlite3 * sqlite, char *shp_path,
                                           char *table, char *charset, int srid,
                                           char *column, int coerce2d,
                                           int compressed, int verbose,
                                           int spatial_index, int *rows,
                                           char *err_msg);

    SPATIALITE_DECLARE int load_shapefile_ex (sqlite3 * sqlite, char *shp_path,
                                              char *table, char *charset,
                                              int srid, char *geo_column,
                                              char *gtype, char *pk_column,
                                              int coerce2d, int compressed,
                                              int verbose, int spatial_index,
                                              int *rows, char *err_msg);

    SPATIALITE_DECLARE int load_shapefile_ex2 (sqlite3 * sqlite, char *shp_path,
                                               char *table, char *charset,
                                               int srid, char *geo_column,
                                               char *gtype, char *pk_column,
                                               int coerce2d, int compressed,
                                               int verbose, int spatial_index,
                                               int text_date, int *rows,
                                               char *err_msg);

    SPATIALITE_DECLARE int load_shapefile_ex3 (sqlite3 * sqlite,
                                               const char *shp_path,
                                               const char *table,
                                               const char *charset, int srid,
                                               const char *geo_column,
                                               const char *gtype,
                                               const char *pk_column,
                                               int coerce2d, int compressed,
                                               int verbose, int spatial_index,
                                               int text_date, int *rows,
                                               int colname_case, char *err_msg);

    SPATIALITE_DECLARE int load_zip_shapefile (sqlite3 * sqlite,
                                               const char *zip_path,
                                               const char *shp_path,
                                               const char *table,
                                               const char *charset, int srid,
                                               const char *geo_column,
                                               const char *gtype,
                                               const char *pk_column,
                                               int coerce2d, int compressed,
                                               int verbose, int spatial_index,
                                               int text_date, int *rows,
                                               int colname_case, char *err_msg);

    SPATIALITE_DECLARE int load_dbf (sqlite3 * sqlite, char *dbf_path,
                                     char *table, char *charset, int verbose,
                                     int *rows, char *err_msg);

    SPATIALITE_DECLARE int load_dbf_ex (sqlite3 * sqlite, char *dbf_path,
                                        char *table, char *pk_column,
                                        char *charset, int verbose, int *rows,
                                        char *err_msg);

    SPATIALITE_DECLARE int load_dbf_ex2 (sqlite3 * sqlite, char *dbf_path,
                                         char *table, char *pk_column,
                                         char *charset, int verbose,
                                         int text_date, int *rows,
                                         char *err_msg);

    SPATIALITE_DECLARE int load_dbf_ex3 (sqlite3 * sqlite, const char *dbf_path,
                                         const char *table,
                                         const char *pk_column,
                                         const char *charset, int verbose,
                                         int text_date, int *rows,
                                         int colname_case, char *err_msg);

    SPATIALITE_DECLARE int load_zip_dbf (sqlite3 * sqlite, const char *zip_file,
                                         const char *dbf_path,
                                         const char *table,
                                         const char *pk_column,
                                         const char *charset, int verbose,
                                         int text_date, int *rows,
                                         int colname_case, char *err_msg);

    SPATIALITE_DECLARE int dump_dbf (sqlite3 * sqlite, char *table,
                                     char *dbf_path, char *charset,
                                     char *err_msg);

    SPATIALITE_DECLARE int dump_dbf_ex (sqlite3 * sqlite, char *table,
                                        char *dbf_path, char *charset,
                                        int *rows, char *err_msg);

    SPATIALITE_DECLARE int dump_dbf_ex2 (sqlite3 * sqlite, char *table,
                                         char *dbf_path, char *charset,
                                         int *rows, int colname_case,
                                         char *err_msg);

    SPATIALITE_DECLARE int load_XL (sqlite3 * sqlite, const char *path,
                                    const char *table,
                                    unsigned int worksheetIndex,
                                    int first_titles, unsigned int *rows,
                                    char *err_msg);

    SPATIALITE_DECLARE double math_round (double value);

    SPATIALITE_DECLARE sqlite3_int64 math_llabs (sqlite3_int64 value);

    SPATIALITE_DECLARE int spatial_ref_sys_init (sqlite3 * sqlite, int verbose);

    SPATIALITE_DECLARE int spatial_ref_sys_init2 (sqlite3 * sqlite, int mode,
                                                  int verbose);

    SPATIALITE_DECLARE int insert_epsg_srid (sqlite3 * sqlite, int srid);

    SPATIALITE_DECLARE int srid_is_geographic (sqlite3 * sqlite, int srid,
                                               int *geographic);

    SPATIALITE_DECLARE int srid_is_projected (sqlite3 * sqlite, int srid,
                                              int *projected);

    SPATIALITE_DECLARE int srid_has_flipped_axes (sqlite3 * sqlite, int srid,
                                                  int *flipped);

    SPATIALITE_DECLARE char *srid_get_spheroid (sqlite3 * sqlite, int srid);

    SPATIALITE_DECLARE char *srid_get_prime_meridian (sqlite3 * sqlite,
                                                      int srid);

    SPATIALITE_DECLARE char *srid_get_projection (sqlite3 * sqlite, int srid);

    SPATIALITE_DECLARE char *srid_get_datum (sqlite3 * sqlite, int srid);

    SPATIALITE_DECLARE char *srid_get_unit (sqlite3 * sqlite, int srid);

    SPATIALITE_DECLARE char *srid_get_axis (sqlite3 * sqlite, int srid,
                                            char axis, char mode);

    SPATIALITE_DECLARE int
        is_kml_constant (sqlite3 * sqlite, char *table, char *column);

    SPATIALITE_DECLARE int dump_kml (sqlite3 * sqlite, char *table,
                                     char *geom_col, char *kml_path,
                                     char *name_col, char *desc_col,
                                     int precision);

    SPATIALITE_DECLARE int dump_kml_ex (sqlite3 * sqlite, char *table,
                                        char *geom_col, char *kml_path,
                                        char *name_col, char *desc_col,
                                        int precision, int *rows);

    SPATIALITE_DECLARE void check_duplicated_rows (sqlite3 * sqlite,
                                                   char *table,
                                                   int *dupl_count);

    SPATIALITE_DECLARE void remove_duplicated_rows (sqlite3 * sqlite,
                                                    char *table);

    SPATIALITE_DECLARE void remove_duplicated_rows_ex (sqlite3 * sqlite,
                                                       char *table,
                                                       int *removed);

    SPATIALITE_DECLARE void remove_duplicated_rows_ex2 (sqlite3 * sqlite,
                                                        char *table,
                                                        int *removed,
                                                        int transaction);

    SPATIALITE_DECLARE void elementary_geometries (sqlite3 * sqlite,
                                                   char *inTable,
                                                   char *geometry,
                                                   char *outTable, char *pKey,
                                                   char *multiId);

    SPATIALITE_DECLARE void elementary_geometries_ex (sqlite3 * sqlite,
                                                      char *inTable,
                                                      char *geometry,
                                                      char *outTable,
                                                      char *pKey, char *multiId,
                                                      int *rows);

    SPATIALITE_DECLARE void elementary_geometries_ex2 (sqlite3 * sqlite,
                                                       char *inTable,
                                                       char *geometry,
                                                       char *outTable,
                                                       char *pKey,
                                                       char *multiId, int *rows,
                                                       int transaction);

    SPATIALITE_DECLARE void elementary_geometries_ex3 (sqlite3 * sqlite,
                                                       char *inTable,
                                                       char *geometry,
                                                       char *outTable,
                                                       char *pKey,
                                                       char *multiId,
                                                       const void *options,
                                                       int *rows,
                                                       int transaction);

    SPATIALITE_DECLARE int dump_geojson (sqlite3 * sqlite, char *table,
                                         char *geom_col, char *outfile_path,
                                         int precision, int option);

    SPATIALITE_DECLARE int dump_geojson_ex (sqlite3 * sqlite, char *table,
                                            char *geom_col, char *outfile_path,
                                            int precision, int option,
                                            int *rows);

    SPATIALITE_DECLARE int dump_geojson2 (sqlite3 * sqlite, char *table,
                                          char *geom_col, char *outfile_path,
                                          int precision, int lon_lat,
                                          int m_coords, int indented,
                                          int colname_case, int *rows,
                                          char **error_message);

    SPATIALITE_DECLARE int load_geojson (sqlite3 * sqlite, char *path,
                                         char *table, char *column,
                                         int spatial_index, int srid,
                                         int colname_case, int *rows,
                                         char **error_message);

    SPATIALITE_DECLARE int update_layer_statistics (sqlite3 * sqlite,
                                                    const char *table,
                                                    const char *column);

    SPATIALITE_DECLARE int gaiaStatisticsInvalidate (sqlite3 * handle,
                                                     const char *table,
                                                     const char *geometry);

    SPATIALITE_DECLARE gaiaGeomCollPtr gaiaGetLayerExtent (sqlite3 * handle,
                                                           const char *table,
                                                           const char *geometry,
                                                           int mode);

    SPATIALITE_DECLARE gaiaVectorLayersListPtr gaiaGetVectorLayersList (sqlite3
                                                                        *
                                                                        handle,
                                                                        const
                                                                        char
                                                                        *table,
                                                                        const
                                                                        char
                                                                        *geometry,
                                                                        int
                                                                        mode);

    SPATIALITE_DECLARE int gaiaCreateMetaCatalogTables (sqlite3 * handle);

    SPATIALITE_DECLARE int gaiaUpdateMetaCatalogStatistics (sqlite3 * handle,
                                                            const char *table,
                                                            const char *column);

    SPATIALITE_DECLARE int gaiaUpdateMetaCatalogStatisticsFromMaster (sqlite3 *
                                                                      handle,
                                                                      const char
                                                                      *master_table,
                                                                      const char
                                                                      *table_name,
                                                                      const char
                                                                      *column_name);

    SPATIALITE_DECLARE void gaiaFreeVectorLayersList (gaiaVectorLayersListPtr
                                                      ptr);

    SPATIALITE_DECLARE int gaiaDropTable (sqlite3 * sqlite, const char *table);

    SPATIALITE_DECLARE int gaiaDropTableEx (sqlite3 * sqlite,
                                            const char *prefix,
                                            const char *table);

    SPATIALITE_DECLARE int gaiaDropTableEx2 (sqlite3 * sqlite,
                                             const char *prefix,
                                             const char *table,
                                             int transaction);

    SPATIALITE_DECLARE int gaiaDropTableEx3 (sqlite3 * sqlite,
                                             const char *prefix,
                                             const char *table,
                                             int transaction,
                                             char **error_message);

    SPATIALITE_DECLARE int gaiaDropTable5 (sqlite3 * sqlite,
                                           const char *prefix,
                                           const char *table,
                                           char **error_message);

    SPATIALITE_DECLARE int gaiaRenameTable (sqlite3 * sqlite,
                                            const char *prefix,
                                            const char *old_name,
                                            const char *new_name,
                                            char **error_message);

    SPATIALITE_DECLARE int gaiaRenameColumn (sqlite3 * sqlite,
                                             const char *prefix,
                                             const char *table,
                                             const char *old_name,
                                             const char *new_name,
                                             char **error_message);

    SPATIALITE_DECLARE int check_geometry_column (sqlite3 * sqlite,
                                                  const char *table,
                                                  const char *geom,
                                                  const char *report_path,
                                                  int *n_rows, int *n_invalids,
                                                  char **err_msg);

    SPATIALITE_DECLARE int check_geometry_column_r (const void *p_cache,
                                                    sqlite3 * sqlite,
                                                    const char *table,
                                                    const char *geom,
                                                    const char *report_path,
                                                    int *n_rows,
                                                    int *n_invalids,
                                                    char **err_msg);

    SPATIALITE_DECLARE int check_all_geometry_columns (sqlite3 * sqlite,
                                                       const char *output_dir,
                                                       int *n_invalids,
                                                       char **err_msg);

    SPATIALITE_DECLARE int check_all_geometry_columns_r (const void *p_cache,
                                                         sqlite3 * sqlite,
                                                         const char *output_dir,
                                                         int *n_invalids,
                                                         char **err_msg);

    SPATIALITE_DECLARE int sanitize_geometry_column (sqlite3 * sqlite,
                                                     const char *table,
                                                     const char *geom,
                                                     const char *tmp_table,
                                                     const char *report_path,
                                                     int *n_invalids,
                                                     int *n_repaired,
                                                     int *n_discarded,
                                                     int *n_failures,
                                                     char **err_msg);

    SPATIALITE_DECLARE int sanitize_geometry_column_r (const void *p_cache,
                                                       sqlite3 * sqlite,
                                                       const char *table,
                                                       const char *geom,
                                                       const char *tmp_table,
                                                       const char *report_path,
                                                       int *n_invalids,
                                                       int *n_repaired,
                                                       int *n_discarded,
                                                       int *n_failures,
                                                       char **err_msg);

    SPATIALITE_DECLARE int sanitize_all_geometry_columns (sqlite3 * sqlite,
                                                          const char
                                                          *tmp_prefix,
                                                          const char
                                                          *output_dir,
                                                          int *not_repaired,
                                                          char **err_msg);

    SPATIALITE_DECLARE int sanitize_all_geometry_columns_r (const void *p_cache,
                                                            sqlite3 * sqlite,
                                                            const char
                                                            *tmp_prefix,
                                                            const char
                                                            *output_dir,
                                                            int *not_repaired,
                                                            char **err_msg);

    SPATIALITE_DECLARE int gaiaCutter (sqlite3 * db_handle, const void *cache,
                                       const char *in_db_prefix,
                                       const char *input_table,
                                       const char *input_geom,
                                       const char *blade_db_prefix,
                                       const char *blade_table,
                                       const char *blade_geom,
                                       const char *output_table,
                                       int transaction, int ram_tmp_store,
                                       char **message);

    SPATIALITE_DECLARE int gaia_create_routing_nodes (sqlite3 * db_handle,
                                                      const void *cache,
                                                      const char *prefix,
                                                      const char *table,
                                                      const char *geom_column,
                                                      const char *from_column,
                                                      const char *to_column);

    SPATIALITE_DECLARE int gaia_create_routing (sqlite3 * db_handle,
                                                const void *cache,
                                                const char *routing_data_table,
                                                const char
                                                *virtual_routing_table,
                                                const char *input_table,
                                                const char *from_column,
                                                const char *to_column,
                                                const char *geom_column,
                                                const char *cost_column,
                                                const char *name_column,
                                                int a_star_enabled,
                                                int bidirectional,
                                                const char *oneway_from,
                                                const char *oneway_to,
                                                int overwrite);

    SPATIALITE_DECLARE gaiaGeomCollPtr gaiaGetRTreeFullExtent (sqlite3 *
                                                               db_handle,
                                                               const char
                                                               *db_prefix,
                                                               const char *name,
                                                               int srid);

    SPATIALITE_DECLARE gaiaGeomCollPtr gaiaGetGpkgRTreeFullExtent (sqlite3 *
                                                                   db_handle,
                                                                   const char
                                                                   *db_prefix,
                                                                   const char
                                                                   *name,
                                                                   int srid);

    SPATIALITE_DECLARE const char *gaia_create_routing_get_last_error (const
                                                                       void
                                                                       *cache);

    SPATIALITE_DECLARE int gaiaGPKG2Spatialite (sqlite3 * handle_in,
                                                const char *gpkg_in_path,
                                                sqlite3 * handle_out,
                                                const char *splite_out_path);

    SPATIALITE_DECLARE int gaiaSpatialite2GPKG (sqlite3 * handle_in,
                                                const char *splite_in_path,
                                                sqlite3 * handle_out,
                                                const char *gpkg_out_path);

    SPATIALITE_DECLARE const void *gaiaGetCurrentProjContext (const void
                                                              *cache);

    SPATIALITE_DECLARE int gaiaSetCurrentCachedProj (const void
                                                     *cache, void *pj,
                                                     const char *proj_string_1,
                                                     const char *proj_string_2,
                                                     void *area);

    SPATIALITE_DECLARE void *gaiaGetCurrentCachedProj (const void *cache);

    SPATIALITE_DECLARE int gaiaCurrentCachedProjMatches (const void *cache,
                                                         const char
                                                         *proj_string_1,
                                                         const char
                                                         *proj_string_2,
                                                         void *area);

    SPATIALITE_DECLARE char *gaiaGetDbObjectScope (sqlite3 * handle,
                                                   const char *db_prefix,
                                                   const char *obj_name);

#ifdef __cplusplus
}
#endif

#endif                          /* _SPATIALITE_H */