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

    12

#include "window_gui.h"

    13

#include "station_gui.h"

    14

#include "viewport.h"

    15

#include "sound.h"

    16

#include "command_func.h"

    17

#include "station.h"

    18

#include "waypoint.h"

    19

#include "debug.h"

    20

#include "variables.h"

    21

#include "newgrf_callbacks.h"

    22

#include "newgrf_station.h"

    23

#include "train.h"

    24

#include "strings_func.h"

    25

#include "functions.h"

    26

#include "window_func.h"

    27

#include "date_func.h"

    28

    29

#include "bridge_map.h"

    30

#include "rail_map.h"

    31

#include "road_map.h"

    32

#include "station_map.h"

    33

#include "tunnel_map.h"

    34

#include "tunnelbridge_map.h"

    35

    36

    37

static RailType _cur_railtype;

    38

static bool _remove_button_clicked;

    39

static DiagDirection _build_depot_direction;

    40

static byte _waypoint_count = 1;

    41

static byte _cur_waypoint_type;

    42

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

    43

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

    44

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

    45

    46

static struct {

    47

	byte orientation;

    48

	byte numtracks;

    49

	byte platlength;

    50

	bool dragdrop;

    51

    52

	bool newstations;

    53

	StationClassIDByte station_class;

    54

	byte station_type;

    55

	byte station_count;

    56

} _railstation;

    57

    58

    59

static void HandleStationPlacement(TileIndex start, TileIndex end);

    60

static void ShowBuildTrainDepotPicker();

    61

static void ShowBuildWaypointPicker();

    62

static void ShowStationBuilder();

    63

static void ShowSignalBuilder();

    64

    65

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

    66

{

    67

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    68

}

    69

    70

static void GenericPlaceRail(TileIndex tile, int cmd)

    71

{

    72

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    73

		(_remove_button_clicked || _ctrl_pressed) ?

    74

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    75

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    76

	);

    77

}

    78

    79

static void PlaceRail_N(TileIndex tile)

    80

{

    81

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

    82

	GenericPlaceRail(tile, cmd);

    83

}

    84

    85

static void PlaceRail_NE(TileIndex tile)

    86

{

    87

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    88

}

    89

    90

static void PlaceRail_E(TileIndex tile)

    91

{

    92

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

    93

	GenericPlaceRail(tile, cmd);

    94

}

    95

    96

static void PlaceRail_NW(TileIndex tile)

    97

{

    98

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

    99

}

   100

   101

static void PlaceRail_AutoRail(TileIndex tile)

   102

{

   103

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

   104

}

   105

   106

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   107

{

   108

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

   109

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

   110

   111

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

   112

}

   113

   114

static const uint16 _place_depot_extra[12] = {

   115

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

   116

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

   117

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

   118

};

   119

   120

   121

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

   122

{

   123

	if (success) {

   124

		DiagDirection dir = (DiagDirection)p2;

   125

   126

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   127

		ResetObjectToPlace();

   128

   129

		tile += TileOffsByDiagDir(dir);

   130

   131

		if (IsTileType(tile, MP_RAILWAY)) {

   132

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   133

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

   134

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

   135

		}

   136

	}

   137

}

   138

   139

static void PlaceRail_Depot(TileIndex tile)

   140

{

   141

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   142

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   143

}

   144

   145

static void PlaceRail_Waypoint(TileIndex tile)

   146

{

   147

	if (_remove_button_clicked || _ctrl_pressed) {

   148

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

   149

	} else {

   150

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

   151

	}

   152

}

   153

   154

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

   155

{

   156

	if (success) {

   157

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   158

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

   159

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

   160

	}

   161

}

   162

   163

static void PlaceRail_Station(TileIndex tile)

   164

{

   165

	if (_remove_button_clicked) {

   166

		VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_REMOVE_STATION);

   167

	} else if (_railstation.dragdrop) {

   168

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   169

		VpSetPlaceSizingLimit(_patches.station_spread);

   170

	} else {

   171

		DoCommandP(tile,

   172

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

   173

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

   174

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   175

	}

   176

}

   177

   178

