WoW:API debugstack - Revision history

Move page script: Move page script moved page API debugstack to WoW:API debugstack without leaving a redirect

2023-08-15T04:45:24Z

Move page script moved page API debugstack to API debugstack without leaving a redirect

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

WoWWiki>Sinus.pi: Added thread parameter and example.

2018-04-26T22:10:30Z

Added thread parameter and example.

← Older revision		Revision as of 22:10, 26 April 2018
Line 3:		Line 3:
	Output a string representation of the current calling stack, similar to the standard Lua debug.traceback() call, which is not present in WoW.		Output a string representation of the current calling stack, similar to the standard Lua debug.traceback() call, which is not present in WoW.

	description = debugstack([start[, count1[, count2]]])		description = debugstack([thread, ][start[, count1[, count2]]]])

	== Arguments ==		== Arguments ==
	=== Parameters ===		=== Parameters ===
	:;start:Number - the stack depth at which to start the stack trace (default 1 - the function calling debugstack)		:;thread:Thread - a coroutine thread, obtained with coroutine.create(). Use to inspect the current call stack inside a coroutine that has yielded or died.
			:;start
			:Number - the stack depth at which to start the stack trace (default 1 - the function calling debugstack)
	:;count1:Number - the number of functions to output at the top of the stack (default 12)		:;count1:Number - the number of functions to output at the top of the stack (default 12)
	:;count2:Number - the number of functions to output at the bottom of the stack (default 10)		:;count2:Number - the number of functions to output at the bottom of the stack (default 10)
Line 64:		Line 66:
	This would return the following output from print:		This would return the following output from print:
	Debug Print on Line 7 with message: We tried to do something.		Debug Print on Line 7 with message: We tried to do something.

			== Example 3 ==
			Using debugstack to find out the location of an error in a coroutine.
			1: function f()
			2: print ("a">0) -- this will cause an error
			3: end
			4:
			5: thread = coroutine.create(f)
			6: executed_ok,message = coroutine.resume(thread)
			7:
			8: if not executed_ok then
			9: print("Error: "..message.." in "..debugstack(thread))
			10: end

	Note that despite its all-lowercase name, this is not a core [[Lua]] function. It is a WoW API.		Note that despite its all-lowercase name, this is not a core [[Lua]] function. It is a WoW API.

2600:8800:2E84:8800:80C4:C369:D7FD:4028: Added a second example that can pull the line number of itself in a file. Useful for debug purposes in an addon.

2017-11-19T03:17:17Z

Added a second example that can pull the line number of itself in a file. Useful for debug purposes in an addon.

← Older revision		Revision as of 03:17, 19 November 2017
Line 51:		Line 51:
	file.lua:19		file.lua:19


			== Example 2 ==
			Combining debugstack with a strmatch can enable you to get the current line of a function call.
			1: function debugprint(msg)
			2: local line = strmatch(debugstack(2),":(%d):");
			3: print("Debug Print on Line "..line.." with message: "..msg);
			4: end
			5:
			6: function doSomething()
			7: debugprint("We tried to do something.");
			8: end
			This would return the following output from print:
			Debug Print on Line 7 with message: We tried to do something.

	Note that despite its all-lowercase name, this is not a core [[Lua]] function. It is a WoW API.		Note that despite its all-lowercase name, this is not a core [[Lua]] function. It is a WoW API.

WoWWiki>Cogwheel: /* Example */ fixed a copy/paste typo and missing parentheses

2006-12-01T03:44:03Z

Example: fixed a copy/paste typo and missing parentheses

← Older revision		Revision as of 03:44, 1 December 2006
Line 34:		Line 34:
	13: function f() e(); end		13: function f() e(); end
	14:		14:
	15: function errhandler(msg)~~; end~~		15: function errhandler(msg)
	16: print msg .. "\nCall stack: \n" .. debugstack(2, 3, 2);		16: print (msg .. "\nCall stack: \n" .. debugstack(2, 3, 2));
	17: end		17: end
	18:		18:

WoWWiki>Mikk: Major rewrite. Should be more easily understood now.

2006-07-18T12:25:02Z

Major rewrite. Should be more easily understood now.

@@ Line 1: / Line 1: @@
-debugstack([start] [, count1] [, count2])
+{{wowapi}}
-This function returns a string representation of the current calling stack, similar to the output of the normal Lua debug.traceback() call.<br>
+Output a string representation of the current calling stack, similar to the standard Lua debug.traceback() call, which is not present in WoW.
-The parameter 'start' is the function level to start the stack trace, which defaults to 1 (the function that called debugstack()).<br>
+ description = debugstack([start[, count1[, count2]]])
-For example, if you had the following call chain:<br>
+== Arguments ==
-debugstack(2, 1, 3)<br>
+=== Parameters ===
-a()<br>
+:;start:Number - the stack depth at which to start the stack trace (default 1 - the function calling debugstack)
-b()<br>
+:;count1:Number - the number of functions to output at the top of the stack (default 12)
-c()<br>
+:;count2:Number - the number of functions to output at the bottom of the stack (default 10)
-d()<br>
-e()<br>
+=== Returns ===
-f()<br>
+:;description:String - a multi-line string showing what the current call stack looks like
-g()<br>
-(g calls f calls e, etc.)<br>
+If there are more than count1+count2 calls in the stack, they are separated by a "..." line.
-The output would show b, ..., e, f, g <br>

WoWWiki>Rmgaddy at 07:06, 6 February 2006

2006-02-06T07:06:11Z

New page

debugstack([start] [, count1] [, count2])

This function returns a string representation of the current calling stack, similar to the output of the normal Lua debug.traceback() call. 

The parameter 'start' is the function level to start the stack trace, which defaults to 1 (the function that called debugstack()). 
The parameter 'count1' is the number of function calls to show in the first part of the stack trace, which defaults to 12. 
The parameter 'count2' is the number of function calls to show in the second part of the stack trace, which defaults to 10. 
If there are more than count1+count2 calls in the stack trace, they are separated by "..." 

For example, if you had the following call chain: 
debugstack(2, 1, 3) 
a() 
b() 
c() 
d() 
e() 
f() 
g() 
(g calls f calls e, etc.) 
The output would show b, ..., e, f, g