core/MenuStyle_Base.cpp
author David Anderson <dvander@alliedmods.net>
Sun Jun 17 18:06:03 2007 +0000 (2007-06-17)
changeset 970 b47becc0083d
parent 959 f0231833e6ec
child 997 2fc3152c3118
permissions -rw-r--r--
added extensive menu action logging
dvander@769
     1
/**
dvander@769
     2
 * vim: set ts=4 :
dvander@769
     3
 * ===============================================================
dvander@769
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@769
     5
 * ===============================================================
dvander@769
     6
 *
dvander@769
     7
 * This file is not open source and may not be copied without explicit
dvander@769
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@769
     9
 * in whole or significant part.
dvander@769
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@769
    11
 *
dvander@769
    12
 * Version: $Id$
dvander@769
    13
 */
dvander@771
    14
dvander@769
    15
#include <stdarg.h>
dvander@769
    16
#include "sm_stringutil.h"
dvander@769
    17
#include "MenuStyle_Base.h"
dvander@775
    18
#include "PlayerManager.h"
dvander@775
    19
#include "MenuManager.h"
dvander@790
    20
#include "HandleSys.h"
dvander@970
    21
#if defined MENU_DEBUG
dvander@970
    22
#include "Logger.h"
dvander@970
    23
#endif
dvander@775
    24
dvander@790
    25
BaseMenuStyle::BaseMenuStyle() : m_WatchList(256), m_hHandle(BAD_HANDLE)
dvander@790
    26
{
dvander@790
    27
}
dvander@790
    28
dvander@790
    29
Handle_t BaseMenuStyle::GetHandle()
dvander@775
    30
{
dvander@790
    31
	/* Don't create the handle until we need it */
dvander@790
    32
	if (m_hHandle == BAD_HANDLE)
dvander@790
    33
	{
dvander@790
    34
		m_hHandle = g_Menus.CreateStyleHandle(this);
dvander@790
    35
	}
dvander@790
    36
dvander@790
    37
	return m_hHandle;
dvander@775
    38
}
dvander@775
    39
dvander@775
    40
void BaseMenuStyle::AddClientToWatch(int client)
dvander@775
    41
{
dvander@970
    42
#if defined MENU_DEBUG
dvander@970
    43
	g_Logger.LogMessage("[SM_MENU] AddClientToWatch(%d)", client);
dvander@970
    44
#endif
dvander@775
    45
	m_WatchList.push_back(client);
dvander@775
    46
}
dvander@775
    47
dvander@775
    48
void BaseMenuStyle::RemoveClientFromWatch(int client)
dvander@775
    49
{
dvander@970
    50
#if defined MENU_DEBUG
dvander@970
    51
	g_Logger.LogMessage("[SM_MENU] RemoveClientFromWatch(%d)", client);
dvander@970
    52
#endif
dvander@775
    53
	m_WatchList.remove(client);
dvander@775
    54
}
dvander@775
    55
dvander@775
    56
void BaseMenuStyle::_CancelClientMenu(int client, bool bAutoIgnore/* =false */, MenuCancelReason reason/* =MenuCancel_Interrupt */)
dvander@775
    57
{
dvander@970
    58
#if defined MENU_DEBUG
dvander@970
    59
	g_Logger.LogMessage("[SM_MENU] _CancelClientMenu() (client %d) (bAutoIgnore %d) (reason %d)", client, bAutoIgnore, reason);
dvander@970
    60
#endif
dvander@775
    61
	CBaseMenuPlayer *player = GetMenuPlayer(client);
dvander@775
    62
	menu_states_t &states = player->states;
dvander@775
    63
dvander@775
    64
	bool bOldIgnore = player->bAutoIgnore;
dvander@775
    65
	if (bAutoIgnore)
dvander@775
    66
	{
dvander@775
    67
		player->bAutoIgnore = true;
dvander@775
    68
	}
dvander@775
    69
dvander@775
    70
	/* Save states */
dvander@775
    71
	IMenuHandler *mh = states.mh;
dvander@775
    72
	IBaseMenu *menu = states.menu;
dvander@775
    73
dvander@775
    74
	/* Clear menu */
dvander@775
    75
	player->bInMenu = false;
dvander@775
    76
	if (player->menuHoldTime)
dvander@775
    77
	{
dvander@775
    78
		RemoveClientFromWatch(client);
dvander@775
    79
	}
dvander@775
    80
dvander@775
    81
	/* Fire callbacks */
dvander@775
    82
	mh->OnMenuCancel(menu, client, reason);
dvander@790
    83
	
dvander@790
    84
	/* Only fire end if there's a valid menu */
dvander@790
    85
	if (menu)
dvander@790
    86
	{
dvander@790
    87
		mh->OnMenuEnd(menu);
dvander@790
    88
	}
dvander@775
    89
dvander@775
    90
	if (bAutoIgnore)
dvander@775
    91
	{
dvander@775
    92
		player->bAutoIgnore = bOldIgnore;
dvander@775
    93
	}
dvander@775
    94
}
dvander@775
    95
