Merge pull request #15 from Mpskydog/adding-arrayObject

Broke out arrayObjects.cpp into arrayObjects.h and arrayObjects_ScriptBinding.h

engine/compilers/VisualStudio 2017/Torque 2D.vcxproj

@@ -872,6 +872,8 @@
     <ClInclude Include="..\..\source\component\behaviors\behaviorTemplate_ScriptBinding.h" />
     <ClInclude Include="..\..\source\component\dynamicConsoleMethodComponent_ScriptBinding.h" />
     <ClInclude Include="..\..\source\component\simComponent_ScriptBinding.h" />
+    <ClInclude Include="..\..\source\console\arrayObject.h" />
+    <ClInclude Include="..\..\source\console\arrayObject_ScriptBinding.h" />
     <ClInclude Include="..\..\source\console\consoleBaseType.h" />
     <ClInclude Include="..\..\source\console\consoleDictionary.h" />
     <ClInclude Include="..\..\source\console\consoleDoc_ScriptBinding.h" />

engine/compilers/VisualStudio 2017/Torque 2D.vcxproj.filters

@@ -3298,6 +3298,12 @@
     <ClInclude Include="..\..\source\2d\sceneobject\SpineCollisionProxy.h">
       <Filter>2d\sceneobject</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\source\console\arrayObject.h">
+      <Filter>console</Filter>
+    </ClInclude>
+    <ClInclude Include="..\..\source\console\arrayObject_ScriptBinding.h">
+      <Filter>console</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <CustomBuild Include="..\..\source\math\mMath_ASM.asm">

engine/source/console/arrayObject.cpp

@@ -1,138 +1,39 @@
 //-----------------------------------------------------------------------------
+// Copyright (c) 2013 GarageGames, LLC
 //
-//	Torque Script Array Object
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
 //
-//	by Daniel Neilsen - 14/10/03
-//	[email protected]
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
 //
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
 //-----------------------------------------------------------------------------
 //
-//	Installation:
-//		1) BACKUP EVERYTHING
-//		2) Copy this file into the /engine/console dir and add to your project
-//		3) Compile
-//
-//
-//	Usage:
-//
-//	In script you should create an array object like so
-//		%myarray = new array();
-//
-//	With this object you can then do a variety of functions.  Some examples are:
-//  add()				- (string key, string value)Adds a new element to the end of an array
-//  append()			- (Array target)Appends the target array to the array object
-//  count()				- Get the number of elements in the array
-//  countKey()			- (string key)Get the number of times a particular key is found in the array
-//  countValue()		- (string value)Get the number of times a particular value is found in the array
-//  crop()				- (Array target)Removes elements with matching keys from array
-//  duplicate()			- (Array target)Alters array into an exact duplicate of the target array
-//  echo()				- Echos the array in the console
-//  empty()				- Emptys all elements from an array
-//  erase()				- (int index)Removes an element at a specific position from the array
-//  getCurrent()		- Gets the current pointer index
-//  getIndexFromKey()	- (string key)Search array from current position for the first matching key
-//  getIndexFromValue() - (string value)Search array from current position for the first matching value
-//  getKey()			- (int index)Get the key of the array element at the submitted index
-//  getValue()			- (int index)Get the value of the array element at the submitted index
-//  setKey()			- (string key, int index)Set the key at the given index
-//  setValue()			- (string key, int index)Set the value at the given index
-//  insert()			- (string key, string value, int index)Adds a new element to a specified position in the array
-//  moveFirst()			- Moves array pointer to start of array
-//  moveLast()			- Moves array pointer to end of array
-//  moveNext()			- Moves array pointer to next position (returns -1 if cannot move)
-//  movePrev()			- Moves array pointer to prev position (returns -1 if cannot move)
-//  pop_back()			- Removes the last element from the array
-//  pop_front()			- Removes the first element from the array
-//  push_back()			- (string key, string value)Adds a new element to the end of an array
-//  push_front()		- (string key, string value)Adds a new element to the front of an array
-//  sort()				- (bool desc)Sorts the array by value (default ascending sort)
-//  sorta()				- Alpha sorts the array by value in ascending order
-//  sortd()				- Alpha sorts the array by value in descending order
-//  sortkd()			- Alpha sorts the array by key in descending order
-//  sortka()			- (bool desc)Sorts the array by key (default ascending sort)
-//  sortn()				- (bool desc)Sorts the array numerically by value (default ascending sort)
-//  sortna()			- Numerical sorts the array by value in ascending order
-//  sortnd()			- Numerical sorts the array by value in descending order
-//  sortnka()			- Numerical sorts the array by key in ascending order
-//  sortnkd()			- Numerical sorts the array by key in descending order
-//  uniqueKey()			- Removes any elements that have duplicated keys (leaving the first instance)
-//  uniqueValue()		- Removes any elements that have duplicated values (leaving the first instance)
-//
-//
-//-----------------------------------------------------------------------------
-
+//	adopted from original code by Daniel Neilsen - 14/10/03
+//	[email protected]
 
 #include "platform/platform.h"
 #include "sim/simBase.h"
 #include "console/consoleTypes.h"
+#include "console/arrayObject.h"
 #include "math/mMathFn.h"
 #include "string/stringTable.h"
 
