1

/* $Id$ */

     2

     3

/** @file rail_gui.cpp File for dealing with rail construction user interface */

     4

     5

#include "stdafx.h"

     6

#include "direction_type.h"

     7

#include "openttd.h"

     8

#include "tile_cmd.h"

     9

#include "landscape.h"

    10

#include "gui.h"

    11

#include "window_gui.h"

    12

#include "station_gui.h"

    13

#include "terraform_gui.h"

    14

#include "viewport_func.h"

    15

#include "gfx_func.h"

    16

#include "command_func.h"

    17

#include "town_type.h"

    18

#include "waypoint.h"

    19

#include "debug.h"

    20

#include "variables.h"

    21

#include "newgrf_callbacks.h"

    22

#include "newgrf_station.h"

    23

#include "train.h"

    24

#include "strings_func.h"

    25

#include "functions.h"

    26

#include "window_func.h"

    27

#include "date_func.h"

    28

#include "sound_func.h"

    29

#include "company_func.h"

    30

#include "settings_type.h"

    31

#include "widgets/dropdown_type.h"

    32

#include "widgets/dropdown_func.h"

    33

#include "tunnelbridge.h"

    34

#include "tilehighlight_func.h"

    35

    36

#include "bridge_map.h"

    37

#include "rail_map.h"

    38

#include "road_map.h"

    39

#include "station_map.h"

    40

#include "tunnel_map.h"

    41

#include "tunnelbridge_map.h"

    42

    43

#include "table/sprites.h"

    44

#include "table/strings.h"

    45

    46

static RailType _cur_railtype;               ///< Rail type of the current build-rail toolbar.

    47

static bool _remove_button_clicked;          ///< Flag whether 'remove' toggle-button is currently enabled

    48

static DiagDirection _build_depot_direction; ///< Currently selected depot direction

    49

static byte _waypoint_count = 1;             ///< Number of waypoint types

    50

static byte _cur_waypoint_type;              ///< Currently selected waypoint type

    51

static bool _convert_signal_button;          ///< convert signal button in the signal GUI pressed

    52

static SignalVariant _cur_signal_variant;    ///< set the signal variant (for signal GUI)

    53

static SignalType _cur_signal_type;          ///< set the signal type (for signal GUI)

    54

    55

/* Map _patches.default_signal_type to the corresponding signal type */

    56

static const SignalType _default_signal_type[] = {SIGTYPE_NORMAL, SIGTYPE_PBS, SIGTYPE_PBS_ONEWAY};

    57

    58

struct RailStationGUISettings {

    59

	Axis orientation;                 ///< Currently selected rail station orientation

    60

	byte numtracks;                   ///< Currently selected number of tracks in station (if not \c dragdrop )

    61

	byte platlength;                  ///< Currently selected platform length of station (if not \c dragdrop )

    62

	bool dragdrop;                    ///< Use drag & drop to place a station

    63

    64

	bool newstations;                 ///< Are custom station definitions available?

    65

	StationClassIDByte station_class; ///< Currently selected custom station class (if newstations is \c true )

    66

	byte station_type;                ///< Station type within the currently selected custom station class (if newstations is \c true )

    67

	byte station_count;               ///< Number of custom stations (if newstations is \c true )

    68

};

    69

static RailStationGUISettings _railstation; ///< Settings of the station builder GUI

    70

    71

    72

static void HandleStationPlacement(TileIndex start, TileIndex end);

    73

static void ShowBuildTrainDepotPicker(Window *parent);

    74

static void ShowBuildWaypointPicker(Window *parent);

    75

static void ShowStationBuilder(Window *parent);

    76

static void ShowSignalBuilder(Window *parent);

    77

    78

void CcPlaySound1E(bool success, TileIndex tile, uint32 p1, uint32 p2)

    79

{

    80

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    81

}

    82

    83

static void GenericPlaceRail(TileIndex tile, int cmd)

    84

{

    85

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    86

		_remove_button_clicked ?

    87

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    88

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    89

	);

    90

}

    91

    92

static void PlaceRail_N(TileIndex tile)

    93

{

    94

	int cmd = _tile_fract_coords.x > _tile_fract_coords.y ? 4 : 5;

    95

	GenericPlaceRail(tile, cmd);

    96

}

    97

    98

