1

/* $Id$ */

     2

     3

/** @file toolbar_gui.cpp Code related to the (main) toolbar. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gui.h"

     8

#include "window_gui.h"

     9

#include "window_func.h"

    10

#include "viewport_func.h"

    11

#include "command_func.h"

    12

#include "variables.h"

    13

#include "train.h"

    14

#include "roadveh.h"

    15

#include "vehicle_gui.h"

    16

#include "rail_gui.h"

    17

#include "road_gui.h"

    18

#include "date_func.h"

    19

#include "vehicle_func.h"

    20

#include "sound_func.h"

    21

#include "terraform_gui.h"

    22

#include "transparency.h"

    23

#include "strings_func.h"

    24

#include "player_base.h"

    25

#include "player_func.h"

    26

#include "player_gui.h"

    27

#include "settings_type.h"

    28

#include "toolbar_gui.h"

    29

#include "vehicle_base.h"

    30

#include "gfx_func.h"

    31

#include "cheat_func.h"

    32

#include "transparency_gui.h"

    33

#include "screenshot.h"

    34

#include "newgrf_config.h"

    35

#include "signs_func.h"

    36

#include "fios.h"

    37

#include "functions.h"

    38

#include "console_gui.h"

    39

#include "news_gui.h"

    40

#include "ai/ai_gui.hpp"

    41

#include "tilehighlight_func.h"

    42

    43

#include "network/network.h"

    44

#include "network/network_gui.h"

    45

    46

#include "table/strings.h"

    47

#include "table/sprites.h"

    48

    49

static void PopupMainToolbMenu(Window *parent, uint16 parent_button, StringID base_string, byte item_count, byte disabled_mask = 0, int sel_index = 0, int checked_items = 0);

    50

static void PopupMainPlayerToolbMenu(Window *parent, int main_button, int gray);

    51

static void SplitToolbar(Window *w);

    52

    53

RailType _last_built_railtype;

    54

RoadType _last_built_roadtype;

    55

    56

enum ToolbarMode {

    57

	TB_NORMAL,

    58

	TB_UPPER,

    59

	TB_LOWER

    60

};

    61

    62

static ToolbarMode _toolbar_mode;

    63

    64

static void SelectSignTool()

    65

{

    66

	if (_cursor.sprite == SPR_CURSOR_SIGN) {

    67

		ResetObjectToPlace();

    68

	} else {

    69

		SetObjectToPlace(SPR_CURSOR_SIGN, PAL_NONE, VHM_RECT, WC_MAIN_TOOLBAR, 0);

    70

		_place_proc = PlaceProc_Sign;

    71

	}

    72

}

    73

    74

/** Returns the position where the toolbar wants the menu to appear.

    75

 * Make sure the dropdown is fully visible within the window.

    76

 * x + w->left because x is supposed to be the offset of the toolbar-button

    77

 * we clicked on and w->left the toolbar window itself. So meaning that

    78

 * the default position is aligned with the left side of the clicked button */

    79

static Point GetToolbarDropdownPos(uint16 parent_button, int width, int height)

    80

{

    81

	const Window *w = FindWindowById(WC_MAIN_TOOLBAR, 0);

    82

	Point pos;

    83

	pos.x = w->widget[GB(parent_button, 0, 8)].left;

    84

	pos.x = w->left + Clamp(pos.x, 0, w->width - width);

    85

	pos.y = w->height;

    86

    87

	return pos;

    88

}

    89

    90

/**

    91

 * Retrieve the menu item number from a position

    92

 * @param w Window holding the menu items

    93

 * @param x X coordinate of the position

    94

 * @param y Y coordinate of the position

    95

 * @return Index number of the menu item, or \c -1 if no valid selection under position

    96

 */

    97

static int GetMenuItemIndex(const Window *w, int item_count, int disabled_items)

    98

