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_AUTO | CMD_NO_WATER :

    70

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_AUTO | 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_AUTO | 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_AUTO | 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_AUTO | 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_AUTO | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   194

	} else {

   195

		DoCommandP(tile, track, 0, CcPlaySound1E,

   196

			CMD_REMOVE_SIGNALS | CMD_AUTO | 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_AUTO | 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_AUTO | 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 {

   239

	RTW_CAPTION        =  1,

   240

	RTW_BUILD_NS       =  4,

   241

	RTW_BUILD_X        =  5,

   242

	RTW_BUILD_EW       =  6,

   243

	RTW_BUILD_Y        =  7,

   244

	RTW_AUTORAIL       =  8,

   245

	RTW_DEMOLISH       =  9,

   246

	RTW_BUILD_DEPOT    = 10,

   247

	RTW_BUILD_WAYPOINT = 11,

   248

	RTW_BUILD_STATION  = 12,

   249

	RTW_BUILD_SIGNALS  = 13,

   250

	RTW_BUILD_BRIDGE   = 14,

   251

	RTW_BUILD_TUNNEL   = 15,

   252

	RTW_REMOVE         = 16,

   253

	RTW_CONVERT_RAIL   = 17

   254

};

   255

   256

   257

static void BuildRailClick_N(Window *w)

   258

{

   259

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

   260

}

   261

   262

static void BuildRailClick_NE(Window *w)

   263

{

   264

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

   265

}

   266

   267

static void BuildRailClick_E(Window *w)

   268

{

   269

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

   270

}

   271

   272

static void BuildRailClick_NW(Window *w)

   273

{

   274

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

   275

}

   276

   277

static void BuildRailClick_AutoRail(Window *w)

   278

{

   279

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

   280

}

   281

   282

static void BuildRailClick_Demolish(Window *w)

   283

{

   284

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

   285

}

   286

   287

static void BuildRailClick_Depot(Window *w)

   288

{

   289

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

   290

		ShowBuildTrainDepotPicker();

   291

	}

   292

}

   293

   294

static void BuildRailClick_Waypoint(Window *w)

   295

{

   296

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   297

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

   298

			_waypoint_count > 1) {

   299

		ShowBuildWaypointPicker();

   300

	}

   301

}

   302

   303

static void BuildRailClick_Station(Window *w)

   304

{

   305

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

   306

}

   307

   308

static void BuildRailClick_AutoSignals(Window *w)

   309

{

   310

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

   311

}

   312

   313

static void BuildRailClick_Bridge(Window *w)

   314

{

   315

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

   316

}

   317

   318

static void BuildRailClick_Tunnel(Window *w)

   319

{

   320

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

   321

}

   322

   323

static void BuildRailClick_Remove(Window *w)

   324

{

   325

	if (IsWindowWidgetDisabled(w, RTW_REMOVE)) return;

   326

	SetWindowDirty(w);

   327

	SndPlayFx(SND_15_BEEP);

   328

   329

	ToggleWidgetLoweredState(w, RTW_REMOVE);

   330

	_remove_button_clicked = IsWindowWidgetLowered(w, RTW_REMOVE);

   331

	SetSelectionRed(_remove_button_clicked);

   332

   333

	// handle station builder

   334

	if (_remove_button_clicked) {

   335

		SetTileSelectSize(1, 1);

   336

	}

   337

}

   338

   339

static void BuildRailClick_Convert(Window *w)

   340

{

   341

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

   342

}

   343

   344

   345

static void DoRailroadTrack(int mode)

   346

{

   347

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

   348

		_remove_button_clicked ?

   349

		CMD_REMOVE_RAILROAD_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   350

		CMD_BUILD_RAILROAD_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   351

	);

   352

}

   353

   354

static void HandleAutodirPlacement()

   355

{

   356

	TileHighlightData *thd = &_thd;

   357

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

   358

   359

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

   360

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

   361

		return;

   362

	}

   363

   364

	DoRailroadTrack(trackstat);

   365

}

   366

   367

static void HandleAutoSignalPlacement()

   368

{

   369

	TileHighlightData *thd = &_thd;

   370

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

   371

   372

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

   373

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

   374

		return;

   375

	}

   376

   377

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

   378

	SB(p2,  3, 1, 0);

   379

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

   380

	SB(p2,  6, 1, _ctrl_pressed);

   381

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

   382

   383

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

   384

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

   385

	DoCommandP(

   386

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

   387

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

   388

		p2,

   389

		CcPlaySound1E,

   390

		_remove_button_clicked ?

   391

			CMD_REMOVE_SIGNAL_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   392

			CMD_BUILD_SIGNAL_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   393

	);

   394

}

   395

   396

   397

typedef void OnButtonClick(Window *w);

   398

   399

static OnButtonClick * const _build_railroad_button_proc[] = {

   400

	BuildRailClick_N,

   401

	BuildRailClick_NE,

   402

	BuildRailClick_E,

   403

	BuildRailClick_NW,

   404

	BuildRailClick_AutoRail,

   405

	BuildRailClick_Demolish,

   406

	BuildRailClick_Depot,

   407

	BuildRailClick_Waypoint,

   408

	BuildRailClick_Station,

   409

	BuildRailClick_AutoSignals,

   410

	BuildRailClick_Bridge,

   411

	BuildRailClick_Tunnel,

   412

	BuildRailClick_Remove,

   413

	BuildRailClick_Convert

   414

};

   415

   416

static const uint16 _rail_keycodes[] = {

   417

	'1',

   418

	'2',

   419

	'3',

   420

	'4',

   421

	'5',

   422

	'6',

   423

	'7', // depot

   424

	'8', // waypoint

   425

	'9', // station

   426

	'S', // signals

   427

	'B', // bridge

   428

	'T', // tunnel

   429

	'R', // remove

   430

	'C', // convert rail

   431

};

   432

   433

   434

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   435

{

   436

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

   437

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

   438

	if (clicked_widget == RTW_REMOVE) return;

   439

   440

	switch (clicked_widget) {

   441

		case RTW_BUILD_NS:

   442

		case RTW_BUILD_X:

   443

		case RTW_BUILD_EW:

   444

		case RTW_BUILD_Y:

   445

		case RTW_AUTORAIL:

   446

		case RTW_BUILD_WAYPOINT:

   447

		case RTW_BUILD_STATION:

   448

		case RTW_BUILD_SIGNALS:

   449

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

   450

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

   451

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

   452

			break;

   453

   454

		default:

   455

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

   456

			 * disable the removal button*/

   457

			DisableWindowWidget(w, RTW_REMOVE);

   458

			RaiseWindowWidget(w, RTW_REMOVE);

   459

			break;

   460

	}

   461

}

   462

   463

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

   464

{

   465

	switch (e->event) {

   466

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

   467

   468

	case WE_PAINT: DrawWindowWidgets(w); break;

   469

   470

	case WE_CLICK:

   471

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

   472

			_remove_button_clicked = false;

   473

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

   474

		}

   475

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

   476

		break;

   477

   478

	case WE_KEYPRESS: {

   479

		uint i;

   480

   481

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

   482

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

   483

				e->we.keypress.cont = false;

   484

				_remove_button_clicked = false;

   485

				_build_railroad_button_proc[i](w);

   486

				UpdateRemoveWidgetStatus(w, i + 4);

   487

				break;

   488

			}

   489

		}

   490

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

   491

		break;

   492

	}