[AHK v2] CallStack

[hoppfrosch]

Hi there,

User Deo once presentend a solution to get the CallStack. ( [AHK_L] How to get CallStack - solution).

I rewrote this function to work with AutoHotkey V2 (tested with latest alpha a100). I changed the function to return an object (associative array) holding the callstack information.

Usage Example:

Code: Select all

#include %A_ScriptDir%\..\lib\CallStack.ahk

foo1()
return

; ----------------
foo1(){
  foo2()
}
; ----------------
foo2(){
  foo3()
}
; ----------------
foo3(){
  foo4()
}
; ----------------
foo4(){
  foo5()
}
; ----------------
foo5(){
	x:= CallStack()
	str := ""

	; Example 1
	str := "I'm function <" . x[0].function . ">`n"
	str := str . "=> I was called from function <" . x[-1].function . ">`n"
	str := str . "   from file <" . x[-1].file . ">, line <" . x[-1].line . ">`n"
	str := str . "   (line contents: <" . x[-1].contents . ">`n"
	MsgBox str

	; Example 2
	str := ""
	for key, value in x { ; Show the callstack for foo5()
		if (A_Index > 1 )
			str := str . " => "
		str := str . value.function	
	}
	MsgBox str
}

And here's the function:

Code: Select all

; ===================================================================================
; AHK Version ...: Tested with AHK v2.0-a100-52515e2 x64 Unicode
; Win Version ...: Tested with Windows 10 Enterprise x64
; Authors ........:  * Original - deo (original)
; ...............   * Modifications - hoppfrosch 
; License .......: WTFPL (http://www.wtfpl.net/about/)
; Source ........: Original: https://autohotkey.com/board/topic/76062-ahk-l-how-to-get-callstack-solution/
; ................ V2 : https://github.com/AutoHotkey-V2/CallStack
; ===================================================================================


/*
Name: CallStack - Gets the current call stack

Version 1.0.1

Description:
	Gets the current callstack, containing information like functionname, filename and linenumber of the function.
	An associative Attay is returned, containing array elements in range of 0 to -calldepth (negative numbers). 
	Index 0 contains the info about current function, whereas Index -1 contains info about the parent (caller) 
	of the current function. (-2: Grandparent ...)

Example:
	cs := CallStack()
	# Print the current callstack
	for level, obj in  CallStack() { 
		if (A_Index > 1 )
			str := str . " => "
		str := str . obj.function	
	}
	MsgBox str

Parameter:
	* deepness (optional, default := 100) - determines the depth of the determined callstack
	* getContents (optional, default := true) - get the contents of the line, where the current function is called
*/

CallStack(deepness :=100, getContents := true) {
	stack := {}
	max := 0
	loop deepness {
		lvl := -1 - deepness + A_Index
		oEx := Exception("", lvl)
		oExPrev := Exception("", lvl - 1)
			
		if (getContents) { ; Get the corresponding line from the file
			file := FileOpen(oEx.file, "r")
			loop {
				if (file.AtEOF)
					break
				line := File.ReadLine() 
				if (A_Index == oEx.line)
					break
			}
			file.close()
		}
		
		if(oEx.What == lvl)
			continue
			
		currStack := {}			
		currStack.file := oEx.File
		currStack.line := oEx.Line
		currStack.function := (oExPrev.What = lvl-1 ? "[AUTO-EXECUTE]" :  oExPrev.What)
		currStack.depth := deepness - A_Index
		if (max < currStack.depth) {
			max :=  currStack.depth
		}
		if (getContents) {
			currStack.contents := line
		}
		stack[lvl+1] := currStack
	}
	for key,value in stack {
		stack[key].depth := max - stack[key].depth
	}
	return stack
}

CallStack is available on github

Always find latest releases on github