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 "station.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

    33

#include "bridge_map.h"

    34

#include "rail_map.h"

    35

#include "road_map.h"

    36

#include "station_map.h"

    37

#include "tunnel_map.h"

    38

#include "tunnelbridge_map.h"

    39

    40

#include "table/sprites.h"

    41

#include "table/strings.h"

    42

    43

static RailType _cur_railtype;

    44

static bool _remove_button_clicked;

    45

static DiagDirection _build_depot_direction;

    46

static byte _waypoint_count = 1;

    47

static byte _cur_waypoint_type;

    48

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

    49

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

    50

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

    51

    52

static struct {

    53

	byte orientation;

    54

	byte numtracks;

    55

	byte platlength;

    56

	bool dragdrop;

    57

    58

	bool newstations;

    59

	StationClassIDByte station_class;

    60

	byte station_type;

    61

	byte station_count;

    62

} _railstation;

    63

    64

    65

static void HandleStationPlacement(TileIndex start, TileIndex end);

    66

static void ShowBuildTrainDepotPicker();

    67

static void ShowBuildWaypointPicker();

    68

static void ShowStationBuilder();

    69

static void ShowSignalBuilder();

    70

    71

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

    72

{

    73

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    74

}

    75

    76

static void GenericPlaceRail(TileIndex tile, int cmd)

    77

{

    78

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    79

		_remove_button_clicked ?

    80

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    81

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    82

	);

    83

}

    84

    85

static void PlaceRail_N(TileIndex tile)

    86

{

    87

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

    88

	GenericPlaceRail(tile, cmd);

    89

}

    90

    91

static void PlaceRail_NE(TileIndex tile)

    92

{

    93

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    94

}

    95

    96

static void PlaceRail_E(TileIndex tile)

    97

{

    98

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

    99

	GenericPlaceRail(tile, cmd);

   100

}

   101

   102

static void PlaceRail_NW(TileIndex tile)

   103

{

   104

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   105

}

   106

   107

static void PlaceRail_AutoRail(TileIndex tile)

   108

{

   109

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   110

}

   111

   112

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   113

{

   114

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

   115

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

   116

   117

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

   118

}

   119

   120

static const uint16 _place_depot_extra[12] = {

   121

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

   122

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

   123

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

   124

};

   125

   126

   127

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

   128

{

   129

	if (success) {

   130

		DiagDirection dir = (DiagDirection)p2;

   131

   132

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   133

		ResetObjectToPlace();

   134

   135

		tile += TileOffsByDiagDir(dir);

   136

   137

		if (IsTileType(tile, MP_RAILWAY)) {

   138

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   139

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

   140

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

   141

		}

   142

	}

   143

}

   144

   145

static void PlaceRail_Depot(TileIndex tile)

   146

{

   147

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   148

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   149

}

   150

   151

static void PlaceRail_Waypoint(TileIndex tile)

   152

{

   153

	if (_remove_button_clicked) {

   154

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

   155

	} else {

   156

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

   157

	}

   158

}

   159

   160

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

   161

{

   162

	if (success) {

   163

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   164

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

   165

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

   166

	}

   167

}

   168

   169

static void PlaceRail_Station(TileIndex tile)

   170

{

   171

	if (_remove_button_clicked) {

   172

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_REMOVE_STATION);

   173

		VpSetPlaceSizingLimit(-1);

   174

	} else if (_railstation.dragdrop) {

   175

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   176

		VpSetPlaceSizingLimit(_patches.station_spread);

   177

	} else {

   178

		DoCommandP(tile,

   179

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

   180

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

   181

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   182

	}

   183

}

   184

   185

/**

   186

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

   187

 *

   188

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

   189

 */

   190

static void GenericPlaceSignals(TileIndex tile)

   191

