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