-static bool sIncreasing;
+// Script bindings.
+#include "arrayObject_ScriptBinding.h"
 
 
-class Array : public SimObject
-{
-   typedef SimObject Parent;
-
-private:
-
-
-
-public:
-	struct Element
-	{
-		StringTableEntry key;
-		StringTableEntry value;
-	};
-
-	U32 mCurrentIndex;
-	Vector<Element> mArray;
-
-   Array();
-   bool onAdd();
-   void onRemove();
-
-   DECLARE_CONOBJECT(Array);
-
-	S32					getIndexFromValue(StringTableEntry value);
-	S32					getIndexFromKey(StringTableEntry key);
-	StringTableEntry	getKeyFromIndex(U32 index);
-	StringTableEntry	getValueFromIndex(U32 index);
-	U32					count();
-	U32					countValue(StringTableEntry value);
-	U32					countKey(StringTableEntry key);
-
-	void 		push_back(StringTableEntry key, StringTableEntry value);
-	void		push_front(StringTableEntry key, StringTableEntry value);
-	void 		insert(StringTableEntry key, StringTableEntry value, U32 index);
-	void		pop_back();
-	void 		pop_front();
-	void 		erase(U32 index);
-	void		empty();
-
-	void		uniqueValue();
-	void		uniqueKey();
-	void		duplicate(Array* obj);
-	void		crop(Array* obj);
-	void		append(Array* obj);
-	void 		setKey(StringTableEntry key, U32 index);
-	void 		setValue(StringTableEntry value, U32 index);
-
-	void		sort(bool valtest, bool desc, bool numeric);
-
-	U32			moveFirst();
-	U32			moveLast();
-	U32			moveNext();
-	U32			movePrev();
-	U32			getCurrent();
-
-	void		echo();
-
-	void		moveIndex(U32 prev, U32 index);
-	S32		getIndexFromKeyValue( StringTableEntry key, StringTableEntry value);
-
-};
 
 IMPLEMENT_CONOBJECT(Array);
 
@@ -174,8 +75,6 @@ static S32 QSORT_CALLBACK keyNumCompare( const void* a, const void* b )
    S32 res = result < 0 ? -1 : (result > 0 ? 1 : 0);
    return ( sIncreasing ? res : -res );
 }
