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"

    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 || _ctrl_pressed) ?

    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 || _ctrl_pressed) {

   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, DDSP_REMOVE_STATION);

   173

	} else if (_railstation.dragdrop) {

   174

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   175

		VpSetPlaceSizingLimit(_patches.station_spread);

   176

	} else {

   177

		DoCommandP(tile,

   178

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

   179

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

   180

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   181

	}

   182

}

   183

   184

/**

   185

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

   186

 *

   187

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

   188

 */

   189

static void GenericPlaceSignals(TileIndex tile)

   190

{

   191

	TrackBits trackbits = (TrackBits)GB(GetTileTrackStatus(tile, TRANSPORT_RAIL, 0), 0, 6);

   192

   193

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

   194

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

   195

	}

   196

   197

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

   198

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

   199

	}

   200

   201

	Track track = FindFirstTrack(trackbits);

   202

   203

	if (_remove_button_clicked) {

   204

		DoCommandP(tile, track, 0, CcPlaySound1E,

   205

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   206

	} else {

   207

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

   208

   209

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   210

		uint32 p1 = track;

   211

		SB(p1, 3, 1, _ctrl_pressed);

   212

		SB(p1, 4, 1, _cur_signal_variant);

   213

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

   214

		SB(p1, 7, 1, _convert_signal_button);

   215

   216

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

   217

			CMD_MSG(_convert_signal_button ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   218

	}

   219

}

   220

   221

static void PlaceRail_Bridge(TileIndex tile)

   222

{

   223

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   224

}

   225

   226

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

   227

{

   228

	if (success) {

   229

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   230

		ResetObjectToPlace();

   231

	} else {

   232

		SetRedErrorSquare(_build_tunnel_endtile);

   233

	}

   234

}

   235

   236

static void PlaceRail_Tunnel(TileIndex tile)

   237

{

   238

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   239

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   240

}

   241

   242

void PlaceProc_BuyLand(TileIndex tile)

   243

{

   244

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

   245

}

   246

   247

static void PlaceRail_ConvertRail(TileIndex tile)

   248

{

   249

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   250

}

   251

   252

static void PlaceRail_AutoSignals(TileIndex tile)

   253

{

   254

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   255

}

   256

   257

   258

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

   259

enum RailToolbarWidgets {

   260

	RTW_CLOSEBOX = 0,

   261

	RTW_CAPTION,

   262

	RTW_STICKY,

   263

	RTW_SPACER,

   264

	RTW_BUILD_NS,

   265

	RTW_BUILD_X,

   266

	RTW_BUILD_EW,

   267

	RTW_BUILD_Y,

   268

	RTW_AUTORAIL,

   269

	RTW_DEMOLISH,

   270

	RTW_BUILD_DEPOT,

   271

	RTW_BUILD_WAYPOINT,

   272

	RTW_BUILD_STATION,

   273

	RTW_BUILD_SIGNALS,

   274

	RTW_BUILD_BRIDGE,

   275

	RTW_BUILD_TUNNEL,

   276

	RTW_REMOVE,

   277

	RTW_CONVERT_RAIL,

   278

};

   279

   280

static void BuildRailClick_N(Window *w)

   281

{

   282

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

   283

}

   284

   285

static void BuildRailClick_NE(Window *w)

   286

{

   287

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

   288

}

   289

   290

static void BuildRailClick_E(Window *w)

   291

{

   292

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

   293

}

   294

   295

static void BuildRailClick_NW(Window *w)

   296

{

   297

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

   298

}

   299

   300

static void BuildRailClick_AutoRail(Window *w)

   301

{

   302

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

   303

}

   304

   305

static void BuildRailClick_Demolish(Window *w)

   306

{

   307

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

   308

}

   309

   310

static void BuildRailClick_Depot(Window *w)

   311

{

   312

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

   313

		ShowBuildTrainDepotPicker();

   314

	}

   315

}

   316

   317

static void BuildRailClick_Waypoint(Window *w)

   318

{

   319

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   320

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

   321

			_waypoint_count > 1) {

   322

		ShowBuildWaypointPicker();

   323

	}

   324

}

   325

   326

static void BuildRailClick_Station(Window *w)

   327

{

   328

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

   329

}

   330

   331

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

   332

static void BuildRailClick_AutoSignals(Window *w)

   333

