core/MenuStyle_Radio.cpp
author David Anderson <dvander@alliedmods.net>
Sun Aug 26 17:41:02 2007 +0000 (2007-08-26)
changeset 1369 bd9ccced1b1a
parent 1361 591f6d2fd11d
child 1474 a3b73df84d88
permissions -rw-r--r--
fixed amb834 - command callbacks could potentially occur on invalid clients in very rare cases
dvander@780
     1
/**
dvander@780
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@780
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@780
    28
 *
dvander@780
    29
 * Version: $Id$
dvander@780
    30
 */
dvander@780
    31
dvander@780
    32
#include "MenuStyle_Radio.h"
dvander@780
    33
#include "sm_stringutil.h"
dvander@780
    34
#include "UserMessages.h"
dvander@780
    35
#include "GameConfigs.h"
dvander@846
    36
#include "PlayerManager.h"
dvander@970
    37
#if defined MENU_DEBUG
dvander@970
    38
#include "Logger.h"
dvander@970
    39
#endif
dvander@780
    40
dvander@780
    41
extern const char *g_RadioNumTable[];
dvander@780
    42
CRadioStyle g_RadioMenuStyle;
dvander@780
    43
int g_ShowMenuId = -1;
dvander@785
    44
bool g_bRadioInit = false;
dvander@780
    45
dvander@780
    46
CRadioStyle::CRadioStyle() : m_players(new CBaseMenuPlayer[256+1])
dvander@780
    47
{
dvander@780
    48
}
dvander@780
    49
dvander@846
    50
void CRadioStyle::OnSourceModAllInitialized()
dvander@846
    51
{
dvander@846
    52
	g_Players.AddClientListener(this);
dvander@846
    53
}
dvander@846
    54
dvander@785
    55
void CRadioStyle::OnSourceModLevelChange(const char *mapName)
dvander@780
    56
{
dvander@785
    57
	if (g_bRadioInit)
dvander@785
    58
	{
dvander@785
    59
		return;
dvander@785
    60
	}
dvander@785
    61
dvander@785
    62
	g_bRadioInit = true;
dvander@780
    63
	const char *msg = g_pGameConf->GetKeyValue("HudRadioMenuMsg");
dvander@780
    64
	if (!msg || msg[0] == '\0')
dvander@780
    65
	{
dvander@780
    66
		return;
dvander@780
    67
	}
dvander@780
    68
dvander@780
    69
	g_ShowMenuId = g_UserMsgs.GetMessageIndex(msg);
dvander@780
    70
dvander@780
    71
	if (!IsSupported())
dvander@780
    72
	{
dvander@780
    73
		return;
dvander@780
    74
	}
dvander@780
    75
dvander@780
    76
	g_Menus.AddStyle(this);
dvander@780
    77
	g_Menus.SetDefaultStyle(this);
dvander@780
    78
dvander@780
    79
	g_UserMsgs.HookUserMessage(g_ShowMenuId, this, false);
dvander@780
    80
}
dvander@780
    81
dvander@780
    82
void CRadioStyle::OnSourceModShutdown()
dvander@780
    83
{
dvander@846
    84
	g_Players.RemoveClientListener(this);
dvander@780
    85
	g_UserMsgs.UnhookUserMessage(g_ShowMenuId, this, false);
dvander@790
    86
dvander@790
    87
	while (!m_FreeDisplays.empty())
dvander@790
    88
	{
dvander@790
    89
		delete m_FreeDisplays.front();
dvander@790
    90
		m_FreeDisplays.pop();
dvander@790
    91
	}
dvander@780
    92
}
dvander@780
    93
dvander@780
    94
bool CRadioStyle::IsSupported()
dvander@780
    95
{
dvander@780
    96
	return (g_ShowMenuId != -1);
dvander@780
    97
}
dvander@780
    98
dvander@1335
    99
