core/MenuManager.cpp
author David Anderson <dvander@alliedmods.net>
Tue Jul 31 18:56:55 2007 +0000 (2007-07-31)
changeset 1220 4f111b467bfa
parent 1163 0bb03cb6277b
child 1231 17badaf66ce4
permissions -rw-r--r--
added amb704 (menu sound support)
dvander@773
     1
/**
dvander@773
     2
 * vim: set ts=4 :
dvander@773
     3
 * ===============================================================
dvander@773
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@773
     5
 * ===============================================================
dvander@773
     6
 *
dvander@773
     7
 * This file is not open source and may not be copied without explicit
dvander@773
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@773
     9
 * in whole or significant part.
dvander@773
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@773
    11
 *
dvander@773
    12
 * Version: $Id$
dvander@773
    13
 */
dvander@773
    14
dvander@877
    15
#include <time.h>
dvander@769
    16
#include <stdarg.h>
dvander@877
    17
#include <stdlib.h>
dvander@769
    18
#include "MenuManager.h"
dvander@769
    19
#include "sm_stringutil.h"
dvander@769
    20
#include "sourcemm_api.h"
dvander@769
    21
#include "PlayerManager.h"
dvander@769
    22
#include "MenuStyle_Valve.h"
dvander@781
    23
#include "ShareSys.h"
dvander@790
    24
#include "HandleSys.h"
dvander@1220
    25
#include "sourcemm_api.h"
dvander@769
    26
dvander@769
    27
MenuManager g_Menus;
dvander@769
    28
dvander@1220
    29
ConVar sm_menu_sounds("sm_menu_sounds", "1", 0, "Sets whether SourceMod menus play trigger sounds");
dvander@1220
    30
dvander@877
    31
/*******************************
dvander@877
    32
 *******************************
dvander@877
    33
 ******** VOTE HANDLER *********
dvander@877
    34
 *******************************
dvander@877
    35
 *******************************/
dvander@769
    36
dvander@877
    37
unsigned int VoteMenuHandler::GetMenuAPIVersion2()
dvander@769
    38
{
dvander@769
    39
	return m_pHandler->GetMenuAPIVersion2();
dvander@769
    40
}
dvander@769
    41
dvander@877
    42
bool VoteMenuHandler::IsVoteInProgress()
dvander@877
    43
{
dvander@877
    44
	return (m_pCurMenu != NULL);
dvander@877
    45
}
dvander@877
    46
dvander@877
    47
void VoteMenuHandler::InitializeVoting(IBaseMenu *menu)
dvander@877
    48
{
dvander@877
    49
	m_Items = menu->GetItemCount();
dvander@877
    50
dvander@877
    51
	if (m_Votes.size() < (size_t)m_Items)
dvander@877
    52
	{
dvander@877
    53
		/* Only clear the items we need to... */
dvander@877
    54
		size_t size = m_Votes.size();
dvander@877
    55
		for (size_t i=0; i<size; i++)
dvander@877
    56
		{
dvander@877
    57
			m_Votes[i] = 0;
dvander@877
    58
		}
dvander@877
    59
		m_Votes.resize(m_Items, 0);
dvander@877
    60
	} else {
dvander@877
    61
		for (unsigned int i=0; i<m_Items; i++)
dvander@877
    62
		{
dvander@877
    63
			m_Votes[i] = 0;
dvander@877
    64
		}
dvander@877
    65
	}
dvander@877
    66
dvander@877
    67
	m_pCurMenu = menu;
dvander@877
    68
dvander@877
    69
	m_pHandler->OnMenuStart(m_pCurMenu);
dvander@877
    70
}
dvander@877
    71
dvander@877
    72
void VoteMenuHandler::StartVoting()
dvander@877
    73
{
dvander@877
    74
	m_bStarted = true;
dvander@877
    75
dvander@877
    76
	m_pHandler->OnMenuVoteStart(m_pCurMenu);
dvander@877
    77
dvander@877
    78
	/* By now we know how many clients were set.  
dvander@877
    79
	 * If there are none, we should end IMMEDIATELY.
dvander@877
    80
	 */
dvander@877
    81
	if (m_Clients == 0)
dvander@877
    82
	{
dvander@877
    83
		EndVoting();
dvander@877
    84
	}
dvander@877
    85
}
dvander@877
    86
dvander@877
    87
void VoteMenuHandler::DecrementPlayerCount()
dvander@877
    88
{
dvander@877
    89
	assert(m_Clients > 0);
dvander@877
    90
dvander@877
    91
	m_Clients--;
dvander@877
    92
dvander@877
    93
	if (m_bStarted && m_Clients == 0)
dvander@877
    94
	{
dvander@877
    95
		EndVoting();
dvander@877
    96
	}
dvander@877
    97
}
dvander@877
    98
dvander@877
    99
