navit/navit/item.h

   1 /**
   2  * Navit, a modular navigation system.
   3  * Copyright (C) 2005-2008 Navit Team
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public License
   7  * version 2 as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this program; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20 #ifndef NAVIT_ITEM_H
  21 #define NAVIT_ITEM_H
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 #include <stdio.h>
  28
  29 enum item_type {
  30 #define ITEM2(x,y) type_##y=x,
  31 #define ITEM(x) type_##x,
  32 #include "item_def.h"
  33 #undef ITEM2
  34 #undef ITEM
  35 };
  36
  37 #define route_item_first type_street_0
  38 #define route_item_last type_path
  39 extern int default_flags[];
  40
  41 #include "attr.h"
  42
  43
  44 /* NOTE: we treat districts as towns for now, since
  45    a) navit does not implement district search yet
  46    b) OSM "place=suburb" maps to type_district in maptool. with the OSM USA maps,
  47       there are many "suburbs" that users will consider towns (not districts/counties);
  48       we want navit's town search to find them
  49 */
  50 #define item_type_is_area(type) ((type) >= type_area)
  51 #define item_is_town(item) ((item).type >= type_town_label && (item).type <= type_district_label_1e7)
  52 #define item_is_district(item) ((item).type >= type_district_label && (item).type <= type_district_label_1e7)
  53 #define item_is_poly_place(item) ((item).type >= type_poly_place1 && (item).type <= type_poly_place6)
  54 #define item_is_point(item) ((item).type < type_line)
  55 #define item_is_custom_poi(item) ((item).type >= type_poi_custom0 && (item).type < type_line)
  56 #define item_is_street(item) (((item).type >= type_street_0 && (item).type < type_street_1_land) \
  57                                ||  (item).type == type_street_pedestrian \
  58                                ||  (item).type == type_living_street  \
  59                                ||  (item).type == type_footway)
  60
  61 #define item_is_equal_id(a,b) ((a).id_hi == (b).id_hi && (a).id_lo == (b).id_lo)
  62 #define item_is_equal(a,b) (item_is_equal_id(a,b) && (a).map == (b).map)
  63
  64 struct coord;
  65
  66 enum change_mode {
  67         change_mode_delete,
  68         change_mode_modify,
  69         change_mode_append,
  70         change_mode_prepend,
  71 };
  72
  73 struct item_methods {
  74         void (*item_coord_rewind)(void *priv_data);
  75         int (*item_coord_get)(void *priv_data, struct coord *c, int count);
  76         void (*item_attr_rewind)(void *priv_data);
  77         int (*item_attr_get)(void *priv_data, enum attr_type attr_type, struct attr *attr);
  78         int (*item_coord_is_node)(void *priv_data);
  79         int (*item_attr_set)(void *priv_data, struct attr *attr, enum change_mode mode);
  80         int (*item_coord_set)(void *priv_data, struct coord *c, int count, enum change_mode mode);
  81         int (*item_type_set)(void *priv_data, enum item_type type);
  82 };
  83
  84 struct item_id {
  85         int id_hi;
  86         int id_lo;
  87 };
  88
  89 #define ITEM_ID_FMT "(0x%x,0x%x)"
  90 #define ITEM_ID_ARGS(x) (x).id_hi,(x).id_lo
  91
  92 struct item {
  93         enum item_type type;
  94         int id_hi;
  95         int id_lo;
  96         struct map *map;
  97         struct item_methods *meth;
  98         void *priv_data;
  99 };
 100
 101 extern struct item_range {
 102         enum item_type min,max;
 103 } item_range_all;
 104
 105 extern struct item busy_item;
 106
 107 /* prototypes */
 108 enum attr_type;
 109 enum change_mode;
 110 enum item_type;
 111 enum projection;
 112 struct attr;
 113 struct coord;
 114 struct item;
 115 struct item_hash;
 116 struct item_range;
 117 struct map;
 118 struct map_selection;
 119 void item_create_hash(void);
 120 void item_destroy_hash(void);
 121 int *item_get_default_flags(enum item_type type);
 122 void item_coord_rewind(struct item *it);
 123 int item_coord_get(struct item *it, struct coord *c, int count);
 124 int item_coord_set(struct item *it, struct coord *c, int count, enum change_mode mode);
 125 int item_coord_get_within_selection(struct item *it, struct coord *c, int count, struct map_selection *sel);
 126 int item_coord_get_pro(struct item *it, struct coord *c, int count, enum projection to);
 127 int item_coord_is_node(struct item *it);
 128 void item_attr_rewind(struct item *it);
 129 int item_attr_get(struct item *it, enum attr_type attr_type, struct attr *attr);
 130 int item_attr_set(struct item *it, struct attr *attr, enum change_mode mode);
 131 int item_type_set(struct item *it, enum item_type type);
 132 struct item *item_new(char *type, int zoom);
 133 enum item_type item_from_name(const char *name);
 134 char *item_to_name(enum item_type item);
 135 unsigned int item_id_hash(const void *key);
 136 int item_id_equal(const void *a, const void *b);
 137 struct item_hash *item_hash_new(void);
 138 void item_hash_insert(struct item_hash *h, struct item *item, void *val);
 139 int item_hash_remove(struct item_hash *h, struct item *item);
 140 void *item_hash_lookup(struct item_hash *h, struct item *item);
 141 void item_hash_destroy(struct item_hash *h);
 142 int item_range_intersects_range(struct item_range *range1, struct item_range *range2);
 143 int item_range_contains_item(struct item_range *range, enum item_type type);
 144 void item_dump_attr(struct item *item, struct map *map, FILE *out);
 145 void item_dump_filedesc(struct item *item, struct map *map, FILE *out);
 146 void item_cleanup(void);
 147
 148 /* end of prototypes */
 149
 150
 151 #ifdef __cplusplus
 152 }
 153 /* __cplusplus */
 154 #endif
 155
 156 /* NAVIT_ITEM_H */
 157 #endif