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"

    32

#include "tunnelbridge.h"

    33

#include "tilehighlight_func.h"

    34

    35

#include "bridge_map.h"

    36

#include "rail_map.h"

    37

#include "road_map.h"

    38

#include "station_map.h"

    39

#include "tunnel_map.h"

    40

#include "tunnelbridge_map.h"

    41

    42

#include "table/sprites.h"

    43

#include "table/strings.h"

    44

    45

static RailType _cur_railtype;

    46

static bool _remove_button_clicked;

    47

static DiagDirection _build_depot_direction;

    48

static byte _waypoint_count = 1;

    49

static byte _cur_waypoint_type;

    50

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

    51

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

    52

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

    53

    54

static struct {

    55

	byte orientation;

    56

	byte numtracks;

    57

	byte platlength;

    58

	bool dragdrop;

    59

    60

	bool newstations;

    61

	StationClassIDByte station_class;

    62

	byte station_type;

    63

	byte station_count;

    64

} _railstation;

    65

    66

    67

static void HandleStationPlacement(TileIndex start, TileIndex end);

    68

static void ShowBuildTrainDepotPicker();

    69

static void ShowBuildWaypointPicker();

    70

static void ShowStationBuilder();

    71

static void ShowSignalBuilder();

    72

    73

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

    74

{

    75

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    76

}

    77

    78

static void GenericPlaceRail(TileIndex tile, int cmd)

    79

{

    80

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    81

		_remove_button_clicked ?

    82

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    83

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    84

	);

    85

}

    86

    87

static void PlaceRail_N(TileIndex tile)

    88

{

    89

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

    90

	GenericPlaceRail(tile, cmd);

    91

}

    92

    93

static void PlaceRail_NE(TileIndex tile)

    94

{

    95

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    96

}

    97

    98

static void PlaceRail_E(TileIndex tile)

    99

{

   100

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

   101

	GenericPlaceRail(tile, cmd);

   102

}

   103

   104

static void PlaceRail_NW(TileIndex tile)

   105

{

   106

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   107

}

   108

   109

static void PlaceRail_AutoRail(TileIndex tile)

   110

{

   111

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   112

}

   113

   114

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   115

{

   116

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

   117

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

   118

   119

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

   120

}

   121

   122

static const uint16 _place_depot_extra[12] = {

   123

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

   124

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

   125

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

   126

};

   127

   128

   129

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

   130

{

   131

	if (success) {

   132

		DiagDirection dir = (DiagDirection)p2;

   133

   134

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   135

		ResetObjectToPlace();

   136

   137

		tile += TileOffsByDiagDir(dir);

   138

   139

		if (IsTileType(tile, MP_RAILWAY)) {

   140

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   141

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

   142

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

   143

		}

   144

	}

   145

}

   146

   147

static void PlaceRail_Depot(TileIndex tile)

   148

{

   149

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   150

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   151

}

   152

   153

static void PlaceRail_Waypoint(TileIndex tile)

   154

{

   155

	if (_remove_button_clicked) {

   156

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

   157

	} else {

   158

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

   159

	}

   160

}

   161

   162

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

   163

{

   164

	if (success) {

   165

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   166

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

   167

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

   168

	}

   169

}

   170

   171

static void PlaceRail_Station(TileIndex tile)

   172

{

   173

	if (_remove_button_clicked) {

   174

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_REMOVE_STATION);

   175

		VpSetPlaceSizingLimit(-1);

   176

	} else if (_railstation.dragdrop) {

   177

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   178

		VpSetPlaceSizingLimit(_patches.station_spread);

   179

	} else {

   180

		DoCommandP(tile,

   181

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

   182

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

   183

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   184

	}

   185

}

   186

   187

/**

   188

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

   189

 *

   190

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

   191

 */

   192

static void GenericPlaceSignals(TileIndex tile)

   193

{

   194

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

   195

   196

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

   197

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

   198

	}

   199

   200

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

   201

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

   202

	}

   203

   204

	Track track = FindFirstTrack(trackbits);

   205

   206

	if (_remove_button_clicked) {

   207

		DoCommandP(tile, track, 0, CcPlaySound1E,

   208

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   209

	} else {

   210

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

   211

   212

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   213

		uint32 p1 = track;

   214

   215

		if (w != NULL) {

   216

			/* signal GUI is used */

   217

			SB(p1, 3, 1, _ctrl_pressed);

   218

			SB(p1, 4, 1, _cur_signal_variant);

   219

			SB(p1, 5, 2, _cur_signal_type);

   220

			SB(p1, 7, 1, _convert_signal_button);

   221

		} else {

   222

			SB(p1, 3, 1, _ctrl_pressed);

   223

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

   224

			SB(p1, 5, 2, SIGTYPE_NORMAL);

   225

			SB(p1, 7, 1, 0);

   226

		}

   227

   228

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

   229

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

   230

	}

   231

}

   232

   233

static void PlaceRail_Bridge(TileIndex tile)

   234

{

   235

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   236

}

   237

   238

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

   239

{

   240

	if (success) {

   241

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   242

		ResetObjectToPlace();

   243

	} else {

   244

		SetRedErrorSquare(_build_tunnel_endtile);

   245

	}

   246

}

   247

   248

static void PlaceRail_Tunnel(TileIndex tile)

   249

{

   250

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   251

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   252

}

   253

   254

static void PlaceRail_ConvertRail(TileIndex tile)

   255

{

   256

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   257

}

   258

   259

static void PlaceRail_AutoSignals(TileIndex tile)

   260

{

   261

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   262

}

   263

   264

   265

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

   266

enum RailToolbarWidgets {

   267

	RTW_CLOSEBOX = 0,

