www

commit c5a532c7890cf82ec5435a5e1f715e46b5757542
parent 15d10d18a70b1e76ccdb0520be4ba3616841f96e
Author: Aurimas Vinckevicius <aurimas.dev@gmail.com>
Date:   Tue, 12 Aug 2014 00:17:20 -0500

Add option to print stack with debug messages

Diffstat:
M
chrome/content/zotero/xpcom/debug.js
 | 
45
+++++++++++++++++++++++++++++++++++----------
M
chrome/content/zotero/xpcom/zotero.js
 | 
17
++++++++++++++---

2 files changed, 49 insertions(+), 13 deletions(-)
diff --git a/chrome/content/zotero/xpcom/debug.js b/chrome/content/zotero/xpcom/debug.js
@@ -41,7 +41,7 @@ Zotero.Debug = new function () {
 		this.enabled = _console || _store;
 	}
 	
-	this.log = function (message, level) {
+	this.log = function (message, level, stack) {
 		if (!_console && !_store) {
 			return;
 		}
@@ -92,15 +92,24 @@ Zotero.Debug = new function () {
 			deltaStr = '(+' + delta + ')';
 		}
 		
-		if (_stackTrace) {
-			var stack = (new Error()).stack;
-			var nl1Index = stack.indexOf("\n")
-			var nl2Index = stack.indexOf("\n", nl1Index+1);
-			var line2 = stack.substring(nl1Index+2, nl2Index-1);
-			var debugLine = line2.substr(line2.indexOf("@"));
-			
-			stack = stack.substring(nl2Index, stack.length-1);
-			message += "\n"+debugLine+stack;
+		if (stack === true) {
+			// Display stack starting from where this was called
+			stack = Components.stack.caller;
+		} else if (stack >= 0) {
+			let i = stack;
+			stack = Components.stack.caller;
+			while(stack && i--) {
+				stack = stack.caller;
+			}
+		} else if (_stackTrace) {
+			// Stack trace enabled globally
+			stack = Components.stack.caller;
+		} else {
+			stack = undefined;
+		}
+		
+		if (stack) {
+			message += '\n' + Zotero.Debug.stackToString(stack);
 		}
 		
 		if (_console) {
@@ -194,4 +203,20 @@ Zotero.Debug = new function () {
 	this.clear = function () {
 		_output = [];
 	}
+	
+	/**
+	 * Format a stack trace for output in the same way that Error.stack does
+	 * @param {Components.stack} stack
+	 * @param {Integer} [lines=5] Number of lines to format
+	 */
+	this.stackToString = function (stack, lines) {
+		if (!lines) lines = 5;
+		var str = '';
+		while(stack && lines--) {
+			str += '\n  ' + (stack.name || '') + '@' + stack.filename
+				+ ':' + stack.lineNumber;
+			stack = stack.caller;
+		}
+		return str.substr(1);
+	};
 }
diff --git a/chrome/content/zotero/xpcom/zotero.js b/chrome/content/zotero/xpcom/zotero.js
@@ -1217,10 +1217,21 @@ Components.utils.import("resource://gre/modules/osfile.jsm");
 	 *
 	 * Uses prefs e.z.debug.log and e.z.debug.level (restart required)
 	 *
-	 * Defaults to log level 3 if level not provided
+	 * @param {} message
+	 * @param {Integer} [level=3]
+	 * @param {Boolean|Integer} [stack] Whether to display the calling stack.
+	 *   If true, stack is displayed starting from the caller. If an integer,
+	 *   that many stack levels will be omitted starting from the caller.
 	 */
-	function debug(message, level) {
-		Zotero.Debug.log(message, level);
+	function debug(message, level, stack) {
+		// Account for this alias
+		if (stack === true) {
+			stack = 1;
+		} else if (stack >= 0) {
+			stack++;
+		}
+		
+		Zotero.Debug.log(message, level, stack);
 	}