extensions/topmenus/TopMenu.cpp
author David Anderson <dvander@alliedmods.net>
Wed Sep 26 14:49:10 2007 +0000 (2007-09-26)
changeset 1491 fb537eedb76a
parent 1489 f782b33f6615
child 1495 5e85546abc33
permissions -rw-r--r--
whoops, forgot to set svn:keywords
dvander@1488
     1
/**
dvander@1488
     2
 * vim: set ts=4 :
dvander@1488
     3
 * =============================================================================
dvander@1488
     4
 * SourceMod Sample Extension
dvander@1488
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1488
     6
 * =============================================================================
dvander@1488
     7
 *
dvander@1488
     8
 * This program is free software; you can redistribute it and/or modify it under
dvander@1488
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@1488
    10
 * Free Software Foundation.
dvander@1488
    11
 * 
dvander@1488
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@1488
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@1488
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@1488
    15
 * details.
dvander@1488
    16
 *
dvander@1488
    17
 * You should have received a copy of the GNU General Public License along with
dvander@1488
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1488
    19
 *
dvander@1488
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@1488
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@1488
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@1488
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@1488
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@1488
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@1488
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@1488
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@1488
    28
 *
dvander@1491
    29
 * Version: $Id$
dvander@1488
    30
 */
dvander@1488
    31
dvander@1488
    32
#include <stdlib.h>
dvander@1489
    33
#include <stdarg.h>
dvander@1488
    34
#include "TopMenu.h"
dvander@1488
    35
dvander@1488
    36
struct obj_by_name_t
dvander@1488
    37
{
dvander@1488
    38
	unsigned int obj_index;
dvander@1488
    39
	char name[64];
dvander@1488
    40
};
dvander@1488
    41
dvander@1488
    42
int _SortObjectNamesDescending(const void *ptr1, const void *ptr2);
dvander@1488
    43
unsigned int strncopy(char *dest, const char *src, size_t count);
dvander@1488
    44
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
dvander@1488
    45
dvander@1488
    46
TopMenu::TopMenu(ITopMenuObjectCallbacks *callbacks)
dvander@1488
    47
{
dvander@1488
    48
	m_clients = NULL;
dvander@1488
    49
	m_SerialNo = 1;
dvander@1488
    50
	m_pTitle = callbacks;
dvander@1488
    51
	m_max_clients = 0;
dvander@1488
    52
dvander@1488
    53
	if (playerhelpers->IsServerActivated())
dvander@1488
    54
	{
dvander@1488
    55
		CreatePlayers(playerhelpers->GetMaxClients());
dvander@1488
    56
	}
dvander@1488
    57
}
dvander@1488
    58
dvander@1488
    59
TopMenu::~TopMenu()
dvander@1488
    60
{
dvander@1488
    61
	/* Delete all categories */
dvander@1488
    62
	for (size_t i = 0; i < m_Categories.size(); i++)
dvander@1488
    63
	{
dvander@1488
    64
		delete m_Categories[i];
dvander@1488
    65
	}
dvander@1488
    66
dvander@1488
    67
	/* Delete all items */
dvander@1488
    68
	for (size_t i = 0; i < m_Objects.size(); i++)
dvander@1488
    69
	{
dvander@1488
    70
		delete m_Objects[i];
dvander@1488
    71
	}
dvander@1488
    72
dvander@1488
    73
	/* Delete all cached config entries */
dvander@1488
    74
	for (size_t i = 0; i < m_Config.cats.size(); i++)
dvander@1488
    75
	{
dvander@1488
    76
		delete m_Config.cats[i];
dvander@1488
    77
	}
dvander@1488
    78
dvander@1488
    79
	/* Sweep players */
dvander@1488
    80
	for (int i = 0; i <= m_max_clients; i++)
dvander@1488
    81
	{
dvander@1488
    82
		TearDownClient(&m_clients[i]);
dvander@1488
    83
	}
dvander@1488
    84
	delete [] m_clients;
dvander@1488
    85
}
dvander@1488
    86
dvander@1488
    87
void TopMenu::OnClientConnected(int client)
dvander@1488
    88
{
dvander@1488
    89
	if (m_clients == NULL)
dvander@1488
    90
	{
dvander@1488
    91
		return;
dvander@1488
    92
	}
dvander@1488
    93
dvander@1488
    94
	topmenu_player_t *player = &m_clients[client];
dvander@1488
    95
	TearDownClient(player);
dvander@1488
    96
}
dvander@1488
    97
dvander@1488
    98
void TopMenu::OnClientDisconnected(int client)
dvander@1488
    99
{
dvander@1488
   100
	if (m_clients == NULL)
dvander@1488
   101
	{
dvander@1488
   102
		return;
dvander@1488
   103
	}
dvander@1488
   104
dvander@1488
   105
	topmenu_player_t *player = &m_clients[client];
dvander@1488
   106
	TearDownClient(player);
dvander@1488
   107
}
dvander@1488
   108
dvander@1488
   109
void TopMenu::OnServerActivated(int max_clients)
dvander@1488
   110
{
dvander@1488
   111
	if (m_clients == NULL)
dvander@1488
   112
	{
dvander@1488
   113
		CreatePlayers(max_clients);
dvander@1488
   114
	}
dvander@1488
   115
}
dvander@1488
   116
dvander@1488
   117
unsigned int TopMenu::AddToMenu(const char *name,
dvander@1488
   118
								TopMenuObjectType type,
dvander@1488
   119
								ITopMenuObjectCallbacks *callbacks,
dvander@1488
   120
								IdentityToken_t *owner,
dvander@1488
   121
								const char *cmdname,
dvander@1488
   122
								FlagBits flags,
dvander@1488
   123
								unsigned int parent)
