source/libr2c2/layout.cpp

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