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

    42

static struct {

    43

	byte orientation;

    44

	byte numtracks;

    45

	byte platlength;

    46

	bool dragdrop;

    47

    48

	bool newstations;

    49

	StationClassIDByte station_class;

    50

	byte station_type;

    51

	byte station_count;

    52

} _railstation;

    53

    54

    55

static void HandleStationPlacement(TileIndex start, TileIndex end);

    56

static void ShowBuildTrainDepotPicker();

    57

static void ShowBuildWaypointPicker();

    58

static void ShowStationBuilder();

    59

    60

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

    61

{

    62

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    63

}

    64

    65

static void GenericPlaceRail(TileIndex tile, int cmd)

    66

{

    67

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    68

		_remove_button_clicked ?

    69

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_NO_WATER :

    70

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_NO_WATER

    71

	);

    72

}

    73

    74

static void PlaceRail_N(TileIndex tile)

    75

{

    76

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

    77

	GenericPlaceRail(tile, cmd);

    78

}

    79

    80

static void PlaceRail_NE(TileIndex tile)

    81

{

    82

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    83

}

    84

    85

static void PlaceRail_E(TileIndex tile)

    86

{

    87

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

    88

	GenericPlaceRail(tile, cmd);

    89

}

    90

    91

static void PlaceRail_NW(TileIndex tile)

    92

{

    93

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

    94

}

    95

    96

static void PlaceRail_AutoRail(TileIndex tile)

    97

{

    98

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

    99

}

   100

   101

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

   102

{

   103

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

   104

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

   105

   106

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

   107

}

   108

   109

static const uint16 _place_depot_extra[12] = {

   110

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

   111

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

   112

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

   113

};

   114

   115

   116

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

   117

{

   118

	if (success) {

   119

		DiagDirection dir = (DiagDirection)p2;

   120

   121

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   122

		ResetObjectToPlace();

   123

   124

		tile += TileOffsByDiagDir(dir);

   125

   126

		if (IsTileType(tile, MP_RAILWAY)) {

   127

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   128

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

   129

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

   130

		}

   131

	}

   132

}

   133

   134

static void PlaceRail_Depot(TileIndex tile)

   135

{

   136

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   137

		CMD_BUILD_TRAIN_DEPOT | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   138

}

   139

   140

static void PlaceRail_Waypoint(TileIndex tile)

   141

{

   142

	if (!_remove_button_clicked) {

   143

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

   144

	} else {

   145

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

   146

	}

   147

}

   148

   149

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

   150

{

   151

	if (success) {

   152

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   153

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

   154

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

   155

	}

   156

}

   157

   158

static void PlaceRail_Station(TileIndex tile)

   159

{

   160

	if (_remove_button_clicked) {

   161

		VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_REMOVE_STATION);

   162

	} else if (_railstation.dragdrop) {

   163

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   164

		VpSetPlaceSizingLimit(_patches.station_spread);

   165

	} else {

   166

		DoCommandP(tile,

   167

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

   168

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

   169

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   170

	}

   171

}

   172

   173

static void GenericPlaceSignals(TileIndex tile)

   174

