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 = 0);

    51

static void SplitToolbar(Window *w);

    52

    53

RailType _last_built_railtype;

    54

RoadType _last_built_roadtype;

    55

    67

enum ToolbarMode {

    68

	TB_NORMAL,

    69

	TB_UPPER,

    70

	TB_LOWER

    71

};

    72

    73

enum ToolbarNormalWidgets {

    74

	TBN_PAUSE         = 0,

    75

	TBN_FASTFORWARD,

    76

	TBN_SETTINGS,

    77

	TBN_SAVEGAME,

    78

	TBN_SMALLMAP,

    79

	TBN_TOWNDIRECTORY,

    80

	TBN_SUBSIDIES,

    81

	TBN_STATIONS,

    82

	TBN_FINANCES,

    83

	TBN_PLAYERS,

    84

	TBN_GRAPHICS,

    85

	TBN_LEAGUE,

    86

	TBN_INDUSTRIES,

    87

	TBN_VEHICLESTART,      ///< trains, actually.  So following are trucks, boats and planes

    88

	TBN_TRAINS        = TBN_VEHICLESTART,

    89

	TBN_ROADVEHS,

    90

	TBN_SHIPS,

    91

	TBN_AIRCRAFTS,

    92

	TBN_ZOOMIN,

    93

	TBN_ZOOMOUT,

    94

	TBN_RAILS,

    95

	TBN_ROADS,

    96

	TBN_WATER,

    97

	TBN_AIR,

    98

	TBN_LANDSCAPE,

    99

	TBN_MUSICSOUND,

   100

	TBN_NEWSREPORT,

   101

	TBN_HELP,

   102

	TBN_SWITCHBAR,         ///< only available when toolbar has been split

   103

};

   104

   105

enum ToolbarScenEditorWidgets {

   106

	TBSE_PAUSE        = 0,

   107

	TBSE_FASTFORWARD,

   108

	TBSE_SAVESCENARIO = 3,

   109

	TBSE_SPACERPANEL,

   111

	TBSE_DATEBACKWARD,

   112

	TBSE_DATEFORWARD,

   113

	TBSE_SMALLMAP,

   114

	TBSE_ZOOMIN,

   115

	TBSE_ZOOMOUT,

   116

	TBSE_LANDGENERATE,

   117

	TBSE_TOWNGENERATE,

   118

	TBSE_INDUSTRYGENERATE,

   119

	TBSE_BUILDROAD,

   121

	TBSE_PLANTTREES,

   122

	TBSE_PLACESIGNS,

   123

};

   124

   125

/** The idea of this enum is to allow a separation between widget position

   126

 * and _menu_clicked_procs's entry.  By shifting, the "action" id is extracted and

   128

 * @see ToolbarMenuWindow::OnMouseLoop */

   129

enum ScenarioEditorMenuActions {

   130

	SEMA_MAP_CLICK = 17 << 8,

   131

};

   132

   133

static ToolbarMode _toolbar_mode;

   134

   135

static void SelectSignTool()

   136

{

   137

	if (_cursor.sprite == SPR_CURSOR_SIGN) {

   138

		ResetObjectToPlace();

   139

	} else {

   140

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

   141

		_place_proc = PlaceProc_Sign;

   142

	}

   143

}

   144

   145

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

   146

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

   147

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

   148

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

   149

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

   150

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

   151

{

   152

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

   153

	Point pos;

   154

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

   155

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

   156

	pos.y = w->height;

   157

   158

	return pos;

   159

}

   160

   161

/**

   162

 * Retrieve the menu item number from a position

   163

 * @param w Window holding the menu items

   164

 * @param x X coordinate of the position

   165

 * @param y Y coordinate of the position

   166

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

   167

 */

   168

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

   169

{

   170

	int x = _cursor.pos.x;

   171

	int y = _cursor.pos.y;

   172

   173

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

   174

		y /= 10;

   175

   176

		if (y < item_count &&

   177

				!HasBit(disabled_items, y)) {

   178

			return y;

   179

		}

   180

	}

   181

	return -1;

   182

}

   183

   184