static void PlaceRail_NE(TileIndex tile)

    99

{

   100

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

   101

}

   102

   103

static void PlaceRail_E(TileIndex tile)

   104

{

   105

	int cmd = _tile_fract_coords.x + _tile_fract_coords.y <= 15 ? 2 : 3;

   106

	GenericPlaceRail(tile, cmd);

   107

}

   108

   109

static void PlaceRail_NW(TileIndex tile)

   110

{

   111

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   112

}

   113

   114

static void PlaceRail_AutoRail(TileIndex tile)

   115

{

   116

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   117

}

   118

   119

/**

   120

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

   121

 * @param tile  Tile to use for adding the rail-track

   122

 * @param extra Track to add

   123

 * @see CcRailDepot()

   124

 */

   125

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   126

{

   127

	if (GetRailTileType(tile) != RAIL_TILE_NORMAL) return;

   128

	if ((GetTrackBits(tile) & GB(extra, 8, 8)) == 0) return;

   129

   130

	DoCommandP(tile, _cur_railtype, extra & 0xFF, NULL, CMD_BUILD_SINGLE_RAIL | CMD_NO_WATER);

   131

}

   132

   133

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

   134

static const uint16 _place_depot_extra[12] = {

   135

	0x0604, 0x2102, 0x1202, 0x0505,  // First additional track for directions 0..3

   136

	0x2400, 0x2801, 0x1800, 0x1401,  // Second additional track

   137

	0x2203, 0x0904, 0x0A05, 0x1103,  // Third additional track

   138

};

   139

   140

   141

void CcRailDepot(bool success, TileIndex tile, uint32 p1, uint32 p2)

   142

{

   143

	if (success) {

   144

		DiagDirection dir = (DiagDirection)p2;

   145

   146

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   147

		ResetObjectToPlace();

   148

   149

		tile += TileOffsByDiagDir(dir);

   150

   151

		if (IsTileType(tile, MP_RAILWAY)) {

   152

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   153

			PlaceExtraDepotRail(tile, _place_depot_extra[dir + 4]);

   154

			PlaceExtraDepotRail(tile, _place_depot_extra[dir + 8]);

   155

		}

   156

	}

   157

}

   158

   159

static void PlaceRail_Depot(TileIndex tile)

   160

{

   161

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   162

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   163

}

   164

   165

static void PlaceRail_Waypoint(TileIndex tile)

   166

{

   167

	if (_remove_button_clicked) {

   168

		DoCommandP(tile, 0, 0, CcPlaySound1E, CMD_REMOVE_TRAIN_WAYPOINT | CMD_MSG(STR_CANT_REMOVE_TRAIN_WAYPOINT));

   169

	} else {

   170

		DoCommandP(tile, _cur_waypoint_type, 0, CcPlaySound1E, CMD_BUILD_TRAIN_WAYPOINT | CMD_MSG(STR_CANT_BUILD_TRAIN_WAYPOINT));

   171

	}

   172

}

   173

   174

void CcStation(bool success, TileIndex tile, uint32 p1, uint32 p2)

   175

{

   176

	if (success) {

   177

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   178

		/* Only close the station builder window if the default station is chosen. */

   179

		if (_railstation.station_class == STAT_CLASS_DFLT && _railstation.station_type == 0) ResetObjectToPlace();

   180

	}

   181

}

   182

   183

static void PlaceRail_Station(TileIndex tile)

   184

{

   185

	if (_remove_button_clicked) {

   186

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_REMOVE_STATION);

   187

		VpSetPlaceSizingLimit(-1);

   188

	} else if (_railstation.dragdrop) {

   189

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   190

		VpSetPlaceSizingLimit(_settings_game.station.station_spread);

   191

	} else {

   192

		DoCommandP(tile,

   193

				_railstation.orientation | (_railstation.numtracks << 8) | (_railstation.platlength << 16) | (_ctrl_pressed << 24),

   194

				_cur_railtype | (_railstation.station_class << 8) | (_railstation.station_type << 16), CcStation,

   195

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   196

	}

   197

}

   198

   199

