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"

    30

    31

#include "bridge_map.h"

    32

#include "rail_map.h"

    33

#include "road_map.h"

    34

#include "station_map.h"

    35

#include "tunnel_map.h"

    36

#include "tunnelbridge_map.h"

    37

    38

#include "table/sprites.h"

    39

#include "table/strings.h"

    40

    41

static RailType _cur_railtype;

    42

static bool _remove_button_clicked;

    43

static DiagDirection _build_depot_direction;

    44

static byte _waypoint_count = 1;

    45

static byte _cur_waypoint_type;

    46

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

    47

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

    48

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

    49

    50

static struct {

    51

	byte orientation;

    52

	byte numtracks;

    53

	byte platlength;

    54

	bool dragdrop;

    55

    56

	bool newstations;

    57

	StationClassIDByte station_class;

    58

	byte station_type;

    59

	byte station_count;

    60

} _railstation;

    61

    62

    63

static void HandleStationPlacement(TileIndex start, TileIndex end);

    64

static void ShowBuildTrainDepotPicker();

    65

static void ShowBuildWaypointPicker();

    66

static void ShowStationBuilder();

    67

static void ShowSignalBuilder();

    68

    69

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

    70

{

    71

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    72

}

    73

    74

static void GenericPlaceRail(TileIndex tile, int cmd)

    75

{

    76

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    77

		(_remove_button_clicked || _ctrl_pressed) ?

    78

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    79

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    80

	);

    81

}

    82

    83

static void PlaceRail_N(TileIndex tile)

    84

{

    85

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

    86

	GenericPlaceRail(tile, cmd);

    87

}

    88

    89

static void PlaceRail_NE(TileIndex tile)

    90

{

    91

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    92

}

    93

    94

static void PlaceRail_E(TileIndex tile)

    95

{

    96

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

    97

	GenericPlaceRail(tile, cmd);

    98

}

    99

   100

static void PlaceRail_NW(TileIndex tile)

   101

{

   102

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   103

}

   104

   105

static void PlaceRail_AutoRail(TileIndex tile)

   106

{

   107

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   108

}

   109

   110

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   111

{

   112

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

   113

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

   114

   115

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

   116

}

   117

   118

static const uint16 _place_depot_extra[12] = {

   119

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

   120

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

   121

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

   122

};

   123

   124

   125

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

   126

{

   127

	if (success) {

   128

		DiagDirection dir = (DiagDirection)p2;

   129

   130

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   131

		ResetObjectToPlace();

   132

   133

		tile += TileOffsByDiagDir(dir);

   134

   135

		if (IsTileType(tile, MP_RAILWAY)) {

   136

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   137

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

   138

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

   139

		}

   140

	}

   141

}

   142

   143

static void PlaceRail_Depot(TileIndex tile)

   144

{

   145

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   146

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   147

}

   148

   149

static void PlaceRail_Waypoint(TileIndex tile)

   150

{

   151

	if (_remove_button_clicked || _ctrl_pressed) {

   152

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

   153

	} else {

   154

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

   155

	}

   156

}

   157

   158

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

   159

{

   160

	if (success) {

   161

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   162

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

   163

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

   164

	}

   165

}

   166

   167

static void PlaceRail_Station(TileIndex tile)

   168

{

   169

	if (_remove_button_clicked) {

   170

		VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_REMOVE_STATION);

   171

	} else if (_railstation.dragdrop) {

   172

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   173

		VpSetPlaceSizingLimit(_patches.station_spread);

   174

	} else {

   175

		DoCommandP(tile,

   176

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

   177

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

   178

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   179

	}

   180

}

   181

   182

/**

   183

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

   184

 *

   185

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

   186

 */

   187

static void GenericPlaceSignals(TileIndex tile)

   188

{

   189

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

   190

   191

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

   192

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

   193

	}

   194

   195

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

   196

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

   197

	}

   198

   199

	Track track = FindFirstTrack(trackbits);

   200

   201

	if (_remove_button_clicked) {

   202

		DoCommandP(tile, track, 0, CcPlaySound1E,

   203

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   204

	} else {

   205

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

   206

   207

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   208

		uint32 p1 = track;

   209

		SB(p1, 3, 1, _ctrl_pressed);

   210

		SB(p1, 4, 1, _cur_signal_variant);

   211

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

   212

		SB(p1, 7, 1, _convert_signal_button);

   213

   214

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

   215

			CMD_MSG(_convert_signal_button ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   216

	}

   217

}

   218

   219

static void PlaceRail_Bridge(TileIndex tile)

   220

{

   221

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   222

}

   223

   224

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

   225

{

   226

	if (success) {

   227

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   228

		ResetObjectToPlace();

   229

	} else {

   230

		SetRedErrorSquare(_build_tunnel_endtile);

   231

	}

   232

}

   233

   234

static void PlaceRail_Tunnel(TileIndex tile)

   235

{

   236

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   237

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   238

}

   239

   240

void PlaceProc_BuyLand(TileIndex tile)

   241

{

   242

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

   243

}

   244

   245

static void PlaceRail_ConvertRail(TileIndex tile)

   246

{

   247

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   248

}

   249

   250

static void PlaceRail_AutoSignals(TileIndex tile)

   251

{

   252

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   253

}

   254

   255

   256

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

   257

enum RailToolbarWidgets {

   258

	RTW_CLOSEBOX = 0,

   259

	RTW_CAPTION,

   260

	RTW_STICKY,

   261

	RTW_SPACER,

   262

	RTW_BUILD_NS,

   263

	RTW_BUILD_X,

   264

	RTW_BUILD_EW,

   265

	RTW_BUILD_Y,

   266

	RTW_AUTORAIL,

   267

	RTW_DEMOLISH,

   268

	RTW_BUILD_DEPOT,

   269

	RTW_BUILD_WAYPOINT,

   270

	RTW_BUILD_STATION,

   271

	RTW_BUILD_SIGNALS,

   272

	RTW_BUILD_BRIDGE,

   273

	RTW_BUILD_TUNNEL,

   274

	RTW_REMOVE,

   275

	RTW_CONVERT_RAIL,

   276

};

   277

   278

static void BuildRailClick_N(Window *w)

   279

{

   280

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

   281

}

   282

   283

static void BuildRailClick_NE(Window *w)

   284

{

   285

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

   286

}

   287

   288

static void BuildRailClick_E(Window *w)

   289

{

   290

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

   291

}

   292

   293

static void BuildRailClick_NW(Window *w)

   294

{

   295

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

   296

}

   297

   298

static void BuildRailClick_AutoRail(Window *w)

   299

{

   300

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

   301

}

   302

   303

static void BuildRailClick_Demolish(Window *w)

   304

{

   305

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

   306

}

   307

   308

static void BuildRailClick_Depot(Window *w)

   309

{

   310

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

   311

		ShowBuildTrainDepotPicker();

   312

	}

   313

}

   314

   315