bool CRadioStyle::OnClientCommand(int client, const char *cmd)
dvander@780
   100
{
dvander@780
   101
	if (strcmp(cmd, "menuselect") == 0)
dvander@780
   102
	{
dvander@780
   103
		if (!m_players[client].bInMenu)
dvander@780
   104
		{
dvander@780
   105
			return false;
dvander@780
   106
		}
dvander@785
   107
dvander@780
   108
		int arg = atoi(engine->Cmd_Argv(1));
dvander@780
   109
		ClientPressedKey(client, arg);
dvander@785
   110
		return true;
dvander@780
   111
	}
dvander@780
   112
dvander@780
   113
	return false;
dvander@780
   114
}
dvander@780
   115
dvander@780
   116
static unsigned int g_last_holdtime = 0;
dvander@780
   117
static unsigned int g_last_client_count = 0;
dvander@780
   118
static int g_last_clients[256];
dvander@780
   119
dvander@780
   120
void CRadioStyle::OnUserMessage(int msg_id, bf_write *bf, IRecipientFilter *pFilter)
dvander@780
   121
{
dvander@780
   122
	int count = pFilter->GetRecipientCount();
dvander@780
   123
	bf_read br(bf->GetBasePointer(), 2);
dvander@780
   124
dvander@780
   125
	br.ReadWord();
dvander@780
   126
	int c = br.ReadChar();
dvander@780
   127
dvander@780
   128
	g_last_holdtime = (c == -1) ? 0 : (unsigned)c;
dvander@780
   129
dvander@780
   130
	for (int i=0; i<count; i++)
dvander@780
   131
	{
dvander@780
   132
		g_last_clients[g_last_client_count++] = pFilter->GetRecipientIndex(i);
dvander@780
   133
	}
dvander@780
   134
}
dvander@780
   135
dvander@780
   136
void CRadioStyle::OnUserMessageSent(int msg_id)
dvander@780
   137
{
dvander@780
   138
	for (unsigned int i=0; i<g_last_client_count; i++)
dvander@780
   139
	{
dvander@780
   140
		int client = g_last_clients[i];
dvander@970
   141
#if defined MENU_DEBUG
dvander@970
   142
		g_Logger.LogMessage("[SM_MENU] CRadioStyle got ShowMenu (client %d) (bInMenu %d)",
dvander@970
   143
			client,
dvander@970
   144
			m_players[client].bInExternMenu);
dvander@970
   145
#endif
dvander@780
   146
		if (m_players[client].bInMenu)
dvander@780
   147
		{
dvander@1005
   148
			_CancelClientMenu(client, MenuCancel_Interrupted, true);
dvander@780
   149
		}
dvander@780
   150
		m_players[client].bInExternMenu = true;
dvander@780
   151
		m_players[client].menuHoldTime = g_last_holdtime;
dvander@780
   152
	}
dvander@780
   153
	g_last_client_count = 0;
dvander@780
   154
}
dvander@780
   155
dvander@787
   156
void CRadioStyle::SendDisplay(int client, IMenuPanel *display)
dvander@780
   157
{
dvander@780
   158
	CRadioDisplay *rDisplay = (CRadioDisplay *)display;
dvander@780
   159
	rDisplay->SendRawDisplay(client, m_players[client].menuHoldTime);
dvander@780
   160
}
dvander@780
   161
dvander@787
   162
IMenuPanel *CRadioStyle::CreatePanel()
dvander@780
   163
{
dvander@790
   164
	return g_RadioMenuStyle.MakeRadioDisplay();
dvander@780
   165
}
dvander@780
   166
dvander@790
   167
IBaseMenu *CRadioStyle::CreateMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner)
dvander@780
   168
{
dvander@790
   169
	return new CRadioMenu(pHandler, pOwner);
dvander@780
   170
}
dvander@780
   171
dvander@780
   172
unsigned int CRadioStyle::GetMaxPageItems()
dvander@780
   173
{
dvander@780
   174
	return 10;
dvander@780
   175
}
dvander@780
   176
dvander@780
   177
const char *CRadioStyle::GetStyleName()
dvander@780
   178
{
dvander@780
   179
	return "radio";
dvander@780
   180
}
dvander@780
   181