{

   192

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

   193

   194

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

   195

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

   196

	}

   197

   198

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

   199

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

   200

	}

   201

   202

	Track track = FindFirstTrack(trackbits);

   203

   204

	if (_remove_button_clicked) {

   205

		DoCommandP(tile, track, 0, CcPlaySound1E,

   206

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   207

	} else {

   208

		if (!_patches.enable_signal_gui) _cur_signal_variant = _cur_year < _patches.semaphore_build_before ? SIG_SEMAPHORE : SIG_ELECTRIC;

   209

   210

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   211

		uint32 p1 = track;

   212

		SB(p1, 3, 1, _ctrl_pressed);

   213

		SB(p1, 4, 1, _cur_signal_variant);

   214

		SB(p1, 5, 2, _patches.enable_signal_gui ? _cur_signal_type : SIGTYPE_NORMAL);

   215

		SB(p1, 7, 1, _convert_signal_button);

   216

   217

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

   218

			CMD_MSG(_convert_signal_button ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   219

	}

   220

}

   221

   222

static void PlaceRail_Bridge(TileIndex tile)

   223

{

   224

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   225

}

   226

   227

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

   228

{

   229

	if (success) {

   230

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   231

		ResetObjectToPlace();

   232

	} else {

   233

		SetRedErrorSquare(_build_tunnel_endtile);

   234

	}

   235

}

   236

   237

static void PlaceRail_Tunnel(TileIndex tile)

   238

{

   239

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   240

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   241

}

   242

   243

void PlaceProc_BuyLand(TileIndex tile)

   244

{

   245

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

   246

}

   247

   248

static void PlaceRail_ConvertRail(TileIndex tile)

   249

{

   250

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   251

}

   252

   253

static void PlaceRail_AutoSignals(TileIndex tile)

   254

{

   255

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   256

}

   257

   258

   259

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

   260

enum RailToolbarWidgets {

   261

	RTW_CLOSEBOX = 0,

   262

	RTW_CAPTION,

   263

	RTW_STICKY,

   264

	RTW_SPACER,

   265

	RTW_BUILD_NS,

   266

	RTW_BUILD_X,

   267

	RTW_BUILD_EW,

   268

	RTW_BUILD_Y,

   269

	RTW_AUTORAIL,

   270

	RTW_DEMOLISH,

   271

	RTW_BUILD_DEPOT,

   272

	RTW_BUILD_WAYPOINT,

   273

	RTW_BUILD_STATION,

   274

	RTW_BUILD_SIGNALS,

   275

	RTW_BUILD_BRIDGE,

   276

	RTW_BUILD_TUNNEL,

   277

	RTW_REMOVE,

   278

	RTW_CONVERT_RAIL,

   279

};

   280

   281

   282

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

   283

 * @param w window the button belongs to

   284

 */

   285

static void ToggleRailButton_Remove(Window *w)

   286

{

   287

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   288

	w->InvalidateWidget(RTW_REMOVE);

   289

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   290

	SetSelectionRed(_remove_button_clicked);

   291

}

   292

   293

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

   294

 * @param w window the button belongs to

   295

 * @return true iff the remove buton was changed

   296

 */

   297

static bool RailToolbar_CtrlChanged(Window *w)

   298

{

   299

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

   300

   301

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

   302

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

   303

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

   304

			ToggleRailButton_Remove(w);

   305

			return true;

   306

		}

   307

	}

   308

   309

	return false;

   310

}

   311

   312

   313

static void BuildRailClick_N(Window *w)

   314

{

   315

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

   316

}

   317

   318

static void BuildRailClick_NE(Window *w)

   319

{

   320

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

   321

}

   322

   323

static void BuildRailClick_E(Window *w)

   324

{

   325

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

   326

}

   327

   328

static void BuildRailClick_NW(Window *w)

   329

{

   330

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

   331

}

   332

   333

static void BuildRailClick_AutoRail(Window *w)

   334

{

   335

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

   336

}

   337

   338

static void BuildRailClick_Demolish(Window *w)

   339

{

   340

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

   341

}

   342

   343

static void BuildRailClick_Depot(Window *w)

   344

