dvander@535: /**
ds@653:  * vim: set ts=4 :
dvander@1231:  * ================================================================
dvander@1231:  * SourceMod
dvander@1231:  * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1231:  * ================================================================
dvander@535:  *
dvander@1231:  * This program is free software; you can redistribute it and/or 
dvander@1231:  * modify it under the terms of the GNU General Public License, 
dvander@1231:  * version 3.0, as published by the Free Software Foundation.
dvander@1231:  * 
dvander@1231:  * This program is distributed in the hope that it will be useful,
dvander@1231:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1231:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1231:  * GNU General Public License for more details.
dvander@1231:  *
dvander@1231:  * You should have received a copy of the GNU General Public License
dvander@1231:  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231:  *
dvander@1231:  * As a special exception, AlliedModders LLC gives you permission to 
dvander@1231:  * link the code of this program (as well as its derivative works) to 
dvander@1231:  * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
dvander@1231:  * Game MODs that run on software by the Valve Corporation.  You must 
dvander@1231:  * obey the GNU General Public License in all respects for all other 
dvander@1231:  * code used. Additionally, AlliedModders LLC grants this exception 
dvander@1231:  * to all derivative works. AlliedModders LLC defines further 
dvander@1231:  * exceptions, found in LICENSE.txt (as of this writing, version 
dvander@1231:  * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
dvander@535:  *
dvander@535:  * Version: $Id$
dvander@535:  */
dvander@535: 
dvander@535: #include "sm_globals.h"
dvander@535: #include <IHandleSys.h>
dvander@535: #include <stdlib.h>
dvander@603: #include <string.h>
dvander@535: 
dvander@535: /***********************************
dvander@535:  *   About the double array hack   *
dvander@535:      ***************************   
dvander@535: 
dvander@535:  Double arrays in Pawn are vectors offset by the current offset.  For example:
dvander@535: 
dvander@535:  new array[2][2]
dvander@535: 
dvander@535:    In this array, index 0 contains the offset from the current offset which
dvander@535:  results in the final vector [2] (at [0][2]).  Meaning, to dereference [1][2], 
dvander@535:  it is equivalent to:
dvander@535: 
dvander@535:  address = &array[1] + array[1] + 2 * sizeof(cell)
dvander@535: 
dvander@535:    The fact that each offset is from the _current_ position rather than the _base_
dvander@535:  position is very important.  It means that if you to try to swap vector positions,
dvander@535:  the offsets will no longer match, because their current position has changed.  A 
dvander@535:  simple and ingenious way around this is to back up the positions in a separate array,
dvander@535:  then to overwrite each position in the old array with absolute indices.  Pseudo C++ code:
dvander@535: 
dvander@535:  cell *array; //assumed to be set to the 2+D array
dvander@535:  cell *old_offsets = new cell[2];
dvander@535:  for (int i=0; i<2; i++)
dvander@535:  {
dvander@535:     old_offsets = array[i];
dvander@535: 	array[i] = i;
dvander@535:  }
dvander@535: 
dvander@535:    Now, you can swap the array indices with no problem, and do a reverse-lookup to find the original addresses.
dvander@535:  After sorting/modification is done, you must relocate the new indices.  For example, if the two vectors in our
dvander@535:  demo array were swapped, array[0] would be 1 and array[1] would be 0.  This is invalid to the virtual machine.
dvander@535:  Luckily, this is also simple -- all the information is there.
dvander@535: 
dvander@535:  for (int i=0; i<2; i++)
dvander@535:  {
dvander@535: 	//get the # of the vector we want to relocate in
dvander@535: 	cell vector_index = array[i];			
dvander@535: 	//get the real address of this vector
dvander@535: 	char *real_address = (char *)array + (vector_index * sizeof(cell)) + old_offsets[vector_index];
dvander@535: 	//calc and store the new distance offset
dvander@535: 	array[i] = real_address - ( (char *)array + (vector_index + sizeof(cell)) )
dvander@535:  }
dvander@535: 
dvander@535:  Note that the inner expression can be heavily reduced; it is expanded for readability.
dvander@535:  **********************************/
dvander@535: 
dvander@535: enum SortOrder
dvander@535: {
dvander@535: 	Sort_Ascending = 0,
dvander@535: 	Sort_Descending = 1,
dvander@535: };
dvander@535: 
dvander@535: int sort_ints_asc(const void *int1, const void *int2)
dvander@535: {
dvander@535: 	return (*(int *)int1) - (*(int *)int2);
dvander@535: }
dvander@535: 
dvander@535: int sort_ints_desc(const void *int1, const void *int2)
dvander@535: {
dvander@535: 	return (*(int *)int2) - (*(int *)int1);
dvander@535: }
dvander@535: 
dvander@535: static cell_t sm_SortIntegers(IPluginContext *pContext, const cell_t *params)
dvander@535: {
dvander@535: 	cell_t *array;
dvander@535: 	cell_t array_size = params[2];
dvander@535: 	cell_t type = params[3];
dvander@535: 
dvander@535: 	pContext->LocalToPhysAddr(params[1], &array);
dvander@535: 
dvander@535: 	if (type == Sort_Ascending)
dvander@535: 	{
dvander@535: 		qsort(array, array_size, sizeof(cell_t), sort_ints_asc);
dvander@535: 	} else {
dvander@535: 		qsort(array, array_size, sizeof(cell_t), sort_ints_desc);
dvander@535: 	}
dvander@535: 
dvander@535: 	return 1;
dvander@535: }
dvander@535: 
dvander@535: int sort_floats_asc(const void *float1, const void *float2)
dvander@535: {
dvander@535: 	float r1 = *(float *)float1;
dvander@535: 	float r2 = *(float *)float2;
dvander@535: 	
dvander@535: 	if (r1 < r2)
dvander@535: 	{
dvander@535: 		return -1;
dvander@535: 	} else if (r2 < r1) {
dvander@535: 		return 1;
dvander@535: 	} else {
dvander@535: 		return 0;
dvander@535: 	}
dvander@535: }
dvander@535: 
dvander@535: int sort_floats_desc(const void *float1, const void *float2)
dvander@535: {
dvander@535: 	float r1 = *(float *)float1;
dvander@535: 	float r2 = *(float *)float2;
dvander@535: 
dvander@535: 	if (r1 < r2)
dvander@535: 	{
dvander@535: 		return 1;
dvander@535: 	} else if (r2 < r1) {
dvander@535: 		return -1;
dvander@535: 	} else {
dvander@535: 		return 0;
dvander@535: 	}
dvander@535: }
dvander@535: 
dvander@535: static cell_t sm_SortFloats(IPluginContext *pContext, const cell_t *params)
dvander@535: {
dvander@535: 	cell_t *array;
dvander@535: 	cell_t array_size = params[2];
dvander@535: 	cell_t type = params[3];
dvander@535: 
dvander@535: 	pContext->LocalToPhysAddr(params[1], &array);
dvander@535: 
dvander@535: 	if (type == Sort_Ascending)
dvander@535: 	{
dvander@535: 		qsort(array, array_size, sizeof(cell_t), sort_floats_asc);
dvander@535: 	} else {
dvander@535: 		qsort(array, array_size, sizeof(cell_t), sort_floats_desc);
dvander@535: 	}
dvander@535: 
dvander@535: 	return 1;
dvander@535: }
dvander@535: 
dvander@535: static cell_t *g_CurStringArray = NULL;
dvander@535: static cell_t *g_CurRebaseMap = NULL;
dvander@535: 
dvander@535: int sort_strings_asc(const void *blk1, const void *blk2)
dvander@535: {
dvander@535: 	cell_t reloc1 = *(cell_t *)blk1;
dvander@535: 	cell_t reloc2 = *(cell_t *)blk2;
dvander@535: 	
dvander@535: 	char *str1 = ((char *)(&g_CurStringArray[reloc1]) + g_CurRebaseMap[reloc1]);
dvander@535: 	char *str2 = ((char *)(&g_CurStringArray[reloc2]) + g_CurRebaseMap[reloc2]);
dvander@535: 
dvander@535: 	return strcmp(str1, str2);
dvander@535: }
dvander@535: 
dvander@535: int sort_strings_desc(const void *blk1, const void *blk2)
dvander@535: {
dvander@535: 	cell_t reloc1 = *(cell_t *)blk1;
dvander@535: 	cell_t reloc2 = *(cell_t *)blk2;
dvander@535: 
dvander@535: 	char *str1 = ((char *)(&g_CurStringArray[reloc1]) + g_CurRebaseMap[reloc1]);
dvander@535: 	char *str2 = ((char *)(&g_CurStringArray[reloc2]) + g_CurRebaseMap[reloc2]);
dvander@535: 
dvander@535: 	return strcmp(str2, str1);
dvander@535: }
dvander@535: 
dvander@535: static cell_t sm_SortStrings(IPluginContext *pContext, const cell_t *params)
dvander@535: {
dvander@535: 	cell_t *array;
dvander@535: 	cell_t array_size = params[2];
dvander@535: 	cell_t type = params[3];
dvander@535: 
dvander@535: 	pContext->LocalToPhysAddr(params[1], &array);
dvander@535: 
dvander@535: 	/** HACKHACK - back up the old indices, replace the indices with something easier */
dvander@535: 	cell_t amx_addr, *phys_addr;
dvander@535: 	int err;
dvander@535: 	if ((err=pContext->HeapAlloc(array_size, &amx_addr, &phys_addr)) != SP_ERROR_NONE)
dvander@535: 	{
dvander@535: 		pContext->ThrowNativeErrorEx(err, "Ran out of memory to sort");
dvander@535: 	}
dvander@535: 
dvander@535: 	g_CurStringArray = array;
dvander@535: 	g_CurRebaseMap = phys_addr;
dvander@535: 
dvander@535: 	for (int i=0; i<array_size; i++)
dvander@535: 	{
dvander@535: 		phys_addr[i] = array[i];
dvander@535: 		array[i] = i;
dvander@535: 	}
dvander@535: 
dvander@535: 	if (type == Sort_Ascending)
dvander@535: 	{
dvander@535: 		qsort(array, array_size, sizeof(cell_t), sort_strings_asc);
dvander@535: 	} else {
dvander@535: 		qsort(array, array_size, sizeof(cell_t), sort_strings_desc);
dvander@535: 	}
dvander@535: 
dvander@535: 	/* END HACKHACK - restore what we damaged so Pawn doesn't throw up.
dvander@535: 	 * We'll browse through each index of the array and patch up the distance.
dvander@535: 	 */
dvander@535: 	for (int i=0; i<array_size; i++)
dvander@535: 	{
dvander@535: 		/* Compute the final address of the old array and subtract the new location.
dvander@535: 		 * This is the fixed up distance.
dvander@535: 		 */
dvander@535: 		array[i] = ((char *)&array[array[i]] + phys_addr[array[i]]) - (char *)&array[i];
dvander@535: 	}
dvander@535: 
dvander@535: 	pContext->HeapPop(amx_addr);
dvander@535: 
dvander@535: 	g_CurStringArray = NULL;
dvander@535: 	g_CurRebaseMap = NULL;
dvander@535: 
dvander@535: 	return 1;
dvander@535: }
dvander@535: 
dvander@535: struct sort_info
dvander@535: {
dvander@535: 	IPluginFunction *pFunc;
dvander@535: 	Handle_t hndl;
dvander@535: 	cell_t array_addr;
dvander@535: 	cell_t *array_base;
dvander@535: 	cell_t *array_remap;
dvander@535: };
dvander@535: 
dvander@535: sort_info g_SortInfo;
dvander@535: 
dvander@535: int sort1d_amx_custom(const void *elem1, const void *elem2)
dvander@535: {
dvander@535: 	cell_t c1 = *(cell_t *)elem1;
dvander@535: 	cell_t c2 = *(cell_t *)elem2;
dvander@535: 
dvander@535: 	cell_t result = 0;
dvander@535: 	IPluginFunction *pf = g_SortInfo.pFunc;
dvander@535: 	pf->PushCell(c1);
dvander@535: 	pf->PushCell(c2);
dvander@535: 	pf->PushCell(g_SortInfo.array_addr);
dvander@535: 	pf->PushCell(g_SortInfo.hndl);
dvander@535: 	pf->Execute(&result);
dvander@535: 
dvander@535: 	return result;
dvander@535: }
dvander@535: 
dvander@535: static cell_t sm_SortCustom1D(IPluginContext *pContext, const cell_t *params)
dvander@535: {
dvander@535: 	cell_t *array;
dvander@535: 	cell_t array_size = params[2];
dvander@535: 
dvander@535: 	IPluginFunction *pFunction = pContext->GetFunctionById(params[3]);
dvander@535: 	if (!pFunction)
dvander@535: 	{
dvander@535: 		return pContext->ThrowNativeError("Function %x is not a valid function", params[3]);
dvander@535: 	}
dvander@535: 
dvander@535: 	pContext->LocalToPhysAddr(params[1], &array);
dvander@535: 
dvander@535: 	sort_info oldinfo = g_SortInfo;
dvander@535: 
dvander@535: 	
dvander@535: 	g_SortInfo.hndl = params[4];
dvander@535: 	g_SortInfo.array_addr = params[1];
dvander@535: 	g_SortInfo.array_remap = NULL;
dvander@535: 	g_SortInfo.array_base = NULL;
dvander@535: 	g_SortInfo.pFunc = pFunction;
dvander@535: 
dvander@535: 	qsort(array, array_size, sizeof(cell_t), sort1d_amx_custom);
dvander@535: 
dvander@535: 	g_SortInfo = oldinfo;
dvander@535: 
dvander@535: 	return 1;
dvander@535: }
dvander@535: 
dvander@535: int sort2d_amx_custom(const void *elem1, const void *elem2)
dvander@535: {
dvander@535: 	cell_t c1 = *(cell_t *)elem1;
dvander@535: 	cell_t c2 = *(cell_t *)elem2;
dvander@535: 
dvander@535: 	cell_t c1_addr = g_SortInfo.array_addr + (c1 * sizeof(cell_t)) + g_SortInfo.array_remap[c1];
dvander@535: 	cell_t c2_addr = g_SortInfo.array_addr + (c2 * sizeof(cell_t)) + g_SortInfo.array_remap[c2];
dvander@535: 
dvander@535: 	IPluginContext *pContext = g_SortInfo.pFunc->GetParentContext();
dvander@535: 	cell_t *c1_r, *c2_r;
dvander@535: 	pContext->LocalToPhysAddr(c1_addr, &c1_r);
dvander@535: 	pContext->LocalToPhysAddr(c2_addr, &c2_r);
dvander@535: 
dvander@535: 	cell_t result = 0;
dvander@535: 	g_SortInfo.pFunc->PushCell(c1_addr);
dvander@535: 	g_SortInfo.pFunc->PushCell(c2_addr);
dvander@535: 	g_SortInfo.pFunc->PushCell(g_SortInfo.array_addr);
dvander@535: 	g_SortInfo.pFunc->PushCell(g_SortInfo.hndl);
dvander@535: 	g_SortInfo.pFunc->Execute(&result);
dvander@535: 
dvander@535: 	return result;
dvander@535: }
dvander@535: 
dvander@535: static cell_t sm_SortCustom2D(IPluginContext *pContext, const cell_t *params)
dvander@535: {
dvander@535: 	cell_t *array;
dvander@535: 	cell_t array_size = params[2];
dvander@535: 	IPluginFunction *pFunction;
dvander@535: 
dvander@535: 	pContext->LocalToPhysAddr(params[1], &array);
dvander@535: 
dvander@535: 	if ((pFunction=pContext->GetFunctionById(params[3])) == NULL)
dvander@535: 	{
dvander@535: 		return pContext->ThrowNativeError("Function %x is not a valid function", params[3]);
dvander@535: 	}
dvander@535: 
dvander@535: 	/** back up the old indices, replace the indices with something easier */
dvander@535: 	cell_t amx_addr, *phys_addr;
dvander@535: 	int err;
dvander@535: 	if ((err=pContext->HeapAlloc(array_size, &amx_addr, &phys_addr)) != SP_ERROR_NONE)
dvander@535: 	{
dvander@535: 		pContext->ThrowNativeErrorEx(err, "Ran out of memory to sort");
dvander@535: 		return 0;
dvander@535: 	}
dvander@535: 
dvander@535: 	sort_info oldinfo = g_SortInfo;
dvander@535: 
dvander@535: 	g_SortInfo.pFunc = pFunction;
dvander@535: 	g_SortInfo.hndl = params[4];
dvander@535: 	g_SortInfo.array_addr = params[1];
dvander@535: 	
dvander@535: 	/** Same process as in strings, back up the old indices for later fixup */
dvander@535: 	g_SortInfo.array_base = array;
dvander@535: 	g_SortInfo.array_remap = phys_addr;
dvander@535: 	
dvander@535: 	for (int i=0; i<array_size; i++)
dvander@535: 	{
dvander@535: 		phys_addr[i] = array[i];
dvander@535: 		array[i] = i;
dvander@535: 	}
dvander@535: 
dvander@535: 	qsort(array, array_size, sizeof(cell_t), sort2d_amx_custom);
dvander@535: 
dvander@535: 	/** Fixup process! */
dvander@535: 	for (int i=0; i<array_size; i++)
dvander@535: 	{
dvander@535: 		/* Compute the final address of the old array and subtract the new location.
dvander@535: 		 * This is the fixed up distance.
dvander@535: 		 */
dvander@535: 		array[i] = ((char *)&array[array[i]] + phys_addr[array[i]]) - (char *)&array[i];
dvander@535: 	}
dvander@535: 
dvander@535: 	pContext->HeapPop(amx_addr);
dvander@535: 
dvander@535: 	g_SortInfo = oldinfo;
dvander@535: 	
dvander@535: 	return 1;
dvander@535: }
dvander@535: 
dvander@535: REGISTER_NATIVES(sortNatives)
dvander@535: {
dvander@535: 	{"SortIntegers",			sm_SortIntegers},
dvander@535: 	{"SortFloats",				sm_SortFloats},
dvander@535: 	{"SortStrings",				sm_SortStrings},
dvander@535: 	{"SortCustom1D",			sm_SortCustom1D},
dvander@535: 	{"SortCustom2D",			sm_SortCustom2D},
dvander@535: 	{NULL,						NULL},
dvander@535: };