/* --- Pausing --- */

   185

   186

static void ToolbarPauseClick(Window *w)

   187

{

   188

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

   189

   190

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

   191

}

   192

   193

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

   194

   195

static void ToolbarFastForwardClick(Window *w)

   196

{

   197

	_fast_forward ^= true;

   198

	SndPlayFx(SND_15_BEEP);

   199

}

   200

   201

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

   202

   203

enum OptionMenuEntries {

   204

	OME_GAMEOPTIONS    = 0,

   205

	OME_DIFFICULTIES,

   206

	OME_PATCHES,

   207

	OME_NEWGRFSETTINGS,

   208

	OME_TRANSPARENCIES,

   209

	OME_SHOW_TOWNNAMES = 6,

   210

	OME_SHOW_STATIONNAMES,

   211

	OME_SHOW_SIGNS,

   212

	OME_SHOW_WAYPOINTNAMES,

   213

	OME_FULL_ANIMATION,

   214

	OME_FULL_DETAILS,

   215

	OME_TRANSPARENTBUILDINGS,

   216

	OME_SHOW_STATIONSIGNS,

   217

	OME_MENUCOUNT,

   218

};

   219

   220

static void ToolbarOptionsClick(Window *w)

   221

{

   222

	uint16 x = 0;

   223

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

   224

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

   225

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

   226

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

   227

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

   228

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

   229

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

   230

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

   231

   232

	PopupMainToolbMenu(w, TBN_SETTINGS, STR_02C4_GAME_OPTIONS, OME_MENUCOUNT, 0, 0, x);

   233

}

   234

   235

static void MenuClickSettings(int index)

   236

{

   237

	switch (index) {

   238

		case OME_GAMEOPTIONS:          ShowGameOptions();                              return;

   239

		case OME_DIFFICULTIES:         ShowGameDifficulty();                           return;

   240

		case OME_PATCHES:              ShowPatchesSelection();                         return;

   241

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

   242

		case OME_TRANSPARENCIES:       ShowTransparencyToolbar();                      break;

   243

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

		case OME_TRANSPARENTBUILDINGS: ToggleTransparency(TO_HOUSES);                  break;

   251

		case OME_SHOW_STATIONSIGNS:    ToggleTransparency(TO_SIGNS);                   break;

   252

	}

   253

	MarkWholeScreenDirty();

   254

}

   255

   256

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

   257

   258

enum SaveLoadEditorMenuEntries {

   259

	SLEME_SAVE_SCENARIO   = 0,

   260

	SLEME_LOAD_SCENARIO,

   261

	SLEME_LOAD_HEIGHTMAP,

   262

	SLEME_EXIT_TOINTRO,

   263

	SLEME_EXIT_GAME       = 5,

   264

	SLEME_MENUCOUNT,

   265

};

   266

   267

enum SaveLoadNormalMenuEntries {

   268

	SLNME_SAVE_GAME   = 0,

   269

	SLNME_LOAD_GAME,

   270

	SLNME_EXIT_TOINTRO,

   271

	SLNME_EXIT_GAME,

   272

	SLNME_MENUCOUNT,

   273

};

   274

   275

static void ToolbarSaveClick(Window *w)

   276

{

   277

	PopupMainToolbMenu(w, TBN_SAVEGAME, STR_015C_SAVE_GAME, SLNME_MENUCOUNT);

   278

}

   279

   280

static void ToolbarScenSaveOrLoad(Window *w)

   281

{

   282

	PopupMainToolbMenu(w, TBSE_SAVESCENARIO, STR_0292_SAVE_SCENARIO, SLEME_MENUCOUNT);

   283

}

   284

   286

