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

    56

enum ToolbarMode {

    57

	TB_NORMAL,

    58

	TB_UPPER,

    59

	TB_LOWER

    60

};

    61

    62

enum ToolbarNormalWidgets {

    63

	TBN_PAUSE         = 0,

    64

	TBN_FASTFORWARD,

    65

	TBN_SETTINGS,

    66

	TBN_SAVEGAME,

    67

	TBN_SMALLMAP,

    68

	TBN_TOWNDIRECTORY,

    69

	TBN_SUBSIDIES,

    70

	TBN_STATIONS,

    71

	TBN_FINANCES,

    72

	TBN_PLAYERS,

    73

	TBN_GRAPHICS,

    74

	TBN_LEAGUE,

    75

	TBN_INDUSTRIES,

    76

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

    77

	TBN_TRAINS        = TBN_VEHICLESTART,

    78

	TBN_ROADVEHS,

    79

	TBN_SHIPS,

    80

	TBN_AIRCRAFTS,

    81

	TBN_ZOOMIN,

    82

	TBN_ZOOMOUT,

    83

	TBN_RAILS,

    84

	TBN_ROADS,

    85

	TBN_WATER,

    86

	TBN_AIR,

    87

	TBN_LANDSCAPE,

    88

	TBN_MUSICSOUND,

    89

	TBN_NEWSREPORT,

    90

	TBN_HELP,

    91

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

    92

};

    93

    94

enum ToolbarScenEditorWidgets {

    95

	TBSE_PAUSE        = 0,

    96

	TBSE_FASTFORWARD,

    97

	TBSE_SAVESCENARIO = 3,

    98

	TBSE_SPACERPANEL,

    99

	TBSE_SEPARATOR,

   100

	TBSE_DATEBACKWARD,

   101

	TBSE_DATEFORWARD,

   102

	TBSE_SMALLMAP,

   103

	TBSE_ZOOMIN,

   104

	TBSE_ZOOMOUT,

   105

	TBSE_LANDGENERATE,

   106

	TBSE_TOWNGENERATE,

   107

	TBSE_INDUSTRYGENERATE,

   108

	TBSE_BUILDROAD,

   109

	TBSE_PLANTTREES,

   110

	TBSE_PLACESIGNS,

   111

};

   112

   113

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

   114

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

   115

 * kept safe for usage when reuired.

   116

 * @see ToolbarMenuWindow::OnMouseLoop */

   117

enum ScenarioEditorMenuActions {

   118

	SEMA_MAP_CLICK = 17 << 8,

   119

};

   120

   121

static ToolbarMode _toolbar_mode;

   122

   123

static void SelectSignTool()

   124

{

   125

	if (_cursor.sprite == SPR_CURSOR_SIGN) {

   126

		ResetObjectToPlace();

   127

	} else {

   128

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

   129

		_place_proc = PlaceProc_Sign;

   130

	}

   131

}

   132

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

{

   140

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

   141

	Point pos;

   142

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

   143

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

   144

	pos.y = w->height;

   145

   146

	return pos;

   147

}

   148

   149

/**

   150

 * Retrieve the menu item number from a position

   151

 * @param w Window holding the menu items

   152

 * @param x X coordinate of the position

   153

 * @param y Y coordinate of the position

   154

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

   155

 */

   156

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

   157

{

   158

	int x = _cursor.pos.x;

   159

	int y = _cursor.pos.y;

   160

   161

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

   162

		y /= 10;

   163

   164

		if (y < item_count &&

   165

				!HasBit(disabled_items, y)) {

   166

			return y;

   167

		}

   168

	}

   169

	return -1;

   170

}

   171

   172

/* --- Pausing --- */

   173

   174

static void ToolbarPauseClick(Window *w)

   175

{

   176

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

   177

   178

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

   179

}

   180

   181

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

   182

   183

static void ToolbarFastForwardClick(Window *w)

   184

{

   185

	_fast_forward ^= true;

   186

	SndPlayFx(SND_15_BEEP);

   187

}

   188

   189

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

   190

   191

enum OptionMenuEntries {

   192

	OME_GAMEOPTIONS    = 0,

   193

	OME_DIFFICULTIES,

   194

	OME_PATCHES,

   195

	OME_NEWGRFSETTINGS,

   196

	OME_TRANSPARENCIES,

   197

	OME_SHOW_TOWNNAMES = 6,

   198

	OME_SHOW_STATIONNAMES,

   199

	OME_SHOW_SIGNS,

   200

	OME_SHOW_WAYPOINTNAMES,

   201

	OME_FULL_ANIMATION,

   202

	OME_FULL_DETAILS,

   203

	OME_TRANSPARENTBUILDINGS,

   204

	OME_SHOW_STATIONSIGNS,

   205

	OME_MENUCOUNT,

   206

};

   207

   208

static void ToolbarOptionsClick(Window *w)

   209

