station_gui.cpp

Go to the documentation of this file.

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

#include "stdafx.h"
#include "openttd.h"
#include "debug.h"
#include "gui.h"
#include "window_gui.h"
#include "textbuf_gui.h"
#include "station_base.h"
#include "company_func.h"
#include "economy_func.h"
#include "town.h"
#include "command_func.h"
#include "variables.h"
#include "vehicle_gui.h"
#include "cargotype.h"
#include "station_gui.h"
#include "station_func.h"
#include "strings_func.h"
#include "core/alloc_func.hpp"
#include "window_func.h"
#include "viewport_func.h"
#include "gfx_func.h"
#include "widgets/dropdown_func.h"
#include "newgrf_cargo.h"
#include "map_func.h"
#include "settings_type.h"
#include "tile_map.h"
#include "station_map.h"
#include "tilehighlight_func.h"
#include "core/smallvec_type.hpp"
#include "core/smallmap_type.hpp"
#include "string_func.h"
#include "company_base.h"
#include "sortlist_type.h"

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

static void StationsWndShowStationRating(int x, int y, CargoID type, uint amount, byte rating)
{
  static const uint units_full  = 576; 
  static const uint rating_full = 224; 

  const CargoSpec *cs = GetCargo(type);
  if (!cs->IsValid()) return;

  int colour = cs->rating_colour;
  uint w = (minu(amount, units_full) + 5) / 36;

  /* Draw total cargo (limited) on station (fits into 16 pixels) */
  if (w != 0) GfxFillRect(x, y, x + w - 1, y + 6, colour);

  /* Draw a one pixel-wide bar of additional cargo meter, useful
   * for stations with only a small amount (<=30) */
  if (w == 0) {
    uint rest = amount / 5;
    if (rest != 0) {
      w += x;
      GfxFillRect(w, y + 6 - rest, w, y + 6, colour);
    }
  }

  DrawString(x + 1, y, cs->abbrev, TC_BLACK);

  /* Draw green/red ratings bar (fits into 14 pixels) */
  y += 8;
  GfxFillRect(x + 1, y, x + 14, y, 0xB8);
  rating = minu(rating, rating_full) / 16;
  if (rating != 0) GfxFillRect(x + 1, y, x + rating, y, 0xD0);
}

typedef GUIList<const Station*> GUIStationList;

class CompanyStationsWindow : public Window
{
protected:
  /* Runtime saved values */
  static Listing last_sorting;
  static byte facilities;               // types of stations of interest
  static bool include_empty;            // whether we should include stations without waiting cargo
  static const uint32 cargo_filter_max;
  static uint32 cargo_filter;           // bitmap of cargo types to include
  static const Station *last_station;

  /* Constants for sorting stations */
  static const StringID sorter_names[];
  static GUIStationList::SortFunction *const sorter_funcs[];

  GUIStationList stations;


  void BuildStationsList(const Owner owner)
  {
    if (!this->stations.NeedRebuild()) return;

    DEBUG(misc, 3, "Building station list for company %d", owner);

    this->stations.Clear();

    const Station *st;
    FOR_ALL_STATIONS(st) {
      if (st->owner == owner || (st->owner == OWNER_NONE && !st->IsBuoy() && HasStationInUse(st->index, owner))) {
        if (this->facilities & st->facilities) { // only stations with selected facilities
          int num_waiting_cargo = 0;
          for (CargoID j = 0; j < NUM_CARGO; j++) {
            if (!st->goods[j].cargo.Empty()) {
              num_waiting_cargo++; // count number of waiting cargo
              if (HasBit(this->cargo_filter, j)) {
                *this->stations.Append() = st;
                break;
              }
            }
          }
          /* stations without waiting cargo */
          if (num_waiting_cargo == 0 && this->include_empty) {
            *this->stations.Append() = st;
          }
        }
      }
    }

    this->stations.Compact();
    this->stations.RebuildDone();
  }

  static int CDECL StationNameSorter(const Station* const *a, const Station* const *b)
  {
    static char buf_cache[64];
    char buf[64];

    SetDParam(0, (*a)->index);
    GetString(buf, STR_STATION, lastof(buf));

    if (*b != last_station) {
      last_station = *b;
      SetDParam(0, (*b)->index);
      GetString(buf_cache, STR_STATION, lastof(buf_cache));
    }

    return strcmp(buf, buf_cache);
  }

