station.cpp

Go to the documentation of this file.

/* $Id: station.cpp 14919 2009-01-08 16:35:45Z rubidium $ */

#include "stdafx.h"
#include "openttd.h"
#include "bridge_map.h"
#include "debug.h"
#include "station_map.h"
#include "station_base.h"
#include "town.h"
#include "company_func.h"
#include "airport.h"
#include "sprite.h"
#include "train.h"
#include "water_map.h"
#include "industry_map.h"
#include "newgrf_callbacks.h"
#include "newgrf_station.h"
#include "yapf/yapf.h"
#include "cargotype.h"
#include "roadveh.h"
#include "window_type.h"
#include "station_gui.h"
#include "zoom_func.h"
#include "functions.h"
#include "window_func.h"
#include "date_func.h"
#include "variables.h"
#include "settings_type.h"
#include "command_func.h"
#include "order_func.h"
#include "news_func.h"
#include "aircraft.h"
#include "vehicle_gui.h"

#include "table/sprites.h"
#include "table/strings.h"

Station::Station(TileIndex tile)
{
  DEBUG(station, cDebugCtorLevel, "I+%3d", index);

  xy = tile;
  airport_tile = dock_tile = train_tile = INVALID_TILE;
  bus_stops = truck_stops = NULL;
  had_vehicle_of_type = 0;
  time_since_load = 255;
  time_since_unload = 255;
  delete_ctr = 0;
  facilities = 0;

  last_vehicle_type = VEH_INVALID;
  indtype = IT_INVALID;

  random_bits = 0; // Random() must be called when station is really built (DC_EXEC)
  waiting_triggers = 0;
}

Station::~Station()
{
  DEBUG(station, cDebugCtorLevel, "I-%3d", index);

  free(this->name);
  free(this->speclist);

  if (CleaningPool()) return;

  while (!loading_vehicles.empty()) {
    loading_vehicles.front()->LeaveStation();
  }

  Vehicle *v;
  FOR_ALL_VEHICLES(v) {
    if (v->type == VEH_AIRCRAFT && IsNormalAircraft(v) && v->u.air.targetairport == this->index) {
      v->u.air.targetairport = INVALID_STATION;
    }
  }

  MarkDirty();
  InvalidateWindowData(WC_STATION_LIST, this->owner, 0);

  DeleteWindowById(WC_STATION_VIEW, index);
  WindowNumber wno = (index << 16) | VLW_STATION_LIST | this->owner;
  DeleteWindowById(WC_TRAINS_LIST, wno | (VEH_TRAIN << 11));
  DeleteWindowById(WC_ROADVEH_LIST, wno | (VEH_ROAD << 11));
  DeleteWindowById(WC_SHIPS_LIST, wno | (VEH_SHIP << 11));
  DeleteWindowById(WC_AIRCRAFT_LIST, wno | (VEH_AIRCRAFT << 11));

  /* Now delete all orders that go to the station */
  RemoveOrderFromAllVehicles(OT_GOTO_STATION, index);

  /* Subsidies need removal as well */
  DeleteSubsidyWithStation(index);

  /* Remove all news items */
  DeleteStationNews(this->index);

  xy = INVALID_TILE;

  InvalidateWindowData(WC_SELECT_STATION, 0, 0);

  for (CargoID c = 0; c < NUM_CARGO; c++) {
    goods[c].cargo.Truncate(0);
  }
}


RoadStop *Station::GetPrimaryRoadStop(const Vehicle *v) const
{
  RoadStop *rs = this->GetPrimaryRoadStop(IsCargoInClass(v->cargo_type, CC_PASSENGERS) ? ROADSTOP_BUS : ROADSTOP_TRUCK);

  for (; rs != NULL; rs = rs->next) {
    /* The vehicle cannot go to this roadstop (different roadtype) */
    if ((GetRoadTypes(rs->xy) & v->u.road.compatible_roadtypes) == ROADTYPES_NONE) continue;
    /* The vehicle is articulated and can therefor not go the a standard road stop */
    if (IsStandardRoadStopTile(rs->xy) && RoadVehHasArticPart(v)) continue;

    /* The vehicle can actually go to this road stop. So, return it! */
    break;
  }

  return rs;
}

