Some refactoring in preparation for UI persistence

Remove some unnecessary proxy functions

Minor adjustments to UI code

Move user interface code to its own class

Add a dialog and necessary support code to display departures

Set delay to zero before emitting signal_departed

Handle the case of a train being late

Send it on its next trip after a short fixed delay instead of waiting
for the next day.

Move the responsibility of starting the train to TrainRouter

This avoids any further sync problems with the planner, accounts for
irregular situations and also makes more sense.

Add two new telemetry values to the arducontrol driver

Keep UI better in sync with the clock

Sync timetable on clock discontinuity

Use add_argument instead of get_args

Add an option to set simulation speed

Useful for testing long timetables.  Will cause problems if used with a
physical layout; currently there are no checks to prevent it.

Limit timestep to 10 milliseconds

The simulation still has some problems with detriggering sensors if a
train advances too much during a step.  This should alleviate the issue.

Allow zones with no qualifier or no number

Avoid unnecessary wait time with shared destinations

If a train gets blocked by another train which has already arrived but
has a trip duration, a step must be processed when the blocking train
departs again.  Otherwise the next step might be a long time off (in case
all other trains have long departure delays) and would get an overly
inflated cost.

Avoid negative values of wait_time

Add missing initializer

Tweak the picking of the next train to process

If a train just became unblocked, it should be considered for picking
immediately.

Fix handling of trains that are becoming blocked

Penalize running against the preferred direction when planning routes

Cosmetic tweaks

Add explicit typecast to avoid infinite recursion

Give zones a preferred running direction

It's also reflected in tracks as a preferred exit endpoint to avoid
having to look up zones while routing.  Weird things may happen if a
track belongs to multiple zones.

Add a using statement for get_end in Zone

The virtual function declaration hides the other overload if it's not
explicitly brought in.

Retain addresses of previously seen locomotives

It may happen that a locomotive gets re-enumerated, e.g. after visiting
another layout.  Since they are identified by their address, it's useful
to keep the same address.

Read MFX locomotive name

Rewrite goal initialization for TrainRouteMetric

The previous code incorrectly added all tracks as goals when a direction
was specified, instead of only the ends.  This caused cost estimate creep
in the route planner, resulting in suboptimal performance.

Use cached path length from occupied_tracks

TrackType::get_path_length is not only a function call but also loops
through all parts to calculate the length.

Fix a problem with estimated remaining distance in route planner

The front of the occupied tracks list contains the length of the chosen
path on the current track and needs to be updated when the path changes.

Follow the same path until another is significantly better

This replaces the cost penalty for routing steps.  In the penalty approach
it was possible to get two or more steps with the same penalty, which
would then race with each other.  In the new approach, all other steps are
sorted by their unpenalized cost and only the preferred one gets special
treatment.

Consider train length when calculating wait time estimate

This allows also estimating wait time when a train is blocked.

Reset wait time estimate when the train starts moving again

Just in case the estimate was too high.

Add an actual heuristic for wait time

Don't go past end of allocation when checking blocks for a signal

Don't clear current_sequence in set_route

It may be still needed by routers of other trains.

Robustify sequence handling while applying route plans

Setting current_sequence of all participating routers to zero beforehand
will make sequence points involving them not cleared and avoid the need
to special case everything.

Only schedule a sequence check if we're waiting at a sequence point

Combine the sequence_check_pending flag with state

Sprinkle some comments on the routing system

Don't bother with creating intermediate steps for state updates

They were needed back when the wait system was different, but no longer
have any use.

Clear the critical flag one track earlier

Check_arrival is called when the train reaches the end of its current
track.  The flag should be cleared when the track it is entering is no
longer critical.

Move duplicated successor step creation code to a function

Allow direction to be specified for routing waypoints

Support directionality for zones

Store zone blocks in order and use add_tracks to load them

Don't save an allocated but pending block

It could be a failed turnout which is still set the wrong way.

Cosmetic fixes

Don't attempt to use planned route if no waypoints are set

Initialize the halted flag of dummy driver

Add a dialog to display telemetry data from the driver

Add a common base class for dialogs that need to update dynamically

Use deque rather than list for queues

List makes one allocation for every item, deque only one per a bunch of
items.

Provide some telemetry values from ArduControl

Add telemetry framework for drivers

Improve ArduControl task scheduling

The new scheduler can handle multiple tasks with the same priority, so
other things won't get blocked by the priority command queue for too
long.  It also handles sleeping at the scheduler rather than individual
tasks.

Turn ArduControl command_queue into a Task

It seems that I was thinking of this back in d5d8ee8, but left it
unfinished probably because it was simpler to use a Queue directly.  Now
some upcoming task management improvements call for it to be a Task.

Don't check sequence points while applying routes

The preceding train's routes might not be applied yet.  Instead queue a
sequence check to be done when all routes have been applied.

Correct TrackAttachment entry endpoint

Since endpoint direction points outwards from the endpoint, we want to
find one that's as close to opposite to the TrackAttachment's direction
as possible.

