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 "tile_cmd.h"

    10

#include "landscape.h"

    11

#include "date.h"

    12

#include "map.h"

    13

#include "gui.h"

    14

#include "window_gui.h"

    15

#include "station_gui.h"

    16

#include "viewport.h"

    17

#include "sound.h"

    18

#include "command_func.h"

    19

#include "vehicle.h"

    20

#include "station.h"

    21

#include "waypoint.h"

    22

#include "debug.h"

    23

#include "variables.h"

    24

#include "newgrf_callbacks.h"

    25

#include "newgrf_station.h"

    26

#include "train.h"

    27

#include "strings_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

    39

static RailType _cur_railtype;

    40

static bool _remove_button_clicked;

    41

static DiagDirection _build_depot_direction;

    42

static byte _waypoint_count = 1;

    43

static byte _cur_waypoint_type;

    44

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

    45

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

    46

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

    47

    48

static struct {

    49

	byte orientation;

    50

	byte numtracks;

    51

	byte platlength;

    52

	bool dragdrop;

    53

    54

	bool newstations;

    55

	StationClassIDByte station_class;

    56

	byte station_type;

    57

	byte station_count;

    58

} _railstation;

    59

    60

    61

static void HandleStationPlacement(TileIndex start, TileIndex end);

    62

static void ShowBuildTrainDepotPicker();

    63

static void ShowBuildWaypointPicker();

    64

static void ShowStationBuilder();

    65

static void ShowSignalBuilder();

    66

    67

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

    68

{

    69

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    70

}

    71

    72

static void GenericPlaceRail(TileIndex tile, int cmd)

    73

{

    74

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    75

		(_remove_button_clicked || _ctrl_pressed) ?

    76

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    77

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    78

	);

    79

}

    80

    81

static void PlaceRail_N(TileIndex tile)

    82

{

    83

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

    84

	GenericPlaceRail(tile, cmd);

    85

}

    86

    87

static void PlaceRail_NE(TileIndex tile)

    88

{

    89

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    90

}

    91

    92

static void PlaceRail_E(TileIndex tile)

    93

{

    94

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

    95

	GenericPlaceRail(tile, cmd);

    96

}

    97

    98

static void PlaceRail_NW(TileIndex tile)

    99

{

   100

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

   101

}

   102

   103

static void PlaceRail_AutoRail(TileIndex tile)

   104

{

   105

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   106

}

   107

   108

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   109

{

   110

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

   111

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

   112

   113

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

   114

}

   115

   116

static const uint16 _place_depot_extra[12] = {

   117

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

   118

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

   119

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

   120

};

   121

   122

   123

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

   124

{

   125

	if (success) {

   126

		DiagDirection dir = (DiagDirection)p2;

   127

   128

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   129

		ResetObjectToPlace();

   130

   131

		tile += TileOffsByDiagDir(dir);

   132

   133

		if (IsTileType(tile, MP_RAILWAY)) {

   134

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   135

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

   136

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

   137

		}

   138

	}

   139

}

   140

   141

static void PlaceRail_Depot(TileIndex tile)

   142

{

   143

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   144

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   145

}

   146

   147

static void PlaceRail_Waypoint(TileIndex tile)

   148

{

   149

	if (_remove_button_clicked || _ctrl_pressed) {

   150

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

   151

	} else {

   152

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

   153

	}

   154

}

   155

   156

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

   157

{

   158

	if (success) {

   159

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   160

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

   161

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

   162

	}

   163

}

   164

   165

static void PlaceRail_Station(TileIndex tile)

   166

{

   167

	if (_remove_button_clicked) {

   168

		VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_REMOVE_STATION);

   169

	} else if (_railstation.dragdrop) {

   170

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   171

		VpSetPlaceSizingLimit(_patches.station_spread);

   172

	} else {

   173

		DoCommandP(tile,

   174

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

   175

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

   176

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   177

	}

   178

}

   179

   180

