#include "stdafx.h"
#include "gui.h"
#include "window_gui.h"
#include "station_gui.h"
#include "terraform_gui.h"
#include "viewport_func.h"
#include "command_func.h"
#include "waypoint_func.h"
#include "newgrf_station.h"
#include "company_base.h"
#include "strings_func.h"
#include "window_func.h"
#include "sound_func.h"
#include "company_func.h"
#include "widgets/dropdown_type.h"
#include "tunnelbridge.h"
#include "tilehighlight_func.h"
#include "spritecache.h"
#include "core/geometry_func.hpp"
#include "hotkeys.h"
#include "engine_base.h"
#include "vehicle_func.h"
#include "zoom_func.h"
#include "rail_gui.h"
#include "querystring_gui.h"
#include "sortlist_type.h"
#include "stringfilter_type.h"
#include "string_func.h"
#include "station_cmd.h"
#include "tunnelbridge_cmd.h"
#include "waypoint_cmd.h"
#include "rail_cmd.h"
#include "timer/timer.h"
#include "timer/timer_game_calendar.h"
#include "station_map.h"
#include "tunnelbridge_map.h"
#include "widgets/rail_widget.h"
#include "safeguards.h"

Data Structures
struct	RailStationGUISettings

struct	BuildRailToolbarWindow
	Rail toolbar management class. More...

struct	BuildRailStationWindow

struct	BuildSignalWindow

struct	BuildRailDepotWindow

struct	BuildRailWaypointWindow

Enumerations
enum	BuildRalStationHotkeys { BRASHK_FOCUS_FILTER_BOX }
	Enum referring to the Hotkeys in the build rail station window. More...

Functions
static void	HandleStationPlacement (TileIndex start, TileIndex end)

static void	ShowBuildTrainDepotPicker (Window *parent)

static void	ShowBuildWaypointPicker (Window *parent)

static Window *	ShowStationBuilder (Window *parent)
	Open station build window.

static void	ShowSignalBuilder (Window *parent)
	Open the signal selection window.

static bool	IsStationAvailable (const StationSpec *statspec)
	Check whether a station type can be build. More...

void	CcPlaySound_CONSTRUCTION_RAIL (Commands, const CommandCost &result, TileIndex tile)

static void	GenericPlaceRail (TileIndex tile, Track track)

static void	PlaceExtraDepotRail (TileIndex tile, DiagDirection dir, Track track)
	Try to add an additional rail-track at the entrance of a depot. More...

void	CcRailDepot (Commands, const CommandCost &result, TileIndex tile, RailType, DiagDirection dir)

static void	PlaceRail_Waypoint (TileIndex tile)
	Place a rail waypoint. More...

void	CcStation (Commands, const CommandCost &result, TileIndex tile)

static void	PlaceRail_Station (TileIndex tile)
	Place a rail station. More...

static void	GenericPlaceSignals (TileIndex tile)
	Build a new signal or edit/remove a present signal, use CmdBuildSingleSignal() or CmdRemoveSingleSignal() in rail_cmd.cpp. More...

static void	PlaceRail_Bridge (TileIndex tile, Window *w)
	Start placing a rail bridge. More...

void	CcBuildRailTunnel (Commands, const CommandCost &result, TileIndex tile)
	Command callback for building a tunnel.

static void	ToggleRailButton_Remove (Window *w)
	Toggles state of the Remove button of Build rail toolbar. More...

static bool	RailToolbar_CtrlChanged (Window *w)
	Updates the Remove button because of Ctrl state change. More...

static void	BuildRailClick_Remove (Window *w)
	The "remove"-button click proc of the build-rail toolbar. More...

static void	DoRailroadTrack (Track track)

static void	HandleAutodirPlacement ()

static void	HandleAutoSignalPlacement ()
	Build new signals or remove signals or (if only one tile marked) edit a signal. More...

Window *	ShowBuildRailToolbar (RailType railtype)
	Open the build rail toolbar window for a specific rail type. More...

void	InitializeRailGui ()
	Initialize rail building GUI settings.

void	ReinitGuiAfterToggleElrail (bool disable)
	Re-initialize rail-build toolbar after toggling support for electric trains. More...

static void	SetDefaultRailGui ()
	Set the initial (default) railtype to use.

void	ResetSignalVariant (int32_t)
	Updates the current signal variant used in the signal GUI to the one adequate to current year.

void	InitializeRailGUI ()
	Resets the rail GUI - sets default railtype to build and resets the signal GUI.

DropDownList	GetRailTypeDropDownList (bool for_replacement, bool all_option)
	Create a drop down list for all the rail types of the local company. More...

Variables
static RailType	_cur_railtype
	Rail type of the current build-rail toolbar.

static bool	_remove_button_clicked
	Flag whether 'remove' toggle-button is currently enabled.