{

   175

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

   176

   177

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

   178

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

   179

	}

   180

   181

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

   182

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

   183

	}

   184

   185

	Track track = FindFirstTrack(trackbits);

   186

   187

	if (!_remove_button_clicked) {

   188

		uint32 p1 = track;

   189

		SB(p1, 3, 1, _ctrl_pressed);

   190

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

   191

   192

		DoCommandP(tile, p1, 0, CcPlaySound1E,

   193

			CMD_BUILD_SIGNALS | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   194

	} else {

   195

		DoCommandP(tile, track, 0, CcPlaySound1E,

   196

			CMD_REMOVE_SIGNALS | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   197

	}

   198

}

   199

   200

static void PlaceRail_Bridge(TileIndex tile)

   201

{

   202

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   203

}

   204

   205

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

   206

{

   207

	if (success) {

   208

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   209

		ResetObjectToPlace();

   210

	} else {

   211

		SetRedErrorSquare(_build_tunnel_endtile);

   212

	}

   213

}

   214

   215

static void PlaceRail_Tunnel(TileIndex tile)

   216

{

   217

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   218

		CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   219

}

   220

   221

void PlaceProc_BuyLand(TileIndex tile)

   222

{

   223

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

   224

}

   225

   226

static void PlaceRail_ConvertRail(TileIndex tile)

   227

{

   228

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   229

}

   230

   231

static void PlaceRail_AutoSignals(TileIndex tile)

   232

{

   233

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   234

}

   235

   236

   237

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

   238

enum RailToolbarWidgets {

   239

	RTW_CLOSEBOX = 0,

   240

	RTW_CAPTION,

   241

	RTW_STICKY,

   242

	RTW_SPACER,

   243

	RTW_BUILD_NS,

   244

	RTW_BUILD_X,

   245

	RTW_BUILD_EW,

   246

	RTW_BUILD_Y,

   247

	RTW_AUTORAIL,

   248

	RTW_DEMOLISH,

   249

	RTW_BUILD_DEPOT,

   250

	RTW_BUILD_WAYPOINT,

   251

	RTW_BUILD_STATION,

   252

	RTW_BUILD_SIGNALS,

   253

	RTW_BUILD_BRIDGE,

   254

	RTW_BUILD_TUNNEL,

   255

	RTW_REMOVE,

   256

	RTW_CONVERT_RAIL,

   257

};

   258

   259

static void BuildRailClick_N(Window *w)

   260

{

   261

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

   262

}

   263

   264

static void BuildRailClick_NE(Window *w)

   265

{

   266

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

   267

}

   268

   269

static void BuildRailClick_E(Window *w)

   270

{

   271

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

   272

}

   273

   274

static void BuildRailClick_NW(Window *w)

   275

{

   276

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

   277

}

   278

   279

static void BuildRailClick_AutoRail(Window *w)

   280

{

   281

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

   282

}

   283

   284

static void BuildRailClick_Demolish(Window *w)

   285

{

   286

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

   287

}

   288

   289

static void BuildRailClick_Depot(Window *w)

   290

{

   291

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

   292

		ShowBuildTrainDepotPicker();

   293

	}

   294

}

   295

   296

static void BuildRailClick_Waypoint(Window *w)

   297

{

   298

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   299

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

   300

			_waypoint_count > 1) {

   301

		ShowBuildWaypointPicker();

   302

	}

   303

}

   304

   305

static void BuildRailClick_Station(Window *w)

   306

{

   307

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

   308

}

   309

   310

static void BuildRailClick_AutoSignals(Window *w)

   311

{

   312

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

   313

}

   314

   315

static void BuildRailClick_Bridge(Window *w)

   316

{

   317

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

   318

}

   319

   320

static void BuildRailClick_Tunnel(Window *w)

   321

{

   322

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

   323

}

   324

   325

static void BuildRailClick_Remove(Window *w)

   326

{

   327

	if (IsWindowWidgetDisabled(w, RTW_REMOVE)) return;

   328

	SetWindowDirty(w);

   329

	SndPlayFx(SND_15_BEEP);

   330

   331

	ToggleWidgetLoweredState(w, RTW_REMOVE);

   332

	_remove_button_clicked = IsWindowWidgetLowered(w, RTW_REMOVE);

   333

	SetSelectionRed(_remove_button_clicked);

   334

   335

	// handle station builder

   336

	if (_remove_button_clicked) {

   337

		SetTileSelectSize(1, 1);

   338

	}

   339

}

   340

   341

static void BuildRailClick_Convert(Window *w)

   342

{

   343

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

   344

}

   345

   346

   347

static void DoRailroadTrack(int mode)

   348

{

   349

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

   350

		_remove_button_clicked ?

   351

		CMD_REMOVE_RAILROAD_TRACK | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   352

		CMD_BUILD_RAILROAD_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   353

	);

   354

}

   355

   356

static void HandleAutodirPlacement()

   357

{

   358

	TileHighlightData *thd = &_thd;

   359

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

   360

   361

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

   362

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

   363

		return;

   364

	}

   365

   366

	DoRailroadTrack(trackstat);

   367

}

   368

   369

static void HandleAutoSignalPlacement()

   370

