Fix:map_csv:Disable default notification of each deleted item.
[profile/ivi/navit.git] / navit / navit / route.h
index 1543d95..6834d5b 100644 (file)
  * Boston, MA  02110-1301, USA.
  */
 
+/** @file
+ * 
+ * @brief Contains exported code for route.c
+ *
+ * This file contains code that works together with route.c and that is exported to
+ * other modules.
+ */
+
 #ifndef NAVIT_ROUTE_H
 #define NAVIT_ROUTE_H
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+enum route_status {
+       route_status_no_destination=0,
+       route_status_destination_set=1,
+       route_status_not_found=1|2,
+       route_status_building_path=1|4,
+       route_status_building_graph=1|4|8,
+       route_status_path_done_new=1|16,
+       route_status_path_done_incremental=1|32,
+};
+
 struct route_crossing {
        long segid;
        int dir;
@@ -30,74 +51,78 @@ struct route_crossings {
        struct route_crossing crossing[0];
 };
 
+/**
+ * @brief Information about a street
+ *
+ * This contains information about a certain street
+ */
 struct street_data {
-       struct item item;
-       int count;
+       struct item item;       /**< The map item for this street */
+       int count;                      /**< Number of coordinates this street has */
        int flags;
-       struct coord c[0];
+       int maxspeed;           /**< Maximum speed allowed on this street. */
+       struct coord c[0];      /**< Pointer to the coordinates of this street.
+                                                *   DO NOT INSERT FIELDS AFTER THIS. */
 };
 
-#define route_item_first type_street_0
-#define route_item_last type_ferry
-
 /* prototypes */
-enum item_type;
+enum attr_type;
+enum projection;
+struct attr;
+struct attr_iter;
 struct coord;
-struct displaylist;
 struct item;
+struct map;
 struct map_selection;
 struct mapset;
+struct pcoord;
 struct route;
 struct route_info;
-struct route_info_handle;
-struct route_path_coord_handle;
-struct route_path_handle;
-struct route_path_segment;
 struct street_data;
 struct tracking;
-struct transformation;
-struct route *route_new(struct attr **attrs);
-void route_set_mapset(struct route *this, struct mapset *ms);
-struct mapset *route_get_mapset(struct route *this);
-struct route_info *route_get_pos(struct route *this);
-struct route_info *route_get_dst(struct route *this);
-int *route_get_speedlist(struct route *this);
-int route_get_path_set(struct route *this);
-int route_set_speed(struct route *this, enum item_type type, int value);
-int route_contains(struct route *this, struct item *item);
-void route_set_position(struct route *this, struct pcoord *pos);
-void route_set_position_from_tracking(struct route *this, struct tracking *tracking);
+struct vehicleprofile;
+struct route *route_new(struct attr *parent, struct attr **attrs);
+void route_set_mapset(struct route *this_, struct mapset *ms);
+void route_set_profile(struct route *this_, struct vehicleprofile *prof);
+struct mapset *route_get_mapset(struct route *this_);
+struct route_info *route_get_pos(struct route *this_);
+struct route_info *route_get_dst(struct route *this_);
+int route_get_path_set(struct route *this_);
+int route_contains(struct route *this_, struct item *item);
+int route_destination_reached(struct route *this_);
+void route_set_position(struct route *this_, struct pcoord *pos);
+void route_set_position_from_tracking(struct route *this_, struct tracking *tracking, enum projection pro);
 struct map_selection *route_rect(int order, struct coord *c1, struct coord *c2, int rel, int abs);
-void route_set_destination(struct route *this, struct pcoord *dst);
-struct route_path_handle *route_path_open(struct route *this);
-struct route_path_segment *route_path_get_segment(struct route_path_handle *h);
-struct coord *route_path_segment_get_start(struct route_path_segment *s);
-struct coord *route_path_segment_get_end(struct route_path_segment *s);
-struct item *route_path_segment_get_item(struct route_path_segment *s);
-int route_path_segment_get_length(struct route_path_segment *s);
-int route_path_segment_get_time(struct route_path_segment *s);
-void route_path_close(struct route_path_handle *h);
-struct route_path_coord_handle *route_path_coord_open(struct route *this);
-struct coord *route_path_coord_get(struct route_path_coord_handle *h);
-void route_path_coord_close(struct route_path_coord_handle *h);
-int route_time(int *speedlist, struct item *item, int len);
-int route_info_length(struct route_info *pos, struct route_info *dst, int dir);
+void route_set_destinations(struct route *this_, struct pcoord *dst, int count, int async);
+int route_get_destinations(struct route *this_, struct pcoord *pc, int count);
+int route_get_destination_count(struct route *this_);
+void route_set_destination(struct route *this_, struct pcoord *dst, int async);
+void route_append_destination(struct route *this_, struct pcoord *dst, int async);
+void route_remove_nth_waypoint(struct route *this_, int n);
+void route_remove_waypoint(struct route *this_);
+char* route_get_destination_description(struct route *this_, int n);
+struct coord route_get_coord_dist(struct route *this_, int dist);
 struct street_data *street_get_data(struct item *item);
 struct street_data *street_data_dup(struct street_data *orig);
 void street_data_free(struct street_data *sd);
 void route_info_free(struct route_info *inf);
 struct street_data *route_info_street(struct route_info *rinf);
-struct coord *route_info_point(struct route_info *rinf, int point);
-struct route_info_handle *route_info_open(struct route_info *start, struct route_info *end, int dir);
-struct coord *route_info_get(struct route_info_handle *h);
-void route_info_close(struct route_info_handle *h);
-void route_draw(struct route *this, struct transformation *t, struct displaylist *dsp);
-struct map *route_get_map(struct route *route);
-struct map *route_get_graph_map(struct route *route);
-void route_toggle_routegraph_display(struct route *route);
+struct map *route_get_map(struct route *this_);
+struct map *route_get_graph_map(struct route *this_);
 void route_set_projection(struct route *this_, enum projection pro);
+void route_set_destinations(struct route *this_, struct pcoord *dst, int count, int async);
+int route_set_attr(struct route *this_, struct attr *attr);
+int route_add_attr(struct route *this_, struct attr *attr);
+int route_remove_attr(struct route *this_, struct attr *attr);
+struct attr_iter * route_attr_iter_new(void);
+void route_attr_iter_destroy(struct attr_iter *iter);
+int route_get_attr(struct route *this_, enum attr_type type, struct attr *attr, struct attr_iter *iter);
 void route_init(void);
+void route_destroy(struct route *this_);
 /* end of prototypes */
+#ifdef __cplusplus
+}
+#endif
 
 #endif