dvander@780
   182
CBaseMenuPlayer *CRadioStyle::GetMenuPlayer(int client)
dvander@780
   183
{
dvander@780
   184
	return &m_players[client];
dvander@780
   185
}
dvander@780
   186
dvander@790
   187
CRadioDisplay *CRadioStyle::MakeRadioDisplay(CRadioMenu *menu)
dvander@790
   188
{
dvander@790
   189
	CRadioDisplay *display;
dvander@790
   190
	if (m_FreeDisplays.empty())
dvander@790
   191
	{
dvander@790
   192
		display = new CRadioDisplay();
dvander@790
   193
	} else {
dvander@790
   194
		display = m_FreeDisplays.front();
dvander@790
   195
		m_FreeDisplays.pop();
dvander@790
   196
		display->Reset();
dvander@790
   197
	}
dvander@790
   198
	return display;
dvander@790
   199
}
dvander@790
   200
dvander@790
   201
void CRadioStyle::FreeRadioDisplay(CRadioDisplay *display)
dvander@790
   202
{
dvander@790
   203
	m_FreeDisplays.push(display);
dvander@790
   204
}
dvander@790
   205
dvander@780
   206
CRadioDisplay::CRadioDisplay()
dvander@780
   207
{
dvander@780
   208
	Reset();
dvander@780
   209
}
dvander@780
   210
dvander@780
   211
CRadioDisplay::CRadioDisplay(CRadioMenu *menu)
dvander@780
   212
{
dvander@780
   213
	Reset();
dvander@780
   214
}
dvander@780
   215
dvander@780
   216
bool CRadioDisplay::DrawRawLine(const char *rawline)
dvander@780
   217
{
dvander@780
   218
	m_BufferText.append(rawline);
dvander@780
   219
	m_BufferText.append("\n");
dvander@780
   220
	return true;
dvander@780
   221
}
dvander@780
   222
dvander@780
   223
void CRadioDisplay::Reset()
dvander@780
   224
{
dvander@780
   225
	m_BufferText.assign("");
dvander@780
   226
	m_Title.assign("");
dvander@780
   227
	m_NextPos = 1;
dvander@785
   228
	keys = 0;
dvander@780
   229
}
dvander@780
   230
dvander@840
   231
unsigned int CRadioDisplay::GetCurrentKey()
dvander@840
   232
{
dvander@840
   233
	return m_NextPos;
dvander@840
   234
}
dvander@840
   235
dvander@840
   236
bool CRadioDisplay::SetCurrentKey(unsigned int key)
dvander@840
   237
{
dvander@840
   238
	if (key < m_NextPos || m_NextPos > 10)
dvander@840
   239
	{
dvander@840
   240
		return false;
dvander@840
   241
	}
dvander@840
   242
dvander@840
   243
	m_NextPos = key;
dvander@840
   244
dvander@840
   245
	return true;
dvander@840
   246
}
dvander@840
   247
dvander@780
   248
bool CRadioDisplay::SendDisplay(int client, IMenuHandler *handler, unsigned int time)
dvander@780
   249
{
dvander@780
   250
	return g_RadioMenuStyle.DoClientMenu(client, this, handler, time);
dvander@780
   251
}
dvander@780
   252
dvander@780
   253
bool CRadioDisplay::SetExtOption(MenuOption option, const void *valuePtr)
dvander@780
   254
{
dvander@780
   255
	return false;
dvander@780
   256
}
dvander@780
   257
dvander@780
   258
IMenuStyle *CRadioDisplay::GetParentStyle()
dvander@780
   259
{
dvander@780
   260
	return &g_RadioMenuStyle;
dvander@780
   261
}
dvander@780
   262
dvander@780
   263
void CRadioDisplay::DrawTitle(const char *text, bool onlyIfEmpty/* =false */)
dvander@780
   264
{
dvander@780
   265
	if (m_Title.size() != 0 && onlyIfEmpty)
dvander@780
   266
	{
dvander@780
   267
		return;
dvander@780
   268
	}
dvander@780
   269
	m_Title.assign(text);
dvander@780
   270
}
dvander@780
   271