{

   287

	if (_game_mode == GM_EDITOR) {

   288

		switch (index) {

   289

			case SLEME_SAVE_SCENARIO:  ShowSaveLoadDialog(SLD_SAVE_SCENARIO);  break;

   290

			case SLEME_LOAD_SCENARIO:  ShowSaveLoadDialog(SLD_LOAD_SCENARIO);  break;

   291

			case SLEME_LOAD_HEIGHTMAP: ShowSaveLoadDialog(SLD_LOAD_HEIGHTMAP); break;

   292

			case SLEME_EXIT_TOINTRO:   AskExitToGameMenu();                    break;

   293

			case SLEME_EXIT_GAME:      HandleExitGameRequest();                break;

   294

		}

   295

	} else {

   296

		switch (index) {

   297

			case SLNME_SAVE_GAME:      ShowSaveLoadDialog(SLD_SAVE_GAME); break;

   298

			case SLNME_LOAD_GAME:      ShowSaveLoadDialog(SLD_LOAD_GAME); break;

   299

			case SLNME_EXIT_TOINTRO:   AskExitToGameMenu();               break;

   300

			case SLNME_EXIT_GAME:      HandleExitGameRequest();           break;

   301

		}

   302

	}

   303

}

   304

   305

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

   306

   307

enum MapMenuEntries {

   308

	MME_SHOW_SMALLMAP        = 0,

   309

	MME_SHOW_EXTRAVIEWPORTS,

   310

	MME_SHOW_SIGNLISTS,

   311

	MME_SHOW_TOWNDIRECTORY,    ///< This entry is only used in Editor mode

   314

};

   315

   316

static void ToolbarMapClick(Window *w)

   317

{

   318

	PopupMainToolbMenu(w, TBN_SMALLMAP, STR_02DE_MAP_OF_WORLD, MME_MENUCOUNT_NORMAL);

   319

}

   320

   321

static void ToolbarScenMapTownDir(Window *w)

   322

{

   323

	/* Scenario editor button, Use different button to activate.

   324

	 * This scheme will allow to have an action (SEMA_MAP_CLICK, which is in fact

   325

	 * an entry in _menu_clicked_procs) while at the same time having a start button

   326

	 * who is not at the same index as its action

   327

	 * @see ToolbarMenuWindow::OnMouseLoop */

   328

	PopupMainToolbMenu(w, TBSE_SMALLMAP | SEMA_MAP_CLICK, STR_02DE_MAP_OF_WORLD, MME_MENUCOUNT_EDITOR);

   329

}

   330

   331

static void MenuClickMap(int index)

   332

{

   333

	switch (index) {

   334

		case MME_SHOW_SMALLMAP:       ShowSmallMap();            break;

   335

		case MME_SHOW_EXTRAVIEWPORTS: ShowExtraViewPortWindow(); break;

   336

		case MME_SHOW_SIGNLISTS:      ShowSignList();            break;

   337

		case MME_SHOW_TOWNDIRECTORY:  if (_game_mode == GM_EDITOR) ShowTownDirectory(); break;

   338

	}

   339

}

   340

   341

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

   342

   343

static void ToolbarTownClick(Window *w)

   344

{

   345

	PopupMainToolbMenu(w, TBN_TOWNDIRECTORY, STR_02BB_TOWN_DIRECTORY, 1);

   346

}

   347

   348

static void MenuClickTown(int index)

   349

{

   350

	ShowTownDirectory();

   351

}

   352

   353

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

   354

   355

static void ToolbarSubsidiesClick(Window *w)

   356

{

   357

	PopupMainToolbMenu(w, TBN_SUBSIDIES, STR_02DD_SUBSIDIES, 1);

   358

}

   359

   360

static void MenuClickSubsidies(int index)

   361

{

   362

	ShowSubsidiesList();

   363

}

   364

   365

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

   366

   367

static void ToolbarStationsClick(Window *w)

   368

{

   369

	PopupMainPlayerToolbMenu(w, TBN_STATIONS);

   370

}

   371

   372

