source/libr2c2/layout.cpp

   1 #include <algorithm>
   2 #include <msp/core/maputils.h>
   3 #include <msp/core/refptr.h>
   4 #include <msp/datafile/parser.h>
   5 #include <msp/datafile/writer.h>
   6 #include <msp/io/print.h>
   7 #include <msp/time/utils.h>
   8 #include "beamgate.h"
   9 #include "block.h"
  10 #include "catalogue.h"
  11 #include "driver.h"
  12 #include "layout.h"
  13 #include "route.h"
  14 #include "signal.h"
  15 #include "signaltype.h"
  16 #include "terrain.h"
  17 #include "track.h"
  18 #include "trackcircuit.h"
  19 #include "tracktype.h"
  20 #include "train.h"
  21 #include "vehicle.h"
  22 #include "vehicletype.h"
  23 #include "zone.h"
  24
  25 using namespace std;
  26 using namespace Msp;
  27
  28 namespace {
  29
  30 bool zone_order(const R2C2::Zone *z1, const R2C2::Zone *z2)
  31 {
  32         return z1->get_number()<z2->get_number();
  33 }
  34
  35 }
  36
  37
  38 namespace R2C2 {
  39
  40 Layout::Layout(Catalogue &c, Driver *d):
  41         catalogue(c),
  42         driver(d),
  43         next_turnout_addr(0x800)
  44 {
  45         clock.set_rate(60);
  46 }
  47
  48 Layout::~Layout()
  49 {
  50         delete driver;
  51         driver = 0;
  52
  53         while(!trains.empty())
  54                 delete trains.begin()->second;
  55         track_chains.del<Route>();
  56         track_chains.del<Zone>();
  57         objects.del<Signal>();
  58         objects.del<Track>();
  59         track_chains.del<Block>();
  60 }
  61
  62 Driver &Layout::get_driver() const
  63 {
  64         if(!driver)
  65                 throw logic_error("!driver");
  66         return *driver;
  67 }
  68
  69 void Layout::add(Object &o)
  70 {
  71         if(objects.insert(o))
  72                 signal_object_added.emit(o);
  73 }
  74
  75 void Layout::add(Track &t)
  76 {
  77         if(objects.insert(t))
  78         {
  79                 // Blocks must be recreated first
  80                 create_blocks();
  81                 signal_object_added.emit(t);
  82         }
  83 }
  84
  85 void Layout::add(TrackChain &g)
  86 {
  87         if(track_chains.insert(g))
  88                 signal_track_chain_added.emit(g);
  89 }
  90
  91 void Layout::add(Block &b)
  92 {
  93         if(track_chains.insert(b))
  94         {
  95                 b.signal_reserved.connect(sigc::bind<0>(signal_block_reserved, sigc::ref(b)));
  96                 signal_track_chain_added.emit(b);
  97         }
  98 }
  99
 100 void Layout::add(Sensor &s)
 101 {
 102         if(sensors.insert(s))
 103         {
 104                 s.signal_state_changed.connect(sigc::bind<0>(sigc::mem_fun(this, &Layout::sensor_state_changed), sigc::ref(s)));
 105                 s.signal_state_changed.connect(sigc::bind<0>(signal_sensor_state_changed, sigc::ref(s)));
 106         }
 107 }
 108
 109 void Layout::add(BeamGate &g)
 110 {
 111         add(static_cast<Object &>(g));
 112         add(static_cast<Sensor &>(g));
 113 }
 114
 115 template<>
 116 const set<Object *> &Layout::get_all<Object>() const
 117 {
 118         return objects.get();
 119 }
 120
 121 template<>
 122 const set<Track *> &Layout::get_all<Track>() const
 123 {
 124         return objects.get<Track>();
 125 }
 126
 127 template<>
 128 const set<Signal *> &Layout::get_all<Signal>() const
 129 {
 130         return objects.get<Signal>();
 131 }
 132
 133 template<>
 134 const set<Vehicle *> &Layout::get_all<Vehicle>() const
 135 {
 136         return objects.get<Vehicle>();
 137 }
 138
 139 template<>
 140 const set<Terrain *> &Layout::get_all<Terrain>() const
 141 {
 142         return objects.get<Terrain>();
 143 }
 144
 145 template<>
 146 const set<TrackChain *> &Layout::get_all<TrackChain>() const
 147 {
 148         return track_chains.get();
 149 }
 150
 151 template<>
 152 const set<Block *> &Layout::get_all<Block>() const
 153 {
 154         return track_chains.get<Block>();
 155 }
 156
 157 template<>
 158 const set<Route *> &Layout::get_all<Route>() const
 159 {
 160         return track_chains.get<Route>();
 161 }
 162
 163 template<>
 164 const set<Zone *> &Layout::get_all<Zone>() const
 165 {
 166         return track_chains.get<Zone>();
 167 }
 168
 169 template<>
 170 const set<Sensor *> &Layout::get_all<Sensor>() const
 171 {
 172         return sensors.get<Sensor>();
 173 }
 174
 175 template<>
 176 const set<TrackCircuit *> &Layout::get_all<TrackCircuit>() const
 177 {
 178         return sensors.get<TrackCircuit>();
 179 }
 180
 181 template<>
 182 const set<BeamGate *> &Layout::get_all<BeamGate>() const
 183 {
 184         return sensors.get<BeamGate>();
 185 }
 186
 187 template<typename T>
 188 T *Layout::pick(const Ray &ray)
 189 {
 190         const set<Object *> &objs = objects.get();
 191         T *closest = 0;
 192         float distance = -1;
 193         for(set<Object *>::const_iterator i=objs.begin(); i!=objs.end(); ++i)
 194                 if(T *t = dynamic_cast<T *>(*i))
 195                 {
 196                         float d = -1;
 197                         if(t->collide_ray(ray, &d))
 198                                 if(!closest || d<distance)
 199                                 {
 200                                         closest = t;
 201                                         distance = d;
 202                                 }
 203                 }
 204
 205         return closest;
 206 }
 207
 208 template Object *Layout::pick<Object>(const Ray &);
 209 template Track *Layout::pick<Track>(const Ray &);
 210 template Signal *Layout::pick<Signal>(const Ray &);
 211 template Vehicle *Layout::pick<Vehicle>(const Ray &);
 212
 213 void Layout::remove(Object &o)
 214 {
 215         if(objects.erase(o))
 216                 signal_object_removed.emit(o);
 217 }
 218
 219 void Layout::remove(Track &t)
 220 {
 221         if(objects.erase(t))
 222         {
 223                 // Blocks must be recreated first
 224                 create_blocks(t);
 225                 signal_object_removed.emit(t);
 226         }
 227 }
 228
 229 void Layout::remove(TrackChain &g)
 230 {
 231         if(track_chains.erase(g))
 232                 signal_track_chain_removed.emit(g);
 233 }
 234
 235 void Layout::remove(Sensor &s)
 236 {
 237         sensors.erase(s);
 238 }
 239
 240 void Layout::remove(BeamGate &g)
 241 {
 242         remove(static_cast<Object &>(g));
 243         remove(static_cast<Sensor &>(g));
 244 }
 245
 246 unsigned Layout::allocate_turnout_address()
 247 {
 248         set<unsigned> used_addrs;
 249         const set<Track *> &tracks = objects.get<Track>();
 250         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 251                 if((*i)->get_type().is_turnout())
 252                         used_addrs.insert((*i)->get_turnout_address());
 253
 254         unsigned result = next_turnout_addr;
 255         while(used_addrs.count(result))
 256                 ++result;
 257         next_turnout_addr = result+1;
 258
 259         return result;
 260 }
 261
 262 Block &Layout::get_block(unsigned id) const
 263 {
 264         const set<Block *> &blocks = track_chains.get<Block>();
 265         for(set<Block *>::const_iterator i=blocks.begin(); i!=blocks.end(); ++i)
 266                 if((*i)->get_id()==id)
 267                         return **i;
 268
 269         throw key_error(id);
 270 }
 271
 272 void Layout::create_blocks()
 273 {
 274         set<Track *> loose_tracks = objects.get<Track>();
 275         const set<Block *> *blocks = &track_chains.get<Block>();
 276         for(set<Block *>::const_iterator i=blocks->begin(); i!=blocks->end(); ++i)
 277         {
 278                 const set<Track *> &btracks = (*i)->get_tracks();
 279                 for(set<Track *>::const_iterator j=btracks.begin(); j!=btracks.end(); ++j)
 280                         loose_tracks.erase(*j);
 281         }
 282
 283         list<Block *> created_blocks;
 284         while(!loose_tracks.empty())
 285         {
 286                 Block *block = new Block(*this, **loose_tracks.begin());
 287                 created_blocks.push_back(block);
 288
 289                 const set<Track *> &btracks = block->get_tracks();
 290                 for(set<Track *>::const_iterator i=btracks.begin(); i!=btracks.end(); ++i)
 291                         loose_tracks.erase(*i);
 292         }
 293
 294         // The previously obtained set has been invalidated by creating new blocks
 295         blocks = &track_chains.get<Block>();
 296         for(list<Block *>::iterator i=created_blocks.begin(); i!=created_blocks.end(); ++i)
 297                 for(set<Block *>::const_iterator j=blocks->begin(); j!=blocks->end(); ++j)
 298                         if(*j!=*i)
 299                                 (*i)->check_link(**j);
 300 }
 301
 302 void Layout::create_blocks(Track &track)
 303 {
 304         /* Must collect the blocks in a set first while all tracks are still
 305         guaranteed to have blocks and to avoid duplicate deletes */
 306         set<Block *> del_blocks;
 307
 308         del_blocks.insert(&track.get_block());
 309
 310         const vector<Track *> &links = track.get_links();
 311         for(vector<Track *>::const_iterator i=links.begin(); i!=links.end(); ++i)
 312                 if(*i)
 313                         del_blocks.insert(&(*i)->get_block());
 314
 315         for(set<Block *>::iterator i=del_blocks.begin(); i!=del_blocks.end(); ++i)
 316                 delete *i;
 317
 318         create_blocks();
 319 }
 320
 321 Route &Layout::get_route(const string &name) const
 322 {
 323         const set<Route *> &routes = track_chains.get<Route>();
 324         for(set<Route *>::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 325                 if((*i)->get_name()==name)
 326                         return **i;
 327         throw key_error(name);
 328 }
 329
 330 void Layout::update_routes()
 331 {
 332         const set<Route *> &routes = track_chains.get<Route>();
 333         for(set<Route *>::iterator i=routes.begin(); i!=routes.end(); ++i)
 334                 (*i)->update_turnouts();
 335 }
 336
 337 Layout::ZoneArray Layout::get_zones(const string &group) const
 338 {
 339         ZoneArray result;
 340         const set<Zone *> &zones = track_chains.get<Zone>();
 341         for(set<Zone *>::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 342                 if((*i)->get_group()==group)
 343                         result.push_back(*i);
 344
 345         sort(result.begin(), result.end(), zone_order);
 346
 347         return result;
 348 }
 349
 350 Zone &Layout::get_zone(const string &group, unsigned num) const
 351 {
 352         const set<Zone *> &zones = track_chains.get<Zone>();
 353         for(set<Zone *>::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 354                 if((*i)->get_group()==group && (*i)->get_number()==num)
 355                         return **i;
 356
 357         throw key_error(format("%s %d", group, num));
 358 }
 359
 360 void Layout::add_train(Train &t)
 361 {
 362         insert_unique(trains, t.get_address(), &t);
 363         signal_train_added.emit(t);
 364 }
 365
 366 Train &Layout::get_train(unsigned addr) const
 367 {
 368         return *get_item(trains, addr);
 369 }
 370
 371 void Layout::remove_train(Train &t)
 372 {
 373         if(trains.erase(t.get_address()))
 374                 signal_train_removed.emit(t);
 375 }
 376
 377 void Layout::tick()
 378 {
 379         if(driver)
 380                 driver->tick();
 381
 382         Time::TimeStamp t = Time::now();
 383         Time::TimeDelta dt;
 384         if(last_tick)
 385                 dt = t-last_tick;
 386         last_tick = t;
 387
 388         if(!driver || !driver->is_halted())
 389                 clock.tick(dt);
 390
 391         for(set<Sensor *>::iterator i=sensors.get().begin(); i!=sensors.get().end(); ++i)
 392                 (*i)->tick(dt);
 393         const set<Signal *> &signals = objects.get<Signal>();
 394         for(set<Signal *>::iterator i=signals.begin(); i!=signals.end(); ++i)
 395                 (*i)->tick(dt);
 396         for(map<unsigned, Train *>::iterator i=trains.begin(); i!=trains.end(); ++i)
 397                 i->second->tick(dt);
 398 }
 399
 400 void Layout::emergency(Block *block, const string &msg)
 401 {
 402         if(driver)
 403                 driver->halt(true);
 404         if(block)
 405                 IO::print("Emergency at %s: %s\n", block->get_name(), msg);
 406         else
 407                 IO::print("Emergency: %s\n", msg);
 408         signal_emergency.emit(block, msg);
 409 }
 410
 411 void Layout::save(const string &fn) const
 412 {
 413         IO::BufferedFile out(fn, IO::M_WRITE);
 414         DataFile::Writer writer(out);
 415
 416         if(!base.empty())
 417                 writer.write((DataFile::Statement("base"), base));
 418
 419         const set<Track *> &tracks = objects.get<Track>();
 420         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 421         {
 422                 DataFile::Statement st("track");
 423                 st.append(catalogue.get_name(&(*i)->get_type()));
 424                 (*i)->save(st.sub);
 425                 writer.write(st);
 426         }
 427
 428         const set<Signal *> &signals = objects.get<Signal>();
 429         for(set<Signal *>::const_iterator i=signals.begin(); i!=signals.end(); ++i)
 430         {
 431                 DataFile::Statement st("signal");
 432                 st.append(catalogue.get_name(&(*i)->get_type()));
 433                 (*i)->save(st.sub);
 434                 writer.write(st);
 435         }
 436
 437         const set<Terrain *> &terrains = objects.get<Terrain>();
 438         for(set<Terrain *>::const_iterator i=terrains.begin(); i!=terrains.end(); ++i)
 439         {
 440                 DataFile::Statement st("terrain");
 441                 st.append(catalogue.get_name(&(*i)->get_type()));
 442                 (*i)->save(st.sub);
 443                 writer.write(st);
 444         }
 445
 446         const set<BeamGate *> &gates = objects.get<BeamGate>();
 447         for(set<BeamGate *>::const_iterator i=gates.begin(); i!=gates.end(); ++i)
 448         {
 449                 DataFile::Statement st("beamgate");
 450                 (*i)->save(st.sub);
 451                 writer.write(st);
 452         }
 453
 454         const set<Route *> &routes = track_chains.get<Route>();
 455         for(set<Route *>::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 456         {
 457                 if((*i)->is_temporary())
 458                         continue;
 459
 460                 DataFile::Statement st("route");
 461                 (*i)->save(st.sub);
 462                 writer.write(st);
 463         }
 464
 465         const set<Zone *> &zones = track_chains.get<Zone>();
 466         for(set<Zone *>::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 467         {
 468                 DataFile::Statement st("zone");
 469                 (*i)->save(st.sub);
 470                 writer.write(st);
 471         }
 472 }
 473
 474 void Layout::save_dynamic(const string &fn) const
 475 {
 476         IO::BufferedFile out(fn, IO::M_WRITE);
 477         DataFile::Writer writer(out);
 478
 479         {
 480                 DataFile::Statement st("clock");
 481                 clock.save(st.sub);
 482                 writer.write(st);
 483         }
 484
 485         const set<Track *> &tracks = objects.get<Track>();
 486         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 487                 if((*i)->get_type().is_turnout())
 488                         writer.write((DataFile::Statement("turnout"), (*i)->get_turnout_address(), (*i)->get_active_path()));
 489
 490         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 491         {
 492                 DataFile::Statement st("train");
 493                 st.append(catalogue.get_name(&i->second->get_locomotive_type()));
 494                 st.append(i->second->get_address());
 495                 st.append(i->second->get_protocol());
 496                 i->second->save(st.sub);
 497                 writer.write(st);
 498         }
 499 }
 500
 501 void Layout::sensor_state_changed(Sensor &sensor, Sensor::State state)
 502 {
 503         if(state==Sensor::ACTIVE)
 504         {
 505                 Block *block = sensor.get_block();
 506                 if(block && !block->get_train())
 507                         emergency(block, "Unreserved sensor triggered");
 508         }
 509 }
 510
 511
 512 template<typename B>
 513 Layout::Storage<B>::~Storage()
 514 {
 515         while(!base.empty())
 516                 delete *base.begin();
 517 }
 518
 519 template<typename B>
 520 bool Layout::Storage<B>::insert(B &b)
 521 {
 522         bool result = base.insert(&b).second;
 523         if(result)
 524                 caches.clear();
 525         return result;
 526 }
 527
 528 template<typename B>
 529 bool Layout::Storage<B>::erase(B &b)
 530 {
 531         bool result = base.erase(&b);
 532         if(result)
 533                 caches.clear();
 534         return result;
 535 }
 536
 537 template<typename B>
 538 template<typename T>
 539 const set<T *> &Layout::Storage<B>::get() const
 540 {
 541         for(list<Variant>::const_iterator i=caches.begin(); i!=caches.end(); ++i)
 542                 if(i->check_type<set<T *> >())
 543                         return i->value<set<T *> >();
 544
 545         caches.push_back(set<T *>());
 546         set<T *> &result = caches.back().value<set<T *> >();
 547         for(typename set<B *>::const_iterator i=base.begin(); i!=base.end(); ++i)
 548                 if(T *t = dynamic_cast<T *>(*i))
 549                         result.insert(t);
 550
 551         return result;
 552 }
 553
 554 template<typename B>
 555 template<typename T>
 556 void Layout::Storage<B>::del()
 557 {
 558         set<T *> ts = get<T>();
 559         for(typename set<T *>::iterator i=ts.begin(); i!=ts.end(); ++i)
 560                 if(base.count(*i))
 561                         delete *i;
 562 }
 563
 564
 565 Layout::Loader::Loader(Layout &l):
 566         DataFile::ObjectLoader<Layout>(l)
 567 {
 568         add("base",  &Layout::base);
 569         add("beamgate", &Loader::beamgate);
 570         add("clock", &Loader::clock);
 571         add("route", &Loader::route);
 572         add("signal", &Loader::signal);
 573         add("terrain", &Loader::terrain);
 574         add("track", &Loader::track);
 575         add("train", &Loader::train);
 576         add("turnout", &Loader::turnout);
 577         add("zone",  &Loader::zone);
 578 }
 579
 580 void Layout::Loader::beamgate()
 581 {
 582         BeamGate *gate = new BeamGate(obj);
 583         load_sub(*gate);
 584 }
 585
 586 void Layout::Loader::clock()
 587 {
 588         load_sub(obj.clock);
 589 }
 590
 591 void Layout::Loader::route()
 592 {
 593         Route *rte = new Route(obj);
 594         load_sub(*rte);
 595 }
 596
 597 void Layout::Loader::signal(const string &n)
 598 {
 599         Signal *sig = new Signal(obj, obj.catalogue.get<SignalType>(n));
 600         load_sub(*sig);
 601 }
 602
 603 void Layout::Loader::terrain(const string &n)
 604 {
 605         Terrain *ter = new Terrain(obj, obj.catalogue.get<TerrainType>(n));
 606         load_sub(*ter);
 607 }
 608
 609 void Layout::Loader::track(const string &n)
 610 {
 611         Track *trk = new Track(obj, obj.catalogue.get<TrackType>(n));
 612         load_sub(*trk);
 613         const set<Track *> &tracks = obj.objects.get<Track>();
 614         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 615                 if(*i!=trk)
 616                         trk->link_to(**i);
 617 }
 618
 619 void Layout::Loader::train(const string &n, unsigned addr, const std::string &proto)
 620 {
 621         Train *trn = new Train(obj, obj.catalogue.get<VehicleType>(n), addr, proto);
 622         load_sub(*trn);
 623 }
 624
 625 void Layout::Loader::turnout(unsigned addr, unsigned path)
 626 {
 627         if(obj.driver)
 628                 obj.driver->set_turnout(addr, path);
 629 }
 630
 631 void Layout::Loader::zone()
 632 {
 633         Zone *zne = new Zone(obj);
 634         load_sub(*zne);
 635 }
 636
 637 } // namespace R2C2