/**

   179

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

   180

 *

   181

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

   182

 */

   183

static void GenericPlaceSignals(TileIndex tile)

   184

{

   185

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

   186

   187

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

   188

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

   189

	}

   190

   191

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

   192

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

   193

	}

   194

   195

	Track track = FindFirstTrack(trackbits);

   196

   197

	if (_remove_button_clicked) {

   198

		DoCommandP(tile, track, 0, CcPlaySound1E,

   199

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   200

	} else {

   201

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

   202

   203

		/* various bitstuffed elements for CmdBuildSingleSignal() */

   204

		uint32 p1 = track;

   205

		SB(p1, 3, 1, _ctrl_pressed);

   206

		SB(p1, 4, 1, _cur_signal_variant);

   207

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

   208

		SB(p1, 7, 1, _convert_signal_button);

   209

   210

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

   211

			CMD_MSG(_convert_signal_button ? STR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   212

	}

   213

}

   214

   215

static void PlaceRail_Bridge(TileIndex tile)

   216

{

   217

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   218

}

   219

   220

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

   221

{

   222

	if (success) {

   223

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   224

		ResetObjectToPlace();

   225

	} else {

   226

		SetRedErrorSquare(_build_tunnel_endtile);

   227

	}

   228

}

   229

   230

static void PlaceRail_Tunnel(TileIndex tile)

   231

{

   232

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   233

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   234

}

   235

   236

void PlaceProc_BuyLand(TileIndex tile)

   237

{

   238

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

   239

}

   240

   241

static void PlaceRail_ConvertRail(TileIndex tile)

   242

{

   243

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   244

}

   245

   246

static void PlaceRail_AutoSignals(TileIndex tile)

   247

{

   248

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   249

}

   250

   251

   252

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

   253

enum RailToolbarWidgets {

   254

	RTW_CLOSEBOX = 0,

   255

	RTW_CAPTION,

   256

	RTW_STICKY,

   257

	RTW_SPACER,

   258

	RTW_BUILD_NS,

   259

	RTW_BUILD_X,

   260

	RTW_BUILD_EW,

   261

	RTW_BUILD_Y,

   262

	RTW_AUTORAIL,

   263

	RTW_DEMOLISH,

   264

	RTW_BUILD_DEPOT,

   265

	RTW_BUILD_WAYPOINT,

   266

	RTW_BUILD_STATION,

   267

	RTW_BUILD_SIGNALS,

   268

	RTW_BUILD_BRIDGE,

   269

	RTW_BUILD_TUNNEL,

   270

	RTW_REMOVE,

   271

	RTW_CONVERT_RAIL,

   272

};

   273

   274

static void BuildRailClick_N(Window *w)

   275

{

   276

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

   277

}

   278

   279

static void BuildRailClick_NE(Window *w)

   280

{

   281

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

   282

}

   283

   284

static void BuildRailClick_E(Window *w)

   285

{

   286

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

   287

}

   288

   289

static void BuildRailClick_NW(Window *w)

   290

{

   291

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

   292

}

   293

   294

static void BuildRailClick_AutoRail(Window *w)

   295

{

   296

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

   297

}

   298

   299

static void BuildRailClick_Demolish(Window *w)

   300

{

   301

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

   302

}

   303

   304

static void BuildRailClick_Depot(Window *w)

   305

{

   306

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

   307

		ShowBuildTrainDepotPicker();

   308

	}

   309

}

   310

   311

static void BuildRailClick_Waypoint(Window *w)

   312

{

   313

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   314

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

   315

			_waypoint_count > 1) {

   316

		ShowBuildWaypointPicker();

   317

	}

   318

}

   319

   320

static void BuildRailClick_Station(Window *w)

   321

{

   322

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

   323

}

   324

   325

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

   326

static void BuildRailClick_AutoSignals(Window *w)

   327

{

   328

	if (_patches.enable_signal_gui) {

   329

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

   330

	} else {

   331

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

   332

	}

   333

}

   334

   335