static DiagDirection	_build_depot_direction
	Currently selected depot direction.

static uint16_t	_cur_waypoint_type
	Currently selected waypoint type.

static bool	_convert_signal_button
	convert signal button in the signal GUI pressed

static SignalVariant	_cur_signal_variant
	set the signal variant (for signal GUI)

static SignalType	_cur_signal_type
	set the signal type (for signal GUI)

static RailStationGUISettings	_railstation
	Settings of the station builder GUI.

static const Track	_place_depot_extra_track [12]
	Additional pieces of track to add at the entrance of a depot. More...

static const DiagDirection	_place_depot_extra_dir [12]
	Direction to check for existing track pieces. More...

static constexpr NWidgetPart	_nested_build_rail_widgets []

static WindowDesc	_build_rail_desc (__FILE__, __LINE__, WDP_ALIGN_TOOLBAR, "toolbar_rail", 0, 0, WC_BUILD_TOOLBAR, WC_NONE, WDF_CONSTRUCTION, std::begin(_nested_build_rail_widgets), std::end(_nested_build_rail_widgets), &BuildRailToolbarWindow::hotkeys)

static constexpr NWidgetPart	_nested_station_builder_widgets []

static WindowDesc	_station_builder_desc (__FILE__, __LINE__, WDP_AUTO, "build_station_rail", 350, 0, WC_BUILD_STATION, WC_BUILD_TOOLBAR, WDF_CONSTRUCTION, std::begin(_nested_station_builder_widgets), std::end(_nested_station_builder_widgets), &BuildRailStationWindow::hotkeys)
	High level window description of the station-build window (default & newGRF)

static constexpr NWidgetPart	_nested_signal_builder_widgets []
	Nested widget definition of the build signal window.

static WindowDesc	_signal_builder_desc (__FILE__, __LINE__, WDP_AUTO, nullptr, 0, 0, WC_BUILD_SIGNAL, WC_BUILD_TOOLBAR, WDF_CONSTRUCTION, std::begin(_nested_signal_builder_widgets), std::end(_nested_signal_builder_widgets))
	Signal selection window description.

static constexpr NWidgetPart	_nested_build_depot_widgets []
	Nested widget definition of the build rail depot window. More...

static WindowDesc	_build_depot_desc (__FILE__, __LINE__, WDP_AUTO, nullptr, 0, 0, WC_BUILD_DEPOT, WC_BUILD_TOOLBAR, WDF_CONSTRUCTION, std::begin(_nested_build_depot_widgets), std::end(_nested_build_depot_widgets))

static constexpr NWidgetPart	_nested_build_waypoint_widgets []
	Nested widget definition for the build NewGRF rail waypoint window. More...

static WindowDesc	_build_waypoint_desc (__FILE__, __LINE__, WDP_AUTO, "build_waypoint", 0, 0, WC_BUILD_WAYPOINT, WC_BUILD_TOOLBAR, WDF_CONSTRUCTION, std::begin(_nested_build_waypoint_widgets), std::end(_nested_build_waypoint_widgets))

static IntervalTimer< TimerGameCalendar >	_check_reset_signal ({TimerGameCalendar::YEAR, TimerGameCalendar::Priority::NONE}, [](auto) { if(TimerGameCalendar::year !=_settings_client.gui.semaphore_build_before) return;ResetSignalVariant();})

Detailed Description

File for dealing with rail construction user interface

Definition in file rail_gui.cpp.

Enumeration Type Documentation

◆ BuildRalStationHotkeys

enum BuildRalStationHotkeys

Enum referring to the Hotkeys in the build rail station window.

Enumerator
BRASHK_FOCUS_FILTER_BOX	Focus the edit box for editing the filter string.

Definition at line 949 of file rail_gui.cpp.

Function Documentation

◆ BuildRailClick_Remove()

static void BuildRailClick_Remove ( Window * w )

static

The "remove"-button click proc of the build-rail toolbar.

Parameters

w	Build-rail toolbar window

See also: BuildRailToolbarWindow::OnClick()

Definition at line 345 of file rail_gui.cpp.

References _settings_client, SoundSettings::click_beep, Window::IsWidgetDisabled(), ClientSettings::sound, ToggleRailButton_Remove(), and WID_RAT_REMOVE.

◆ GenericPlaceSignals()

static void GenericPlaceSignals ( TileIndex tile )

static

Build a new signal or edit/remove a present signal, use CmdBuildSingleSignal() or CmdRemoveSingleSignal() in rail_cmd.cpp.

Parameters

tile	The tile where the signal will build or edit

Definition at line 226 of file rail_gui.cpp.

References GetTileTrackStatus(), TRACK_BIT_VERT, TrackStatusToTrackBits(), and TRANSPORT_RAIL.

◆ GetRailTypeDropDownList()

