core/smn_sorting.cpp
author David Anderson <dvander@alliedmods.net>
Mon Mar 19 01:44:09 2007 +0000 (2007-03-19)
changeset 647 1e29dcc9ca97
parent 603 a71f010463c4
child 653 ef60870067ff
permissions -rw-r--r--
fixed a potential bug with kicking players during authorization
dvander@535
     1
/**
dvander@535
     2
 * ===============================================================
dvander@535
     3
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@535
     4
 * ===============================================================
dvander@535
     5
 *
dvander@535
     6
 * This file is not open source and may not be copied without explicit
dvander@535
     7
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@535
     8
 * in whole or significant part.
dvander@535
     9
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@535
    10
 *
dvander@535
    11
 * Version: $Id$
dvander@535
    12
 */
dvander@535
    13
dvander@535
    14
#include "sm_globals.h"
dvander@535
    15
#include <IHandleSys.h>
dvander@535
    16
#include <stdlib.h>
dvander@603
    17
#include <string.h>
dvander@535
    18
dvander@535
    19
/***********************************
dvander@535
    20
 *   About the double array hack   *
dvander@535
    21
     ***************************   
dvander@535
    22
dvander@535
    23
 Double arrays in Pawn are vectors offset by the current offset.  For example:
dvander@535
    24
dvander@535
    25
 new array[2][2]
dvander@535
    26
dvander@535
    27
   In this array, index 0 contains the offset from the current offset which
dvander@535
    28
 results in the final vector [2] (at [0][2]).  Meaning, to dereference [1][2], 
dvander@535
    29
 it is equivalent to:
dvander@535
    30
dvander@535
    31
 address = &array[1] + array[1] + 2 * sizeof(cell)
dvander@535
    32
dvander@535
    33
   The fact that each offset is from the _current_ position rather than the _base_
dvander@535
    34
 position is very important.  It means that if you to try to swap vector positions,
dvander@535
    35
 the offsets will no longer match, because their current position has changed.  A 
dvander@535
    36
 simple and ingenious way around this is to back up the positions in a separate array,
dvander@535
    37
 then to overwrite each position in the old array with absolute indices.  Pseudo C++ code:
dvander@535
    38
dvander@535
    39
 cell *array; //assumed to be set to the 2+D array
dvander@535
    40
 cell *old_offsets = new cell[2];
dvander@535
    41
 for (int i=0; i<2; i++)
dvander@535
    42
 {
dvander@535
    43
    old_offsets = array[i];
dvander@535
    44
	array[i] = i;
dvander@535
    45
 }
dvander@535
    46
dvander@535
    47
   Now, you can swap the array indices with no problem, and do a reverse-lookup to find the original addresses.
dvander@535
    48
 After sorting/modification is done, you must relocate the new indices.  For example, if the two vectors in our
dvander@535
    49
 demo array were swapped, array[0] would be 1 and array[1] would be 0.  This is invalid to the virtual machine.
dvander@535
    50
 Luckily, this is also simple -- all the information is there.
dvander@535
    51
dvander@535
    52
 for (int i=0; i<2; i++)
dvander@535
    53
 {
dvander@535
    54
	//get the # of the vector we want to relocate in
dvander@535
    55
	cell vector_index = array[i];			
dvander@535
    56
	//get the real address of this vector
dvander@535
    57
	char *real_address = (char *)array + (vector_index * sizeof(cell)) + old_offsets[vector_index];
dvander@535
    58
	//calc and store the new distance offset
dvander@535
    59
	array[i] = real_address - ( (char *)array + (vector_index + sizeof(cell)) )
dvander@535
    60
 }
dvander@535
    61
dvander@535
    62
 Note that the inner expression can be heavily reduced; it is expanded for readability.
dvander@535
    63
 **********************************/
dvander@535
    64
dvander@535
    65
enum SortOrder
dvander@535
    66
{
dvander@535
    67
	Sort_Ascending = 0,
dvander@535
    68
	Sort_Descending = 1,
dvander@535
    69
};
dvander@535
    70