dvander@780
   272
unsigned int CRadioDisplay::DrawItem(const ItemDrawInfo &item)
dvander@780
   273
{
dvander@780
   274
	if (m_NextPos > 10 || !CanDrawItem(item.style))
dvander@780
   275
	{
dvander@780
   276
		return 0;
dvander@780
   277
	}
dvander@780
   278
dvander@780
   279
	if (item.style & ITEMDRAW_RAWLINE)
dvander@780
   280
	{
dvander@780
   281
		if (item.style & ITEMDRAW_SPACER)
dvander@780
   282
		{
dvander@785
   283
			m_BufferText.append(" \n");
dvander@780
   284
		} else {
dvander@780
   285
			m_BufferText.append(item.display);
dvander@780
   286
			m_BufferText.append("\n");
dvander@780
   287
		}
dvander@780
   288
		return 0;
dvander@780
   289
	} else if (item.style & ITEMDRAW_SPACER) {
dvander@785
   290
		m_BufferText.append(" \n");
dvander@785
   291
		return m_NextPos++;
dvander@785
   292
	} else if (item.style & ITEMDRAW_NOTEXT) {
dvander@780
   293
		return m_NextPos++;
dvander@780
   294
	}
dvander@780
   295
dvander@780
   296
	if (item.style & ITEMDRAW_DISABLED)
dvander@780
   297
	{
dvander@780
   298
		m_BufferText.append(g_RadioNumTable[m_NextPos]);
dvander@780
   299
		m_BufferText.append(item.display);
dvander@780
   300
		m_BufferText.append("\n");
dvander@780
   301
	} else {
dvander@785
   302
		m_BufferText.append("->");
dvander@785
   303
		m_BufferText.append(g_RadioNumTable[m_NextPos]);
dvander@780
   304
		m_BufferText.append(item.display);
dvander@780
   305
		m_BufferText.append("\n");
dvander@780
   306
		keys |= (1<<(m_NextPos-1));
dvander@780
   307
	}
dvander@780
   308
dvander@780
   309
	return m_NextPos++;
dvander@780
   310
}
dvander@780
   311
dvander@780
   312
bool CRadioDisplay::CanDrawItem(unsigned int drawFlags)
dvander@780
   313
{
dvander@780
   314
	if ((drawFlags & ITEMDRAW_IGNORE) == ITEMDRAW_IGNORE)
dvander@780
   315
	{
dvander@780
   316
		return false;
dvander@780
   317
	}
dvander@780
   318
dvander@785
   319
	if ((drawFlags & ITEMDRAW_DISABLED) && (drawFlags & ITEMDRAW_CONTROL))
dvander@785
   320
	{
dvander@785
   321
		return false;
dvander@785
   322
	}
dvander@785
   323
dvander@780
   324
	return true;
dvander@780
   325
}
dvander@780
   326
dvander@780
   327