{

   345

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

   346

		ShowBuildTrainDepotPicker();

   347

	}

   348

}

   349

   350

static void BuildRailClick_Waypoint(Window *w)

   351

{

   352

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   353

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

   354

			_waypoint_count > 1) {

   355

		ShowBuildWaypointPicker();

   356

	}

   357

}

   358

   359

static void BuildRailClick_Station(Window *w)

   360

{

   361

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

   362

}

   363

   364

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

   365

static void BuildRailClick_AutoSignals(Window *w)

   366

{

   367

	if (_patches.enable_signal_gui) {

   368

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

   369

	} else {

   370

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

   371

	}

   372

}

   373

   374

static void BuildRailClick_Bridge(Window *w)

   375

{

   376

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

   377

}

   378

   379

static void BuildRailClick_Tunnel(Window *w)

   380

{

   381

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

   382

}

   383

   384

static void BuildRailClick_Remove(Window *w)

   385

{

   386

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

   387

	ToggleRailButton_Remove(w);

   388

	SndPlayFx(SND_15_BEEP);

   389

   390

	/* handle station builder */

   391

	if (w->IsWidgetLowered(RTW_BUILD_STATION)) {

   392

		if (_remove_button_clicked) {

   393

			/* starting drag & drop remove */

   394

			if (!_railstation.dragdrop) {

   395

				SetTileSelectSize(1, 1);

   396

			} else {

   397

				VpSetPlaceSizingLimit(-1);

   398

			}

   399

		} else {

   400

			/* starting station build mode */

   401

			if (!_railstation.dragdrop) {

   402

				int x = _railstation.numtracks;

   403

				int y = _railstation.platlength;

   404

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

   405

				SetTileSelectSize(x, y);

   406

			} else {

   407

				VpSetPlaceSizingLimit(_patches.station_spread);

   408

			}

   409

		}

   410

	}

   411

}

   412

   413

static void BuildRailClick_Convert(Window *w)

   414

{

   415

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

   416

}

   417

   418

   419

static void DoRailroadTrack(int mode)

   420

{

   421

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

   422

		_remove_button_clicked ?

   423

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   424

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   425

	);

   426

}

   427

   428

static void HandleAutodirPlacement()

   429

{

   430

	TileHighlightData *thd = &_thd;

   431

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

   432

   433

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

   434

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

   435

		return;

   436

	}

   437

   438

	DoRailroadTrack(trackstat);

   439

}

   440

   441

/**

   442

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

   443

 *

   444

 * If one tile marked abort and use GenericPlaceSignals()

   445

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

   446

 */

   447

static void HandleAutoSignalPlacement()

   448

{

   449

	TileHighlightData *thd = &_thd;

   450

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

   451

   452

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

   453

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

   454

		return;

   455

	}

   456

   457

	/* XXX Steal ctrl for autosignal function, until we get some GUI */

   458

	SB(p2,  3, 1, 0);

   459

	SB(p2,  4, 1, _cur_year < _patches.semaphore_build_before);

   460

	SB(p2,  6, 1, _ctrl_pressed);

   461

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

   462

   463

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

   464

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

   465

	DoCommandP(

   466

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

   467

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

   468

		p2,

   469

		CcPlaySound1E,

   470

		_remove_button_clicked ?

   471

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   472

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   473

	);

   474

}

   475

   476

   477

typedef void OnButtonClick(Window *w);

   478

   479

static OnButtonClick * const _build_railroad_button_proc[] = {

   480

	BuildRailClick_N,

   481

	BuildRailClick_NE,

   482

	BuildRailClick_E,

   483

	BuildRailClick_NW,

   484

	BuildRailClick_AutoRail,

   485

	BuildRailClick_Demolish,

   486

	BuildRailClick_Depot,

   487

	BuildRailClick_Waypoint,

   488

	BuildRailClick_Station,

   489

	BuildRailClick_AutoSignals,

   490

	BuildRailClick_Bridge,

   491