]> git.tdb.fi Git - r2c2.git/blob - source/libr2c2/layout.cpp
Reduce interface clutter in Layout by storing Objects in a uniform way
[r2c2.git] / 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 "block.h"
9 #include "catalogue.h"
10 #include "driver.h"
11 #include "layout.h"
12 #include "route.h"
13 #include "signal.h"
14 #include "signaltype.h"
15 #include "track.h"
16 #include "trackcircuit.h"
17 #include "tracktype.h"
18 #include "train.h"
19 #include "vehicle.h"
20 #include "vehicletype.h"
21 #include "zone.h"
22
23 using namespace std;
24 using namespace Msp;
25
26 namespace {
27
28 bool zone_order(const R2C2::Zone *z1, const R2C2::Zone *z2)
29 {
30         return z1->get_number()<z2->get_number();
31 }
32
33 }
34
35
36 namespace R2C2 {
37
38 Layout::Layout(Catalogue &c, Driver *d):
39         catalogue(c),
40         driver(d),
41         next_turnout_id(0x800)
42 { }
43
44 Layout::~Layout()
45 {
46         delete driver;
47         driver = 0;
48
49         while(!trains.empty())
50                 delete trains.begin()->second;
51         while(!routes.empty())
52                 delete *routes.begin();
53         while(!zones.empty())
54                 delete *zones.begin();
55         objects.del<Signal>();
56         objects.del<Track>();
57         while(!blocks.empty())
58                 delete *blocks.begin();
59 }
60
61 Driver &Layout::get_driver() const
62 {
63         if(!driver)
64                 throw logic_error("!driver");
65         return *driver;
66 }
67
68 void Layout::add(Object &o)
69 {
70         if(objects.insert(o))
71                 signal_object_added.emit(o);
72 }
73
74 void Layout::add(Track &t)
75 {
76         if(objects.insert(t))
77         {
78                 // Blocks must be recreated first
79                 create_blocks();
80                 signal_object_added.emit(t);
81         }
82 }
83
84 template<>
85 const set<Object *> &Layout::get_all<Object>() const
86 {
87         return objects.get();
88 }
89
90 template<>
91 const set<Track *> &Layout::get_all<Track>() const
92 {
93         return objects.get<Track>();
94 }
95
96 template<>
97 const set<Signal *> &Layout::get_all<Signal>() const
98 {
99         return objects.get<Signal>();
100 }
101
102 template<>
103 const set<Vehicle *> &Layout::get_all<Vehicle>() const
104 {
105         return objects.get<Vehicle>();
106 }
107
108 template<typename T>
109 T *Layout::pick(const Ray &ray)
110 {
111         const set<Object *> &objs = objects.get();
112         for(set<Object *>::const_iterator i=objs.begin(); i!=objs.end(); ++i)
113                 if(T *t = dynamic_cast<T *>(*i))
114                         if(t->collide_ray(ray))
115                                 return t;
116
117         return 0;
118 }
119
120 template Object *Layout::pick<Object>(const Ray &);
121 template Track *Layout::pick<Track>(const Ray &);
122 template Signal *Layout::pick<Signal>(const Ray &);
123 template Vehicle *Layout::pick<Vehicle>(const Ray &);
124
125 void Layout::remove(Object &o)
126 {
127         if(objects.erase(o))
128                 signal_object_removed.emit(o);
129 }
130
131 void Layout::remove(Track &t)
132 {
133         if(objects.erase(t))
134         {
135                 // Blocks must be recreated first
136                 create_blocks(t);
137                 signal_object_removed.emit(t);
138         }
139 }
140
141 unsigned Layout::allocate_turnout_id()
142 {
143         set<unsigned> used_ids;
144         const set<Track *> &tracks = objects.get<Track>();
145         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
146                 if((*i)->get_turnout_id())
147                         used_ids.insert((*i)->get_turnout_id());
148
149         unsigned result = next_turnout_id;
150         while(used_ids.count(result))
151                 ++result;
152         next_turnout_id = result+1;
153
154         return result;
155 }
156
157 void Layout::add_block(Block &b)
158 {
159         blocks.insert(&b);
160         b.signal_reserved.connect(sigc::bind<0>(signal_block_reserved, sigc::ref(b)));
161 }
162
163 Block &Layout::get_block(unsigned id) const
164 {
165         for(set<Block *>::const_iterator i=blocks.begin(); i!=blocks.end(); ++i)
166                 if((*i)->get_id()==id)
167                         return **i;
168
169         throw key_error(id);
170 }
171
172 void Layout::create_blocks()
173 {
174         set<Track *> used_tracks;
175         for(set<Block *>::const_iterator i=blocks.begin(); i!=blocks.end(); ++i)
176         {
177                 const set<Track *> &btracks = (*i)->get_tracks();
178                 used_tracks.insert(btracks.begin(), btracks.end());
179         }
180
181         const set<Track *> &tracks = objects.get<Track>();
182         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
183                 if(used_tracks.count(*i)==0)
184                 {
185                         Block *block = new Block(*this, **i);
186                         used_tracks.insert(block->get_tracks().begin(), block->get_tracks().end());
187                 }
188
189         for(set<Block *>::iterator i=blocks.begin(); i!=blocks.end(); ++i)
190                 for(set<Block *>::iterator j=i; j!=blocks.end(); ++j)
191                         if(j!=i)
192                                 (*i)->check_link(**j);
193 }
194
195 void Layout::create_blocks(Track &track)
196 {
197         /* Must collect the blocks in a set first while all tracks are still
198         guaranteed to have blocks and to avoid duplicate deletes */
199         set<Block *> del_blocks;
200
201         del_blocks.insert(&track.get_block());
202
203         const vector<Track *> &links = track.get_links();
204         for(vector<Track *>::const_iterator i=links.begin(); i!=links.end(); ++i)
205                 if(*i)
206                         del_blocks.insert(&(*i)->get_block());
207
208         for(set<Block *>::iterator i=del_blocks.begin(); i!=del_blocks.end(); ++i)
209                 delete *i;
210
211         create_blocks();
212 }
213
214 void Layout::remove_block(Block &b)
215 {
216         blocks.erase(&b);
217 }
218
219 void Layout::add_route(Route &r)
220 {
221         if(routes.insert(&r).second)
222                 signal_route_added.emit(r);
223 }
224
225 Route &Layout::get_route(const string &name) const
226 {
227         for(set<Route *>::const_iterator i=routes.begin(); i!=routes.end(); ++i)
228                 if((*i)->get_name()==name)
229                         return **i;
230         throw key_error(name);
231 }
232
233 void Layout::update_routes()
234 {
235         for(set<Route *>::iterator i=routes.begin(); i!=routes.end(); ++i)
236                 (*i)->update_turnouts();
237 }
238
239 void Layout::remove_route(Route &r)
240 {
241         if(routes.erase(&r))
242                 signal_route_removed.emit(r);
243 }
244
245 void Layout::add_zone(Zone &z)
246 {
247         if(zones.insert(&z).second)
248                 signal_zone_added.emit(z);
249 }
250
251 Layout::ZoneArray Layout::get_zones(const string &group) const
252 {
253         ZoneArray result;
254         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
255                 if((*i)->get_group()==group)
256                         result.push_back(*i);
257
258         sort(result.begin(), result.end(), zone_order);
259
260         return result;
261 }
262
263 Zone &Layout::get_zone(const string &group, unsigned num) const
264 {
265         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
266                 if((*i)->get_group()==group && (*i)->get_number()==num)
267                         return **i;
268
269         throw key_error(format("%s %d", group, num));
270 }
271
272 void Layout::remove_zone(Zone &z)
273 {
274         if(zones.erase(&z))
275                 signal_zone_removed.emit(z);
276 }
277
278 void Layout::add_train(Train &t)
279 {
280         insert_unique(trains, t.get_address(), &t);
281         signal_train_added.emit(t);
282 }
283
284 Train &Layout::get_train(unsigned addr) const
285 {
286         return *get_item(trains, addr);
287 }
288
289 void Layout::remove_train(Train &t)
290 {
291         if(trains.erase(t.get_address()))
292                 signal_train_removed.emit(t);
293 }
294
295 void Layout::add_sensor(Sensor &s)
296 {
297         if(sensors.insert(&s).second)
298         {
299                 s.signal_state_changed.connect(sigc::bind<0>(sigc::mem_fun(this, &Layout::sensor_state_changed), sigc::ref(s)));
300                 s.signal_state_changed.connect(sigc::bind<0>(signal_sensor_state_changed, sigc::ref(s)));
301         }
302 }
303
304 void Layout::remove_sensor(Sensor &s)
305 {
306         sensors.erase(&s);
307 }
308
309 void Layout::tick()
310 {
311         if(driver)
312                 driver->tick();
313
314         Time::TimeStamp t = Time::now();
315         Time::TimeDelta dt;
316         if(last_tick)
317                 dt = t-last_tick;
318         last_tick = t;
319
320         for(set<Sensor *>::iterator i=sensors.begin(); i!=sensors.end(); ++i)
321                 (*i)->tick(dt);
322         const set<Signal *> &signals = objects.get<Signal>();
323         for(set<Signal *>::iterator i=signals.begin(); i!=signals.end(); ++i)
324                 (*i)->tick(dt);
325         for(map<unsigned, Train *>::iterator i=trains.begin(); i!=trains.end(); ++i)
326                 i->second->tick(t, dt);
327 }
328
329 void Layout::emergency(const string &msg)
330 {
331         if(driver)
332                 driver->halt(true);
333         IO::print("Emergency: %s\n", msg);
334         signal_emergency.emit(msg);
335 }
336
337 void Layout::save(const string &fn) const
338 {
339         IO::BufferedFile out(fn, IO::M_WRITE);
340         DataFile::Writer writer(out);
341
342         if(!base.empty())
343                 writer.write((DataFile::Statement("base"), base));
344
345         const set<Track *> &tracks = objects.get<Track>();
346         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
347         {
348                 DataFile::Statement st("track");
349                 st.append((*i)->get_type().get_article_number());
350                 (*i)->save(st.sub);
351                 writer.write(st);
352         }
353
354         const set<Signal *> &signals = objects.get<Signal>();
355         for(set<Signal *>::const_iterator i=signals.begin(); i!=signals.end(); ++i)
356         {
357                 DataFile::Statement st("signal");
358                 st.append((*i)->get_type().get_article_number());
359                 (*i)->save(st.sub);
360                 writer.write(st);
361         }
362
363         for(set<Route *>::const_iterator i=routes.begin(); i!=routes.end(); ++i)
364         {
365                 if((*i)->is_temporary())
366                         continue;
367
368                 DataFile::Statement st("route");
369                 (*i)->save(st.sub);
370                 writer.write(st);
371         }
372
373         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
374         {
375                 DataFile::Statement st("zone");
376                 (*i)->save(st.sub);
377                 writer.write(st);
378         }
379 }
380
381 void Layout::save_dynamic(const string &fn) const
382 {
383         IO::BufferedFile out(fn, IO::M_WRITE);
384         DataFile::Writer writer(out);
385
386         const set<Track *> &tracks = objects.get<Track>();
387         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
388                 if(unsigned tid = (*i)->get_turnout_id())
389                         writer.write((DataFile::Statement("turnout"), tid, (*i)->get_active_path()));
390
391         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
392         {
393                 DataFile::Statement st("train");
394                 st.append(i->second->get_locomotive_type().get_article_number());
395                 st.append(i->second->get_address());
396                 st.append(i->second->get_protocol());
397                 i->second->save(st.sub);
398                 writer.write(st);
399         }
400 }
401
402 void Layout::sensor_state_changed(Sensor &sensor, Sensor::State state)
403 {
404         if(state==Sensor::ACTIVE)
405         {
406                 Block *block = 0;
407                 if(TrackCircuit *tc = dynamic_cast<TrackCircuit *>(&sensor))
408                         block = &tc->get_block();
409
410                 if(block && !block->get_train())
411                         emergency(format("Unreserved sensor %d triggered", sensor.get_address()));
412         }
413 }
414
415
416 template<typename B>
417 Layout::Storage<B>::~Storage()
418 {
419         while(!base.empty())
420                 delete *base.begin();
421 }
422
423 template<typename B>
424 bool Layout::Storage<B>::insert(B &b)
425 {
426         bool result = base.insert(&b).second;
427         if(result)
428                 caches.clear();
429         return result;
430 }
431
432 template<typename B>
433 bool Layout::Storage<B>::erase(B &b)
434 {
435         bool result = base.erase(&b);
436         if(result)
437                 caches.clear();
438         return result;
439 }
440
441 template<typename B>
442 template<typename T>
443 const set<T *> &Layout::Storage<B>::get() const
444 {
445         for(list<Variant>::const_iterator i=caches.begin(); i!=caches.end(); ++i)
446                 if(i->check_type<set<T *> >())
447                         return i->value<set<T *> >();
448
449         caches.push_back(set<T *>());
450         set<T *> &result = caches.back().value<set<T *> >();
451         for(typename set<B *>::const_iterator i=base.begin(); i!=base.end(); ++i)
452                 if(T *t = dynamic_cast<T *>(*i))
453                         result.insert(t);
454
455         return result;
456 }
457
458 template<typename B>
459 template<typename T>
460 void Layout::Storage<B>::del()
461 {
462         set<T *> ts = get<T>();
463         for(typename set<T *>::iterator i=ts.begin(); i!=ts.end(); ++i)
464                 if(base.count(*i))
465                         delete *i;
466 }
467
468
469 Layout::Loader::Loader(Layout &l):
470         DataFile::ObjectLoader<Layout>(l),
471         new_tracks(false)
472 {
473         add("base",  &Layout::base);
474         add("route", static_cast<void (Loader::*)()>(&Loader::route));
475         add("signal", &Loader::signal);
476         add("track", static_cast<void (Loader::*)(ArticleNumber)>(&Loader::track));
477         add("train", static_cast<void (Loader::*)(ArticleNumber, unsigned, const std::string &)>(&Loader::train));
478         add("turnout", &Loader::turnout);
479         add("zone",  &Loader::zone);
480
481         // Deprecated aliases
482         add("route", static_cast<void (Loader::*)(const string &)>(&Loader::route));
483         add("track", static_cast<void (Loader::*)(unsigned)>(&Loader::track));
484         add("train", static_cast<void (Loader::*)(unsigned, unsigned, const std::string &)>(&Loader::train));
485 }
486
487 void Layout::Loader::route()
488 {
489         Route *rte = new Route(obj);
490         load_sub(*rte);
491 }
492
493 void Layout::Loader::route(const string &n)
494 {
495         Route *rte = new Route(obj);
496         rte->set_name(n);
497         load_sub(*rte);
498 }
499
500 void Layout::Loader::signal(ArticleNumber art_nr)
501 {
502         Signal *sig = new Signal(obj, obj.catalogue.get_signal(art_nr));
503         load_sub(*sig);
504 }
505
506 void Layout::Loader::track(unsigned art_nr)
507 {
508         track(ArticleNumber(art_nr));
509 }
510
511 void Layout::Loader::track(ArticleNumber art_nr)
512 {
513         Track *trk = new Track(obj, obj.catalogue.get_track(art_nr));
514         load_sub(*trk);
515         new_tracks = true;
516         const set<Track *> &tracks = obj.objects.get<Track>();
517         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
518                 if(*i!=trk)
519                         trk->link_to(**i);
520 }
521
522 void Layout::Loader::train(unsigned art_nr, unsigned addr, const std::string &proto)
523 {
524         train(ArticleNumber(art_nr), addr, proto);
525 }
526
527 void Layout::Loader::train(ArticleNumber art_nr, unsigned addr, const std::string &proto)
528 {
529         Train *trn = new Train(obj, obj.catalogue.get_vehicle(art_nr), addr, proto);
530         load_sub(*trn);
531 }
532
533 void Layout::Loader::turnout(unsigned addr, unsigned path)
534 {
535         if(obj.driver)
536                 obj.driver->set_turnout(addr, path);
537 }
538
539 void Layout::Loader::zone()
540 {
541         Zone *zne = new Zone(obj);
542         load_sub(*zne);
543 }
544
545 } // namespace R2C2