dvander@1488
   124
{
dvander@1488
   125
	/* Sanity checks */
dvander@1488
   126
	if (type == TopMenuObject_Category && parent != 0)
dvander@1488
   127
	{
dvander@1488
   128
		return 0;
dvander@1488
   129
	}
dvander@1488
   130
	else if (type == TopMenuObject_Item && parent == 0)
dvander@1488
   131
	{
dvander@1488
   132
		return 0;
dvander@1488
   133
	}
dvander@1488
   134
	else if (m_ObjLookup.retrieve(name) != NULL)
dvander@1488
   135
	{
dvander@1488
   136
		return 0;
dvander@1488
   137
	}
dvander@1488
   138
dvander@1488
   139
	/* If we're adding an item, make sure the parent is valid, 
dvander@1488
   140
	 * and that the parent is a category.
dvander@1488
   141
	 */
dvander@1488
   142
	topmenu_object_t *parent_obj = NULL;
dvander@1488
   143
	topmenu_category_t *parent_cat = NULL;
dvander@1488
   144
	if (type == TopMenuObject_Item)
dvander@1488
   145
	{
dvander@1488
   146
		/* Check parent index.  Note it will be >= 1 here. */
dvander@1488
   147
		if (parent > m_Objects.size() || m_Objects[parent - 1]->is_free)
dvander@1488
   148
		{
dvander@1488
   149
			return 0;
dvander@1488
   150
		}
dvander@1488
   151
		parent_obj = m_Objects[parent - 1];
dvander@1488
   152
dvander@1488
   153
		/* Find an equivalent pointer in the category array. */
dvander@1488
   154
		for (size_t i = 0; i < m_Categories.size(); i++)
dvander@1488
   155
		{
dvander@1488
   156
			if (m_Categories[i]->obj == parent_obj)
dvander@1488
   157
			{
dvander@1488
   158
				parent_cat = m_Categories[i];
dvander@1488
   159
				break;
dvander@1488
   160
			}
dvander@1488
   161
		}
dvander@1488
   162
dvander@1488
   163
		/* If none was found, leave. */
dvander@1488
   164
		if (parent_cat == NULL)
dvander@1488
   165
		{
dvander@1488
   166
			return 0;
dvander@1488
   167
		}
dvander@1488
   168
	}
dvander@1488
   169
dvander@1488
   170
	/* Re-use an old object pointer if we can. */
dvander@1488
   171
	topmenu_object_t *obj = NULL;
dvander@1488
   172
	for (size_t i = 0; i < m_Objects.size(); i++)
dvander@1488
   173
	{
dvander@1488
   174
		if (m_Objects[i]->is_free == true)
dvander@1488
   175
		{
dvander@1488
   176
			obj = m_Objects[i];
dvander@1488
   177
			break;
dvander@1488
   178
		}
dvander@1488
   179
	}
dvander@1488
   180
dvander@1488
   181
	/* Otherwise, allocate a new one. */
dvander@1488
   182
	if (obj == NULL)
dvander@1488
   183
	{
dvander@1488
   184
		obj = new topmenu_object_t;
dvander@1488
   185
		obj->object_id = ((unsigned int)m_Objects.size()) + 1;
dvander@1488
   186
		m_Objects.push_back(obj);
dvander@1488
   187
	}
dvander@1488
   188
dvander@1488
   189
	/* Initialize the object's properties. */
dvander@1488
   190
	obj->callbacks = callbacks;
dvander@1488
   191
	obj->flags = flags;
dvander@1488
   192
	obj->owner = owner;
dvander@1488
   193
	obj->type = type;
dvander@1488
   194
	obj->is_free = false;
dvander@1488
   195
	obj->parent = parent_obj;
dvander@1488
   196
	strncopy(obj->name, name, sizeof(obj->name));
dvander@1488
   197
	strncopy(obj->cmdname, cmdname ? cmdname : "", sizeof(obj->cmdname));
dvander@1488
   198
dvander@1488
   199
	if (obj->type == TopMenuObject_Category)
dvander@1488
   200
	{
dvander@1488
   201
		/* Create a new category entry */
dvander@1488
   202
		topmenu_category_t *cat = new topmenu_category_t;
dvander@1488
   203
		cat->obj = obj;
dvander@1488
   204
		cat->reorder = false;
dvander@1488
   205
		cat->serial = 1;
dvander@1488
   206
dvander@1488
   207
		/* Add it, then update our serial change number. */
dvander@1488
   208
		m_Categories.push_back(cat);
dvander@1488
   209
		m_SerialNo++;
dvander@1488
   210
dvander@1488
   211
		/* Updating sorting info */
dvander@1488
   212
		m_bCatsNeedResort = true;
dvander@1488
   213
	}
dvander@1488
   214
	else if (obj->type == TopMenuObject_Item)
dvander@1488
   215
	{
dvander@1488
   216
		/* Update the category, mark it as needing changes */
dvander@1488
   217
		parent_cat->obj_list.push_back(obj);
dvander@1488
   218
		parent_cat->reorder = true;
dvander@1488
   219
		parent_cat->serial++;
dvander@1488
   220
	}
dvander@1488
   221
dvander@1488
   222
	m_ObjLookup.insert(name, obj);
dvander@1488
   223
dvander@1488
   224
	return obj->object_id;
dvander@1488
   225
}
dvander@1488
   226
dvander@1488
   227