dvander@535
    71
int sort_ints_asc(const void *int1, const void *int2)
dvander@535
    72
{
dvander@535
    73
	return (*(int *)int1) - (*(int *)int2);
dvander@535
    74
}
dvander@535
    75
dvander@535
    76
int sort_ints_desc(const void *int1, const void *int2)
dvander@535
    77
{
dvander@535
    78
	return (*(int *)int2) - (*(int *)int1);
dvander@535
    79
}
dvander@535
    80
dvander@535
    81
static cell_t sm_SortIntegers(IPluginContext *pContext, const cell_t *params)
dvander@535
    82
{
dvander@535
    83
	cell_t *array;
dvander@535
    84
	cell_t array_size = params[2];
dvander@535
    85
	cell_t type = params[3];
dvander@535
    86
dvander@535
    87
	pContext->LocalToPhysAddr(params[1], &array);
dvander@535
    88
dvander@535
    89
	if (type == Sort_Ascending)
dvander@535
    90
	{
dvander@535
    91
		qsort(array, array_size, sizeof(cell_t), sort_ints_asc);
dvander@535
    92
	} else {
dvander@535
    93
		qsort(array, array_size, sizeof(cell_t), sort_ints_desc);
dvander@535
    94
	}
dvander@535
    95
dvander@535
    96
	return 1;
dvander@535
    97
}
dvander@535
    98
dvander@535
    99
int sort_floats_asc(const void *float1, const void *float2)
dvander@535
   100
{
dvander@535
   101
	float r1 = *(float *)float1;
dvander@535
   102
	float r2 = *(float *)float2;
dvander@535
   103
	
dvander@535
   104
	if (r1 < r2)
dvander@535
   105
	{
dvander@535
   106
		return -1;
dvander@535
   107
	} else if (r2 < r1) {
dvander@535
   108
		return 1;
dvander@535
   109
	} else {
dvander@535
   110
		return 0;
dvander@535
   111
	}
dvander@535
   112
}
dvander@535
   113
dvander@535
   114
int sort_floats_desc(const void *float1, const void *float2)
dvander@535
   115
{
dvander@535
   116
	float r1 = *(float *)float1;
dvander@535
   117
	float r2 = *(float *)float2;
dvander@535
   118
dvander@535
   119
	if (r1 < r2)
dvander@535
   120
	{
dvander@535
   121
		return 1;
dvander@535
   122
	} else if (r2 < r1) {
dvander@535
   123
		return -1;
dvander@535
   124
	} else {
dvander@535
   125
		return 0;
dvander@535
   126
	}
dvander@535
   127
}
dvander@535
   128
dvander@535
   129
static cell_t sm_SortFloats(IPluginContext *pContext, const cell_t *params)
dvander@535
   130
{
dvander@535
   131
	cell_t *array;
dvander@535
   132
	cell_t array_size = params[2];
dvander@535
   133
	cell_t type = params[3];
dvander@535
   134
dvander@535
   135
	pContext->LocalToPhysAddr(params[1], &array);
dvander@535
   136
dvander@535
   137
	if (type == Sort_Ascending)
dvander@535
   138
	{
dvander@535
   139
		qsort(array, array_size, sizeof(cell_t), sort_floats_asc);
dvander@535
   140
	} else {
dvander@535
   141
		qsort(array, array_size, sizeof(cell_t), sort_floats_desc);
dvander@535
   142
	}
dvander@535
   143
dvander@535
   144
	return 1;
dvander@535
   145
}
dvander@535
   146
dvander@535
   147
static cell_t *g_CurStringArray = NULL;
dvander@535
   148
static cell_t *g_CurRebaseMap = NULL;
dvander@535
   149
dvander@535
   150
