2 * Navit, a modular navigation system.
3 * Copyright (C) 2005-2008 Navit Team
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * version 2 as published by the Free Software Foundation.
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 General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * 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.
22 * @brief Contains code used for loading more than one map
24 * The code in this file introduces "mapsets", which are collections of several maps.
25 * This enables navit to operate on more than one map at once. See map.c / map.h to learn
26 * how maps are handled.
31 #include <glib/gprintf.h>
35 #include "projection.h"
41 * This structure holds a complete mapset
44 GList *maps; /**< Linked list of all the maps in the mapset */
52 * @brief Creates a new, empty mapset
54 * @return The new mapset
56 struct mapset *mapset_new(struct attr *parent, struct attr **attrs)
60 ms=g_new0(struct mapset, 1);
67 mapset_attr_iter_new(void)
69 return g_new0(struct attr_iter, 1);
73 mapset_attr_iter_destroy(struct attr_iter *iter)
79 * @brief Adds a map to a mapset
81 * @param ms The mapset to add the map to
82 * @param m The map to be added
85 mapset_add_attr(struct mapset *ms, struct attr *attr)
89 ms->maps=g_list_append(ms->maps, attr->u.map);
97 mapset_get_attr(struct mapset *ms, enum attr_type type, struct attr *attr, struct attr_iter *iter)
105 if (!iter || iter->last == g_list_previous(map)) {
106 attr->u.map=map->data;
111 map=g_list_next(map);
122 static void mapset_maps_free(struct mapset *ms)
129 * @brief Destroys a mapset.
131 * This destroys a mapset. Please note that it does not touch the contained maps
134 * @param ms The mapset to be destroyed
136 void mapset_destroy(struct mapset *ms)
142 * @brief Handle for a mapset in use
144 * This struct is used for a mapset that is in use. With this it is possible to iterate
145 * all maps in a mapset.
147 struct mapset_handle {
148 GList *l; /**< Pointer to the current (next) map */
152 * @brief Returns a new handle for a mapset
154 * This returns a new handle for an existing mapset. The new handle points to the first
157 * @param ms The mapset to get a handle of
158 * @return The new mapset handle
160 struct mapset_handle *
161 mapset_open(struct mapset *ms)
163 struct mapset_handle *ret=NULL;
166 ret=g_new(struct mapset_handle, 1);
174 * @brief Gets the next map from a mapset handle
176 * If you set active to true, this function will not return any maps that
177 * have the attr_active attribute associated with them and set to false.
179 * @param msh The mapset handle to get the next map of
180 * @param active Set to true to only get active maps (See description)
181 * @return The next map
183 struct map * mapset_next(struct mapset_handle *msh, int active)
186 struct attr active_attr;
192 msh->l=g_list_next(msh->l);
195 if (!map_get_attr(ret, attr_active, &active_attr, NULL))
197 if (active_attr.u.num)
203 * @brief Closes a mapset handle after it is no longer used
205 * @param msh Mapset handle to be closed
208 mapset_close(struct mapset_handle *msh)
214 * @brief Holds information about a search in a mapset
216 * This struct holds information about a search (e.g. for a street) in a mapset.
218 * @sa For a more detailed description see the documentation of mapset_search_new().
220 struct mapset_search {
221 GList *map; /**< The list of maps to be searched within */
222 struct map_search *ms; /**< A map search struct for the map currently active */
223 struct item *item; /**< "Superior" item. */
224 struct attr *search_attr; /**< Attribute to be searched for. */
225 int partial; /**< Indicates if one would like to have partial matches */
229 * @brief Starts a search on a mapset
231 * This function starts a search on a mapset. What attributes one can search for depends on the
232 * map plugin. See the description of map_search_new() in map.c for details.
234 * If you enable partial matches bear in mind that the search matches only the begin of the
235 * strings - a search for a street named "street" would match to "streetfoo", but not to
236 * "somestreet". Search is case insensitive.
238 * The item passed to this function specifies a "superior item" to "search within" - e.g. a town
239 * in which we want to search for a street, or a country in which to search for a town.
241 * @param ms The mapset that should be searched
242 * @param item Specifies a superior item to "search within" (see description)
243 * @param search_attr Attribute specifying what to search for. See description.
244 * @param partial Set this to true to also have partial matches. See description.
245 * @return A new mapset search struct for this search
247 struct mapset_search *
248 mapset_search_new(struct mapset *ms, struct item *item, struct attr *search_attr, int partial)
250 struct mapset_search *this;
251 dbg(1,"enter(%p,%p,%p,%d)\n", ms, item, search_attr, partial);
252 this=g_new0(struct mapset_search,1);
253 if(this != NULL && ms!=NULL )
257 this->search_attr=search_attr;
258 this->partial=partial;
259 this->ms=map_search_new(this->map->data, item, search_attr, partial);
269 * @brief Returns the next found item from a mapset search
271 * This function returns the next item from a mapset search or NULL if there are no more items found.
272 * It automatically iterates through all the maps in the mapset. Please note that maps which have the
273 * attr_active attribute associated with them and set to false are not searched.
275 * @param this The mapset search to return an item from
276 * @return The next found item or NULL if there are no more items found
279 mapset_search_get_item(struct mapset_search *this)
281 struct item *ret=NULL;
282 struct attr active_attr;
284 while ((this) && (!this->ms || !(ret=map_search_get_item(this->ms)))) { /* The current map has no more items to be returned */
285 if (this->search_attr->type >= attr_country_all && this->search_attr->type <= attr_country_name)
288 this->map=g_list_next(this->map);
291 if (!map_get_attr(this->map->data, attr_active, &active_attr, NULL))
293 if (active_attr.u.num)
298 map_search_destroy(this->ms);
299 this->ms=map_search_new(this->map->data, this->item, this->search_attr, this->partial);
305 * @brief Destroys a mapset search
307 * @param this The mapset search to be destroyed
310 mapset_search_destroy(struct mapset_search *this)
313 map_search_destroy(this->ms);