WoW:API debugstack: Difference between revisions

WoW:API debugstack (source)

Revision as of 12:25, 18 July 2006

590 bytes added , 18 July 2006

Major rewrite. Should be more easily understood now.

Anonymous user

WoWWiki>Mikk

@@ 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]]])
-The parameter 'count1' is the number of function calls to show in the first part of the stack trace, which defaults to 12.<br>
-The parameter 'count2' is the number of function calls to show in the second part of the stack trace, which defaults to 10.<br>
-If there are more than count1+count2 calls in the stack trace, they are separated by "..."<br>
-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>
+== Example ==
+Assume the following example file, "file.lua":
+: function a()
+:   error("Boom!");
+: end
+:
+: function b() a(); end
+:
+: function c() b(); end
+:
+: function d() c(); end
+:
+: function e() d(); end
+:
+: function f() e(); end
+:
+: function errhandler(msg); end
+:   print msg .. "\nCall stack: \n" .. debugstack(2, 3, 2);
+: end
+:
+: xpcall(f, errhandler);
+This would output something along the following:
+ file.lua:2: Boom!
+ Call stack:
+ file.lua:2: in function a
+ file.lua:5: in function b
+ file.lua:7: in function c
+ ...
+ file.lua:13: in function f
+ file.lua:19
+Note that despite its all-lowercase name, this is not a core [[Lua]] function. It is a WoW API.