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

    10

#include "landscape.h"

    11

#include "date.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "window.h"

    15

#include "gui.h"

    16

#include "viewport.h"

    17

#include "gfx.h"

    18

#include "sound.h"

    19

#include "command.h"

    20

#include "vehicle.h"

    21

#include "station.h"

    22

#include "waypoint.h"

    23

#include "debug.h"

    24

#include "variables.h"

    25

#include "newgrf_callbacks.h"

    26

#include "newgrf_station.h"

    27

#include "train.h"

    28

    29

static RailType _cur_railtype;

    30

static bool _remove_button_clicked;

    31

static DiagDirection _build_depot_direction;

    32

static byte _waypoint_count = 1;

    33

static byte _cur_waypoint_type;

    34

    35

static struct {

    36

	byte orientation;

    37

	byte numtracks;

    38

	byte platlength;

    39

	bool dragdrop;

    40

    41

	bool newstations;

    42

	StationClassIDByte station_class;

    43

	byte station_type;

    44

	byte station_count;

    45

} _railstation;

    46

    47

    48

static void HandleStationPlacement(TileIndex start, TileIndex end);

    49

static void ShowBuildTrainDepotPicker();

    50

static void ShowBuildWaypointPicker();

    51

static void ShowStationBuilder();

    52

    53

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

    54

{

    55

	if (success) SndPlayTileFx(SND_20_SPLAT_2, tile);

    56

}

    57

    58

static void GenericPlaceRail(TileIndex tile, int cmd)

    59

{

    60

	DoCommandP(tile, _cur_railtype, cmd, CcPlaySound1E,

    61

		_remove_button_clicked ?

    62

		CMD_REMOVE_SINGLE_RAIL | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) | CMD_AUTO | CMD_NO_WATER :

    63

		CMD_BUILD_SINGLE_RAIL | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK) | CMD_AUTO | CMD_NO_WATER

    64

	);

    65

}

    66

    67

static void PlaceRail_N(TileIndex tile)

    68

{

    69

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

    70

	GenericPlaceRail(tile, cmd);

    71

}

    72

    73

static void PlaceRail_NE(TileIndex tile)

    74

{

    75

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_RAIL_NE);

    76

}

    77

    78

static void PlaceRail_E(TileIndex tile)

    79

{

    80

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

    81

	GenericPlaceRail(tile, cmd);

    82

}

    83

    84

static void PlaceRail_NW(TileIndex tile)

    85

{

    86

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_RAIL_NW);

    87

}

    88

    89

static void PlaceRail_AutoRail(TileIndex tile)

    90

{

    91

	VpStartPlaceSizing(tile, VPM_RAILDIRS, DDSP_PLACE_AUTORAIL);

    92

}

    93

    94

static void PlaceExtraDepotRail(TileIndex tile, uint16 extra)

    95

{

    96

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

    97

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

    98

    99

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

   100

}

   101

   102

static const uint16 _place_depot_extra[12] = {

   103

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

   104

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

   105

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

   106

};

   107

   108

   109

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

   110

{

   111

	if (success) {

   112

		DiagDirection dir = (DiagDirection)p2;

   113

   114

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   115

		ResetObjectToPlace();

   116

   117

		tile += TileOffsByDiagDir(dir);

   118

   119

		if (IsTileType(tile, MP_RAILWAY)) {

   120

			PlaceExtraDepotRail(tile, _place_depot_extra[dir]);

   121

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

   122

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

   123

		}

   124

	}

   125

}

   126

   127

static void PlaceRail_Depot(TileIndex tile)

   128

{

   129

	DoCommandP(tile, _cur_railtype, _build_depot_direction, CcRailDepot,

   130

		CMD_BUILD_TRAIN_DEPOT | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_100E_CAN_T_BUILD_TRAIN_DEPOT));

   131

}

   132

   133

static void PlaceRail_Waypoint(TileIndex tile)

   134

{

   135

	if (!_remove_button_clicked) {

   136

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

   137

	} else {

   138

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

   139

	}

   140

}

   141

   142

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

   143

{

   144

	if (success) {

   145

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   146

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

   147

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

   148

	}

   149

}

   150

   151

static void PlaceRail_Station(TileIndex tile)

   152

{

   153

	if (_remove_button_clicked) {

   154

		VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_REMOVE_STATION);

   155

	} else if (_railstation.dragdrop) {

   156

		VpStartPlaceSizing(tile, VPM_X_AND_Y_LIMITED, DDSP_BUILD_STATION);

   157

		VpSetPlaceSizingLimit(_patches.station_spread);

   158

	} else {

   159

		DoCommandP(tile,

   160

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

   161

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

   162

				CMD_BUILD_RAILROAD_STATION | CMD_NO_WATER | CMD_AUTO | CMD_MSG(STR_100F_CAN_T_BUILD_RAILROAD_STATION));

   163

	}

   164

}

   165

   166