void VoteMenuHandler::EndVoting()
dvander@877
   100
{
dvander@884
   101
	if (m_bCancelled)
dvander@884
   102
	{
dvander@884
   103
		/* If we were cancelled, don't bother tabulating anything.
dvander@884
   104
		 * Reset just in case someone tries to redraw, which means
dvander@884
   105
		 * we need to save our states.
dvander@884
   106
		 */
dvander@884
   107
		IBaseMenu *menu = m_pCurMenu;
dvander@884
   108
		InternalReset();
dvander@884
   109
		m_pHandler->OnMenuVoteCancel(menu);
dvander@997
   110
		m_pHandler->OnMenuEnd(menu, MenuEnd_VotingCancelled);
dvander@884
   111
		return;
dvander@884
   112
	}
dvander@884
   113
dvander@877
   114
	unsigned int chosen = 0;
dvander@882
   115
	unsigned int highest = 0;
dvander@879
   116
	unsigned int dup_count = 0;
dvander@962
   117
	unsigned int total = m_Votes.size() ? m_Votes[0] : 0;
dvander@877
   118
dvander@877
   119
	/* If we got zero votes, take a shortcut. */
dvander@877
   120
	if (m_NumVotes == 0)
dvander@877
   121
	{
dvander@877
   122
		/* Pick a random item and then jump far, far away. */
dvander@877
   123
		srand((unsigned int)(time(NULL)));
dvander@884
   124
		chosen = (unsigned int)rand() % m_Items;
dvander@877
   125
		goto picked_item;
dvander@877
   126
	}
dvander@877
   127
dvander@877
   128
	/* We can't have more dups than this!
dvander@877
   129
	 * This is the max number of players.
dvander@877
   130
	 */
dvander@877
   131
	unsigned int dup_array[256];
dvander@877
   132
dvander@882
   133
	for (size_t i=1; i<m_Items; i++)
dvander@877
   134
	{
dvander@877
   135
		if (m_Votes[i] > m_Votes[highest])
dvander@877
   136
		{
dvander@877
   137
			/* If we have a new highest count, mark it and trash the duplicate
dvander@877
   138
			 * list by setting the total to 0.
dvander@877
   139
			 */
dvander@877
   140
			highest = i;
dvander@877
   141
			dup_count = 0;
dvander@877
   142
		} else if (m_Votes[i] == m_Votes[highest]) {
dvander@877
   143
			/* If they're equal, mark it in the duplicate list.
dvander@877
   144
			 * We'll add in the original later.
dvander@877
   145
			 */
dvander@877
   146
			dup_array[dup_count++] = i;
dvander@877
   147
		}
dvander@960
   148
		total += m_Votes[i];
dvander@877
   149
	}
dvander@877
   150
dvander@877
   151
	/* Check if we need to pick from the duplicate list */
dvander@877
   152
	if (dup_count)
dvander@877
   153
	{
dvander@877
   154
		/* Re-add the original to the list because it's not in there. */
dvander@882
   155
		dup_array[dup_count++] = highest;
dvander@877
   156
dvander@877
   157
		/* Pick a random slot. */
dvander@877
   158
		srand((unsigned int)(time(NULL)));
dvander@877
   159
		unsigned int r = (unsigned int)rand() % dup_count;
dvander@877
   160
dvander@877
   161
		/* Pick the item. */
dvander@877
   162
		chosen = dup_array[r];
dvander@877
   163
	} else {
dvander@882
   164
		chosen = highest;
dvander@877
   165
	}
dvander@877
   166
dvander@877
   167
picked_item:
dvander@960
   168
	m_pHandler->OnMenuVoteEnd(m_pCurMenu, chosen, m_Votes[highest], total);
dvander@997
   169
	m_pHandler->OnMenuEnd(m_pCurMenu, MenuEnd_VotingDone);
dvander@877
   170
	InternalReset();
dvander@877
   171
}
dvander@877
   172
dvander@877
   173
void VoteMenuHandler::OnMenuStart(IBaseMenu *menu)
dvander@877
   174
{
dvander@877
   175
	m_Clients++;
dvander@877
   176
}
dvander@877
   177
dvander@997
   178
void VoteMenuHandler::OnMenuEnd(IBaseMenu *menu, MenuEndReason reason)
dvander@877
   179
{
dvander@877
   180
	DecrementPlayerCount();
dvander@877
   181
}
dvander@877
   182
dvander@877
   183
void VoteMenuHandler::OnMenuCancel(IBaseMenu *menu, int client, MenuCancelReason reason)
dvander@769
   184
{
dvander@769
   185
	m_pHandler->OnMenuCancel(menu, client, reason);
dvander@769
   186
}
dvander@769
   187
dvander@877
   188
void VoteMenuHandler::OnMenuDisplay(IBaseMenu *menu, int client, IMenuPanel *display)
dvander@769
   189
{
dvander@769
   190
	m_pHandler->OnMenuDisplay(menu, client, display);
dvander@769
   191
}
dvander@769
   192
dvander@1163
   193
unsigned int VoteMenuHandler::OnMenuDisplayItem(IBaseMenu *menu, int client, IMenuPanel *panel, unsigned int item, const ItemDrawInfo &dr)
dvander@769
   194
{
dvander@1163
   195
	return m_pHandler->OnMenuDisplayItem(menu, client, panel, item, dr);
dvander@877
   196
}
dvander@877
   197
dvander@877
   198
void VoteMenuHandler::OnMenuDrawItem(IBaseMenu *menu, int client, unsigned int item, unsigned int &style)
dvander@877
   199
{
dvander@877
   200
	m_pHandler->OnMenuDrawItem(menu, client, item, style);
dvander@769
   201
}
dvander@769
   202
dvander@877
   203
void VoteMenuHandler::OnMenuSelect(IBaseMenu *menu, int client, unsigned int item)
dvander@769
   204
{
dvander@877
   205
	/* Check by our item count, NOT the vote array size */
dvander@877
   206
	if (item < m_Items)
dvander@877
   207
	{
dvander@877
   208
		m_Votes[item]++;
dvander@877
   209
		m_NumVotes++;
dvander@877
   210
	}
dvander@877
   211
dvander@769
   212
	m_pHandler->OnMenuSelect(menu, client, item);
dvander@769
   213
}
dvander@769
   214