DropDownList GetRailTypeDropDownList	(	bool	for_replacement,
		bool	all_option
	)

Create a drop down list for all the rail types of the local company.

Parameters

for_replacement	Whether this list is for the replacement window.
all_option	Whether to add an 'all types' item.

Returns: The populated and sorted DropDownList.

Definition at line 2372 of file rail_gui.cpp.

References _local_company, Company::avail_railtypes, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), GetCompanyRailTypes(), GetRailTypes(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, and INVALID_RAILTYPE.

◆ HandleAutoSignalPlacement()

static void HandleAutoSignalPlacement ( )

static

Build new signals or remove signals or (if only one tile marked) edit a signal.

If one tile marked abort and use GenericPlaceSignals() else use CmdBuildSingleSignal() or CmdRemoveSingleSignal() in rail_cmd.cpp to build many signals

Definition at line 403 of file rail_gui.cpp.

References GB().

◆ IsStationAvailable()

static bool IsStationAvailable ( const StationSpec * statspec )

static

Check whether a station type can be build.

Returns: true if building is allowed.

Definition at line 82 of file rail_gui.cpp.

References StationSpec::callback_mask, CBM_STATION_AVAIL, and HasBit().

◆ PlaceExtraDepotRail()

static void PlaceExtraDepotRail	(	TileIndex	tile,
		DiagDirection	dir,
		Track	track
	)

static

Try to add an additional rail-track at the entrance of a depot.

Parameters

tile	Tile to use for adding the rail-track
dir	Direction to check for already present tracks
track	Track to add

See also: CcRailDepot()

Definition at line 115 of file rail_gui.cpp.

References _cur_railtype, _settings_client, GUISettings::auto_remove_signals, DiagdirReachesTracks(), GetRailTileType(), GetTrackBits(), ClientSettings::gui, RAIL_TILE_DEPOT, and RAIL_TILE_SIGNALS.

◆ PlaceRail_Bridge()

static void PlaceRail_Bridge	(	TileIndex	tile,
		Window *	w
	)

static

Start placing a rail bridge.

Parameters

tile	Position of the first tile of the bridge.
w	Rail toolbar window.

Definition at line 284 of file rail_gui.cpp.

References DDSP_BUILD_BRIDGE, GetOtherTunnelBridgeEnd(), IsBridgeTile(), Window::OnPlaceMouseUp(), VPM_X_OR_Y, and VpStartPlaceSizing().

◆ PlaceRail_Station()

static void PlaceRail_Station ( TileIndex tile )

static

Place a rail station.

Parameters

tile	Position to place or start dragging a station.

Definition at line 190 of file rail_gui.cpp.

References _remove_button_clicked, DDSP_REMOVE_STATION, VPM_X_AND_Y_LIMITED, and VpStartPlaceSizing().

◆ PlaceRail_Waypoint()

static void PlaceRail_Waypoint ( TileIndex tile )

static

Place a rail waypoint.

Parameters

tile	Position to start dragging a waypoint.

Definition at line 158 of file rail_gui.cpp.

References _remove_button_clicked, AXIS_X, DDSP_BUILD_STATION, DDSP_REMOVE_STATION, GetAxisForNewWaypoint(), IsValidAxis(), VPM_X_AND_Y, VPM_X_LIMITED, VPM_Y_LIMITED, and VpStartPlaceSizing().

◆ RailToolbar_CtrlChanged()

static bool RailToolbar_CtrlChanged ( Window * w )

static

Updates the Remove button because of Ctrl state change.

Parameters

w	window the button belongs to

Returns: true iff the remove button was changed

Definition at line 324 of file rail_gui.cpp.

References Window::IsWidgetDisabled(), Window::IsWidgetLowered(), ToggleRailButton_Remove(), WID_RAT_BUILD_NS, WID_RAT_BUILD_STATION, WID_RAT_BUILD_WAYPOINT, and WID_RAT_REMOVE.

Referenced by BuildRailToolbarWindow::OnCTRLStateChange().

◆ ReinitGuiAfterToggleElrail()

void ReinitGuiAfterToggleElrail ( bool disable )

Re-initialize rail-build toolbar after toggling support for electric trains.

Parameters

disable Boolean whether electric trains are disabled (removed from the game)

Definition at line 2269 of file rail_gui.cpp.

Referenced by SettingsDisableElrail().

◆ ShowBuildRailToolbar()

Window* ShowBuildRailToolbar ( RailType railtype )

Open the build rail toolbar window for a specific rail type.

If the terraform toolbar is linked to the toolbar, that window is also opened.

Parameters

railtype Rail type to open the window for

Returns: newly opened rail toolbar, or nullptr if the toolbar could not be opened.

Definition at line 911 of file rail_gui.cpp.

References _cur_railtype, _local_company, _remove_button_clicked, CloseWindowByClass(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), ValParamRailType(), and WC_BUILD_TOOLBAR.

◆ ToggleRailButton_Remove()

static void ToggleRailButton_Remove ( Window * w )

static

Toggles state of the Remove button of Build rail toolbar.

Parameters

w	window the button belongs to

Definition at line 310 of file rail_gui.cpp.

References _remove_button_clicked, CloseWindowById(), Window::IsWidgetLowered(), Window::SetWidgetDirty(), Window::ToggleWidgetLoweredState(), WC_SELECT_STATION, and WID_RAT_REMOVE.

Referenced by BuildRailClick_Remove(), and RailToolbar_CtrlChanged().

Variable Documentation

◆ _nested_build_depot_widgets

constexpr NWidgetPart _nested_build_depot_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
    NWidget(NWID_HORIZONTAL_LTR), SetPIP(0, WidgetDimensions::unscaled.hsep_normal, 0), SetPIPRatio(1, 0, 1), SetPadding(WidgetDimensions::unscaled.picker),
      NWidget(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_normal, 0),
        NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_NW), SetMinimalSize(66, 50), SetDataTip(0x0, STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
        NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_SW), SetMinimalSize(66, 50), SetDataTip(0x0, STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
      EndContainer(),
      NWidget(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_normal, 0),
        NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_NE), SetMinimalSize(66, 50), SetDataTip(0x0, STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
        NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_SE), SetMinimalSize(66, 50), SetDataTip(0x0, STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
      EndContainer(),
    EndContainer(),
  EndContainer(),
}

