bridge_gui.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "error.h"
#include "command_func.h"
#include "rail.h"
#include "road.h"
#include "strings_func.h"
#include "window_func.h"
#include "sound_func.h"
#include "gfx_func.h"
#include "tunnelbridge.h"
#include "sortlist_type.h"
#include "dropdown_func.h"
#include "core/geometry_func.hpp"
#include "tunnelbridge_map.h"
#include "road_gui.h"
#include "tunnelbridge_cmd.h"
 
#include "widgets/bridge_widget.h"
 
#include "table/strings.h"
 
#include "safeguards.h"

static BridgeType _last_railbridge_type = 0;
static BridgeType _last_roadbridge_type = 0;

struct BuildBridgeData {
  BridgeType index;
  const BridgeSpec *spec;
  Money cost;
};
 
typedef GUIList<BuildBridgeData> GUIBridgeList; 

void CcBuildBridge(Commands, const CommandCost &result, TileIndex end_tile, TileIndex tile_start, TransportType transport_type, BridgeType, RailType, RoadType)
{
  if (result.Failed()) return;
  if (_settings_client.sound.confirm) SndPlayTileFx(SND_27_CONSTRUCTION_BRIDGE, end_tile);
 
  if (transport_type == TRANSPORT_ROAD) {
    DiagDirection end_direction = ReverseDiagDir(GetTunnelBridgeDirection(end_tile));
    ConnectRoadToStructure(end_tile, end_direction);
 
    DiagDirection start_direction = ReverseDiagDir(GetTunnelBridgeDirection(tile_start));
    ConnectRoadToStructure(tile_start, start_direction);
  }
}

class BuildBridgeWindow : public Window {
private:
  /* Runtime saved values */
  static Listing last_sorting; 

  static inline const StringID sorter_names[] = {
    STR_SORT_BY_NUMBER,
    STR_SORT_BY_COST,
    STR_SORT_BY_MAX_SPEED,
  };
  static const std::initializer_list<GUIBridgeList::SortFunction * const> sorter_funcs; 
 
  TileIndex start_tile = INVALID_TILE;
  TileIndex end_tile = INVALID_TILE;
  TransportType transport_type = INVALID_TRANSPORT;
  RailType railtype = INVALID_RAILTYPE; 
  RoadType roadtype = INVALID_ROADTYPE; 
  GUIBridgeList bridges{};
  int icon_width = 0; 
  Scrollbar *vscroll = nullptr;

  static bool BridgeIndexSorter(const BuildBridgeData &a, const BuildBridgeData &b)
  {
    return a.index < b.index;
  }

  static bool BridgePriceSorter(const BuildBridgeData &a, const BuildBridgeData &b)
  {
    return a.cost < b.cost;
  }

  static bool BridgeSpeedSorter(const BuildBridgeData &a, const BuildBridgeData &b)
  {
    return a.spec->speed < b.spec->speed;
  }
 
  void BuildBridge(BridgeType type)
  {
    switch (this->transport_type) {
      case TRANSPORT_RAIL: _last_railbridge_type = type; break;
      case TRANSPORT_ROAD: _last_roadbridge_type = type; break;
      default: break;
    }
    Command<Commands::BuildBridge>::Post(STR_ERROR_CAN_T_BUILD_BRIDGE_HERE, CcBuildBridge,
          this->end_tile, this->start_tile, this->transport_type, type, this->railtype, this->roadtype);
  }

  void SortBridgeList()
  {
    this->bridges.Sort();
 
    /* Display the current sort variant */
    this->GetWidget<NWidgetCore>(WID_BBS_DROPDOWN_CRITERIA)->SetString(BuildBridgeWindow::sorter_names[this->bridges.SortType()]);
 
    /* Set the modified widgets dirty */
    this->SetWidgetDirty(WID_BBS_DROPDOWN_CRITERIA);
    this->SetWidgetDirty(WID_BBS_BRIDGE_LIST);
  }