int sort_strings_asc(const void *blk1, const void *blk2)
dvander@535
   151
{
dvander@535
   152
	cell_t reloc1 = *(cell_t *)blk1;
dvander@535
   153
	cell_t reloc2 = *(cell_t *)blk2;
dvander@535
   154
	
dvander@535
   155
	char *str1 = ((char *)(&g_CurStringArray[reloc1]) + g_CurRebaseMap[reloc1]);
dvander@535
   156
	char *str2 = ((char *)(&g_CurStringArray[reloc2]) + g_CurRebaseMap[reloc2]);
dvander@535
   157
dvander@535
   158
	return strcmp(str1, str2);
dvander@535
   159
}
dvander@535
   160
dvander@535
   161
int sort_strings_desc(const void *blk1, const void *blk2)
dvander@535
   162
{
dvander@535
   163
	cell_t reloc1 = *(cell_t *)blk1;
dvander@535
   164
	cell_t reloc2 = *(cell_t *)blk2;
dvander@535
   165
dvander@535
   166
	char *str1 = ((char *)(&g_CurStringArray[reloc1]) + g_CurRebaseMap[reloc1]);
dvander@535
   167
	char *str2 = ((char *)(&g_CurStringArray[reloc2]) + g_CurRebaseMap[reloc2]);
dvander@535
   168
dvander@535
   169
	return strcmp(str2, str1);
dvander@535
   170
}
dvander@535
   171
dvander@535
   172
static cell_t sm_SortStrings(IPluginContext *pContext, const cell_t *params)
dvander@535
   173
{
dvander@535
   174
	cell_t *array;
dvander@535
   175
	cell_t array_size = params[2];
dvander@535
   176
	cell_t type = params[3];
dvander@535
   177
dvander@535
   178
	pContext->LocalToPhysAddr(params[1], &array);
dvander@535
   179
dvander@535
   180
	/** HACKHACK - back up the old indices, replace the indices with something easier */
dvander@535
   181
	cell_t amx_addr, *phys_addr;
dvander@535
   182
	int err;
dvander@535
   183
	if ((err=pContext->HeapAlloc(array_size, &amx_addr, &phys_addr)) != SP_ERROR_NONE)
dvander@535
   184
	{
dvander@535
   185
		pContext->ThrowNativeErrorEx(err, "Ran out of memory to sort");
dvander@535
   186
	}
dvander@535
   187
dvander@535
   188
	g_CurStringArray = array;
dvander@535
   189
	g_CurRebaseMap = phys_addr;
dvander@535
   190
dvander@535
   191
	for (int i=0; i<array_size; i++)
dvander@535
   192
	{
dvander@535
   193
		phys_addr[i] = array[i];
dvander@535
   194
		array[i] = i;
dvander@535
   195
	}
dvander@535
   196
dvander@535
   197
	if (type == Sort_Ascending)
dvander@535
   198
	{
dvander@535
   199
		qsort(array, array_size, sizeof(cell_t), sort_strings_asc);
dvander@535
   200
	} else {
dvander@535
   201
		qsort(array, array_size, sizeof(cell_t), sort_strings_desc);
dvander@535
   202
	}
dvander@535
   203
dvander@535
   204
	/* END HACKHACK - restore what we damaged so Pawn doesn't throw up.
dvander@535
   205
	 * We'll browse through each index of the array and patch up the distance.
dvander@535
   206
	 */
dvander@535
   207
	for (int i=0; i<array_size; i++)
dvander@535
   208
	{
dvander@535
   209
		/* Compute the final address of the old array and subtract the new location.
dvander@535
   210
		 * This is the fixed up distance.
dvander@535
   211
		 */
dvander@535
   212
		array[i] = ((char *)&array[array[i]] + phys_addr[array[i]]) - (char *)&array[i];
dvander@535
   213
	}
dvander@535
   214
dvander@535
   215
	pContext->HeapPop(amx_addr);
dvander@535
   216
dvander@535
   217
	g_CurStringArray = NULL;
dvander@535
   218
	g_CurRebaseMap = NULL;
dvander@535
   219
dvander@535
   220
	return 1;
dvander@535
   221
}
dvander@535
   222
dvander@535
   223