dvander@775
    96
void BaseMenuStyle::CancelMenu(CBaseMenu *menu)
dvander@775
    97
{
dvander@970
    98
#if defined MENU_DEBUG
dvander@970
    99
	g_Logger.LogMessage("[SM_MENU] CancelMenu() (menu %p)", menu);
dvander@970
   100
#endif
dvander@775
   101
	int maxClients = g_Players.GetMaxClients();
dvander@775
   102
	for (int i=1; i<=maxClients; i++)
dvander@775
   103
	{
dvander@775
   104
		CBaseMenuPlayer *player = GetMenuPlayer(i);
dvander@775
   105
		if (player->bInMenu)
dvander@775
   106
		{
dvander@775
   107
			menu_states_t &states = player->states;
dvander@775
   108
			if (states.menu == menu)
dvander@775
   109
			{
dvander@775
   110
				_CancelClientMenu(i);
dvander@775
   111
			}
dvander@775
   112
		}
dvander@775
   113
	}
dvander@775
   114
}
dvander@775
   115
dvander@775
   116
bool BaseMenuStyle::CancelClientMenu(int client, bool autoIgnore)
dvander@775
   117
{
dvander@970
   118
#if defined MENU_DEBUG
dvander@970
   119
	g_Logger.LogMessage("[SM_MENU] CancelClientMenu() (client %d) (bAutoIgnore %d)", client, autoIgnore);
dvander@970
   120
#endif
dvander@775
   121
	if (client < 1 || client > g_Players.MaxClients())
dvander@775
   122
	{
dvander@775
   123
		return false;
dvander@775
   124
	}
dvander@775
   125
dvander@775
   126
	CBaseMenuPlayer *player = GetMenuPlayer(client);
dvander@775
   127
	if (!player->bInMenu)
dvander@775
   128
	{
dvander@775
   129
		return false;
dvander@775
   130
	}
dvander@775
   131
dvander@775
   132
	_CancelClientMenu(client, autoIgnore);
dvander@775
   133
dvander@775
   134
	return true;
dvander@775
   135
}
dvander@775
   136
dvander@775
   137
MenuSource BaseMenuStyle::GetClientMenu(int client, void **object)
dvander@775
   138
{
dvander@775
   139
	if (client < 1 || client > g_Players.GetMaxClients())
dvander@775
   140
	{
dvander@775
   141
		return MenuSource_None;
dvander@775
   142
	}
dvander@775
   143
dvander@775
   144
	CBaseMenuPlayer *player = GetMenuPlayer(client);
dvander@775
   145
dvander@775
   146
	if (player->bInMenu)
dvander@775
   147
	{
dvander@775
   148
		IBaseMenu *menu;
dvander@775
   149
		if ((menu=player->states.menu) != NULL)
dvander@775
   150
		{
dvander@775
   151
			if (object)
dvander@775
   152
			{
dvander@775
   153
				*object = menu;
dvander@775
   154
			}
dvander@775
   155
			return MenuSource_BaseMenu;
dvander@775
   156
		}
dvander@775
   157
dvander@775
   158
		return MenuSource_Display;
dvander@780
   159
	} else if (player->bInExternMenu) {
dvander@782
   160
		if (player->menuHoldTime != 0
dvander@782
   161
			&& (gpGlobals->curtime > player->menuStartTime + player->menuHoldTime))
dvander@782
   162
		{
dvander@782
   163
			player->bInExternMenu = false;
dvander@782
   164
			return MenuSource_None;
dvander@782
   165
		}
dvander@780
   166
		return MenuSource_External;
dvander@775
   167
	}
dvander@775
   168
dvander@775
   169
	return MenuSource_None;
dvander@775
   170
}
dvander@775
   171
dvander@775
   172
void BaseMenuStyle::OnClientDisconnected(int client)
dvander@775
   173
{
dvander@970
   174
#if defined MENU_DEBUG
dvander@970
   175
	g_Logger.LogMessage("[SM_MENU] OnClientDisconnected(%d)", client);
dvander@970
   176
#endif
dvander@775
   177
	CBaseMenuPlayer *player = GetMenuPlayer(client);
dvander@775
   178
	if (!player->bInMenu)
dvander@775
   179
	{
dvander@775
   180
		return;
dvander@775
   181
	}
dvander@775
   182
dvander@775
   183
	_CancelClientMenu(client, true, MenuCancel_Disconnect);
dvander@775
   184
dvander@775
   185
	player->bInMenu = false;
dvander@790
   186
	player->bInExternMenu = false;
dvander@775
   187
}
dvander@775
   188
dvander@775
   189
static int do_lookup[256];
dvander@775
   190