  std::string GetBridgeSelectString(const BuildBridgeData &bridge_data) const
  {
    /* If the bridge has no meaningful speed limit, don't display it. */
    if (bridge_data.spec->speed == UINT16_MAX) {
      return _game_mode == GM_EDITOR
        ? GetString(STR_SELECT_BRIDGE_INFO_NAME, bridge_data.spec->material)
        : GetString(STR_SELECT_BRIDGE_INFO_NAME_COST, bridge_data.spec->material, bridge_data.cost);
    }
 
    uint64_t packed_velocity = PackVelocity(bridge_data.spec->speed, static_cast<VehicleType>(this->transport_type));
    return _game_mode == GM_EDITOR
      ? GetString(STR_SELECT_BRIDGE_INFO_NAME_MAX_SPEED, bridge_data.spec->material, packed_velocity)
      : GetString(STR_SELECT_BRIDGE_INFO_NAME_MAX_SPEED_COST, bridge_data.spec->material, packed_velocity, bridge_data.cost);
  }
 
public:
  BuildBridgeWindow(WindowDesc &desc, TileIndex start, TileIndex end, TransportType transport_type, RailType railtype, RoadType roadtype, GUIBridgeList &&bl) : Window(desc),
    start_tile(start),
    end_tile(end),
    transport_type(transport_type),
    railtype(railtype),
    roadtype(roadtype),
    bridges(std::move(bl))
  {
    this->CreateNestedTree();
    this->vscroll = this->GetScrollbar(WID_BBS_SCROLLBAR);
    /* Change the data, or the caption of the gui. Set it to road or rail, accordingly. */
    this->GetWidget<NWidgetCore>(WID_BBS_CAPTION)->SetString((transport_type == TRANSPORT_ROAD) ? STR_SELECT_ROAD_BRIDGE_CAPTION : STR_SELECT_RAIL_BRIDGE_CAPTION);
    this->FinishInitNested(transport_type); // Initializes 'this->icon_width'.
 
    this->parent = FindWindowById(WC_BUILD_TOOLBAR, transport_type);
    this->bridges.SetListing(BuildBridgeWindow::last_sorting);
    this->bridges.SetSortFuncs(BuildBridgeWindow::sorter_funcs);
    this->bridges.NeedResort();
    this->SortBridgeList();
 
    this->vscroll->SetCount(this->bridges.size());
  }

  ~BuildBridgeWindow() override
  {
    BuildBridgeWindow::last_sorting = this->bridges.GetListing();
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    switch (widget) {
      case WID_BBS_DROPDOWN_ORDER: {
        Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->GetString());
        d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
        d.height += padding.height;
        size = maxdim(size, d);
        break;
      }
      case WID_BBS_DROPDOWN_CRITERIA: {
        Dimension d = GetStringListBoundingBox(BuildBridgeWindow::sorter_names);
        d.width += padding.width;
        d.height += padding.height;
        size = maxdim(size, d);
        break;
      }
      case WID_BBS_BRIDGE_LIST: {
        Dimension sprite_dim = {0, 0}; // Biggest bridge sprite dimension
        Dimension text_dim   = {0, 0}; // Biggest text dimension
        for (const BuildBridgeData &bridge_data : this->bridges) {
          sprite_dim = maxdim(sprite_dim, GetScaledSpriteSize(bridge_data.spec->sprite));
          text_dim = maxdim(text_dim, GetStringBoundingBox(GetBridgeSelectString(bridge_data)));
        }
        fill.height = resize.height = std::max(sprite_dim.height, text_dim.height) + padding.height; // Max of both sizes + account for matrix edges.
 
        this->icon_width = sprite_dim.width; // Width of bridge icon.
        size.width = this->icon_width + WidgetDimensions::scaled.hsep_normal + text_dim.width + padding.width;
        size.height = 4 * resize.height; // Smallest bridge gui is 4 entries high in the matrix.
        break;
      }
    }
  }
 
  Point OnInitialPosition([[maybe_unused]] int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
  {
    /* Position the window so hopefully the first bridge from the list is under the mouse pointer. */
    NWidgetBase *list = this->GetWidget<NWidgetBase>(WID_BBS_BRIDGE_LIST);
    Point corner; // point of the top left corner of the window.
    corner.y = Clamp(_cursor.pos.y - list->pos_y - 5, GetMainViewTop(), GetMainViewBottom() - sm_height);
    corner.x = Clamp(_cursor.pos.x - list->pos_x - 5, 0, _screen.width - sm_width);
    return corner;
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    switch (widget) {
      case WID_BBS_DROPDOWN_ORDER:
        this->DrawSortButtonState(widget, this->bridges.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
        break;
 
      case WID_BBS_BRIDGE_LIST: {
        Rect tr = r.WithHeight(this->resize.step_height).Shrink(WidgetDimensions::scaled.matrix);
        bool rtl = _current_text_dir == TD_RTL;
        auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->bridges);
        for (auto it = first; it != last; ++it) {
          const BridgeSpec *b = it->spec;
          DrawSpriteIgnorePadding(b->sprite, b->pal, tr.WithWidth(this->icon_width, rtl), SA_HOR_CENTER | SA_BOTTOM);
          DrawStringMultiLineWithClipping(tr.Indent(this->icon_width + WidgetDimensions::scaled.hsep_normal, rtl), GetBridgeSelectString(*it));
          tr = tr.Translate(0, this->resize.step_height);
        }
        break;
      }
    }
  }
 
  EventState OnKeyPress([[maybe_unused]] char32_t key, uint16_t keycode) override
  {
    const uint8_t i = keycode - '1';
    if (i < 9 && i < this->bridges.size()) {
      /* Build the requested bridge */
      this->BuildBridge(this->bridges[i].index);
      this->Close();
      return ES_HANDLED;
    }
    return ES_NOT_HANDLED;
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      default: break;
      case WID_BBS_BRIDGE_LIST: {
        auto it = this->vscroll->GetScrolledItemFromWidget(this->bridges, pt.y, this, WID_BBS_BRIDGE_LIST);
        if (it != this->bridges.end()) {
          this->BuildBridge(it->index);
          this->Close();
        }
        break;
      }
 
      case WID_BBS_DROPDOWN_ORDER:
        this->bridges.ToggleSortOrder();
        this->SetDirty();
        break;
 
      case WID_BBS_DROPDOWN_CRITERIA:
        ShowDropDownMenu(this, BuildBridgeWindow::sorter_names, this->bridges.SortType(), WID_BBS_DROPDOWN_CRITERIA, 0, 0);
        break;
    }
  }
 
  void OnDropdownSelect(WidgetID widget, int index, int) override
  {
    if (widget == WID_BBS_DROPDOWN_CRITERIA && this->bridges.SortType() != index) {
      this->bridges.SetSortType(index);
 
      this->SortBridgeList();
    }
  }
 
  void OnResize() override
  {
    this->vscroll->SetCapacityFromWidget(this, WID_BBS_BRIDGE_LIST);
  }
};

