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 "table/sprites.h"

     8

#include "table/strings.h"

     9

#include "strings.h"

    10

#include "functions.h"

    11

#include "landscape.h"

    12

#include "date.h"

    13

#include "map.h"

    14

#include "tile.h"

    15

#include "window.h"

    16

#include "gui.h"

    17

#include "viewport.h"

    18

#include "gfx.h"

    19

#include "sound.h"

    20

#include "command.h"

    21

#include "vehicle.h"

    22

#include "station.h"

    23

#include "waypoint.h"

    24

#include "debug.h"

    25

#include "variables.h"

    26

#include "newgrf_callbacks.h"

    27

#include "newgrf_station.h"

    28

#include "train.h"

    29

    30

#include "bridge_map.h"

    31

#include "rail_map.h"

    32

#include "road_map.h"

    33

#include "station_map.h"

    34

#include "tunnel_map.h"

    35

#include "tunnelbridge_map.h"

    36

    37

    38

static RailType _cur_railtype;

    39

static bool _remove_button_clicked;

    40

static DiagDirection _build_depot_direction;

    41

static byte _waypoint_count = 1;

    42

static byte _cur_waypoint_type;

    43

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

    44

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

    45

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

    46

    47

static struct {

    48

	byte orientation;

    49

	byte numtracks;

    50

	byte platlength;

    51

	bool dragdrop;

    52

    53

	bool newstations;

    54

	StationClassIDByte station_class;

    55

	byte station_type;

    56

	byte station_count;

    57

} _railstation;

    58

    59

    60

static void HandleStationPlacement(TileIndex start, TileIndex end);

    61

static void ShowBuildTrainDepotPicker();

    62

static void ShowBuildWaypointPicker();

    63

static void ShowStationBuilder();

    64

static void ShowSignalBuilder();

    65

    66

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

    67

{

    68

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    69

}

    70

    71

static void GenericPlaceRail(TileIndex tile, int cmd)

    72

{

    73

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    74

		(_remove_button_clicked || _ctrl_pressed) ?

    75

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    76

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    77

	);

    78

}

    79

    80

static void PlaceRail_N(TileIndex tile)

    81

{

    82

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

    83

	GenericPlaceRail(tile, cmd);

    84

}

    85

    86

static void PlaceRail_NE(TileIndex tile)

    87

{

    88

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    89

}

    90

    91

static void PlaceRail_E(TileIndex tile)

    92

{

    93

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

    94

	GenericPlaceRail(tile, cmd);

    95

}

    96

    97

static void PlaceRail_NW(TileIndex tile)

    98

{

    99

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   100

}

   101

   102

static void PlaceRail_AutoRail(TileIndex tile)

   103

{

   104

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   105

}

   106

   107

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   108

{

   109

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

   110

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

   111

   112

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

   113

}

   114

   115

static const uint16 _place_depot_extra[12] = {

   116

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

   117

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

   118

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

   119

};

   120

   121

   122

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

   123

{

   124

	if (success) {

   125

		DiagDirection dir = (DiagDirection)p2;

   126

   127

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   128

		ResetObjectToPlace();

   129

   130

		tile += TileOffsByDiagDir(dir);

   131

   132

		if (IsTileType(tile, MP_RAILWAY)) {

   133

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   134

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

   135

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

   136

		}

   137

	}

   138

}

   139

   140

static void PlaceRail_Depot(TileIndex tile)

   141

{

   142

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   143

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   144

}

   145

   146

static void PlaceRail_Waypoint(TileIndex tile)

   147

{

   148

	if (_remove_button_clicked || _ctrl_pressed) {

   149

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

   150

	} else {

   151

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

   152

	}

   153

}

   154

   155

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

   156

{

   157

	if (success) {

   158

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   159

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

   160

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

   161

	}

   162

}

   163

   164

static void PlaceRail_Station(TileIndex tile)

   165