static void GenericPlaceSignals(TileIndex tile)

   167

{

   168

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

   169

   170

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

   171

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

   172

	}

   173

   174

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

   175

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

   176

	}

   177

   179

   180

	if (!_remove_button_clicked) {

   181

		uint32 p1 = track;

   182

		SB(p1, 3, 1, _ctrl_pressed);

   183

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

   184

   185

		DoCommandP(tile, p1, 0, CcPlaySound1E,

   186

			CMD_BUILD_SIGNALS | CMD_AUTO | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE));

   187

	} else {

   188

		DoCommandP(tile, track, 0, CcPlaySound1E,

   189

			CMD_REMOVE_SIGNALS | CMD_AUTO | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM));

   190

	}

   191

}

   192

   193

static void PlaceRail_Bridge(TileIndex tile)

   194

{

   195

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   196

}

   197

   198

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

   199

{

   200

	if (success) {

   201

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   202

		ResetObjectToPlace();

   203

	} else {

   204

		SetRedErrorSquare(_build_tunnel_endtile);

   205

	}

   206

}

   207

   208

static void PlaceRail_Tunnel(TileIndex tile)

   209

{

   210

	DoCommandP(tile, _cur_railtype, 0, CcBuildRailTunnel,

   211

		CMD_BUILD_TUNNEL | CMD_AUTO | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   212

}

   213

   214

void PlaceProc_BuyLand(TileIndex tile)

   215

{

   216

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

   217

}

   218

   219

static void PlaceRail_ConvertRail(TileIndex tile)

   220

{

   221

	VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CONVERT_RAIL);

   222

}

   223

   224

static void PlaceRail_AutoSignals(TileIndex tile)

   225

{

   226

	VpStartPlaceSizing(tile, VPM_SIGNALDIRS, DDSP_BUILD_SIGNALS);

   227

}

   228

   229

   230

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

   231

enum {

   232

	RTW_CAPTION        =  1,

   233

	RTW_BUILD_NS       =  4,

   234

	RTW_BUILD_X        =  5,

   235

	RTW_BUILD_EW       =  6,

   236

	RTW_BUILD_Y        =  7,

   237

	RTW_AUTORAIL       =  8,

   238

	RTW_DEMOLISH       =  9,

   239

	RTW_BUILD_DEPOT    = 10,

   240

	RTW_BUILD_WAYPOINT = 11,

   241

	RTW_BUILD_STATION  = 12,

   242

	RTW_BUILD_SIGNALS  = 13,

   243

	RTW_BUILD_BRIDGE   = 14,

   244

	RTW_BUILD_TUNNEL   = 15,

   245

	RTW_REMOVE         = 16,

   246

	RTW_CONVERT_RAIL   = 17

   247

};

   248

   249

   250

static void BuildRailClick_N(Window *w)

   251

{

   252

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

   253

}

   254

   255

static void BuildRailClick_NE(Window *w)

   256

{

   257

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

   258

}

   259

   260

static void BuildRailClick_E(Window *w)

   261

{

   262

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

   263

}

   264

   265

static void BuildRailClick_NW(Window *w)

   266

{

   267

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

   268

}

   269

   270

static void BuildRailClick_AutoRail(Window *w)

   271

{

   272

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

   273

}

   274

   275

static void BuildRailClick_Demolish(Window *w)

   276

{

   277

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

   278

}

   279

   280

static void BuildRailClick_Depot(Window *w)

   281

{

   282

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

   283

		ShowBuildTrainDepotPicker();

   284

	}

   285

}

   286

   287

static void BuildRailClick_Waypoint(Window *w)

   288

{

   289

	_waypoint_count = GetNumCustomStations(STAT_CLASS_WAYP);

   290

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

   291

			_waypoint_count > 1) {

   292

		ShowBuildWaypointPicker();

   293

	}

   294

}

   295

   296

static void BuildRailClick_Station(Window *w)

   297

{

   298

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

   299

}

   300

   301

static void BuildRailClick_AutoSignals(Window *w)

   302

{

   303

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

   304

}

   305

   306

static void BuildRailClick_Bridge(Window *w)

   307

{

   308

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

   309

}

   310

   311

static void BuildRailClick_Tunnel(Window *w)

   312

{

   313

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

   314

}

   315

   316

static void BuildRailClick_Remove(Window *w)

   317

{

   318

	if (IsWindowWidgetDisabled(w, RTW_REMOVE)) return;

   319

	SetWindowDirty(w);

   320

	SndPlayFx(SND_15_BEEP);

   321

   322

	ToggleWidgetLoweredState(w, RTW_REMOVE);

   323

	_remove_button_clicked = IsWindowWidgetLowered(w, RTW_REMOVE);

   324

	SetSelectionRed(_remove_button_clicked);

   325

   326

	// handle station builder

   327

	if (_remove_button_clicked) {

   328

		SetTileSelectSize(1, 1);

   329

	}

   330

}

   331

   332