Listing BuildBridgeWindow::last_sorting = {true, 2};

const std::initializer_list<GUIBridgeList::SortFunction * const> BuildBridgeWindow::sorter_funcs = {
  &BridgeIndexSorter,
  &BridgePriceSorter,
  &BridgeSpeedSorter
};

static constexpr std::initializer_list<NWidgetPart> _nested_build_bridge_widgets = {
  /* Header */
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, Colours::DarkGreen),
    NWidget(WWT_CAPTION, Colours::DarkGreen, WID_BBS_CAPTION), SetStringTip(STR_SELECT_RAIL_BRIDGE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_DEFSIZEBOX, Colours::DarkGreen),
  EndContainer(),
 
  NWidget(NWID_HORIZONTAL),
    NWidget(NWID_VERTICAL),
      /* Sort order + criteria buttons */
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_TEXTBTN, Colours::DarkGreen, WID_BBS_DROPDOWN_ORDER), SetFill(1, 0), SetStringTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
        NWidget(WWT_DROPDOWN, Colours::DarkGreen, WID_BBS_DROPDOWN_CRITERIA), SetFill(1, 0), SetToolTip(STR_TOOLTIP_SORT_CRITERIA),
      EndContainer(),
      /* Matrix. */
      NWidget(WWT_MATRIX, Colours::DarkGreen, WID_BBS_BRIDGE_LIST), SetFill(1, 0), SetResize(0, 22), SetMatrixDataTip(1, 0, STR_SELECT_BRIDGE_SELECTION_TOOLTIP), SetScrollbar(WID_BBS_SCROLLBAR),
    EndContainer(),
 
    /* scrollbar + resize button */
    NWidget(NWID_VERTICAL),
      NWidget(NWID_VSCROLLBAR, Colours::DarkGreen, WID_BBS_SCROLLBAR),
      NWidget(WWT_RESIZEBOX, Colours::DarkGreen),
    EndContainer(),
  EndContainer(),
};