Also check if the clock is stopped

Don't eat away departure delay while halted

Don't segfault if an emergency doesn't have a block

Declare emergency if route planning fails

Abort route planning if it takes too long

Be more permissive when checking route continuity

In some cases more than one consecutive route may end on the same track,
or a route might only go one track past the previous one, with that track
being a turnout with undetermined path.  Allow skipping routes to deal
with these situations, as long as we don't go completely off route.

Ensure that remaining estimate is negative if the waypoint is unreachable

Fix critical block logic

First noncritical block is not reliable, as it could be outside of the
train's allocated blocks and not guaranteed to set to a consistent path.
Worse, the get_first_noncritical_block function could return a block on
the other side of a turnout which is changing path, and is_block_critical
used completely different logic.

Don't allow trains to become blocked in critical blocks

Avoid arriving too early if there's an unexpected stop on the last route

If the final block of the route is allocated while the train is stopped,
arrival could be triggered prematurely.  I'm not entirely certain if this
can happen in absence of certain quirks of the dummy driver, but better
safe than sorry.

Better sequence syncing on route change

Immediately go into the wait state if an uncleared sequence point is
encountered during sync.

Apply all planned routes at once

Letting each router to do it separately in the tick function causes
certain problems with synchronization.  In particular, sequence points
are difficult to synchronize unless the route update is atomic.

Add turnout failure simulation to the dummy driver

Eliminate an unnecessary variable

Unify destination and waypoints

Destination is really just a special case of a waypoint, so there's no
point in keeping it separate.  It just adds duplicated logic, which was
about to get worse with some upcoming new features.

Do not allocate blocks while halt is in effect

A turnout state change signal is emitted even if a failure is detected,
to indicate the end of the operation.  Resuming allocation in such a case
would cause the train to stray to an incorrect path.  It's better to wait
until the user has resolved the situation and removed the halt state.

Use a shared white material for techniques

Instantly set turnout paths when loading state

Vehicles are placed immediately and will follow turnout paths.  Having
them in the wrong places confuses the route planner.

Move block reservation signal serialization to Layout

It needs to be serialized between different blocks as well, since
TrainRouter at least expects to receive the signals in order.

Initialize clock rate field with the current rate

Interpret turnout delay as float, not unsigned

Cosmetic fixes

Use max/min for range capping

Sync timetable to clock on first tick

This is not perfect, but it allows some flexibility in restarting the
program.

Make sure Block::signal_reserved is emitted consistently

Sigc++ apparently takes arguments as references, so if someone reached to
a signal with null train by reserving the block again, any remaining slots
of the release emission would also get the new train pointer.  This caused
the routing system to malfunction in certain cases as the router saw two
emissions for the same block reservation.

The simplest solution would be to pass t instead of train to emit(), but
then the ordering of the two emissions would be inconsistent.  Thus the
additional logic to delay further emissions until the outstanding one is
completed.

Consider block deallocation when planning routes

Blocks are not released until a sensor is detriggered.  Not taking that
into account could cause situations where the planner tries to drive
trains through a balloon loop which is actually too small for them.

Further improve lead route generation

The previous version generated nonsense if the first actual route was
completely covered by existing critical blocks.

Immediately process sequence points that are already covered

The planner starts from the front buffer of the train, so it may generate
sequence points in the existing critical blocks.

Don't diverge from critical blocks

Doing so could confuse the router.

Improve metrics_stale flag handling

Eliminate a possible race condition in thread termination

In the unlikely event that the thread doesn't terminate fast enough after
setting the goal pointer, deleting it would send it a kill signal.
Remove this possibility by explicitly jouning the thread.

Allow an undetermined turnout at the beginning of a route

If route plans are regenerated when the train's last vehicle is on the
sensor following a turnout in a points-facing movement, the first track
of the lead route is a turnout with undetermined path.  Route_changed
would then try to figure out which route the next allocation will occur
on and fail at the very beginning because advance_to_track refused to
use the undetermined turnout.

Restructure lead route generation

All of the relevant logic is now in one place.

Don't access waypoint and metric data if the router has no destination

Don't use bool for a counter variable

Penalize steps other than the fastest one

This encourages the planner to follow a single chain of steps and avoids
exploding the state tree too much.  In the future this may be replaced by
different speed limits on diverging paths of turnouts (reducing the
ambiguity of fastest path) and an actual heuristic for potential wait time
(giving wait states an implicit penalty).

Store routing information in TrainRoutePlanner to avoid threading problems

TrainRouter removes checkpoints when the train passes them, which will
cause problems if the planner is still running.

Resume allocation if a train moves out of its own way

The normal handling in block_reserved() does not work, since by that time
release_block() has already cleared pending_block.

Unoccupy destination during planning when the train has departed again

Eliminate the one step delay in adding tracks to routes

It is no longer necessary now that we inspect linked tracks to detect
loops.  Removing it makes the logic easier to understand.

Make route planning threaded

It can take several seconds in some cases, which would cause an
unacceptable pause in simulation and control.