void BaseMenuStyle::ProcessWatchList()
dvander@775
   191
{
dvander@775
   192
	if (!m_WatchList.size())
dvander@775
   193
	{
dvander@775
   194
		return;
dvander@775
   195
	}
dvander@775
   196
dvander@775
   197
	unsigned int total = 0;
dvander@775
   198
	for (FastLink<int>::iterator iter=m_WatchList.begin(); iter!=m_WatchList.end(); ++iter)
dvander@775
   199
	{
dvander@775
   200
		do_lookup[total++] = (*iter);
dvander@775
   201
	}
dvander@775
   202
dvander@970
   203
#if defined MENU_DEBUG
dvander@970
   204
	if (total)
dvander@970
   205
	{
dvander@970
   206
		g_Logger.LogMessage("[SM_MENU] ProcessWatchList() found %d clients", total);
dvander@970
   207
	}
dvander@970
   208
#endif
dvander@970
   209
dvander@775
   210
	int client;
dvander@775
   211
	CBaseMenuPlayer *player;
dvander@775
   212
	float curTime = gpGlobals->curtime;
dvander@775
   213
	for (unsigned int i=0; i<total; i++)
dvander@775
   214
	{
dvander@775
   215
		client = do_lookup[i];
dvander@775
   216
		player = GetMenuPlayer(client);
dvander@970
   217
#if defined MENU_DEBUG
dvander@970
   218
		g_Logger.LogMessage("[SM_MENU] ProcessWatchList() (client %d) (bInMenu %d) (menuHoldTime %d) (curTime %f) (menuStartTime %f)",
dvander@970
   219
			client,
dvander@970
   220
			player->bInMenu,
dvander@970
   221
			player->menuHoldTime,
dvander@970
   222
			curTime,
dvander@970
   223
			player->menuStartTime);
dvander@970
   224
#endif
dvander@775
   225
		if (!player->bInMenu || !player->menuHoldTime)
dvander@775
   226
		{
dvander@970
   227
#if defined MENU_DEBUG
dvander@970
   228
			g_Logger.LogMessage("[SM_MENU] ProcessWatchList() removing client %d", client);
dvander@970
   229
#endif
dvander@825
   230
			m_WatchList.remove(client);
dvander@775
   231
			continue;
dvander@775
   232
		}
dvander@775
   233
		if (curTime > player->menuStartTime + player->menuHoldTime)
dvander@775
   234
		{
dvander@775
   235
			_CancelClientMenu(client, false);
dvander@775
   236
		}
dvander@775
   237
	}
dvander@775
   238
}
dvander@775
   239
dvander@775
   240
void BaseMenuStyle::ClientPressedKey(int client, unsigned int key_press)
dvander@775
   241
{
dvander@970
   242
#if defined MENU_DEBUG
dvander@970
   243
	g_Logger.LogMessage("[SM_MENU] ClientPressedKey() (client %d) (key_press %d)", client, key_press);
dvander@970
   244
#endif
dvander@775
   245
	CBaseMenuPlayer *player = GetMenuPlayer(client);
dvander@775
   246
dvander@775
   247
	/* First question: Are we in a menu? */
dvander@775
   248
	if (!player->bInMenu)
dvander@775
   249
	{
dvander@775
   250
		return;
dvander@775
   251
	}
dvander@775
   252
dvander@775
   253
	bool cancel = false;
dvander@775
   254
	unsigned int item = 0;
dvander@775
   255
	MenuCancelReason reason = MenuCancel_Exit;
dvander@775
   256
	menu_states_t &states = player->states;
dvander@775
   257
dvander@775
   258
	assert(states.mh != NULL);
dvander@775
   259
dvander@775
   260
	if (states.menu == NULL)
dvander@775
   261
	{
dvander@775
   262
		item = key_press;
dvander@785
   263
	} else if (key_press < 1 || key_press > GetMaxPageItems()) {
dvander@775
   264
		cancel = true;
dvander@775
   265
	} else {
dvander@775
   266
		ItemSelection type = states.slots[key_press].type;
dvander@775
   267
dvander@775
   268
		/* For navigational items, we're going to redisplay */
dvander@775
   269
		if (type == ItemSel_Back)
dvander@775
   270
		{
dvander@775
   271
			if (!RedoClientMenu(client, ItemOrder_Descending))
dvander@775
   272
			{
dvander@775
   273
				cancel = true;
dvander@775
   274
				reason = MenuCancel_NoDisplay;
dvander@775
   275
			} else {
dvander@775
   276
				return;
dvander@775
   277
			}
dvander@775
   278
		} else if (type == ItemSel_Next) {
dvander@775
   279
			if (!RedoClientMenu(client, ItemOrder_Ascending))
dvander@775
   280
			{
dvander@775
   281
				cancel = true;						/* I like Saltines. */
dvander@775
   282
				reason = MenuCancel_NoDisplay;
dvander@775
   283
			} else {
dvander@775
   284
				return;
dvander@775
   285
			}
dvander@775
   286
		} else if (type == ItemSel_Exit || type == ItemSel_None) {
dvander@775
   287
			cancel = true;
dvander@775
   288
		} else {
dvander@775
   289
			item = states.slots[key_press].item;
dvander@775
   290
		}
dvander@775
   291
	}
dvander@775
   292
dvander@775
   293
	/* Save variables */
dvander@775
   294
	IMenuHandler *mh = states.mh;
dvander@775
   295
	IBaseMenu *menu = states.menu;
dvander@775
   296
dvander@775
   297
	/* Clear states */
dvander@775
   298
	player->bInMenu = false;
dvander@775
   299
	if (player->menuHoldTime)
dvander@775
   300
	{
dvander@883
   301
		RemoveClientFromWatch(client);
dvander@775
   302
	}
dvander@775
   303
dvander@775
   304
	if (cancel)
dvander@775
   305
	{
dvander@775
   306
		mh->OnMenuCancel(menu, client, reason);
dvander@775
   307
	} else {
dvander@775
   308
		mh->OnMenuSelect(menu, client, item);
dvander@775
   309
	}
dvander@775
   310
dvander@790
   311
	/* Only fire end for valid menus */
dvander@790
   312
	if (menu)
dvander@790
   313
	{
dvander@790
   314
		mh->OnMenuEnd(menu);
dvander@790
   315
	}
dvander@775
   316
}
dvander@775
   317
