]> git.tdb.fi Git - r2c2.git/blobdiff - source/libmarklin/route.cpp
Fix pathfinder to not block itself in some situations
[r2c2.git] / source / libmarklin / route.cpp
index fa2286cc65aef625848101bc7b7c77c9d020d055..ace8d0b950812c56a22e23a0ba381f4d389b9f7b 100644 (file)
 /* $Id$
 
 This file is part of the MSP Märklin suite
-Copyright © 2007-2009  Mikkosoft Productions, Mikko Rasa
+Copyright © 2007-2010  Mikkosoft Productions, Mikko Rasa
 Distributed under the GPL
 */
 
+#include <queue>
+#include <msp/strings/formatter.h>
+#include "layout.h"
+#include "route.h"
 #include "track.h"
 #include "tracktype.h"
-#include "route.h"
 
 using namespace std;
 using namespace Msp;
 
+namespace {
+
+using namespace Marklin;
+
+typedef std::pair<const Track *, unsigned> Key;
+
+struct Node
+{
+       const Track *track;
+       unsigned ep;
+       Node *prev;
+       float dist;
+
+       Node():
+               track(0), ep(0), prev(0), dist(0)
+       { }
+
+       Node(const Track &t, unsigned e):
+               track(&t), ep(e), prev(0), dist(0)
+       { }
+
+       Node(const Track &t, unsigned e, Node &r, float d):
+               track(&t), ep(e), prev(&r), dist(prev->dist+d)
+       { }
+
+       bool operator<(const Node &other) const
+       { return dist>other.dist; }
+};
+
+struct TrackMatch
+{
+       const Track &track;
+
+       TrackMatch(const Track &t): track(t) { }
+
+       bool operator()(const Track &t) const { return &t==&track; }
+};
+
+struct TrackInRoute
+{
+       const Route &route;
+
+       TrackInRoute(const Route &r): route(r) { }
+
+       bool operator()(const Track &t) const { return route.get_tracks().count(&t); }
+};
+
+template<typename Pred>
+list<const Track *> dijkstra(const Track &from, unsigned ep, const Pred &goal)
+{
+       map<Key, Node> track_nodes;
+       priority_queue<Node> nodes;
+       Node *final = 0;
+
+       nodes.push(Node(from, ep));
+
+       while(!nodes.empty())
+       {
+               Node lowest = nodes.top();
+               nodes.pop();
+
+               Key key(lowest.track, lowest.ep);
+               if(track_nodes.count(key))
+                       continue;
+
+               Node &ref = track_nodes[key] = lowest;
+               if(goal(*lowest.track))
+               {
+                       final = &ref;
+                       break;
+               }
+
+               const TrackType &type = lowest.track->get_type();
+               const vector<Endpoint> &eps = type.get_endpoints();
+               const vector<Track *> &links = lowest.track->get_links();
+               for(unsigned i=0; i<eps.size(); ++i)
+               {
+                       if(i==lowest.ep || !links[i])
+                               continue;
+
+                       unsigned link_ep = links[i]->get_endpoint_by_link(*lowest.track);
+                       if(track_nodes.count(Key(links[i], link_ep)))
+                               continue;
+
+                       unsigned mask = eps[i].paths&eps[lowest.ep].paths;
+                       if(!mask)
+                               continue;
+
+                       unsigned path=0;
+                       for(; !(mask&1); ++path, mask>>=1) ;
+                       nodes.push(Node(*links[i], links[i]->get_endpoint_by_link(*lowest.track), ref, type.get_path_length(path)));
+               }
+       }
+
+       if(!final)
+               throw InvalidParameterValue("Could not find a route");
+
+       list<const Track *> result;
+       for(Node *node=final; node; node=node->prev)
+               result.push_front(node->track);
+
+       return result;
+}
+
+unsigned count = 0;
+
+template<typename Pred>
+Route *create_route(const Track &from, unsigned ep, const Pred &goal)
+{
+       list<const Track *> tracks = dijkstra(from, ep, goal);
+
+       Route *route = new Route(from.get_layout(), format("-%d-", ++count));
+       for(list<const Track *>::iterator i=tracks.begin(); i!=tracks.end(); ++i)
+               route->add_track(**i);
+
+       return route;
+}
+
+}
+
+
 namespace Marklin {
 
-Route::Route(const string &n):
+Route::Route(Layout &l, const string &n):
+       layout(l),
        name(n)
-{ }
+{
+       layout.add_route(*this);
+       layout.signal_track_removed.connect(sigc::mem_fun(this, &Route::track_removed));
+}
+
+Route::~Route()
+{
+       layout.remove_route(*this);
+}
 
 int Route::get_turnout(unsigned id) const
 {
@@ -89,34 +222,40 @@ void Route::update_turnouts()
                        const vector<Endpoint> &endpoints = (*i)->get_type().get_endpoints();
                        const vector<Track *> &links = (*i)->get_links();
 
+                       // Build a combined path mask from linked endpoints
                        unsigned mask = 15;
                        for(unsigned j=0; j<endpoints.size(); ++j)
                        {
                                if(!tracks.count(links[j]))
                                        continue;
+
                                if(unsigned tid2=links[j]->get_turnout_id())
                                {
                                        const Endpoint &ep = links[j]->get_type().get_endpoints()[links[j]->get_endpoint_by_link(**i)];
-                                       int r = get_turnout(tid2);
-                                       if(r>=0 && !(ep.routes&(1<<r)))
+                                       int p = get_turnout(tid2);
+                                       if(p>=0 && !(ep.paths&(1<<p)))
                                        {
-                                               mask &= ~endpoints[j].routes;
+                                               // The linked track is a turnout and has a path which is incompatible with this endpoint
+                                               mask &= ~endpoints[j].paths;
                                                continue;
                                        }
                                }
-                               mask &= endpoints[j].routes;
+                               mask &= endpoints[j].paths;
                        }
 
-                       if(!(mask&(mask-1)))
+                       if(mask && !(mask&(mask-1)))
                        {
-                               unsigned route = 0;
-                               for(; (mask && !(mask&1)); mask>>=1, ++route) ;
-                               turnouts[tid] = route;
+                               // Exactly one possible choice, set the path accordingly
+                               unsigned path = 0;
+                               for(; (mask && !(mask&1)); mask>>=1, ++path) ;
+                               turnouts[tid] = path;
                        }
-                       else
+                       else if(!turnouts.count(tid))
+                               // More than one possible choice, and no existing entry - set as undecided
                                turnouts[tid] = -1;
                }
 
+       // Remove any turnouts that do not exist in the route
        for(map<unsigned, int>::iterator i=turnouts.begin(); i!=turnouts.end();)
        {
                if(!found.count(i->first))
@@ -134,6 +273,7 @@ unsigned Route::check_validity(const Track &trk) const
                int epi=(*i)->get_endpoint_by_link(trk);
                if(epi>=0)
                {
+                       // Linked to an existing track - good
                        result |= 1;
                        const vector<Endpoint> &endpoints = (*i)->get_type().get_endpoints();
                        if(unsigned tid=(*i)->get_turnout_id())
@@ -141,11 +281,13 @@ unsigned Route::check_validity(const Track &trk) const
                                int r = get_turnout(tid);
                                if(r>=0)
                                {
-                                       if(endpoints[epi].routes&(1<<r))
+                                       // Linking to a turnout with path set is only good if we're continuing that path
+                                       if(endpoints[epi].paths&(1<<r))
                                                result |= 2;
                                }
                                else
                                {
+                                       // Linked to a turnout with no path set - find out other linked tracks 
                                        unsigned count = 0;
                                        const vector<Track *> &links = (*i)->get_links();
                                        int epj = -1;
@@ -155,15 +297,19 @@ unsigned Route::check_validity(const Track &trk) const
                                                        ++count;
                                                        epj = k;
                                                }
+
+                                       // Only good if at most one other track is linked to the turnout
                                        if(count<=1)
                                        {
                                                result |= 2;
-                                               if(epj>=0 && !(endpoints[epi].routes&endpoints[epj].routes))
+                                               if(epj>=0 && !(endpoints[epi].paths&endpoints[epj].paths))
+                                                       // Impossible path through the turnout - not good
                                                        result &= 3;
                                        }
                                }
                        }
                        else
+                               // Linked to something linear - good
                                result |= 2;
                }
        }
@@ -171,6 +317,21 @@ unsigned Route::check_validity(const Track &trk) const
        return result;
 }
 
+void Route::track_removed(Track &t)
+{
+       tracks.erase(&t);
+}
+
+Route *Route::find(const Track &from, unsigned ep, const Track &to)
+{
+       return create_route(from, ep, TrackMatch(to));
+}
+
+Route *Route::find(const Track &from, unsigned ep, const Route &to)
+{
+       return create_route(from, ep, TrackInRoute(to));
+}
+
 
 Route::Loader::Loader(Route &r):
        DataFile::BasicLoader<Route>(r)
@@ -178,9 +339,9 @@ Route::Loader::Loader(Route &r):
        add("turnout", &Loader::turnout);
 }
 
-void Route::Loader::turnout(unsigned id, unsigned route)
+void Route::Loader::turnout(unsigned id, unsigned path)
 {
-       obj.turnouts[id] = route;
+       obj.turnouts[id] = path;
 }
 
 } // namespace Marklin