1

/* $Id$ */

     2

     3

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

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "tile_cmd.h"

     8

#include "landscape.h"

     9

#include "gui.h"

    10

#include "window_gui.h"

    11

#include "station_gui.h"

    12

#include "terraform_gui.h"

    13

#include "viewport_func.h"

    14

#include "gfx_func.h"

    15

#include "command_func.h"

    16

#include "town_type.h"

    17

#include "waypoint.h"

    18

#include "debug.h"

    19

#include "variables.h"

    20

#include "newgrf_callbacks.h"

    21

#include "newgrf_station.h"

    22

#include "train.h"

    23

#include "strings_func.h"

    24

#include "functions.h"

    25

#include "window_func.h"

    26

#include "date_func.h"

    27

#include "sound_func.h"

    28

#include "player_func.h"

    29

#include "settings_type.h"

    30

#include "widgets/dropdown_type.h"

    31

#include "widgets/dropdown_func.h"

    33

    34

#include "bridge_map.h"

    35

#include "rail_map.h"

    36

#include "road_map.h"

    37

#include "station_map.h"

    38

#include "tunnel_map.h"

    39

#include "tunnelbridge_map.h"

    40

    41

#include "table/sprites.h"

    42

#include "table/strings.h"

    43

    44

static RailType _cur_railtype;

    45

static bool _remove_button_clicked;

    46

static DiagDirection _build_depot_direction;

    47

static byte _waypoint_count = 1;

    48

static byte _cur_waypoint_type;

    49

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

    50

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

    51

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

    52

    53

static struct {

    54

	byte orientation;

    55

	byte numtracks;

    56

	byte platlength;

    57

	bool dragdrop;

    58

    59

	bool newstations;

    60

	StationClassIDByte station_class;

    61

	byte station_type;

    62

	byte station_count;

    63

} _railstation;

    64

    65

    66

static void HandleStationPlacement(TileIndex start, TileIndex end);

    67

static void ShowBuildTrainDepotPicker();

    68

static void ShowBuildWaypointPicker();

    69

static void ShowStationBuilder();

    70

static void ShowSignalBuilder();

    71

    72

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

    73

{

    74

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    75

}

    76

    77

static void GenericPlaceRail(TileIndex tile, int cmd)

    78

{

    79

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    80

		_remove_button_clicked ?

    81

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    82

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    83

	);

    84

}

    85

    86

static void PlaceRail_N(TileIndex tile)

    87

{

    88

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

    89

	GenericPlaceRail(tile, cmd);

    90

}

    91

    92

static void PlaceRail_NE(TileIndex tile)

    93

{

    94

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    95

}

    96

    97

static void PlaceRail_E(TileIndex tile)

    98

{

    99

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

   100

	GenericPlaceRail(tile, cmd);

   101

}

   102

   103

static void PlaceRail_NW(TileIndex tile)

   104

{

   105

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   106

}

   107

   108

static void PlaceRail_AutoRail(TileIndex tile)

   109

{

   110

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   111

}

   112

   113

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   114

{

   115

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

   116

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

   117

   118

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

   119

}

   120

   121

static const uint16 _place_depot_extra[12] = {

   122

	0x0604, 0x2102, 0x1202, 0x0505,

   123

	0x2400, 0x2801, 0x1800, 0x1401,

   124

	0x2203, 0x0904, 0x0A05, 0x1103,

   125

};

   126

   127

   128

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

   129

{

   130

	if (success) {

   131

		DiagDirection dir = (DiagDirection)p2;

   132

   133

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   134

		ResetObjectToPlace();

   135

   136

		tile += TileOffsByDiagDir(dir);

   137

   138

		if (IsTileType(tile, MP_RAILWAY)) {

   139

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   140

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

   141

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

   142

		}

   143

	}

   144

}

   145

   146

static void PlaceRail_Depot(TileIndex tile)

   147

{

   148

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   149

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   150

}

   151

   152

static void PlaceRail_Waypoint(TileIndex tile)

   153

{

   154

	if (_remove_button_clicked) {

   155

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

   156

	} else {

   157

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

   158

	}

   159

}

   160

   161

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

   162

{

   163

	if (success) {

   164

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   165

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

   166

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

   167

	}

   168

}

   169

   170

static void PlaceRail_Station(TileIndex tile)

   171

{

   172

	if (_remove_button_clicked) {

   173

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_REMOVE_STATION);

   174

		VpSetPlaceSizingLimit(-1);

   175

	} else if (_railstation.dragdrop) {

   176

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   177

		VpSetPlaceSizingLimit(_patches.station_spread);

   178

	} else {

   179

		DoCommandP(tile,

   180

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

   181

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

   182

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   183

	}

   184

}

   185

   186

/**

   187

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

   188

 *

   189

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

   190

 */

   191