  static int CDECL StationTypeSorter(const Station* const *a, const Station* const *b)
  {
    return (*a)->facilities - (*b)->facilities;
  }

  static int CDECL StationWaitingSorter(const Station* const *a, const Station* const *b)
  {
    Money diff = 0;

    for (CargoID j = 0; j < NUM_CARGO; j++) {
      if (!HasBit(cargo_filter, j)) continue;
      if (!(*a)->goods[j].cargo.Empty()) diff += GetTransportedGoodsIncome((*a)->goods[j].cargo.Count(), 20, 50, j);
      if (!(*b)->goods[j].cargo.Empty()) diff -= GetTransportedGoodsIncome((*b)->goods[j].cargo.Count(), 20, 50, j);
    }

    return ClampToI32(diff);
  }

  static int CDECL StationRatingMaxSorter(const Station* const *a, const Station* const *b)
  {
    byte maxr1 = 0;
    byte maxr2 = 0;

    for (CargoID j = 0; j < NUM_CARGO; j++) {
      if (HasBit((*a)->goods[j].acceptance_pickup, GoodsEntry::PICKUP)) maxr1 = max(maxr1, (*a)->goods[j].rating);
      if (HasBit((*b)->goods[j].acceptance_pickup, GoodsEntry::PICKUP)) maxr2 = max(maxr2, (*b)->goods[j].rating);
    }

    return maxr1 - maxr2;
  }