Nested widget definition of the build rail depot window.

Definition at line 1996 of file rail_gui.cpp.

◆ _nested_build_waypoint_widgets

constexpr NWidgetPart _nested_build_waypoint_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_WAYPOINT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
    NWidget(WWT_EDITBOX, COLOUR_DARK_GREEN, WID_BRW_FILTER), SetPadding(2), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetScrollbar(WID_BRW_SCROLL),
      NWidget(NWID_MATRIX, COLOUR_DARK_GREEN, WID_BRW_WAYPOINT_MATRIX), SetPIP(0, 2, 0), SetPadding(WidgetDimensions::unscaled.picker),
        NWidget(WWT_PANEL, COLOUR_GREY, WID_BRW_WAYPOINT), SetDataTip(0x0, STR_WAYPOINT_GRAPHICS_TOOLTIP), SetScrollbar(WID_BRW_SCROLL), EndContainer(),
      EndContainer(),
    EndContainer(),
    NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_BRW_SCROLL),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
      NWidget(WWT_TEXT, COLOUR_DARK_GREEN, WID_BRW_NAME), SetPadding(2), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_JUST_STRING, STR_NULL), SetTextStyle(TC_ORANGE), SetAlignment(SA_CENTER),
    EndContainer(),
    NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
  EndContainer(),
}

Nested widget definition for the build NewGRF rail waypoint window.

Definition at line 2219 of file rail_gui.cpp.

◆ _place_depot_extra_dir

const DiagDirection _place_depot_extra_dir[12]

static

Initial value:

= {
  DIAGDIR_SE, DIAGDIR_SW, DIAGDIR_SE, DIAGDIR_SW,
  DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NE, DIAGDIR_SE,
  DIAGDIR_NW, DIAGDIR_NE, DIAGDIR_NW, DIAGDIR_NE,
}

Direction to check for existing track pieces.

Definition at line 132 of file rail_gui.cpp.

◆ _place_depot_extra_track

const Track _place_depot_extra_track[12]

static

Initial value:

= {
  TRACK_LEFT,  TRACK_UPPER, TRACK_UPPER, TRACK_RIGHT, 
  TRACK_X,     TRACK_Y,     TRACK_X,     TRACK_Y,     
  TRACK_LOWER, TRACK_LEFT,  TRACK_RIGHT, TRACK_LOWER, 
}

Additional pieces of track to add at the entrance of a depot.

Definition at line 125 of file rail_gui.cpp.

Data Structures

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ BuildRalStationHotkeys

Function Documentation

◆ BuildRailClick_Remove()

◆ GenericPlaceSignals()

◆ GetRailTypeDropDownList()

◆ HandleAutoSignalPlacement()

◆ IsStationAvailable()

◆ PlaceExtraDepotRail()

◆ PlaceRail_Bridge()

◆ PlaceRail_Station()

◆ PlaceRail_Waypoint()

◆ RailToolbar_CtrlChanged()

◆ ReinitGuiAfterToggleElrail()

◆ ShowBuildRailToolbar()

◆ ToggleRailButton_Remove()

Variable Documentation

◆ _nested_build_depot_widgets

◆ _nested_build_waypoint_widgets

◆ _place_depot_extra_dir

◆ _place_depot_extra_track