dvander@877
   215
void VoteMenuHandler::Reset(IMenuHandler *mh)
dvander@769
   216
{
dvander@877
   217
	m_pHandler = mh;
dvander@877
   218
	InternalReset();
dvander@769
   219
}
dvander@769
   220
dvander@877
   221
void VoteMenuHandler::InternalReset()
dvander@769
   222
{
dvander@877
   223
	m_Clients = 0;
dvander@877
   224
	m_Items = 0;
dvander@877
   225
	m_bStarted = false;
dvander@877
   226
	m_pCurMenu = NULL;
dvander@877
   227
	m_NumVotes = 0;
dvander@884
   228
	m_bCancelled = false;
dvander@884
   229
}
dvander@884
   230
dvander@884
   231
void VoteMenuHandler::CancelVoting()
dvander@884
   232
{
dvander@884
   233
	m_bCancelled = true;
dvander@769
   234
}
dvander@769
   235
dvander@769
   236
/*******************************
dvander@769
   237
 *******************************
dvander@769
   238
 ******** MENU MANAGER *********
dvander@769
   239
 *******************************
dvander@769
   240
 *******************************/
dvander@769
   241
dvander@769
   242
MenuManager::MenuManager()
dvander@769
   243
{
dvander@780
   244
	m_Styles.push_back(&g_ValveMenuStyle);
dvander@780
   245
	SetDefaultStyle(&g_ValveMenuStyle);
dvander@769
   246
}
dvander@769
   247
dvander@769
   248
void MenuManager::OnSourceModAllInitialized()
dvander@769
   249
{
dvander@781
   250
	g_ShareSys.AddInterface(NULL, this);
dvander@790
   251
dvander@790
   252
	HandleAccess access;
dvander@790
   253
	g_HandleSys.InitAccessDefaults(NULL, &access);
dvander@790
   254
dvander@790
   255
	/* Deny cloning to menus */
dvander@790
   256
	access.access[HandleAccess_Clone] = HANDLE_RESTRICT_OWNER|HANDLE_RESTRICT_IDENTITY;
dvander@790
   257
	m_MenuType = g_HandleSys.CreateType("IBaseMenu", this, 0, NULL, &access, g_pCoreIdent, NULL);
dvander@790
   258
dvander@790
   259
	/* Also deny deletion to styles */
dvander@790
   260
	access.access[HandleAccess_Delete] = HANDLE_RESTRICT_OWNER|HANDLE_RESTRICT_IDENTITY;
dvander@790
   261
	m_StyleType = g_HandleSys.CreateType("IMenuStyle", this, 0, NULL, &access, g_pCoreIdent, NULL);
dvander@769
   262
}
dvander@769
   263
dvander@769
   264
void MenuManager::OnSourceModAllShutdown()
dvander@769
   265
{
dvander@790
   266
	g_HandleSys.RemoveType(m_MenuType, g_pCoreIdent);
dvander@790
   267
	g_HandleSys.RemoveType(m_StyleType, g_pCoreIdent);
dvander@790
   268
dvander@769
   269
	while (!m_VoteHandlers.empty())
dvander@769
   270
	{
dvander@769
   271
		delete m_VoteHandlers.front();
dvander@769
   272
		m_VoteHandlers.pop();
dvander@769
   273
	}
dvander@769
   274
}
dvander@769
   275
dvander@790
   276
void MenuManager::OnHandleDestroy(HandleType_t type, void *object)
dvander@790
   277
{
dvander@790
   278
	if (type == m_MenuType)
dvander@790
   279
	{
dvander@790
   280
		IBaseMenu *menu = (IBaseMenu *)object;
dvander@790
   281
		menu->Destroy(false);
dvander@790
   282
	} else if (type == m_StyleType) {
dvander@790
   283
		/* Do nothing */
dvander@790
   284
	}
dvander@790
   285
}
dvander@790
   286
dvander@790
   287
Handle_t MenuManager::CreateMenuHandle(IBaseMenu *menu, IdentityToken_t *pOwner)
dvander@790
   288
{
dvander@790
   289
	if (m_MenuType == NO_HANDLE_TYPE)
dvander@790
   290
	{
dvander@790
   291
		return BAD_HANDLE;
dvander@790
   292
	}
dvander@790
   293
dvander@790
   294
	return g_HandleSys.CreateHandle(m_MenuType, menu, pOwner, g_pCoreIdent, NULL);
dvander@790
   295
}
dvander@790
   296
dvander@790
   297
Handle_t MenuManager::CreateStyleHandle(IMenuStyle *style)
dvander@790
   298
{
dvander@790
   299
	if (m_StyleType == NO_HANDLE_TYPE)
dvander@790
   300
	{
dvander@790
   301
		return BAD_HANDLE;
dvander@790
   302
	}
dvander@790
   303
dvander@790
   304
	return g_HandleSys.CreateHandle(m_StyleType, style, g_pCoreIdent, g_pCoreIdent, NULL);
dvander@790
   305
}
dvander@790
   306
dvander@790
   307
HandleError MenuManager::ReadMenuHandle(Handle_t handle, IBaseMenu **menu)
dvander@790
   308
{
dvander@790
   309
	HandleSecurity sec;
dvander@790
   310
dvander@790
   311
	sec.pIdentity = g_pCoreIdent;
dvander@790
   312
	sec.pOwner = NULL;
dvander@790
   313
dvander@790
   314
	return g_HandleSys.ReadHandle(handle, m_MenuType, &sec, (void **)menu);
dvander@790
   315
}
dvander@790
   316