{

    99

	int x = _cursor.pos.x;

   100

	int y = _cursor.pos.y;

   101

   102

	if ((x -= w->left) >= 0 && x < w->width && (y -= w->top + 1) >= 0) {

   103

		y /= 10;

   104

   105

		if (y < item_count &&

   106

				!HasBit(disabled_items, y)) {

   107

			return y;

   108

		}

   109

	}

   110

	return -1;

   111

}

   112

   113

/* --- Pausing --- */

   114

   115

static void ToolbarPauseClick(Window *w)

   116

{

   117

	if (_networking && !_network_server) return; // only server can pause the game

   118

   119

	if (DoCommandP(0, _pause_game ? 0 : 1, 0, NULL, CMD_PAUSE)) SndPlayFx(SND_15_BEEP);

   120

}

   121

   122

/* --- Fast forwarding --- */

   123

   124

static void ToolbarFastForwardClick(Window *w)

   125

{

   126

	_fast_forward ^= true;

   127

	SndPlayFx(SND_15_BEEP);

   128

}

   129

   130

/* --- Options button menu --- */

   131

   132

static void ToolbarOptionsClick(Window *w)

   133

{

   134

	uint16 x = 0;

   135

	if (HasBit(_display_opt, DO_SHOW_TOWN_NAMES))    SetBit(x,  6);

   136

	if (HasBit(_display_opt, DO_SHOW_STATION_NAMES)) SetBit(x,  7);

   137

	if (HasBit(_display_opt, DO_SHOW_SIGNS))         SetBit(x,  8);

   138

	if (HasBit(_display_opt, DO_WAYPOINTS))          SetBit(x,  9);

   139

	if (HasBit(_display_opt, DO_FULL_ANIMATION))     SetBit(x, 10);

   140

	if (HasBit(_display_opt, DO_FULL_DETAIL))        SetBit(x, 11);

   141

	if (IsTransparencySet(TO_HOUSES))                SetBit(x, 12);

   142

	if (IsTransparencySet(TO_SIGNS))                 SetBit(x, 13);

   143

   144

	PopupMainToolbMenu(w, 2, STR_02C4_GAME_OPTIONS, 14, 0, 0, x);

   145

}

   146

   147

static void MenuClickSettings(int index)

   148

{

   149

	switch (index) {

   150

		case 0: ShowGameOptions();      return;

   151

		case 1: ShowGameDifficulty();   return;

   152

		case 2: ShowPatchesSelection(); return;

   153

		case 3: ShowNewGRFSettings(!_networking, true, true, &_grfconfig);   return;

   154

		case 4: ShowTransparencyToolbar(); break;

   155

   156

		case  6: ToggleBit(_display_opt, DO_SHOW_TOWN_NAMES);    break;

   157

		case  7: ToggleBit(_display_opt, DO_SHOW_STATION_NAMES); break;

   158

		case  8: ToggleBit(_display_opt, DO_SHOW_SIGNS);         break;

   159

		case  9: ToggleBit(_display_opt, DO_WAYPOINTS);          break;

   160

		case 10: ToggleBit(_display_opt, DO_FULL_ANIMATION);     break;

   161

		case 11: ToggleBit(_display_opt, DO_FULL_DETAIL);        break;

   162

		case 12: ToggleTransparency(TO_HOUSES);                  break;

   163

		case 13: ToggleTransparency(TO_SIGNS);                   break;

   164

	}

   165

	MarkWholeScreenDirty();

   166

}

   167

   168

/* --- Saving/loading button menu --- */

   169

   170

static void ToolbarSaveClick(Window *w)

   171

{

   172

	PopupMainToolbMenu(w, 3, STR_015C_SAVE_GAME, 4);

   173

}

   174

   175

static void ToolbarScenSaveOrLoad(Window *w)

   176

{

   177

	PopupMainToolbMenu(w, 3, STR_0292_SAVE_SCENARIO, 6);

   178

}

   179

   180

