libpostal-sys 0.1.1

Low-level wrappers for libpostal address normalization (with locks to support thread-safe initialization)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

#ifndef GEONAMES_H
#define GEONAMES_H

 

#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>

#include "collections.h"
#include "features.h"
#include "string_utils.h"

typedef enum {
    GEONAMES_COUNTRY = 0,
    GEONAMES_ADMIN1 = 1,
    GEONAMES_ADMIN2 = 2,
    GEONAMES_ADMIN3 = 3,
    GEONAMES_ADMIN4 = 4,
    GEONAMES_ADMIN_OTHER = 5,
    GEONAMES_LOCALITY = 6,
    GEONAMES_NEIGHBORHOOD = 7,
    NUM_BOUNDARY_TYPES
} boundary_type_t;

#define GEONAMES_ADDRESS_COMPONENT_COUNTRY (1 << 0)
#define GEONAMES_ADDRESS_COMPONENT_ADMIN1 (1 << 1)
#define GEONAMES_ADDRESS_COMPONENT_ADMIN2 (1 << 2)
#define GEONAMES_ADDRESS_COMPONENT_ADMIN3 (1 << 3)
#define GEONAMES_ADDRESS_COMPONENT_ADMIN4 (1 << 4)
#define GEONAMES_ADDRESS_COMPONENT_ADMIN_OTHER (1 << 5)
#define GEONAMES_ADDRESS_COMPONENT_LOCALITY (1 << 6)
#define GEONAMES_ADDRESS_COMPONENT_NEIGHBORHOOD (1 << 7)
#define GEONAMES_ADDRESS_COMPONENT_POSTCODE (1 << 8)

typedef struct geoname {
    uint32_t geonames_id;
    char_array *name;
    char_array *canonical;
    boundary_type_t type;
    char_array *iso_language;
    bool has_wikipedia_entry;
    bool is_preferred_name;
    bool is_short_name;
    bool is_colloquial;
    bool is_historical;
    uint32_t population;
    double latitude;
    double longitude;
    char_array *feature_code;
    char_array *country_code;
    uint32_t country_geonames_id;
    char_array *admin1_code;
    uint32_t admin1_geonames_id;
    char_array *admin2_code;
    uint32_t admin2_geonames_id;
    char_array *admin3_code;
    uint32_t admin3_geonames_id;
    char_array *admin4_code;
    uint32_t admin4_geonames_id;
} geoname_t;

/* We want to reuse objects here, so only call
 * geoname_create once or twice and populate the same
 * object repeatedly with geoname_deserialize.
 * This helps avoid making too many malloc/free calls
*/
geoname_t *geoname_new(void);
bool geoname_deserialize(geoname_t *self, char_array *str);
bool geoname_serialize(geoname_t *self, char_array *str);
void geoname_print(geoname_t *self);
void geoname_clear(geoname_t *self);
void geoname_destroy(geoname_t *self);

typedef struct gn_postal_code {
    char_array *postal_code;
    char_array *country_code;
    uint32_t country_geonames_id;
    bool have_lat_lon;
    double latitude;
    double longitude;
    uint8_t accuracy;
    bool have_containing_geoname;
    char_array *containing_geoname;
    uint32_t containing_geonames_id;
    uint32_array *admin1_ids;
    uint32_array *admin2_ids;
    uint32_array *admin3_ids;
} gn_postal_code_t;

gn_postal_code_t *gn_postal_code_new(void);
bool gn_postal_code_deserialize(gn_postal_code_t *self, char_array *str);
bool gn_postal_code_serialize(gn_postal_code_t *self, char_array *str);
void gn_postal_code_print(gn_postal_code_t *self);
void gn_postal_code_clear(gn_postal_code_t *self);
void gn_postal_code_destroy(gn_postal_code_t *self);

typedef enum {
    GEONAMES_PLACE, 
    GEONAMES_POSTAL_CODE 
} gn_type;

typedef struct geonames_generic {
    gn_type type;
    union {
        geoname_t *geoname;
        gn_postal_code_t *postal_code;
    };
} geonames_generic_t;

VECTOR_INIT(gn_generic_array, geonames_generic_t);

bool geonames_generic_serialize(geonames_generic_t *gn, char_array *str);
bool geonames_generic_deserialize(gn_type *type, geoname_t *geoname, gn_postal_code_t *postal_code, char_array *str);

 

#endif