dvander@790
   317
HandleError MenuManager::ReadStyleHandle(Handle_t handle, IMenuStyle **style)
dvander@790
   318
{
dvander@790
   319
	HandleSecurity sec;
dvander@790
   320
dvander@790
   321
	sec.pIdentity = g_pCoreIdent;
dvander@790
   322
	sec.pOwner = g_pCoreIdent;
dvander@790
   323
dvander@790
   324
	return g_HandleSys.ReadHandle(handle, m_StyleType, &sec, (void **)style);
dvander@790
   325
}
dvander@790
   326
dvander@769
   327
bool MenuManager::SetDefaultStyle(IMenuStyle *style)
dvander@769
   328
{
dvander@769
   329
	if (!style)
dvander@769
   330
	{
dvander@769
   331
		return false;
dvander@769
   332
	}
dvander@769
   333
dvander@769
   334
	m_pDefaultStyle = style;
dvander@769
   335
dvander@769
   336
	return true;
dvander@769
   337
}
dvander@769
   338
dvander@769
   339
IMenuStyle *MenuManager::GetStyle(unsigned int index)
dvander@769
   340
{
dvander@769
   341
	if (index >= GetStyleCount())
dvander@769
   342
	{
dvander@769
   343
		return NULL;
dvander@769
   344
	}
dvander@769
   345
dvander@769
   346
	return m_Styles[index];
dvander@769
   347
}
dvander@769
   348
dvander@780
   349
void MenuManager::AddStyle(IMenuStyle *style)
dvander@780
   350
{
dvander@780
   351
	m_Styles.push_back(style);
dvander@780
   352
}
dvander@780
   353
dvander@769
   354
unsigned int MenuManager::GetStyleCount()
dvander@769
   355
{
dvander@769
   356
	return (unsigned int)m_Styles.size();
dvander@769
   357
}
dvander@769
   358
dvander@769
   359
IMenuStyle *MenuManager::FindStyleByName(const char *name)
dvander@769
   360
{
dvander@769
   361
	unsigned int count = GetStyleCount();
dvander@769
   362
	for (unsigned int i=0; i<count; i++)
dvander@769
   363
	{
dvander@769
   364
		IMenuStyle *ptr = GetStyle(i);
dvander@769
   365
		if (strcasecmp(ptr->GetStyleName(), name) == 0)
dvander@769
   366
		{
dvander@769
   367
			return ptr;
dvander@769
   368
		}
dvander@769
   369
	}
dvander@769
   370
dvander@769
   371
	return NULL;
dvander@769
   372
}
dvander@769
   373
dvander@787
   374
inline bool IsSlotItem(IMenuPanel *display,
dvander@769
   375
					   unsigned int style)
dvander@769
   376
{
dvander@769
   377
	if (!display->CanDrawItem(style))
dvander@769
   378
	{
dvander@769
   379
	return false;
dvander@769
   380
	}
dvander@769
   381
	if ((style & ITEMDRAW_IGNORE) == ITEMDRAW_IGNORE)
dvander@769
   382
	{
dvander@769
   383
		return false;
dvander@769
   384
	}
dvander@769
   385
	if (style & ITEMDRAW_RAWLINE)
dvander@769
   386
	{
dvander@769
   387
		return false;
dvander@769
   388
	}
dvander@769
   389
dvander@769
   390
	return true;
dvander@769
   391
}
dvander@769
   392
dvander@787
   393
