src/headers/spatialite/gaiaaux.h

Go to the documentation of this file.

/* 
 gaiaaux.h -- Gaia common utility functions
  
 version 4.3, 2015 June 29

 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-2015
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 DLL_EXPORT
#define GAIAAUX_DECLARE __declspec(dllexport)
#else
#define GAIAAUX_DECLARE extern
#endif
#endif

#ifndef _GAIAAUX_H
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define _GAIAAUX_H
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/* constants */
#define GAIA_SQL_SINGLE_QUOTE   1001

#define GAIA_SQL_DOUBLE_QUOTE   1002

/* function prototypes */

    GAIAAUX_DECLARE const char *gaiaGetLocaleCharset (void);

    GAIAAUX_DECLARE int gaiaConvertCharset (char **buf, const char *fromCs,
                                            const char *toCs);

    GAIAAUX_DECLARE void *gaiaCreateUTF8Converter (const char *fromCS);

    GAIAAUX_DECLARE void gaiaFreeUTF8Converter (void *cvtCS);

    GAIAAUX_DECLARE char *gaiaConvertToUTF8 (void *cvtCS, const char *buf,
                                             int len, int *err);

    GAIAAUX_DECLARE int gaiaIsReservedSqliteName (const char *name);

    GAIAAUX_DECLARE int gaiaIsReservedSqlName (const char *name);

    GAIAAUX_DECLARE int gaiaIllegalSqlName (const char *name);

    GAIAAUX_DECLARE char *gaiaSingleQuotedSql (const char *value);

    GAIAAUX_DECLARE char *gaiaDoubleQuotedSql (const char *value);

    GAIAAUX_DECLARE char *gaiaQuotedSql (const char *value, int quote);

    GAIAAUX_DECLARE char *gaiaDequotedSql (const char *value);

/*
/ DEPRECATED FUNCTION: gaiaCleanSqlString()
/ this function must not be used for any new project
/ it's still maintained for backward compatibility,
/ but will be probably removed in future versions
*/

    GAIAAUX_DECLARE void gaiaCleanSqlString (char *value);

    GAIAAUX_DECLARE void gaiaInsertIntoSqlLog (sqlite3 * sqlite,
                                               const char *user_agent,
                                               const char *utf8Sql,
                                               sqlite3_int64 * sqllog_pk);

    GAIAAUX_DECLARE void gaiaUpdateSqlLog (sqlite3 * sqlite,
                                           sqlite3_int64 sqllog_pk, int success,
                                           const char *errMsg);

    GAIAAUX_DECLARE void *gaiaCreateMD5Checksum (void);

    GAIAAUX_DECLARE void gaiaFreeMD5Checksum (void *md5);

    GAIAAUX_DECLARE void gaiaUpdateMD5Checksum (void *md5,
                                                const unsigned char *blob,
                                                int blob_len);

    GAIAAUX_DECLARE char *gaiaFinalizeMD5Checksum (void *md5);

    GAIAAUX_DECLARE int gaiaParseDMS (const char *dms, double *longitude,
                                      double *latitude);

    GAIAAUX_DECLARE char *gaiaConvertToDMS (double longitude, double latitude);

    GAIAAUX_DECLARE char *gaiaEncodeURL (const char *url);

    GAIAAUX_DECLARE char *gaiaDecodeURL (const char *encoded);

    GAIAAUX_DECLARE char *gaiaDirNameFromPath (const char *path);

    GAIAAUX_DECLARE char *gaiaFullFileNameFromPath (const char *path);

    GAIAAUX_DECLARE char *gaiaFileNameFromPath (const char *path);

    GAIAAUX_DECLARE char *gaiaFileExtFromPath (const char *path);

#ifdef __cplusplus
}
#endif

#endif                          /* _GAIAAUX_H */