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