static void GenericPlaceSignals(TileIndex tile)

   192

{

   193

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

   194

   195

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

   196

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

   197

	}

   198

   199

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

   200

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

   201

	}

   202

   203

	Track track = FindFirstTrack(trackbits);

   204

   205

	if (_remove_button_clicked) {

   206

		DoCommandP(tile, track, 0, CcPlaySound1E,

   207

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   208

	} else {

   209

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

   210

   211

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   212

		uint32 p1 = track;

   213

   214

		if (w != NULL) {

   215

			/* signal GUI is used */

   216

			SB(p1, 3, 1, _ctrl_pressed);

   217

			SB(p1, 4, 1, _cur_signal_variant);

   218

			SB(p1, 5, 2, _cur_signal_type);

   219

			SB(p1, 7, 1, _convert_signal_button);

   220

		} else {

   221

			SB(p1, 3, 1, _ctrl_pressed);

   222

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

   223

			SB(p1, 5, 2, SIGTYPE_NORMAL);

   224

			SB(p1, 7, 1, 0);

   225

		}

   226

   227

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

   228

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

   229

	}

   230

}

   231

   232

static void PlaceRail_Bridge(TileIndex tile)

   233

{

   234

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   235

}

   236

   237

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

   238

{

   239

	if (success) {

   240

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   241

		ResetObjectToPlace();

   242

	} else {

   243

		SetRedErrorSquare(_build_tunnel_endtile);

   244

	}

   245

}

   246

   247

static void PlaceRail_Tunnel(TileIndex tile)

   248

{

   249

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   250

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   251

}

   252

   253

void PlaceProc_BuyLand(TileIndex tile)

   254

{

   255

	DoCommandP(tile, 0, 0, CcPlaySound1E, CMD_PURCHASE_LAND_AREA | CMD_NO_WATER | CMD_MSG(STR_5806_CAN_T_PURCHASE_THIS_LAND));

   256

}

   257

   258

static void PlaceRail_ConvertRail(TileIndex tile)

   259

{

   260

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   261

}

   262

   263

static void PlaceRail_AutoSignals(TileIndex tile)

   264

{

   265

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   266

}

   267

   268

   269

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

   270

enum RailToolbarWidgets {

   271

	RTW_CLOSEBOX = 0,

   272

	RTW_CAPTION,

   273

	RTW_STICKY,

   274

	RTW_SPACER,

   275

	RTW_BUILD_NS,

   276

	RTW_BUILD_X,

   277

	RTW_BUILD_EW,

   278

	RTW_BUILD_Y,

   279

	RTW_AUTORAIL,

   280

	RTW_DEMOLISH,

   281

	RTW_BUILD_DEPOT,

   282

	RTW_BUILD_WAYPOINT,

   283

	RTW_BUILD_STATION,

   284

	RTW_BUILD_SIGNALS,

   285

	RTW_BUILD_BRIDGE,

   286

	RTW_BUILD_TUNNEL,

   287

	RTW_REMOVE,

   288

	RTW_CONVERT_RAIL,

   289

};

   290

   291

   292

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

   293

 * @param w window the button belongs to

   294

 */

   295

static void ToggleRailButton_Remove(Window *w)

   296

{

   297

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   298

	w->InvalidateWidget(RTW_REMOVE);

   299

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   300

	SetSelectionRed(_remove_button_clicked);

   301

}

   302

   303

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

   304

 * @param w window the button belongs to

   305

 * @return true iff the remove buton was changed

   306

 */

   307

static bool RailToolbar_CtrlChanged(Window *w)

   308

{

   309

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

   310

   311

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

   312

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

   313

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

   314

			ToggleRailButton_Remove(w);

   315

			return true;

   316

		}

   317

	}

   318

   319

	return false;

   320

}

   321

   322

   323

static void BuildRailClick_N(Window *w)

   324

{

   325

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

   326

}

   327

   328

static void BuildRailClick_NE(Window *w)

   329

{

   330

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

   331

}

   332

   333

static void BuildRailClick_E(Window *w)

   334

{

   335

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

   336

}

   337

   338

static void BuildRailClick_NW(Window *w)

   339

{

   340

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

   341

}

   342

   343

static void BuildRailClick_AutoRail(Window *w)

   344

{

   345

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

   346

}

   347

   348

static void BuildRailClick_Demolish(Window *w)

   349

{

   350

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

   351

}

   352

   353

static void BuildRailClick_Depot(Window *w)

   354

{

   355

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

   356

		ShowBuildTrainDepotPicker();

   357

	}

   358

}

   359

   360

static void BuildRailClick_Waypoint(Window *w)

   361

{

   362

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   363

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

   364

			_waypoint_count > 1) {

   365

		ShowBuildWaypointPicker();

   366

	}

   367

}

   368

   369