IMenuPanel *MenuManager::RenderMenu(int client, menu_states_t &md, ItemOrder order)
dvander@769
   394
{
dvander@769
   395
	IBaseMenu *menu = md.menu;
dvander@769
   396
dvander@769
   397
	if (!menu)
dvander@769
   398
	{
dvander@769
   399
		return NULL;
dvander@769
   400
	}
dvander@769
   401
dvander@769
   402
	struct
dvander@769
   403
	{
dvander@769
   404
		unsigned int position;
dvander@769
   405
		ItemDrawInfo draw;
dvander@769
   406
	} drawItems[10];
dvander@769
   407
dvander@769
   408
	/* Figure out how many items to draw */
dvander@769
   409
	IMenuStyle *style = menu->GetDrawStyle();
dvander@769
   410
	unsigned int pgn = menu->GetPagination();
dvander@769
   411
	unsigned int maxItems = style->GetMaxPageItems();
dvander@769
   412
	if (pgn != MENU_NO_PAGINATION)
dvander@769
   413
	{
dvander@769
   414
		maxItems = pgn;
dvander@769
   415
	}
dvander@769
   416
dvander@769
   417
	unsigned int totalItems = menu->GetItemCount();
dvander@769
   418
	unsigned int startItem = 0;
dvander@769
   419
dvander@769
   420
	/* For pagination, find the starting point. */
dvander@769
   421
	if (pgn != MENU_NO_PAGINATION)
dvander@769
   422
	{
dvander@769
   423
		if (order == ItemOrder_Ascending)
dvander@769
   424
		{
dvander@769
   425
			startItem = md.lastItem;
dvander@769
   426
			/* This shouldn't happen with well-coded menus.
dvander@769
   427
			 * If the item is out of bounds, switch the order to
dvander@769
   428
			 * Items_Descending and make us start from the top.
dvander@769
   429
			 */
dvander@769
   430
			if (startItem >= totalItems)
dvander@769
   431
			{
dvander@769
   432
				startItem = totalItems - 1;
dvander@769
   433
				order = ItemOrder_Descending;
dvander@769
   434
			}
dvander@769
   435
		} else if (order == ItemOrder_Descending) {
dvander@769
   436
			startItem = md.firstItem;
dvander@769
   437
			/* This shouldn't happen with well-coded menus.
dvander@769
   438
			 * If searching backwards doesn't give us enough room,
dvander@769
   439
			 * start from the beginning and change to ascending.
dvander@769
   440
			 */
dvander@769
   441
			if (startItem <= maxItems)
dvander@769
   442
			{
dvander@769
   443
				startItem = 0;
dvander@769
   444
				order = ItemOrder_Ascending;
dvander@769
   445
			}
dvander@769
   446
		}
dvander@769
   447
	}
dvander@769
   448
dvander@769
   449
	/* Get our Display pointer and initialize some crap */
dvander@787
   450
	IMenuPanel *display = menu->CreatePanel();
dvander@769
   451
	IMenuHandler *mh = md.mh;
dvander@769
   452
	bool foundExtra = false;
dvander@769
   453
	unsigned int extraItem = 0;
dvander@769
   454
dvander@769
   455
	/**
dvander@769
   456
	 * We keep searching until:
dvander@769
   457
	 * 1) There are no more items
dvander@769
   458
	 * 2) We reach one OVER the maximum number of slot items
dvander@769
   459
	 * 3) We have reached maxItems and pagination is MENU_NO_PAGINATION
dvander@769
   460
	 */
dvander@769
   461
	unsigned int i = startItem;
dvander@769
   462
	unsigned int foundItems = 0;
dvander@769
   463
	while (true)
dvander@769
   464
	{
dvander@769
   465
		ItemDrawInfo &dr = drawItems[foundItems].draw;
dvander@769
   466
		/* Is the item valid? */
dvander@769
   467
		if (menu->GetItemInfo(i, &dr) != NULL)
dvander@769
   468
		{
dvander@769
   469
			/* Ask the user to change the style, if necessary */
dvander@769
   470
			mh->OnMenuDrawItem(menu, client, i, dr.style);
dvander@769
   471
			/* Check if it's renderable */
dvander@769
   472
			if (IsSlotItem(display, dr.style))
dvander@769
   473
			{
dvander@769
   474
				/* If we've already found the max number of items,
dvander@769
   475
				 * This means we should just cancel out and log our
dvander@769
   476
				 * "last item."
dvander@769
   477
				 */
dvander@769
   478
				if (foundItems >= maxItems)
dvander@769
   479
				{
dvander@769
   480
					foundExtra = true;
dvander@769
   481
					extraItem = i;
dvander@769
   482
					break;
dvander@769
   483
				}
dvander@769
   484
				drawItems[foundItems++].position = i;
dvander@769
   485
			}
dvander@769
   486
		}
dvander@769
   487
		/* If there's no pagination, stop once the menu is full. */
dvander@769
   488
		if (pgn == MENU_NO_PAGINATION)
dvander@769
   489
		{
dvander@769
   490
			/* If we've filled up, then stop */
dvander@769
   491
			if (foundItems >= maxItems)
dvander@769
   492
			{
dvander@769
   493
				break;
dvander@769
   494
			}
dvander@769
   495
		}
dvander@769
   496
		/* If we're descending and this is the first item, stop */
dvander@769
   497
		if (order == ItemOrder_Descending)
dvander@769
   498
		{
dvander@769
   499
			if (i == 0)
dvander@769
   500
			{
dvander@769
   501
				break;
dvander@769
   502
			}
dvander@769
   503
			i--;
dvander@769
   504
		} 
dvander@769
   505
		/* If we're ascending and this is the last item, stop */
dvander@769
   506
		else if (order == ItemOrder_Ascending)
dvander@769
   507
		{
dvander@769
   508
			if (i >= totalItems - 1)
dvander@769
   509
			{
dvander@769
   510
				break;
dvander@769
   511
			}
dvander@769
   512
			i++;
dvander@769
   513
		}
dvander@769
   514
	}
dvander@769
   515
dvander@769
   516
	/* There were no items to draw! */
dvander@769
   517
	if (!foundItems)
dvander@769
   518
	{
dvander@776
   519
		display->DeleteThis();
dvander@769
   520
		return NULL;
dvander@769
   521
	}
dvander@769
   522
dvander@769
   523
	/* Check initial buttons */
dvander@769
   524
	bool displayPrev = false;
dvander@769
   525
	bool displayNext = false;
dvander@769
   526
	if (foundExtra)
dvander@769
   527
	{
dvander@769
   528
		if (order == ItemOrder_Descending)
dvander@769
   529
		{
dvander@769
   530
			displayPrev = true;
dvander@769
   531
			md.firstItem = extraItem;
dvander@769
   532
		} else if (order == ItemOrder_Ascending) {
dvander@769
   533
			displayNext = true;
dvander@769
   534
			md.lastItem = extraItem;
dvander@769
   535
		}
dvander@769
   536
	}
dvander@769
   537
dvander@769
   538
	/**
dvander@769
   539
	 * If we're paginated, we have to find if there is another page.
dvander@769
   540
	 * Sadly, the only way to do this is to try drawing more items!
dvander@769
   541
	 */
dvander@769
   542
	if (pgn != MENU_NO_PAGINATION)
dvander@769
   543
	{
dvander@769
   544
		unsigned int lastItem = 0;
dvander@769
   545
		ItemDrawInfo dr;
dvander@769
   546
		/* Find the last feasible item to search from. */
dvander@769
   547
		if (order == ItemOrder_Descending)
dvander@769
   548
		{
dvander@769
   549
			lastItem = drawItems[0].position;
dvander@769
   550
			if (lastItem >= totalItems - 1)
dvander@769
   551
			{
dvander@769
   552
				goto skip_search;
dvander@769
   553
			}
dvander@769
   554
			while (++lastItem < totalItems)
dvander@769
   555
			{
dvander@769
   556
				if (menu->GetItemInfo(lastItem, &dr) != NULL)
dvander@769
   557
				{
dvander@769
   558
					mh->OnMenuDrawItem(menu, client, lastItem, dr.style);
dvander@769
   559
					if (IsSlotItem(display, dr.style))
dvander@769
   560
					{
dvander@769
   561
						displayNext = true;
dvander@769
   562
						md.lastItem = lastItem;
dvander@769
   563
						break;
dvander@769
   564
					}
dvander@769
   565
				}
dvander@769
   566
			}
dvander@769
   567
		} else if (order == ItemOrder_Ascending) {
dvander@769
   568
			lastItem = drawItems[0].position;
dvander@769
   569
			if (lastItem == 0)
dvander@769
   570
			{
dvander@769
   571
				goto skip_search;
dvander@769
   572
			}
dvander@769
   573
			lastItem--;
dvander@1004
   574
			while (lastItem != 0)
dvander@769
   575
			{
dvander@769
   576
				if (menu->GetItemInfo(lastItem, &dr) != NULL)
dvander@769
   577
				{
dvander@769
   578
					mh->OnMenuDrawItem(menu, client, lastItem, dr.style);
dvander@769
   579
					if (IsSlotItem(display, dr.style))
dvander@769
   580
					{
dvander@769
   581
						displayPrev = true;
dvander@769
   582
						md.firstItem = lastItem;
dvander@769
   583
						break;
dvander@769
   584
					}
dvander@769
   585
				}
dvander@1004
   586
				lastItem--;
dvander@769
   587
			}
dvander@769
   588
		}
dvander@769
   589
	}
dvander@769
   590
skip_search:
dvander@769
   591
dvander@769
   592
	/* Draw the item according to the order */
dvander@769
   593
	menu_slots_t *slots = md.slots;
dvander@769
   594
	unsigned int position = 0;			/* Keep track of the last position */
dvander@769
   595
	if (order == ItemOrder_Ascending)
dvander@769
   596
	{
dvander@769
   597
		for (unsigned int i=0; i<foundItems; i++)
dvander@769
   598
		{
dvander@769
   599
			ItemDrawInfo &dr = drawItems[i].draw;
dvander@1163
   600
			if ((position = mh->OnMenuDisplayItem(menu, client, display, drawItems[i].position, dr)) == 0)
dvander@1163
   601
			{
dvander@1163
   602
				position = display->DrawItem(dr);
dvander@1163
   603
			}
dvander@1163
   604
			if (position != 0)
dvander@769
   605
			{
dvander@769
   606
				slots[position].item = drawItems[i].position;
dvander@769
   607
				slots[position].type = ItemSel_Item;
dvander@769
   608
			}
dvander@769
   609
		}
dvander@769
   610
	} else if (order == ItemOrder_Descending) {
dvander@769
   611
		unsigned int i = foundItems;
dvander@769
   612
		/* NOTE: There will always be at least one item because
dvander@769
   613
		 * of the check earlier.
dvander@769
   614
		 */
dvander@769
   615
		while (i--)
dvander@769
   616
		{
dvander@769
   617
			ItemDrawInfo &dr = drawItems[i].draw;
dvander@1163
   618
			if ((position = mh->OnMenuDisplayItem(menu, client, display, drawItems[i].position, dr)) == 0)
dvander@1163
   619
			{
dvander@1163
   620
				position = display->DrawItem(dr);
dvander@1163
   621
			}
dvander@769
   622
			if ((position = display->DrawItem(dr)) != 0)
dvander@769
   623
			{
dvander@769
   624
				slots[position].item = drawItems[i].position;
dvander@769
   625
				slots[position].type = ItemSel_Item;
dvander@769
   626
			}
dvander@769
   627
		}
dvander@769
   628
	}
dvander@769
   629
dvander@769
   630
	/* Now, we need to check if we need to add anything extra */
dvander@769
   631
	if (pgn != MENU_NO_PAGINATION)
dvander@769
   632
	{
dvander@785
   633
		bool canDrawDisabled = display->CanDrawItem(ITEMDRAW_DISABLED|ITEMDRAW_CONTROL);
dvander@769
   634
		bool exitButton = menu->GetExitButton();
dvander@1005
   635
		bool exitBackButton = menu->GetExitBackButton();
dvander@769
   636
		char text[50];
dvander@769
   637
dvander@769
   638
		/* Calculate how many items we are allowed for control stuff */
dvander@769
   639
		unsigned int padding = style->GetMaxPageItems() - maxItems;
dvander@769
   640
		
dvander@769
   641
		/* Add the number of available slots */
dvander@769
   642
		padding += (maxItems - foundItems);
dvander@769
   643
dvander@769
   644
		/* Someday, if we are able to re-enable this, we will be very lucky men. */
dvander@769
   645
#if 0
dvander@769
   646
		if (!style->FeatureExists(MenuStyleFeature_ImplicitExit))
dvander@769
   647
		{
dvander@769
   648
#endif
dvander@769
   649
		/* Even if we don't draw an exit button, we invalidate the slot. */
dvander@769
   650
		padding--;
dvander@769
   651
#if 0
dvander@769
   652
		} else {
dvander@769
   653
			/* Otherwise, we don't draw anything and leave the slot available */
dvander@769
   654
			exitButton = false;
dvander@769
   655
		}
dvander@769
   656
#endif
dvander@769
   657
dvander@769
   658
		/* Subtract two slots for the displayNext/displayPrev padding */
dvander@769
   659
		padding -= 2;
dvander@769
   660
dvander@1005
   661
		/* If we have an "Exit Back" button and the space to draw it, do so. */
dvander@1005
   662
		if (exitBackButton)
dvander@1005
   663
		{
dvander@1005
   664
			if (!displayPrev)
dvander@1005
   665
			{
dvander@1005
   666
				displayPrev = true;
dvander@1005
   667
			} else {
dvander@1005
   668
				exitBackButton = false;
dvander@1005
   669
			}
dvander@1005
   670
		}
dvander@1005
   671
dvander@769
   672
		/**
dvander@769
   673
		 * We allow next/prev to be undrawn if neither exists.
dvander@769
   674
		 * Thus, we only need padding if one of them will be drawn,
dvander@769
   675
		 * or the exit button will be drawn.
dvander@769
   676
		 */
dvander@769
   677
		ItemDrawInfo padItem(NULL, ITEMDRAW_SPACER);
dvander@769
   678
		if (exitButton || (displayNext || displayPrev))
dvander@769
   679
		{
dvander@790
   680
			/* If there are no control options,
dvander@790
   681
			 * Instead just pad with invisible slots.
dvander@790
   682
			 */
dvander@790
   683
			if (!displayPrev && !displayPrev)
dvander@790
   684
			{
dvander@790
   685
				padItem.style = ITEMDRAW_NOTEXT;
dvander@790
   686
			}
dvander@769
   687
			/* Add spacers so we can pad to the end */
dvander@769
   688
			for (unsigned int i=0; i<padding; i++)
dvander@769
   689
			{
dvander@769
   690
				position = display->DrawItem(padItem);
dvander@769
   691
				slots[position].type = ItemSel_None;
dvander@769
   692
			}
dvander@769
   693
		}
dvander@776
   694
dvander@776
   695
		/* Put a fake spacer before control stuff, if possible */
dvander@797
   696
		if ((displayPrev || displayNext) || exitButton)
dvander@776
   697
		{
dvander@776
   698
			ItemDrawInfo draw("", ITEMDRAW_RAWLINE|ITEMDRAW_SPACER);
dvander@776
   699
			display->DrawItem(draw);
dvander@776
   700
		}
dvander@769
   701
dvander@776
   702
		ItemDrawInfo dr(text, 0);
dvander@785
   703
		/**
dvander@785
   704
		 * If we have one or the other, we need to have spacers for both.
dvander@785
   705
		 */
dvander@785
   706
		if (displayPrev || displayNext)
dvander@769
   707
		{
dvander@785
   708
			/* PREVIOUS */
dvander@785
   709
			ItemDrawInfo padCtrlItem(NULL, ITEMDRAW_SPACER|ITEMDRAW_CONTROL);
dvander@785
   710
			if (displayPrev || canDrawDisabled)
dvander@785
   711
			{
dvander@1005
   712
				if (exitBackButton)
dvander@1005
   713
				{
dvander@1005
   714
					CorePlayerTranslate(client, text, sizeof(text), "Back", NULL);
dvander@1005
   715
					dr.style = ITEMDRAW_CONTROL;
dvander@1005
   716
					position = display->DrawItem(dr);
dvander@1005
   717
					slots[position].type = ItemSel_ExitBack;
dvander@1005
   718
				} else {
dvander@1005
   719
					CorePlayerTranslate(client, text, sizeof(text), "Previous", NULL);
dvander@1005
   720
					dr.style = (displayPrev ? 0 : ITEMDRAW_DISABLED)|ITEMDRAW_CONTROL;
dvander@1005
   721
					position = display->DrawItem(dr);
dvander@1005
   722
					slots[position].type = ItemSel_Back;
dvander@1005
   723
				}
dvander@785
   724
			} else if (displayNext || exitButton) {
dvander@785
   725
				/* If we can't display this, and there is an exit button,
dvander@785
   726
				 * we need to pad!
dvander@785
   727
				 */
dvander@785
   728
				position = display->DrawItem(padCtrlItem);
dvander@785
   729
				slots[position].type = ItemSel_None;
dvander@785
   730
			}
dvander@785
   731
dvander@785
   732
			/* NEXT */
dvander@785
   733
			if (displayNext || canDrawDisabled)
dvander@785
   734
			{
dvander@785
   735
				CorePlayerTranslate(client, text, sizeof(text), "Next", NULL);
dvander@785
   736
				dr.style = (displayNext ? 0 : ITEMDRAW_DISABLED)|ITEMDRAW_CONTROL;
dvander@785
   737
				position = display->DrawItem(dr);
dvander@785
   738
				slots[position].type = ItemSel_Next;
dvander@785
   739
			} else if (exitButton) {
dvander@785
   740
				/* If we can't display this,
dvander@785
   741
				 * but there is an "exit" button, we need to pad!
dvander@785
   742
				 */
dvander@785
   743
				position = display->DrawItem(padCtrlItem);
dvander@785
   744
				slots[position].type = ItemSel_None;
dvander@785
   745
			}
dvander@785
   746
		} else {
dvander@785
   747
			/* Otherwise, bump to two slots! */
dvander@785
   748
			ItemDrawInfo numBump(NULL, ITEMDRAW_NOTEXT);
dvander@785
   749
			position = display->DrawItem(numBump);
dvander@769
   750
			slots[position].type = ItemSel_None;
dvander@785
   751
			position = display->DrawItem(numBump);
dvander@769
   752
			slots[position].type = ItemSel_None;
dvander@769
   753
		}
dvander@769
   754
dvander@769
   755
		/* EXIT */
dvander@769
   756
		if (exitButton)
dvander@769
   757
		{
dvander@769
   758
			CorePlayerTranslate(client, text, sizeof(text), "Exit", NULL);
dvander@785
   759
			dr.style = ITEMDRAW_CONTROL;
dvander@769
   760
			position = display->DrawItem(dr);
dvander@769
   761
			slots[position].type = ItemSel_Exit;
dvander@769
   762
		}
dvander@769
   763
	}
dvander@769
   764
dvander@769
   765
	/* Lastly, fill in any slots we could have missed */
dvander@769
   766
	for (unsigned int i = position + 1; i < 10; i++)
dvander@769
   767
	{
dvander@769
   768
		slots[i].type = ItemSel_None;
dvander@769
   769
	}
dvander@769
   770
dvander@769
   771
	/* Do title stuff */
dvander@769
   772
	mh->OnMenuDisplay(menu, client, display);
dvander@769
   773
	display->DrawTitle(menu->GetDefaultTitle(), true);
dvander@769
   774
dvander@769
   775
	return display;
dvander@769
   776
}
dvander@769
   777