static void MenuClickSaveLoad(int index)

   181

{

   182

	if (_game_mode == GM_EDITOR) {

   183

		switch (index) {

   184

			case 0: ShowSaveLoadDialog(SLD_SAVE_SCENARIO);  break;

   185

			case 1: ShowSaveLoadDialog(SLD_LOAD_SCENARIO);  break;

   186

			case 2: ShowSaveLoadDialog(SLD_LOAD_HEIGHTMAP); break;

   187

			case 3: AskExitToGameMenu();                    break;

   188

			case 5: HandleExitGameRequest();                break;

   189

		}

   190

	} else {

   191

		switch (index) {

   192

			case 0: ShowSaveLoadDialog(SLD_SAVE_GAME); break;

   193

			case 1: ShowSaveLoadDialog(SLD_LOAD_GAME); break;

   194

			case 2: AskExitToGameMenu();               break;

   195

			case 3: HandleExitGameRequest();           break;

   196

		}

   197

	}

   198

}

   199

   200

/* --- Map button menu --- */

   201

   202

static void ToolbarMapClick(Window *w)

   203

{

   204

	PopupMainToolbMenu(w, 4, STR_02DE_MAP_OF_WORLD, 3);

   205

}

   206

   207

static void MenuClickMap(int index)

   208

{

   209

	switch (index) {

   210

		case 0: ShowSmallMap();            break;

   211

		case 1: ShowExtraViewPortWindow(); break;

   212

		case 2: ShowSignList();            break;

   213

	}

   214

}

   215

   216

static void MenuClickScenMap(int index)

   217

{

   218

	switch (index) {

   219

		case 0: ShowSmallMap();            break;

   220

		case 1: ShowExtraViewPortWindow(); break;

   221

		case 2: ShowSignList();            break;

   222

		case 3: ShowTownDirectory();       break;

   223

	}

   224

}

   225

   226

/* --- Town button menu --- */

   227

   228

static void ToolbarTownClick(Window *w)

   229

{

   230

	PopupMainToolbMenu(w, 5, STR_02BB_TOWN_DIRECTORY, 1);

   231

}

   232

   233

static void MenuClickTown(int index)

   234

{

   235

	ShowTownDirectory();

   236

}

   237

   238

/* --- Subidies button menu --- */

   239

   240

static void ToolbarSubsidiesClick(Window *w)

   241

{

   242

	PopupMainToolbMenu(w, 6, STR_02DD_SUBSIDIES, 1);

   243

}

   244

   245

static void MenuClickSubsidies(int index)

   246

{

   247

	ShowSubsidiesList();

   248

}

   249

   250

/* --- Stations button menu --- */

   251

   252

static void ToolbarStationsClick(Window *w)

   253

{

   254

	PopupMainPlayerToolbMenu(w, 7, 0);

   255

}

   256

   257

static void MenuClickStations(int index)

   258

{

   259

	ShowPlayerStations((PlayerID)index);

   260

}

   261

   262

/* --- Finances button menu --- */

   263

   264

static void ToolbarFinancesClick(Window *w)

   265

{

   266

	PopupMainPlayerToolbMenu(w, 8, 0);

   267

}

   268

   269

static void MenuClickFinances(int index)

   270

{

   271

	ShowPlayerFinances((PlayerID)index);

   272

}

   273

   274

/* --- Company's button menu --- */

   275

   276

static void ToolbarPlayersClick(Window *w)

   277

{

   278

	PopupMainPlayerToolbMenu(w, 9, 0);

   279

}

   280

   281

static void MenuClickCompany(int index)

   282

{

   283

	if (_networking && index == 0) {

   284

		ShowClientList();

   285

	} else {

   286

		if (_networking) index--;

   287

		ShowPlayerCompany((PlayerID)index);

   288

	}

   289

}

   290

   291

/* --- Graphs button menu --- */

   292

   293

