Fix:Core:Correct attribute alloc and free
[navit-package] / 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 osm2navit. 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_is_town(item) ((item).type >= type_town_label && (item).type <= type_district_label_1e7)
51 #define item_is_district(item) ((item).type >= type_district_label && (item).type <= type_district_label_1e7)
52 #define item_is_poly_place(item) ((item).type >= type_poly_place1 && (item).type <= type_poly_place6)
53
54 #define item_is_equal_id(a,b) ((a).id_hi == (b).id_hi && (a).id_lo == (b).id_lo)
55 #define item_is_equal(a,b) (item_is_equal_id(a,b) && (a).map == (b).map)
56
57 struct coord;
58
59 enum change_mode {
60         change_mode_delete,
61         change_mode_modify,
62         change_mode_append,
63         change_mode_prepend,
64 };
65
66 struct item_methods {
67         void (*item_coord_rewind)(void *priv_data);
68         int (*item_coord_get)(void *priv_data, struct coord *c, int count);
69         void (*item_attr_rewind)(void *priv_data);
70         int (*item_attr_get)(void *priv_data, enum attr_type attr_type, struct attr *attr);
71         int (*item_coord_is_node)(void *priv_data);
72         int (*item_attr_set)(void *priv_data, struct attr *attr, enum change_mode mode);
73         int (*item_coord_set)(void *priv_data, struct coord *c, int count, enum change_mode mode);
74         int (*item_type_set)(void *priv_data, enum item_type type);
75 };
76
77 struct item_id {
78         int id_hi;
79         int id_lo;
80 };
81
82 #define ITEM_ID_FMT "(0x%x,0x%x)"
83 #define ITEM_ID_ARGS(x) (x).id_hi,(x).id_lo
84
85 struct item {
86         enum item_type type;
87         int id_hi;
88         int id_lo;
89         struct map *map;
90         struct item_methods *meth;
91         void *priv_data;
92 };
93
94 extern struct item_range {
95         enum item_type min,max;
96 } item_range_all;
97
98 /* prototypes */
99 enum attr_type;
100 enum change_mode;
101 enum item_type;
102 enum projection;
103 struct attr;
104 struct coord;
105 struct item;
106 struct item_hash;
107 struct item_range;
108 struct map;
109 struct map_selection;
110 int *item_get_default_flags(enum item_type type);
111 void item_coord_rewind(struct item *it);
112 int item_coord_get(struct item *it, struct coord *c, int count);
113 int item_coord_set(struct item *it, struct coord *c, int count, enum change_mode mode);
114 int item_coord_get_within_selection(struct item *it, struct coord *c, int count, struct map_selection *sel);
115 int item_coord_get_pro(struct item *it, struct coord *c, int count, enum projection to);
116 int item_coord_is_node(struct item *it);
117 void item_attr_rewind(struct item *it);
118 int item_attr_get(struct item *it, enum attr_type attr_type, struct attr *attr);
119 int item_attr_set(struct item *it, struct attr *attr, enum change_mode mode);
120 struct item *item_new(char *type, int zoom);
121 enum item_type item_from_name(const char *name);
122 char *item_to_name(enum item_type item);
123 unsigned int item_id_hash(const void *key);
124 int item_id_equal(const void *a, const void *b);
125 struct item_hash *item_hash_new(void);
126 void item_hash_insert(struct item_hash *h, struct item *item, void *val);
127 int item_hash_remove(struct item_hash *h, struct item *item);
128 void *item_hash_lookup(struct item_hash *h, struct item *item);
129 void item_hash_destroy(struct item_hash *h);
130 int item_range_intersects_range(struct item_range *range1, struct item_range *range2);
131 int item_range_contains_item(struct item_range *range, enum item_type type);
132 void item_dump_attr(struct item *item, struct map *map, FILE *out);
133 void item_dump_filedesc(struct item *item, struct map *map, FILE *out);
134 /* end of prototypes */
135
136
137 #ifdef __cplusplus
138 }
139 /* __cplusplus */
140 #endif
141
142 /* NAVIT_ITEM_H */
143 #endif