static void MenuClickStations(int index)

   373

{

   374

	ShowPlayerStations((PlayerID)index);

   375

}

   376

   377

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

   378

   379

static void ToolbarFinancesClick(Window *w)

   380

{

   381

	PopupMainPlayerToolbMenu(w, TBN_FINANCES);

   382

}

   383

   384

static void MenuClickFinances(int index)

   385

{

   386

	ShowPlayerFinances((PlayerID)index);

   387

}

   388

   389

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

   390

   391

static void ToolbarPlayersClick(Window *w)

   392

{

   393

	PopupMainPlayerToolbMenu(w, TBN_PLAYERS);

   394

}

   395

   396

static void MenuClickCompany(int index)

   397

{

   398

	if (_networking && index == 0) {

   399

		ShowClientList();

   400

	} else {

   401

		if (_networking) index--;

   402

		ShowPlayerCompany((PlayerID)index);

   403

	}

   404

}

   405

   406

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

   407

   408

static void ToolbarGraphsClick(Window *w)

   409

{

   410

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

   411

}

   412

   413

static void MenuClickGraphs(int index)

   414

{

   415

	switch (index) {

   416

		case 0: ShowOperatingProfitGraph();    break;

   417

		case 1: ShowIncomeGraph();             break;

   418

		case 2: ShowDeliveredCargoGraph();     break;

   419

		case 3: ShowPerformanceHistoryGraph(); break;

   420

		case 4: ShowCompanyValueGraph();       break;

   421

		case 5: ShowCargoPaymentRates();       break;

   422

		/* functions for combined graphs/league button */

   423

		case 6: ShowCompanyLeagueTable();      break;

   424

		case 7: ShowPerformanceRatingDetail(); break;

   425

	}

   426

}

   427

   428

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

   429

   430

static void ToolbarLeagueClick(Window *w)

   431

{

   432

	PopupMainToolbMenu(w, TBN_LEAGUE, STR_015A_COMPANY_LEAGUE_TABLE, 2);

   433

}

   434

   435

static void MenuClickLeague(int index)

   436

{

   437

	switch (index) {

   438

		case 0: ShowCompanyLeagueTable();      break;

   439

		case 1: ShowPerformanceRatingDetail(); break;

   440

	}

   441

}

   442

   443

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

   444

   445

static void ToolbarIndustryClick(Window *w)

   446

{

   447

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

   448

	PopupMainToolbMenu(w, TBN_INDUSTRIES, STR_INDUSTRY_DIR, 2, (_current_player == PLAYER_SPECTATOR) ? 2 : 0);

   449

}

   450

   451

static void MenuClickIndustry(int index)

   452

{

   453

	switch (index) {

   454

		case 0: ShowIndustryDirectory();   break;

   455

		case 1: ShowBuildIndustryWindow(); break;

   456

	}

   457

}

   458

   459

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

   460

   461

static void ToolbarVehicleClick(Window *w, VehicleType veh)

   462

{

   463

	const Vehicle *v;

   464

	int dis = ~0;

   465

   466

	FOR_ALL_VEHICLES(v) {

   467

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

   468

	}

   469

	PopupMainPlayerToolbMenu(w, TBN_VEHICLESTART + veh, dis);

   470

}

   471

   472

   473

static void ToolbarTrainClick(Window *w)

   474

{

   475

	ToolbarVehicleClick(w, VEH_TRAIN);

   476

}

   477

   478

static void MenuClickShowTrains(int index)

   479

{

   480

	ShowVehicleListWindow((PlayerID)index, VEH_TRAIN);

   481

}

   482

   483

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

   484

   485

static void ToolbarRoadClick(Window *w)

   486

{

   487

	ToolbarVehicleClick(w, VEH_ROAD);

   488

}

   489

   490

static void MenuClickShowRoad(int index)

   491

{

   492

	ShowVehicleListWindow((PlayerID)index, VEH_ROAD);

   493

}

   494

   495

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