codeblocks-dev 13.12-3 / usr / include / codeblocks / scripting / sqplus / SquirrelObject.h

#ifndef _SQUIRREL_OBJECT_H_
#define _SQUIRREL_OBJECT_H_

// C::B patch: Include required, so references are found
#include "sqplus.h"

class SquirrelObject
{
	friend class SquirrelVM;
public:
	SquirrelObject();
	virtual ~SquirrelObject();
	SquirrelObject(const SquirrelObject &o);
	SquirrelObject(HSQOBJECT o);
	SquirrelObject & operator =(const SquirrelObject &o);
	SquirrelObject & operator =(SQInteger n);
	void AttachToStackObject(SQInteger idx);
  void Reset(void); // Release (any) reference and reset _o.
  SquirrelObject Clone();
	BOOL_T SetValue(const SquirrelObject &key,const SquirrelObject &val);

	BOOL_T SetValue(SQInteger key,const SquirrelObject &val);
	BOOL_T SetValue(INT_T key,bool b); // Compiler treats SQBool as INT_T.
	BOOL_T SetValue(INT_T key,INT_T n);
	BOOL_T SetValue(INT_T key,FLOAT_T f);
	BOOL_T SetValue(INT_T key,const SQChar *s);

	BOOL_T SetValue(const SQChar *key,const SquirrelObject &val);
	BOOL_T SetValue(const SQChar *key,bool b);
	BOOL_T SetValue(const SQChar *key,INT_T n);
	BOOL_T SetValue(const SQChar *key,FLOAT_T f);
	BOOL_T SetValue(const SQChar *key,const SQChar *s);

  BOOL_T SetUserPointer(const SQChar * key,SQUserPointer up);
  SQUserPointer GetUserPointer(const SQChar * key);
  BOOL_T SetUserPointer(INT_T key,SQUserPointer up);
  SQUserPointer GetUserPointer(INT_T key);

  BOOL_T NewUserData(const SQChar * key,INT_T size,SQUserPointer * typetag=0);
  BOOL_T GetUserData(const SQChar * key,SQUserPointer * data,SQUserPointer * typetag=0);
  BOOL_T RawGetUserData(const SQChar * key,SQUserPointer * data,SQUserPointer * typetag=0);

  // === BEGIN Arrays ===

  BOOL_T ArrayResize(INT_T newSize);
  BOOL_T ArrayExtend(INT_T amount);
  BOOL_T ArrayReverse(void);
  SquirrelObject ArrayPop(SQBool returnPoppedVal=SQTrue);

  void ArrayAppend(const SquirrelObject &o);

  template<typename T>
  BOOL_T ArrayAppend(T item);

  // === END Arrays ===

	BOOL_T SetInstanceUP(SQUserPointer up);
	BOOL_T IsNull() const;
	SQInteger IsNumeric() const;
	SQInteger Len() const;
	BOOL_T SetDelegate(SquirrelObject &obj);
	SquirrelObject GetDelegate();
	const SQChar* ToString();
	bool ToBool();
	SQInteger ToInteger();
	SQFloat ToFloat();
	SQUserPointer GetInstanceUP(SQUserPointer tag) const;
	SquirrelObject GetValue(const SQChar *key) const;
	BOOL_T Exists(const SQChar *key) const;
	FLOAT_T GetFloat(const SQChar *key) const;
	INT_T GetInt(const SQChar *key) const;
	const SQChar *GetString(const SQChar *key) const;
	bool GetBool(const SQChar *key) const;
	SquirrelObject GetValue(INT_T key) const;
	FLOAT_T GetFloat(INT_T key) const;
	INT_T GetInt(INT_T key) const;
	const SQChar *GetString(INT_T key) const;
	bool GetBool(INT_T key) const;
	SquirrelObject GetAttributes(const SQChar *key = NULL);
	SQObjectType GetType();
	HSQOBJECT & GetObjectHandle(){return _o;}
	BOOL_T BeginIteration();
	BOOL_T Next(SquirrelObject &key,SquirrelObject &value);
	void EndIteration();

  BOOL_T GetTypeTag(SQUserPointer * typeTag);