  void SortStationsList()
  {
    if (!this->stations.Sort()) return;

    /* Reset name sorter sort cache */
    this->last_station = NULL;

    /* Set the modified widget dirty */
    this->InvalidateWidget(SLW_LIST);
  }

public:
  CompanyStationsWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)
  {
    this->caption_color = (byte)this->window_number;
    this->vscroll.cap = 12;
    this->resize.step_height = 10;
    this->resize.height = this->height - 10 * 7; // minimum if 5 in the list

    /* Add cargo filter buttons */
    uint num_active = 0;
    for (CargoID c = 0; c < NUM_CARGO; c++) {
      if (GetCargo(c)->IsValid()) num_active++;
    }

    this->widget_count += num_active;
    this->widget = ReallocT(this->widget, this->widget_count + 1);
    this->widget[this->widget_count].type = WWT_LAST;

    uint i = 0;
    for (CargoID c = 0; c < NUM_CARGO; c++) {
      if (!GetCargo(c)->IsValid()) continue;

      Widget *wi = &this->widget[SLW_CARGOSTART + i];
      wi->type     = WWT_PANEL;
      wi->display_flags = RESIZE_NONE;
      wi->color    = COLOUR_GREY;
      wi->left     = 89 + i * 14;
      wi->right    = wi->left + 13;
      wi->top      = 14;
      wi->bottom   = 24;
      wi->data     = 0;
      wi->tooltips = STR_USE_CTRL_TO_SELECT_MORE;

      if (HasBit(this->cargo_filter, c)) this->LowerWidget(SLW_CARGOSTART + i);
      i++;
    }

    this->widget[SLW_NOCARGOWAITING].left += num_active * 14;
    this->widget[SLW_NOCARGOWAITING].right += num_active * 14;
    this->widget[SLW_CARGOALL].left += num_active * 14;
    this->widget[SLW_CARGOALL].right += num_active * 14;
    this->widget[SLW_PAN_RIGHT].left += num_active * 14;

    if (num_active > 15) {
      /* Resize and fix the minimum width, if necessary */
      ResizeWindow(this, (num_active - 15) * 14, 0);
      this->resize.width = this->width;
    }

    if (this->cargo_filter == this->cargo_filter_max) this->cargo_filter = _cargo_mask;

    for (uint i = 0; i < 5; i++) {
      if (HasBit(this->facilities, i)) this->LowerWidget(i + SLW_TRAIN);
    }
    this->SetWidgetLoweredState(SLW_FACILALL, this->facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));
    this->SetWidgetLoweredState(SLW_CARGOALL, this->cargo_filter == _cargo_mask && this->include_empty);
    this->SetWidgetLoweredState(SLW_NOCARGOWAITING, this->include_empty);

    this->stations.SetListing(this->last_sorting);
    this->stations.SetSortFuncs(this->sorter_funcs);
    this->stations.ForceRebuild();
    this->stations.NeedResort();
    this->SortStationsList();

    this->widget[SLW_SORTDROPBTN].data = this->sorter_names[this->stations.SortType()];

    this->FindWindowPlacementAndResize(desc);
  }

  ~CompanyStationsWindow()
  {
    this->last_sorting = this->stations.GetListing();
  }

  virtual void OnPaint()
  {
    const Owner owner = (Owner)this->window_number;

    this->BuildStationsList(owner);
    this->SortStationsList();

    SetVScrollCount(this, this->stations.Length());

    /* draw widgets, with company's name in the caption */
    SetDParam(0, owner);
    SetDParam(1, this->vscroll.count);

    this->DrawWidgets();

    /* draw arrow pointing up/down for ascending/descending sorting */
    this->DrawSortButtonState(SLW_SORTBY, this->stations.IsDescSortOrder() ? SBS_DOWN : SBS_UP);

    int cg_ofst;
    int x = 89;
    int y = 14;
    int xb = 2; 

    uint i = 0;
    for (CargoID c = 0; c < NUM_CARGO; c++) {
      const CargoSpec *cs = GetCargo(c);
      if (!cs->IsValid()) continue;

      cg_ofst = HasBit(this->cargo_filter, c) ? 2 : 1;
      GfxFillRect(x + cg_ofst, y + cg_ofst, x + cg_ofst + 10 , y + cg_ofst + 7, cs->rating_colour);
      DrawStringCentered(x + 6 + cg_ofst, y + cg_ofst, cs->abbrev, TC_BLACK);
      x += 14;
      i++;
    }

    x += 6;
    cg_ofst = this->IsWidgetLowered(SLW_NOCARGOWAITING) ? 2 : 1;
    DrawStringCentered(x + cg_ofst, y + cg_ofst, STR_ABBREV_NONE, TC_BLACK);
    x += 14;
    cg_ofst = this->IsWidgetLowered(SLW_CARGOALL) ? 2 : 1;
    DrawStringCentered(x + cg_ofst, y + cg_ofst, STR_ABBREV_ALL, TC_BLACK);

    cg_ofst = this->IsWidgetLowered(SLW_FACILALL) ? 2 : 1;
    DrawString(71 + cg_ofst, y + cg_ofst, STR_ABBREV_ALL, TC_BLACK);

    if (this->vscroll.count == 0) { // company has no stations
      DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);
      return;
    }

    int max = min(this->vscroll.pos + this->vscroll.cap, this->stations.Length());
    y = 40; // start of the list-widget

    for (int i = this->vscroll.pos; i < max; ++i) { // do until max number of stations of owner
      const Station *st = this->stations[i];
      int x;

      assert(st->xy != INVALID_TILE);

      /* Do not do the complex check HasStationInUse here, it may be even false
        * when the order had been removed and the station list hasn't been removed yet */
      assert(st->owner == owner || (st->owner == OWNER_NONE && !st->IsBuoy()));

      SetDParam(0, st->index);
      SetDParam(1, st->facilities);
      x = DrawString(xb, y, STR_3049_0, TC_FROMSTRING) + 5;

      /* show cargo waiting and station ratings */
      for (CargoID j = 0; j < NUM_CARGO; j++) {
        if (!st->goods[j].cargo.Empty()) {
          StationsWndShowStationRating(x, y, j, st->goods[j].cargo.Count(), st->goods[j].rating);
          x += 20;
        }
      }
      y += 10;
    }
  }

  virtual void OnClick(Point pt, int widget)
  {
    switch (widget) {
      case SLW_LIST: {
        uint32 id_v = (pt.y - 41) / 10;

        if (id_v >= this->vscroll.cap) return; // click out of bounds

        id_v += this->vscroll.pos;

        if (id_v >= this->stations.Length()) return; // click out of list bound

        const Station *st = this->stations[id_v];
        /* do not check HasStationInUse - it is slow and may be invalid */
        assert(st->owner == (Owner)this->window_number || (st->owner == OWNER_NONE && !st->IsBuoy()));

        if (_ctrl_pressed) {
          ShowExtraViewPortWindow(st->xy);
        } else {
          ScrollMainWindowToTile(st->xy);
        }
        break;
      }

      case SLW_TRAIN:
      case SLW_TRUCK:
      case SLW_BUS:
      case SLW_AIRPLANE:
      case SLW_SHIP:
        if (_ctrl_pressed) {
          ToggleBit(this->facilities, widget - SLW_TRAIN);
          this->ToggleWidgetLoweredState(widget);
        } else {
          uint i;
          FOR_EACH_SET_BIT(i, this->facilities) {
            this->RaiseWidget(i + SLW_TRAIN);
          }
          SetBit(this->facilities, widget - SLW_TRAIN);
          this->LowerWidget(widget);
        }
        this->SetWidgetLoweredState(SLW_FACILALL, this->facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));
        this->stations.ForceRebuild();
        this->SetDirty();
        break;

      case SLW_FACILALL:
        for (uint i = 0; i < 5; i++) {
          this->LowerWidget(i + SLW_TRAIN);
        }
        this->LowerWidget(SLW_FACILALL);

        this->facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;
        this->stations.ForceRebuild();
        this->SetDirty();
        break;

      case SLW_CARGOALL: {
        uint i = 0;
        for (CargoID c = 0; c < NUM_CARGO; c++) {
          if (!GetCargo(c)->IsValid()) continue;
          this->LowerWidget(i + SLW_CARGOSTART);
          i++;
        }
        this->LowerWidget(SLW_NOCARGOWAITING);
        this->LowerWidget(SLW_CARGOALL);

        this->cargo_filter = _cargo_mask;
        this->include_empty = true;
        this->stations.ForceRebuild();
        this->SetDirty();
        break;
      }

      case SLW_SORTBY: // flip sorting method asc/desc
        this->stations.ToggleSortOrder();
        this->flags4 |= WF_TIMEOUT_BEGIN;
        this->LowerWidget(SLW_SORTBY);
        this->SetDirty();
        break;

      case SLW_SORTDROPBTN: // select sorting criteria dropdown menu
        ShowDropDownMenu(this, this->sorter_names, this->stations.SortType(), SLW_SORTDROPBTN, 0, 0);
        break;

      case SLW_NOCARGOWAITING:
        if (_ctrl_pressed) {
          this->include_empty = !this->include_empty;
          this->ToggleWidgetLoweredState(SLW_NOCARGOWAITING);
        } else {
          for (uint i = SLW_CARGOSTART; i < this->widget_count; i++) {
            this->RaiseWidget(i);
          }

          this->cargo_filter = 0;
          this->include_empty = true;

          this->LowerWidget(SLW_NOCARGOWAITING);
        }
        this->SetWidgetLoweredState(SLW_CARGOALL, this->cargo_filter == _cargo_mask && this->include_empty);
        this->stations.ForceRebuild();
        this->SetDirty();
        break;

      default:
        if (widget >= SLW_CARGOSTART) { // change cargo_filter
          /* Determine the selected cargo type */
          CargoID c;
          int i = 0;
          for (c = 0; c < NUM_CARGO; c++) {
            if (!GetCargo(c)->IsValid()) continue;
            if (widget - SLW_CARGOSTART == i) break;
            i++;
          }

          if (_ctrl_pressed) {
            ToggleBit(this->cargo_filter, c);
            this->ToggleWidgetLoweredState(widget);
          } else {
            for (uint i = SLW_CARGOSTART; i < this->widget_count; i++) {
              this->RaiseWidget(i);
            }
            this->RaiseWidget(SLW_NOCARGOWAITING);

            this->cargo_filter = 0;
            this->include_empty = false;

            SetBit(this->cargo_filter, c);
            this->LowerWidget(widget);
          }
          this->SetWidgetLoweredState(SLW_CARGOALL, this->cargo_filter == _cargo_mask && this->include_empty);
          this->stations.ForceRebuild();
          this->SetDirty();
        }
        break;
    }
  }

  virtual void OnDropdownSelect(int widget, int index)
  {
    if (this->stations.SortType() != index) {
      this->stations.SetSortType(index);

      /* Display the current sort variant */
      this->widget[SLW_SORTDROPBTN].data = this->sorter_names[this->stations.SortType()];

      this->SetDirty();
    }
  }

  virtual void OnTick()
  {
    if (_pause_game != 0) return;
    if (this->stations.NeedResort()) {
      DEBUG(misc, 3, "Periodic rebuild station list company %d", this->window_number);
      this->SetDirty();
    }
  }

  virtual void OnTimeout()
  {
    this->RaiseWidget(SLW_SORTBY);
    this->SetDirty();
  }

  virtual void OnResize(Point new_size, Point delta)
  {
    this->vscroll.cap += delta.y / 10;
  }

  virtual void OnInvalidateData(int data)
  {
    if (data == 0) {
      this->stations.ForceRebuild();
    } else {
      this->stations.ForceResort();
    }
  }
};