dvander@769
   778
IMenuStyle *MenuManager::GetDefaultStyle()
dvander@769
   779
{
dvander@769
   780
	return m_pDefaultStyle;
dvander@769
   781
}
dvander@769
   782
dvander@877
   783
IVoteMenuHandler *MenuManager::CreateVoteWrapper(IMenuHandler *mh)
dvander@877
   784
{
dvander@877
   785
	VoteMenuHandler *vh = NULL;
dvander@877
   786
dvander@877
   787
	if (m_VoteHandlers.empty())
dvander@877
   788
	{
dvander@877
   789
		vh = new VoteMenuHandler;
dvander@877
   790
	} else {
dvander@877
   791
		vh = m_VoteHandlers.front();
dvander@877
   792
		m_VoteHandlers.pop();
dvander@877
   793
	}
dvander@877
   794
dvander@877
   795
	vh->Reset(mh);
dvander@877
   796
dvander@877
   797
	return vh;
dvander@877
   798
}
dvander@877
   799
dvander@877
   800
void MenuManager::ReleaseVoteWrapper(IVoteMenuHandler *mh)
dvander@877
   801
{
dvander@877
   802
	if (mh == NULL)
dvander@877
   803
	{
dvander@877
   804
		return;
dvander@877
   805
	}
dvander@877
   806
dvander@877
   807
	m_VoteHandlers.push((VoteMenuHandler *)mh);
dvander@877
   808
}
dvander@1220
   809