   268

	RTW_CAPTION,

   269

	RTW_STICKY,

   270

	RTW_SPACER,

   271

	RTW_BUILD_NS,

   272

	RTW_BUILD_X,

   273

	RTW_BUILD_EW,

   274

	RTW_BUILD_Y,

   275

	RTW_AUTORAIL,

   276

	RTW_DEMOLISH,

   277

	RTW_BUILD_DEPOT,

   278

	RTW_BUILD_WAYPOINT,

   279

	RTW_BUILD_STATION,

   280

	RTW_BUILD_SIGNALS,

   281

	RTW_BUILD_BRIDGE,

   282

	RTW_BUILD_TUNNEL,

   283

	RTW_REMOVE,

   284

	RTW_CONVERT_RAIL,

   285

};

   286

   287

   288

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

   289

 * @param w window the button belongs to

   290

 */

   291

static void ToggleRailButton_Remove(Window *w)

   292

{

   293

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   294

	w->InvalidateWidget(RTW_REMOVE);

   295

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   296

	SetSelectionRed(_remove_button_clicked);

   297

}

   298

   299

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

   300

 * @param w window the button belongs to

   301

 * @return true iff the remove buton was changed

   302

 */

   303

static bool RailToolbar_CtrlChanged(Window *w)

   304

{

   305

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

   306

   307

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

   308

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

   309

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

   310

			ToggleRailButton_Remove(w);

   311

			return true;

   312

		}

   313

	}

   314

   315

	return false;

   316

}

   317

   318

   319

static void BuildRailClick_N(Window *w)

   320

{

   321

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

   322

}

   323

   324

static void BuildRailClick_NE(Window *w)

   325

{

   326

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

   327

}

   328

   329

static void BuildRailClick_E(Window *w)

   330

{

   331

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

   332

}

   333

   334

static void BuildRailClick_NW(Window *w)

   335

{

   336

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

   337

}

   338

   339

static void BuildRailClick_AutoRail(Window *w)

   340

{

   341

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

   342

}

   343

   344

static void BuildRailClick_Demolish(Window *w)

   345

{

   346

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

   347

}

   348

   349

static void BuildRailClick_Depot(Window *w)

   350

{

   351

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

   352

		ShowBuildTrainDepotPicker();

   353

	}

   354

}

   355

   356

static void BuildRailClick_Waypoint(Window *w)

   357

{

   358

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   359

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

   360

			_waypoint_count > 1) {

   361

		ShowBuildWaypointPicker();

   362

	}

   363

}

   364

   365

static void BuildRailClick_Station(Window *w)

   366

{

   367

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

   368

}

   369

   370

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

   371

static void BuildRailClick_AutoSignals(Window *w)

   372

{

   373

	if (_patches.enable_signal_gui != _ctrl_pressed) {

   374

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

   375

	} else {

   376

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

   377

	}

   378

}

   379

   380

static void BuildRailClick_Bridge(Window *w)

   381

{

   382

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

   383

}

   384

   385

static void BuildRailClick_Tunnel(Window *w)

   386

{

   387

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

   388

}

   389

   390

static void BuildRailClick_Remove(Window *w)

   391

{

   392

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

   393

	ToggleRailButton_Remove(w);

   394

	SndPlayFx(SND_15_BEEP);

   395

   396

	/* handle station builder */

   397

	if (w->IsWidgetLowered(RTW_BUILD_STATION)) {

   398

		if (_remove_button_clicked) {

   399

			/* starting drag & drop remove */

   400

			if (!_railstation.dragdrop) {

   401

				SetTileSelectSize(1, 1);

   402

			} else {

   403

				VpSetPlaceSizingLimit(-1);

   404

			}

   405

		} else {

   406

			/* starting station build mode */

   407

			if (!_railstation.dragdrop) {

   408

				int x = _railstation.numtracks;

   409

				int y = _railstation.platlength;

   410

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

   411

				SetTileSelectSize(x, y);

   412

			} else {

   413

				VpSetPlaceSizingLimit(_patches.station_spread);

   414

			}

   415

		}

   416

	}

   417

}

   418

   419

static void BuildRailClick_Convert(Window *w)

   420

{

   421

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

   422

}

   423

   424

   425

static void DoRailroadTrack(int mode)

   426

{

   427

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

   428

		_remove_button_clicked ?

   429

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   430

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   431

	);

   432

}

   433

   434

static void HandleAutodirPlacement()

   435

{

   436

	TileHighlightData *thd = &_thd;

   437

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

   438

   439

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

   440

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

   441

		return;

   442

	}

   443

   444

	DoRailroadTrack(trackstat);

   445

}

   446

   447

/**

   448

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

   449

 *

   450

 * If one tile marked abort and use GenericPlaceSignals()

   451

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

   452

 */

   453

static void HandleAutoSignalPlacement()

   454

{

   455

	TileHighlightData *thd = &_thd;

   456

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

   457

   458

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

   459

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

   460

		return;

   461

	}

   462

   463

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

   464

   465

	if (w != NULL) {

   466

		/* signal GUI is used */

   467

		SB(p2,  3, 1, 0);

   468

		SB(p2,  4, 1, _cur_signal_variant);

   469

		SB(p2,  6, 1, _ctrl_pressed);

   470

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

   471

	} else {

   472

		SB(p2,  3, 1, 0);

   473

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

   474

		SB(p2,  6, 1, _ctrl_pressed);

   475

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

   476

	}

   477

   478

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

   479

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

   480

	DoCommandP(

   481

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

   482

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

   483

		p2,

   484

		CcPlaySound1E,

   485

		_remove_button_clicked ?

   486

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   487

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   488

	);

   489

}

   490

   491