core/MenuStyle_Valve.cpp
author David Anderson <dvander@alliedmods.net>
Sun Oct 21 17:58:35 2007 +0000 (2007-10-21)
changeset 1620 fd5c786ca8e5
parent 1605 ae3fb5e25a00
child 1766 d30c252089be
permissions -rw-r--r--
atcprintf() is now fully re-entrant, meaning translations can be used from inside translations
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2007 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 "sm_stringutil.h"
    33 #include "PlayerManager.h"
    34 #include "MenuStyle_Valve.h"
    35 #include "Translator.h"
    36 #include "PlayerManager.h"
    37 #include "ConCmdManager.h"
    38 
    39 SH_DECL_HOOK4_void(IServerPluginHelpers, CreateMessage, SH_NOATTRIB, false, edict_t *, DIALOG_TYPE, KeyValues *, IServerPluginCallbacks *);
    40 
    41 ValveMenuStyle g_ValveMenuStyle;
    42 extern const char *g_OptionNumTable[];
    43 extern const char *g_OptionCmdTable[];
    44 CallClass<IServerPluginHelpers> *g_pSPHCC = NULL;
    45 
    46 ValveMenuStyle::ValveMenuStyle() : m_players(new CValveMenuPlayer[256+1])
    47 {
    48 }
    49 
    50 CBaseMenuPlayer *ValveMenuStyle::GetMenuPlayer(int client)
    51 {
    52 	return &m_players[client];
    53 }
    54 
    55 bool ValveMenuStyle::OnClientCommand(int client, const char *cmdname, const CCommand &cmd)
    56 {
    57 	if (strcmp(cmdname, "sm_vmenuselect") == 0)
    58 	{
    59 		int key_press = atoi(cmd.Arg(1));
    60 		g_ValveMenuStyle.ClientPressedKey(client, key_press);
    61 		return true;
    62 	}
    63 
    64 	return false;
    65 }
    66 
    67 void ValveMenuStyle::OnSourceModAllInitialized()
    68 {
    69 	g_Players.AddClientListener(this);
    70 	SH_ADD_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
    71 	g_pSPHCC = SH_GET_CALLCLASS(serverpluginhelpers);
    72 }
    73 
    74 void ValveMenuStyle::OnSourceModShutdown()
    75 {
    76 	SH_RELEASE_CALLCLASS(g_pSPHCC);
    77 	SH_REMOVE_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
    78 	g_Players.RemoveClientListener(this);
    79 }
    80 
    81 void ValveMenuStyle::HookCreateMessage(edict_t *pEdict,
    82 									   DIALOG_TYPE type,
    83 									   KeyValues *kv,
    84 									   IServerPluginCallbacks *plugin)
    85 {
    86 	if (type != DIALOG_MENU)
    87 	{
    88 		return;
    89 	}
    90 
    91 	int client = engine->IndexOfEdict(pEdict);
    92 	if (client < 1 || client > 256)
    93 	{
    94 		return;
    95 	}
    96 
    97 	CValveMenuPlayer *player = &m_players[client];
    98 	
    99 	/* We don't care if the player is in a menu because, for all intents and purposes,
   100 	 * the menu is completely private.  Instead, we just figure out the level we'll need
   101 	 * in order to override it.
   102 	 */
   103 	player->curPrioLevel = kv->GetInt("level", player->curPrioLevel);
   104 
   105 	/* Oh no! What happens if we got a menu that overwrites ours?! */
   106 	if (player->bInMenu)
   107 	{
   108 		/* Okay, let the external menu survive for now.  It may live another 
   109 		 * day to avenge its grandfather, killed in the great Menu Interruption
   110 		 * battle.
   111 		 */
   112 		_CancelClientMenu(client, MenuCancel_Interrupted, true);
   113 	}
   114 }
   115 
   116 IMenuPanel *ValveMenuStyle::CreatePanel()
   117 {
   118 	return new CValveMenuDisplay();
   119 }
   120 
   121 IBaseMenu *ValveMenuStyle::CreateMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner)
   122 {
   123 	return new CValveMenu(pHandler, pOwner);
   124 }
   125 
   126 const char *ValveMenuStyle::GetStyleName()
   127 {
   128 	return "valve";
   129 }
   130 
   131 unsigned int ValveMenuStyle::GetMaxPageItems()
   132 {
   133 	return 8;
   134 }
   135 
   136 void ValveMenuStyle::SendDisplay(int client, IMenuPanel *display)
   137 {
   138 	m_players[client].curPrioLevel--;
   139 	CValveMenuDisplay *vDisplay = (CValveMenuDisplay *)display;
   140 	vDisplay->SendRawDisplay(client, m_players[client].curPrioLevel, m_players[client].menuHoldTime);
   141 }
   142 
   143 bool ValveMenuStyle::DoClientMenu(int client, IMenuPanel *menu, IMenuHandler *mh, unsigned int time)
   144 {
   145 	if (vsp_interface == NULL)
   146 	{
   147 		return false;
   148 	}
   149 
   150 	return BaseMenuStyle::DoClientMenu(client, menu, mh, time);
   151 }
   152 
   153 bool ValveMenuStyle::DoClientMenu(int client, CBaseMenu *menu, unsigned int first_item, IMenuHandler *mh, unsigned int time)
   154 {
   155 	if (vsp_interface == NULL)
   156 	{
   157 		mh->OnMenuStart(menu);
   158 		mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
   159 		mh->OnMenuEnd(menu, MenuEnd_Cancelled);
   160 		return false;
   161 	}
   162 
   163 	return BaseMenuStyle::DoClientMenu(client, menu, first_item, mh, time);
   164 }
   165 
   166 CValveMenuDisplay::CValveMenuDisplay()
   167 {
   168 	m_pKv = NULL;
   169 	Reset();
   170 }
   171 
   172 CValveMenuDisplay::CValveMenuDisplay(CValveMenu *pMenu)
   173 {
   174 	m_pKv = NULL;
   175 	Reset();
   176 	m_pKv->SetColor("color", pMenu->m_IntroColor);
   177 	m_pKv->SetString("title", pMenu->m_IntroMsg);
   178 }
   179 
   180 void CValveMenuDisplay::DeleteThis()
   181 {
   182 	delete this;
   183 }
   184 
   185 CValveMenuDisplay::~CValveMenuDisplay()
   186 {
   187 	m_pKv->deleteThis();
   188 }
   189 
   190 IMenuStyle *CValveMenuDisplay::GetParentStyle()
   191 {
   192 	return &g_ValveMenuStyle;
   193 }
   194 
   195 void CValveMenuDisplay::Reset()
   196 {
   197 	if (m_pKv)
   198 	{
   199 		m_pKv->deleteThis();
   200 	}
   201 	m_pKv = new KeyValues("menu");
   202 	m_NextPos = 1;
   203 	m_TitleDrawn = false;
   204 }
   205 
   206 unsigned int CValveMenuDisplay::GetCurrentKey()
   207 {
   208 	return m_NextPos;
   209 }
   210 
   211 bool CValveMenuDisplay::SetCurrentKey(unsigned int key)
   212 {
   213 	if (key < m_NextPos || key > 9)
   214 	{
   215 		return false;
   216 	}
   217 
   218 	m_NextPos = key;
   219 
   220 	return true;
   221 }
   222 
   223 bool CValveMenuDisplay::SetExtOption(MenuOption option, const void *valuePtr)
   224 {
   225 	if (option == MenuOption_IntroMessage)
   226 	{
   227 		m_pKv->SetString("title", (const char *)valuePtr);
   228 		return true;
   229 	} else if (option == MenuOption_IntroColor) {
   230 		int *array = (int *)valuePtr;
   231 		m_pKv->SetColor("color", Color(array[0], array[1], array[2], array[3]));
   232 		return true;
   233 	} else if (option == MenuOption_Priority) {
   234 		m_pKv->SetInt("level", *(int *)valuePtr);
   235 		return true;
   236 	}
   237 
   238 	return false;
   239 }
   240 
   241 bool CValveMenuDisplay::CanDrawItem(unsigned int drawFlags)
   242 {
   243 	/**
   244 	 * ITEMDRAW_RAWLINE - We can't draw random text, and this doesn't add a slot,
   245 	 *  so it's completely safe to ignore it.
   246 	 * -----------------------------------------
   247 	 */
   248 	if (drawFlags & ITEMDRAW_RAWLINE)
   249 	{
   250 		return false;
   251 	}
   252 
   253 	/**
   254 	 * Special cases, explained in DrawItem()
   255 	 */
   256 	if ((drawFlags & ITEMDRAW_NOTEXT)
   257 		|| (drawFlags & ITEMDRAW_SPACER))
   258 	{
   259 		return true;
   260 	}
   261 
   262 	/**
   263 	 * We can't draw disabled text.  We could bump the position, but we
   264 	 * want DirectDraw() to find some actual items to display.
   265 	 */
   266 	if (drawFlags & ITEMDRAW_DISABLED)
   267 	{
   268 		return false;
   269 	}
   270 
   271 	return true;
   272 }
   273 
   274 unsigned int CValveMenuDisplay::DrawItem(const ItemDrawInfo &item)
   275 {
   276 	if (m_NextPos > 9 || !CanDrawItem(item.style))
   277 	{
   278 		return 0;
   279 	}
   280 
   281 	/**
   282 	 * For these cases we can't draw anything at all, but
   283 	 * we can at least bump the position since we were explicitly asked to.
   284 	 */
   285 	if ((item.style & ITEMDRAW_NOTEXT)
   286 		|| (item.style & ITEMDRAW_SPACER))
   287 	{
   288 		return m_NextPos++;
   289 	}
   290 
   291 	char buffer[255];
   292 	UTIL_Format(buffer, sizeof(buffer), "%d. %s", m_NextPos, item.display);
   293 
   294 	KeyValues *ki = m_pKv->FindKey(g_OptionNumTable[m_NextPos], true);
   295 	ki->SetString("command", g_OptionCmdTable[m_NextPos]);
   296 	ki->SetString("msg", buffer);
   297 
   298 	return m_NextPos++;
   299 }
   300 
   301 void CValveMenuDisplay::DrawTitle(const char *text, bool onlyIfEmpty/* =false */)
   302 {
   303 	if (onlyIfEmpty && m_TitleDrawn)
   304 	{
   305 		return;
   306 	}
   307 
   308 	m_pKv->SetString("msg", text);
   309 	m_TitleDrawn = true;
   310 }
   311 
   312 bool CValveMenuDisplay::DrawRawLine(const char *rawline)
   313 {
   314 	return false;
   315 }
   316 
   317 void CValveMenuDisplay::SendRawDisplay(int client, int priority, unsigned int time)
   318 {
   319 	m_pKv->SetInt("level", priority);
   320 	m_pKv->SetInt("time", time ? time : 200);
   321 
   322 	SH_CALL(g_pSPHCC, &IServerPluginHelpers::CreateMessage)(
   323 		engine->PEntityOfEntIndex(client),
   324 		DIALOG_MENU,
   325 		m_pKv,
   326 		vsp_interface);
   327 }
   328 
   329 bool CValveMenuDisplay::SendDisplay(int client, IMenuHandler *handler, unsigned int time)
   330 {
   331 	return g_ValveMenuStyle.DoClientMenu(client, this, handler, time);
   332 }
   333 
   334 bool CValveMenuDisplay::SetSelectableKeys(unsigned int keymap)
   335 {
   336 	return false;
   337 }
   338 
   339 int CValveMenuDisplay::GetAmountRemaining()
   340 {
   341 	/* :TODO: this is a lie, but nothing really seems meaningful... */
   342 	return -1;
   343 }
   344 
   345 CValveMenu::CValveMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner) : 
   346 CBaseMenu(pHandler, &g_ValveMenuStyle, pOwner), 
   347 	m_IntroColor(255, 0, 0, 255)
   348 {
   349 	strcpy(m_IntroMsg, "You have a menu, press ESC");
   350 	m_Pagination = 5;
   351 }
   352 
   353 void CValveMenu::Cancel_Finally()
   354 {
   355 	g_ValveMenuStyle.CancelMenu(this);
   356 }
   357 
   358 bool CValveMenu::SetPagination(unsigned int itemsPerPage)
   359 {
   360 	if (itemsPerPage > 5)
   361 	{
   362 		return false;
   363 	}
   364 
   365 	return CBaseMenu::SetPagination(itemsPerPage);
   366 }
   367 
   368 bool CValveMenu::SetExtOption(MenuOption option, const void *valuePtr)
   369 {
   370 	if (option == MenuOption_IntroMessage)
   371 	{
   372 		strncopy(m_IntroMsg, (const char *)valuePtr, sizeof(m_IntroMsg));
   373 		return true;
   374 	} else if (option == MenuOption_IntroColor) {
   375 		unsigned int *array = (unsigned int *)valuePtr;
   376 		m_IntroColor = Color(array[0], array[1], array[2], array[3]);
   377 		return true;
   378 	}
   379 
   380 	return false;
   381 }
   382 
   383 bool CValveMenu::Display(int client, unsigned int time, IMenuHandler *alt_handler)
   384 {
   385 	return DisplayAtItem(client, time, 0, alt_handler);
   386 }
   387 
   388 bool CValveMenu::DisplayAtItem(int client,
   389 							   unsigned int time,
   390 							   unsigned int start_item,
   391 							   IMenuHandler *alt_handler/* =NULL */)
   392 {
   393 	if (m_bCancelling)
   394 	{
   395 		return false;
   396 	}
   397 
   398 	return g_ValveMenuStyle.DoClientMenu(client, this, start_item, alt_handler ? alt_handler : m_pHandler, time);
   399 }
   400 
   401 IMenuPanel *CValveMenu::CreatePanel()
   402 {
   403 	return new CValveMenuDisplay(this);
   404 }
   405 
   406 void CValveMenu::SetMenuOptionFlags(unsigned int flags)
   407 {
   408 	flags |= MENUFLAG_BUTTON_EXIT;
   409 	CBaseMenu::SetMenuOptionFlags(flags);
   410 }
   411 
   412 const char *g_OptionNumTable[] = 
   413 {
   414 	"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"
   415 };
   416 
   417 const char *g_OptionCmdTable[] = 
   418 {
   419 	"sm_vmenuselect 0", /* INVALID! */
   420 	"sm_vmenuselect 1",
   421 	"sm_vmenuselect 2",
   422 	"sm_vmenuselect 3",
   423 	"sm_vmenuselect 4",
   424 	"sm_vmenuselect 5",
   425 	"sm_vmenuselect 6",
   426 	"sm_vmenuselect 7",
   427 	"sm_vmenuselect 8",
   428 	"sm_vmenuselect 9",
   429 	"sm_vmenuselect 10"
   430 };