Re-enabled PDB files.
3 * =============================================================================
5 * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
6 * =============================================================================
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.
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
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/>.
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>.
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
43 BaseMenuStyle::BaseMenuStyle() : m_WatchList(256), m_hHandle(BAD_HANDLE)
47 Handle_t BaseMenuStyle::GetHandle()
49 /* Don't create the handle until we need it */
50 if (m_hHandle == BAD_HANDLE)
52 m_hHandle = g_Menus.CreateStyleHandle(this);
58 void BaseMenuStyle::AddClientToWatch(int client)
60 #if defined MENU_DEBUG
61 g_Logger.LogMessage("[SM_MENU] AddClientToWatch(%d)", client);
63 m_WatchList.push_back(client);
66 void BaseMenuStyle::RemoveClientFromWatch(int client)
68 #if defined MENU_DEBUG
69 g_Logger.LogMessage("[SM_MENU] RemoveClientFromWatch(%d)", client);
71 m_WatchList.remove(client);
74 void BaseMenuStyle::_CancelClientMenu(int client, MenuCancelReason reason, bool bAutoIgnore/* =false */)
76 #if defined MENU_DEBUG
77 g_Logger.LogMessage("[SM_MENU] _CancelClientMenu() (client %d) (bAutoIgnore %d) (reason %d)", client, bAutoIgnore, reason);
79 CBaseMenuPlayer *player = GetMenuPlayer(client);
80 menu_states_t &states = player->states;
82 bool bOldIgnore = player->bAutoIgnore;
85 player->bAutoIgnore = true;
89 IMenuHandler *mh = states.mh;
90 IBaseMenu *menu = states.menu;
93 player->bInMenu = false;
94 if (player->menuHoldTime)
96 RemoveClientFromWatch(client);
100 mh->OnMenuCancel(menu, client, reason);
102 /* Only fire end if there's a valid menu */
105 mh->OnMenuEnd(menu, MenuEnd_Cancelled);
110 player->bAutoIgnore = bOldIgnore;
114 void BaseMenuStyle::CancelMenu(CBaseMenu *menu)
116 #if defined MENU_DEBUG
117 g_Logger.LogMessage("[SM_MENU] CancelMenu() (menu %p)", menu);
119 int maxClients = g_Players.GetMaxClients();
120 for (int i=1; i<=maxClients; i++)
122 CBaseMenuPlayer *player = GetMenuPlayer(i);
125 menu_states_t &states = player->states;
126 if (states.menu == menu)
128 _CancelClientMenu(i, MenuCancel_Interrupted);
134 bool BaseMenuStyle::CancelClientMenu(int client, bool autoIgnore)
136 #if defined MENU_DEBUG
137 g_Logger.LogMessage("[SM_MENU] CancelClientMenu() (client %d) (bAutoIgnore %d)", client, autoIgnore);
139 if (client < 1 || client > g_Players.MaxClients())
144 CBaseMenuPlayer *player = GetMenuPlayer(client);
145 if (!player->bInMenu)
150 _CancelClientMenu(client, MenuCancel_Interrupted, autoIgnore);
155 MenuSource BaseMenuStyle::GetClientMenu(int client, void **object)
157 if (client < 1 || client > g_Players.GetMaxClients())
159 return MenuSource_None;
162 CBaseMenuPlayer *player = GetMenuPlayer(client);
167 if ((menu=player->states.menu) != NULL)
173 return MenuSource_BaseMenu;
176 return MenuSource_Display;
177 } else if (player->bInExternMenu) {
178 if (player->menuHoldTime != 0
179 && (gpGlobals->curtime > player->menuStartTime + player->menuHoldTime))
181 player->bInExternMenu = false;
182 return MenuSource_None;
184 return MenuSource_External;
187 return MenuSource_None;
190 void BaseMenuStyle::OnClientDisconnected(int client)
192 #if defined MENU_DEBUG
193 g_Logger.LogMessage("[SM_MENU] OnClientDisconnected(%d)", client);
195 CBaseMenuPlayer *player = GetMenuPlayer(client);
196 if (!player->bInMenu)
201 _CancelClientMenu(client, MenuCancel_Disconnected, true);
203 player->bInMenu = false;
204 player->bInExternMenu = false;
207 static int do_lookup[256];
208 void BaseMenuStyle::ProcessWatchList()
210 if (!m_WatchList.size())
215 #if defined MENU_DEBUG
216 g_Logger.LogMessage("BaseMenuStyle::ProcessWatchList(%d,%d,%d,%d,%d,%p)",
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);
225 unsigned int total = 0;
226 for (FastLink<int>::iterator iter=m_WatchList.begin(); iter!=m_WatchList.end(); ++iter)
228 do_lookup[total++] = (*iter);
231 #if defined MENU_DEBUG
234 g_Logger.LogMessage("[SM_MENU] ProcessWatchList() found %d clients", total);
239 CBaseMenuPlayer *player;
240 float curTime = gpGlobals->curtime;
241 for (unsigned int i=0; i<total; i++)
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)",
249 player->menuHoldTime,
251 player->menuStartTime);
253 if (!player->bInMenu || !player->menuHoldTime)
255 #if defined MENU_DEBUG
256 g_Logger.LogMessage("[SM_MENU] ProcessWatchList() removing client %d", client);
258 m_WatchList.remove(client);
261 if (curTime > player->menuStartTime + player->menuHoldTime)
263 _CancelClientMenu(client, MenuCancel_Timeout, false);
268 void BaseMenuStyle::ClientPressedKey(int client, unsigned int key_press)
270 #if defined MENU_DEBUG
271 g_Logger.LogMessage("[SM_MENU] ClientPressedKey() (client %d) (key_press %d)", client, key_press);
273 CBaseMenuPlayer *player = GetMenuPlayer(client);
275 /* First question: Are we in a menu? */
276 if (!player->bInMenu)
282 unsigned int item = 0;
283 MenuCancelReason reason = MenuCancel_Exit;
284 MenuEndReason end_reason = MenuEnd_Selected;
285 menu_states_t &states = player->states;
288 IMenuHandler *mh = states.mh;
289 IBaseMenu *menu = states.menu;
291 unsigned int item_on_page = states.item_on_page;
298 } else if (key_press < 1 || key_press > GetMaxPageItems()) {
301 ItemSelection type = states.slots[key_press].type;
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))
307 CellRecipientFilter filter;
311 filter.Initialize(clients, 1);
313 const char *sound = g_Menus.GetMenuSound(type);
317 edict_t *pEdict = PEntityOfEntIndex(client);
320 ICollideable *pCollideable = pEdict->GetCollideable();
324 const Vector & pos = pCollideable->GetCollisionOrigin();
326 enginesound->EmitSound(filter,
340 /* For navigational items, we're going to redisplay */
341 if (type == ItemSel_Back)
343 if (!RedoClientMenu(client, ItemOrder_Descending))
346 reason = MenuCancel_NoDisplay;
347 end_reason = MenuEnd_Cancelled;
351 } else if (type == ItemSel_Next) {
352 if (!RedoClientMenu(client, ItemOrder_Ascending))
354 cancel = true; /* I like Saltines. */
355 reason = MenuCancel_NoDisplay;
356 end_reason = MenuEnd_Cancelled;
360 } else if (type == ItemSel_Exit || type == ItemSel_None) {
362 reason = MenuCancel_Exit;
363 end_reason = MenuEnd_Exit;
364 } else if (type == ItemSel_ExitBack) {
366 reason = MenuCancel_ExitBack;
367 end_reason = MenuEnd_ExitBack;
369 item = states.slots[key_press].item;
374 player->bInMenu = false;
375 if (player->menuHoldTime)
377 RemoveClientFromWatch(client);
382 mh->OnMenuCancel(menu, client, reason);
384 mh->OnMenuSelect(menu, client, item);
385 if (mh->GetMenuAPIVersion2() >= 13)
387 mh->OnMenuSelect2(menu, client, item, item_on_page);
391 /* Only fire end for valid menus */
394 mh->OnMenuEnd(menu, end_reason);
398 bool BaseMenuStyle::DoClientMenu(int client, IMenuPanel *menu, IMenuHandler *mh, unsigned int time)
400 #if defined MENU_DEBUG
401 g_Logger.LogMessage("[SM_MENU] DoClientMenu() (client %d) (panel %p) (mh %p) (time %d)",
407 CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
408 if (!pPlayer || pPlayer->IsFakeClient() || !pPlayer->IsInGame())
413 CBaseMenuPlayer *player = GetMenuPlayer(client);
414 if (player->bAutoIgnore)
419 /* For the duration of this, we are going to totally ignore whether
420 * the player is already in a menu or not (except to cancel the old one).
421 * Instead, we are simply going to ignore any further menu displays, so
422 * this display can't be interrupted.
424 player->bAutoIgnore = true;
426 /* Cancel any old menus */
427 menu_states_t &states = player->states;
430 _CancelClientMenu(client, MenuCancel_Interrupted, true);
433 states.firstItem = 0;
437 states.apiVers = SMINTERFACE_MENUMANAGER_VERSION;
438 player->bInMenu = true;
439 player->bInExternMenu = false;
440 player->menuStartTime = gpGlobals->curtime;
441 player->menuHoldTime = time;
445 AddClientToWatch(client);
448 /* Draw the display */
449 SendDisplay(client, menu);
451 /* We can be interrupted again! */
452 player->bAutoIgnore = false;
457 bool BaseMenuStyle::DoClientMenu(int client,
459 unsigned int first_item,
463 #if defined MENU_DEBUG
464 g_Logger.LogMessage("[SM_MENU] DoClientMenu() (client %d) (menu %p) (mh %p) (time %d)",
470 mh->OnMenuStart(menu);
472 CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
473 if (!pPlayer || pPlayer->IsFakeClient() || !pPlayer->IsInGame())
475 #if defined MENU_DEBUG
476 g_Logger.LogMessage("[SM_MENU] DoClientMenu(): Failed to display to client %d", client);
478 mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
479 mh->OnMenuEnd(menu, MenuEnd_Cancelled);
483 CBaseMenuPlayer *player = GetMenuPlayer(client);
484 if (player->bAutoIgnore)
486 #if defined MENU_DEBUG
487 g_Logger.LogMessage("[SM_MENU] DoClientMenu(): Client %d is autoIgnoring", client);
489 mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
490 mh->OnMenuEnd(menu, MenuEnd_Cancelled);
494 /* For the duration of this, we are going to totally ignore whether
495 * the player is already in a menu or not (except to cancel the old one).
496 * Instead, we are simply going to ignore any further menu displays, so
497 * this display can't be interrupted.
499 player->bAutoIgnore = true;
501 /* Cancel any old menus */
502 menu_states_t &states = player->states;
505 #if defined MENU_DEBUG
506 g_Logger.LogMessage("[SM_MENU] DoClientMenu(): Cancelling old menu to client %d", client);
508 _CancelClientMenu(client, MenuCancel_Interrupted, true);
511 states.firstItem = 0;
512 states.lastItem = first_item;
515 states.apiVers = SMINTERFACE_MENUMANAGER_VERSION;
517 IMenuPanel *display = g_Menus.RenderMenu(client, states, ItemOrder_Ascending);
520 #if defined MENU_DEBUG
521 g_Logger.LogMessage("[SM_MENU] DoClientMenu(): Failed to render to client %d", client);
523 player->bAutoIgnore = false;
524 player->bInMenu = false;
525 mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
526 mh->OnMenuEnd(menu, MenuEnd_Cancelled);
530 /* Finally, set our states */
531 player->bInMenu = true;
532 player->bInExternMenu = false;
533 player->menuStartTime = gpGlobals->curtime;
534 player->menuHoldTime = time;
538 AddClientToWatch(client);
541 /* Draw the display */
542 SendDisplay(client, display);
544 /* Free the display pointer */
545 display->DeleteThis();
547 /* We can be interrupted again! */
548 player->bAutoIgnore = false;
550 #if defined MENU_DEBUG
551 g_Logger.LogMessage("[SM_MENU] DoClientMenu() finished successfully (client %d)", client);
557 bool BaseMenuStyle::RedoClientMenu(int client, ItemOrder order)
559 #if defined MENU_DEBUG
560 g_Logger.LogMessage("[SM_MENU] RedoClientMenu() (client %d) (order %d)", client, order);
562 CBaseMenuPlayer *player = GetMenuPlayer(client);
563 menu_states_t &states = player->states;
565 player->bAutoIgnore = true;
566 IMenuPanel *display = g_Menus.RenderMenu(client, states, order);
569 #if defined MENU_DEBUG
570 g_Logger.LogMessage("[SM_MENU] RedoClientMenu(): Failed to render menu");
572 if (player->menuHoldTime)
574 RemoveClientFromWatch(client);
576 player->bAutoIgnore = false;
580 SendDisplay(client, display);
582 display->DeleteThis();
584 player->bAutoIgnore = false;
586 #if defined MENU_DEBUG
587 g_Logger.LogMessage("[SM_MENU] RedoClientMenu(): Succeeded to client %d", client);
593 CBaseMenu::CBaseMenu(IMenuHandler *pHandler, IMenuStyle *pStyle, IdentityToken_t *pOwner) :
594 m_pStyle(pStyle), m_Strings(512), m_Pagination(7), m_bShouldDelete(false), m_bCancelling(false),
595 m_pOwner(pOwner ? pOwner : g_pCoreIdent), m_bDeleting(false), m_bWillFreeHandle(false),
596 m_hHandle(BAD_HANDLE), m_pHandler(pHandler), m_nFlags(MENUFLAG_BUTTON_EXIT)
600 CBaseMenu::~CBaseMenu()
604 Handle_t CBaseMenu::GetHandle()
608 m_hHandle = g_Menus.CreateMenuHandle(this, m_pOwner);
614 bool CBaseMenu::AppendItem(const char *info, const ItemDrawInfo &draw)
616 if (m_Pagination == (unsigned)MENU_NO_PAGINATION
617 && m_items.size() >= m_pStyle->GetMaxPageItems())
624 item.infoString = m_Strings.AddString(info);
627 item.displayString = m_Strings.AddString(draw.display);
629 item.style = draw.style;
631 m_items.push_back(item);
636 bool CBaseMenu::InsertItem(unsigned int position, const char *info, const ItemDrawInfo &draw)
638 if (m_Pagination == (unsigned)MENU_NO_PAGINATION
639 && m_items.size() >= m_pStyle->GetMaxPageItems())
644 if (position >= m_items.size())
650 item.infoString = m_Strings.AddString(info);
653 item.displayString = m_Strings.AddString(draw.display);
655 item.style = draw.style;
657 CVector<CItem>::iterator iter = m_items.iterAt(position);
658 m_items.insert(iter, item);
663 bool CBaseMenu::RemoveItem(unsigned int position)
665 if (position >= m_items.size())
670 m_items.erase(m_items.iterAt(position));
672 if (m_items.size() == 0)
680 void CBaseMenu::RemoveAllItems()
686 const char *CBaseMenu::GetItemInfo(unsigned int position, ItemDrawInfo *draw/* =NULL */)
688 if (position >= m_items.size())
695 draw->display = m_Strings.GetString(m_items[position].displayString);
696 draw->style = m_items[position].style;
699 return m_Strings.GetString(m_items[position].infoString);
702 unsigned int CBaseMenu::GetItemCount()
704 return m_items.size();
707 bool CBaseMenu::SetPagination(unsigned int itemsPerPage)
709 if (itemsPerPage > 7 || itemsPerPage == 1)
714 if (itemsPerPage == MENU_NO_PAGINATION
715 && m_Pagination != MENU_NO_PAGINATION)
717 m_nFlags &= ~MENUFLAG_BUTTON_EXIT;
720 m_Pagination = itemsPerPage;
725 unsigned int CBaseMenu::GetPagination()
730 IMenuStyle *CBaseMenu::GetDrawStyle()
735 void CBaseMenu::SetDefaultTitle(const char *message)
737 m_Title.assign(message);
740 const char *CBaseMenu::GetDefaultTitle()
742 return m_Title.c_str();
745 void CBaseMenu::Cancel()
752 #if defined MENU_DEBUG
753 g_Logger.LogMessage("[SM_MENU] CBaseMenu::Cancel(%p) (m_bShouldDelete %d)",
758 m_bCancelling = true;
760 m_bCancelling = false;
768 void CBaseMenu::Destroy(bool releaseHandle)
770 /* Check if we shouldn't be here */
776 #if defined MENU_DEBUG
777 g_Logger.LogMessage("[SM_MENU] CBaseMenu::Destroy(%p) (release %d) (m_bCancelling %d) (m_bShouldDelete %d)",
784 /* Save the destruction hint about our handle */
785 m_bWillFreeHandle = releaseHandle;
787 /* Now actually do stuff */
788 if (!m_bCancelling || m_bShouldDelete)
793 m_bShouldDelete = true;
797 void CBaseMenu::InternalDelete()
799 if (m_bWillFreeHandle && m_hHandle != BAD_HANDLE)
801 Handle_t hndl = m_hHandle;
804 sec.pOwner = m_pOwner;
805 sec.pIdentity = g_pCoreIdent;
807 m_hHandle = BAD_HANDLE;
809 g_HandleSys.FreeHandle(hndl, &sec);
812 m_pHandler->OnMenuDestroy(this);
817 unsigned int CBaseMenu::GetMenuOptionFlags()
822 void CBaseMenu::SetMenuOptionFlags(unsigned int flags)
827 IMenuHandler *CBaseMenu::GetHandler()
832 unsigned int CBaseMenu::GetBaseMemUsage()
834 return m_Title.size()
835 + m_Strings.GetMemTable()->GetMemUsage()
836 + (m_items.size() * sizeof(CItem));