dvander@787
   318
bool BaseMenuStyle::DoClientMenu(int client, IMenuPanel *menu, IMenuHandler *mh, unsigned int time)
dvander@775
   319
{
dvander@970
   320
#if defined MENU_DEBUG
dvander@970
   321
	g_Logger.LogMessage("[SM_MENU] DoClientMenu() (client %d) (panel %p) (mh %p) (time %d)",
dvander@970
   322
		client,
dvander@970
   323
		menu,
dvander@970
   324
		mh,
dvander@970
   325
		time);
dvander@970
   326
#endif
dvander@775
   327
	CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
dvander@775
   328
	if (!pPlayer || pPlayer->IsFakeClient() || !pPlayer->IsInGame())
dvander@775
   329
	{
dvander@775
   330
		return false;
dvander@775
   331
	}
dvander@775
   332
dvander@775
   333
	CBaseMenuPlayer *player = GetMenuPlayer(client);
dvander@775
   334
	if (player->bAutoIgnore)
dvander@775
   335
	{
dvander@775
   336
		return false;
dvander@775
   337
	}
dvander@775
   338
dvander@775
   339
	/* For the duration of this, we are going to totally ignore whether
dvander@775
   340
	* the player is already in a menu or not (except to cancel the old one).
dvander@775
   341
	* Instead, we are simply going to ignore any further menu displays, so
dvander@775
   342
	* this display can't be interrupted.
dvander@775
   343
	*/
dvander@775
   344
	player->bAutoIgnore = true;
dvander@775
   345
dvander@775
   346
	/* Cancel any old menus */
dvander@775
   347
	menu_states_t &states = player->states;
dvander@775
   348
	if (player->bInMenu)
dvander@775
   349
	{
dvander@790
   350
		_CancelClientMenu(client, true);
dvander@775
   351
	}
dvander@775
   352
dvander@775
   353
	states.firstItem = 0;
dvander@775
   354
	states.lastItem = 0;
dvander@775
   355
	states.menu = NULL;
dvander@775
   356
	states.mh = mh;
dvander@775
   357
	states.apiVers = SMINTERFACE_MENUMANAGER_VERSION;
dvander@775
   358
	player->bInMenu = true;
dvander@790
   359
	player->bInExternMenu = false;
dvander@775
   360
	player->menuStartTime = gpGlobals->curtime;
dvander@775
   361
	player->menuHoldTime = time;
dvander@775
   362
dvander@775
   363
	if (time)
dvander@775
   364
	{
dvander@775
   365
		AddClientToWatch(client);
dvander@775
   366
	}
dvander@775
   367
dvander@775
   368
	/* Draw the display */
dvander@775
   369
	SendDisplay(client, menu);
dvander@775
   370
dvander@775
   371
	/* We can be interrupted again! */
dvander@775
   372
	player->bAutoIgnore = false;
dvander@775
   373
dvander@775
   374
	return true;
dvander@775
   375
}
dvander@775
   376
dvander@775
   377
