source/libr2c2/layout.cpp

   1 /* $Id$
   2
   3 This file is part of R²C²
   4 Copyright © 2006-2011  Mikkosoft Productions, Mikko Rasa
   5 Distributed under the GPL
   6 */
   7
   8 #include <algorithm>
   9 #include <msp/core/refptr.h>
  10 #include <msp/datafile/parser.h>
  11 #include <msp/datafile/writer.h>
  12 #include <msp/io/print.h>
  13 #include <msp/time/utils.h>
  14 #include "block.h"
  15 #include "catalogue.h"
  16 #include "driver.h"
  17 #include "layout.h"
  18 #include "route.h"
  19 #include "track.h"
  20 #include "tracktype.h"
  21 #include "train.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_id(0x800)
  44 { }
  45
  46 Layout::~Layout()
  47 {
  48         delete driver;
  49         driver = 0;
  50
  51         while(!trains.empty())
  52                 delete trains.begin()->second;
  53         while(!routes.empty())
  54                 delete *routes.begin();
  55         while(!zones.empty())
  56                 delete *zones.begin();
  57         while(!tracks.empty())
  58                 delete *tracks.begin();
  59         while(!blocks.empty())
  60                 delete *blocks.begin();
  61 }
  62
  63 Driver &Layout::get_driver() const
  64 {
  65         if(!driver)
  66                 throw InvalidState("No driver");
  67         return *driver;
  68 }
  69
  70 void Layout::add_track(Track &t)
  71 {
  72         if(tracks.insert(&t).second)
  73         {
  74                 create_blocks();
  75                 signal_track_added.emit(t);
  76         }
  77 }
  78
  79 void Layout::remove_track(Track &t)
  80 {
  81         if(tracks.erase(&t))
  82         {
  83                 create_blocks(t);
  84                 signal_track_removed.emit(t);
  85         }
  86 }
  87
  88 Track *Layout::pick_track(const Vector &start, const Vector &ray)
  89 {
  90         for(set<Track *>::iterator i=tracks.begin(); i!=tracks.end(); ++i)
  91                 if((*i)->collide_ray(start, ray))
  92                         return *i;
  93
  94         return 0;
  95 }
  96
  97 unsigned Layout::allocate_turnout_id()
  98 {
  99         set<unsigned> used_ids;
 100         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 101                 if((*i)->get_turnout_id())
 102                         used_ids.insert((*i)->get_turnout_id());
 103
 104         unsigned result = next_turnout_id;
 105         while(used_ids.count(result))
 106                 ++result;
 107         next_turnout_id = result+1;
 108
 109         return result;
 110 }
 111
 112 void Layout::add_block(Block &b)
 113 {
 114         blocks.insert(&b);
 115         b.signal_reserved.connect(sigc::bind<0>(signal_block_reserved, sigc::ref(b)));
 116         if(b.get_sensor_id())
 117         {
 118                 b.signal_state_changed.connect(sigc::bind<0>(sigc::mem_fun(this, &Layout::block_state_changed), sigc::ref(b)));
 119                 b.signal_state_changed.connect(sigc::bind<0>(signal_block_state_changed, sigc::ref(b)));
 120         }
 121 }
 122
 123 Block &Layout::get_block(unsigned id) const
 124 {
 125         for(set<Block *>::const_iterator i=blocks.begin(); i!=blocks.end(); ++i)
 126                 if((*i)->get_id()==id)
 127                         return **i;
 128
 129         throw KeyError("Unknown block", lexical_cast(id));
 130 }
 131
 132 void Layout::create_blocks()
 133 {
 134         set<Track *> used_tracks;
 135         for(set<Block *>::const_iterator i=blocks.begin(); i!=blocks.end(); ++i)
 136         {
 137                 const set<Track *> &btracks = (*i)->get_tracks();
 138                 used_tracks.insert(btracks.begin(), btracks.end());
 139         }
 140
 141         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 142                 if(used_tracks.count(*i)==0)
 143                 {
 144                         Block *block = new Block(*this, **i);
 145                         used_tracks.insert(block->get_tracks().begin(), block->get_tracks().end());
 146                 }
 147
 148         for(set<Block *>::iterator i=blocks.begin(); i!=blocks.end(); ++i)
 149                 for(set<Block *>::iterator j=i; j!=blocks.end(); ++j)
 150                         if(j!=i)
 151                                 (*i)->check_link(**j);
 152 }
 153
 154 void Layout::create_blocks(Track &track)
 155 {
 156         /* Must collect the blocks in a set first while all tracks are still
 157         guaranteed to have blocks and to avoid duplicate deletes */
 158         set<Block *> del_blocks;
 159
 160         del_blocks.insert(&track.get_block());
 161
 162         const vector<Track *> &links = track.get_links();
 163         for(vector<Track *>::const_iterator i=links.begin(); i!=links.end(); ++i)
 164                 if(*i)
 165                         del_blocks.insert(&(*i)->get_block());
 166
 167         for(set<Block *>::iterator i=del_blocks.begin(); i!=del_blocks.end(); ++i)
 168                 delete *i;
 169
 170         create_blocks();
 171 }
 172
 173 void Layout::remove_block(Block &b)
 174 {
 175         blocks.erase(&b);
 176 }
 177
 178 void Layout::add_route(Route &r)
 179 {
 180         if(routes.insert(&r).second)
 181                 signal_route_added.emit(r);
 182 }
 183
 184 Route &Layout::get_route(const string &name) const
 185 {
 186         for(set<Route *>::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 187                 if((*i)->get_name()==name)
 188                         return **i;
 189         throw KeyError("Unknown route", name);
 190 }
 191
 192 void Layout::update_routes()
 193 {
 194         for(set<Route *>::iterator i=routes.begin(); i!=routes.end(); ++i)
 195                 (*i)->update_turnouts();
 196 }
 197
 198 void Layout::remove_route(Route &r)
 199 {
 200         if(routes.erase(&r))
 201                 signal_route_removed.emit(r);
 202 }
 203
 204 void Layout::add_zone(Zone &z)
 205 {
 206         if(zones.insert(&z).second)
 207                 signal_zone_added.emit(z);
 208 }
 209
 210 Layout::ZoneArray Layout::get_zones(const string &group) const
 211 {
 212         ZoneArray result;
 213         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 214                 if((*i)->get_group()==group)
 215                         result.push_back(*i);
 216
 217         sort(result.begin(), result.end(), zone_order);
 218
 219         return result;
 220 }
 221
 222 Zone &Layout::get_zone(const string &group, unsigned num) const
 223 {
 224         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 225                 if((*i)->get_group()==group && (*i)->get_number()==num)
 226                         return **i;
 227
 228         throw KeyError("Unknown zone", format("%s %d", group, num));
 229 }
 230
 231 void Layout::remove_zone(Zone &z)
 232 {
 233         if(zones.erase(&z))
 234                 signal_zone_removed.emit(z);
 235 }
 236
 237 void Layout::add_train(Train &t)
 238 {
 239         if(trains.count(t.get_address()))
 240                 throw KeyError("Duplicate train address", lexical_cast(t.get_address()));
 241
 242         trains[t.get_address()] = &t;
 243         signal_train_added.emit(t);
 244 }
 245
 246 Train &Layout::get_train(unsigned addr) const
 247 {
 248         map<unsigned, Train *>::const_iterator i = trains.find(addr);
 249         if(i==trains.end())
 250                 throw KeyError("Unknown train", lexical_cast(addr));
 251         return *i->second;
 252 }
 253
 254 void Layout::remove_train(Train &t)
 255 {
 256         if(trains.erase(t.get_address()))
 257                 signal_train_removed.emit(t);
 258 }
 259
 260 void Layout::add_vehicle(Vehicle &v)
 261 {
 262         if(vehicles.insert(&v).second)
 263                 signal_vehicle_added.emit(v);
 264 }
 265
 266 void Layout::remove_vehicle(Vehicle &v)
 267 {
 268         if(vehicles.erase(&v))
 269                 signal_vehicle_removed.emit(v);
 270 }
 271
 272 void Layout::tick()
 273 {
 274         if(driver)
 275                 driver->tick();
 276
 277         Time::TimeStamp t = Time::now();
 278         Time::TimeDelta dt;
 279         if(last_tick)
 280                 dt = t-last_tick;
 281         last_tick = t;
 282
 283         for(set<Block *>::iterator i=blocks.begin(); i!=blocks.end(); ++i)
 284                 (*i)->tick(dt);
 285         for(map<unsigned, Train *>::iterator i=trains.begin(); i!=trains.end(); ++i)
 286                 i->second->tick(t, dt);
 287 }
 288
 289 void Layout::emergency(const string &msg)
 290 {
 291         if(driver)
 292                 driver->halt(true);
 293         IO::print("Emergency: %s\n", msg);
 294         signal_emergency.emit(msg);
 295 }
 296
 297 void Layout::save(const string &fn) const
 298 {
 299         IO::BufferedFile out(fn, IO::M_WRITE);
 300         DataFile::Writer writer(out);
 301
 302         if(!base.empty())
 303                 writer.write((DataFile::Statement("base"), base));
 304
 305         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 306         {
 307                 DataFile::Statement st("track");
 308                 st.append((*i)->get_type().get_article_number());
 309                 (*i)->save(st.sub);
 310                 writer.write(st);
 311         }
 312
 313         for(set<Route *>::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 314         {
 315                 if((*i)->is_temporary())
 316                         continue;
 317
 318                 DataFile::Statement st("route");
 319                 (*i)->save(st.sub);
 320                 writer.write(st);
 321         }
 322
 323         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 324         {
 325                 DataFile::Statement st("zone");
 326                 (*i)->save(st.sub);
 327                 writer.write(st);
 328         }
 329 }
 330
 331 void Layout::save_dynamic(const string &fn) const
 332 {
 333         IO::BufferedFile out(fn, IO::M_WRITE);
 334         DataFile::Writer writer(out);
 335
 336         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 337                 if(unsigned tid = (*i)->get_turnout_id())
 338                         writer.write((DataFile::Statement("turnout"), tid, (*i)->get_active_path()));
 339
 340         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 341         {
 342                 DataFile::Statement st("train");
 343                 st.append(i->second->get_locomotive_type().get_article_number());
 344                 st.append(i->second->get_address());
 345                 st.append(i->second->get_protocol());
 346                 i->second->save(st.sub);
 347                 writer.write(st);
 348         }
 349 }
 350
 351 void Layout::block_state_changed(Block &block, Block::State state)
 352 {
 353         if(state==Block::ACTIVE && !block.get_train())
 354                 emergency(format("Unreserved sensor %d triggered", block.get_sensor_id()));
 355 }
 356
 357
 358 Layout::Loader::Loader(Layout &l):
 359         DataFile::BasicLoader<Layout>(l),
 360         new_tracks(false)
 361 {
 362         add("base",  &Layout::base);
 363         add("route", static_cast<void (Loader::*)()>(&Loader::route));
 364         add("track", static_cast<void (Loader::*)(ArticleNumber)>(&Loader::track));
 365         add("train", static_cast<void (Loader::*)(ArticleNumber, unsigned, const std::string &)>(&Loader::train));
 366         add("turnout", &Loader::turnout);
 367         add("zone",  &Loader::zone);
 368
 369         // Deprecated aliases
 370         add("route", static_cast<void (Loader::*)(const string &)>(&Loader::route));
 371         add("track", static_cast<void (Loader::*)(unsigned)>(&Loader::track));
 372         add("train", static_cast<void (Loader::*)(unsigned, unsigned, const std::string &)>(&Loader::train));
 373 }
 374
 375 void Layout::Loader::finish()
 376 {
 377         for(set<Track *>::iterator i=obj.tracks.begin(); i!=obj.tracks.end(); ++i)
 378                 (*i)->check_slope();
 379 }
 380
 381 void Layout::Loader::route()
 382 {
 383         Route *rte = new Route(obj);
 384         load_sub(*rte);
 385 }
 386
 387 void Layout::Loader::route(const string &n)
 388 {
 389         Route *rte = new Route(obj);
 390         rte->set_name(n);
 391         load_sub(*rte);
 392 }
 393
 394 void Layout::Loader::track(unsigned art_nr)
 395 {
 396         track(ArticleNumber(art_nr));
 397 }
 398
 399 void Layout::Loader::track(ArticleNumber art_nr)
 400 {
 401         Track *trk = new Track(obj, obj.catalogue.get_track(art_nr));
 402         load_sub(*trk);
 403         new_tracks = true;
 404         for(set<Track *>::iterator i=obj.tracks.begin(); i!=obj.tracks.end(); ++i)
 405                 if(*i!=trk)
 406                         trk->snap_to(**i, true);
 407 }
 408
 409 void Layout::Loader::train(unsigned art_nr, unsigned addr, const std::string &proto)
 410 {
 411         train(ArticleNumber(art_nr), addr, proto);
 412 }
 413
 414 void Layout::Loader::train(ArticleNumber art_nr, unsigned addr, const std::string &proto)
 415 {
 416         Train *trn = new Train(obj, obj.catalogue.get_vehicle(art_nr), addr, proto);
 417         load_sub(*trn);
 418 }
 419
 420 void Layout::Loader::turnout(unsigned addr, unsigned path)
 421 {
 422         if(obj.driver)
 423                 obj.driver->set_turnout(addr, path);
 424 }
 425
 426 void Layout::Loader::zone()
 427 {
 428         Zone *zne = new Zone(obj);
 429         load_sub(*zne);
 430 }
 431
 432 } // namespace R2C2