static void BuildRailClick_Station(Window *w)

   370

{

   371

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

   372

}

   373

   374

/** The "build signal"-button proc from BuildRailToolbWndProc() (start ShowSignalBuilder() and/or HandleAutoSignalPlacement()) */

   375

static void BuildRailClick_AutoSignals(Window *w)

   376

{

   377

	if (_patches.enable_signal_gui != _ctrl_pressed) {

   378

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

   379

	} else {

   380

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

   381

	}

   382

}

   383

   384

static void BuildRailClick_Bridge(Window *w)

   385

{

   386

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

   387

}

   388

   389

static void BuildRailClick_Tunnel(Window *w)

   390

{

   391

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

   392

}

   393

   394

static void BuildRailClick_Remove(Window *w)

   395

{

   396

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

   397

	ToggleRailButton_Remove(w);

   398

	SndPlayFx(SND_15_BEEP);

   399

   400

	/* handle station builder */

   401

	if (w->IsWidgetLowered(RTW_BUILD_STATION)) {

   402

		if (_remove_button_clicked) {

   403

			/* starting drag & drop remove */

   404

			if (!_railstation.dragdrop) {

   405

				SetTileSelectSize(1, 1);

   406

			} else {

   407

				VpSetPlaceSizingLimit(-1);

   408

			}

   409

		} else {

   410

			/* starting station build mode */

   411

			if (!_railstation.dragdrop) {

   412

				int x = _railstation.numtracks;

   413

				int y = _railstation.platlength;

   414

				if (_railstation.orientation == 0) Swap(x, y);

   415

				SetTileSelectSize(x, y);

   416

			} else {

   417

				VpSetPlaceSizingLimit(_patches.station_spread);

   418

			}

   419

		}

   420

	}

   421

}

   422

   423

static void BuildRailClick_Convert(Window *w)

   424

{

   425

	HandlePlacePushButton(w, RTW_CONVERT_RAIL, GetRailTypeInfo(_cur_railtype)->cursor.convert, VHM_RECT, PlaceRail_ConvertRail);

   426

}

   427

   428

   429

static void DoRailroadTrack(int mode)

   430

{

   431

	DoCommandP(TileVirtXY(_thd.selstart.x, _thd.selstart.y), TileVirtXY(_thd.selend.x, _thd.selend.y), _cur_railtype | (mode << 4), NULL,

   432

		_remove_button_clicked ?

   433

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   434

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   435

	);

   436

}

   437

   438

static void HandleAutodirPlacement()

   439

{

   440

	TileHighlightData *thd = &_thd;

   441

	int trackstat = thd->drawstyle & 0xF; // 0..5

   442

   443

	if (thd->drawstyle & HT_RAIL) { // one tile case

   444

		GenericPlaceRail(TileVirtXY(thd->selend.x, thd->selend.y), trackstat);

   445

		return;

   446

	}

   447

   448

	DoRailroadTrack(trackstat);

   449

}

   450

   451

/**

   452

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

   453

 *

   454

 * If one tile marked abort and use GenericPlaceSignals()

   455

 * else use CmdBuildSingleSignal() or CmdRemoveSingleSignal() in rail_cmd.cpp to build many signals

   456

 */

   457

static void HandleAutoSignalPlacement()

   458

{

   459

	TileHighlightData *thd = &_thd;

   460

	uint32 p2 = GB(thd->drawstyle, 0, 3); // 0..5

   461

   462

	if (thd->drawstyle == HT_RECT) { // one tile case

   463

		GenericPlaceSignals(TileVirtXY(thd->selend.x, thd->selend.y));

   464

		return;

   465

	}

   466

   467

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

   468

   469

	if (w != NULL) {

   470

		/* signal GUI is used */

   471

		SB(p2,  3, 1, 0);

   472

		SB(p2,  4, 1, _cur_signal_variant);

   473

		SB(p2,  6, 1, _ctrl_pressed);

   474

		SB(p2, 24, 8, _patches.drag_signals_density);

   475

	} else {

   476

		SB(p2,  3, 1, 0);

   477

		SB(p2,  4, 1, (_cur_year < _patches.semaphore_build_before ? SIG_SEMAPHORE : SIG_ELECTRIC));

   478

		SB(p2,  6, 1, _ctrl_pressed);

   479

		SB(p2, 24, 8, _patches.drag_signals_density);

   480

	}

   481

   482

	/* _patches.drag_signals_density is given as a parameter such that each user

   483

	 * in a network game can specify his/her own signal density */

   484

	DoCommandP(

   485

		TileVirtXY(thd->selstart.x, thd->selstart.y),

   486

		TileVirtXY(thd->selend.x, thd->selend.y),

   487

		p2,

   488

		CcPlaySound1E,

   489

		_remove_button_clicked ?

   490

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   491

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)