/**

   181

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

   182

 *

   183

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

   184

 */

   185

static void GenericPlaceSignals(TileIndex tile)

   186

{

   187

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

   188

   189

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

   190

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

   191

	}

   192

   193

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

   194

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

   195

	}

   196

   197

	Track track = FindFirstTrack(trackbits);

   198

   199

	if (_remove_button_clicked) {

   200

		DoCommandP(tile, track, 0, CcPlaySound1E,

   201

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   202

	} else {

   203

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

   204

   205

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   206

		uint32 p1 = track;

   207

		SB(p1, 3, 1, _ctrl_pressed);

   208

		SB(p1, 4, 1, _cur_signal_variant);

   209

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

   210

		SB(p1, 7, 1, _convert_signal_button);

   211

   212

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

   213

			CMD_MSG(_convert_signal_button ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   214

	}

   215

}

   216

   217

static void PlaceRail_Bridge(TileIndex tile)

   218

{

   219

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   220

}

   221

   222

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

   223

{

   224

	if (success) {

   225

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   226

		ResetObjectToPlace();

   227

	} else {

   228

		SetRedErrorSquare(_build_tunnel_endtile);

   229

	}

   230

}

   231

   232

static void PlaceRail_Tunnel(TileIndex tile)

   233

{

   234

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   235

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   236

}

   237

   238

void PlaceProc_BuyLand(TileIndex tile)

   239

{

   240

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

   241

}

   242

   243

static void PlaceRail_ConvertRail(TileIndex tile)

   244

{

   245

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   246

}

   247

   248

static void PlaceRail_AutoSignals(TileIndex tile)

   249

{

   250

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   251

}

   252

   253

   254

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

   255

enum RailToolbarWidgets {

   256

	RTW_CLOSEBOX = 0,

   257

	RTW_CAPTION,

   258

	RTW_STICKY,

   259

	RTW_SPACER,

   260

	RTW_BUILD_NS,

   261

	RTW_BUILD_X,

   262

	RTW_BUILD_EW,

   263

	RTW_BUILD_Y,

   264

	RTW_AUTORAIL,

   265

	RTW_DEMOLISH,

   266

	RTW_BUILD_DEPOT,

   267

	RTW_BUILD_WAYPOINT,

   268

	RTW_BUILD_STATION,

   269

	RTW_BUILD_SIGNALS,

   270

	RTW_BUILD_BRIDGE,

   271

	RTW_BUILD_TUNNEL,

   272

	RTW_REMOVE,

   273

	RTW_CONVERT_RAIL,

   274

};

   275

   276

static void BuildRailClick_N(Window *w)

   277

{

   278

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

   279

}

   280

   281

static void BuildRailClick_NE(Window *w)

   282

{

   283

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

   284

}

   285

   286

static void BuildRailClick_E(Window *w)

   287

{

   288

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

   289

}

   290

   291

static void BuildRailClick_NW(Window *w)

   292

{

   293

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

   294

}

   295

   296

static void BuildRailClick_AutoRail(Window *w)

   297

{

   298

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

   299

}

   300

   301

static void BuildRailClick_Demolish(Window *w)

   302

{

   303

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

   304

}

   305

   306

static void BuildRailClick_Depot(Window *w)

   307

{

   308

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

   309

		ShowBuildTrainDepotPicker();

   310

	}

   311

}

   312

   313

static void BuildRailClick_Waypoint(Window *w)

   314

{

   315

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   316

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

   317

			_waypoint_count > 1) {

   318

		ShowBuildWaypointPicker();

   319

	}

   320

}

   321

   322

static void BuildRailClick_Station(Window *w)

   323

{

   324

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

   325

}

   326

   327

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

   328

static void BuildRailClick_AutoSignals(Window *w)

   329

{

   330

	if (_patches.enable_signal_gui) {

   331

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

   332

	} else {

   333

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

   334

	}

   335

}

   336

   337

static void BuildRailClick_Bridge(Window *w)

   338

