osm.h

   1 /*
   2  *      Hic Est Leo -- Representation of OSM Data
   3  *
   4  *      (c) 2014 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 #ifndef _LEO_OSM_H
   8 #define _LEO_OSM_H
   9
  10 #include "dict.h"
  11
  12 typedef u64 osm_id_t;
  13 #define OSM_INVALID_ID ~(osm_id_t)0
  14
  15 typedef u32 osm_key_t, osm_val_t;
  16
  17 struct osm_object {
  18   cnode n;                      // In the per-type list
  19   byte type;                    // OSM_TYPE_xxx
  20   byte pad[3];
  21   osm_id_t id;
  22   clist tags;
  23   clist backrefs;               // Objects pointing to this one
  24 };
  25
  26 enum osm_object_type {
  27   OSM_TYPE_INVALID,
  28   OSM_TYPE_NODE,
  29   OSM_TYPE_WAY,
  30   OSM_TYPE_RELATION,
  31   OSM_TYPE_MULTIPOLYGON,
  32   // Remember to update osm_obj_type_names[], too
  33   OSM_TYPE_MAX,
  34 };
  35
  36 struct osm_tag {
  37   cnode n;                      // In object->tags
  38   osm_key_t key;
  39   osm_val_t val;
  40 };
  41
  42 struct osm_ref {
  43   cnode n;
  44   struct osm_object *o;
  45   osm_val_t role;
  46 };
  47
  48 struct osm_node {
  49   struct osm_object o;
  50   double x, y;
  51   /*
  52    * For WGS84 coordinates, x is longitude and y latitude.
  53    * For UTM, x is easting and y northing.
  54    * After map scaling, x is horizontal (left-to-right) and y vertical (top-to-bottom) on the paper.
  55    */
  56 };
  57
  58 struct osm_way {
  59   struct osm_object o;
  60   clist nodes;                  // List of osm_ref's
  61 };
  62
  63 struct osm_relation {
  64   struct osm_object o;
  65   clist members;                // List of osm_ref's
  66 };
  67
  68 struct osm_multipolygon {       // Virtual object constructed from multipolygon relations
  69   struct osm_object o;
  70   struct osm_relation *rel;     // Original relation
  71   clist boundaries;             // List of osm_mpg_boundary's
  72 };
  73
  74 struct osm_mpg_boundary {
  75   cnode n;
  76   bool inner;
  77   clist nodes;                  // List of osm_ref's (without back-references, since the boundary is not a regular object)
  78 };
  79
  80 struct osm {
  81   struct mempool *pool;
  82   clist obj_list[OSM_TYPE_MAX];
  83   struct osm_id_hash_table *id_hash[OSM_TYPE_MAX];
  84 };
  85
  86 extern struct osm *osm_this;
  87
  88 struct osm *osm_init(void);
  89 void osm_dump(void);
  90
  91 osm_id_t osm_parse_id(const char *str);
  92 struct osm_object *osm_obj_find_by_id(enum osm_object_type type, osm_id_t id);
  93 void osm_obj_add_tag(struct osm_object *o, const char *key, const char *val);
  94 void osm_obj_add_tag_raw(struct osm_object *o, osm_key_t key, osm_val_t val);
  95 osm_val_t osm_obj_find_tag(struct osm_object *o, osm_val_t key);
  96 void osm_obj_dump(struct osm_object *o);
  97 void osm_obj_warn(struct osm_object *o, const char *msg, ...);
  98 extern const char * const osm_obj_type_names[OSM_TYPE_MAX];
  99 #define STK_OSM_NAME(o) stk_printf("%s:%ju", osm_obj_type_names[(o)->type], (uintmax_t) (o)->id)
 100
 101 void osm_ref_add(struct osm_object *parent, clist *list, struct osm_object *son, osm_val_t role);
 102 #define OSM_FOR_EACH_BEGIN(_type, _var, _list) CLIST_FOR_EACH(struct osm_ref *, _ref, _list) { _type _var = (_type) _ref->o;
 103 #define OSM_FOR_EACH_END }
 104
 105 struct osm_node *osm_node_new(osm_id_t id);
 106 void osm_node_dump(struct osm_node *n);
 107 void osm_node_dump_all(void);
 108
 109 struct osm_way *osm_way_new(osm_id_t id);
 110 void osm_way_add_node(struct osm_way *w, struct osm_node *n);
 111 void osm_way_dump(struct osm_way *w);
 112 void osm_way_dump_all(void);
 113 bool osm_way_cyclic_p(struct osm_way *w);
 114
 115 struct osm_relation *osm_relation_new(osm_id_t id);
 116 void osm_relation_add_member(struct osm_relation *r, struct osm_object *o, const char *role);
 117 void osm_relation_dump(struct osm_relation *w);
 118 void osm_relation_dump_all(void);
 119
 120 void osm_multipolygon_dump(struct osm_multipolygon *w);
 121 void osm_multipolygon_dump_all(void);
 122 void osm_make_multipolygons(void);
 123
 124 void osm_project(const char *spec);
 125
 126 bool osm_obj_center(struct osm_object *o, double *xp, double *yp);
 127
 128 /* Tags */
 129
 130 extern struct dict osm_key_dict, osm_value_dict;
 131
 132 static inline osm_key_t osm_key_encode(const char *key)
 133 {
 134   return dict_encode(&osm_key_dict, key);
 135 }
 136
 137 static inline const char *osm_key_decode(osm_key_t key)
 138 {
 139   return dict_decode(&osm_key_dict, key);
 140 }
 141
 142 static inline osm_val_t osm_val_encode(const char *val)
 143 {
 144   return dict_encode(&osm_value_dict, val);
 145 }
 146
 147 static inline const char *osm_val_decode(osm_val_t key)
 148 {
 149   return dict_decode(&osm_value_dict, key);
 150 }
 151
 152 void osm_tag_dump(struct osm_tag *t);
 153
 154 /* Well-known tags and values */
 155
 156 enum tag_keys {
 157     KEY_NULL,
 158 #define P(x,y) KEY_##x,
 159 #include "dict-keys.h"
 160 #undef P
 161 };
 162
 163 enum value_names {
 164     VALUE_NULL,
 165 #define P(x,y) VALUE_##x,
 166 #include "dict-values.h"
 167 #undef P
 168 };
 169
 170 /* xml.c */
 171
 172 void osm_xml_parse(const char *name);
 173
 174 #endif