void TopMenu::RemoveFromMenu(unsigned int object_id)
dvander@1488
   228
{
dvander@1488
   229
	if (object_id == 0 
dvander@1488
   230
		|| object_id > m_Objects.size() 
dvander@1488
   231
		|| m_Objects[object_id - 1]->is_free)
dvander@1488
   232
	{
dvander@1488
   233
		return;
dvander@1488
   234
	}
dvander@1488
   235
dvander@1488
   236
	topmenu_object_t *obj = m_Objects[object_id - 1];
dvander@1488
   237
dvander@1488
   238
	m_ObjLookup.remove(obj->name);
dvander@1488
   239
dvander@1488
   240
	if (obj->type == TopMenuObject_Category)
dvander@1488
   241
	{
dvander@1488
   242
		/* Find it in the category list */
dvander@1488
   243
		for (size_t i = 0; i < m_Categories.size(); i++)
dvander@1488
   244
		{
dvander@1488
   245
			if (m_Categories[i]->obj == obj)
dvander@1488
   246
			{
dvander@1488
   247
				/* Erase from here */
dvander@1488
   248
				delete m_Categories[i];
dvander@1488
   249
				m_Categories.erase(m_Categories.iterAt(i));
dvander@1488
   250
				break;
dvander@1488
   251
			}
dvander@1488
   252
		}
dvander@1488
   253
		/* Update us as changed */
dvander@1488
   254
		m_SerialNo++;
dvander@1488
   255
		m_bCatsNeedResort = true;
dvander@1488
   256
	}
dvander@1488
   257
	else if (obj->type == TopMenuObject_Item)
dvander@1488
   258
	{
dvander@1488
   259
		/* Find the category this item is in. */
dvander@1488
   260
		topmenu_category_t *parent_cat = NULL;
dvander@1488
   261
		for (size_t i = 0; i < m_Categories.size(); i++)
dvander@1488
   262
		{
dvander@1488
   263
			if (m_Categories[i]->obj == obj->parent)
dvander@1488
   264
			{
dvander@1488
   265
				parent_cat = m_Categories[i];
dvander@1488
   266
				break;
dvander@1488
   267
			}
dvander@1488
   268
		}
dvander@1488
   269
dvander@1488
   270
		/* Erase it from the category's lists. */
dvander@1488
   271
		if (parent_cat)
dvander@1488
   272
		{
dvander@1488
   273
			for (size_t i = 0; i < parent_cat->obj_list.size(); i++)
dvander@1488
   274
			{
dvander@1488
   275
				if (parent_cat->obj_list[i] == obj)
dvander@1488
   276
				{
dvander@1488
   277
					parent_cat->obj_list.erase(parent_cat->obj_list.iterAt(i));
dvander@1488
   278
					break;
dvander@1488
   279
				}
dvander@1488
   280
			}
dvander@1488
   281
			parent_cat->reorder = true;
dvander@1488
   282
			parent_cat->serial++;
dvander@1488
   283
		}
dvander@1488
   284
	}
dvander@1488
   285
dvander@1488
   286
	/* Finally, mark the object as free. */
dvander@1488
   287
	obj->is_free = true;
dvander@1488
   288
}
dvander@1488
   289
dvander@1488
   290
bool TopMenu::DisplayMenu(int client, unsigned int hold_time, TopMenuPosition position)
dvander@1488
   291
{
dvander@1488
   292
	if (m_clients == NULL)
dvander@1488
   293
	{
dvander@1488
   294
		return false;
dvander@1488
   295
	}
dvander@1488
   296
dvander@1488
   297
	IGamePlayer *pPlayer = playerhelpers->GetGamePlayer(client);
dvander@1488
   298
	if (!pPlayer->IsInGame())
dvander@1488
   299
	{
dvander@1488
   300
		return false;
dvander@1488
   301
	}
dvander@1488
   302
dvander@1488
   303
	UpdateClientRoot(client, pPlayer);
dvander@1488
   304
dvander@1488
   305
	topmenu_player_t *pClient = &m_clients[client];
dvander@1488
   306
	if (pClient->root == NULL)
dvander@1488
   307
	{
dvander@1488
   308
		return false;
dvander@1488
   309
	}
dvander@1488
   310
dvander@1488
   311
	bool return_value = false;
dvander@1488
   312
dvander@1488
   313
	if (position == TopMenuPosition_LastCategory && 
dvander@1488
   314
		pClient->last_category < m_Categories.size())
dvander@1488
   315
	{
dvander@1488
   316
		return_value = DisplayCategory(client, pClient->last_category, hold_time, true);
dvander@1488
   317
	}
dvander@1488
   318
	else if (position == TopMenuPosition_LastRoot)
dvander@1488
   319
	{
dvander@1488
   320
		pClient->root->DisplayAtItem(client, hold_time, pClient->last_root_pos);
dvander@1488
   321
	}
dvander@1488
   322
	else if (position == TopMenuPosition_Start)
dvander@1488
   323
	{
dvander@1488
   324
		pClient->last_position = 0;
dvander@1488
   325
		pClient->last_category = 0;
dvander@1488
   326
		return_value = pClient->root->Display(client, hold_time);
dvander@1488
   327
	}
dvander@1488
   328
dvander@1488
   329
	return return_value;
dvander@1488
   330
}
dvander@1488
   331
dvander@1488
   332
bool TopMenu::DisplayCategory(int client, unsigned int category, unsigned int hold_time, bool last_position)
dvander@1488
   333
{
dvander@1488
   334
	UpdateClientCategory(client, category);
dvander@1488
   335
dvander@1488
   336
	topmenu_player_t *pClient = &m_clients[client];
dvander@1488
   337
	if (category >= pClient->cat_count
dvander@1488
   338
		|| pClient->cats[category].menu == NULL)
dvander@1488
   339
	{
dvander@1488
   340
		return false;
dvander@1488
   341
	}
dvander@1488
   342
dvander@1488
   343
	bool return_value = false;
dvander@1488
   344
dvander@1488
   345
	topmenu_player_category_t *player_cat = &(pClient->cats[category]);
dvander@1488
   346
dvander@1488
   347
	pClient->last_category = category;
dvander@1488
   348
	if (last_position)
dvander@1488
   349
	{
dvander@1488
   350
		return_value = player_cat->menu->DisplayAtItem(client, hold_time, pClient->last_position);
dvander@1488
   351
	}
dvander@1488
   352
	else
dvander@1488
   353
	{
dvander@1488
   354
		return_value = player_cat->menu->Display(client, hold_time);
dvander@1488
   355
	}
dvander@1488
   356
dvander@1488
   357
	return return_value;
dvander@1488
   358
}
dvander@1488
   359
dvander@1488
   360