{

   371

	TileHighlightData *thd = &_thd;

   372

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

   373

   374

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

   375

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

   376

		return;

   377

	}

   378

   379

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

   380

	SB(p2,  3, 1, 0);

   381

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

   382

	SB(p2,  6, 1, _ctrl_pressed);

   383

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

   384

   385

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

   386

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

   387

	DoCommandP(

   388

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

   389

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

   390

		p2,

   391

		CcPlaySound1E,

   392

		_remove_button_clicked ?

   393

			CMD_REMOVE_SIGNAL_TRACK | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   394

			CMD_BUILD_SIGNAL_TRACK  | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   395

	);

   396

}

   397

   398

   399

typedef void OnButtonClick(Window *w);

   400

   401

static OnButtonClick * const _build_railroad_button_proc[] = {

   402

	BuildRailClick_N,

   403

	BuildRailClick_NE,

   404

	BuildRailClick_E,

   405

	BuildRailClick_NW,

   406

	BuildRailClick_AutoRail,

   407

	BuildRailClick_Demolish,

   408

	BuildRailClick_Depot,

   409

	BuildRailClick_Waypoint,

   410

	BuildRailClick_Station,

   411

	BuildRailClick_AutoSignals,

   412

	BuildRailClick_Bridge,

   413

	BuildRailClick_Tunnel,

   414

	BuildRailClick_Remove,

   415

	BuildRailClick_Convert

   416

};

   417

   418

static const uint16 _rail_keycodes[] = {

   419

	'1',

   420

	'2',

   421

	'3',

   422

	'4',

   423

	'5',

   424

	'6',

   425

	'7', // depot

   426

	'8', // waypoint

   427

	'9', // station

   428

	'S', // signals

   429

	'B', // bridge

   430

	'T', // tunnel

   431

	'R', // remove

   432

	'C', // convert rail

   433

};

   434

   435

   436

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   437

{

   438

	switch (clicked_widget) {

   439

		case RTW_REMOVE:

   440

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

   441

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

   442

			return;

   443

			break;

   444

		case RTW_BUILD_NS:

   445

		case RTW_BUILD_X:

   446

		case RTW_BUILD_EW:

   447

		case RTW_BUILD_Y:

   448

		case RTW_AUTORAIL:

   449

		case RTW_BUILD_WAYPOINT:

   450

		case RTW_BUILD_STATION:

   451

		case RTW_BUILD_SIGNALS:

   452

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

   453

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

   454

			SetWindowWidgetDisabledState(w, RTW_REMOVE, !IsWindowWidgetLowered(w, clicked_widget));

   455

			break;

   456

   457

		default:

   458

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

   459

			 * disable the removal button */

   460

			DisableWindowWidget(w, RTW_REMOVE);

   461

			RaiseWindowWidget(w, RTW_REMOVE);

   462

			break;

   463

	}

   464

}

   465

   466

static void BuildRailToolbWndProc(Window *w, WindowEvent *e)

   467

{

   468

	switch (e->event) {

   469

	case WE_CREATE: DisableWindowWidget(w, RTW_REMOVE); break;

   470

   471

	case WE_PAINT: DrawWindowWidgets(w); break;

   472

   473

	case WE_CLICK:

   474

		if (e->we.click.widget >= RTW_BUILD_NS) {

   475

			_remove_button_clicked = false;

   476

			_build_railroad_button_proc[e->we.click.widget - RTW_BUILD_NS](w);

   477

		}

   478

		UpdateRemoveWidgetStatus(w, e->we.click.widget);

   479

		break;

   480

   481

	case WE_KEYPRESS:

   482

		for (uint8 i = 0; i != lengthof(_rail_keycodes); i++) {

   483

			if (e->we.keypress.keycode == _rail_keycodes[i]) {

   484

				e->we.keypress.cont = false;

   485

				_remove_button_clicked = false;

   486

				_build_railroad_button_proc[i](w);

   487

				UpdateRemoveWidgetStatus(w, i + RTW_BUILD_NS);

   488

				break;

   489

			}

   490

		}

   491

		MarkTileDirty(_thd.pos.x, _thd.pos.y); // redraw tile selection