void CRadioDisplay::SendRawDisplay(int client, unsigned int time)
dvander@780
   328
{
dvander@780
   329
	char buffer[4096];
dvander@780
   330
	size_t len;
dvander@780
   331
dvander@780
   332
	len = UTIL_Format(buffer, sizeof(buffer), "%s\n%s", m_Title.c_str(), m_BufferText.c_str());
dvander@780
   333
dvander@780
   334
	cell_t players[1] = {client};
dvander@780
   335
dvander@819
   336
	int _sel_keys = (keys == 0) ? (1<<9) : keys;
dvander@819
   337
dvander@780
   338
	char *ptr = buffer;
dvander@780
   339
	char save = 0;
dvander@780
   340
	while (true)
dvander@780
   341
	{
dvander@780
   342
		if (len > 240)
dvander@780
   343
		{
dvander@780
   344
			save = ptr[240];
dvander@780
   345
			ptr[240] = '\0';
dvander@780
   346
		}
dvander@1251
   347
		bf_write *buffer = g_UserMsgs.StartMessage(g_ShowMenuId, players, 1, USERMSG_BLOCKHOOKS);
dvander@819
   348
		buffer->WriteWord(_sel_keys);
dvander@780
   349
		buffer->WriteChar(time ? time : -1);
dvander@780
   350
		buffer->WriteByte( (len > 240) ? 1 : 0 );
dvander@780
   351
		buffer->WriteString(ptr);
dvander@780
   352
		g_UserMsgs.EndMessage();
dvander@780
   353
		if (len > 240)
dvander@780
   354
		{
dvander@780
   355
			ptr[240] = save;
dvander@780
   356
			ptr = &ptr[240];
dvander@780
   357
			len -= 240;
dvander@780
   358
		} else {
dvander@780
   359
			break;
dvander@780
   360
		}
dvander@780
   361
	}
dvander@780
   362
}
dvander@780
   363
dvander@1361
   364
int CRadioDisplay::GetAmountRemaining()
dvander@1361
   365
{
dvander@1361
   366
	size_t amt = m_Title.size() + 1 + m_BufferText.size();
dvander@1361
   367
	if (amt >= 511)
dvander@1361
   368
	{
dvander@1361
   369
		return 0;
dvander@1361
   370
	}
dvander@1361
   371
	return (int)(511 - amt);
dvander@1361
   372
}
dvander@1361
   373
dvander@780
   374
void CRadioDisplay::DeleteThis()
dvander@780
   375
{
dvander@780
   376
	delete this;
dvander@780
   377
}
dvander@780
   378
dvander@819
   379
bool CRadioDisplay::SetSelectableKeys(unsigned int keymap)
dvander@819
   380
{
dvander@819
   381
	keys = (signed)keymap;
dvander@820
   382
	return true;
dvander@819
   383
}
dvander@819
   384
dvander@790
   385
CRadioMenu::CRadioMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner) : 
dvander@790
   386
CBaseMenu(pHandler, &g_RadioMenuStyle, pOwner)
dvander@780
   387
{
dvander@780
   388
}
dvander@780
   389
dvander@780
   390
bool CRadioMenu::SetExtOption(MenuOption option, const void *valuePtr)
dvander@780
   391
{
dvander@780
   392
	return false;
dvander@780
   393
}
dvander@780
   394
dvander@787
   395
IMenuPanel *CRadioMenu::CreatePanel()
dvander@780
   396
{
dvander@790
   397
	return g_RadioMenuStyle.MakeRadioDisplay(this);
dvander@780
   398
}
dvander@780
   399
dvander@1269
   400
bool CRadioMenu::Display(int client, unsigned int time, IMenuHandler *alt_handler)
dvander@780
   401
{
dvander@970
   402
#if defined MENU_DEBUG
dvander@970
   403
	g_Logger.LogMessage("[SM_MENU] CRadioMenu::Display(%p) (client %d) (time %d)",
dvander@970
   404
		this,
dvander@970
   405
		client,
dvander@970
   406
		time);
dvander@970
   407
#endif
dvander@877
   408
	if (m_bCancelling)
dvander@877
   409
	{
dvander@877
   410
		return false;
dvander@877
   411
	}
dvander@877
   412
dvander@1269
   413
	return g_RadioMenuStyle.DoClientMenu(client, this, alt_handler ? alt_handler : m_pHandler, time);
dvander@877
   414
}
dvander@877
   415
dvander@780
   416
void CRadioMenu::Cancel_Finally()
dvander@780
   417
{
dvander@780
   418
	g_RadioMenuStyle.CancelMenu(this);
dvander@780
   419
}
dvander@780
   420
dvander@780
   421
const char *g_RadioNumTable[11] = 
dvander@780
   422
{
dvander@785
   423
	"0. ", "1. ", "2. ", "3. ", "4. ", "5. ", "6. ", "7. ", "8. ", "9. ", "0. "
dvander@780
   424
};