bool BaseMenuStyle::DoClientMenu(int client, CBaseMenu *menu, IMenuHandler *mh, unsigned int time)
dvander@775
   378
{
dvander@970
   379
#if defined MENU_DEBUG
dvander@970
   380
	g_Logger.LogMessage("[SM_MENU] DoClientMenu() (client %d) (menu %p) (mh %p) (time %d)",
dvander@970
   381
		client,
dvander@970
   382
		menu,
dvander@970
   383
		mh,
dvander@970
   384
		time);
dvander@970
   385
#endif
dvander@775
   386
	mh->OnMenuStart(menu);
dvander@775
   387
dvander@775
   388
	CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
dvander@775
   389
	if (!pPlayer || pPlayer->IsFakeClient() || !pPlayer->IsInGame())
dvander@775
   390
	{
dvander@970
   391
#if defined MENU_DEBUG
dvander@970
   392
		g_Logger.LogMessage("[SM_MENU] DoClientMenu(): Failed to display to client %d", client);
dvander@970
   393
#endif
dvander@775
   394
		mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
dvander@775
   395
		mh->OnMenuEnd(menu);
dvander@775
   396
		return false;
dvander@775
   397
	}
dvander@775
   398
dvander@775
   399
	CBaseMenuPlayer *player = GetMenuPlayer(client);
dvander@775
   400
	if (player->bAutoIgnore)
dvander@775
   401
	{
dvander@970
   402
#if defined MENU_DEBUG
dvander@970
   403
		g_Logger.LogMessage("[SM_MENU] DoClientMenu(): Client %d is autoIgnoring", client);
dvander@970
   404
#endif
dvander@775
   405
		mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
dvander@775
   406
		mh->OnMenuEnd(menu);
dvander@775
   407
		return false;
dvander@775
   408
	}
dvander@775
   409
dvander@775
   410
	/* For the duration of this, we are going to totally ignore whether
dvander@775
   411
	* the player is already in a menu or not (except to cancel the old one).
dvander@775
   412
	* Instead, we are simply going to ignore any further menu displays, so
dvander@775
   413
	* this display can't be interrupted.
dvander@775
   414
	*/
dvander@775
   415
	player->bAutoIgnore = true;
dvander@775
   416
dvander@775
   417
	/* Cancel any old menus */
dvander@775
   418
	menu_states_t &states = player->states;
dvander@775
   419
	if (player->bInMenu)
dvander@775
   420
	{
dvander@970
   421
#if defined MENU_DEBUG
dvander@970
   422
		g_Logger.LogMessage("[SM_MENU] DoClientMenu(): Cancelling old menu to client %d", client);
dvander@970
   423
#endif
dvander@775
   424
		_CancelClientMenu(client, true);
dvander@775
   425
	}
dvander@775
   426
dvander@775
   427
	states.firstItem = 0;
dvander@775
   428
	states.lastItem = 0;
dvander@775
   429
	states.menu = menu;
dvander@775
   430
	states.mh = mh;
dvander@775
   431
	states.apiVers = SMINTERFACE_MENUMANAGER_VERSION;
dvander@775
   432
dvander@787
   433
	IMenuPanel *display = g_Menus.RenderMenu(client, states, ItemOrder_Ascending);
dvander@775
   434
	if (!display)
dvander@775
   435
	{
dvander@970
   436
#if defined MENU_DEBUG
dvander@970
   437
		g_Logger.LogMessage("[SM_MENU] DoClientMenu(): Failed to render to client %d", client);
dvander@970
   438
#endif
dvander@775
   439
		player->bAutoIgnore = false;
dvander@775
   440
		player->bInMenu = false;
dvander@775
   441
		mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
dvander@775
   442
		mh->OnMenuEnd(menu);
dvander@775
   443
		return false;
dvander@775
   444
	}
dvander@775
   445
dvander@775
   446
	/* Finally, set our states */
dvander@775
   447
	player->bInMenu = true;
dvander@790
   448
	player->bInExternMenu = false;
dvander@775
   449
	player->menuStartTime = gpGlobals->curtime;
dvander@775
   450
	player->menuHoldTime = time;
dvander@775
   451
dvander@775
   452
	if (time)
dvander@775
   453
	{
dvander@775
   454
		AddClientToWatch(client);
dvander@775
   455
	}
dvander@775
   456
dvander@775
   457
	/* Draw the display */
dvander@775
   458
	SendDisplay(client, display);
dvander@775
   459
dvander@775
   460
	/* Free the display pointer */
dvander@776
   461
	display->DeleteThis();
dvander@775
   462
dvander@775
   463
	/* We can be interrupted again! */
dvander@775
   464
	player->bAutoIgnore = false;
dvander@775
   465
dvander@970
   466
#if defined MENU_DEBUG
dvander@970
   467
	g_Logger.LogMessage("[SM_MENU] DoClientMenu() finished successfully (client %d)", client);
dvander@970
   468
#endif
dvander@970
   469
dvander@775
   470
	return true;
dvander@775
   471
}
dvander@775
   472
dvander@775
   473