static WindowDesc _build_bridge_desc(
  WDP_AUTO, "build_bridge", 200, 114,
  WC_BUILD_BRIDGE, WC_BUILD_TOOLBAR,
  WindowDefaultFlag::Construction,
  _nested_build_bridge_widgets
);

void ShowBuildBridgeWindow(TileIndex start, TileIndex end, TransportType transport_type, RailType railtype, RoadType roadtype)
{
  CloseWindowByClass(WC_BUILD_BRIDGE);
 
  /* The bridge length without ramps. */
  const uint bridge_len = GetTunnelBridgeLength(start, end);
 
  /* If Ctrl is being pressed, check whether the last bridge built is available
   * If so, return this bridge type. Otherwise continue normally.
   * We store bridge types for each transport type, so we have to check for
   * the transport type beforehand.
   */
  BridgeType last_bridge_type = 0;
  switch (transport_type) {
    case TRANSPORT_ROAD: last_bridge_type = _last_roadbridge_type; break;
    case TRANSPORT_RAIL: last_bridge_type = _last_railbridge_type; break;
    default: break; // water ways and air routes don't have bridge types
  }
  if (_ctrl_pressed && CheckBridgeAvailability(last_bridge_type, bridge_len).Succeeded()) {
    Command<Commands::BuildBridge>::Post(STR_ERROR_CAN_T_BUILD_BRIDGE_HERE, CcBuildBridge, end, start, transport_type, last_bridge_type, railtype, roadtype);
    return;
  }
 
  /* only query bridge building possibility once, result is the same for all bridges!
   * returns CMD_ERROR on failure, and price on success */
  CommandCost ret = Command<Commands::BuildBridge>::Do(CommandFlagsToDCFlags(GetCommandFlags<Commands::BuildBridge>()) | DoCommandFlag::QueryCost, end, start, transport_type, 0, railtype, roadtype);
 
  GUIBridgeList bl;
  if (!ret.Failed()) {
    /* check which bridges can be built */
    const uint tot_bridgedata_len = CalcBridgeLenCostFactor(bridge_len + 2);
 
    Money infra_cost = 0;
    switch (transport_type) {
      case TRANSPORT_ROAD: {
        /* In case we add a new road type as well, we must be aware of those costs. */
        RoadType road_rt = INVALID_ROADTYPE;
        RoadType tram_rt = INVALID_ROADTYPE;
        if (IsBridgeTile(start)) {
          road_rt = GetRoadTypeRoad(start);
          tram_rt = GetRoadTypeTram(start);
        }
        if (RoadTypeIsRoad(roadtype)) {
          road_rt = roadtype;
        } else {
          tram_rt = roadtype;
        }
 
        if (road_rt != INVALID_ROADTYPE) infra_cost += (bridge_len + 2) * 2 * RoadBuildCost(road_rt);
        if (tram_rt != INVALID_ROADTYPE) infra_cost += (bridge_len + 2) * 2 * RoadBuildCost(tram_rt);
 
        break;
      }
      case TRANSPORT_RAIL: infra_cost = (bridge_len + 2) * RailBuildCost(railtype); break;
      default: break;
    }
 
    bool any_available = false;
    CommandCost type_check;
    /* loop for all bridgetypes */
    for (BridgeType brd_type = 0; brd_type != MAX_BRIDGES; brd_type++) {
      type_check = CheckBridgeAvailability(brd_type, bridge_len);
      if (type_check.Succeeded()) {
        /* bridge is accepted, add to list */
        BuildBridgeData &item = bl.emplace_back();
        item.index = brd_type;
        item.spec = GetBridgeSpec(brd_type);
        /* Add to terraforming & bulldozing costs the cost of the
         * bridge itself (not computed with DoCommandFlag::QueryCost) */
        item.cost = ret.GetCost() + (((int64_t)tot_bridgedata_len * _price[Price::BuildBridge] * item.spec->price) >> 8) + infra_cost;
        any_available = true;
      }
    }
    /* give error cause if no bridges available here*/
    if (!any_available) ret = std::move(type_check);
  }
 
  if (!bl.empty()) {
    new BuildBridgeWindow(_build_bridge_desc, start, end, transport_type, railtype, roadtype, std::move(bl));
  } else {
    ShowErrorMessage(GetEncodedString(STR_ERROR_CAN_T_BUILD_BRIDGE_HERE), TileX(end) * TILE_SIZE, TileY(end) * TILE_SIZE, ret);
  }
}