Listing CompanyStationsWindow::last_sorting = {false, 0};
byte CompanyStationsWindow::facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;
bool CompanyStationsWindow::include_empty = true;
const uint32 CompanyStationsWindow::cargo_filter_max = UINT32_MAX;
uint32 CompanyStationsWindow::cargo_filter = UINT32_MAX;
const Station *CompanyStationsWindow::last_station = NULL;

/* Availible station sorting functions */
GUIStationList::SortFunction *const CompanyStationsWindow::sorter_funcs[] = {
  &StationNameSorter,
  &StationTypeSorter,
  &StationWaitingSorter,
  &StationRatingMaxSorter
};

/* Names of the sorting functions */
const StringID CompanyStationsWindow::sorter_names[] = {
  STR_SORT_BY_DROPDOWN_NAME,
  STR_SORT_BY_FACILITY,
  STR_SORT_BY_WAITING,
  STR_SORT_BY_RATING_MAX,
  INVALID_STRING_ID
};


static const Widget _company_stations_widgets[] = {
{   WWT_CLOSEBOX,   RESIZE_NONE,  COLOUR_GREY,     0,    10,     0,    13, STR_00C5,          STR_018B_CLOSE_WINDOW},            // SLW_CLOSEBOX
{    WWT_CAPTION,  RESIZE_RIGHT,  COLOUR_GREY,    11,   345,     0,    13, STR_3048_STATIONS, STR_018C_WINDOW_TITLE_DRAG_THIS},
{  WWT_STICKYBOX,     RESIZE_LR,  COLOUR_GREY,   346,   357,     0,    13, 0x0,               STR_STICKY_BUTTON},
{      WWT_PANEL,     RESIZE_RB,  COLOUR_GREY,     0,   345,    37,   161, 0x0,               STR_3057_STATION_NAMES_CLICK_ON},  // SLW_LIST
{  WWT_SCROLLBAR,    RESIZE_LRB,  COLOUR_GREY,   346,   357,    37,   149, 0x0,               STR_0190_SCROLL_BAR_SCROLLS_LIST},
{  WWT_RESIZEBOX,   RESIZE_LRTB,  COLOUR_GREY,   346,   357,   150,   161, 0x0,               STR_RESIZE_BUTTON},

{    WWT_TEXTBTN,   RESIZE_NONE,  COLOUR_GREY,     0,    13,    14,    24, STR_TRAIN,         STR_USE_CTRL_TO_SELECT_MORE},      // SLW_TRAIN
{    WWT_TEXTBTN,   RESIZE_NONE,  COLOUR_GREY,    14,    27,    14,    24, STR_LORRY,         STR_USE_CTRL_TO_SELECT_MORE},      // SLW_TRUCK
{    WWT_TEXTBTN,   RESIZE_NONE,  COLOUR_GREY,    28,    41,    14,    24, STR_BUS,           STR_USE_CTRL_TO_SELECT_MORE},      // SLW_BUS
{    WWT_TEXTBTN,   RESIZE_NONE,  COLOUR_GREY,    42,    55,    14,    24, STR_PLANE,         STR_USE_CTRL_TO_SELECT_MORE},      // SLW_AIRPLANE
{    WWT_TEXTBTN,   RESIZE_NONE,  COLOUR_GREY,    56,    69,    14,    24, STR_SHIP,          STR_USE_CTRL_TO_SELECT_MORE},      // SLW_SHIP
{      WWT_PANEL,   RESIZE_NONE,  COLOUR_GREY,    70,    83,    14,    24, 0x0,               STR_SELECT_ALL_FACILITIES},        // SLW_FACILALL

{      WWT_PANEL,   RESIZE_NONE,  COLOUR_GREY,    83,    88,    14,    24, 0x0,               STR_NULL},                         // SLW_PAN_BETWEEN
{      WWT_PANEL,   RESIZE_NONE,  COLOUR_GREY,    89,   102,    14,    24, 0x0,               STR_NO_WAITING_CARGO},             // SLW_NOCARGOWAITING
{      WWT_PANEL,   RESIZE_NONE,  COLOUR_GREY,   103,   116,    14,    24, 0x0,               STR_SELECT_ALL_TYPES},             // SLW_CARGOALL
{      WWT_PANEL,  RESIZE_RIGHT,  COLOUR_GREY,   117,   357,    14,    24, 0x0,               STR_NULL},                         // SLW_PAN_RIGHT

{    WWT_TEXTBTN,   RESIZE_NONE,  COLOUR_GREY,     0,    80,    25,    36, STR_SORT_BY,       STR_SORT_ORDER_TIP},               // SLW_SORTBY
{   WWT_DROPDOWN,   RESIZE_NONE,  COLOUR_GREY,    81,   243,    25,    36, 0x0,               STR_SORT_CRITERIA_TIP},            // SLW_SORTDROPBTN
{      WWT_PANEL,  RESIZE_RIGHT,  COLOUR_GREY,   244,   357,    25,    36, 0x0,               STR_NULL},                         // SLW_PAN_SORT_RIGHT
{   WIDGETS_END},
};