void Station::AddFacility(byte new_facility_bit, TileIndex facil_xy)
{
  if (facilities == 0) {
    xy = facil_xy;
    random_bits = Random();
  }
  facilities |= new_facility_bit;
  owner = _current_company;
  build_date = _date;
}

void Station::MarkDirty() const
{
  if (sign.width_1 != 0) {
    InvalidateWindowWidget(WC_STATION_VIEW, index, SVW_CAPTION);

    /* We use ZOOM_LVL_MAX here, as every viewport can have an other zoom,
     *  and there is no way for us to know which is the biggest. So make the
     *  biggest area dirty, and we are safe for sure. */
    MarkAllViewportsDirty(
      sign.left - 6,
      sign.top,
      sign.left + ScaleByZoom(sign.width_1 + 12, ZOOM_LVL_MAX),
      sign.top + ScaleByZoom(12, ZOOM_LVL_MAX));
  }
}

void Station::MarkTilesDirty(bool cargo_change) const
{
  TileIndex tile = train_tile;
  int w, h;

  if (tile == INVALID_TILE) return;

  /* cargo_change is set if we're refreshing the tiles due to cargo moving
   * around. */
  if (cargo_change) {
    /* Don't waste time updating if there are no custom station graphics
     * that might change. Even if there are custom graphics, they might
     * not change. Unfortunately we have no way of telling. */
    if (this->num_specs == 0) return;
  }

  for (h = 0; h < trainst_h; h++) {
    for (w = 0; w < trainst_w; w++) {
      if (TileBelongsToRailStation(tile)) {
        MarkTileDirtyByTile(tile);
      }
      tile += TileDiffXY(1, 0);
    }
    tile += TileDiffXY(-w, 1);
  }
}

bool Station::TileBelongsToRailStation(TileIndex tile) const
{
  return IsTileType(tile, MP_STATION) && GetStationIndex(tile) == index && IsRailwayStation(tile);
}

uint Station::GetPlatformLength(TileIndex tile) const
{
  TileIndex t;
  TileIndexDiff delta;
  uint len = 0;
  assert(TileBelongsToRailStation(tile));

  delta = (GetRailStationAxis(tile) == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1));

  t = tile;
  do {
    t -= delta;
    len++;
  } while (IsCompatibleTrainStationTile(t, tile));

  t = tile;
  do {
    t += delta;
    len++;
  } while (IsCompatibleTrainStationTile(t, tile));

  return len - 1;
}

uint Station::GetPlatformLength(TileIndex tile, DiagDirection dir) const
{
  TileIndex start_tile = tile;
  uint length = 0;
  assert(IsRailwayStationTile(tile));
  assert(dir < DIAGDIR_END);

  do {
    length ++;
    tile += TileOffsByDiagDir(dir);
  } while (IsCompatibleTrainStationTile(tile, start_tile));

  return length;
}

bool Station::IsBuoy() const
{
  return (had_vehicle_of_type & HVOT_BUOY) != 0;
}

uint Station::GetCatchmentRadius() const
{
  uint ret = CA_NONE;

  if (_settings_game.station.modified_catchment) {
    if (this->bus_stops    != NULL)         ret = max<uint>(ret, CA_BUS);
    if (this->truck_stops  != NULL)         ret = max<uint>(ret, CA_TRUCK);
    if (this->train_tile   != INVALID_TILE) ret = max<uint>(ret, CA_TRAIN);
    if (this->dock_tile    != INVALID_TILE) ret = max<uint>(ret, CA_DOCK);
    if (this->airport_tile != INVALID_TILE) ret = max<uint>(ret, this->Airport()->catchment);
  } else {
    if (this->bus_stops != NULL || this->truck_stops != NULL || this->train_tile != INVALID_TILE || this->dock_tile != INVALID_TILE || this->airport_tile != INVALID_TILE) {
      ret = CA_UNMODIFIED;
    }
  }

  return ret;
}


