src/zonedetect.h

   1 /*
   2  * Copyright (c) 2018, Bertold Van den Bergh (vandenbergh@bertold.org)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the author nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR DISTRIBUTOR BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <stdint.h>
  29
  30 #ifndef _ZONEDETECT_H_
  31 #define _ZONEDETECT_H_
  32
  33 typedef enum {
  34     ZD_LOOKUP_IGNORE = -3,
  35     ZD_LOOKUP_END = -2,
  36     ZD_LOOKUP_PARSE_ERROR = -1,
  37     ZD_LOOKUP_NOT_IN_ZONE = 0,
  38     ZD_LOOKUP_IN_ZONE = 1,
  39     ZD_LOOKUP_IN_EXCLUDED_ZONE = 2,
  40     ZD_LOOKUP_ON_BORDER_VERTEX = 3,
  41     ZD_LOOKUP_ON_BORDER_SEGMENT = 4
  42 } ZDLookupResult;
  43
  44 typedef struct {
  45     ZDLookupResult lookupResult;
  46
  47     uint32_t metaId;
  48     uint8_t numFields;
  49     char** fieldNames;
  50     char** data;
  51 } ZoneDetectResult;
  52
  53 struct ZoneDetectOpaque;
  54 typedef struct ZoneDetectOpaque ZoneDetect;
  55
  56 #ifdef __cplusplus
  57 extern "C" {
  58 #endif
  59
  60 ZoneDetect* ZDOpenDatabase(const char* path);
  61 void        ZDCloseDatabase(ZoneDetect* library);
  62
  63 ZoneDetectResult* ZDLookup(ZoneDetect* library, float lat, float lon, float* safezone);
  64 void              ZDFreeResults(ZoneDetectResult* results);
  65
  66 const char* ZDGetNotice(ZoneDetect* library);
  67 uint8_t     ZDGetTableType(ZoneDetect* library);
  68 const char* ZDLookupResultToString(ZDLookupResult result);
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif
  73
  74 #endif