Class IObjectPtr

source/script.h:1424–1443

This class encapsulates a pointer to an object which can be called by a timer, hotkey, etc. It provides common functionality that wouldn't be suitable for the base IObject interface, but is needed for detection of "Suspend" or "Critical" prior to calling the sub or function.

// base IObject interface, but is needed for detection of "Suspend" or "Critical"
// prior to calling the sub or function.
class IObjectPtr
{
protected:
	IObject *mObject;
	
public:
	IObjectPtr() : mObject(NULL) {}
	IObjectPtr(IObject *object) : mObject(object) {}
	ResultType ExecuteInNewThread(TCHAR *aNewThreadDesc
		, ExprTokenType *aParamValue = NULL, int aParamCount = 0, __int64 *aRetVal = NULL) const;
	const IObjectPtr* operator-> () { return this; } // Act like a pointer.
	operator void *() const { return mObject; } // For comparisons and boolean eval.

	// Caller beware: does not check for NULL.
	Func *ToFunc() const;
	IObject *ToObject() const { return mObject; }
	
	// Currently only used by ListLines, listing active timers.
	LPCTSTR Name() const;
};

// IObjectPtr with automatic reference-counting, for storing an object safely,
// such as in a HotkeyVariant, UserMenuItem, etc.  Its specific purpose is to