void TopMenu::OnMenuSelect2(IBaseMenu *menu, int client, unsigned int item, unsigned int item_on_page)
dvander@1488
   361
{
dvander@1488
   362
	const char *item_name = menu->GetItemInfo(item, NULL);
dvander@1488
   363
	if (!item_name)
dvander@1488
   364
	{
dvander@1488
   365
		return;
dvander@1488
   366
	}
dvander@1488
   367
dvander@1488
   368
	topmenu_object_t *obj;
dvander@1488
   369
	topmenu_player_t *pClient = &m_clients[client];
dvander@1488
   370
	topmenu_object_t **pObject = m_ObjLookup.retrieve(item_name);
dvander@1488
   371
	if (pObject == NULL)
dvander@1488
   372
	{
dvander@1488
   373
		return;
dvander@1488
   374
	}
dvander@1488
   375
dvander@1488
   376
	obj = *pObject;
dvander@1488
   377
dvander@1488
   378
	/* We now have the object... what do we do with it? */
dvander@1488
   379
	if (obj->type == TopMenuObject_Category)
dvander@1488
   380
	{
dvander@1488
   381
		/* If it's a category, the user wants to view it.. */
dvander@1488
   382
		for (size_t i = 0; i < m_Categories.size(); i++)
dvander@1488
   383
		{
dvander@1488
   384
			if (m_Categories[i]->obj == obj)
dvander@1488
   385
			{
dvander@1488
   386
				pClient->last_root_pos = item_on_page;
dvander@1488
   387
				DisplayCategory(client, (unsigned int)i, MENU_TIME_FOREVER, false);
dvander@1488
   388
				break;
dvander@1488
   389
			}
dvander@1488
   390
		}
dvander@1488
   391
	}
dvander@1488
   392
	else
dvander@1488
   393
	{
dvander@1488
   394
		pClient->last_position = item_on_page;
dvander@1488
   395
		
dvander@1488
   396
		/* Re-check access in case this user had their credentials revoked */
dvander@1488
   397
		if (obj->cmdname[0] != '\0' && !adminsys->CheckAccess(client, obj->cmdname, obj->flags, false))
dvander@1488
   398
		{
dvander@1488
   399
			DisplayMenu(client, 0, TopMenuPosition_LastCategory);
dvander@1488
   400
			return;
dvander@1488
   401
		}
dvander@1488
   402
		
dvander@1488
   403
		/* Pass the information on to the callback */
dvander@1488
   404
		obj->callbacks->OnTopMenuSelectOption(client, obj->object_id);
dvander@1488
   405
	}
dvander@1488
   406
}
dvander@1488
   407
dvander@1488
   408
void TopMenu::OnMenuDrawItem(IBaseMenu *menu, int client, unsigned int item, unsigned int &style)
dvander@1488
   409
{
dvander@1488
   410
	const char *item_name = menu->GetItemInfo(item, NULL);
dvander@1488
   411
	if (!item_name)
dvander@1488
   412
	{
dvander@1488
   413
		return;
dvander@1488
   414
	}
dvander@1488
   415
dvander@1488
   416
	topmenu_object_t *obj;
dvander@1488
   417
	topmenu_object_t **pObject = m_ObjLookup.retrieve(item_name);
dvander@1488
   418
	if (pObject == NULL)
dvander@1488
   419
	{
dvander@1488
   420
		return;
dvander@1488
   421
	}
dvander@1488
   422
dvander@1488
   423
	obj = *pObject;
dvander@1488
   424
dvander@1488
   425
	if (obj->cmdname[0] == '\0')
dvander@1488
   426
	{
dvander@1488
   427
		return;
dvander@1488
   428
	}
dvander@1488
   429
dvander@1488
   430
	if (!adminsys->CheckAccess(client, obj->cmdname, obj->flags, false))
dvander@1488
   431
	{
dvander@1488
   432
		style = ITEMDRAW_IGNORE;
dvander@1488
   433
	}
dvander@1488
   434
}
dvander@1488
   435
dvander@1488
   436
unsigned int TopMenu::OnMenuDisplayItem(IBaseMenu *menu,
dvander@1488
   437
								int client,
dvander@1488
   438
								IMenuPanel *panel,
dvander@1488
   439
								unsigned int item,
dvander@1488
   440
								const ItemDrawInfo &dr)
dvander@1488
   441
{
dvander@1488
   442
	const char *item_name = menu->GetItemInfo(item, NULL);
dvander@1488
   443
	if (!item_name)
dvander@1488
   444
	{
dvander@1488
   445
		return 0;
dvander@1488
   446
	}
dvander@1488
   447
dvander@1488
   448
	topmenu_object_t *obj;
dvander@1488
   449
	topmenu_object_t **pObject = m_ObjLookup.retrieve(item_name);
dvander@1488
   450
	if (pObject == NULL)
dvander@1488
   451
	{
dvander@1488
   452
		return 0;
dvander@1488
   453
	}
dvander@1488
   454
dvander@1488
   455
	obj = *pObject;
dvander@1488
   456
dvander@1488
   457
	/* Ask the object to render the text for this client */
dvander@1488
   458
	char renderbuf[64];
dvander@1488
   459
	obj->callbacks->OnTopMenuDrawOption(client, obj->object_id, renderbuf, sizeof(renderbuf));
dvander@1488
   460
dvander@1488
   461
	/* Build the new draw info */
dvander@1488
   462
	ItemDrawInfo new_dr = dr;
dvander@1488
   463
	new_dr.display = renderbuf;
dvander@1488
   464
dvander@1488
   465
	/* Man I love the menu API.  Ask the panel to draw the item and give the position 
dvander@1488
   466
	 * back to Core's renderer.  This way we don't have to worry about keeping the 
dvander@1488
   467
	 * render buffer static!
dvander@1488
   468
	 */
dvander@1488
   469
	return panel->DrawItem(new_dr);
dvander@1488
   470
}
dvander@1488
   471
dvander@1488
   472
void TopMenu::OnMenuCancel(IBaseMenu *menu, int client, MenuCancelReason reason)
dvander@1488
   473
{
dvander@1488
   474
	if (reason == MenuCancel_ExitBack)
dvander@1488
   475
	{
dvander@1488
   476
		/* If the client chose exit back, they were on a category menu, and we can
dvander@1488
   477
		 * now display the root menu from the last known position.
dvander@1488
   478
		 */
dvander@1488
   479
		DisplayMenu(client, 0, TopMenuPosition_LastRoot);
dvander@1488
   480
	}
dvander@1488
   481
}
dvander@1488
   482
dvander@1488
   483