bool BaseMenuStyle::RedoClientMenu(int client, ItemOrder order)
dvander@775
   474
{
dvander@970
   475
#if defined MENU_DEBUG
dvander@970
   476
	g_Logger.LogMessage("[SM_MENU] RedoClientMenu() (client %d) (order %d)", client, order);
dvander@970
   477
#endif
dvander@775
   478
	CBaseMenuPlayer *player = GetMenuPlayer(client);
dvander@775
   479
	menu_states_t &states = player->states;
dvander@775
   480
dvander@775
   481
	player->bAutoIgnore = true;
dvander@787
   482
	IMenuPanel *display = g_Menus.RenderMenu(client, states, order);
dvander@775
   483
	if (!display)
dvander@775
   484
	{
dvander@970
   485
#if defined MENU_DEBUG
dvander@970
   486
		g_Logger.LogMessage("[SM_MENU] RedoClientMenu(): Failed to render menu");
dvander@970
   487
#endif
dvander@775
   488
		if (player->menuHoldTime)
dvander@775
   489
		{
dvander@883
   490
			RemoveClientFromWatch(client);
dvander@775
   491
		}
dvander@775
   492
		player->bAutoIgnore = false;
dvander@775
   493
		return false;
dvander@775
   494
	}
dvander@775
   495
dvander@775
   496
	SendDisplay(client, display);
dvander@775
   497
dvander@776
   498
	display->DeleteThis();
dvander@775
   499
dvander@775
   500
	player->bAutoIgnore = false;
dvander@775
   501
dvander@970
   502
#if defined MENU_DEBUG
dvander@970
   503
	g_Logger.LogMessage("[SM_MENU] RedoClientMenu(): Succeeded to client %d", client);
dvander@970
   504
#endif
dvander@970
   505
dvander@775
   506
	return true;
dvander@775
   507
}
dvander@769
   508
dvander@790
   509
CBaseMenu::CBaseMenu(IMenuHandler *pHandler, IMenuStyle *pStyle, IdentityToken_t *pOwner) : 
dvander@790
   510
m_pStyle(pStyle), m_Strings(512), m_Pagination(7), m_ExitButton(true), 
dvander@790
   511
m_bShouldDelete(false), m_bCancelling(false), m_pOwner(pOwner ? pOwner : g_pCoreIdent), 
dvander@877
   512
m_bDeleting(false), m_bWillFreeHandle(false), m_hHandle(BAD_HANDLE), m_pHandler(pHandler),
dvander@877
   513
m_pVoteHandler(NULL)
dvander@769
   514
{
dvander@769
   515
}
dvander@769
   516
dvander@769
   517
CBaseMenu::~CBaseMenu()
dvander@769
   518
{
dvander@877
   519
	g_Menus.ReleaseVoteWrapper(m_pVoteHandler);
dvander@769
   520
}
dvander@769
   521
dvander@790
   522
Handle_t CBaseMenu::GetHandle()
dvander@790
   523
{
dvander@790
   524
	if (!m_hHandle)
dvander@790
   525
	{
dvander@790
   526
		m_hHandle = g_Menus.CreateMenuHandle(this, m_pOwner);
dvander@790
   527
	}
dvander@790
   528
dvander@790
   529
	return m_hHandle;
dvander@790
   530
}
dvander@790
   531
dvander@769
   532
bool CBaseMenu::AppendItem(const char *info, const ItemDrawInfo &draw)
dvander@769
   533
{
dvander@778
   534
	if (m_Pagination == (unsigned)MENU_NO_PAGINATION
dvander@769
   535
		&& m_items.size() >= m_pStyle->GetMaxPageItems())
dvander@769
   536
	{
dvander@769
   537
		return false;
dvander@769
   538
	}
dvander@769
   539
dvander@769
   540
	CItem item;
dvander@769
   541
dvander@769
   542
	item.infoString = m_Strings.AddString(info);
dvander@769
   543
	if (draw.display)
dvander@769
   544
	{
dvander@769
   545
		item.displayString = m_Strings.AddString(draw.display);
dvander@769
   546
	}
dvander@769
   547
	item.style = draw.style;
dvander@769
   548
dvander@769
   549
dvander@769
   550
	m_items.push_back(item);
dvander@769
   551
dvander@769
   552
	return true;
dvander@769
   553
}
dvander@769
   554
dvander@769
   555
bool CBaseMenu::InsertItem(unsigned int position, const char *info, const ItemDrawInfo &draw)
dvander@769
   556
{
dvander@778
   557
	if (m_Pagination == (unsigned)MENU_NO_PAGINATION
dvander@769
   558
		&& m_items.size() >= m_pStyle->GetMaxPageItems())
dvander@769
   559
	{
dvander@769
   560
		return false;
dvander@769
   561
	}
dvander@769
   562
dvander@769
   563
	if (position >= m_items.size())
dvander@769
   564
	{
dvander@769
   565
		return false;
dvander@769
   566
	}
dvander@769
   567
dvander@769
   568
	CItem item;
dvander@769
   569
	item.infoString = m_Strings.AddString(info);
dvander@769
   570
	if (draw.display)
dvander@769
   571
	{
dvander@769
   572
		item.displayString = m_Strings.AddString(draw.display);
dvander@769
   573
	}
dvander@769
   574
	item.style = draw.style;
dvander@769
   575
dvander@769
   576
	CVector<CItem>::iterator iter = m_items.iterAt(position);
dvander@769
   577
	m_items.insert(iter, item);
dvander@769
   578
dvander@769
   579
	return true;
dvander@769
   580
}
dvander@769
   581