static void ToolbarGraphsClick(Window *w)

   294

{

   295

	PopupMainToolbMenu(w, 10, STR_0154_OPERATING_PROFIT_GRAPH, (_toolbar_mode == TB_NORMAL) ? 6 : 8);

   296

}

   297

   298

static void MenuClickGraphs(int index)

   299

{

   300

	switch (index) {

   301

		case 0: ShowOperatingProfitGraph();    break;

   302

		case 1: ShowIncomeGraph();             break;

   303

		case 2: ShowDeliveredCargoGraph();     break;

   304

		case 3: ShowPerformanceHistoryGraph(); break;

   305

		case 4: ShowCompanyValueGraph();       break;

   306

		case 5: ShowCargoPaymentRates();       break;

   307

		/* functions for combined graphs/league button */

   308

		case 6: ShowCompanyLeagueTable();      break;

   309

		case 7: ShowPerformanceRatingDetail(); break;

   310

	}

   311

}

   312

   313

/* --- League button menu --- */

   314

   315

static void ToolbarLeagueClick(Window *w)

   316

{

   317

	PopupMainToolbMenu(w, 11, STR_015A_COMPANY_LEAGUE_TABLE, 2);

   318

}

   319

   320

static void MenuClickLeague(int index)

   321

{

   322

	switch (index) {

   323

		case 0: ShowCompanyLeagueTable();      break;

   324

		case 1: ShowPerformanceRatingDetail(); break;

   325

	}

   326

}

   327

   328

/* --- Industries button menu --- */

   329

   330

static void ToolbarIndustryClick(Window *w)

   331

{

   332

	/* Disable build-industry menu if we are a spectator */

   333

	PopupMainToolbMenu(w, 12, STR_INDUSTRY_DIR, 2, (_current_player == PLAYER_SPECTATOR) ? (1 << 1) : 0);

   334

}

   335

   336

static void MenuClickIndustry(int index)

   337

{

   338

	switch (index) {

   339

		case 0: ShowIndustryDirectory();   break;

   340

		case 1: ShowBuildIndustryWindow(); break;

   341

	}

   342

}

   343

   344

/* --- Trains button menu + 1 helper function for all vehicles. --- */

   345

   346

static void ToolbarVehicleClick(Window *w, VehicleType veh)

   347

{

   348

	const Vehicle *v;

   349

	int dis = ~0;

   350

   351

	FOR_ALL_VEHICLES(v) {

   352

		if (v->type == veh && v->IsPrimaryVehicle()) ClrBit(dis, v->owner);

   353

	}

   354

	PopupMainPlayerToolbMenu(w, 13 + veh, dis);

   355

}

   356

   357

   358

static void ToolbarTrainClick(Window *w)

   359

{

   360

	ToolbarVehicleClick(w, VEH_TRAIN);

   361

}

   362

   363

static void MenuClickShowTrains(int index)

   364

{

   365

	ShowVehicleListWindow((PlayerID)index, VEH_TRAIN);

   366

}

   367

   368

/* --- Road vehicle button menu --- */

   369

   370

static void ToolbarRoadClick(Window *w)

   371

{

   372

	ToolbarVehicleClick(w, VEH_ROAD);

   373

}

   374

   375

static void MenuClickShowRoad(int index)

   376

{

   377

	ShowVehicleListWindow((PlayerID)index, VEH_ROAD);

   378

}

   379

   380

/* --- Ship button menu --- */

   381

   382

static void ToolbarShipClick(Window *w)

   383

{

   384

	ToolbarVehicleClick(w, VEH_SHIP);

   385

}

   386

   387

static void MenuClickShowShips(int index)

   388

{

   389

	ShowVehicleListWindow((PlayerID)index, VEH_SHIP);

   390

}

   391

   392

/* --- Aircraft button menu --- */

   393

   394

static void ToolbarAirClick(Window *w)

   395