/************************************************************************/
/*                     StationRect implementation                       */
/************************************************************************/

StationRect::StationRect()
{
  MakeEmpty();
}

void StationRect::MakeEmpty()
{
  left = top = right = bottom = 0;
}

bool StationRect::PtInExtendedRect(int x, int y, int distance) const
{
  return (left - distance <= x && x <= right + distance && top - distance <= y && y <= bottom + distance);
}

bool StationRect::IsEmpty() const
{
  return (left == 0 || left > right || top > bottom);
}

bool StationRect::BeforeAddTile(TileIndex tile, StationRectMode mode)
{
  int x = TileX(tile);
  int y = TileY(tile);
  if (IsEmpty()) {
    /* we are adding the first station tile */
    if (mode != ADD_TEST) {
      left = right = x;
      top = bottom = y;
    }
  } else if (!PtInExtendedRect(x, y)) {
    /* current rect is not empty and new point is outside this rect */
    /* make new spread-out rectangle */
    Rect new_rect = {min(x, left), min(y, top), max(x, right), max(y, bottom)};

    /* check new rect dimensions against preset max */
    int w = new_rect.right - new_rect.left + 1;
    int h = new_rect.bottom - new_rect.top + 1;
    if (mode != ADD_FORCE && (w > _settings_game.station.station_spread || h > _settings_game.station.station_spread)) {
      assert(mode != ADD_TRY);
      _error_message = STR_306C_STATION_TOO_SPREAD_OUT;
      return false;
    }

    /* spread-out ok, return true */
    if (mode != ADD_TEST) {
      /* we should update the station rect */
      *this = new_rect;
    }
  } else {
    ; // new point is inside the rect, we don't need to do anything
  }
  return true;
}

bool StationRect::BeforeAddRect(TileIndex tile, int w, int h, StationRectMode mode)
{
  return (mode == ADD_FORCE || (w <= _settings_game.station.station_spread && h <= _settings_game.station.station_spread)) && // important when the old rect is completely inside the new rect, resp. the old one was empty
      BeforeAddTile(tile, mode) && BeforeAddTile(TILE_ADDXY(tile, w - 1, h - 1), mode);
}

/*static*/ bool StationRect::ScanForStationTiles(StationID st_id, int left_a, int top_a, int right_a, int bottom_a)
{
  TileIndex top_left = TileXY(left_a, top_a);
  int width = right_a - left_a + 1;
  int height = bottom_a - top_a + 1;

  BEGIN_TILE_LOOP(tile, width, height, top_left)
    if (IsTileType(tile, MP_STATION) && GetStationIndex(tile) == st_id) return true;
  END_TILE_LOOP(tile, width, height, top_left);

  return false;
}

bool StationRect::AfterRemoveTile(Station *st, TileIndex tile)
{
  int x = TileX(tile);
  int y = TileY(tile);

  /* look if removed tile was on the bounding rect edge
   * and try to reduce the rect by this edge
   * do it until we have empty rect or nothing to do */
  for (;;) {
    /* check if removed tile is on rect edge */
    bool left_edge = (x == left);
    bool right_edge = (x == right);
    bool top_edge = (y == top);
    bool bottom_edge = (y == bottom);

    /* can we reduce the rect in either direction? */
    bool reduce_x = ((left_edge || right_edge) && !ScanForStationTiles(st->index, x, top, x, bottom));
    bool reduce_y = ((top_edge || bottom_edge) && !ScanForStationTiles(st->index, left, y, right, y));
    if (!(reduce_x || reduce_y)) break; // nothing to do (can't reduce)

    if (reduce_x) {
      /* reduce horizontally */
      if (left_edge) {
        /* move left edge right */
        left = x = x + 1;
      } else {
        /* move right edge left */
        right = x = x - 1;
      }
    }
    if (reduce_y) {
      /* reduce vertically */
      if (top_edge) {
        /* move top edge down */
        top = y = y + 1;
      } else {
        /* move bottom edge up */
        bottom = y = y - 1;
      }
    }

    if (left > right || top > bottom) {
      /* can't continue, if the remaining rectangle is empty */
      MakeEmpty();
      return true; // empty remaining rect
    }
  }
  return false; // non-empty remaining rect
}