  // === Get the type name of item/object through string key in a table or class. Returns NULL if the type name is not set (not an SqPlus registered type).
  const SQChar * GetTypeName(const SQChar * key);
  // === Get the type name of item/object through INT_T key in a table or class. Returns NULL if the type name is not set (not an SqPlus registered type).
  const SQChar * GetTypeName(INT_T key);
  // === Get the type name of this object, else return NULL if not an SqPlus registered type.
  const SQChar * GetTypeName(void);


private:
	BOOL_T GetSlot(const SQChar *name) const;
  BOOL_T RawGetSlot(const SQChar *name) const;
	BOOL_T GetSlot(INT_T key) const;
	HSQOBJECT _o;
};

struct StackHandler {
	StackHandler(HSQUIRRELVM vm) {
		_top = sq_gettop(vm);
		this->v = vm;
	}
	SQFloat GetFloat(SQInteger idx) {
		SQFloat x = 0.0f;
		if(idx > 0 && idx <= _top) {
			sq_getfloat(v,idx,&x);
		}
		return x;
	}
	SQInteger GetInt(SQInteger idx) {
		SQInteger x = 0;
		if(idx > 0 && idx <= _top) {
			sq_getinteger(v,idx,&x);
		}
		return x;
	}
	HSQOBJECT GetObjectHandle(SQInteger idx) {
		HSQOBJECT x;
		if(idx > 0 && idx <= _top) {
			sq_resetobject(&x);
			sq_getstackobj(v,idx,&x);
		}
		return x;
	}
	const SQChar *GetString(SQInteger idx)
	{
    const SQChar *x = NULL;
		if(idx > 0 && idx <= _top) {
			sq_getstring(v,idx,&x);
		}
		return x;
	}
	SQUserPointer GetUserPointer(SQInteger idx)
	{
		SQUserPointer x = 0;
		if(idx > 0 && idx <= _top) {
			sq_getuserpointer(v,idx,&x);
		}
		return x;
	}
	SQUserPointer GetInstanceUp(SQInteger idx,SQUserPointer tag)
	{
		SQUserPointer self;
		if(SQ_FAILED(sq_getinstanceup(v,idx,(SQUserPointer*)&self,tag)))
			return NULL;
		return self;
	}
	SQUserPointer GetUserData(SQInteger idx,SQUserPointer tag=0)
	{
		SQUserPointer otag;
		SQUserPointer up;
		if(idx > 0 && idx <= _top) {
			if(SQ_SUCCEEDED(sq_getuserdata(v,idx,&up,&otag))) {
				if(tag == otag)
					return up;
			}
		}
		return NULL;
	}
	BOOL_T GetBool(SQInteger idx)
	{
		SQBool ret;
		if(idx > 0 && idx <= _top) {
			if(SQ_SUCCEEDED(sq_getbool(v,idx,&ret)))
				return ret;
		}
		return FALSE;
	}
	SQInteger GetType(SQInteger idx)
	{
		if(idx > 0 && idx <= _top) {
			return sq_gettype(v,idx);
		}
		return -1;
	}

	SQInteger GetParamCount() {
		return _top;
	}
	SQInteger Return(const SQChar *s)
	{
		sq_pushstring(v,s,-1);
		return 1;
	}
	SQInteger Return(FLOAT_T f)
	{
		sq_pushfloat(v,f);
		return 1;
	}
	SQInteger Return(INT_T i)
	{
		sq_pushinteger(v,i);
		return 1;
	}
	SQInteger Return(bool b)
	{
		sq_pushbool(v,b);
		return 1;
	}
  SQInteger Return(SQUserPointer p) {
    sq_pushuserpointer(v,p);
    return 1;
  }
	SQInteger Return(SquirrelObject &o)
	{
		sq_pushobject(v,o.GetObjectHandle());
		return 1;
	}
	SQInteger Return() { return 0; }
	SQInteger ThrowError(const SQChar *error) {
		return sq_throwerror(v,error);
	}
  HSQUIRRELVM GetVMPtr() { return v; }
private:
	SQInteger _top;
	HSQUIRRELVM v;
};

#endif //_SQUIRREL_OBJECT_H_