{

   166

	if (_remove_button_clicked) {

   167

		VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_REMOVE_STATION);

   168

	} else if (_railstation.dragdrop) {

   169

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   170

		VpSetPlaceSizingLimit(_patches.station_spread);

   171

	} else {

   172

		DoCommandP(tile,

   173

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

   174

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

   175

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   176

	}

   177

}

   178

   179

/**

   180

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

   181

 *

   182

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

   183

 */

   184

static void GenericPlaceSignals(TileIndex tile)

   185

{

   186

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

   187

   188

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

   189

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

   190

	}

   191

   192

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

   193

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

   194

	}

   195

   196

	Track track = FindFirstTrack(trackbits);

   197

   198

	if (_remove_button_clicked) {

   199

		DoCommandP(tile, track, 0, CcPlaySound1E,

   200

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   201

	} else {

   202

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

   203

   204

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   205

		uint32 p1 = track;

   206

		SB(p1, 3, 1, _ctrl_pressed);

   207

		SB(p1, 4, 1, _cur_signal_variant);

   208

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

   209

		SB(p1, 7, 1, _convert_signal_button);

   210

   211

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

   212

			CMD_MSG(_convert_signal_button ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   213

	}

   214

}

   215

   216

static void PlaceRail_Bridge(TileIndex tile)

   217

{

   218

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   219

}

   220

   221

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

   222

{

   223

	if (success) {

   224

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   225

		ResetObjectToPlace();

   226

	} else {

   227

		SetRedErrorSquare(_build_tunnel_endtile);

   228

	}

   229

}

   230

   231

static void PlaceRail_Tunnel(TileIndex tile)

   232

{

   233

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   234

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   235

}

   236

   237

void PlaceProc_BuyLand(TileIndex tile)

   238

{

   239

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

   240

}

   241

   242

static void PlaceRail_ConvertRail(TileIndex tile)

   243

{

   244

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   245

}

   246

   247

static void PlaceRail_AutoSignals(TileIndex tile)

   248

{

   249

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   250

}

   251

   252

   253

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

   254

enum RailToolbarWidgets {

   255

	RTW_CLOSEBOX = 0,

   256

	RTW_CAPTION,

   257

	RTW_STICKY,

   258

	RTW_SPACER,

   259

	RTW_BUILD_NS,

   260

	RTW_BUILD_X,

   261

	RTW_BUILD_EW,

   262

	RTW_BUILD_Y,

   263

	RTW_AUTORAIL,

   264

	RTW_DEMOLISH,

   265

	RTW_BUILD_DEPOT,

   266

	RTW_BUILD_WAYPOINT,

   267

	RTW_BUILD_STATION,

   268

	RTW_BUILD_SIGNALS,

   269

	RTW_BUILD_BRIDGE,

   270

	RTW_BUILD_TUNNEL,

   271

	RTW_REMOVE,

   272

	RTW_CONVERT_RAIL,

   273

};

   274

   275

static void BuildRailClick_N(Window *w)

   276

{

   277

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

   278

}

   279

   280

static void BuildRailClick_NE(Window *w)

   281

{

   282

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

   283

}

   284

   285

static void BuildRailClick_E(Window *w)

   286

{

   287

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

   288

}

   289

   290

static void BuildRailClick_NW(Window *w)

   291

{

   292

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

   293

}

   294

   295

static void BuildRailClick_AutoRail(Window *w)

   296

{

   297

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

   298

}

   299

   300

static void BuildRailClick_Demolish(Window *w)

   301

{

   302

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

   303

}

   304

   305

static void BuildRailClick_Depot(Window *w)

   306

{

   307

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

   308

		ShowBuildTrainDepotPicker();

   309

	}

   310

}

   311

   312

static void BuildRailClick_Waypoint(Window *w)

   313

{

   314

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   315

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

   316

			_waypoint_count > 1) {

   317

		ShowBuildWaypointPicker();

   318

	}

   319

}

   320

   321

static void BuildRailClick_Station(Window *w)

   322

{

   323

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

   324

}

   325

   326

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

   327

static void BuildRailClick_AutoSignals(Window *w)

   328

{

   329

	if (_patches.enable_signal_gui) {

   330

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

   331

	} else {

   332

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

   333

	}

   334

}

   335

   336