struct sort_info
dvander@535
   224
{
dvander@535
   225
	IPluginFunction *pFunc;
dvander@535
   226
	Handle_t hndl;
dvander@535
   227
	cell_t array_addr;
dvander@535
   228
	cell_t *array_base;
dvander@535
   229
	cell_t *array_remap;
dvander@535
   230
};
dvander@535
   231
dvander@535
   232
sort_info g_SortInfo;
dvander@535
   233
dvander@535
   234
int sort1d_amx_custom(const void *elem1, const void *elem2)
dvander@535
   235
{
dvander@535
   236
	cell_t c1 = *(cell_t *)elem1;
dvander@535
   237
	cell_t c2 = *(cell_t *)elem2;
dvander@535
   238
dvander@535
   239
	cell_t result = 0;
dvander@535
   240
	IPluginFunction *pf = g_SortInfo.pFunc;
dvander@535
   241
	pf->PushCell(c1);
dvander@535
   242
	pf->PushCell(c2);
dvander@535
   243
	pf->PushCell(g_SortInfo.array_addr);
dvander@535
   244
	pf->PushCell(g_SortInfo.hndl);
dvander@535
   245
	pf->Execute(&result);
dvander@535
   246
dvander@535
   247
	return result;
dvander@535
   248
}
dvander@535
   249
dvander@535
   250
static cell_t sm_SortCustom1D(IPluginContext *pContext, const cell_t *params)
dvander@535
   251
{
dvander@535
   252
	cell_t *array;
dvander@535
   253
	cell_t array_size = params[2];
dvander@535
   254
dvander@535
   255
	IPluginFunction *pFunction = pContext->GetFunctionById(params[3]);
dvander@535
   256
	if (!pFunction)
dvander@535
   257
	{
dvander@535
   258
		return pContext->ThrowNativeError("Function %x is not a valid function", params[3]);
dvander@535
   259
	}
dvander@535
   260
dvander@535
   261
	pContext->LocalToPhysAddr(params[1], &array);
dvander@535
   262
dvander@535
   263
	sort_info oldinfo = g_SortInfo;
dvander@535
   264
dvander@535
   265
	
dvander@535
   266
	g_SortInfo.hndl = params[4];
dvander@535
   267
	g_SortInfo.array_addr = params[1];
dvander@535
   268
	g_SortInfo.array_remap = NULL;
dvander@535
   269
	g_SortInfo.array_base = NULL;
dvander@535
   270
	g_SortInfo.pFunc = pFunction;
dvander@535
   271
dvander@535
   272
	qsort(array, array_size, sizeof(cell_t), sort1d_amx_custom);
dvander@535
   273
dvander@535
   274
	g_SortInfo = oldinfo;
dvander@535
   275
dvander@535
   276
	return 1;
dvander@535
   277
}
dvander@535
   278
dvander@535
   279
int sort2d_amx_custom(const void *elem1, const void *elem2)
dvander@535
   280
{
dvander@535
   281
	cell_t c1 = *(cell_t *)elem1;
dvander@535
   282
	cell_t c2 = *(cell_t *)elem2;
dvander@535
   283
dvander@535
   284
	cell_t c1_addr = g_SortInfo.array_addr + (c1 * sizeof(cell_t)) + g_SortInfo.array_remap[c1];
dvander@535
   285
	cell_t c2_addr = g_SortInfo.array_addr + (c2 * sizeof(cell_t)) + g_SortInfo.array_remap[c2];
dvander@535
   286
dvander@535
   287
	IPluginContext *pContext = g_SortInfo.pFunc->GetParentContext();
dvander@535
   288
	cell_t *c1_r, *c2_r;
dvander@535
   289
	pContext->LocalToPhysAddr(c1_addr, &c1_r);
dvander@535
   290
	pContext->LocalToPhysAddr(c2_addr, &c2_r);
dvander@535
   291
dvander@535
   292
	cell_t result = 0;
dvander@535
   293
	g_SortInfo.pFunc->PushCell(c1_addr);
dvander@535
   294
	g_SortInfo.pFunc->PushCell(c2_addr);
dvander@535
   295
	g_SortInfo.pFunc->PushCell(g_SortInfo.array_addr);
dvander@535
   296
	g_SortInfo.pFunc->PushCell(g_SortInfo.hndl);
dvander@535
   297
	g_SortInfo.pFunc->Execute(&result);
dvander@535
   298
dvander@535
   299
	return result;
dvander@535
   300
}
dvander@535
   301