{

   210

	uint16 x = 0;

   211

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

   212

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

   213

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

   214

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

   215

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

   216

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

   217

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

   218

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

   219

   220

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

   221

}

   222

   223

static void MenuClickSettings(int index)

   224

{

   225

	switch (index) {

   226

		case OME_GAMEOPTIONS:          ShowGameOptions();                              return;

   227

		case OME_DIFFICULTIES:         ShowGameDifficulty();                           return;

   228

		case OME_PATCHES:              ShowPatchesSelection();                         return;

   229

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

   230

		case OME_TRANSPARENCIES:       ShowTransparencyToolbar();                      break;

   231

   232

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

   233

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

   234

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

   235

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

   236

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

   237

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

   238

		case OME_TRANSPARENTBUILDINGS: ToggleTransparency(TO_HOUSES);                  break;

   239

		case OME_SHOW_STATIONSIGNS:    ToggleTransparency(TO_SIGNS);                   break;

   240

	}

   241

	MarkWholeScreenDirty();

   242

}

   243

   244

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

   245

   246

enum SaveLoadEditorMenuEntries {

   247

	SLEME_SAVE_SCENARIO   = 0,

   248

	SLEME_LOAD_SCENARIO,

   249

	SLEME_LOAD_HEIGHTMAP,

   250

	SLEME_EXIT_TOINTRO,

   251

	SLEME_EXIT_GAME       = 5,

   252

	SLEME_MENUCOUNT,

   253

};

   254

   255

enum SaveLoadNormalMenuEntries {

   256

	SLNME_SAVE_GAME   = 0,

   257

	SLNME_LOAD_GAME,

   258

	SLNME_EXIT_TOINTRO,

   259

	SLNME_EXIT_GAME,

   260

	SLNME_MENUCOUNT,

   261

};

   262

   263

static void ToolbarSaveClick(Window *w)

   264

{

   265

	PopupMainToolbMenu(w, TBN_SAVEGAME, STR_015C_SAVE_GAME, SLNME_MENUCOUNT);

   266

}

   267

   268

static void ToolbarScenSaveOrLoad(Window *w)

   269

{

   270

	PopupMainToolbMenu(w, TBSE_SAVESCENARIO, STR_0292_SAVE_SCENARIO, SLEME_MENUCOUNT);

   271

}

   272

   273

static void MenuClickSaveLoad(int index)

   274

{

   275

	if (_game_mode == GM_EDITOR) {

   276

		switch (index) {

   277

			case SLEME_SAVE_SCENARIO:  ShowSaveLoadDialog(SLD_SAVE_SCENARIO);  break;

   278

			case SLEME_LOAD_SCENARIO:  ShowSaveLoadDialog(SLD_LOAD_SCENARIO);  break;

   279

			case SLEME_LOAD_HEIGHTMAP: ShowSaveLoadDialog(SLD_LOAD_HEIGHTMAP); break;

   280

			case SLEME_EXIT_TOINTRO:   AskExitToGameMenu();                    break;

   281

			case SLEME_EXIT_GAME:      HandleExitGameRequest();                break;

   282

		}

   283

	} else {

   284

		switch (index) {

   285

			case SLNME_SAVE_GAME:      ShowSaveLoadDialog(SLD_SAVE_GAME); break;

   286

			case SLNME_LOAD_GAME:      ShowSaveLoadDialog(SLD_LOAD_GAME); break;

   287

			case SLNME_EXIT_TOINTRO:   AskExitToGameMenu();               break;

   288

			case SLNME_EXIT_GAME:      HandleExitGameRequest();           break;

   289

		}

   290

	}

   291

}

   292

   293

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

   294

   295

enum MapMenuEntries {

   296

	MME_SHOW_SMALLMAP        = 0,

   297

	MME_SHOW_EXTRAVIEWPORTS,

   298

	MME_SHOW_SIGNLISTS,

   299

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

   300

	MME_MENUCOUNT_NORMAL = 3,

   301

	MME_MENUCOUNT_EDITOR = 4,

   302

};

   303

   304

static void ToolbarMapClick(Window *w)

   305

{

   306

	PopupMainToolbMenu(w, TBN_SMALLMAP, STR_02DE_MAP_OF_WORLD, MME_MENUCOUNT_NORMAL);

   307

}

   308

   309

static void ToolbarScenMapTownDir(Window *w)

   310

{

   311

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

   312

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

   313

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

   314

	 * who is not at the same index as its action

   315

	 * @see ToolbarMenuWindow::OnMouseLoop */

   316

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

   317

}

   318

   319

static void MenuClickMap(int index)

   320

{

   321

	switch (index) {

   322

		case MME_SHOW_SMALLMAP:       ShowSmallMap();            break;

   323

		case MME_SHOW_EXTRAVIEWPORTS: ShowExtraViewPortWindow(); break;

   324

		case MME_SHOW_SIGNLISTS:      ShowSignList();            break;

   325

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

   326

	}

   327

}

   328

   329

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

   330

   331

static void ToolbarTownClick(Window *w)

   332