dvander@769
   582
bool CBaseMenu::RemoveItem(unsigned int position)
dvander@769
   583
{
dvander@769
   584
	if (position >= m_items.size())
dvander@769
   585
	{
dvander@769
   586
		return false;
dvander@769
   587
	}
dvander@769
   588
dvander@769
   589
	m_items.erase(m_items.iterAt(position));
dvander@769
   590
dvander@769
   591
	if (m_items.size() == 0)
dvander@769
   592
	{
dvander@769
   593
		m_Strings.Reset();
dvander@769
   594
	}
dvander@769
   595
dvander@769
   596
	return true;
dvander@769
   597
}
dvander@769
   598
dvander@769
   599
void CBaseMenu::RemoveAllItems()
dvander@769
   600
{
dvander@769
   601
	m_items.clear();
dvander@769
   602
	m_Strings.Reset();
dvander@769
   603
}
dvander@769
   604
dvander@769
   605
const char *CBaseMenu::GetItemInfo(unsigned int position, ItemDrawInfo *draw/* =NULL */)
dvander@769
   606
{
dvander@769
   607
	if (position >= m_items.size())
dvander@769
   608
	{
dvander@769
   609
		return NULL;
dvander@769
   610
	}
dvander@769
   611
dvander@769
   612
	if (draw)
dvander@769
   613
	{
dvander@769
   614
		draw->display = m_Strings.GetString(m_items[position].displayString);
dvander@769
   615
		draw->style = m_items[position].style;
dvander@769
   616
	}
dvander@769
   617
dvander@769
   618
	return m_Strings.GetString(m_items[position].infoString);
dvander@769
   619
}
dvander@769
   620
dvander@769
   621
unsigned int CBaseMenu::GetItemCount()
dvander@769
   622
{
dvander@769
   623
	return m_items.size();
dvander@769
   624
}
dvander@769
   625
dvander@769
   626
bool CBaseMenu::SetPagination(unsigned int itemsPerPage)
dvander@769
   627
{
dvander@820
   628
	if (itemsPerPage > 7 || itemsPerPage == 1)
dvander@769
   629
	{
dvander@769
   630
		return false;
dvander@769
   631
	}
dvander@769
   632
dvander@769
   633
	m_Pagination = itemsPerPage;
dvander@769
   634
dvander@769
   635
	return true;
dvander@769
   636
}
dvander@769
   637
dvander@769
   638
unsigned int CBaseMenu::GetPagination()
dvander@769
   639
{
dvander@769
   640
	return m_Pagination;
dvander@769
   641
}
dvander@769
   642
dvander@769
   643
IMenuStyle *CBaseMenu::GetDrawStyle()
dvander@769
   644
{
dvander@769
   645
	return m_pStyle;
dvander@769
   646
}
dvander@769
   647
dvander@769
   648
void CBaseMenu::SetDefaultTitle(const char *message)
dvander@769
   649
{
dvander@769
   650
	m_Title.assign(message);
dvander@769
   651
}
dvander@769
   652
dvander@769
   653
const char *CBaseMenu::GetDefaultTitle()
dvander@769
   654
{
dvander@769
   655
	return m_Title.c_str();
dvander@769
   656
}
dvander@769
   657
dvander@769
   658
bool CBaseMenu::GetExitButton()
dvander@769
   659
{
dvander@769
   660
	return m_ExitButton;
dvander@769
   661
}
dvander@769
   662
dvander@769
   663
bool CBaseMenu::SetExitButton(bool set)
dvander@769
   664
{
dvander@769
   665
	m_ExitButton = set;
dvander@769
   666
	return true;
dvander@769
   667
}
dvander@775
   668
dvander@775
   669
void CBaseMenu::Cancel()
dvander@775
   670
{
dvander@775
   671
	if (m_bCancelling)
dvander@775
   672
	{
dvander@775
   673
		return;
dvander@775
   674
	}
dvander@775
   675
dvander@970
   676
#if defined MENU_DEBUG
dvander@970
   677
	g_Logger.LogMessage("[SM_MENU] CBaseMenu::Cancel(%p) (m_pVote %p) (inVote %d) (m_bShouldDelete %d)",
dvander@970
   678
		this,
dvander@970
   679
		m_pVoteHandler,
dvander@970
   680
		m_pVoteHandler ? m_pVoteHandler->IsVoteInProgress() : false,
dvander@970
   681
		m_bShouldDelete);
dvander@970
   682
#endif
dvander@970
   683
dvander@959
   684
	if (m_pVoteHandler && m_pVoteHandler->IsVoteInProgress())
dvander@959
   685
	{
dvander@959
   686
		m_pVoteHandler->CancelVoting();
dvander@959
   687
	}
dvander@959
   688
dvander@775
   689
	m_bCancelling = true;
dvander@775
   690
	Cancel_Finally();
dvander@775
   691
	m_bCancelling = false;
dvander@775
   692
dvander@775
   693
	if (m_bShouldDelete)
dvander@775
   694
	{
dvander@790
   695
		InternalDelete();
dvander@775
   696
	}
dvander@775
   697
}
dvander@775
   698