{

   334

	if (_patches.enable_signal_gui) {

   335

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

   336

	} else {

   337

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

   338

	}

   339

}

   340

   341

static void BuildRailClick_Bridge(Window *w)

   342

{

   343

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

   344

}

   345

   346

static void BuildRailClick_Tunnel(Window *w)

   347

{

   348

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

   349

}

   350

   351

static void BuildRailClick_Remove(Window *w)

   352

{

   353

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

   354

	SetWindowDirty(w);

   355

	SndPlayFx(SND_15_BEEP);

   356

   357

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   358

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   359

	SetSelectionRed(_remove_button_clicked);

   360

   361

	// handle station builder

   362

	if (_remove_button_clicked) {

   363

		SetTileSelectSize(1, 1);

   364

	}

   365

}

   366

   367

static void BuildRailClick_Convert(Window *w)

   368

{

   369

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

   370

}

   371

   372

   373

static void DoRailroadTrack(int mode)

   374

{

   375

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

   376

		(_remove_button_clicked || _ctrl_pressed) ?

   377

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   378

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   379

	);

   380

}

   381

   382

static void HandleAutodirPlacement()

   383

{

   384

	TileHighlightData *thd = &_thd;

   385

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

   386

   387

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

   388

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

   389

		return;

   390

	}

   391

   392

	DoRailroadTrack(trackstat);

   393

}

   394

   395

/**

   396

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

   397

 *

   398

 * If one tile marked abort and use GenericPlaceSignals()

   399

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

   400

 */

   401

static void HandleAutoSignalPlacement()

   402

{

   403

	TileHighlightData *thd = &_thd;

   404

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

   405

   406

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

   407

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

   408

		return;

   409

	}

   410

   411

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

   412

	SB(p2,  3, 1, 0);

   413

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

   414

	SB(p2,  6, 1, _ctrl_pressed);

   415

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

   416

   417

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

   418

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

   419

	DoCommandP(

   420

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

   421

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

   422

		p2,

   423

		CcPlaySound1E,

   424

		_remove_button_clicked ?

   425

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   426

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   427

	);

   428

}

   429

   430

   431

typedef void OnButtonClick(Window *w);

   432

   433

static OnButtonClick * const _build_railroad_button_proc[] = {

   434

	BuildRailClick_N,

   435

	BuildRailClick_NE,

   436

	BuildRailClick_E,

   437

	BuildRailClick_NW,

   438

	BuildRailClick_AutoRail,

   439

	BuildRailClick_Demolish,

   440

	BuildRailClick_Depot,

   441

	BuildRailClick_Waypoint,

   442

	BuildRailClick_Station,

   443

	BuildRailClick_AutoSignals,

   444

	BuildRailClick_Bridge,

   445

	BuildRailClick_Tunnel,

   446

	BuildRailClick_Remove,

   447

	BuildRailClick_Convert

   448

};

   449

   450

static const uint16 _rail_keycodes[] = {

   451

	'1',

   452

	'2',

   453

	'3',

   454

	'4',

   455

	'5',

   456

	'6',

   457

	'7', // depot

   458

	'8', // waypoint

   459

	'9', // station

   460

	'S', // signals

   461

	'B', // bridge

   462

	'T', // tunnel

   463

	'R', // remove

   464

	'C', // convert rail

   465

};

   466

   467

   468

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   469

{

   470

	switch (clicked_widget) {

   471

		case RTW_REMOVE:

   472

			/* If it is the removal button that has been clicked, do nothing,

   473

			 * as it is up to the other buttons to drive removal status */

   474

			return;

   475

			break;

   476

		case RTW_BUILD_NS:

   477

		case RTW_BUILD_X:

   478

		case RTW_BUILD_EW:

   479

		case RTW_BUILD_Y:

   480

		case RTW_AUTORAIL:

   481

		case RTW_BUILD_WAYPOINT:

   482

		case RTW_BUILD_STATION:

   483

		case RTW_BUILD_SIGNALS:

   484

			/* Removal button is enabled only if the rail/signal/waypoint/station

   485

			 * button is still lowered.  Once raised, it has to be disabled */

   486

			w->SetWidgetDisabledState(RTW_REMOVE, !w->IsWidgetLowered(clicked_widget));

   487

			break;

   488

   489

		default:

   490

			/* When any other buttons than rail/signal/waypoint/station, raise and

   491

			 * disable the removal button */