{

   333

	PopupMainToolbMenu(w, TBN_TOWNDIRECTORY, STR_02BB_TOWN_DIRECTORY, 1);

   334

}

   335

   336

static void MenuClickTown(int index)

   337

{

   338

	ShowTownDirectory();

   339

}

   340

   341

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

   342

   343

static void ToolbarSubsidiesClick(Window *w)

   344

{

   345

	PopupMainToolbMenu(w, TBN_SUBSIDIES, STR_02DD_SUBSIDIES, 1);

   346

}

   347

   348

static void MenuClickSubsidies(int index)

   349

{

   350

	ShowSubsidiesList();

   351

}

   352

   353

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

   354

   355

static void ToolbarStationsClick(Window *w)

   356

{

   357

	PopupMainPlayerToolbMenu(w, TBN_STATIONS);

   358

}

   359

   360

static void MenuClickStations(int index)

   361

{

   362

	ShowPlayerStations((PlayerID)index);

   363

}

   364

   365

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

   366

   367

static void ToolbarFinancesClick(Window *w)

   368

{

   369

	PopupMainPlayerToolbMenu(w, TBN_FINANCES);

   370

}

   371

   372

static void MenuClickFinances(int index)

   373

{

   374

	ShowPlayerFinances((PlayerID)index);

   375

}

   376

   377

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

   378

   379

static void ToolbarPlayersClick(Window *w)

   380

{

   381

	PopupMainPlayerToolbMenu(w, TBN_PLAYERS);

   382

}

   383

   384

static void MenuClickCompany(int index)

   385

{

   386

	if (_networking && index == 0) {

   387

		ShowClientList();

   388

	} else {

   389

		if (_networking) index--;

   390

		ShowPlayerCompany((PlayerID)index);

   391

	}

   392

}

   393

   394

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

   395

   396

static void ToolbarGraphsClick(Window *w)

   397

{

   398

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

   399

}

   400

   401

static void MenuClickGraphs(int index)

   402

{

   403

	switch (index) {

   404

		case 0: ShowOperatingProfitGraph();    break;

   405

		case 1: ShowIncomeGraph();             break;

   406

		case 2: ShowDeliveredCargoGraph();     break;

   407

		case 3: ShowPerformanceHistoryGraph(); break;

   408

		case 4: ShowCompanyValueGraph();       break;

   409

		case 5: ShowCargoPaymentRates();       break;

   410

		/* functions for combined graphs/league button */

   411

		case 6: ShowCompanyLeagueTable();      break;

   412

		case 7: ShowPerformanceRatingDetail(); break;

   413

	}

   414

}

   415

   416

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

   417

   418

static void ToolbarLeagueClick(Window *w)

   419

{

   420

	PopupMainToolbMenu(w, TBN_LEAGUE, STR_015A_COMPANY_LEAGUE_TABLE, 2);

   421

}

   422

   423

static void MenuClickLeague(int index)

   424

{

   425

	switch (index) {

   426

		case 0: ShowCompanyLeagueTable();      break;

   427

		case 1: ShowPerformanceRatingDetail(); break;

   428

	}

   429

}

   430

   431

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

   432

   433

static void ToolbarIndustryClick(Window *w)

   434

{

   435

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

   436

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

   437

}

   438

   439

static void MenuClickIndustry(int index)

   440

{

   441

	switch (index) {

   442

		case 0: ShowIndustryDirectory();   break;

   443

		case 1: ShowBuildIndustryWindow(); break;

   444

	}

   445

}

   446

   447

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

   448

   449

static void ToolbarVehicleClick(Window *w, VehicleType veh)

   450

{

   451

	const Vehicle *v;

   452

	int dis = ~0;

   453

   454

	FOR_ALL_VEHICLES(v) {

   455

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

   456

	}

   457

	PopupMainPlayerToolbMenu(w, TBN_VEHICLESTART + veh, dis);

   458

}

   459

   460

   461

static void ToolbarTrainClick(Window *w)

   462

{

   463

	ToolbarVehicleClick(w, VEH_TRAIN);

   464

}

   465

   466

static void MenuClickShowTrains(int index)

   467

{

   468

	ShowVehicleListWindow((PlayerID)index, VEH_TRAIN);

   469

}

   470

   471

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

   472

   473

static void ToolbarRoadClick(Window *w)

   474

{

   475

	ToolbarVehicleClick(w, VEH_ROAD);

   476

}

   477

   478

static void MenuClickShowRoad(int index)

   479

{

   480

	ShowVehicleListWindow((PlayerID)index, VEH_ROAD);

   481

}

   482

   483

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

   484

   485

static void ToolbarShipClick(Window *w)

   486

{

   487

	ToolbarVehicleClick(w, VEH_SHIP);

   488

}

   489

   490

static void MenuClickShowShips(int index)

   491

{

   492

	ShowVehicleListWindow((PlayerID)index, VEH_SHIP);

   493

}

   494

   495

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

   496