{

   339

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

   340

}

   341

   342

static void BuildRailClick_Tunnel(Window *w)

   343

{

   344

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

   345

}

   346

   347

static void BuildRailClick_Remove(Window *w)

   348

{

   349

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

   350

	SetWindowDirty(w);

   351

	SndPlayFx(SND_15_BEEP);

   352

   353

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   354

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   355

	SetSelectionRed(_remove_button_clicked);

   356

   357

	// handle station builder

   358

	if (_remove_button_clicked) {

   359

		SetTileSelectSize(1, 1);

   360

	}

   361

}

   362

   363

static void BuildRailClick_Convert(Window *w)

   364

{

   365

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

   366

}

   367

   368

   369

static void DoRailroadTrack(int mode)

   370

{

   371

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

   372

		(_remove_button_clicked || _ctrl_pressed) ?

   373

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   374

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   375

	);

   376

}

   377

   378

static void HandleAutodirPlacement()

   379

{

   380

	TileHighlightData *thd = &_thd;

   381

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

   382

   383

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

   384

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

   385

		return;

   386

	}

   387

   388

	DoRailroadTrack(trackstat);

   389

}

   390

   391

/**

   392

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

   393

 *

   394

 * If one tile marked abort and use GenericPlaceSignals()

   395

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

   396

 */

   397

static void HandleAutoSignalPlacement()

   398

{

   399

	TileHighlightData *thd = &_thd;

   400

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

   401

   402

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

   403

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

   404

		return;

   405

	}

   406

   407

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

   408

	SB(p2,  3, 1, 0);

   409

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

   410

	SB(p2,  6, 1, _ctrl_pressed);

   411

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

   412

   413

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

   414

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

   415

	DoCommandP(

   416

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

   417

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

   418

		p2,

   419

		CcPlaySound1E,

   420

		_remove_button_clicked ?

   421

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   422

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   423

	);

   424

}

   425

   426

   427

typedef void OnButtonClick(Window *w);

   428

   429

static OnButtonClick * const _build_railroad_button_proc[] = {

   430

	BuildRailClick_N,

   431

	BuildRailClick_NE,

   432

	BuildRailClick_E,

   433

	BuildRailClick_NW,

   434

	BuildRailClick_AutoRail,

   435

	BuildRailClick_Demolish,

   436

	BuildRailClick_Depot,

   437

	BuildRailClick_Waypoint,

   438

	BuildRailClick_Station,

   439

	BuildRailClick_AutoSignals,

   440

	BuildRailClick_Bridge,

   441

	BuildRailClick_Tunnel,

   442

	BuildRailClick_Remove,

   443

	BuildRailClick_Convert

   444

};

   445

   446

static const uint16 _rail_keycodes[] = {

   447

	'1',

   448

	'2',

   449

	'3',

   450

	'4',

   451

	'5',

   452

	'6',

   453

	'7', // depot

   454

	'8', // waypoint

   455

	'9', // station

   456

	'S', // signals

   457

	'B', // bridge

   458

	'T', // tunnel

   459

	'R', // remove

   460

	'C', // convert rail

   461

};

   462

   463

   464

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   465

{

   466

	switch (clicked_widget) {

   467

		case RTW_REMOVE:

   468

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

   469

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

   470

			return;

   471

			break;

   472

		case RTW_BUILD_NS:

   473

		case RTW_BUILD_X:

   474

		case RTW_BUILD_EW:

   475

		case RTW_BUILD_Y:

   476

		case RTW_AUTORAIL:

   477

		case RTW_BUILD_WAYPOINT:

   478

		case RTW_BUILD_STATION:

   479

		case RTW_BUILD_SIGNALS:

   480

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

   481

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

   482

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

   483

			break;

   484

   485

		default:

   486

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

   487

			 * disable the removal button */

   488

			w->DisableWidget(RTW_REMOVE);

   489

			w->RaiseWidget(RTW_REMOVE);

   490

			break;

   491

	}