static void BuildRailClick_Bridge(Window *w)

   337

{

   338

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

   339

}

   340

   341

static void BuildRailClick_Tunnel(Window *w)

   342

{

   343

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

   344

}

   345

   346

static void BuildRailClick_Remove(Window *w)

   347

{

   348

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

   349

	SetWindowDirty(w);

   350

	SndPlayFx(SND_15_BEEP);

   351

   352

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   353

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   354

	SetSelectionRed(_remove_button_clicked);

   355

   356

	// handle station builder

   357

	if (_remove_button_clicked) {

   358

		SetTileSelectSize(1, 1);

   359

	}

   360

}

   361

   362

static void BuildRailClick_Convert(Window *w)

   363

{

   364

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

   365

}

   366

   367

   368

static void DoRailroadTrack(int mode)

   369

{

   370

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

   371

		(_remove_button_clicked || _ctrl_pressed) ?

   372

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   373

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   374

	);

   375

}

   376

   377

static void HandleAutodirPlacement()

   378

{

   379

	TileHighlightData *thd = &_thd;

   380

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

   381

   382

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

   383

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

   384

		return;

   385

	}

   386

   387

	DoRailroadTrack(trackstat);

   388

}

   389

   390

/**

   391

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

   392

 *

   393

 * If one tile marked abort and use GenericPlaceSignals()

   394

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

   395

 */

   396

static void HandleAutoSignalPlacement()

   397

{

   398

	TileHighlightData *thd = &_thd;

   399

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

   400

   401

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

   402

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

   403

		return;

   404

	}

   405

   406

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

   407

	SB(p2,  3, 1, 0);

   408

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

   409

	SB(p2,  6, 1, _ctrl_pressed);

   410

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

   411

   412

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

   413

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

   414

	DoCommandP(

   415

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

   416

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

   417

		p2,

   418

		CcPlaySound1E,

   419

		_remove_button_clicked ?

   420

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   421

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   422

	);

   423

}

   424

   425

   426

typedef void OnButtonClick(Window *w);

   427

   428

static OnButtonClick * const _build_railroad_button_proc[] = {

   429

	BuildRailClick_N,

   430

	BuildRailClick_NE,

   431

	BuildRailClick_E,

   432

	BuildRailClick_NW,

   433

	BuildRailClick_AutoRail,

   434

	BuildRailClick_Demolish,

   435

	BuildRailClick_Depot,

   436

	BuildRailClick_Waypoint,

   437

	BuildRailClick_Station,

   438

	BuildRailClick_AutoSignals,

   439

	BuildRailClick_Bridge,

   440

	BuildRailClick_Tunnel,

   441

	BuildRailClick_Remove,

   442

	BuildRailClick_Convert

   443

};

   444

   445

static const uint16 _rail_keycodes[] = {

   446

	'1',

   447

	'2',

   448

	'3',

   449

	'4',

   450

	'5',

   451

	'6',

   452

	'7', // depot

   453

	'8', // waypoint

   454

	'9', // station

   455

	'S', // signals

   456

	'B', // bridge

   457

	'T', // tunnel

   458

	'R', // remove

   459

	'C', // convert rail

   460

};

   461

   462

   463

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   464

{

   465

	switch (clicked_widget) {

   466

		case RTW_REMOVE:

   467

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

   468

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

   469

			return;

   470

			break;

   471

		case RTW_BUILD_NS:

   472

		case RTW_BUILD_X:

   473

		case RTW_BUILD_EW:

   474

		case RTW_BUILD_Y:

   475

		case RTW_AUTORAIL:

   476

		case RTW_BUILD_WAYPOINT:

   477

		case RTW_BUILD_STATION:

   478

		case RTW_BUILD_SIGNALS:

   479

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

   480

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

   481

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

   482

			break;

   483

   484

		default:

   485

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

   486

			 * disable the removal button */

   487

			w->DisableWidget(RTW_REMOVE);

   488

			w->RaiseWidget(RTW_REMOVE);

   489

			break;

   490

	}

   491

}