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