Function Objects
"Function object" usually means any of the following:
- A reference to a Func object, which represents an actual function; either built-in or defined by the script.
- A user-defined object which can be called like a function. This is sometimes also referred to as a "functor".
- Any other object which can be called like a function, such as a BoundFunc object or a JavaScript function object returned by a COM method.
Function objects can be used with the following:
User-Defined
User-defined function objects must define a Call method containing the implementation of the "function".
class YourClassName {
Call(a, b) { ; Declare parameters as needed, or an array*.
;...
return c
}
;...
}
Examples
The following example defines a function array which can be called; when called, it calls each element of the array in turn.
class FuncArrayType {
Call(obj, params*) {
; Call a list of functions.
Loop % this.Length()
this[A_Index].Call(params*)
}
}
; Create an array of functions.
funcArray := new FuncArrayType
; Add some functions to the array (can be done at any point).
funcArray.Push(Func("One"))
funcArray.Push(Func("Two"))
; Create an object which uses the array as a method.
obj := {method: funcArray}
; Call the method.
obj.method("foo", "bar")
One(param1, param2) {
ListVars
MsgBox
}
Two(param1, param2) {
ListVars
MsgBox
}
BoundFunc Object
Acts like a function, but just passes predefined parameters to another function.
There are two ways that BoundFunc objects can be created:
- By calling the Func.Bind() method, which binds parameter values to a function.
- By calling the ObjBindMethod() function, which binds parameter values and a method name to a target object.
BoundFunc objects can be called as shown in the example below. No other methods are supported. When the BoundFunc is called, it calls the function or method to which it is bound, passing any bound parameters followed by any which were passed by the caller. For example:
fn := Func("RealFn").Bind(1)
%fn%(2) ; Shows "1, 2"
fn.Call(3) ; Shows "1, 3"
RealFn(a, b) {
MsgBox("%a%, %b%")
}
ObjBindMethod() can be used to bind to a method when it isn't possible to retrieve a reference to the method itself. For example:
file := FileOpen(A_ScriptFullPath, "r") getLine := ObjBindMethod(file, "ReadLine") MsgBox % %getLine%() ; Shows the first line of this file.
For a more complex example, see SetTimer.