void TopMenu::UpdateClientRoot(int client, IGamePlayer *pGamePlayer)
dvander@1488
   484
{
dvander@1488
   485
	topmenu_player_t *pClient = &m_clients[client];
dvander@1488
   486
	IGamePlayer *pPlayer = pGamePlayer ? pGamePlayer : playerhelpers->GetGamePlayer(client);
dvander@1488
   487
dvander@1488
   488
	/* Determine if an update is necessary */
dvander@1488
   489
	bool is_update_needed = false;
dvander@1488
   490
	if (pClient->menu_serial != m_SerialNo)
dvander@1488
   491
	{
dvander@1488
   492
		is_update_needed = true;
dvander@1488
   493
	}
dvander@1488
   494
	else if (pPlayer->GetUserId() != pClient->user_id)
dvander@1488
   495
	{
dvander@1488
   496
		is_update_needed = true;
dvander@1488
   497
	}
dvander@1488
   498
dvander@1488
   499
	/* If no update is needed at the root level, just leave now */
dvander@1488
   500
	if (!is_update_needed)
dvander@1488
   501
	{
dvander@1488
   502
		return;
dvander@1488
   503
	}
dvander@1488
   504
dvander@1488
   505
	/* First we need to flush the cache... */
dvander@1488
   506
	TearDownClient(pClient);
dvander@1488
   507
dvander@1488
   508
	/* Now, rebuild the category list, but don't create menus */
dvander@1488
   509
	if (m_Categories.size() == 0)
dvander@1488
   510
	{
dvander@1488
   511
		pClient->cat_count = 0;
dvander@1488
   512
		pClient->cats = NULL;
dvander@1488
   513
	}
dvander@1488
   514
	else
dvander@1488
   515
	{
dvander@1488
   516
		pClient->cat_count = (unsigned int)m_Categories.size();
dvander@1488
   517
		pClient->cats = new topmenu_player_category_t[pClient->cat_count];
dvander@1488
   518
		memset(pClient->cats, 0, sizeof(topmenu_player_category_t) * pClient->cat_count);
dvander@1488
   519
	}
dvander@1488
   520
dvander@1488
   521
	/* Re-sort the root categories if needed */
dvander@1488
   522
	SortCategoriesIfNeeded();
dvander@1488
   523
dvander@1488
   524
	/* Build the root menu */
dvander@1488
   525
	IBaseMenu *root_menu = menus->GetDefaultStyle()->CreateMenu(this, myself->GetIdentity());
dvander@1488
   526
dvander@1488
   527
	/* Add the sorted items */
dvander@1488
   528
	for (size_t i = 0; i < m_SortedCats.size(); i++)
dvander@1488
   529
	{
dvander@1488
   530
		root_menu->AppendItem(m_Categories[m_SortedCats[i]]->obj->name, ItemDrawInfo(""));
dvander@1488
   531
	}
dvander@1488
   532
dvander@1488
   533
	/* Now we need to handle un-sorted items.  This is slightly trickier, as we need to 
dvander@1488
   534
	 * pre-render each category name, and cache those names.  Phew!
dvander@1488
   535
	 */
dvander@1488
   536
	if (m_UnsortedCats.size())
dvander@1488
   537
	{
dvander@1488
   538
		obj_by_name_t *item_list = new obj_by_name_t[m_UnsortedCats.size()];
dvander@1488
   539
		for (size_t i = 0; i < m_UnsortedCats.size(); i++)
dvander@1488
   540
		{
dvander@1488
   541
			obj_by_name_t *temp_obj = &item_list[i];
dvander@1488
   542
			topmenu_object_t *obj = m_Categories[m_UnsortedCats[i]]->obj;
dvander@1488
   543
			obj->callbacks->OnTopMenuDrawOption(client, 
dvander@1488
   544
				obj->object_id,
dvander@1488
   545
				temp_obj->name,
dvander@1488
   546
				sizeof(temp_obj->name));
dvander@1488
   547
			temp_obj->obj_index = m_UnsortedCats[i];
dvander@1488
   548
		}
dvander@1488
   549
dvander@1488
   550
		/* Sort our temp list */
dvander@1488
   551
		qsort(item_list, m_UnsortedCats.size(), sizeof(obj_by_name_t), _SortObjectNamesDescending);
dvander@1488
   552
dvander@1488
   553
		/* Add the new sorted categories */
dvander@1488
   554
		for (size_t i = 0; i < m_SortedCats.size(); i++)
dvander@1488
   555
		{
dvander@1488
   556
			root_menu->AppendItem(m_Categories[item_list[i].obj_index]->obj->name, ItemDrawInfo(""));
dvander@1488
   557
		}
dvander@1488
   558
dvander@1488
   559
		delete [] item_list;
dvander@1488
   560
	}
dvander@1488
   561
dvander@1488
   562
	/* Set the menu's title */
dvander@1488
   563
	char renderbuf[128];
dvander@1488
   564
	m_pTitle->OnTopMenuDrawTitle(client, 0, renderbuf, sizeof(renderbuf));
dvander@1488
   565
	root_menu->SetDefaultTitle(renderbuf);
dvander@1488
   566
dvander@1488
   567
	/* The client is now fully updated */
dvander@1488
   568
	pClient->root = root_menu;
dvander@1488
   569
	pClient->user_id = pPlayer->GetUserId();
dvander@1488
   570
	pClient->menu_serial = m_SerialNo;
dvander@1488
   571
	pClient->last_position = 0;
dvander@1488
   572
	pClient->last_category = 0;
dvander@1488
   573
	pClient->last_root_pos = 0;
dvander@1488
   574
}
dvander@1488
   575
dvander@1488
   576