dvander@1220
   810
bool MenuManager::MenuSoundsEnabled()
dvander@1220
   811
{
dvander@1220
   812
	return (sm_menu_sounds.GetInt() != 0);
dvander@1220
   813
}
dvander@1220
   814
dvander@1220
   815
ConfigResult MenuManager::OnSourceModConfigChanged(const char *key,
dvander@1220
   816
												   const char *value,
dvander@1220
   817
												   ConfigSource source,
dvander@1220
   818
												   char *error,
dvander@1220
   819
												   size_t maxlength)
dvander@1220
   820
{
dvander@1220
   821
	if (strcmp(key, "MenuItemSound") == 0)
dvander@1220
   822
	{
dvander@1220
   823
		m_SelectSound.assign(value);
dvander@1220
   824
		return ConfigResult_Accept;
dvander@1220
   825
	} else if (strcmp(key, "MenuExitBackSound") == 0) {
dvander@1220
   826
		m_ExitBackSound.assign(value);
dvander@1220
   827
		return ConfigResult_Accept;
dvander@1220
   828
	}
dvander@1220
   829
dvander@1220
   830
	return ConfigResult_Ignore;
dvander@1220
   831
}
dvander@1220
   832
dvander@1220
   833
const char *MenuManager::GetMenuSound(ItemSelection sel)
dvander@1220
   834
{
dvander@1220
   835
	const char *sound = NULL;
dvander@1220
   836
dvander@1220
   837
	switch (sel)
dvander@1220
   838
	{
dvander@1220
   839
	case ItemSel_Back:
dvander@1220
   840
	case ItemSel_Next:
dvander@1220
   841
	case ItemSel_Exit:
dvander@1220
   842
	case ItemSel_Item:
dvander@1220
   843
		{
dvander@1220
   844
			if (m_SelectSound.size() > 0)
dvander@1220
   845
			{
dvander@1220
   846
				sound = m_SelectSound.c_str();
dvander@1220
   847
			}
dvander@1220
   848
			break;
dvander@1220
   849
		}
dvander@1220
   850
	case ItemSel_ExitBack:
dvander@1220
   851
		{
dvander@1220
   852
			if (m_ExitBackSound.size() > 0)
dvander@1220
   853
			{
dvander@1220
   854
				sound = m_ExitBackSound.c_str();
dvander@1220
   855
			}
dvander@1220
   856
			break;
dvander@1220
   857
		}
dvander@1220
   858
	default:
dvander@1220
   859
		{
dvander@1220
   860
			break;
dvander@1220
   861
		}
dvander@1220
   862
	}
dvander@1220
   863
dvander@1220
   864
	return sound;
dvander@1220
   865
}