static void BuildRailClick_Bridge(Window *w)

   336

{

   337

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

   338

}

   339

   340

static void BuildRailClick_Tunnel(Window *w)

   341

{

   342

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

   343

}

   344

   345

static void BuildRailClick_Remove(Window *w)

   346

{

   347

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

   348

	SetWindowDirty(w);

   349

	SndPlayFx(SND_15_BEEP);

   350

   351

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   352

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   353

	SetSelectionRed(_remove_button_clicked);

   354

   355

	// handle station builder

   356

	if (_remove_button_clicked) {

   357

		SetTileSelectSize(1, 1);

   358

	}

   359

}

   360

   361

static void BuildRailClick_Convert(Window *w)

   362

{

   363

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

   364

}

   365

   366

   367

static void DoRailroadTrack(int mode)

   368

{

   369

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

   370

		(_remove_button_clicked || _ctrl_pressed) ?

   371

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   372

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   373

	);

   374

}

   375

   376

static void HandleAutodirPlacement()

   377

{

   378

	TileHighlightData *thd = &_thd;

   379

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

   380

   381

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

   382

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

   383

		return;

   384

	}

   385

   386

	DoRailroadTrack(trackstat);

   387

}

   388

   389

/**

   390

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

   391

 *

   392

 * If one tile marked abort and use GenericPlaceSignals()

   393

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

   394

 */

   395

static void HandleAutoSignalPlacement()

   396

{

   397

	TileHighlightData *thd = &_thd;

   398

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

   399

   400

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

   401

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

   402

		return;

   403

	}

   404

   405

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

   406

	SB(p2,  3, 1, 0);

   407

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

   408

	SB(p2,  6, 1, _ctrl_pressed);

   409

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

   410

   411

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

   412

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

   413

	DoCommandP(

   414

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

   415

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

   416

		p2,

   417

		CcPlaySound1E,

   418

		_remove_button_clicked ?

   419

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   420

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   421

	);

   422

}

   423

   424

   425

typedef void OnButtonClick(Window *w);

   426

   427

static OnButtonClick * const _build_railroad_button_proc[] = {

   428

	BuildRailClick_N,

   429

	BuildRailClick_NE,

   430

	BuildRailClick_E,

   431

	BuildRailClick_NW,

   432

	BuildRailClick_AutoRail,

   433

	BuildRailClick_Demolish,

   434

	BuildRailClick_Depot,

   435

	BuildRailClick_Waypoint,

   436

	BuildRailClick_Station,

   437

	BuildRailClick_AutoSignals,

   438

	BuildRailClick_Bridge,

   439

	BuildRailClick_Tunnel,

   440

	BuildRailClick_Remove,

   441

	BuildRailClick_Convert

   442

};

   443

   444

static const uint16 _rail_keycodes[] = {

   445

	'1',

   446

	'2',

   447

	'3',

   448

	'4',

   449

	'5',

   450

	'6',

   451

	'7', // depot

   452

	'8', // waypoint

   453

	'9', // station

   454

	'S', // signals

   455

	'B', // bridge

   456

	'T', // tunnel

   457

	'R', // remove

   458

	'C', // convert rail

   459

};

   460

   461

   462

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   463

{

   464

	switch (clicked_widget) {

   465

		case RTW_REMOVE:

   466

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

   467

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

   468

			return;

   469

			break;

   470

		case RTW_BUILD_NS:

   471

		case RTW_BUILD_X:

   472

		case RTW_BUILD_EW:

   473

		case RTW_BUILD_Y:

   474

		case RTW_AUTORAIL:

   475

		case RTW_BUILD_WAYPOINT:

   476

		case RTW_BUILD_STATION:

   477

		case RTW_BUILD_SIGNALS:

   478

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

   479

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

   480

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

   481

			break;

   482

   483

		default:

   484

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

   485

			 * disable the removal button */

   486

			w->DisableWidget(RTW_REMOVE);

   487

			w->RaiseWidget(RTW_REMOVE);

   488

			break;

   489

	}

   490

}

   491