bool StationRect::AfterRemoveRect(Station *st, TileIndex tile, int w, int h)
{
  assert(PtInExtendedRect(TileX(tile), TileY(tile)));
  assert(PtInExtendedRect(TileX(tile) + w - 1, TileY(tile) + h - 1));

  bool empty = AfterRemoveTile(st, tile);
  if (w != 1 || h != 1) empty = empty || AfterRemoveTile(st, TILE_ADDXY(tile, w - 1, h - 1));
  return empty;
}

StationRect& StationRect::operator = (Rect src)
{
  left = src.left;
  top = src.top;
  right = src.right;
  bottom = src.bottom;
  return *this;
}


/************************************************************************/
/*                     RoadStop implementation                          */
/************************************************************************/

RoadStop::RoadStop(TileIndex tile) :
  xy(tile),
  status(3), // stop is free
  num_vehicles(0),
  next(NULL)
{
  DEBUG(ms, cDebugCtorLevel,  "I+ at %d[0x%x]", tile, tile);
}

RoadStop::~RoadStop()
{
  if (CleaningPool()) return;

  /* Clear the slot assignment of all vehicles heading for this road stop */
  if (num_vehicles != 0) {
    Vehicle *v;

    FOR_ALL_VEHICLES(v) {
      if (v->type == VEH_ROAD && v->u.road.slot == this) ClearSlot(v);
    }
  }
  assert(num_vehicles == 0);

  DEBUG(ms, cDebugCtorLevel , "I- at %d[0x%x]", xy, xy);

  xy = INVALID_TILE;
}

bool RoadStop::HasFreeBay() const
{
  return GB(status, 0, MAX_BAY_COUNT) != 0;
}

bool RoadStop::IsFreeBay(uint nr) const
{
  assert(nr < MAX_BAY_COUNT);
  return HasBit(status, nr);
}

uint RoadStop::AllocateBay()
{
  assert(HasFreeBay());

  /* Find the first free bay. If the bit is set, the bay is free. */
  uint bay_nr = 0;
  while (!HasBit(status, bay_nr)) bay_nr++;

  ClrBit(status, bay_nr);
  return bay_nr;
}

void RoadStop::AllocateDriveThroughBay(uint nr)
{
  assert(nr < MAX_BAY_COUNT);
  ClrBit(status, nr);
}

void RoadStop::FreeBay(uint nr)
{
  assert(nr < MAX_BAY_COUNT);
  SetBit(status, nr);
}


bool RoadStop::IsEntranceBusy() const
{
  return HasBit(status, 7);
}

void RoadStop::SetEntranceBusy(bool busy)
{
  SB(status, 7, 1, busy);
}

RoadStop *RoadStop::GetNextRoadStop(const Vehicle *v) const
{
  for (RoadStop *rs = this->next; rs != NULL; rs = rs->next) {
    /* The vehicle cannot go to this roadstop (different roadtype) */
    if ((GetRoadTypes(rs->xy) & v->u.road.compatible_roadtypes) == ROADTYPES_NONE) continue;
    /* The vehicle is articulated and can therefor not go the a standard road stop */
    if (IsStandardRoadStopTile(rs->xy) && RoadVehHasArticPart(v)) continue;

    /* The vehicle can actually go to this road stop. So, return it! */
    return rs;
  }

  return NULL;
}