dvander@535
   302
static cell_t sm_SortCustom2D(IPluginContext *pContext, const cell_t *params)
dvander@535
   303
{
dvander@535
   304
	cell_t *array;
dvander@535
   305
	cell_t array_size = params[2];
dvander@535
   306
	IPluginFunction *pFunction;
dvander@535
   307
dvander@535
   308
	pContext->LocalToPhysAddr(params[1], &array);
dvander@535
   309
dvander@535
   310
	if ((pFunction=pContext->GetFunctionById(params[3])) == NULL)
dvander@535
   311
	{
dvander@535
   312
		return pContext->ThrowNativeError("Function %x is not a valid function", params[3]);
dvander@535
   313
	}
dvander@535
   314
dvander@535
   315
	/** back up the old indices, replace the indices with something easier */
dvander@535
   316
	cell_t amx_addr, *phys_addr;
dvander@535
   317
	int err;
dvander@535
   318
	if ((err=pContext->HeapAlloc(array_size, &amx_addr, &phys_addr)) != SP_ERROR_NONE)
dvander@535
   319
	{
dvander@535
   320
		pContext->ThrowNativeErrorEx(err, "Ran out of memory to sort");
dvander@535
   321
		return 0;
dvander@535
   322
	}
dvander@535
   323
dvander@535
   324
	sort_info oldinfo = g_SortInfo;
dvander@535
   325
dvander@535
   326
	g_SortInfo.pFunc = pFunction;
dvander@535
   327
	g_SortInfo.hndl = params[4];
dvander@535
   328
	g_SortInfo.array_addr = params[1];
dvander@535
   329
	
dvander@535
   330
	/** Same process as in strings, back up the old indices for later fixup */
dvander@535
   331
	g_SortInfo.array_base = array;
dvander@535
   332
	g_SortInfo.array_remap = phys_addr;
dvander@535
   333
	
dvander@535
   334
	for (int i=0; i<array_size; i++)
dvander@535
   335
	{
dvander@535
   336
		phys_addr[i] = array[i];
dvander@535
   337
		array[i] = i;
dvander@535
   338
	}
dvander@535
   339
dvander@535
   340
	qsort(array, array_size, sizeof(cell_t), sort2d_amx_custom);
dvander@535
   341
dvander@535
   342
	/** Fixup process! */
dvander@535
   343
	for (int i=0; i<array_size; i++)
dvander@535
   344
	{
dvander@535
   345
		/* Compute the final address of the old array and subtract the new location.
dvander@535
   346
		 * This is the fixed up distance.
dvander@535
   347
		 */
dvander@535
   348
		array[i] = ((char *)&array[array[i]] + phys_addr[array[i]]) - (char *)&array[i];
dvander@535
   349
	}
dvander@535
   350
dvander@535
   351
	pContext->HeapPop(amx_addr);
dvander@535
   352
dvander@535
   353
	g_SortInfo = oldinfo;
dvander@535
   354
	
dvander@535
   355
	return 1;
dvander@535
   356
}
dvander@535
   357
dvander@535
   358
REGISTER_NATIVES(sortNatives)
dvander@535
   359
{
dvander@535
   360
	{"SortIntegers",			sm_SortIntegers},
dvander@535
   361
	{"SortFloats",				sm_SortFloats},
dvander@535
   362
	{"SortStrings",				sm_SortStrings},
dvander@535
   363
	{"SortCustom1D",			sm_SortCustom1D},
dvander@535
   364
	{"SortCustom2D",			sm_SortCustom2D},
dvander@535
   365
	{NULL,						NULL},
dvander@535
   366
};