static const WindowDesc _company_stations_desc = {
  WDP_AUTO, WDP_AUTO, 358, 162, 358, 162,
  WC_STATION_LIST, WC_NONE,
  WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_STICKY_BUTTON | WDF_RESIZABLE,
  _company_stations_widgets,
};

void ShowCompanyStations(CompanyID company)
{
  if (!IsValidCompanyID(company)) return;

  AllocateWindowDescFront<CompanyStationsWindow>(&_company_stations_desc, company);
}

static const Widget _station_view_widgets[] = {
{   WWT_CLOSEBOX,   RESIZE_NONE,  COLOUR_GREY,     0,    10,     0,    13, STR_00C5,          STR_018B_CLOSE_WINDOW},                // SVW_CLOSEBOX
{    WWT_CAPTION,  RESIZE_RIGHT,  COLOUR_GREY,    11,   236,     0,    13, STR_300A_0,        STR_018C_WINDOW_TITLE_DRAG_THIS},
{  WWT_STICKYBOX,     RESIZE_LR,  COLOUR_GREY,   237,   248,     0,    13, 0x0,               STR_STICKY_BUTTON},
{      WWT_PANEL,     RESIZE_RB,  COLOUR_GREY,     0,   236,    14,    65, 0x0,               STR_NULL},                             // SVW_WAITING
{  WWT_SCROLLBAR,    RESIZE_LRB,  COLOUR_GREY,   237,   248,    14,    65, 0x0,               STR_0190_SCROLL_BAR_SCROLLS_LIST},
{      WWT_PANEL,    RESIZE_RTB,  COLOUR_GREY,     0,   248,    66,    97, 0x0,               STR_NULL},                             // SVW_ACCEPTLIST / SVW_RATINGLIST
{ WWT_PUSHTXTBTN,     RESIZE_TB,  COLOUR_GREY,     0,    59,    98,   109, STR_00E4_LOCATION, STR_3053_CENTER_MAIN_VIEW_ON_STATION}, // SVW_LOCATION
{ WWT_PUSHTXTBTN,     RESIZE_TB,  COLOUR_GREY,    60,   120,    98,   109, STR_3032_RATINGS,  STR_3054_SHOW_STATION_RATINGS},        // SVW_RATINGS / SVW_ACCEPTS
{ WWT_PUSHTXTBTN,    RESIZE_RTB,  COLOUR_GREY,   121,   180,    98,   109, STR_0130_RENAME,   STR_3055_CHANGE_NAME_OF_STATION},      // SVW_RENAME
{ WWT_PUSHTXTBTN,   RESIZE_LRTB,  COLOUR_GREY,   181,   194,    98,   109, STR_TRAIN,         STR_SCHEDULED_TRAINS_TIP },            // SVW_TRAINS
{ WWT_PUSHTXTBTN,   RESIZE_LRTB,  COLOUR_GREY,   195,   208,    98,   109, STR_LORRY,         STR_SCHEDULED_ROAD_VEHICLES_TIP },     // SVW_ROADVEHS
{ WWT_PUSHTXTBTN,   RESIZE_LRTB,  COLOUR_GREY,   209,   222,    98,   109, STR_PLANE,         STR_SCHEDULED_AIRCRAFT_TIP },          // SVW_PLANES
{ WWT_PUSHTXTBTN,   RESIZE_LRTB,  COLOUR_GREY,   223,   236,    98,   109, STR_SHIP,          STR_SCHEDULED_SHIPS_TIP },             // SVW_SHIPS
{  WWT_RESIZEBOX,   RESIZE_LRTB,  COLOUR_GREY,   237,   248,    98,   109, 0x0,               STR_RESIZE_BUTTON},
{   WIDGETS_END},
};