void TopMenu::UpdateClientCategory(int client, unsigned int category)
dvander@1488
   577
{
dvander@1488
   578
	/* Update the client's root menu just in case it needs it.  This 
dvander@1488
   579
	 * will validate that we have both a valid client and a valid
dvander@1488
   580
	 * category structure for that client.
dvander@1488
   581
	 */
dvander@1488
   582
	UpdateClientRoot(client);
dvander@1488
   583
dvander@1488
   584
	/* Now it's guaranteed that our category tables will be usable */
dvander@1488
   585
	topmenu_player_t *pClient = &m_clients[client];
dvander@1488
   586
	topmenu_category_t *cat = m_Categories[category];
dvander@1488
   587
	topmenu_player_category_t *player_cat = &(pClient->cats[category]);
dvander@1488
   588
dvander@1488
   589
	/* Does the category actually need updating? */
dvander@1488
   590
	if (player_cat->serial == cat->serial)
dvander@1488
   591
	{
dvander@1488
   592
		return;
dvander@1488
   593
	}
dvander@1488
   594
dvander@1488
   595
	/* Destroy any existing menu */
dvander@1488
   596
	if (player_cat->menu)
dvander@1488
   597
	{
dvander@1488
   598
		player_cat->menu->Destroy();
dvander@1488
   599
		player_cat->menu = NULL;
dvander@1488
   600
	}
dvander@1488
   601
dvander@1488
   602
	if (pClient->last_category == category)
dvander@1488
   603
	{
dvander@1488
   604
		pClient->last_position = 0;
dvander@1488
   605
	}
dvander@1488
   606
dvander@1488
   607
	IBaseMenu *cat_menu = menus->GetDefaultStyle()->CreateMenu(this, myself->GetIdentity());
dvander@1488
   608
	
dvander@1488
   609
	/* Categories get an "exit back" button */
dvander@1488
   610
	cat_menu->SetMenuOptionFlags(cat_menu->GetMenuOptionFlags() | MENUFLAG_BUTTON_EXITBACK);
dvander@1488
   611
dvander@1488
   612
	/* Re-sort the category if needed */
dvander@1488
   613
	SortCategoryIfNeeded(category);
dvander@1488
   614
dvander@1488
   615
	/* Build the menu with the sorted items first */
dvander@1488
   616
	for (size_t i = 0; i < cat->sorted.size(); i++)
dvander@1488
   617
	{
dvander@1488
   618
		cat_menu->AppendItem(cat->sorted[i]->name, ItemDrawInfo(""));
dvander@1488
   619
	}
dvander@1488
   620
dvander@1488
   621
	/* Now handle unsorted items */
dvander@1488
   622
	if (cat->unsorted.size())
dvander@1488
   623
	{
dvander@1488
   624
		/* Build a list of the item names */
dvander@1488
   625
		obj_by_name_t *item_list = new obj_by_name_t[cat->unsorted.size()];
dvander@1488
   626
		for (size_t i = 0; i < cat->unsorted.size(); i++)
dvander@1488
   627
		{
dvander@1488
   628
			obj_by_name_t *item = &item_list[i];
dvander@1488
   629
			topmenu_object_t *obj = cat->unsorted[i];
dvander@1488
   630
			obj->callbacks->OnTopMenuDrawOption(client,
dvander@1488
   631
				obj->object_id,
dvander@1488
   632
				item->name,
dvander@1488
   633
				sizeof(item->name));
dvander@1488
   634
			item->obj_index = (unsigned int)i;
dvander@1488
   635
		}
dvander@1488
   636
dvander@1488
   637
		/* Sort the names */
dvander@1488
   638
		qsort(item_list, cat->unsorted.size(), sizeof(obj_by_name_t), _SortObjectNamesDescending);
dvander@1488
   639
dvander@1488
   640
		/* Add to the menu */
dvander@1488
   641
		for (size_t i = 0; i < cat->unsorted.size(); i++)
dvander@1488
   642
		{
dvander@1488
   643
			cat_menu->AppendItem(cat->unsorted[item_list[i].obj_index]->name, ItemDrawInfo(""));
dvander@1488
   644
		}
dvander@1488
   645
dvander@1488
   646
		delete [] item_list;
dvander@1488
   647
	}
dvander@1488
   648
dvander@1488
   649
	/* Set the menu's title */
dvander@1488
   650
	char renderbuf[128];
dvander@1488
   651
	cat->obj->callbacks->OnTopMenuDrawTitle(client, cat->obj->object_id, renderbuf, sizeof(renderbuf));
dvander@1488
   652
	cat_menu->SetDefaultTitle(renderbuf);
dvander@1488
   653
dvander@1488
   654
	/* We're done! */
dvander@1488
   655
	player_cat->menu = cat_menu;
dvander@1488
   656
	player_cat->serial = cat->serial;
dvander@1488
   657
}
dvander@1488
   658
dvander@1488
   659
void TopMenu::SortCategoryIfNeeded(unsigned int category)
dvander@1488
   660
{
dvander@1488
   661
	topmenu_category_t *cat = m_Categories[category];
dvander@1488
   662
	if (!cat->reorder)
dvander@1488
   663
	{
dvander@1488
   664
		return;
dvander@1488
   665
	}
dvander@1488
   666
dvander@1488
   667
	cat->sorted.clear();
dvander@1488
   668
	cat->unsorted.clear();
dvander@1488
   669
dvander@1488
   670
	if (cat->obj_list.size() == 0)
dvander@1488
   671
	{
dvander@1488
   672
		cat->reorder = false;
dvander@1488
   673
		return;
dvander@1488
   674
	}
dvander@1488
   675
dvander@1488
   676
	CVector<unsigned int> to_sort;
dvander@1488
   677
	for (size_t i = 0; i < cat->obj_list.size(); i++)
dvander@1488
   678
	{
dvander@1488
   679
		to_sort.push_back(i);
dvander@1488
   680
	}
dvander@1488
   681
dvander@1488
   682
	/* Find a matching category in the configs */
dvander@1488
   683
	config_category_t *config_cat = NULL; 
dvander@1488
   684
	for (size_t i = 0; i < m_Config.cats.size(); i++)
dvander@1488
   685
	{
dvander@1488
   686
		if (strcmp(m_Config.strings.GetString(m_Config.cats[i]->name), cat->obj->name) == 0)
dvander@1488
   687
		{
dvander@1488
   688
			config_cat = m_Config.cats[i];
dvander@1488
   689
			break;
dvander@1488
   690
		}
dvander@1488
   691
	}
dvander@1488
   692
dvander@1488
   693
	/* If there is a matching category, build a pre-sorted item list */
dvander@1488
   694
	if (config_cat != NULL)
dvander@1488
   695
	{
dvander@1488
   696
		/* Find matching objects in this category */
dvander@1488
   697
		for (size_t i = 0; i < config_cat->commands.size(); i++)
dvander@1488
   698
		{
dvander@1488
   699
			const char *config_name = m_Config.strings.GetString(config_cat->commands[i]);
dvander@1488
   700
			for (size_t j = 0; j < to_sort.size(); j++)
dvander@1488
   701
			{
dvander@1488
   702
				if (strcmp(config_name, cat->obj_list[to_sort[j]]->name) == 0)
dvander@1488
   703
				{
dvander@1488
   704
					/* Place in the final list, then remove from the temporary list */
dvander@1488
   705
					cat->sorted.push_back(cat->obj_list[to_sort[j]]);
dvander@1488
   706
					to_sort.erase(to_sort.iterAt(j));
dvander@1488
   707
					break;
dvander@1488
   708
				}
dvander@1488
   709
			}
dvander@1488
   710
		}
dvander@1488
   711
	}
dvander@1488
   712
dvander@1488
   713
	/* Push any remaining items onto the unsorted list */
dvander@1488
   714
	for (size_t i = 0; i < to_sort.size(); i++)
dvander@1488
   715
	{
dvander@1488
   716
		cat->unsorted.push_back(cat->obj_list[to_sort[i]]);
dvander@1488
   717
	}
dvander@1488
   718
dvander@1488
   719
	cat->reorder = false;
dvander@1488
   720
}
dvander@1488
   721
