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