SpriteID GetCargoSprite(CargoID i)
{
  const CargoSpec *cs = GetCargo(i);
  SpriteID sprite;

  if (cs->sprite == 0xFFFF) {
    /* A value of 0xFFFF indicates we should draw a custom icon */
    sprite = GetCustomCargoSprite(cs);
  } else {
    sprite = cs->sprite;
  }

  if (sprite == 0) sprite = SPR_CARGO_GOODS;

  return sprite;
}

static void DrawCargoIcons(CargoID i, uint waiting, int x, int y, uint width)
{
  uint num = min((waiting + 5) / 10, width / 10); // maximum is width / 10 icons so it won't overflow
  if (num == 0) return;

  SpriteID sprite = GetCargoSprite(i);

  do {
    DrawSprite(sprite, PAL_NONE, x, y);
    x += 10;
  } while (--num);
}

struct CargoData {
  CargoID cargo;
  StationID source;
  uint count;

  CargoData(CargoID cargo, StationID source, uint count) :
    cargo(cargo),
    source(source),
    count(count)
  { }
};

typedef std::list<CargoData> CargoDataList;

struct StationViewWindow : public Window {
  uint32 cargo;                 
  uint16 cargo_rows[NUM_CARGO]; 

  StationViewWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)
  {
    Owner owner = GetStation(window_number)->owner;
    if (owner != OWNER_NONE) this->caption_color = owner;
    this->vscroll.cap = 5;
    this->resize.step_height = 10;

    this->FindWindowPlacementAndResize(desc);
  }

  ~StationViewWindow()
  {
    WindowNumber wno =
      (this->window_number << 16) | VLW_STATION_LIST | GetStation(this->window_number)->owner;

    DeleteWindowById(WC_TRAINS_LIST, wno | (VEH_TRAIN << 11), false);
    DeleteWindowById(WC_ROADVEH_LIST, wno | (VEH_ROAD << 11), false);
    DeleteWindowById(WC_SHIPS_LIST, wno | (VEH_SHIP << 11), false);
    DeleteWindowById(WC_AIRCRAFT_LIST, wno | (VEH_AIRCRAFT << 11), false);
  }

  virtual void OnPaint()
  {
    StationID station_id = this->window_number;
    const Station *st = GetStation(station_id);
    CargoDataList cargolist;
    uint32 transfers = 0;

    /* count types of cargos waiting in station */
    for (CargoID i = 0; i < NUM_CARGO; i++) {
      if (st->goods[i].cargo.Empty()) {
        this->cargo_rows[i] = 0;
      } else {
        /* Add an entry for total amount of cargo of this type waiting. */
        cargolist.push_back(CargoData(i, INVALID_STATION, st->goods[i].cargo.Count()));

        /* Set the row for this cargo entry for the expand/hide button */
        this->cargo_rows[i] = (uint16)cargolist.size();

        /* Add an entry for each distinct cargo source. */
        const CargoList::List *packets = st->goods[i].cargo.Packets();
        for (CargoList::List::const_iterator it = packets->begin(); it != packets->end(); it++) {
          const CargoPacket *cp = *it;
          if (cp->source != station_id) {
            bool added = false;

            /* Enable the expand/hide button for this cargo type */
            SetBit(transfers, i);

            /* Don't add cargo lines if not expanded */
            if (!HasBit(this->cargo, i)) break;

            /* Check if we already have this source in the list */
            for (CargoDataList::iterator jt = cargolist.begin(); jt != cargolist.end(); jt++) {
              CargoData *cd = &(*jt);
              if (cd->cargo == i && cd->source == cp->source) {
                cd->count += cp->count;
                added = true;
                break;
              }
            }

            if (!added) cargolist.push_back(CargoData(i, cp->source, cp->count));
          }
        }
      }
    }
    SetVScrollCount(this, (int)cargolist.size() + 1); // update scrollbar

    /* disable some buttons */
    this->SetWidgetDisabledState(SVW_RENAME,   st->owner != _local_company);
    this->SetWidgetDisabledState(SVW_TRAINS,   !(st->facilities & FACIL_TRAIN));
    this->SetWidgetDisabledState(SVW_ROADVEHS, !(st->facilities & FACIL_TRUCK_STOP) && !(st->facilities & FACIL_BUS_STOP));
    this->SetWidgetDisabledState(SVW_PLANES,   !(st->facilities & FACIL_AIRPORT));
    this->SetWidgetDisabledState(SVW_SHIPS,    !(st->facilities & FACIL_DOCK));

    SetDParam(0, st->index);
    SetDParam(1, st->facilities);
    this->DrawWidgets();

    int x = 2;  
    int y = 15;
    int pos = this->vscroll.pos; 

    uint width = this->widget[SVW_WAITING].right - this->widget[SVW_WAITING].left - 4;
    int maxrows = this->vscroll.cap;

    StringID str;

    if (--pos < 0) {
      str = STR_00D0_NOTHING;
      for (CargoID i = 0; i < NUM_CARGO; i++) {
        if (!st->goods[i].cargo.Empty()) str = STR_EMPTY;
      }
      SetDParam(0, str);
      DrawString(x, y, STR_0008_WAITING, TC_FROMSTRING);
      y += 10;
    }

    for (CargoDataList::const_iterator it = cargolist.begin(); it != cargolist.end() && pos > -maxrows; ++it) {
      if (--pos < 0) {
        const CargoData *cd = &(*it);
        if (cd->source == INVALID_STATION) {
          /* Heading */
          DrawCargoIcons(cd->cargo, cd->count, x, y, width);
          SetDParam(0, cd->cargo);
          SetDParam(1, cd->count);
          if (HasBit(transfers, cd->cargo)) {
            /* This cargo has transfers waiting so show the expand or shrink 'button' */
            const char *sym = HasBit(this->cargo, cd->cargo) ? "-" : "+";
            DrawStringRightAligned(x + width - 8, y, STR_0009, TC_FROMSTRING);
            DoDrawString(sym, x + width - 6, y, TC_YELLOW);
          } else {
            DrawStringRightAligned(x + width, y, STR_0009, TC_FROMSTRING);
          }
        } else {
          SetDParam(0, cd->cargo);
          SetDParam(1, cd->count);
          SetDParam(2, cd->source);
          DrawStringRightAlignedTruncated(x + width, y, STR_EN_ROUTE_FROM, TC_FROMSTRING, width);
        }

        y += 10;
      }
    }

    if (this->widget[SVW_ACCEPTS].data == STR_3032_RATINGS) { // small window with list of accepted cargo
      char string[512];
      char *b = string;
      bool first = true;

      b = InlineString(b, STR_000C_ACCEPTS);

      for (CargoID i = 0; i < NUM_CARGO; i++) {
        if (b >= lastof(string) - (1 + 2 * 4)) break; // ',' or ' ' and two calls to Utf8Encode()
        if (HasBit(st->goods[i].acceptance_pickup, GoodsEntry::ACCEPTANCE)) {
          if (first) {
            first = false;
          } else {
            /* Add a comma if this is not the first item */
            *b++ = ',';
            *b++ = ' ';
          }
          b = InlineString(b, GetCargo(i)->name);
        }
      }

      /* If first is still true then no cargo is accepted */
      if (first) b = InlineString(b, STR_00D0_NOTHING);

      *b = '\0';

      /* Make sure we detect any buffer overflow */
      assert(b < endof(string));

      SetDParamStr(0, string);
      DrawStringMultiLine(2, this->widget[SVW_ACCEPTLIST].top + 1, STR_JUST_RAW_STRING, this->widget[SVW_ACCEPTLIST].right - this->widget[SVW_ACCEPTLIST].left);
    } else { // extended window with list of cargo ratings
      y = this->widget[SVW_RATINGLIST].top + 1;

      DrawString(2, y, STR_3034_LOCAL_RATING_OF_TRANSPORT, TC_FROMSTRING);
      y += 10;

      for (CargoID i = 0; i < NUM_CARGO; i++) {
        const CargoSpec *cs = GetCargo(i);
        if (!cs->IsValid())