/**

   200

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

   201

 *

   202

 * @param tile The tile where the signal will build or edit

   203

 */

   204

static void GenericPlaceSignals(TileIndex tile)

   205

{

   206

	TrackBits trackbits = TrackStatusToTrackBits(GetTileTrackStatus(tile, TRANSPORT_RAIL, 0));

   207

   208

	if (trackbits & TRACK_BIT_VERT) { // N-S direction

   209

		trackbits = (_tile_fract_coords.x <= _tile_fract_coords.y) ? TRACK_BIT_RIGHT : TRACK_BIT_LEFT;

   210

	}

   211

   212

	if (trackbits & TRACK_BIT_HORZ) { // E-W direction

   213

		trackbits = (_tile_fract_coords.x + _tile_fract_coords.y <= 15) ? TRACK_BIT_UPPER : TRACK_BIT_LOWER;

   214

	}

   215

   216

	Track track = FindFirstTrack(trackbits);

   217

   218

	if (_remove_button_clicked) {

   219

		DoCommandP(tile, track, 0, CcPlaySound1E,

   220

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   221

	} else {

   222

		const Window *w = FindWindowById(WC_BUILD_SIGNAL, 0);

   223

   224

		/* Map _patches.cycle_signal_types to the lower and upper allowed signal type. */

   225

		static const uint cycle_bounds[] = {SIGTYPE_NORMAL | (SIGTYPE_LAST_NOPBS << 3), SIGTYPE_PBS | (SIGTYPE_LAST << 3), SIGTYPE_NORMAL | (SIGTYPE_LAST << 3)};

   226

   227

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   228

		uint32 p1 = track;

   229

   230

		if (w != NULL) {

   231

			/* signal GUI is used */

   232

			SB(p1, 3, 1, _ctrl_pressed);

   233

			SB(p1, 4, 1, _cur_signal_variant);

   234

			SB(p1, 5, 3, _cur_signal_type);

   235

			SB(p1, 8, 1, _convert_signal_button);

   236

			SB(p1, 9, 6, cycle_bounds[_settings_client.gui.cycle_signal_types]);

   237

		} else {

   238

			SB(p1, 3, 1, _ctrl_pressed);

   239

			SB(p1, 4, 1, (_cur_year < _settings_client.gui.semaphore_build_before ? SIG_SEMAPHORE : SIG_ELECTRIC));

   240

			SB(p1, 5, 3, _default_signal_type[_settings_client.gui.default_signal_type]);

   241

			SB(p1, 8, 1, 0);

   242

			SB(p1, 9, 6, cycle_bounds[_settings_client.gui.cycle_signal_types]);

   243

		}

   244

   245

		DoCommandP(tile, p1, 0, CcPlaySound1E, CMD_BUILD_SIGNALS |

   246

			CMD_MSG((w != NULL && _convert_signal_button) ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   247

	}

   248

}

   249

   250

static void PlaceRail_Bridge(TileIndex tile)

   251

{

   252

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   253

}

   254

   255

/** Command callback for building a tunnel */

   256

void CcBuildRailTunnel(bool success, TileIndex tile, uint32 p1, uint32 p2)

   257

{

   258

	if (success) {

   259

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   260

		ResetObjectToPlace();

   261

	} else {

   262

		SetRedErrorSquare(_build_tunnel_endtile);

   263

	}

   264

}

   265

   266

static void PlaceRail_Tunnel(TileIndex tile)

   267

{

   268

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   269

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   270

}

   271

   272

static void PlaceRail_ConvertRail(TileIndex tile)

   273

{

   274

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   275

}

   276

   277

static void PlaceRail_AutoSignals(TileIndex tile)

   278

{

   279

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   280

}

   281

   282

   283

/** Enum referring to the widgets of the build rail toolbar */

   284

enum RailToolbarWidgets {

   285

	RTW_CLOSEBOX = 0,

   286

	RTW_CAPTION,

   287

	RTW_STICKY,

   288

	RTW_SPACER,

   289

	RTW_BUILD_NS,

   290

	RTW_BUILD_X,

   291

	RTW_BUILD_EW,

   292

	RTW_BUILD_Y,

   293

	RTW_AUTORAIL,

   294

	RTW_DEMOLISH,

   295

	RTW_BUILD_DEPOT,

   296

	RTW_BUILD_WAYPOINT,

   297

	RTW_BUILD_STATION,

   298

	RTW_BUILD_SIGNALS,

   299

	RTW_BUILD_BRIDGE,

   300

	RTW_BUILD_TUNNEL,

   301

	RTW_REMOVE,

   302

	RTW_CONVERT_RAIL,

   303

};

   304

   305

   306

/** Toggles state of the Remove button of Build rail toolbar

   307

 * @param w window the button belongs to

   308

 */

   309

static void ToggleRailButton_Remove(Window *w)

   310

{

   311

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   312

	w->InvalidateWidget(RTW_REMOVE);

   313

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   314

	SetSelectionRed(_remove_button_clicked);

   315

}

   316

   317

/** Updates the Remove button because of Ctrl state change

   318

 * @param w window the button belongs to

   319

 * @return true iff the remove buton was changed

   320

 */

   321

static bool RailToolbar_CtrlChanged(Window *w)

   322

{

   323

	if (w->IsWidgetDisabled(RTW_REMOVE)) return false;

   324

   325

	/* allow ctrl to switch remove mode only for these widgets */

   326

	for (uint i = RTW_BUILD_NS; i <= RTW_BUILD_STATION; i++) {

   327

		if ((i <= RTW_AUTORAIL || i >= RTW_BUILD_WAYPOINT) && w->IsWidgetLowered(i)) {

   328

			ToggleRailButton_Remove(w);

   329

			return true;

   330

		}

   331

	}

   332

   333

	return false;

   334

}

   335

   336

   337

/**

   338

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

   339

 * @param w Build-rail toolbar window

   340

 * @see BuildRailToolbWndProc()

   341

 */

   342

static void BuildRailClick_N(Window *w)

   343

{

   344

	HandlePlacePushButton(w, RTW_BUILD_NS, GetRailTypeInfo(_cur_railtype)->cursor.rail_ns, VHM_RECT, PlaceRail_N);

   345

}

   346

   347

/**

   348

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

   349

 * @param w Build-rail toolbar window

   350

 * @see BuildRailToolbWndProc()

   351

 */

   352

static void BuildRailClick_NE(Window *w)

   353

{

   354

	HandlePlacePushButton(w, RTW_BUILD_X, GetRailTypeInfo(_cur_railtype)->cursor.rail_swne, VHM_RECT, PlaceRail_NE);

   355

}

   356

   357

/**

   358

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

   359

 * @param w Build-rail toolbar window

   360

 * @see BuildRailToolbWndProc()

   361

 */

   362

static void BuildRailClick_E(Window *w)

   363

{

   364

	HandlePlacePushButton(w, RTW_BUILD_EW, GetRailTypeInfo(_cur_railtype)->cursor.rail_ew, VHM_RECT, PlaceRail_E);

   365

}

   366

   367

/**

   368

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

   369

 * @param w Build-rail toolbar window

   370

 * @see BuildRailToolbWndProc()

   371

 */

   372

static void BuildRailClick_NW(Window *w)

   373

{

   374

	HandlePlacePushButton(w, RTW_BUILD_Y, GetRailTypeInfo(_cur_railtype)->cursor.rail_nwse, VHM_RECT, PlaceRail_NW);

   375

}

   376

   377

/**

   378

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

   379

 * @param w Build-rail toolbar window

   380

 * @see BuildRailToolbWndProc()

   381

 */

   382

static void BuildRailClick_AutoRail(Window *w)

   383

{

   384

	HandlePlacePushButton(w, RTW_AUTORAIL, GetRailTypeInfo(_cur_railtype)->cursor.autorail, VHM_RAIL, PlaceRail_AutoRail);

   385

}

   386

   387

/**

   388

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

   389

 * @param w Build-rail toolbar window

   390

 * @see BuildRailToolbWndProc()

   391

 */

   392

static void BuildRailClick_Demolish(Window *w)

   393

{

   394

	HandlePlacePushButton(w, RTW_DEMOLISH, ANIMCURSOR_DEMOLISH, VHM_RECT, PlaceProc_DemolishArea);

   395

}

   396

   397

/**

   398

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

   399

 * @param w Build-rail toolbar window

   400

 * @see BuildRailToolbWndProc()

   401

 */

   402

static void BuildRailClick_Depot(Window *w)

   403

{

   404

	if (HandlePlacePushButton(w, RTW_BUILD_DEPOT, GetRailTypeInfo(_cur_railtype)->cursor.depot, VHM_RECT, PlaceRail_Depot)) {

   405

		ShowBuildTrainDepotPicker(w);

   406

	}

   407

}

   408

   409

/**

   410

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

   411

 * If there are newGRF waypoints, also open a window to pick the waypoint type.

   412

 * @param w Build-rail toolbar window

   413

 * @see BuildRailToolbWndProc()

   414

 */

   415

static void BuildRailClick_Waypoint(Window *w)

   416

{

   417

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   418

	if (HandlePlacePushButton(w, RTW_BUILD_WAYPOINT, SPR_CURSOR_WAYPOINT, VHM_RECT, PlaceRail_Waypoint) &&

   419

			_waypoint_count > 1) {

   420

		ShowBuildWaypointPicker(w);

   421

	}

   422

}

   423

   424

/**

   425

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

   426

 * @param w Build-rail toolbar window

   427

 * @see BuildRailToolbWndProc()

   428

 */

   429

static void BuildRailClick_Station(Window *w)

   430

{

   431

	if (HandlePlacePushButton(w, RTW_BUILD_STATION, SPR_CURSOR_RAIL_STATION, VHM_RECT, PlaceRail_Station)) ShowStationBuilder(w);

   432

}

   433

   434

/**

   435

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

   436

 * Start ShowSignalBuilder() and/or HandleAutoSignalPlacement().

   437

 * @param w Build-rail toolbar window

   438

 * @see BuildRailToolbWndProc()

   439

 */

   440

static void BuildRailClick_AutoSignals(Window *w)

   441

{

   442

	if (_settings_client.gui.enable_signal_gui != _ctrl_pressed) {

   443

		if (HandlePlacePushButton(w, RTW_BUILD_SIGNALS, ANIMCURSOR_BUILDSIGNALS, VHM_RECT, PlaceRail_AutoSignals)) ShowSignalBuilder(w);

   444

	} else {

   445

		HandlePlacePushButton(w, RTW_BUILD_SIGNALS, ANIMCURSOR_BUILDSIGNALS, VHM_RECT, PlaceRail_AutoSignals);

   446

	}

   447

}

   448

   449

/**

   450

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

   451

 * @param w Build-rail toolbar window

   452

 * @see BuildRailToolbWndProc()

   453

 */

   454

static void BuildRailClick_Bridge(Window *w)

   455

{

   456

	HandlePlacePushButton(w, RTW_BUILD_BRIDGE, SPR_CURSOR_BRIDGE, VHM_RECT, PlaceRail_Bridge);

   457

}

   458

   459

/**

   460

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

   461

 * @param w Build-rail toolbar window

   462

 * @see BuildRailToolbWndProc()

   463

 */

   464

static void BuildRailClick_Tunnel(Window *w)

   465

{

   466

	HandlePlacePushButton(w, RTW_BUILD_TUNNEL, GetRailTypeInfo(_cur_railtype)->cursor.tunnel, VHM_SPECIAL, PlaceRail_Tunnel);

   467

}

   468

   469

/**

   470

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

   471

 * @param w Build-rail toolbar window

   472

 * @see BuildRailToolbWndProc()

   473

 */

   474

static void BuildRailClick_Remove(Window *w)

   475

{

   476

	if (w->IsWidgetDisabled(RTW_REMOVE)) return;

   477

	ToggleRailButton_Remove(w);

   478

	SndPlayFx(SND_15_BEEP);

   479

   480

	/* handle station builder */

   481

	if (w->IsWidgetLowered(RTW_BUILD_STATION)) {

   482

		if (_remove_button_clicked) {

   483

			/* starting drag & drop remove */

   484

			if (!_railstation.dragdrop) {

   485

				SetTileSelectSize(1, 1);

   486

			} else {

   487

				VpSetPlaceSizingLimit(-1);

   488

			}

   489

		} else {

   490

			/* starting station build mode */