-//-----------------------------------------------------------------------
-//	Object Init
 
 Array::Array()
 {
@@ -200,12 +99,11 @@ void Array::onRemove()
 
 
 
-//---------------------------------------------------------------------
-//	Data query functions
+
 
 S32 Array::getIndexFromValue( StringTableEntry value)  
 {  
-    for(U32 i=mCurrentIndex; i<mArray.size(); i++)  
+    for(S32 i=mCurrentIndex; i<mArray.size(); i++)  
     {  
         if(mArray[i].value == value)  
         {  
@@ -213,7 +111,7 @@ S32 Array::getIndexFromValue( StringTableEntry value)
         }  
     }  
   
-    for(U32 i=0; i<mCurrentIndex; i++)  
+    for(S32 i=0; i<mCurrentIndex; i++)  
     {  
         if(mArray[i].value == value)  
         {  
@@ -225,14 +123,14 @@ S32 Array::getIndexFromValue( StringTableEntry value)
   
 S32 Array::getIndexFromKey( StringTableEntry key)  
 {  
-    for(U32 i=mCurrentIndex; i<mArray.size(); i++)  
+    for(S32 i=mCurrentIndex; i<mArray.size(); i++)  
     {  
         if(mArray[i].key == key)  
         {  
             return i;  
         }  
     }  
-    for(U32 i=0; i<mCurrentIndex; i++)  
+    for(S32 i=0; i<mCurrentIndex; i++)  
     {  
         if(mArray[i].key == key)  
         {  
@@ -244,14 +142,14 @@ S32 Array::getIndexFromKey( StringTableEntry key)
   
 S32 Array::getIndexFromKeyValue( StringTableEntry key, StringTableEntry value)  
 {  
-    for(U32 i=mCurrentIndex; i<mArray.size(); i++)  
+    for(S32 i=mCurrentIndex; i<mArray.size(); i++)  
     {  
         if(mArray[i].key == key && mArray[i].value == value)  
         {  
             return i;  
         }  
     }  
-    for(U32 i=0; i<mCurrentIndex; i++)  
+    for(S32 i=0; i<mCurrentIndex; i++)  
     {  
         if(mArray[i].key == key && mArray[i].value == value)  
         {  
@@ -263,7 +161,7 @@ S32 Array::getIndexFromKeyValue( StringTableEntry key, StringTableEntry value)
 
 //	Returns the key for a given index.
 //	Will return a null value for an invalid index
-StringTableEntry Array::getKeyFromIndex(U32 index)
+StringTableEntry Array::getKeyFromIndex(S32 index)
 {
 	if(index >= mArray.size() || index < 0)
 		return NULL;
@@ -272,7 +170,7 @@ StringTableEntry Array::getKeyFromIndex(U32 index)
 
 //	Returns the value for a given index.
 //	Will return a null value for an invalid index
-StringTableEntry Array::getValueFromIndex(U32 index)
+StringTableEntry Array::getValueFromIndex(S32 index)
 {
 	if(index >= mArray.size() || index < 0)
 		return NULL;
@@ -280,16 +178,16 @@ StringTableEntry Array::getValueFromIndex(U32 index)
 }
 
 //	Counts the number of elements in the array
-U32 Array::count()
+S32 Array::count()
 {
 	return mArray.size();
 }
 
 //	Counts the number of instances of a particular value in the array
-U32 Array::countValue(StringTableEntry value)
+S32 Array::countValue(StringTableEntry value)
 {
-	U32 count = 0;
-	for(U32 i=0; i<mArray.size(); i++)
+	S32 count = 0;
+	for(S32 i=0; i<mArray.size(); i++)
 	{
 		if(mArray[i].value == value)
 			count++;
@@ -298,10 +196,10 @@ U32 Array::countValue(StringTableEntry value)
 }
 
 //	Counts the number of instances of a particular key in the array
-U32 Array::countKey(StringTableEntry key)
+S32 Array::countKey(StringTableEntry key)
 {
-	U32 count = 0;
-	for(U32 i=0; i<mArray.size(); i++)
+	S32 count = 0;
+	for(S32 i=0; i<mArray.size(); i++)
 	{
 		if(mArray[i].key == key)
 			count++;
@@ -333,7 +231,7 @@ void Array::push_front(StringTableEntry key, StringTableEntry value)
 }
 
 //	Adds a new array item to a particular index of the array
-void Array::insert(StringTableEntry key, StringTableEntry value, U32 index)
+void Array::insert(StringTableEntry key, StringTableEntry value, S32 index)
 {
 	index = mClampF(index, 0, mArray.size()-1);
 
@@ -370,7 +268,7 @@ void Array::pop_front()
 }
 
 //	Removes an array item from a particular index of the array
-void Array::erase(U32 index)
+void Array::erase(S32 index)
 {
 	if(index < 0 || index >= mArray.size())
 		return;
@@ -380,15 +278,15 @@ void Array::erase(U32 index)
 //	Clears an array
 void Array::empty()
 {
-	U32 size = mArray.size();
-	for(U32 i=0; i<size; i++)
+	S32 size = mArray.size();
+	for(S32 i=0; i<size; i++)
 		mArray.pop_front();
 	mCurrentIndex = 0;
 }
 
 
 //	Moves a key and value from one index location to another.
-void Array::moveIndex(U32 prev, U32 index)
+void Array::moveIndex(S32 prev, S32 index)
 {
 	if(index >= mArray.size())
 		push_back(mArray[prev].key, mArray[prev].value);
@@ -407,9 +305,9 @@ void Array::moveIndex(U32 prev, U32 index)
 //	(keeps the first instance only)
 void Array::uniqueValue()
 {
-	for(U32 i=0; i<mArray.size(); i++)
+	for(S32 i=0; i<mArray.size(); i++)
 	{
-		for(U32 j=i+1; j<mArray.size(); j++)
+		for(S32 j=i+1; j<mArray.size(); j++)
 		{
 			if(mArray[i].value == mArray[j].value)
 			{
@@ -424,9 +322,9 @@ void Array::uniqueValue()
 //	(keeps the first instance only)
 void Array::uniqueKey()
 {
-	for(U32 i=0; i<mArray.size(); i++)
+	for(S32 i=0; i<mArray.size(); i++)
 	{
-		for(U32 j=i+1; j<mArray.size(); j++)
+		for(S32 j=i+1; j<mArray.size(); j++)
 		{
 			if(mArray[i].key == mArray[j].key)
 			{
@@ -441,7 +339,7 @@ void Array::uniqueKey()
 void Array::duplicate(Array* obj)
 {
 	empty();
-	for(U32 i=0; i<obj->count(); i++)
+	for(S32 i=0; i<obj->count(); i++)
 	{
 		StringTableEntry tempval = obj->getValueFromIndex(i);
 		StringTableEntry tempkey = obj->getKeyFromIndex(i);
@@ -453,10 +351,10 @@ void Array::duplicate(Array* obj)
 //	Crops the keys that exists in the target array from our current array
 void Array::crop(Array* obj)
 {
-	for(U32 i=0; i<obj->count(); i++)
+	for(S32 i=0; i<obj->count(); i++)
 	{
 		StringTableEntry tempkey = obj->getKeyFromIndex(i);
-		for(U32 j=0; j<mArray.size(); j++)
+		for(S32 j=0; j<mArray.size(); j++)
 		{
 			if(mArray[j].key == tempkey)
 			{
@@ -470,7 +368,7 @@ void Array::crop(Array* obj)
 //	Appends the target array to our current array
 void Array::append(Array* obj)
 {
-	for(U32 i=0; i<obj->count(); i++)
+	for(S32 i=0; i<obj->count(); i++)
 	{
 		StringTableEntry tempval = obj->getValueFromIndex(i);
 		StringTableEntry tempkey = obj->getKeyFromIndex(i);
@@ -480,7 +378,7 @@ void Array::append(Array* obj)
 
 
 //	Sets the key at the given index
-void Array::setKey(StringTableEntry key, U32 index)
+void Array::setKey(StringTableEntry key, S32 index)
 {
 	if(index >= mArray.size())
 		return;
@@ -488,7 +386,7 @@ void Array::setKey(StringTableEntry key, U32 index)
 }
 
 //	Sets the key at the given index
-void Array::setValue(StringTableEntry value, U32 index)
+void Array::setValue(StringTableEntry value, S32 index)
 {
 	if(index >= mArray.size())
 		return;
@@ -525,27 +423,19 @@ void Array::sort(bool valsort, bool desc, bool numeric)
 	}
 }
 
-
-//---------------------------------------------------------------------
-//	Pointer Manipulation Functions
-
-//	Moves pointer to arrays first position
-U32 Array::moveFirst()
+S32 Array::moveFirst()
 {
 	mCurrentIndex = 0;
 	return mCurrentIndex;
 }
 
-//	Moves pointer to arrays last position
-U32 Array::moveLast()
+S32 Array::moveLast()
 {
 	mCurrentIndex = mArray.size()-1;
 	return mCurrentIndex;
 }
 
-//	Moves pointer to arrays next position
-//	If last position it returns -1 and no move occurs;
-U32 Array::moveNext()
+S32 Array::moveNext()
 {
 	if(mCurrentIndex >= mArray.size()-1)
 		return -1;
@@ -553,9 +443,7 @@ U32 Array::moveNext()
 	return mCurrentIndex;
 }
 
-//	Moves pointer to arrays prev position
-//	If first position it returns -1 and no move occurs;
-U32 Array::movePrev()
+S32 Array::movePrev()
 {
 	if(mCurrentIndex <= 0)
 		return -1;
@@ -563,18 +451,22 @@ U32 Array::movePrev()
 	return mCurrentIndex;
 }
 
-//	Returns current pointer index
-U32 Array::getCurrent()
+S32 Array::getCurrent()
 {
 	return mCurrentIndex;
 }
 
+void Array::setCurrent( S32 idx )
+{
+   if ( idx < 0 || idx >= mArray.size() )
+   {
+      Con::errorf( "Array::setCurrent( %d ) is out of the array bounds!", idx );
+      return;
+   }
 
-//---------------------------------------------------------------------
-//	Data Listing Functions
-
+   mCurrentIndex = idx;
+}
 
-//	Echos the array to console
 void Array::echo()
 {
 	Con::printf("Array Listing:");
@@ -586,270 +478,3 @@ void Array::echo()
 		Con::printf("%d    [%s]    =>    %s",(U32)i, key, val);
 	}
 }
-
-
-
-
-//---------------------------------------------------------------------
-//	Console Functions
-
-ConsoleMethod( Array, getIndexFromValue, S32, 3, 3, "(string value)"
-              "Search array from current position for the first matching value")
-{
-   StringTableEntry value = StringTable->insert(argv[2]);
-   return (S32)object->getIndexFromValue(value);
-}
-
-ConsoleMethod( Array, getIndexFromKey, S32, 3, 3, "(string key)"
-              "Search array from current position for the first matching key")
-{
-   StringTableEntry value = StringTable->insert(argv[2]);
-   return (S32)object->getIndexFromKey(value);
-}
-
-ConsoleMethod( Array, getValue, const char*, 3, 3, "(int index)"  
-              "Get the value of the array element at the submitted index")  
-{  
-   StringTableEntry ret = object->getValueFromIndex(dAtoi(argv[2]));  
-   return ret; // oxe 20081103 - no need to use the return buffer mechanism because StringTableEntries are write-once read-many.  
-}  
-  
-ConsoleMethod( Array, getKey, const char*, 3, 3, "(int index)"  
-              "Get the key of the array element at the submitted index")  
-{  
-   StringTableEntry ret = object->getKeyFromIndex(dAtoi(argv[2]));  
-   return ret; // oxe 20081103 - no need to use the return buffer mechanism because StringTableEntries are write-once read-many.  
-}
-
-ConsoleMethod( Array, setKey, void, 4, 4, "(string key, int index)"
-              "Set the key at the given index")
-{
-   StringTableEntry key = StringTable->insert(argv[2]);
-   U32 index = dAtoi(argv[3]);
-   object->setKey(key, index);
-}
-
-ConsoleMethod( Array, setValue, void, 4, 4, "(string key, int index)"
-              "Set the value at the given index")
-{
-   StringTableEntry value = StringTable->insert(argv[2]);
-   U32 index = dAtoi(argv[3]);
-   object->setValue(value, index);
-}
-
-ConsoleMethod( Array, count, S32, 2, 2, "Get the number of elements in the array")
-{
-	return (S32)object->count();
-}
-
-ConsoleMethod( Array, countValue, S32, 3, 3, "(string value)"
-              "Get the number of times a particular value is found in the array")
-{
-   StringTableEntry value = StringTable->insert(argv[2]);
-   return (S32)object->countValue(value);
-}
-
-ConsoleMethod( Array, countKey, S32, 3, 3, "(string key)"
-              "Get the number of times a particular key is found in the array")
-{
-   StringTableEntry value = StringTable->insert(argv[2]);
-   return (S32)object->countKey(value);
-}
-
-ConsoleMethod( Array, add, void, 4, 4, "(string key, string value)"
-              "Adds a new element to the end of an array")
-{
-   StringTableEntry key = StringTable->insert(argv[2]);
-   StringTableEntry value = StringTable->insert(argv[3]);
-   object->push_back(key, value);
-}
-
-ConsoleMethod( Array, push_back, void, 4, 4, "(string key, string value)"
-              "Adds a new element to the end of an array")
-{ 
-   StringTableEntry key = StringTable->insert(argv[2]);
-   StringTableEntry value = StringTable->insert(argv[3]);
-
-   object->push_back(key, value);
-}
-
-ConsoleMethod( Array, push_front, void, 4, 4, "(string key, string value)"
-              "Adds a new element to the front of an array")
-{
-   StringTableEntry key = StringTable->insert(argv[2]);
-   StringTableEntry value = StringTable->insert(argv[3]);
-   object->push_front(key, value);
-}
-
-ConsoleMethod( Array, insert, void, 5, 5, "(string key, string value, int index)"
-              "Adds a new element to a specified position in the array")
-{
-   StringTableEntry key = StringTable->insert(argv[2]);
-   StringTableEntry value = StringTable->insert(argv[3]);
-   object->insert(key, value, dAtoi(argv[4]));
-}
-
-ConsoleMethod( Array, pop_back, void, 2, 2, "Removes the last element from the array")
-{
-   object->pop_back();
-}
-
-ConsoleMethod( Array, pop_front, void, 2, 2, "Removes the first element from the array")
-{
-   object->pop_front();
-}
-
-ConsoleMethod( Array, erase, void, 3, 3, "(int index)"
-					"Removes an element at a specific position from the array")
-{
-   object->erase(dAtoi(argv[2]));
-}
-
-ConsoleMethod( Array, empty, void, 2, 2, "Emptys all elements from an array")
-{
-   object->empty();
-}
-
-ConsoleMethod( Array, uniqueValue, void, 2, 2, "Removes any elements that have duplicated values (leaving the first instance)")
-{
-   object->uniqueValue();
-}
-
-ConsoleMethod( Array, uniqueKey, void, 2, 2, "Removes any elements that have duplicated keys (leaving the first instance)")
-{
-   object->uniqueKey();
-}
-
-ConsoleMethod( Array, duplicate, bool, 3, 3, "(Array target)"
-					"Alters array into an exact duplicate of the target array")
-{
-	Array *target;
-	if (Sim::findObject(argv[2],target))
-	{
-		object->duplicate(target);
-		return true;
-	}
-	return false;
-}
-
-ConsoleMethod( Array, crop, bool, 3, 3, "(Array target)"
-					"Removes elements with matching keys from array")
-{
-	Array *target;
-	if (Sim::findObject(argv[2],target))
-	{
-		object->crop(target);
-		return true;
-	}
-	return false;
-}
-
-ConsoleMethod( Array, append, bool, 3, 3, "(Array target)"
-					"Appends the target array to the array object")
-{
-	Array *target;
-	if (Sim::findObject(argv[2],target))
-	{
-		object->append(target);
-		return true;
-	}
-	return false;
-}
-
-ConsoleMethod( Array, sort, void, 2, 3, "(bool desc)"
-					"Alpha sorts the array by value (default ascending sort)")
-{
-    bool descending = argc == 3 ? dAtob(argv[2]) : false;
-	object->sort(true,descending,false);
-}
-
-ConsoleMethod( Array, sorta, void, 2, 2, "Alpha sorts the array by value in ascending order")
-{
-	object->sort(true,false,false);
-}
-
-ConsoleMethod( Array, sortd, void, 2, 2, "Alpha sorts the array by value in descending order")
-{
-	object->sort(true,true,false);
-}
-
-ConsoleMethod( Array, sortk, void, 2, 3, "(bool desc)"
-					"Alpha sorts the array by key (default ascending sort)")
-{
-	bool descending = argc == 3 ? dAtob(argv[2]) : false;
-	object->sort(false,descending,false);
-}
-
-ConsoleMethod( Array, sortka, void, 2, 2, "Alpha sorts the array by key in ascending order")
-{
-	object->sort(false,false,false);
-}
-
-ConsoleMethod( Array, sortkd, void, 2, 2, "Alpha sorts the array by key in descending order")
-{
-	object->sort(false,true,false);
-}
-
-ConsoleMethod( Array, sortn, void, 2, 3, "(bool desc)"
-					"Numerically sorts the array by value (default ascending sort)")
-{
-    bool descending = argc == 3 ? dAtob(argv[2]) : false;
-	object->sort(true,descending,true);
-}
-
-ConsoleMethod( Array, sortna, void, 2, 2, "Numerically sorts the array by value in ascending order")
-{
-	object->sort(true,false,true);
-}
-
-ConsoleMethod( Array, sortnd, void, 2, 2, "Numerically sorts the array by value in descending order")
-{
-	object->sort(true,true,true);
-}
-
-ConsoleMethod( Array, sortnk, void, 2, 3, "(bool desc)"
-					"Numerically sorts the array by key (default ascending sort)")
-{
-    bool descending = argc == 3 ? dAtob(argv[2]) : false;
-	object->sort(false,descending,true);
-}
-
-ConsoleMethod( Array, sortnka, void, 2, 2, "Numerical sorts the array by key in ascending order")
-{
-	object->sort(false,false,true);
-}
-
-ConsoleMethod( Array, sortnkd, void, 2, 2, "Numerical sorts the array by key in descending order")
-{
-	object->sort(false,true,true);
-}
-
-ConsoleMethod( Array, moveFirst, S32, 2, 2, "Moves array pointer to start of array")
-{
-	return object->moveFirst();
-}
-
-ConsoleMethod( Array, moveLast, S32, 2, 2, "Moves array pointer to end of array")
-{
-	return object->moveLast();
-}
-
-ConsoleMethod( Array, moveNext, S32, 2, 2, "Moves array pointer to next position (returns -1 if cannot move)")
-{
-	return object->moveNext();
-}
-
-ConsoleMethod( Array, movePrev, S32, 2, 2, "Moves array pointer to prev position (returns -1 if cannot move)")
-{
-	return object->movePrev();
-}
-
-ConsoleMethod( Array, getCurrent, S32, 2, 2, "Gets the current pointer index")
-{
-	return object->getCurrent();
-}
-
-ConsoleMethod( Array, echo, void, 2, 2, "Echos the array in the console")
-{
-	object->echo();
-}

engine/source/console/arrayObject.h

@@ -0,0 +1,158 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2012 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#ifndef _ARRAYOBJECT_H_
+#define _ARRAYOBJECT_H_
+
+#ifndef _SIMBASE_H_
+#include "sim/simBase.h"
+#endif
+
+//	adopted from original code by Daniel Neilsen - 14/10/03
+//	[email protected]
+
+static bool sIncreasing;
+
+/// A data structure holding indexed sequences of key/value pairs for script use.
+class Array : public SimObject
+{
+   typedef SimObject Parent;
+
+private:
+
+
+
+public:
+	struct Element
+	{
+		StringTableEntry key;
+		StringTableEntry value;
+	};
+	
+	S32 mCurrentIndex;
+	Vector<Element> mArray;
+
+	Array();
+	
+	void onRemove();
+
+	//  add()				- (string key, string value)Adds a new element to the end of an array
+	bool onAdd();
+	
+	//  append()			- (Array target)Appends the target array to the array object
+	void append(Array* obj);
+	
+	//  count()				- Get the number of elements in the array
+	S32	count();
+	
+	//  countKey()			- (string key)Get the number of times a particular key is found in the array
+	S32	countKey(StringTableEntry key);
+	
+	//  countValue()		- (string value)Get the number of times a particular value is found in the array
+	S32	countValue(StringTableEntry value);
+	
+	//  crop()				- (Array target)Removes elements with matching keys from array
+	void crop(Array* obj);
+	
+	//  duplicate()			- (Array target)Alters array into an exact duplicate of the target array
+	void duplicate(Array* obj);
+	
+	//  echo()				- Echos the array in the console
+	void echo();
+	
+	//  empty()				- Emptys all elements from an array
+	void empty();
+	
+	//  erase()				- (int index)Removes an element at a specific position from the array
+	void erase(S32 index);
+	
+	//  getCurrent()		- Gets the current pointer index
+	S32	getCurrent();
+
+	// setCurrent()			- Sets the current pointer index
+	void setCurrent( S32 idx );
+	
+	//  getIndexFromKey()	- (string key)Search array from current position for the first matching key
+	S32	getIndexFromKey(StringTableEntry key);
+
+	//  getIndexFromValue() - (string value)Search array from current position for the first matching value
+	S32	getIndexFromValue(StringTableEntry value);
+	
+	//  getIndexFromKeyValue()		- Search array and return the index from the key and value
+	S32	getIndexFromKeyValue( StringTableEntry key, StringTableEntry value);
+	
+	//  getKeyFromIndex()			- (int index)Get the key of the array element at the submitted index
+	StringTableEntry getKeyFromIndex(S32 index);
+	
+	//  getValueFromIndex()			- (int index)Get the value of the array element at the submitted index
+	StringTableEntry getValueFromIndex(S32 index);
+	
+	//  setKey()			- (string key, int index)Set the key at the given index
+	void setKey(StringTableEntry key, S32 index);
+	
+	//  setValue()			- (string key, int index)Set the value at the given index
+	void setValue(StringTableEntry value, S32 index);
+		
+	//  insert()			- (string key, string value, int index)Adds a new element to a specified position in the array
+	void insert(StringTableEntry key, StringTableEntry value, S32 index);
+	
+	//  moveFirst()			- Moves array pointer to start of array
+	S32	moveFirst();
+	
+	//  moveLast()			- Moves array pointer to end of array
+	S32	moveLast();
+	
+	//  moveNext()			- Moves array pointer to next position (returns -1 if cannot move)
+	S32	moveNext();
+	
+	//  movePrev()			- Moves array pointer to prev position (returns -1 if cannot move)
+	S32	movePrev();
+	
+	// moveIndex()			- Moves a key and value from one index location to another.
+	void moveIndex(S32 prev, S32 index);
+	
+	//  pop_back()			- Removes the last element from the array
+	void pop_back();
+	
+	//  pop_front()			- Removes the first element from the array
+	void pop_front();
+	
+	//  push_back()			- (string key, string value)Adds a new element to the end of an array
+	void push_back(StringTableEntry key, StringTableEntry value);
+	
+	//  push_front()		- (string key, string value)Adds a new element to the front of an array
+	void push_front(StringTableEntry key, StringTableEntry value);
+	
+	//  sort()				- (bool desc)Sorts the array by value (default ascending sort)
+	void sort(bool valtest, bool desc, bool numeric);
+	
+	//  uniqueKey()			- Removes any elements that have duplicated keys (leaving the first instance)
+	void uniqueKey();
+	
+	//  uniqueValue()		- Removes any elements that have duplicated values (leaving the first instance)
+	void uniqueValue();
+//-----------------------------------------------------------------------------
+
+DECLARE_CONOBJECT(Array);
+
+};
+#endif // _ARRAYOBJECT_H_

engine/source/console/arrayObject_ScriptBinding.h

@@ -0,0 +1,285 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2012 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+//	adopted from original code by Daniel Neilsen - 14/10/03
+//	[email protected]
+
+ConsoleMethodWithDocs( Array, getIndexFromValue, S32, 3, 3, "(string value)"
+              "Search array from current position for the first matching value")
+{
+   StringTableEntry value = StringTable->insert(argv[2]);
+   return (S32)object->getIndexFromValue(value);
+}
+
+ConsoleMethodWithDocs( Array, getIndexFromKey, S32, 3, 3, "(string key)"
+              "Search array from current position for the first matching key")
+{
+   StringTableEntry value = StringTable->insert(argv[2]);
+   return (S32)object->getIndexFromKey(value);
+}
+
+ConsoleMethodWithDocs( Array, getValue, const char*, 3, 3, "(int index)"  
+              "Get the value of the array element at the submitted index")  
+{  
+   StringTableEntry ret = object->getValueFromIndex(dAtoi(argv[2]));  
+   return ret; // oxe 20081103 - no need to use the return buffer mechanism because StringTableEntries are write-once read-many.  
+}  
+  
+ConsoleMethodWithDocs( Array, getKey, const char*, 3, 3, "(int index)"  
+              "Get the key of the array element at the submitted index")  
+{  
+   StringTableEntry ret = object->getKeyFromIndex(dAtoi(argv[2]));  
+   return ret; // oxe 20081103 - no need to use the return buffer mechanism because StringTableEntries are write-once read-many.  
+}
+
+ConsoleMethodWithDocs( Array, setKey, void, 4, 4, "(string key, int index)"
+              "Set the key at the given index")
+{
+   StringTableEntry key = StringTable->insert(argv[2]);
+   S32 index = dAtoi(argv[3]);
+   object->setKey(key, index);
+}
+
+ConsoleMethodWithDocs( Array, setValue, void, 4, 4, "(string key, int index)"
+              "Set the value at the given index")
+{
+   StringTableEntry value = StringTable->insert(argv[2]);
+   S32 index = dAtoi(argv[3]);
+   object->setValue(value, index);
+}
+
+ConsoleMethodWithDocs( Array, count, S32, 2, 2, "Get the number of elements in the array")
+{
+	return (S32)object->count();
+}
+
+ConsoleMethodWithDocs( Array, countValue, S32, 3, 3, "(string value)"
+              "Get the number of times a particular value is found in the array")
+{
+   StringTableEntry value = StringTable->insert(argv[2]);
+   return (S32)object->countValue(value);
+}
+
+ConsoleMethodWithDocs( Array, countKey, S32, 3, 3, "(string key)"
+              "Get the number of times a particular key is found in the array")
+{
+   StringTableEntry value = StringTable->insert(argv[2]);
+   return (S32)object->countKey(value);
+}
+
+ConsoleMethodWithDocs( Array, add, void, 4, 4, "(string key, string value)"
+              "Adds a new element to the end of an array")
+{
+   StringTableEntry key = StringTable->insert(argv[2]);
+   StringTableEntry value = StringTable->insert(argv[3]);
+   object->push_back(key, value);
+}
+
+ConsoleMethodWithDocs( Array, push_back, void, 4, 4, "(string key, string value)"
+              "Adds a new element to the end of an array")
+{ 
+   StringTableEntry key = StringTable->insert(argv[2]);
+   StringTableEntry value = StringTable->insert(argv[3]);
+
+   object->push_back(key, value);
+}
+
+ConsoleMethodWithDocs( Array, push_front, void, 4, 4, "(string key, string value)"
+              "Adds a new element to the front of an array")
+{
+   StringTableEntry key = StringTable->insert(argv[2]);
+   StringTableEntry value = StringTable->insert(argv[3]);
+   object->push_front(key, value);
+}
+
+ConsoleMethodWithDocs( Array, insert, void, 5, 5, "(string key, string value, int index)"
+              "Adds a new element to a specified position in the array")
+{
+   StringTableEntry key = StringTable->insert(argv[2]);
+   StringTableEntry value = StringTable->insert(argv[3]);
+   object->insert(key, value, dAtoi(argv[4]));
+}
+
+ConsoleMethodWithDocs( Array, pop_back, void, 2, 2, "Removes the last element from the array")
+{
+   object->pop_back();
+}
+
+ConsoleMethodWithDocs( Array, pop_front, void, 2, 2, "Removes the first element from the array")
+{
+   object->pop_front();
+}
+
+ConsoleMethodWithDocs( Array, erase, void, 3, 3, "(int index)"
+					"Removes an element at a specific position from the array")
+{
+   object->erase(dAtoi(argv[2]));
+}
+
+ConsoleMethodWithDocs( Array, empty, void, 2, 2, "Emptys all elements from an array")
+{
+   object->empty();
+}
+
+ConsoleMethodWithDocs( Array, uniqueValue, void, 2, 2, "Removes any elements that have duplicated values (leaving the first instance)")
+{
+   object->uniqueValue();
+}
+
+ConsoleMethodWithDocs( Array, uniqueKey, void, 2, 2, "Removes any elements that have duplicated keys (leaving the first instance)")
+{
+   object->uniqueKey();
+}
+
+ConsoleMethodWithDocs( Array, duplicate, bool, 3, 3, "(Array target)"
+					"Alters array into an exact duplicate of the target array")
+{
+	Array *target;
+	if (Sim::findObject(argv[2],target))
+	{
+		object->duplicate(target);
+		return true;
+	}
+	return false;
+}
+
+ConsoleMethodWithDocs( Array, crop, bool, 3, 3, "(Array target)"
+					"Removes elements with matching keys from array")
+{
+	Array *target;
+	if (Sim::findObject(argv[2],target))
+	{
+		object->crop(target);
+		return true;
+	}
+	return false;
+}
+
+ConsoleMethodWithDocs( Array, append, bool, 3, 3, "(Array target)"
+					"Appends the target array to the array object")
+{
+	Array *target;
+	if (Sim::findObject(argv[2],target))
+	{
+		object->append(target);
+		return true;
+	}
+	return false;
+}
+
+ConsoleMethodWithDocs( Array, sort, void, 2, 3, "(bool desc)"
+					"Alpha sorts the array by value (default ascending sort)")
+{
+    bool descending = argc == 3 ? dAtob(argv[2]) : false;
+	object->sort(true,descending,false);
+}
+
+ConsoleMethodWithDocs( Array, sorta, void, 2, 2, "Alpha sorts the array by value in ascending order")
+{
+	object->sort(true,false,false);
+}
+
+ConsoleMethodWithDocs( Array, sortd, void, 2, 2, "Alpha sorts the array by value in descending order")
+{
+	object->sort(true,true,false);
+}
+
+ConsoleMethodWithDocs( Array, sortk, void, 2, 3, "(bool desc)"
+					"Alpha sorts the array by key (default ascending sort)")
+{
+	bool descending = argc == 3 ? dAtob(argv[2]) : false;
+	object->sort(false,descending,false);
+}
+
+ConsoleMethodWithDocs( Array, sortka, void, 2, 2, "Alpha sorts the array by key in ascending order")
+{
+	object->sort(false,false,false);
+}
+
+ConsoleMethodWithDocs( Array, sortkd, void, 2, 2, "Alpha sorts the array by key in descending order")
+{
+	object->sort(false,true,false);
+}
+
+ConsoleMethodWithDocs( Array, sortn, void, 2, 3, "(bool desc)"
+					"Numerically sorts the array by value (default ascending sort)")
+{
+    bool descending = argc == 3 ? dAtob(argv[2]) : false;
+	object->sort(true,descending,true);
+}
+
+ConsoleMethodWithDocs( Array, sortna, void, 2, 2, "Numerically sorts the array by value in ascending order")
+{
+	object->sort(true,false,true);
+}
+
+ConsoleMethodWithDocs( Array, sortnd, void, 2, 2, "Numerically sorts the array by value in descending order")
+{
+	object->sort(true,true,true);
+}
+
+ConsoleMethodWithDocs( Array, sortnk, void, 2, 3, "(bool desc)"
+					"Numerically sorts the array by key (default ascending sort)")
+{
+    bool descending = argc == 3 ? dAtob(argv[2]) : false;
+	object->sort(false,descending,true);
+}
+
+ConsoleMethodWithDocs( Array, sortnka, void, 2, 2, "Numerical sorts the array by key in ascending order")
+{
+	object->sort(false,false,true);
+}
+
+ConsoleMethodWithDocs( Array, sortnkd, void, 2, 2, "Numerical sorts the array by key in descending order")
+{
+	object->sort(false,true,true);
+}
+
+ConsoleMethodWithDocs( Array, moveFirst, S32, 2, 2, "Moves array pointer to start of array")
+{
+	return object->moveFirst();
+}
+
+ConsoleMethodWithDocs( Array, moveLast, S32, 2, 2, "Moves array pointer to end of array")
+{
+	return object->moveLast();
+}
+
+ConsoleMethodWithDocs( Array, moveNext, S32, 2, 2, "Moves array pointer to next position (returns -1 if cannot move)")
+{
+	return object->moveNext();
+}
+
+ConsoleMethodWithDocs( Array, movePrev, S32, 2, 2, "Moves array pointer to prev position (returns -1 if cannot move)")
+{
+	return object->movePrev();
+}
+
+ConsoleMethodWithDocs( Array, getCurrent, S32, 2, 2, "Gets the current pointer index")
+{
+	return object->getCurrent();
+}
+
+ConsoleMethodWithDocs( Array, echo, void, 2, 2, "Echos the array in the console")
+{
+	object->echo();
+}