{

   396

	ToolbarVehicleClick(w, VEH_AIRCRAFT);

   397

}

   398

   399

static void MenuClickShowAir(int index)

   400

{

   401

	ShowVehicleListWindow((PlayerID)index, VEH_AIRCRAFT);

   402

}

   403

   404

/* --- Zoom in button --- */

   405

   406

static void ToolbarZoomInClick(Window *w)

   407

{

   408

	if (DoZoomInOutWindow(ZOOM_IN, FindWindowById(WC_MAIN_WINDOW, 0))) {

   409

		w->HandleButtonClick(17);

   410

		SndPlayFx(SND_15_BEEP);

   411

	}

   412

}

   413

   414

/* --- Zoom out button --- */

   415

   416

static void ToolbarZoomOutClick(Window *w)

   417

{

   418

	if (DoZoomInOutWindow(ZOOM_OUT, FindWindowById(WC_MAIN_WINDOW, 0))) {

   419

		w->HandleButtonClick(18);

   420

		SndPlayFx(SND_15_BEEP);

   421

	}

   422

}

   423

   424

/* --- Rail button menu --- */

   425

   426

static void ToolbarBuildRailClick(Window *w)

   427

{

   428

	const Player *p = GetPlayer(_local_player);

   429

	PopupMainToolbMenu(w, 19, STR_1015_RAILROAD_CONSTRUCTION, RAILTYPE_END, ~p->avail_railtypes, _last_built_railtype);

   430

}

   431

   432

static void MenuClickBuildRail(int index)

   433

{

   434

	_last_built_railtype = (RailType)index;

   435

	ShowBuildRailToolbar(_last_built_railtype, -1);

   436

}

   437

   438

/* --- Road button menu --- */

   439

   440

static void ToolbarBuildRoadClick(Window *w)

   441

{

   442

	const Player *p = GetPlayer(_local_player);

   443

	/* The standard road button is *always* available */

   444

	PopupMainToolbMenu(w, 20, STR_180A_ROAD_CONSTRUCTION, 2, ~(p->avail_roadtypes | ROADTYPES_ROAD), _last_built_roadtype);

   445

}

   446

   447

static void MenuClickBuildRoad(int index)

   448

{

   449

	_last_built_roadtype = (RoadType)index;

   450

	ShowBuildRoadToolbar(_last_built_roadtype);

   451

}

   452

   453

/* --- Water button menu --- */

   454

   455

static void ToolbarBuildWaterClick(Window *w)

   456

{

   457

	PopupMainToolbMenu(w, 21, STR_9800_DOCK_CONSTRUCTION, 1);

   458

}

   459

   460

static void MenuClickBuildWater(int index)

   461

{

   462

	ShowBuildDocksToolbar();

   463

}

   464

   465

/* --- Airport button menu --- */

   466

   467

static void ToolbarBuildAirClick(Window *w)

   468

{

   469

	PopupMainToolbMenu(w, 22, STR_A01D_AIRPORT_CONSTRUCTION, 1);

   470

}

   471

   472

static void MenuClickBuildAir(int index)

   473

{

   474

	ShowBuildAirToolbar();

   475

}

   476

   477

/* --- Forest button menu --- */

   478

   479

static void ToolbarForestClick(Window *w)

   480

{

   481

	PopupMainToolbMenu(w, 23, STR_LANDSCAPING, 3);

   482

}

   483

   484

static void MenuClickForest(int index)

   485

{

   486

	switch (index) {

   487

		case 0: ShowTerraformToolbar();  break;

   488

		case 1: ShowBuildTreesToolbar(); break;

   489

		case 2: SelectSignTool();        break;

   490

	}

   491

}

   492

   493

/* --- Music button menu --- */

   494

   495

static void ToolbarMusicClick(Window *w)

   496

{

   497

	PopupMainToolbMenu(w, 24, STR_01D3_SOUND_MUSIC, 1);