static void BuildRailClick_Convert(Window *w)

   333

{

   334

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

   335

}

   336

   337

   338

static void DoRailroadTrack(int mode)

   339

{

   340

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

   341

		_remove_button_clicked ?

   342

		CMD_REMOVE_RAILROAD_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1012_CAN_T_REMOVE_RAILROAD_TRACK) :

   343

		CMD_BUILD_RAILROAD_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1011_CAN_T_BUILD_RAILROAD_TRACK)

   344

	);

   345

}

   346

   347

static void HandleAutodirPlacement()

   348

{

   349

	TileHighlightData *thd = &_thd;

   350

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

   351

   352

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

   353

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

   354

		return;

   355

	}

   356

   357

	DoRailroadTrack(trackstat);

   358

}

   359

   360

static void HandleAutoSignalPlacement()

   361

{

   362

	TileHighlightData *thd = &_thd;

   363

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

   364

   365

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

   366

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

   367

		return;

   368

	}

   369

   370

	SB(p2,  3, 1, _ctrl_pressed);

   371

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

   372

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

   373

   374

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

   375

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

   376

	DoCommandP(

   377

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

   378

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

   379

		p2,

   380

		CcPlaySound1E,

   381

		_remove_button_clicked ?

   382

			CMD_REMOVE_SIGNAL_TRACK | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1013_CAN_T_REMOVE_SIGNALS_FROM) :

   383

			CMD_BUILD_SIGNAL_TRACK  | CMD_AUTO | CMD_NO_WATER | CMD_MSG(STR_1010_CAN_T_BUILD_SIGNALS_HERE)

   384

	);

   385

}

   386

   387

   388

typedef void OnButtonClick(Window *w);

   389

   390

static OnButtonClick * const _build_railroad_button_proc[] = {

   391

	BuildRailClick_N,

   392

	BuildRailClick_NE,

   393

	BuildRailClick_E,

   394

	BuildRailClick_NW,

   395

	BuildRailClick_AutoRail,

   396

	BuildRailClick_Demolish,

   397

	BuildRailClick_Depot,

   398

	BuildRailClick_Waypoint,

   399

	BuildRailClick_Station,

   400

	BuildRailClick_AutoSignals,

   401

	BuildRailClick_Bridge,

   402

	BuildRailClick_Tunnel,

   403

	BuildRailClick_Remove,

   404

	BuildRailClick_Convert

   405

};

   406

   407

static const uint16 _rail_keycodes[] = {

   408

	'1',

   409

	'2',

   410

	'3',

   411

	'4',

   412

	'5',

   413

	'6',

   414

	'7', // depot

   415

	'8', // waypoint

   416

	'9', // station

   417

	'S', // signals

   418

	'B', // bridge

   419

	'T', // tunnel

   420

	'R', // remove

   421

	'C', // convert rail

   422

};

   423

   424

   425

static void UpdateRemoveWidgetStatus(Window *w, int clicked_widget)

   426

{

   427

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

   428

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

   429

	if (clicked_widget == RTW_REMOVE) return;

   430

   431

	switch (clicked_widget) {

   432

		case RTW_BUILD_NS:

   433

		case RTW_BUILD_X:

   434

		case RTW_BUILD_EW:

   435

		case RTW_BUILD_Y:

   436

		case RTW_AUTORAIL:

   437

		case RTW_BUILD_WAYPOINT:

   438

		case RTW_BUILD_STATION:

   439

		case RTW_BUILD_SIGNALS:

   440

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

   441

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

   442

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

   443

			break;

   444

   445

		default:

   446

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

   447

			 * disable the removal button*/

   448

			DisableWindowWidget(w, RTW_REMOVE);

   449

			RaiseWindowWidget(w, RTW_REMOVE);

   450

			break;

   451

	}

   452

}

   453

   454

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

   455

{

   456

	switch (e->event) {

   457

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

   458

   459

	case WE_PAINT: DrawWindowWidgets(w); break;

   460

   461

	case WE_CLICK:

   462

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

   463

			_remove_button_clicked = false;

   464

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

   465

		}

   466

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

   467

		break;

   468

   469

	case WE_KEYPRESS: {

   470

		uint i;

   471

   472

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

   473

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

   474

				e->we.keypress.cont = false;

   475

				_remove_button_clicked = false;

   476

				_build_railroad_button_proc[i](w);

   477

				UpdateRemoveWidgetStatus(w, i + 4);

   478

				break;

   479

			}

   480

		}

   481

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

   482

		break;

   483

	}

   484

   485

	case WE_PLACE_OBJ:

   486

		_place_proc(e->we.place.tile);

   487

		return;

   488

   489

	case WE_PLACE_DRAG: {

   490

		VpSelectTilesWithMethod(e->we.place.pt.x, e->we.place.pt.y, e->we.place.select_method);

   491

		return;

   492

	}

   493