static void BuildRailClick_Waypoint(Window *w)

   316

{

   317

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   318

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

   319

			_waypoint_count > 1) {

   320

		ShowBuildWaypointPicker();

   321

	}

   322

}

   323

   324

static void BuildRailClick_Station(Window *w)

   325

{

   326

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

   327

}

   328

   329

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

   330

static void BuildRailClick_AutoSignals(Window *w)

   331

{

   332

	if (_patches.enable_signal_gui) {

   333

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

   334

	} else {

   335

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

   336

	}

   337

}

   338

   339

static void BuildRailClick_Bridge(Window *w)

   340

{

   341

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

   342

}

   343

   344

static void BuildRailClick_Tunnel(Window *w)

   345

{

   346

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

   347

}

   348

   349

static void BuildRailClick_Remove(Window *w)

   350

{

   351

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

   352

	SetWindowDirty(w);

   353

	SndPlayFx(SND_15_BEEP);

   354

   355

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   356

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   357

	SetSelectionRed(_remove_button_clicked);

   358

   359

	// handle station builder

   360

	if (_remove_button_clicked) {

   361

		SetTileSelectSize(1, 1);

   362

	}

   363

}

   364

   365

static void BuildRailClick_Convert(Window *w)

   366

{

   367

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

   368

}

   369

   370

   371

static void DoRailroadTrack(int mode)

   372

{

   373

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

   374

		(_remove_button_clicked || _ctrl_pressed) ?

   375

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   376

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   377

	);

   378

}

   379

   380

static void HandleAutodirPlacement()

   381

{

   382

	TileHighlightData *thd = &_thd;

   383

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

   384

   385

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

   386

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

   387

		return;

   388

	}

   389

   390

	DoRailroadTrack(trackstat);

   391

}

   392

   393

/**

   394

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

   395

 *

   396

 * If one tile marked abort and use GenericPlaceSignals()

   397

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

   398

 */

   399

static void HandleAutoSignalPlacement()

   400

{

   401

	TileHighlightData *thd = &_thd;

   402

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

   403

   404

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

   405

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

   406

		return;

   407

	}

   408

   409

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

   410

	SB(p2,  3, 1, 0);

   411

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

   412

	SB(p2,  6, 1, _ctrl_pressed);

   413

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

   414

   415

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

   416

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

   417

	DoCommandP(

   418

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

   419

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

   420

		p2,

   421

		CcPlaySound1E,

   422

		_remove_button_clicked ?

   423

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   424

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   425

	);

   426

}

   427

   428

   429

typedef void OnButtonClick(Window *w);

   430

   431

static OnButtonClick * const _build_railroad_button_proc[] = {

   432

	BuildRailClick_N,

   433

	BuildRailClick_NE,

   434

	BuildRailClick_E,

   435

	BuildRailClick_NW,

   436

	BuildRailClick_AutoRail,

   437

	BuildRailClick_Demolish,

   438

	BuildRailClick_Depot,

   439

	BuildRailClick_Waypoint,

   440

	BuildRailClick_Station,

   441

	BuildRailClick_AutoSignals,

   442

	BuildRailClick_Bridge,

   443

	BuildRailClick_Tunnel,

   444

	BuildRailClick_Remove,

   445

	BuildRailClick_Convert

   446

};

   447

   448

static const uint16 _rail_keycodes[] = {

   449

	'1',

   450

	'2',

   451

	'3',

   452

	'4',

   453

	'5',

   454

	'6',

   455

	'7', // depot

   456

	'8', // waypoint

   457

	'9', // station

   458

	'S', // signals

   459

	'B', // bridge

   460

	'T', // tunnel

   461

	'R', // remove

   462

	'C', // convert rail

   463

};

   464

   465

   466

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   467

{

   468

	switch (clicked_widget) {

   469

		case RTW_REMOVE:

   470

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

   471

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

   472

			return;

   473

			break;

   474

		case RTW_BUILD_NS:

   475

		case RTW_BUILD_X:

   476

		case RTW_BUILD_EW:

   477

		case RTW_BUILD_Y:

   478

		case RTW_AUTORAIL:

   479

		case RTW_BUILD_WAYPOINT:

   480

		case RTW_BUILD_STATION:

   481

		case RTW_BUILD_SIGNALS:

   482

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

   483

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

   484

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

   485

			break;

   486

   487

		default:

   488

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

   489

			 * disable the removal button */

   490

			w->DisableWidget(RTW_REMOVE);

   491

			w->RaiseWidget(RTW_REMOVE);