dvander@1488
   722
void TopMenu::SortCategoriesIfNeeded()
dvander@1488
   723
{
dvander@1488
   724
	if (!m_bCatsNeedResort)
dvander@1488
   725
	{
dvander@1488
   726
		return;
dvander@1488
   727
	}
dvander@1488
   728
dvander@1488
   729
	/* Clear sort results */
dvander@1488
   730
	m_SortedCats.clear();
dvander@1488
   731
	m_UnsortedCats.clear();
dvander@1488
   732
dvander@1488
   733
	if (m_Categories.size() == 0)
dvander@1488
   734
	{
dvander@1488
   735
		m_bCatsNeedResort = false;
dvander@1488
   736
		return;
dvander@1488
   737
	}
dvander@1488
   738
dvander@1488
   739
	CVector<unsigned int> to_sort;
dvander@1488
   740
	for (unsigned int i = 0; i < (unsigned int)m_Categories.size(); i++)
dvander@1488
   741
	{
dvander@1488
   742
		to_sort.push_back(i);
dvander@1488
   743
	}
dvander@1488
   744
dvander@1488
   745
	/* If we have any predefined categories, add them in as they appear. */
dvander@1488
   746
	for (size_t i= 0; i < m_Config.cats.size(); i++)
dvander@1488
   747
	{
dvander@1488
   748
		/* Find this category and map it in if we can */
dvander@1488
   749
		for (size_t j = 0; j < to_sort.size(); j++)
dvander@1488
   750
		{
dvander@1488
   751
			if (strcmp(m_Config.strings.GetString(m_Config.cats[i]->name), 
dvander@1488
   752
					   m_Categories[to_sort[j]]->obj->name) == 0)
dvander@1488
   753
			{
dvander@1488
   754
				/* Add to the real list and remove from the temporary */
dvander@1488
   755
				m_SortedCats.push_back(to_sort[j]);
dvander@1488
   756
				to_sort.erase(to_sort.iterAt(j));
dvander@1488
   757
				break;
dvander@1488
   758
			}
dvander@1488
   759
		}
dvander@1488
   760
	}
dvander@1488
   761
dvander@1488
   762
	/* Push any remaining items onto the unsorted list */
dvander@1488
   763
	for (size_t i = 0; i < to_sort.size(); i++)
dvander@1488
   764
	{
dvander@1488
   765
		m_UnsortedCats.push_back(to_sort[i]);
dvander@1488
   766
	}
dvander@1488
   767
dvander@1488
   768
	m_bCatsNeedResort = false;
dvander@1488
   769
}
dvander@1488
   770
dvander@1488
   771
void TopMenu::CreatePlayers(int max_clients)
dvander@1488
   772
{
dvander@1488
   773
	m_max_clients = max_clients;
dvander@1488
   774
	m_clients = (topmenu_player_t *)malloc(sizeof(topmenu_player_t) * (max_clients + 1));
dvander@1488
   775
	memset(m_clients, 0, sizeof(topmenu_player_t) * (max_clients + 1));
dvander@1488
   776
}
dvander@1488
   777
dvander@1488
   778
void TopMenu::TearDownClient(topmenu_player_t *player)
dvander@1488
   779
{
dvander@1488
   780
	if (player->cats != NULL)
dvander@1488
   781
	{
dvander@1488
   782
		for (unsigned int i = 0; i < player->cat_count; i++)
dvander@1488
   783
		{
dvander@1488
   784
			topmenu_player_category_t *player_cat = &(player->cats[i]);
dvander@1488
   785
			if (player_cat->menu != NULL)
dvander@1488
   786
			{
dvander@1488
   787
				player_cat->menu->Destroy();
dvander@1488
   788
			}
dvander@1488
   789
		}
dvander@1488
   790
		delete [] player->cats;
dvander@1488
   791
	}
dvander@1488
   792
dvander@1488
   793
	if (player->root != NULL)
dvander@1488
   794
	{
dvander@1488
   795
		player->root->Destroy();
dvander@1488
   796
	}
dvander@1488
   797
dvander@1488
   798
	memset(player, 0, sizeof(topmenu_player_t));
dvander@1488
   799
}
dvander@1488
   800
dvander@1488
   801
bool TopMenu::LoadConfiguration(const char *file, char *error, size_t maxlength)
dvander@1488
   802
{
dvander@1488
   803
	SMCParseError err;
dvander@1488
   804
	unsigned int line = 0, col = 0;
dvander@1488
   805
dvander@1488
   806
	if ((err = textparsers->ParseFile_SMC(file, this, &line, &col))
dvander@1488
   807
		!= SMCParse_Okay)
dvander@1488
   808
	{
dvander@1488
   809
		const char *err_string = textparsers->GetSMCErrorString(err);
dvander@1488
   810
		if (!err_string)
dvander@1488
   811
		{
dvander@1488
   812
			err_string = "Unknown";
dvander@1488
   813
		}
dvander@1488
   814
dvander@1488
   815
		UTIL_Format(error, maxlength, "%s", err_string);
dvander@1488
   816
dvander@1488
   817
		return false;
dvander@1488
   818
	}
dvander@1488
   819
dvander@1488
   820
	return true;
dvander@1488
   821
}
dvander@1488
   822
