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

    36

static RailType _cur_railtype;

    37

static bool _remove_button_clicked;

    38

static DiagDirection _build_depot_direction;

    39

static byte _waypoint_count = 1;

    40

static byte _cur_waypoint_type;

    41

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

    42

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

    43

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

    44

    45

static struct {

    46

	byte orientation;

    47

	byte numtracks;

    48

	byte platlength;

    49

	bool dragdrop;

    50

    51

	bool newstations;

    52

	StationClassIDByte station_class;

    53

	byte station_type;

    54

	byte station_count;

    55

} _railstation;

    56

    57

    58

static void HandleStationPlacement(TileIndex start, TileIndex end);

    59

static void ShowBuildTrainDepotPicker();

    60

static void ShowBuildWaypointPicker();

    61

static void ShowStationBuilder();

    62

static void ShowSignalBuilder();

    63

    64

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

    65

{

    66

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    67

}

    68

    69

static void GenericPlaceRail(TileIndex tile, int cmd)

    70

{

    71

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    72

		(_remove_button_clicked || _ctrl_pressed) ?

    73

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    74

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    75

	);

    76

}

    77

    78

static void PlaceRail_N(TileIndex tile)

    79

{

    80

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

    81

	GenericPlaceRail(tile, cmd);

    82

}

    83

    84

static void PlaceRail_NE(TileIndex tile)

    85

{

    86

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    87

}

    88

    89

static void PlaceRail_E(TileIndex tile)

    90

{

    91

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

    92

	GenericPlaceRail(tile, cmd);

    93

}

    94

    95

static void PlaceRail_NW(TileIndex tile)

    96

{

    97

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

    98

}

    99

   100

static void PlaceRail_AutoRail(TileIndex tile)

   101

{

   102

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   103

}

   104

   105

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   106

{

   107

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

   108

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

   109

   110

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

   111

}

   112

   113

static const uint16 _place_depot_extra[12] = {

   114

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

   115

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

   116

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

   117

};

   118

   119

   120

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

   121

{

   122

	if (success) {

   123

		DiagDirection dir = (DiagDirection)p2;

   124

   125

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   126

		ResetObjectToPlace();

   127

   128

		tile += TileOffsByDiagDir(dir);

   129

   130

		if (IsTileType(tile, MP_RAILWAY)) {

   131

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   132

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

   133

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

   134

		}

   135

	}

   136

}

   137

   138

static void PlaceRail_Depot(TileIndex tile)

   139

{

   140

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   141

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   142

}

   143

   144

static void PlaceRail_Waypoint(TileIndex tile)

   145

{

   146

	if (_remove_button_clicked || _ctrl_pressed) {

   147

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

   148

	} else {

   149

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

   150

	}

   151

}

   152

   153

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

   154

{

   155

	if (success) {

   156

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   157

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

   158

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

   159

	}

   160

}

   161

   162

static void PlaceRail_Station(TileIndex tile)

   163

{

   164

	if (_remove_button_clicked) {

   165

		VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_REMOVE_STATION);

   166

	} else if (_railstation.dragdrop) {

   167

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   168

		VpSetPlaceSizingLimit(_patches.station_spread);

   169

	} else {

   170

		DoCommandP(tile,

   171

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

   172

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

   173

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   174

	}

   175

}

   176

   177

/**

   178

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

   179

 *

   180

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

   181

 */

   182

static void GenericPlaceSignals(TileIndex tile)

   183

{

   184

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

   185

   186

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

   187

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

   188

	}

   189

   190

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

   191

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

   192

	}

   193

   194

	Track track = FindFirstTrack(trackbits);

   195

   196

	if (_remove_button_clicked) {

   197

		DoCommandP(tile, track, 0, CcPlaySound1E,

   198

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   199

	} else {

   200

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

   201

   202

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   203

		uint32 p1 = track;

   204

		SB(p1, 3, 1, _ctrl_pressed);

   205

		SB(p1, 4, 1, _cur_signal_variant);

   206

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

   207

		SB(p1, 7, 1, _convert_signal_button);

   208

   209

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

   210

			CMD_MSG(_convert_signal_button ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   211

	}

   212

}

   213

   214

static void PlaceRail_Bridge(TileIndex tile)

   215

{

   216

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   217

}

   218

   219

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

   220

{

   221

	if (success) {

   222

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   223

		ResetObjectToPlace();

   224

	} else {

   225

		SetRedErrorSquare(_build_tunnel_endtile);

   226

	}

   227

}

   228

   229

static void PlaceRail_Tunnel(TileIndex tile)

   230

{

   231

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   232

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   233

}

   234

   235

void PlaceProc_BuyLand(TileIndex tile)

   236

{

   237

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

   238

}

   239

   240

static void PlaceRail_ConvertRail(TileIndex tile)

   241

{

   242

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   243

}

   244

   245

static void PlaceRail_AutoSignals(TileIndex tile)

   246

{

   247

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   248

}

   249

   250

   251

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

   252

enum RailToolbarWidgets {

   253

	RTW_CLOSEBOX = 0,

   254

	RTW_CAPTION,

   255

	RTW_STICKY,

   256

	RTW_SPACER,

   257

	RTW_BUILD_NS,

   258

	RTW_BUILD_X,

   259

	RTW_BUILD_EW,

   260

	RTW_BUILD_Y,

   261

	RTW_AUTORAIL,

   262

	RTW_DEMOLISH,

   263

	RTW_BUILD_DEPOT,

   264

	RTW_BUILD_WAYPOINT,

   265

	RTW_BUILD_STATION,

   266

	RTW_BUILD_SIGNALS,

   267

	RTW_BUILD_BRIDGE,

   268

	RTW_BUILD_TUNNEL,

   269

	RTW_REMOVE,

   270

	RTW_CONVERT_RAIL,

   271

};

   272

   273

static void BuildRailClick_N(Window *w)

   274

{

   275

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

   276

}

   277

   278

static void BuildRailClick_NE(Window *w)

   279

{

   280

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

   281

}

   282

   283

static void BuildRailClick_E(Window *w)

   284

{

   285

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

   286

}

   287

   288

static void BuildRailClick_NW(Window *w)

   289

{

   290

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

   291

}

   292

   293

static void BuildRailClick_AutoRail(Window *w)

   294

{

   295

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

   296

}

   297

   298

static void BuildRailClick_Demolish(Window *w)

   299

{

   300

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

   301

}

   302

   303

static void BuildRailClick_Depot(Window *w)

   304

{

   305

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

   306

		ShowBuildTrainDepotPicker();

   307

	}

   308

}

   309

   310

