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.
21 * @brief Contains code related to finding a route from a position to a destination
23 * Routing uses segments, points and items. Items are items from the map: Streets, highways, etc.
24 * Segments represent such items, or parts of it. Generally, a segment is a driveable path. An item
25 * can be represented by more than one segment - in that case it is "segmented". Each segment has an
26 * "offset" associated, that indicates at which position in a segmented item this segment is - a
27 * segment representing a not-segmented item always has the offset 1.
28 * A point is located at the end of segments, often connecting several segments.
30 * The code in this file will make navit find a route between a position and a destination.
31 * It accomplishes this by first building a "route graph". This graph contains segments and
34 * After building this graph in route_graph_build(), the function route_graph_flood() assigns every
35 * point and segment a "value" which represents the "costs" of traveling from this point to the
36 * destination. This is done by Dijkstra's algorithm.
38 * When the graph is built a "route path" is created, which is a path in this graph from a given
39 * position to the destination determined at time of building the graph.
56 #include "projection.h"
64 #include "transform.h"
78 * @brief A point in the route graph
80 * This represents a point in the route graph. A point usually connects two or more segments,
81 * but there are also points which don't do that (e.g. at the end of a dead-end).
83 struct route_graph_point {
84 struct route_graph_point *next; /**< Linked-list pointer to a list of all route_graph_points */
85 struct route_graph_point *hash_next; /**< Pointer to a chained hashlist of all route_graph_points with this hash */
86 struct route_graph_segment *start; /**< Pointer to a list of segments of which this point is the start. The links
87 * of this linked-list are in route_graph_segment->start_next.*/
88 struct route_graph_segment *end; /**< Pointer to a list of segments of which this pointer is the end. The links
89 * of this linked-list are in route_graph_segment->end_next. */
90 struct route_graph_segment *seg; /**< Pointer to the segment one should use to reach the destination at
92 struct fibheap_el *el; /**< When this point is put on a Fibonacci heap, this is a pointer
93 * to this point's heap-element */
94 int value; /**< The cost at which one can reach the destination from this point on */
95 struct coord c; /**< Coordinates of this point */
99 * @brief A segment in the route graph
101 * This is a segment in the route graph. A segment represents a driveable way.
103 struct route_graph_segment {
104 struct route_graph_segment *next; /**< Linked-list pointer to a list of all route_graph_segments */
105 struct route_graph_segment *start_next; /**< Pointer to the next element in the list of segments that start at the
106 * same point. Start of this list is in route_graph_point->start. */
107 struct route_graph_segment *end_next; /**< Pointer to the next element in the list of segments that end at the
108 * same point. Start of this list is in route_graph_point->end. */
109 struct route_graph_point *start; /**< Pointer to the point this segment starts at. */
110 struct route_graph_point *end; /**< Pointer to the point this segment ends at. */
111 struct item item; /**< The item (e.g. street) that this segment represents. */
113 int len; /**< Length of this segment */
114 int offset; /**< If the item represented by this segment is "segmented" (i.e.
115 * is represented by several segments instead of just one), this
116 * indicates the position of this segment in the item - for items
117 * that are not segmented this should always be 1 */
121 * @brief A segment in the route path
123 * This is a segment in the route path.
125 struct route_path_segment {
126 struct route_path_segment *next; /**< Pointer to the next segment in the path */
127 struct item item; /**< The item (e.g. street) this segment represents */
128 int length; /**< Length of the segment */
129 int offset; /**< Same as in route_graph_segment->offset */
130 int direction; /**< Order in which the coordinates are ordered. >0 means "First
131 * coordinate of the segment is the first coordinate of the item", <=0
133 unsigned ncoords; /**< How many coordinates does this segment have? */
134 struct coord c[0]; /**< Pointer to the ncoords coordinates of this segment */
135 /* WARNING: There will be coordinates following here, so do not create new fields after c! */
139 * @brief Usually represents a destination or position
141 * This struct usually represents a destination or position
144 struct coord c; /**< The actual destination / position */
145 struct coord lp; /**< The nearest point on a street to c */
146 int pos; /**< The position of lp within the coords of the street */
147 int lenpos; /**< Distance between lp and the end of the street */
148 int lenneg; /**< Distance between lp and the start of the street */
149 int lenextra; /**< Distance between lp and c */
151 struct street_data *street; /**< The street lp is on */
155 * @brief A complete route path
157 * This structure describes a whole routing path
160 int updated; /**< The path has only been updated */
161 struct route_path_segment *path; /**< The first segment in the path, i.e. the segment one should
163 struct route_path_segment *path_last; /**< The last segment in the path */
164 /* XXX: path_hash is not necessery now */
165 struct item_hash *path_hash; /**< A hashtable of all the items represented by this route's segements */
168 #define RF_FASTEST (1<<0)
169 #define RF_SHORTEST (1<<1)
170 #define RF_AVOIDHW (1<<2)
171 #define RF_AVOIDPAID (1<<3)
172 #define RF_LOCKONROAD (1<<4)
173 #define RF_SHOWGRAPH (1<<5)
176 * @brief A complete route
178 * This struct holds all information about a route.
181 struct mapset *ms; /**< The mapset this route is built upon */
183 struct route_info *pos; /**< Current position within this route */
184 struct route_info *dst; /**< Destination of the route */
186 struct route_graph *graph; /**< Pointer to the route graph */
187 struct route_path *path2; /**< Pointer to the route path */
189 struct map *graph_map;
190 struct callback * route_graph_done_cb ; /**< Callback when route graph is done */
191 struct callback * route_graph_flood_done_cb ; /**< Callback when route graph flooding is done */
192 struct callback_list *cbl; /**< Callback list to call when route changes */
193 int destination_distance; /**< Distance to the destination at which the destination is considered "reached" */
194 int speedlist[route_item_last-route_item_first+1]; /**< The speedlist for this route */
198 * @brief A complete route graph
200 * This structure describes a whole routing graph
203 int busy; /**< The graph is being built */
204 struct map_selection *sel; /**< The rectangle selection for the graph */
205 struct mapset_handle *h; /**< Handle to the mapset */
206 struct map *m; /**< Pointer to the currently active map */
207 struct map_rect *mr; /**< Pointer to the currently active map rectangle */
208 struct callback *idle_cb; /**< Idle callback to process the graph */
209 struct callback *done_cb; /**< Callback when graph is done */
210 struct event_idle *idle_ev; /**< The pointer to the idle event */
211 struct route_graph_point *route_points; /**< Pointer to the first route_graph_point in the linked list of all points */
212 struct route_graph_segment *route_segments; /**< Pointer to the first route_graph_segment in the linked list of all segments */
213 #define HASH_SIZE 8192
214 struct route_graph_point *hash[HASH_SIZE]; /**< A hashtable containing all route_graph_points in this graph */
217 #define HASHCOORD(c) ((((c)->x +(c)->y) * 2654435761UL) & (HASH_SIZE-1))
220 * @brief Iterator to iterate through all route graph segments in a route graph point
222 * This structure can be used to iterate through all route graph segments connected to a
223 * route graph point. Use this with the rp_iterator_* functions.
225 struct route_graph_point_iterator {
226 struct route_graph_point *p; /**< The route graph point whose segments should be iterated */
227 int end; /**< Indicates if we have finished iterating through the "start" segments */
228 struct route_graph_segment *next; /**< The next segment to be returned */
231 static struct route_info * route_find_nearest_street(struct mapset *ms, struct pcoord *c);
232 static struct route_graph_point *route_graph_get_point(struct route_graph *this, struct coord *c);
233 static void route_graph_update(struct route *this, struct callback *cb);
234 static void route_graph_build_done(struct route_graph *rg, int cancel);
235 static struct route_path *route_path_new(struct route_graph *this, struct route_path *oldpath, struct route_info *pos, struct route_info *dst, int *speedlist);
236 static void route_process_street_graph(struct route_graph *this, struct item *item);
237 static void route_graph_destroy(struct route_graph *this);
238 static void route_path_update(struct route *this, int cancel);
241 * @brief Returns the projection used for this route
243 * @param route The route to return the projection for
244 * @return The projection used for this route
246 static enum projection route_projection(struct route *route)
248 struct street_data *street;
249 street = route->pos ? route->pos->street : route->dst->street;
250 return map_projection(street->item.map);
254 * @brief Creates a new graph point iterator
256 * This function creates a new route graph point iterator, that can be used to
257 * iterate through all segments connected to the point.
259 * @param p The route graph point to create the iterator from
260 * @return A new iterator.
262 static struct route_graph_point_iterator
263 rp_iterator_new(struct route_graph_point *p)
265 struct route_graph_point_iterator it;
280 * @brief Gets the next segment connected to a route graph point from an iterator
282 * @param it The route graph point iterator to get the segment from
283 * @return The next segment or NULL if there are no more segments
285 static struct route_graph_segment
286 *rp_iterator_next(struct route_graph_point_iterator *it)
288 struct route_graph_segment *ret;
296 if (ret->start_next) {
297 it->next = ret->start_next;
299 it->next = it->p->end;
303 it->next = ret->end_next;
310 * @brief Checks if the last segment returned from a route_graph_point_iterator comes from the end
312 * @param it The route graph point iterator to be checked
313 * @return 1 if the last segment returned comes from the end of the route graph point, 0 otherwise
316 rp_iterator_end(struct route_graph_point_iterator *it) {
317 if (it->end && (it->next != it->p->end)) {
325 * @brief Destroys a route_path
327 * @param this The route_path to be destroyed
330 route_path_destroy(struct route_path *this)
332 struct route_path_segment *c,*n;
335 if (this->path_hash) {
336 item_hash_destroy(this->path_hash);
337 this->path_hash=NULL;
349 * @brief Creates a completely new route structure
351 * @param attrs Not used
352 * @return The newly created route
355 route_new(struct attr *parent, struct attr **attrs)
357 struct route *this=g_new0(struct route, 1);
358 struct attr dest_attr;
360 if (attr_generic_get_attr(attrs, NULL, attr_destination_distance, &dest_attr, NULL)) {
361 this->destination_distance = dest_attr.u.num;
363 this->destination_distance = 50; // Default value
365 this->cbl=callback_list_new();
371 * @brief Checks if a segment is part of a roundabout
373 * This function checks if a segment is part of a roundabout.
375 * @param seg The segment to be checked
376 * @param level How deep to scan the route graph
377 * @param direction Set this to 1 if we're entering the segment through its end, to 0 otherwise
378 * @param origin Used internally, set to NULL
379 * @return 1 If a roundabout was detected, 0 otherwise
382 route_check_roundabout(struct route_graph_segment *seg, int level, int direction, struct route_graph_segment *origin)
384 struct route_graph_point_iterator it,it2;
385 struct route_graph_segment *cur;
391 if (!direction && !(seg->flags & AF_ONEWAY)) {
394 if (direction && !(seg->flags & AF_ONEWAYREV)) {
403 it = rp_iterator_new(seg->end);
405 it = rp_iterator_new(seg->start);
409 while ((cur = rp_iterator_next(&it2)))
414 cur = rp_iterator_next(&it);
417 cur = rp_iterator_next(&it);
422 seg->flags |= AF_ROUNDABOUT;
426 if (route_check_roundabout(cur, (level-1), rp_iterator_end(&it), origin)) {
427 seg->flags |= AF_ROUNDABOUT;
431 cur = rp_iterator_next(&it);
438 * @brief Sets the mapset of the route passwd
440 * @param this The route to set the mapset for
441 * @param ms The mapset to set for this route
444 route_set_mapset(struct route *this, struct mapset *ms)
450 * @brief Returns the mapset of the route passed
452 * @param this The route to get the mapset of
453 * @return The mapset of the route passed
456 route_get_mapset(struct route *this)
462 * @brief Returns the current position within the route passed
464 * @param this The route to get the position for
465 * @return The position within the route passed
468 route_get_pos(struct route *this)
474 * @brief Returns the destination of the route passed
476 * @param this The route to get the destination for
477 * @return The destination of the route passed
480 route_get_dst(struct route *this)
486 * @brief Returns the speedlist of the route passed
488 * @param this The route to get the speedlist for
489 * @return The speedlist of the route passed
492 route_get_speedlist(struct route *this)
494 return this->speedlist;
498 * @brief Checks if the path is calculated for the route passed
500 * @param this The route to check
501 * @return True if the path is calculated, false if not
504 route_get_path_set(struct route *this)
506 return this->path2 != NULL;
510 * @brief Sets the driving speed for a certain itemtype
512 * @param this The route to set the speed for
513 * @param type The itemtype to set the speed for
514 * @param value The speed that should be set
515 * @return True on success, false if the itemtype does not exist
518 route_set_speed(struct route *this, enum item_type type, int value)
520 if (type < route_item_first || type > route_item_last) {
521 dbg(0,"street type %d out of range [%d,%d]", type, route_item_first, route_item_last);
524 this->speedlist[type-route_item_first]=value;
529 * @brief Checks if the route passed contains a certain item within the route path
531 * This function checks if a certain items exists in the path that navit will guide
532 * the user to his destination. It does *not* check if this item exists in the route
535 * @param this The route to check for this item
536 * @param item The item to search for
537 * @return True if the item was found, false if the item was not found or the route was not calculated
540 route_contains(struct route *this, struct item *item)
542 if (! this->path2 || !this->path2->path_hash)
544 return (int)item_hash_lookup(this->path2->path_hash, item);
548 * @brief Checks if the current position in a route is a certain item
550 * @param this The route to check for this item
551 * @param item The item to search for
552 * @return True if the current position is this item, false otherwise
555 route_pos_contains(struct route *this, struct item *item)
557 if (! this->pos || !this->pos->street)
559 return item_is_equal(this->pos->street->item, *item);
563 * @brief Checks if a route has reached its destination
565 * @param this The route to be checked
566 * @return True if the destination is "reached", false otherwise.
569 route_destination_reached(struct route *this)
571 struct street_data *sd = NULL;
576 sd = this->pos->street;
582 if (!item_is_equal(this->pos->street->item, this->dst->street->item)) {
586 if ((sd->flags & AF_ONEWAY) && (this->pos->lenneg >= this->dst->lenneg)) { // We would have to drive against the one-way road
589 if ((sd->flags & AF_ONEWAYREV) && (this->pos->lenpos >= this->dst->lenpos)) {
593 if (transform_distance(route_projection(this), &this->pos->c, &this->dst->lp) > this->destination_distance) {
601 route_path_update_done(struct route *this, int new_graph)
603 struct route_path *oldpath=this->path2;
606 this->path2=route_path_new(this->graph, oldpath, this->pos, this->dst, this->speedlist);
607 route_path_destroy(oldpath);
612 val=2+!this->path2->updated;
615 callback_list_call_attr_1(this->cbl, attr_route, (void *)val);
619 * @brief Updates the route graph and the route path if something changed with the route
621 * This will update the route graph and the route path of the route if some of the
622 * route's settings (destination, position) have changed.
624 * @attention For this to work the route graph has to be destroyed if the route's
625 * @attention destination is changed somewhere!
627 * @param this The route to update
630 route_path_update(struct route *this, int cancel)
632 if (! this->pos || ! this->dst) {
633 route_path_destroy(this->path2);
637 /* the graph is destroyed when setting the destination */
638 if (this->graph && !cancel) {
639 // we can try to update
640 route_path_update_done(this, 0);
642 route_path_destroy(this->path2);
645 if (! this->graph || !this->path2) {
646 if (! this->route_graph_flood_done_cb)
647 this->route_graph_flood_done_cb=callback_new_2(callback_cast(route_path_update_done), this, 1);
648 route_graph_update(this, this->route_graph_flood_done_cb);
653 * @brief This will calculate all the distances stored in a route_info
655 * @param ri The route_info to calculate the distances for
656 * @param pro The projection used for this route
659 route_info_distances(struct route_info *ri, enum projection pro)
662 struct street_data *sd=ri->street;
663 /* 0 1 2 X 3 4 5 6 pos=2 npos=3 count=7 0,1,2 3,4,5,6*/
664 ri->lenextra=transform_distance(pro, &ri->lp, &ri->c);
665 ri->lenneg=transform_polyline_length(pro, sd->c, npos)+transform_distance(pro, &sd->c[ri->pos], &ri->lp);
666 ri->lenpos=transform_polyline_length(pro, sd->c+npos, sd->count-npos)+transform_distance(pro, &sd->c[npos], &ri->lp);
670 * @brief This sets the current position of the route passed
672 * This will set the current position of the route passed to the street that is nearest to the
673 * passed coordinates. It also automatically updates the route.
675 * @param this The route to set the position of
676 * @param pos Coordinates to set as position
679 route_set_position(struct route *this, struct pcoord *pos)
682 route_info_free(this->pos);
684 this->pos=route_find_nearest_street(this->ms, pos);
685 dbg(1,"this->pos=%p\n", this->pos);
688 route_info_distances(this->pos, pos->pro);
689 route_path_update(this, 0);
693 * @brief Sets a route's current position based on coordinates from tracking
695 * @param this The route to set the current position of
696 * @param tracking The tracking to get the coordinates from
699 route_set_position_from_tracking(struct route *this, struct tracking *tracking)
702 struct route_info *ret;
703 struct street_data *sd;
706 c=tracking_get_pos(tracking);
707 ret=g_new0(struct route_info, 1);
709 printf("%s:Out of memory\n", __FUNCTION__);
713 route_info_free(this->pos);
719 ret->pos=tracking_get_segment_pos(tracking);
720 sd=tracking_get_street_data(tracking);
722 ret->street=street_data_dup(sd);
723 route_info_distances(ret, c->pro);
725 dbg(3,"c->x=0x%x, c->y=0x%x pos=%d item=(0x%x,0x%x)\n", c->x, c->y, ret->pos, ret->street->item.id_hi, ret->street->item.id_lo);
726 dbg(3,"street 0=(0x%x,0x%x) %d=(0x%x,0x%x)\n", ret->street->c[0].x, ret->street->c[0].y, ret->street->count-1, ret->street->c[ret->street->count-1].x, ret->street->c[ret->street->count-1].y);
729 route_path_update(this, 0);
733 /* Used for debuging of route_rect, what routing sees */
734 struct map_selection *route_selection;
737 * @brief Returns a single map selection
739 struct map_selection *
740 route_rect(int order, struct coord *c1, struct coord *c2, int rel, int abs)
742 int dx,dy,sx=1,sy=1,d,m;
743 struct map_selection *sel=g_new(struct map_selection, 1);
745 printf("%s:Out of memory\n", __FUNCTION__);
749 sel->range.min=route_item_first;
750 sel->range.max=route_item_last;
751 dbg(1,"%p %p\n", c1, c2);
756 sel->u.c_rect.lu.x=c1->x;
757 sel->u.c_rect.rl.x=c2->x;
759 sel->u.c_rect.lu.x=c2->x;
760 sel->u.c_rect.rl.x=c1->x;
764 sel->u.c_rect.lu.y=c2->y;
765 sel->u.c_rect.rl.y=c1->y;
767 sel->u.c_rect.lu.y=c1->y;
768 sel->u.c_rect.rl.y=c2->y;
775 sel->u.c_rect.lu.x-=m;
776 sel->u.c_rect.rl.x+=m;
777 sel->u.c_rect.lu.y+=m;
778 sel->u.c_rect.rl.y-=m;
784 * @brief Returns a list of map selections useable to create a route graph
786 * Returns a list of map selections useable to get a map rect from which items can be
787 * retrieved to build a route graph. The selections are a rectangle with
788 * c1 and c2 as two corners.
790 * @param c1 Corner 1 of the rectangle
791 * @param c2 Corder 2 of the rectangle
793 static struct map_selection *
794 route_calc_selection(struct coord *c1, struct coord *c2)
796 struct map_selection *ret,*sel;
797 sel=route_rect(4, c1, c2, 25, 0);
799 sel->next=route_rect(8, c1, c1, 0, 40000);
801 sel->next=route_rect(18, c1, c1, 0, 10000);
803 sel->next=route_rect(8, c2, c2, 0, 40000);
805 sel->next=route_rect(18, c2, c2, 0, 10000);
806 /* route_selection=ret; */
811 * @brief Destroys a list of map selections
813 * @param sel Start of the list to be destroyed
816 route_free_selection(struct map_selection *sel)
818 struct map_selection *next;
828 * @brief Sets the destination of a route
830 * This sets the destination of a route to the street nearest to the coordinates passed
831 * and updates the route.
833 * @param this The route to set the destination for
834 * @param dst Coordinates to set as destination
837 route_set_destination(struct route *this, struct pcoord *dst)
841 route_info_free(this->dst);
844 this->dst=route_find_nearest_street(this->ms, dst);
846 route_info_distances(this->dst, dst->pro);
848 callback_list_call_attr_1(this->cbl, attr_route, (void *)0);
849 profile(1,"find_nearest_street");
851 /* The graph has to be destroyed and set to NULL, otherwise route_path_update() doesn't work */
852 route_graph_destroy(this->graph);
854 route_path_update(this, 1);
859 * @brief Gets the route_graph_point with the specified coordinates
861 * @param this The route in which to search
862 * @param c Coordinates to search for
863 * @return The point at the specified coordinates or NULL if not found
865 static struct route_graph_point *
866 route_graph_get_point(struct route_graph *this, struct coord *c)
868 struct route_graph_point *p;
869 int hashval=HASHCOORD(c);
870 p=this->hash[hashval];
872 if (p->c.x == c->x && p->c.y == c->y)
880 * @brief Inserts a point into the route graph at the specified coordinates
882 * This will insert a point into the route graph at the coordinates passed in f.
883 * Note that the point is not yet linked to any segments.
885 * @param this The route to insert the point into
886 * @param f The coordinates at which the point should be inserted
887 * @return The point inserted or NULL on failure
889 static struct route_graph_point *
890 route_graph_add_point(struct route_graph *this, struct coord *f)
893 struct route_graph_point *p;
895 p=route_graph_get_point(this,f);
897 hashval=HASHCOORD(f);
899 printf("p (0x%x,0x%x)\n", f->x, f->y);
900 p=g_new(struct route_graph_point,1);
902 printf("%s:Out of memory\n", __FUNCTION__);
905 p->hash_next=this->hash[hashval];
906 this->hash[hashval]=p;
907 p->next=this->route_points;
914 this->route_points=p;
920 * @brief Frees all the memory used for points in the route graph passed
922 * @param this The route graph to delete all points from
925 route_graph_free_points(struct route_graph *this)
927 struct route_graph_point *curr,*next;
928 curr=this->route_points;
934 this->route_points=NULL;
935 memset(this->hash, 0, sizeof(this->hash));
939 * @brief Inserts a new segment into the route graph
941 * This function performs a check if a segment for the item specified already exists, and inserts
942 * a new segment representing this item if it does not.
944 * @param this The route graph to insert the segment into
945 * @param start The graph point which should be connected to the start of this segment
946 * @param end The graph point which should be connected to the end of this segment
947 * @param len The length of this segment
948 * @param item The item that is represented by this segment
949 * @param flags Flags for this segment
950 * @param offset If the item passed in "item" is segmented (i.e. divided into several segments), this indicates the position of this segment within the item
953 route_graph_add_segment(struct route_graph *this, struct route_graph_point *start,
954 struct route_graph_point *end, int len, struct item *item,
955 int flags, int offset)
957 struct route_graph_segment *s;
961 if (item_is_equal(*item, s->item) && (s->offset == offset))
966 s = g_new0(struct route_graph_segment, 1);
968 printf("%s:Out of memory\n", __FUNCTION__);
972 s->start_next=start->start;
975 s->end_next=end->end;
977 dbg_assert(len >= 0);
982 s->next=this->route_segments;
983 this->route_segments=s;
985 printf("l (0x%x,0x%x)-(0x%x,0x%x)\n", start->c.x, start->c.y, end->c.x, end->c.y);
989 * @brief Gets all the coordinates of an item
991 * This will get all the coordinates of the item i and return them in c,
992 * up to max coordinates. Additionally it is possible to limit the coordinates
993 * returned to all the coordinates of the item between the two coordinates
996 * @important Make shure that whatever c points to has enough memory allocated
997 * @important to hold max coordinates!
999 * @param i The item to get the coordinates of
1000 * @param c Pointer to memory allocated for holding the coordinates
1001 * @param max Maximum number of coordinates to return
1002 * @param start First coordinate to get
1003 * @param end Last coordinate to get
1004 * @return The number of coordinates returned
1006 static int get_item_seg_coords(struct item *i, struct coord *c, int max,
1007 struct coord *start, struct coord *end)
1009 struct map_rect *mr;
1013 mr=map_rect_new(i->map, NULL);
1016 item = map_rect_get_item_byid(mr, i->id_hi, i->id_lo);
1018 rc = item_coord_get(item, &c1, 1);
1019 while (rc && (c1.x != start->x || c1.y != start->y)) {
1020 rc = item_coord_get(item, &c1, 1);
1022 while (rc && p < max) {
1024 if (c1.x == end->x && c1.y == end->y)
1026 rc = item_coord_get(item, &c1, 1);
1029 map_rect_destroy(mr);
1034 * @brief Returns and removes one segment from a path
1036 * @param path The path to take the segment from
1037 * @param item The item whose segment to remove
1038 * @param offset Offset of the segment within the item to remove. If the item is not segmented this should be 1.
1039 * @return The segment removed
1041 static struct route_path_segment *
1042 route_extract_segment_from_path(struct route_path *path, struct item *item,
1045 struct route_path_segment *sp = NULL, *s;
1048 if (s->offset == offset && item_is_equal(s->item,*item)) {
1053 path->path = s->next;
1061 item_hash_remove(path->path_hash, item);
1066 * @brief Adds a segment and the end of a path
1068 * @param this The path to add the segment to
1069 * @param segment The segment to add
1072 route_path_add_segment(struct route_path *this, struct route_path_segment *segment)
1076 if (this->path_last)
1077 this->path_last->next=segment;
1078 this->path_last=segment;
1082 * @brief Adds a new item to a path
1084 * This adds a new item to a path, creating a new segment for it. Please note that this function does not check
1085 * if the item passed is segmented - it will create exactly one segment.
1087 * @param this The path to add the item to
1088 * @param item The item to add
1089 * @param len The length of the item
1090 * @param first (Optional) coordinate to add to the start of the item. If none should be added, make this NULL.
1091 * @param c Pointer to count coordinates of the item.
1092 * @param cound Number of coordinates in c
1093 * @param last (Optional) coordinate to add to the end of the item. If none should be added, make this NULL.
1094 * @param dir Direction to add the coordinates in. Greater than zero means "start with the first coordinate in c", all other values mean "start with the last coordinate in c"
1097 route_path_add_item(struct route_path *this, struct item *item, int len, struct coord *first, struct coord *c, int count, struct coord *last, int dir)
1099 int i,idx=0,ccount=count + (first ? 1:0) + (last ? 1:0);
1100 struct route_path_segment *segment;
1102 segment=g_malloc0(sizeof(*segment) + sizeof(struct coord) * ccount);
1103 segment->ncoords=ccount;
1104 segment->direction=dir;
1106 segment->c[idx++]=*first;
1108 for (i = 0 ; i < count ; i++)
1109 segment->c[idx++]=c[i];
1111 for (i = 0 ; i < count ; i++)
1112 segment->c[idx++]=c[count-i-1];
1115 segment->c[idx++]=*last;
1116 segment->length=len;
1118 segment->item=*item;
1119 route_path_add_segment(this, segment);
1123 * @brief Inserts a new item into the path
1125 * This function does almost the same as "route_apth_add_item()", but identifies
1126 * the item to add by a segment from the route graph. Another difference is that it "copies" the
1127 * segment from the route graph, i.e. if the item is segmented, only the segment passed in rgs will
1128 * be added to the route path, not all segments of the item.
1130 * The function can be sped up by passing an old path already containing this segment in oldpath -
1131 * the segment will then be extracted from this old path. Please note that in this case the direction
1132 * parameter has no effect.
1134 * @param this The path to add the item to
1135 * @param oldpath Old path containing the segment to be added. Speeds up the function, but can be NULL.
1136 * @param rgs Segment of the route graph that should be "copied" to the route path
1137 * @param len Length of the item to be added
1138 * @param offset Offset of rgs within the item it represents
1139 * @param dir Order in which to add the coordinates. See route_path_add_item()
1140 * @param straight Indicates if this segment is being entered "straight". See route_check_straight().
1143 route_path_add_item_from_graph(struct route_path *this, struct route_path *oldpath,
1144 struct route_graph_segment *rgs, int len, int offset, int dir, int straight)
1146 struct route_path_segment *segment;
1147 int i,ccnt = 0, ret=1;
1148 struct coord ca[2048];
1151 ccnt = (int)item_hash_lookup(oldpath->path_hash, &rgs->item);
1153 segment = route_extract_segment_from_path(oldpath,
1154 &rgs->item, offset);
1161 ccnt = get_item_seg_coords(&rgs->item, ca, 2047, &rgs->start->c, &rgs->end->c);
1162 segment= g_malloc0(sizeof(*segment) + sizeof(struct coord) * ccnt);
1163 segment->direction=dir;
1165 for (i = 0 ; i < ccnt ; i++)
1166 segment->c[i]=ca[i];
1168 for (i = 0 ; i < ccnt ; i++)
1169 segment->c[i]=ca[ccnt-i-1];
1171 segment->ncoords = ccnt;
1173 /* We check if the route graph segment is part of a roundabout here, because this
1174 * only matters for route graph segments which form parts of the route path */
1175 if (!(rgs->flags & AF_ROUNDABOUT)) { // We identified this roundabout earlier
1176 route_check_roundabout(rgs, 13, (dir < 1), NULL);
1180 segment->item=rgs->item;
1181 segment->offset = offset;
1183 segment->length=len;
1185 item_hash_insert(this->path_hash, &rgs->item, (void *)ccnt);
1187 route_path_add_segment(this, segment);
1193 * @brief Destroys all segments of a route graph
1195 * @param this The graph to destroy all segments from
1198 route_graph_free_segments(struct route_graph *this)
1200 struct route_graph_segment *curr,*next;
1201 curr=this->route_segments;
1207 this->route_segments=NULL;
1211 * @brief Destroys a route graph
1213 * @param this The route graph to be destroyed
1216 route_graph_destroy(struct route_graph *this)
1219 route_graph_build_done(this, 1);
1220 route_graph_free_points(this);
1221 route_graph_free_segments(this);
1227 * @brief Returns the time needed to drive len on item
1229 * This function returns the time needed to drive len meters on
1230 * the item passed in item in tenth of seconds.
1232 * @param speedlist The speedlist that should be used
1233 * @param item The item to be driven on
1234 * @param len The length to drive
1235 * @return The time needed to drive len on item in thenth of senconds
1238 route_time(int *speedlist, struct item *item, int len)
1240 if (item->type < route_item_first || item->type > route_item_last) {
1241 dbg(0,"street type %d out of range [%d,%d]\n", item->type, route_item_first, route_item_last);
1244 if (!speedlist[item->type-route_item_first]) {
1245 dbg(0,"street type %d speed is zero\n", item->type);
1249 return len*36/speedlist[item->type-route_item_first];
1253 * @brief Returns the "costs" of driving len on item
1255 * @param speedlist The speedlist that should be used
1256 * @param item The item to be driven on
1257 * @param len The length to drive
1258 * @return The "costs" needed to drive len on item
1261 route_value(int *speedlist, struct item *item, int len)
1265 printf("len=%d\n", len);
1267 dbg_assert(len >= 0);
1268 ret=route_time(speedlist, item, len);
1269 dbg(1, "route_value(0x%x, %d)=%d\n", item->type, len, ret);
1274 * @brief Adds an item to the route graph
1276 * This adds an item (e.g. a street) to the route graph, creating as many segments as needed for a
1279 * @param this The route graph to add to
1280 * @param item The item to add
1283 route_process_street_graph(struct route_graph *this, struct item *item)
1290 struct route_graph_point *s_pnt,*e_pnt;
1297 if (item_coord_get(item, &l, 1)) {
1298 if (item_attr_get(item, attr_flags, &attr)) {
1300 if (flags & AF_SEGMENTED)
1303 s_pnt=route_graph_add_point(this,&l);
1305 while (item_coord_get(item, &c, 1)) {
1306 len+=transform_distance(map_projection(item->map), &l, &c);
1309 e_pnt=route_graph_add_point(this,&l);
1310 dbg_assert(len >= 0);
1311 route_graph_add_segment(this, s_pnt, e_pnt, len, item, flags, offset);
1316 isseg = item_coord_is_node(item);
1317 rc = item_coord_get(item, &c, 1);
1319 len+=transform_distance(map_projection(item->map), &l, &c);
1322 e_pnt=route_graph_add_point(this,&l);
1323 route_graph_add_segment(this, s_pnt, e_pnt, len, item, flags, offset);
1325 s_pnt=route_graph_add_point(this,&l);
1330 e_pnt=route_graph_add_point(this,&l);
1331 dbg_assert(len >= 0);
1333 route_graph_add_segment(this, s_pnt, e_pnt, len, item, flags, offset);
1339 * @brief Compares the costs of reaching the destination from two points on
1341 * @important Do not pass anything other than route_graph_points in v1 and v2!
1345 * @return The additional costs of v1 compared to v2 (may be negative)
1348 compare(void *v1, void *v2)
1350 struct route_graph_point *p1=v1;
1351 struct route_graph_point *p2=v2;
1354 printf("compare %d (%p) vs %d (%p)\n", p1->value,p1,p2->value,p2);
1356 return p1->value-p2->value;
1360 * @brief Calculates the routing costs for each point
1362 * This function is the heart of routing. It assigns each point in the route graph a
1363 * cost at which one can reach the destination from this point on. Additionally it assigns
1364 * each point a segment one should follow from this point on to reach the destination at the
1367 * This function uses Dijkstra's algorithm to do the routing. To understand it you should have a look
1368 * at this algorithm.
1371 route_graph_flood(struct route_graph *this, struct route_info *dst, int *speedlist, struct callback *cb)
1373 struct route_graph_point *p_min,*end=NULL;
1374 struct route_graph_segment *s;
1375 int min,new,old,val;
1376 struct fibheap *heap; /* This heap will hold all points with "temporarily" calculated costs */
1377 struct street_data *sd=dst->street;
1379 heap = fh_makeheap();
1380 fh_setcmp(heap, compare);
1382 if (! (sd->flags & AF_ONEWAYREV)) { /* If we may drive in the direction of the coordinates of the item, the first coordinate is one starting point */
1383 end=route_graph_get_point(this, &sd->c[0]);
1384 dbg_assert(end != 0);
1385 end->value=route_value(speedlist, &sd->item, dst->lenneg);
1386 end->el=fh_insert(heap, end);
1389 if (! (sd->flags & AF_ONEWAY)) { /* If we may drive against the direction of the coordinates, the last coordinate is another starting point */
1390 end=route_graph_get_point(this, &sd->c[sd->count-1]);
1391 dbg_assert(end != 0);
1392 end->value=route_value(speedlist, &sd->item, dst->lenpos);
1393 end->el=fh_insert(heap, end);
1396 dbg(1,"0x%x,0x%x\n", end->c.x, end->c.y);
1398 p_min=fh_extractmin(heap); /* Starting Dijkstra by selecting the point with the minimum costs on the heap */
1399 if (! p_min) /* There are no more points with temporarily calculated costs, Dijkstra has finished */
1403 printf("extract p=%p free el=%p min=%d, 0x%x, 0x%x\n", p_min, p_min->el, min, p_min->c.x, p_min->c.y);
1404 p_min->el=NULL; /* This point is permanently calculated now, we've taken it out of the heap */
1406 while (s) { /* Iterating all the segments leading away from our point to update the points at their ends */
1407 val=route_value(speedlist, &s->item, s->len);
1409 val+=val*2*street_route_contained(s->str->segid);
1413 printf("begin %d len %d vs %d (0x%x,0x%x)\n",new,val,s->end->value, s->end->c.x, s->end->c.y);
1414 if (new < s->end->value && !(s->flags & AF_ONEWAY)) { /* We've found a less costly way to reach the end of s, update it */
1419 printf("insert_end p=%p el=%p val=%d ", s->end, s->end->el, s->end->value);
1420 s->end->el=fh_insert(heap, s->end);
1422 printf("el new=%p\n", s->end->el);
1426 printf("replace_end p=%p el=%p val=%d\n", s->end, s->end->el, s->end->value);
1427 fh_replacedata(heap, s->end->el, s->end);
1435 while (s) { /* Doing the same as above with the segments leading towards our point */
1436 val=route_value(speedlist, &s->item, s->len);
1439 printf("end %d len %d vs %d (0x%x,0x%x)\n",new,val,s->start->value,s->start->c.x, s->start->c.y);
1440 if (new < s->start->value && !(s->flags & AF_ONEWAYREV)) {
1441 old=s->start->value;
1442 s->start->value=new;
1444 if (! s->start->el) {
1446 printf("insert_start p=%p el=%p val=%d ", s->start, s->start->el, s->start->value);
1447 s->start->el=fh_insert(heap, s->start);
1449 printf("el new=%p\n", s->start->el);
1453 printf("replace_start p=%p el=%p val=%d\n", s->start, s->start->el, s->start->value);
1454 fh_replacedata(heap, s->start->el, s->start);
1462 fh_deleteheap(heap);
1463 callback_call_0(cb);
1467 * @brief Starts an "offroad" path
1469 * This starts a path that is not located on a street. It creates a new route path
1470 * adding only one segment, that leads from pos to dest, and which is not associated with an item.
1472 * @param this Not used
1473 * @param pos The starting position for the new path
1474 * @param dst The destination of the new path
1475 * @param dir Not used
1476 * @return The new path
1478 static struct route_path *
1479 route_path_new_offroad(struct route_graph *this, struct route_info *pos, struct route_info *dst, int dir)
1481 struct route_path *ret;
1483 ret=g_new0(struct route_path, 1);
1484 ret->path_hash=item_hash_new();
1485 route_path_add_item(ret, NULL, pos->lenextra+dst->lenextra, &pos->c, NULL, 0, &dst->c, 1);
1492 * @brief Creates a new "trivial" route
1494 * This function creates a new "trivial" route. A trivial route is a route that starts and ends on the same street,
1495 * so there is no routing needed. Depending on pos and dst it can optionally add some "offroad" part to the route.
1497 * @param this The route graph to place the route on
1498 * @param pos The starting position for the new path
1499 * @param dst The destination of the new path
1500 * @param dir Direction of the coordinates to be added
1501 * @return The new path
1503 static struct route_path *
1504 route_path_new_trivial(struct route_graph *this, struct route_info *pos, struct route_info *dst, int dir)
1506 struct street_data *sd=pos->street;
1507 struct route_path *ret;
1510 if (pos->lenextra + dst->lenextra + pos->lenneg-dst->lenneg > transform_distance(map_projection(sd->item.map), &pos->c, &dst->c))
1511 return route_path_new_offroad(this, pos, dst, dir);
1513 if (pos->lenextra + dst->lenextra + pos->lenpos-dst->lenpos > transform_distance(map_projection(sd->item.map), &pos->c, &dst->c))
1514 return route_path_new_offroad(this, pos, dst, dir);
1516 ret=g_new0(struct route_path, 1);
1517 ret->path_hash=item_hash_new();
1519 route_path_add_item(ret, NULL, pos->lenextra, &pos->c, NULL, 0, &pos->lp, 1);
1521 route_path_add_item(ret, &sd->item, pos->lenpos-dst->lenpos, &pos->lp, sd->c+pos->pos+1, dst->pos+pos->pos, &dst->lp, 1);
1523 route_path_add_item(ret, &sd->item, pos->lenneg-dst->lenneg, &pos->lp, sd->c+dst->pos+1, pos->pos-dst->pos, &dst->lp, -1);
1525 route_path_add_item(ret, NULL, dst->lenextra, &dst->lp, NULL, 0, &dst->c, 1);
1531 * @brief Creates a new route path
1533 * This creates a new non-trivial route. It therefore needs the routing information created by route_graph_flood, so
1534 * make shure to run route_graph_flood() after changing the destination before using this function.
1536 * @param this The route graph to create the route from
1537 * @param oldpath (Optional) old path which may contain parts of the new part - this speeds things up a bit. May be NULL.
1538 * @param pos The starting position of the route
1539 * @param dst The destination of the route
1540 * @param speedlist The speedlist to use
1541 * @return The new route path
1543 static struct route_path *
1544 route_path_new(struct route_graph *this, struct route_path *oldpath, struct route_info *pos, struct route_info *dst, int *speedlist)
1546 struct route_graph_point *start1=NULL,*start2=NULL,*start;
1547 struct route_graph_segment *s=NULL;
1548 struct route_graph_segment *lastseg = NULL;
1553 int time=0,hr,min,sec
1555 unsigned int val1=0xffffffff,val2=0xffffffff;
1556 struct street_data *sd=pos->street;
1557 struct route_path *ret;
1559 if (! pos->street || ! dst->street)
1561 if (item_is_equal(pos->street->item, dst->street->item)) { /* We probably don't have to leave this street and can use a trivial route */
1562 if (!(sd->flags & AF_ONEWAY) && pos->lenneg >= dst->lenneg) {
1563 return route_path_new_trivial(this, pos, dst, -1);
1565 if (!(sd->flags & AF_ONEWAYREV) && pos->lenpos >= dst->lenpos) {
1566 return route_path_new_trivial(this, pos, dst, 1);
1569 if (! (sd->flags & AF_ONEWAY)) { /* Using the start of the current segment as one starting point */
1570 start1=route_graph_get_point(this, &sd->c[0]);
1573 val1=start1->value+route_value(speedlist, &sd->item, pos->lenneg);
1574 dbg(1,"start1: %d(route)+%d=%d\n", start1->value, val1-start1->value, val1);
1576 if (! (sd->flags & AF_ONEWAYREV)) { /* Using the start of the current segment as an alternative starting point */
1577 start2=route_graph_get_point(this, &sd->c[sd->count-1]);
1580 val2=start2->value+route_value(speedlist, &sd->item, pos->lenpos);
1581 dbg(1,"start2: %d(route)+%d=%d\n", start2->value, val2-start2->value, val2);
1583 dbg(1,"val1=%d val2=%d\n", val1, val2);
1585 val1=start1->start->start->value;
1586 val2=start2->end->end->value;
1588 ret=g_new0(struct route_path, 1);
1591 route_path_add_item(ret, NULL, pos->lenextra, &pos->c, NULL, 0, &pos->lp, 1);
1592 if (start1 && (val1 < val2)) {
1594 route_path_add_item(ret, &sd->item, pos->lenneg, &pos->lp, sd->c, pos->pos+1, NULL, -1);
1598 route_path_add_item(ret, &sd->item, pos->lenpos, &pos->lp, sd->c+pos->pos+1, sd->count-pos->pos-1, NULL, 1);
1600 printf("no route found, pos blocked\n");
1604 ret->path_hash=item_hash_new();
1605 while ((s=start->seg)) { /* following start->seg, which indicates the least costly way to reach our destination */
1608 printf("start->value=%d 0x%x,0x%x\n", start->value, start->c.x, start->c.y);
1613 if (s->start == start) {
1614 if (!route_path_add_item_from_graph(ret, oldpath, s, seg_len, s->offset, 1, is_straight))
1618 if (!route_path_add_item_from_graph(ret, oldpath, s, seg_len, s->offset, -1, is_straight))
1626 dbg(1,"start->value=%d 0x%x,0x%x\n", start->value, start->c.x, start->c.y);
1627 dbg(1,"dst sd->flags=%d sd->c[0]=0x%x,0x%x sd->c[sd->count-1]=0x%x,0x%x\n", sd->flags, sd->c[0].x,sd->c[0].y, sd->c[sd->count-1].x, sd->c[sd->count-1].y);
1628 if (start->c.x == sd->c[0].x && start->c.y == sd->c[0].y) { /* Adding a final segment to reach the destination within the destination street */
1629 route_path_add_item(ret, &sd->item, dst->lenneg, NULL, sd->c, dst->pos+1, &dst->lp, 1);
1630 } else if (start->c.x == sd->c[sd->count-1].x && start->c.y == sd->c[sd->count-1].y) {
1631 route_path_add_item(ret, &sd->item, dst->lenpos, NULL, sd->c+dst->pos+1, sd->count-dst->pos-1, &dst->lp, -1);
1633 printf("no route found\n");
1634 route_path_destroy(ret);
1638 route_path_add_item(ret, NULL, dst->lenextra, &dst->lp, NULL, 0, &dst->c, 1);
1639 dbg(1, "%d segments\n", segs);
1644 route_graph_build_next_map(struct route_graph *rg)
1647 rg->m=mapset_next(rg->h, 1);
1650 map_rect_destroy(rg->mr);
1651 rg->mr=map_rect_new(rg->m, rg->sel);
1658 route_graph_build_done(struct route_graph *rg, int cancel)
1660 dbg(1,"cancel=%d\n",cancel);
1661 event_remove_idle(rg->idle_ev);
1662 callback_destroy(rg->idle_cb);
1663 map_rect_destroy(rg->mr);
1664 mapset_close(rg->h);
1665 route_free_selection(rg->sel);
1672 callback_call_0(rg->done_cb);
1677 route_graph_build_idle(struct route_graph *rg)
1684 item=map_rect_get_item(rg->mr);
1687 if (!route_graph_build_next_map(rg)) {
1688 route_graph_build_done(rg, 0);
1692 if (item->type >= type_street_0 && item->type <= type_ferry)
1693 route_process_street_graph(rg, item);
1699 * @brief Builds a new route graph from a mapset
1701 * This function builds a new route graph from a map. Please note that this function does not
1702 * add any routing information to the route graph - this has to be done via the route_graph_flood()
1705 * The function does not create a graph covering the whole map, but only covering the rectangle
1706 * between c1 and c2.
1708 * @param ms The mapset to build the route graph from
1709 * @param c1 Corner 1 of the rectangle to use from the map
1710 * @param c2 Corner 2 of the rectangle to use from the map
1711 * @param done_cb The callback which will be called when graph is complete
1712 * @return The new route graph.
1714 static struct route_graph *
1715 route_graph_build(struct mapset *ms, struct coord *c1, struct coord *c2, struct callback *done_cb)
1717 struct route_graph *ret=g_new0(struct route_graph, 1);
1721 ret->sel=route_calc_selection(c1, c2);
1722 ret->h=mapset_open(ms);
1723 ret->done_cb=done_cb;
1725 if (route_graph_build_next_map(ret)) {
1726 ret->idle_cb=callback_new_1(callback_cast(route_graph_build_idle), ret);
1727 ret->idle_ev=event_add_idle(50, ret->idle_cb);
1729 route_graph_build_done(ret, 0);
1735 route_graph_update_done(struct route *this, struct callback *cb)
1737 route_graph_flood(this->graph, this->dst, this->speedlist, cb);
1741 * @brief Updates the route graph
1743 * This updates the route graph after settings in the route have changed. It also
1744 * adds routing information afterwards by calling route_graph_flood().
1746 * @param this The route to update the graph for
1749 route_graph_update(struct route *this, struct callback *cb)
1751 route_graph_destroy(this->graph);
1752 callback_destroy(this->route_graph_done_cb);
1753 this->route_graph_done_cb=callback_new_2(callback_cast(route_graph_update_done), this, cb);
1754 callback_list_call_attr_1(this->cbl, attr_route, (void *)0);
1755 this->graph=route_graph_build(this->ms, &this->pos->c, &this->dst->c, this->route_graph_done_cb);
1759 * @brief Gets street data for an item
1761 * @param item The item to get the data for
1762 * @return Street data for the item
1764 struct street_data *
1765 street_get_data (struct item *item)
1768 struct street_data *ret = NULL, *ret1;
1770 const int step = 128;
1774 ret1=g_realloc(ret, sizeof(struct street_data)+(count+step)*sizeof(struct coord));
1781 c = item_coord_get(item, &ret->c[count], step);
1783 } while (c && c == step);
1785 ret1=g_realloc(ret, sizeof(struct street_data)+count*sizeof(struct coord));
1790 if (item_attr_get(item, attr_flags, &attr))
1791 ret->flags=attr.u.num;
1799 * @brief Copies street data
1801 * @param orig The street data to copy
1802 * @return The copied street data
1804 struct street_data *
1805 street_data_dup(struct street_data *orig)
1807 struct street_data *ret;
1808 int size=sizeof(struct street_data)+orig->count*sizeof(struct coord);
1811 memcpy(ret, orig, size);
1817 * @brief Frees street data
1819 * @param sd Street data to be freed
1822 street_data_free(struct street_data *sd)
1828 * @brief Finds the nearest street to a given coordinate
1830 * @param ms The mapset to search in for the street
1831 * @param pc The coordinate to find a street nearby
1832 * @return The nearest street
1834 static struct route_info *
1835 route_find_nearest_street(struct mapset *ms, struct pcoord *pc)
1837 struct route_info *ret=NULL;
1839 struct map_selection *sel;
1840 int dist,mindist=0,pos;
1841 struct mapset_handle *h;
1843 struct map_rect *mr;
1846 struct street_data *sd;
1850 ret=g_new0(struct route_info, 1);
1852 dbg(0,"Out of memory\n");
1858 while ((m=mapset_next(h,1))) {
1861 if (map_projection(m) != pc->pro) {
1862 transform_to_geo(pc->pro, &c, &g);
1863 transform_from_geo(map_projection(m), &g, &c);
1865 sel = route_rect(18, &c, &c, 0, max_dist);
1868 mr=map_rect_new(m, sel);
1870 map_selection_destroy(sel);
1873 while ((item=map_rect_get_item(mr))) {
1874 if (item->type >= type_street_0 && item->type <= type_ferry) {
1875 sd=street_get_data(item);
1878 dist=transform_distance_polyline_sq(sd->c, sd->count, &c, &lp, &pos);
1879 if (dist < mindist) {
1882 street_data_free(ret->street);
1888 dbg(1,"dist=%d id 0x%x 0x%x pos=%d\n", dist, item->id_hi, item->id_lo, pos);
1890 street_data_free(sd);
1894 map_selection_destroy(sel);
1895 map_rect_destroy(mr);
1899 if (!ret->street || mindist > max_dist*max_dist) {
1901 street_data_free(ret->street);
1902 dbg(1,"Much too far %d > %d\n", mindist, max_dist);
1912 * @brief Destroys a route_info
1914 * @param info The route info to be destroyed
1917 route_info_free(struct route_info *inf)
1920 street_data_free(inf->street);
1928 * @brief Returns street data for a route info
1930 * @param rinf The route info to return the street data for
1931 * @return Street data for the route info
1933 struct street_data *
1934 route_info_street(struct route_info *rinf)
1936 return rinf->street;
1940 struct route_crossings *
1941 route_crossings_get(struct route *this, struct coord *c)
1943 struct route_point *pnt;
1944 struct route_segment *seg;
1946 struct route_crossings *ret;
1948 pnt=route_graph_get_point(this, c);
1951 printf("start: 0x%x 0x%x\n", seg->item.id_hi, seg->item.id_lo);
1953 seg=seg->start_next;
1957 printf("end: 0x%x 0x%x\n", seg->item.id_hi, seg->item.id_lo);
1961 ret=g_malloc(sizeof(struct route_crossings)+crossings*sizeof(struct route_crossing));
1962 ret->count=crossings;
1968 struct map_rect_priv {
1969 struct route_info_handle *ri;
1970 enum attr_type attr_next;
1972 struct map_priv *mpriv;
1975 unsigned int last_coord;
1976 struct route_path_segment *seg,*seg_next;
1977 struct route_graph_point *point;
1978 struct route_graph_segment *rseg;
1980 struct coord *coord_sel; /**< Set this to a coordinate if you want to filter for just a single route graph point */
1981 struct route_graph_point_iterator it;
1985 rm_coord_rewind(void *priv_data)
1987 struct map_rect_priv *mr = priv_data;
1992 rm_attr_rewind(void *priv_data)
1994 struct map_rect_priv *mr = priv_data;
1995 mr->attr_next = attr_street_item;
1999 rm_attr_get(void *priv_data, enum attr_type attr_type, struct attr *attr)
2001 struct map_rect_priv *mr = priv_data;
2002 struct route_path_segment *seg=mr->seg;
2003 struct route *route=mr->mpriv->route;
2004 attr->type=attr_type;
2005 switch (attr_type) {
2007 while (mr->attr_next != attr_none) {
2008 if (rm_attr_get(priv_data, mr->attr_next, attr))
2012 case attr_street_item:
2013 mr->attr_next=attr_direction;
2014 if (seg && seg->item.map)
2015 attr->u.item=&seg->item;
2019 case attr_direction:
2020 mr->attr_next=attr_route;
2022 attr->u.num=seg->direction;
2027 mr->attr_next=attr_length;
2028 attr->u.route = mr->mpriv->route;
2032 attr->u.num=seg->length;
2034 attr->u.num=mr->length;
2035 mr->attr_next=attr_time;
2038 mr->attr_next=attr_none;
2040 attr->u.num=route_time(route->speedlist, &seg->item, seg->length);
2045 mr->attr_next=attr_none;
2048 mr->attr_next=attr_none;
2049 attr->type=attr_none;
2056 rm_coord_get(void *priv_data, struct coord *c, int count)
2058 struct map_rect_priv *mr = priv_data;
2059 struct route_path_segment *seg = mr->seg;
2061 struct route *r = mr->mpriv->route;
2062 enum projection pro = route_projection(r);
2066 for (i=0; i < count; i++) {
2067 if (mr->last_coord >= seg->ncoords)
2069 if (i >= seg->ncoords)
2071 if (pro != projection_mg)
2072 transform_from_to(&seg->c[mr->last_coord++], pro,
2073 &c[i],projection_mg);
2075 c[i] = seg->c[mr->last_coord++];
2078 dbg(1,"return %d\n",rc);
2082 static struct item_methods methods_route_item = {
2090 rp_attr_rewind(void *priv_data)
2092 struct map_rect_priv *mr = priv_data;
2093 mr->attr_next = attr_label;
2097 rp_attr_get(void *priv_data, enum attr_type attr_type, struct attr *attr)
2099 struct map_rect_priv *mr = priv_data;
2100 struct route_graph_point *p = mr->point;
2101 struct route_graph_segment *seg = mr->rseg;
2102 switch (attr_type) {
2103 case attr_any: // works only with rg_points for now
2104 if (mr->item.type != type_rg_point)
2106 while (mr->attr_next != attr_none) {
2107 if (rp_attr_get(priv_data, mr->attr_next, attr))
2112 if (mr->item.type != type_rg_point)
2114 attr->type = attr_label;
2117 if (p->value != INT_MAX)
2118 mr->str=g_strdup_printf("%d", p->value);
2120 mr->str=g_strdup("-");
2121 attr->u.str = mr->str;
2122 mr->attr_next=attr_none;
2124 case attr_street_item:
2125 if (mr->item.type != type_rg_segment)
2127 mr->attr_next=attr_none;
2128 if (seg && seg->item.map)
2129 attr->u.item=&seg->item;
2134 if (mr->item.type != type_rg_segment)
2136 mr->attr_next = attr_none;
2138 attr->u.num = seg->flags;
2143 case attr_direction:
2144 // This only works if the map has been opened at a single point, and in that case indicates if the
2145 // segment returned last is connected to this point via its start (1) or its end (-1)
2146 if (!mr->coord_sel || (mr->item.type != type_rg_segment))
2148 if (seg->start == mr->point) {
2150 } else if (seg->end == mr->point) {
2157 if (mr->item.type != type_rg_point)
2159 attr->type = attr_debug;
2162 mr->str=g_strdup_printf("x=%d y=%d", p->c.x, p->c.y);
2163 attr->u.str = mr->str;
2164 mr->attr_next=attr_none;
2167 mr->attr_next=attr_none;
2168 attr->type=attr_none;
2174 * @brief Returns the coordinates of a route graph item
2176 * @param priv_data The route graph item's private data
2177 * @param c Pointer where to store the coordinates
2178 * @param count How many coordinates to get at a max?
2179 * @return The number of coordinates retrieved
2182 rp_coord_get(void *priv_data, struct coord *c, int count)
2184 struct map_rect_priv *mr = priv_data;
2185 struct route_graph_point *p = mr->point;
2186 struct route_graph_segment *seg = mr->rseg;
2188 struct route *r = mr->mpriv->route;
2189 enum projection pro = route_projection(r);
2191 for (i=0; i < count; i++) {
2192 if (mr->item.type == type_rg_point) {
2193 if (mr->last_coord >= 1)
2195 if (pro != projection_mg)
2196 transform_from_to(&p->c, pro,
2197 &c[i],projection_mg);
2201 if (mr->last_coord >= 2)
2204 if (seg->end->seg == seg)
2209 if (pro != projection_mg)
2210 transform_from_to(&seg->end->c, pro,
2211 &c[i],projection_mg);
2215 if (pro != projection_mg)
2216 transform_from_to(&seg->start->c, pro,
2217 &c[i],projection_mg);
2219 c[i] = seg->start->c;
2228 static struct item_methods methods_point_item = {
2236 rp_destroy(struct map_priv *priv)
2242 rm_destroy(struct map_priv *priv)
2247 static struct map_rect_priv *
2248 rm_rect_new(struct map_priv *priv, struct map_selection *sel)
2250 struct map_rect_priv * mr;
2252 if (! route_get_pos(priv->route))
2254 if (! route_get_dst(priv->route))
2256 if (! priv->route->path2)
2258 mr=g_new0(struct map_rect_priv, 1);
2260 mr->item.priv_data = mr;
2261 mr->item.type = type_street_route;
2262 mr->item.meth = &methods_route_item;
2263 mr->seg_next=priv->route->path2->path;
2268 * @brief Opens a new map rectangle on the route graph's map
2270 * This function opens a new map rectangle on the route graph's map.
2271 * The "sel" parameter enables you to only search for a single route graph
2272 * point on this map (or exactly: open a map rectangle that only contains
2273 * this one point). To do this, pass here a single map selection, whose
2274 * c_rect has both coordinates set to the same point. Otherwise this parameter
2277 * @param priv The route graph map's private data
2278 * @param sel Here it's possible to specify a point for which to search. Please read the function's description.
2279 * @return A new map rect's private data
2281 static struct map_rect_priv *
2282 rp_rect_new(struct map_priv *priv, struct map_selection *sel)
2284 struct map_rect_priv * mr;
2287 if (! priv->route->graph || ! priv->route->graph->route_points)
2289 mr=g_new0(struct map_rect_priv, 1);
2291 mr->item.priv_data = mr;
2292 mr->item.type = type_rg_point;
2293 mr->item.meth = &methods_point_item;
2295 if ((sel->u.c_rect.lu.x == sel->u.c_rect.rl.x) && (sel->u.c_rect.lu.y == sel->u.c_rect.rl.y)) {
2296 mr->coord_sel = g_malloc(sizeof(struct coord));
2297 *(mr->coord_sel) = sel->u.c_rect.lu;
2304 rm_rect_destroy(struct map_rect_priv *mr)
2308 if (mr->coord_sel) {
2309 g_free(mr->coord_sel);
2315 static struct item *
2316 rp_get_item(struct map_rect_priv *mr)
2318 struct route *r = mr->mpriv->route;
2319 struct route_graph_point *p = mr->point;
2320 struct route_graph_segment *seg = mr->rseg;
2322 if (mr->item.type == type_rg_point) {
2323 if (mr->coord_sel) {
2324 // We are supposed to return only the point at one specified coordinate...
2326 p = r->graph->hash[HASHCOORD(mr->coord_sel)];
2327 while ((p) && ((p->c.x != mr->coord_sel->x) || (p->c.y != mr->coord_sel->y))) {
2330 if ((!p) || !((p->c.x == mr->coord_sel->x) && (p->c.y == mr->coord_sel->y))) {
2331 mr->point = NULL; // This indicates that no point has been found
2333 mr->it = rp_iterator_new(p);
2340 p = r->graph->route_points;
2347 rm_coord_rewind(mr);
2351 mr->item.type = type_rg_segment;
2354 if (mr->coord_sel) {
2355 if (!mr->point) { // This means that no point has been found
2358 seg = rp_iterator_next(&(mr->it));
2361 seg=r->graph->route_segments;
2369 rm_coord_rewind(mr);
2377 static struct item *
2378 rp_get_item_byid(struct map_rect_priv *mr, int id_hi, int id_lo)
2380 struct item *ret=NULL;
2382 ret=rp_get_item(mr);
2387 static struct item *
2388 rm_get_item(struct map_rect_priv *mr)
2390 dbg(1,"enter\n", mr->pos);
2392 mr->seg=mr->seg_next;
2395 mr->seg_next=mr->seg->next;
2402 static struct item *
2403 rm_get_item_byid(struct map_rect_priv *mr, int id_hi, int id_lo)
2405 struct item *ret=NULL;
2407 ret=rm_get_item(mr);
2411 static struct map_methods route_meth = {
2424 static struct map_methods route_graph_meth = {
2438 route_toggle_routegraph_display(struct route *route)
2440 if (route->flags & RF_SHOWGRAPH) {
2441 route->flags &= ~RF_SHOWGRAPH;
2443 route->flags |= RF_SHOWGRAPH;
2447 static struct map_priv *
2448 route_map_new_helper(struct map_methods *meth, struct attr **attrs, int graph)
2450 struct map_priv *ret;
2451 struct attr *route_attr;
2453 route_attr=attr_search(attrs, NULL, attr_route);
2456 ret=g_new0(struct map_priv, 1);
2458 *meth=route_graph_meth;
2461 ret->route=route_attr->u.route;
2466 static struct map_priv *
2467 route_map_new(struct map_methods *meth, struct attr **attrs)
2469 return route_map_new_helper(meth, attrs, 0);
2472 static struct map_priv *
2473 route_graph_map_new(struct map_methods *meth, struct attr **attrs)
2475 return route_map_new_helper(meth, attrs, 1);
2479 route_get_map_helper(struct route *this_, struct map **map, char *type, char *description)
2482 *map=map_new(NULL, (struct attr*[]){
2483 &(struct attr){attr_type,{type}},
2484 &(struct attr){attr_route,.u.route=this_},
2485 &(struct attr){attr_data,{""}},
2486 &(struct attr){attr_description,{description}},
2493 * @brief Returns a new map containing the route path
2495 * This function returns a new map containing the route path.
2497 * @important Do not map_destroy() this!
2499 * @param this_ The route to get the map of
2500 * @return A new map containing the route path
2503 route_get_map(struct route *this_)
2505 return route_get_map_helper(this_, &this_->map, "route","Route");
2510 * @brief Returns a new map containing the route graph
2512 * This function returns a new map containing the route graph.
2514 * @important Do not map_destroy() this!
2516 * @param this_ The route to get the map of
2517 * @return A new map containing the route graph
2520 route_get_graph_map(struct route *this_)
2522 return route_get_map_helper(this_, &this_->graph_map, "route_graph","Route Graph");
2526 route_set_projection(struct route *this_, enum projection pro)
2531 route_add_callback(struct route *this_, struct callback *cb)
2533 callback_list_add(this_->cbl, cb);
2537 route_remove_callback(struct route *this_, struct callback *cb)
2539 callback_list_remove(this_->cbl, cb);
2546 plugin_register_map_type("route", route_map_new);
2547 plugin_register_map_type("route_graph", route_graph_map_new);