dvander@1488
   823
#define PARSE_STATE_NONE		0
dvander@1488
   824
#define PARSE_STATE_CATEGORY	1
dvander@1488
   825
unsigned int ignore_parse_level = 0;
dvander@1488
   826
unsigned int current_parse_state = 0;
dvander@1488
   827
config_category_t *cur_cat = NULL;
dvander@1488
   828
dvander@1488
   829
void TopMenu::ReadSMC_ParseStart()
dvander@1488
   830
{
dvander@1488
   831
	current_parse_state = PARSE_STATE_NONE;
dvander@1488
   832
	ignore_parse_level = 0;
dvander@1488
   833
	cur_cat = NULL;
dvander@1488
   834
dvander@1488
   835
	/* Reset the old config */
dvander@1488
   836
	m_Config.strings.Reset();
dvander@1488
   837
	for (size_t i = 0; i < m_Config.cats.size(); i++)
dvander@1488
   838
	{
dvander@1488
   839
		delete m_Config.cats[i];
dvander@1488
   840
	}
dvander@1488
   841
	m_Config.cats.clear();
dvander@1488
   842
}
dvander@1488
   843
dvander@1488
   844
SMCParseResult TopMenu::ReadSMC_NewSection(const char *name, bool opt_quotes)
dvander@1488
   845
{
dvander@1488
   846
	if (ignore_parse_level)
dvander@1488
   847
	{
dvander@1488
   848
		ignore_parse_level++;
dvander@1488
   849
	}
dvander@1488
   850
	else
dvander@1488
   851
	{
dvander@1488
   852
		if (current_parse_state == PARSE_STATE_NONE)
dvander@1488
   853
		{
dvander@1488
   854
			cur_cat = new config_category_t;
dvander@1488
   855
			cur_cat->name = m_Config.strings.AddString(name);
dvander@1488
   856
			m_Config.cats.push_back(cur_cat);
dvander@1488
   857
			current_parse_state = PARSE_STATE_CATEGORY;
dvander@1488
   858
		}
dvander@1488
   859
		else
dvander@1488
   860
		{
dvander@1488
   861
			ignore_parse_level = 1;
dvander@1488
   862
		}
dvander@1488
   863
	}
dvander@1488
   864
dvander@1488
   865
	return SMCParse_Continue;
dvander@1488
   866
}
dvander@1488
   867
dvander@1488
   868
SMCParseResult TopMenu::ReadSMC_KeyValue(const char *key, const char *value, bool key_quotes, bool value_quotes)
dvander@1488
   869
{
dvander@1488
   870
	if (ignore_parse_level > 0
dvander@1488
   871
		|| current_parse_state != PARSE_STATE_CATEGORY
dvander@1488
   872
		|| cur_cat == NULL)
dvander@1488
   873
	{
dvander@1488
   874
		return SMCParse_Continue;
dvander@1488
   875
	}
dvander@1488
   876
dvander@1488
   877
	if (strcmp(key, "item") == 0)
dvander@1488
   878
	{
dvander@1488
   879
		cur_cat->commands.push_back(m_Config.strings.AddString(value));
dvander@1488
   880
	}
dvander@1488
   881
dvander@1488
   882
	return SMCParse_Continue;
dvander@1488
   883
}
dvander@1488
   884
dvander@1488
   885
SMCParseResult TopMenu::ReadSMC_LeavingSection()
dvander@1488
   886
{
dvander@1488
   887
	if (ignore_parse_level)
dvander@1488
   888
	{
dvander@1488
   889
		ignore_parse_level--;
dvander@1488
   890
	}
dvander@1488
   891
	else
dvander@1488
   892
	{
dvander@1488
   893
		if (current_parse_state == PARSE_STATE_CATEGORY)
dvander@1488
   894
		{
dvander@1488
   895
			cur_cat = NULL;
dvander@1488
   896
			current_parse_state = PARSE_STATE_NONE;
dvander@1488
   897
		}
dvander@1488
   898
	}
dvander@1488
   899
dvander@1488
   900
	return SMCParse_Continue;
dvander@1488
   901
}
dvander@1488
   902
dvander@1488
   903
int _SortObjectNamesDescending(const void *ptr1, const void *ptr2)
dvander@1488
   904
{
dvander@1488
   905
	obj_by_name_t *obj1 = (obj_by_name_t *)ptr1;
dvander@1488
   906
	obj_by_name_t *obj2 = (obj_by_name_t *)ptr2;
dvander@1488
   907
	return strcmp(obj1->name, obj2->name);
dvander@1488
   908
}
dvander@1488
   909
dvander@1488
   910
unsigned int strncopy(char *dest, const char *src, size_t count)
dvander@1488
   911
{
dvander@1488
   912
	if (!count)
dvander@1488
   913
	{
dvander@1488
   914
		return 0;
dvander@1488
   915
	}
dvander@1488
   916
dvander@1488
   917
	char *start = dest;
dvander@1488
   918
	while ((*src) && (--count))
dvander@1488
   919
	{
dvander@1488
   920
		*dest++ = *src++;
dvander@1488
   921
	}
dvander@1488
   922
	*dest = '\0';
dvander@1488
   923
dvander@1488
   924
	return (dest - start);
dvander@1488
   925
}
dvander@1488
   926
dvander@1488
   927
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...)
dvander@1488
   928
{
dvander@1488
   929
	va_list ap;
dvander@1488
   930
	va_start(ap, fmt);
dvander@1488
   931
	size_t len = vsnprintf(buffer, maxlength, fmt, ap);
dvander@1488
   932
	va_end(ap);
dvander@1488
   933
dvander@1488
   934
	if (len >= maxlength)
dvander@1488
   935
	{
dvander@1488
   936
		buffer[maxlength - 1] = '\0';
dvander@1488
   937
		return (maxlength - 1);
dvander@1488
   938
	}
dvander@1488
   939
	else
dvander@1488
   940
	{
dvander@1488
   941
		return len;
dvander@1488
   942
	}
dvander@1488
   943
}