static void BuildRailClick_Waypoint(Window *w)

   311

{

   312

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   313

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

   314

			_waypoint_count > 1) {

   315

		ShowBuildWaypointPicker();

   316

	}

   317

}

   318

   319

static void BuildRailClick_Station(Window *w)

   320

{

   321

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

   322

}

   323

   324

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

   325

static void BuildRailClick_AutoSignals(Window *w)

   326

{

   327

	if (_patches.enable_signal_gui) {

   328

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

   329

	} else {

   330

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

   331

	}

   332

}

   333

   334

static void BuildRailClick_Bridge(Window *w)

   335

{

   336

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

   337

}

   338

   339

static void BuildRailClick_Tunnel(Window *w)

   340

{

   341

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

   342

}

   343

   344

static void BuildRailClick_Remove(Window *w)

   345

{

   346

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

   347

	SetWindowDirty(w);

   348

	SndPlayFx(SND_15_BEEP);

   349

   350

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   351

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   352

	SetSelectionRed(_remove_button_clicked);

   353

   354

	// handle station builder

   355

	if (_remove_button_clicked) {

   356

		SetTileSelectSize(1, 1);

   357

	}

   358

}

   359

   360

static void BuildRailClick_Convert(Window *w)

   361

{

   362

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

   363

}

   364

   365

   366

static void DoRailroadTrack(int mode)

   367

{

   368

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

   369

		(_remove_button_clicked || _ctrl_pressed) ?

   370

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   371

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   372

	);

   373

}

   374

   375

static void HandleAutodirPlacement()

   376

{

   377

	TileHighlightData *thd = &_thd;

   378

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

   379

   380

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

   381

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

   382

		return;

   383

	}

   384

   385

	DoRailroadTrack(trackstat);

   386

}

   387

   388

/**

   389

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

   390

 *

   391

 * If one tile marked abort and use GenericPlaceSignals()

   392

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

   393

 */

   394

static void HandleAutoSignalPlacement()

   395

{

   396

	TileHighlightData *thd = &_thd;

   397

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

   398

   399

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

   400

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

   401

		return;

   402

	}

   403

   404

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

   405

	SB(p2,  3, 1, 0);

   406

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

   407

	SB(p2,  6, 1, _ctrl_pressed);

   408

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

   409

   410

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

   411

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

   412

	DoCommandP(

   413

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

   414

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

   415

		p2,

   416

		CcPlaySound1E,

   417

		_remove_button_clicked ?

   418

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   419

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   420

	);

   421

}

   422

   423

   424

typedef void OnButtonClick(Window *w);

   425

   426

static OnButtonClick * const _build_railroad_button_proc[] = {

   427

	BuildRailClick_N,

   428

	BuildRailClick_NE,

   429

	BuildRailClick_E,

   430

	BuildRailClick_NW,

   431

	BuildRailClick_AutoRail,

   432

	BuildRailClick_Demolish,

   433

	BuildRailClick_Depot,

   434

	BuildRailClick_Waypoint,

   435

	BuildRailClick_Station,

   436

	BuildRailClick_AutoSignals,

   437

	BuildRailClick_Bridge,

   438

	BuildRailClick_Tunnel,

   439

	BuildRailClick_Remove,

   440

	BuildRailClick_Convert

   441

};

   442

   443

static const uint16 _rail_keycodes[] = {

   444

	'1',

   445

	'2',

   446

	'3',

   447

	'4',

   448

	'5',

   449

	'6',

   450

	'7', // depot

   451

	'8', // waypoint

   452

	'9', // station

   453

	'S', // signals

   454

	'B', // bridge

   455

	'T', // tunnel

   456

	'R', // remove

   457

	'C', // convert rail

   458

};

   459

   460

   461

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   462

{

   463

	switch (clicked_widget) {

   464

		case RTW_REMOVE:

   465

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

   466

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

   467

			return;

   468

			break;

   469

		case RTW_BUILD_NS:

   470

		case RTW_BUILD_X:

   471

		case RTW_BUILD_EW:

   472

		case RTW_BUILD_Y:

   473

		case RTW_AUTORAIL:

   474

		case RTW_BUILD_WAYPOINT:

   475

		case RTW_BUILD_STATION:

   476

		case RTW_BUILD_SIGNALS:

   477

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

   478

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

   479

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

   480

			break;

   481

   482

		default:

   483

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

   484

			 * disable the removal button */

   485

			w->DisableWidget(RTW_REMOVE);

   486

			w->RaiseWidget(RTW_REMOVE);

   487

			break;

   488

	}

   489

}

   490

   491

/**