dvander@790
   699
void CBaseMenu::Destroy(bool releaseHandle)
dvander@775
   700
{
dvander@790
   701
	/* Check if we shouldn't be here */
dvander@790
   702
	if (m_bDeleting)
dvander@790
   703
	{
dvander@790
   704
		return;
dvander@790
   705
	}
dvander@790
   706
dvander@970
   707
#if defined MENU_DEBUG
dvander@970
   708
	g_Logger.LogMessage("[SM_MENU] CBaseMenu::Destroy(%p) (release %d) (m_bCancelling %d) (m_bShouldDelete %d)",
dvander@970
   709
		this,
dvander@970
   710
		releaseHandle,
dvander@970
   711
		m_bCancelling,
dvander@970
   712
		m_bShouldDelete);
dvander@970
   713
#endif
dvander@970
   714
dvander@790
   715
	/* Save the destruction hint about our handle */
dvander@790
   716
	m_bWillFreeHandle = releaseHandle;
dvander@790
   717
dvander@790
   718
	/* Now actually do stuff */
dvander@775
   719
	if (!m_bCancelling || m_bShouldDelete)
dvander@775
   720
	{
dvander@775
   721
		Cancel();
dvander@790
   722
		InternalDelete();
dvander@775
   723
	} else {
dvander@775
   724
		m_bShouldDelete = true;
dvander@775
   725
	}
dvander@775
   726
}
dvander@775
   727
dvander@790
   728
void CBaseMenu::InternalDelete()
dvander@790
   729
{
dvander@790
   730
	if (m_bWillFreeHandle && m_hHandle != BAD_HANDLE)
dvander@790
   731
	{
dvander@790
   732
		Handle_t hndl = m_hHandle;
dvander@790
   733
		HandleSecurity sec;
dvander@790
   734
dvander@790
   735
		sec.pOwner = m_pOwner;
dvander@790
   736
		sec.pIdentity = g_pCoreIdent;
dvander@790
   737
dvander@790
   738
		m_hHandle = BAD_HANDLE;
dvander@790
   739
		m_bDeleting = true;
dvander@790
   740
		g_HandleSys.FreeHandle(hndl, &sec);
dvander@790
   741
	}
dvander@790
   742
dvander@790
   743
	m_pHandler->OnMenuDestroy(this);
dvander@790
   744
dvander@790
   745
	delete this;
dvander@790
   746
}
dvander@790
   747
dvander@877
   748
bool CBaseMenu::BroadcastVote(int clients[], 
dvander@877
   749
							  unsigned int numClients, 
dvander@877
   750
							  unsigned int maxTime,
dvander@877
   751
							  unsigned int flags)
dvander@877
   752
{
dvander@970
   753
#if defined MENU_DEBUG
dvander@970
   754
	g_Logger.LogMessage("[SM_MENU] CBaseMenu::BroadcastVote(%p) (maxTime %d) (numClients %d) (m_pVote %p) (inVote %d)",
dvander@970
   755
		this,
dvander@970
   756
		maxTime,
dvander@970
   757
		numClients,
dvander@970
   758
		m_pVoteHandler,
dvander@970
   759
		m_pVoteHandler ? m_pVoteHandler->IsVoteInProgress() : false);
dvander@970
   760
#endif
dvander@877
   761
	if (!m_pVoteHandler)
dvander@877
   762
	{
dvander@877
   763
		m_pVoteHandler = g_Menus.CreateVoteWrapper(m_pHandler);
dvander@877
   764
	} else if (m_pVoteHandler->IsVoteInProgress()) {
dvander@877
   765
		return false;
dvander@877
   766
	}
dvander@877
   767
dvander@877
   768
	m_pVoteHandler->InitializeVoting(this);
dvander@877
   769
dvander@877
   770
	for (unsigned int i=0; i<numClients; i++)
dvander@877
   771
	{
dvander@877
   772
		VoteDisplay(clients[i], maxTime);
dvander@877
   773
	}
dvander@877
   774
dvander@877
   775
	m_pVoteHandler->StartVoting();
dvander@879
   776
dvander@879
   777
	return true;
dvander@877
   778
}
dvander@879
   779
dvander@884
   780
bool CBaseMenu::IsVoteInProgress()
dvander@884
   781
{
dvander@884
   782
	return (m_pVoteHandler && m_pVoteHandler->IsVoteInProgress());
dvander@884
   783
}