@jdeighan/coffee-utils 7.0.56 → 7.0.59

package/Debugging.md

@@ -0,0 +1,6 @@
+Debugging CoffeeScript:
+
+1. install JetBrains IntellijIDE
+2. create file test/counting.coffee
+3. compile the file with the sourcemap option:
+      coffee -c -m test/counting.coffee

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "7.0.56",
+	"version": "7.0.59",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {

package/src/call_stack.coffee

@@ -36,10 +36,9 @@ export class CallStack
 
 	# ........................................................................
 
-	enter: (funcName, oldFlag=undef) ->
+	enter: (funcName) ->
 		# --- funcName might be <object>.<method>
 
-		assert (oldFlag == undef), "enter() takes only 1 arg"
 		if doDebugStack
 			LOG "[--> ENTER #{funcName}]"
 
@@ -54,13 +53,13 @@ export class CallStack
 		[_, ident1, ident2] = lMatches
 		if ident2
 			@lStack.push({
-				fullName: "#{ident1}.#{ident2}"
+				fullName: funcName     #    "#{ident1}.#{ident2}"
 				funcName: ident2
 				isLogged: false
 				})
 		else
 			@lStack.push({
-				fullName: ident1
+				fullName: funcName
 				funcName: ident1
 				isLogged: false
 				})
@@ -68,6 +67,12 @@ export class CallStack
 
 	# ........................................................................
 
+	getLevel: () ->
+
+		return @level
+
+	# ........................................................................
+
 	isLogging: () ->
 
 		if (@lStack.length == 0)
@@ -86,12 +91,17 @@ export class CallStack
 
 	# ........................................................................
 
-	logCurFunc: () ->
+	logCurFunc: (funcName) ->
 
 		# --- funcName must be  the current function
 		#     and the isLogged flag must currently be false
+
 		cur = @lStack[@lStack.length - 1]
 		assert (cur.isLogged == false), "isLogged is already true"
+		if (funcName != cur.fullName)
+			LOG "cur func #{cur.fullName} is not #{funcName}"
+			LOG @dump()
+			croak "BAD"
 		cur.isLogged = true
 		@level += 1
 		return
@@ -105,7 +115,7 @@ export class CallStack
 			LOG "[<-- BACK #{fName}]"
 
 		if @lStack.length == 0
-			LOG "ERROR: returnFrom('#{funcName}') but stack is empty"
+			LOG "ERROR: returnFrom('#{fName}') but stack is empty"
 			return
 
 		{fullName, isLogged} = @lStack.pop()
@@ -126,12 +136,6 @@ export class CallStack
 
 	# ........................................................................
 
-	getLevel: () ->
-
-		return @level
-
-	# ........................................................................
-
 	curFunc: () ->
 
 		if (@lStack.length == 0)
@@ -151,14 +155,28 @@ export class CallStack
 		return false
 
 	# ........................................................................
-	# ........................................................................
 
 	dump: (prefix='', label='CALL STACK') ->
 
-		LOG "#{label}:"
+		lLines = ["#{label}:"]
 		if @lStack.length == 0
-			LOG "   <EMPTY>"
+			lLines.push "   <EMPTY>"
 		else
 			for item, i in @lStack
-				LOG "   #{i}: #{item.fullName} #{item.isLogged}"
-		return
+				lLines.push "   #{i}: #{item.fullName} #{item.isLogged}"
+		return lLines.join("\n") + "\n"
+
+	# ........................................................................
+
+	sdump: (label='CALL STACK') ->
+
+		lFuncNames = []
+		for item in @lStack
+			if item.isLogged
+				lFuncNames.push '*' + item.fullName
+			else
+				lFuncNames.push item.fullName
+		if @lStack.length == 0
+			return "#{label} <EMPTY>"
+		else
+			return "#{label} #{lFuncNames.join(' ')}"

package/src/call_stack.js

@@ -45,10 +45,9 @@ export var CallStack = class CallStack {
   }
 
   // ........................................................................
-  enter(funcName, oldFlag = undef) {
+  enter(funcName) {
     var _, ident1, ident2, lMatches;
     // --- funcName might be <object>.<method>
-    assert(oldFlag === undef, "enter() takes only 1 arg");
     if (doDebugStack) {
       LOG(`[--> ENTER ${funcName}]`);
     }
@@ -57,19 +56,24 @@ export var CallStack = class CallStack {
     [_, ident1, ident2] = lMatches;
     if (ident2) {
       this.lStack.push({
-        fullName: `${ident1}.${ident2}`,
+        fullName: funcName, //    "#{ident1}.#{ident2}"
         funcName: ident2,
         isLogged: false
       });
     } else {
       this.lStack.push({
-        fullName: ident1,
+        fullName: funcName,
         funcName: ident1,
         isLogged: false
       });
     }
   }
 
+  // ........................................................................
+  getLevel() {
+    return this.level;
+  }
+
   // ........................................................................
   isLogging() {
     if (this.lStack.length === 0) {
@@ -89,12 +93,17 @@ export var CallStack = class CallStack {
   }
 
   // ........................................................................
-  logCurFunc() {
+  logCurFunc(funcName) {
     var cur;
     // --- funcName must be  the current function
     //     and the isLogged flag must currently be false
     cur = this.lStack[this.lStack.length - 1];
     assert(cur.isLogged === false, "isLogged is already true");
+    if (funcName !== cur.fullName) {
+      LOG(`cur func ${cur.fullName} is not ${funcName}`);
+      LOG(this.dump());
+      croak("BAD");
+    }
     cur.isLogged = true;
     this.level += 1;
   }
@@ -107,7 +116,7 @@ export var CallStack = class CallStack {
       LOG(`[<-- BACK ${fName}]`);
     }
     if (this.lStack.length === 0) {
-      LOG(`ERROR: returnFrom('${funcName}') but stack is empty`);
+      LOG(`ERROR: returnFrom('${fName}') but stack is empty`);
       return;
     }
     ({fullName, isLogged} = this.lStack.pop());
@@ -128,11 +137,6 @@ export var CallStack = class CallStack {
     }
   }
 
-  // ........................................................................
-  getLevel() {
-    return this.level;
-  }
-
   // ........................................................................
   curFunc() {
     if (this.lStack.length === 0) {
@@ -157,20 +161,40 @@ export var CallStack = class CallStack {
     return false;
   }
 
-  // ........................................................................
   // ........................................................................
   dump(prefix = '', label = 'CALL STACK') {
-    var i, item, j, len, ref;
-    LOG(`${label}:`);
+    var i, item, j, lLines, len, ref;
+    lLines = [`${label}:`];
     if (this.lStack.length === 0) {
-      LOG("   <EMPTY>");
+      lLines.push("   <EMPTY>");
     } else {
       ref = this.lStack;
       for (i = j = 0, len = ref.length; j < len; i = ++j) {
         item = ref[i];
-        LOG(`   ${i}: ${item.fullName} ${item.isLogged}`);
+        lLines.push(`   ${i}: ${item.fullName} ${item.isLogged}`);
       }
     }
+    return lLines.join("\n") + "\n";
+  }
+
+  // ........................................................................
+  sdump(label = 'CALL STACK') {
+    var item, j, lFuncNames, len, ref;
+    lFuncNames = [];
+    ref = this.lStack;
+    for (j = 0, len = ref.length; j < len; j++) {
+      item = ref[j];
+      if (item.isLogged) {
+        lFuncNames.push('*' + item.fullName);
+      } else {
+        lFuncNames.push(item.fullName);
+      }
+    }
+    if (this.lStack.length === 0) {
+      return `${label} <EMPTY>`;
+    } else {
+      return `${label} ${lFuncNames.join(' ')}`;
+    }
   }
 
 };

package/src/debug_utils.coffee

@@ -16,11 +16,83 @@ import {
 	log, logItem, LOG, shortEnough, dashes,
 	} from '@jdeighan/coffee-utils/log'
 
-callStack = new CallStack()
+# --- set in resetDebugging() and setDebugging()
+export callStack = new CallStack()
+export shouldLog = () -> undef
+
+lFuncList = []
+strFuncList = undef     # original string
+
+# --- internal debugging
 doDebugDebug = false
+lFunctions = undef     # --- only used when doDebugDebug is true
+
+# ---------------------------------------------------------------------------
+
+export dumpCallStack = (label) ->
+
+	LOG callStack.dump('', label)
+	return
+
+# ---------------------------------------------------------------------------
+
+export setDebugDebugging = (value=true) ->
+	# --- value can be a boolean or string of words
+
+	if isBoolean(value)
+		doDebugDebug = value
+	else if isString(value)
+		doDebugDebug = true
+		lFunctions = words(value)
+	else
+		croak "Bad value: #{OL(value)}"
+	return
+
+# ---------------------------------------------------------------------------
+
+debugDebug = (label, lObjects...) ->
+	# --- For debugging functions in this module
+
+	if ! doDebugDebug
+		return
+
+	# --- At this point, doDebugDebug is true
+	doDebugDebug = false   # temp - reset before returning
+
+	assert isString(label), "1st arg #{OL(label)} should be a string"
+	nObjects = lObjects.length
+	[type, funcName] = getType(label, nObjects)
+
+	switch type
+		when 'enter'
+			assert defined(funcName), "type enter, funcName = undef"
+			callStack.enter funcName
+			doLog = (lFunctions == undef) || (funcName in lFunctions)
+
+		when 'return'
+			assert defined(funcName), "type return, funcName = undef"
+			doLog = (lFunctions == undef) || (funcName in lFunctions)
+
+		when 'string'
+			assert (funcName == undef), "type string, funcName defined"
+			assert (nObjects == 0), "Objects not allowed for #{OL(type)}"
+			doLog = true
 
-export shouldLog = undef  # set in resetDebugging() and setDebugging()
-export lFuncList = []
+		when 'objects'
+			assert (funcName == undef), "type objects, funcName defined"
+			assert (nObjects > 0), "Objects required for #{OL(type)}"
+			dolog = true
+
+	if doLog
+		doTheLogging type, label, lObjects
+
+	if (type == 'enter') && doLog
+		callStack.logCurFunc(funcName)
+	else if (type == 'return')
+		callStack.returnFrom funcName
+
+	doDebugDebug = true
+	return
 
 # ---------------------------------------------------------------------------
 
@@ -28,87 +100,98 @@ export debug = (label, lObjects...) ->
 
 	assert isString(label), "1st arg #{OL(label)} should be a string"
 
-	# --- We want to allow objects to be undef. Therefore, we need to
-	#     distinguish between 1 arg sent vs. 2 or more args sent
+	# --- If label is "enter <funcname>, we need to put that on the stack
+	#     BEFORE we do any internal logging
 	nObjects = lObjects.length
-
-	# --- funcName is only set for types 'enter' and 'return'
 	[type, funcName] = getType(label, nObjects)
-	if doDebugDebug
-		LOG "debug(): type = #{OL(type)}"
-		LOG "debug(): funcName = #{OL(funcName)}"
+	if (type == 'enter')
+		callStack.enter funcName
+
+	debugDebug "enter debug(#{OL(label)})", lObjects...
+	debugDebug "type = #{OL(type)}"
+	debugDebug "funcName = #{OL(funcName)}"
 
 	# --- function shouldLog() returns the (possibly modified) label
 	#     if we should log this, else it returns undef
 
 	switch type
 		when 'enter'
-			callStack.enter funcName
 			label = shouldLog(label, type, funcName, callStack)
 		when 'return'
 			label = shouldLog(label, type, funcName, callStack)
 		when 'string'
 			label = shouldLog(label, type, undef, callStack)
 			assert (nObjects == 0),
-					"multiple objects only not allowed for #{OL(type)}"
+					"Objects not allowed for #{OL(type)}"
 		when 'objects'
 			label = shouldLog(label, type, undef, callStack)
 			assert (nObjects > 0),
-					"multiple objects only not allowed for #{OL(type)}"
-	doLog = defined(label)
+					"Objects required for #{OL(type)}"
 
-	if doDebugDebug
-		if nObjects == 0
-			LOG "debug(#{OL(label)}) - 1 arg"
-		else
-			LOG "debug(#{OL(label)}), #{nObjects} args"
-		LOG "doLog = #{OL(doLog)}"
+	assert (label == undef) || isString(label),
+			"label not a string: #{OL(label)}"
+	doLog = defined(label)
+	debugDebug "doLog = #{OL(doLog)}"
+	debugDebug "#{nObjects} objects"
 
 	if doLog
-		level = callStack.getLevel()
-		prefix = getPrefix(level)
-		itemPrefix = removeLastVbar(prefix)
-
-		if doDebugDebug
-			LOG "callStack", callStack
-			LOG "level = #{OL(level)}"
-			LOG "prefix = #{OL(prefix)}"
-			LOG "itemPrefix = #{OL(itemPrefix)}"
-
-		switch type
-			when 'enter'
-				log label, {prefix}
-				for obj,i in lObjects
-					if (i > 0)
-						log dashes(itemPrefix, 40)
-					logItem undef, obj, {itemPrefix}
-			when 'return'
-				log label, {prefix: addArrow(prefix)}
-				for obj,i in lObjects
-					if (i > 0)
-						log dashes(itemPrefix, 40)
-					logItem undef, obj, {itemPrefix}
-			when 'string'
-				log label, {prefix}
-			when 'objects'
-				if (nObjects==1) && shortEnough(label, lObjects[0])
-					logItem label, lObjects[0], {prefix}
-				else
-					if (label.indexOf(':') != label.length - 1)
-						label += ':'
-					log label, {prefix}
-					for obj in lObjects
-						logItem undef, obj, {prefix}
+		doTheLogging type, label, lObjects
 
 	if (type == 'enter') && doLog && (label.indexOf('call') == -1)
-		callStack.logCurFunc()
-	else if (type == 'return')
+		callStack.logCurFunc(funcName)
+
+	# --- This must be called BEFORE we return from funcName
+	debugDebug "return from debug()"
+
+	if (type == 'return')
 		callStack.returnFrom funcName
 
 	return true   # allow use in boolean expressions
 
 # ---------------------------------------------------------------------------
 
+export doTheLogging = (type, label, lObjects) ->
+
+	level = callStack.getLevel()
+	prefix = getPrefix(level)
+	itemPrefix = removeLastVbar(prefix)
+	sep = dashes(itemPrefix, 40)
+	assert isString(sep), "sep is not a string"
+
+	debugDebug "callStack", callStack
+	debugDebug "level = #{OL(level)}"
+	debugDebug "prefix = #{OL(prefix)}"
+	debugDebug "itemPrefix = #{OL(itemPrefix)}"
+	debugDebug "sep = #{OL(sep)}"
+
+	switch type
+		when 'enter'
+			log label, {prefix}
+			for obj,i in lObjects
+				if (i > 0)
+					log sep
+				logItem undef, obj, {itemPrefix}
+		when 'return'
+			log label, {prefix: addArrow(prefix)}
+			for obj,i in lObjects
+				if (i > 0)
+					log sep
+				logItem undef, obj, {itemPrefix}
+		when 'string'
+			log label, {prefix}
+		when 'objects'
+			if (lObjects.length==1) && shortEnough(label, lObjects[0])
+				logItem label, lObjects[0], {prefix}
+			else
+				if (label.indexOf(':') != label.length - 1)
+					label += ':'
+				log label, {prefix}
+				for obj in lObjects
+					logItem undef, obj, {prefix}
+	return
+
+# ---------------------------------------------------------------------------
+
 export stdShouldLog = (label, type, funcName, stack) ->
 	# --- if type is 'enter', then funcName won't be on the stack yet
 	#     returns the (possibly modified) label to log
@@ -125,14 +208,12 @@ export stdShouldLog = (label, type, funcName, stack) ->
 		assert funcName == undef, "func name #{OL(funcName)} not undef"
 	assert stack instanceof CallStack, "not a call stack object"
 
-	if doDebugDebug
-		LOG "stdShouldLog(#{OL(label)}, #{OL(type)}, #{OL(funcName)}, stack)"
-		LOG "stack", stack
-		LOG "lFuncList", lFuncList
+	debugDebug "enter stdShouldLog(#{OL(label)}, #{OL(type)}, #{OL(funcName)}, stack)"
 
 	switch type
 		when 'enter'
-			if funcMatch(stack, lFuncList)
+			if funcMatch()
+				debugDebug "return #{OL(label)} from stdShouldLog() - funcMatch"
 				return label
 
 			else
@@ -142,53 +223,31 @@ export stdShouldLog = (label, type, funcName, stack) ->
 
 				prevLogged = stack.isLoggingPrev()
 				if prevLogged
-					return label.replace('enter', 'call')
+					result = label.replace('enter', 'call')
+					debugDebug "return #{OL(result)} from stdShouldLog() - s/enter/call/"
+					return result
 		else
-			if funcMatch(stack, lFuncList)
+			if funcMatch()
+				debugDebug "return #{OL(label)} from stdShouldLog()"
 				return label
+	debugDebug "return undef from stdShouldLog()"
 	return undef
 
 # ---------------------------------------------------------------------------
 
-export debugDebug = (flag=true) ->
-
-	doDebugDebug = flag
-	if doDebugDebug
-		LOG "doDebugDebug = #{flag}"
-	return
-
-# ---------------------------------------------------------------------------
-
-resetDebugging = () ->
-
-	if doDebugDebug
-		LOG "resetDebugging()"
-	callStack.reset()
-	shouldLog = (label, type, funcName, stack) -> undef
-	return
-
-# ---------------------------------------------------------------------------
-
 export setDebugging = (option) ->
 
-	resetDebugging()
+	callStack.reset()
 	if isBoolean(option)
 		if option
 			shouldLog = (label, type, funcName, stack) -> label
 		else
 			shouldLog = (label, type, funcName, stack) -> undef
-		if doDebugDebug
-			LOG "setDebugging = #{option}"
 	else if isString(option)
 		lFuncList = getFuncList(option)
 		shouldLog = stdShouldLog
-		if doDebugDebug
-			LOG "setDebugging FUNCS: #{option}"
-			LOG 'lFuncList', lFuncList
 	else if isFunction(option)
 		shouldLog = option
-		if doDebugDebug
-			LOG "setDebugging to custom func"
 	else
 		croak "bad parameter #{OL(option)}"
 	return
@@ -198,6 +257,7 @@ export setDebugging = (option) ->
 
 export getFuncList = (str) ->
 
+	strFuncList = str     # store original string for debugging
 	lFuncList = []
 	for word in words(str)
 		if lMatches = word.match(///^
@@ -227,27 +287,23 @@ export getFuncList = (str) ->
 # ---------------------------------------------------------------------------
 # --- export only to allow unit tests
 
-export funcMatch = (stack, lFuncList) ->
+export funcMatch = () ->
 
 	assert isArray(lFuncList), "not an array #{OL(lFuncList)}"
 
-	curFunc = stack.curFunc()
-	if doDebugDebug
-		LOG "funcMatch(): curFunc = #{OL(curFunc)}"
-		stack.dump('   ')
-		LOG 'lFuncList', lFuncList
+	debugDebug "enter funcMatch()"
+	curFunc = callStack.curFunc()
+	debugDebug "curFunc = #{OL(curFunc)}"
+	debugDebug "lFuncList = #{strFuncList}"
 	for h in lFuncList
 		{name, object, plus} = h
 		if (name == curFunc)
-			if doDebugDebug
-				LOG "   curFunc in lFuncList - match successful"
+			debugDebug "return from funcMatch() - curFunc in lFuncList"
 			return true
-		if plus && stack.isActive(name)
-			if doDebugDebug
-				LOG "   func #{OL(name)} is active - match successful"
+		if plus && callStack.isActive(name)
+			debugDebug "return from funcMatch() - func #{OL(name)} is active"
 			return true
-	if doDebugDebug
-		LOG "   - no match"
+	debugDebug "return from funcMatch() - no match"
 	return false
 
 # ---------------------------------------------------------------------------
@@ -290,40 +346,3 @@ reMethod = ///^
 
 # ---------------------------------------------------------------------------
 
-export checkTrace = (block) ->
-	# --- export only to allow unit tests
-
-	lStack = []
-
-	for line in blockToArray(block)
-		if lMatches = line.match(///
-				enter
-				\s+
-				([A-Za-z_][A-Za-z0-9_\.]*)
-				///)
-			funcName = lMatches[1]
-			lStack.push funcName
-		else if lMatches = line.match(///
-				return
-				.*
-				from
-				\s+
-				([A-Za-z_][A-Za-z0-9_\.]*)
-				///)
-			funcName = lMatches[1]
-			len = lStack.length
-			if (len == 0)
-				log "return from #{funcName} with empty stack"
-			else if (lStack[len-1] == funcName)
-				lStack.pop()
-			else if (lStack[len-2] == funcName)
-				log "missing return from #{lStack[len-2]}"
-				lStack.pop()
-				lStack.pop()
-			else
-				log "return from #{funcName} - not found on stack"
-	return
-
-# ---------------------------------------------------------------------------
-
-resetDebugging()

package/src/debug_utils.js

@@ -1,6 +1,7 @@
 // Generated by CoffeeScript 2.7.0
-// debug_utils.coffee
-var callStack, doDebugDebug, reMethod, resetDebugging;
+  // debug_utils.coffee
+var debugDebug, doDebugDebug, lFuncList, lFunctions, reMethod, strFuncList,
+  indexOf = [].indexOf;
 
 import {
   assert,
@@ -50,32 +51,102 @@ import {
   dashes
 } from '@jdeighan/coffee-utils/log';
 
-callStack = new CallStack();
+// --- set in resetDebugging() and setDebugging()
+export var callStack = new CallStack();
 
+export var shouldLog = function() {
+  return undef;
+};
+
+lFuncList = [];
+
+strFuncList = undef; // original string
+
+
+// --- internal debugging
 doDebugDebug = false;
 
-export var shouldLog = undef; // set in resetDebugging() and setDebugging()
+lFunctions = undef; // --- only used when doDebugDebug is true
+
+
+// ---------------------------------------------------------------------------
+export var dumpCallStack = function(label) {
+  LOG(callStack.dump('', label));
+};
+
+// ---------------------------------------------------------------------------
+export var setDebugDebugging = function(value = true) {
+  // --- value can be a boolean or string of words
+  if (isBoolean(value)) {
+    doDebugDebug = value;
+  } else if (isString(value)) {
+    doDebugDebug = true;
+    lFunctions = words(value);
+  } else {
+    croak(`Bad value: ${OL(value)}`);
+  }
+};
 
-export var lFuncList = [];
+// ---------------------------------------------------------------------------
+debugDebug = function(label, ...lObjects) {
+  var doLog, dolog, funcName, nObjects, type;
+  if (!doDebugDebug) {
+    return;
+  }
+  // --- At this point, doDebugDebug is true
+  doDebugDebug = false; // temp - reset before returning
+  assert(isString(label), `1st arg ${OL(label)} should be a string`);
+  nObjects = lObjects.length;
+  [type, funcName] = getType(label, nObjects);
+  switch (type) {
+    case 'enter':
+      assert(defined(funcName), "type enter, funcName = undef");
+      callStack.enter(funcName);
+      doLog = (lFunctions === undef) || (indexOf.call(lFunctions, funcName) >= 0);
+      break;
+    case 'return':
+      assert(defined(funcName), "type return, funcName = undef");
+      doLog = (lFunctions === undef) || (indexOf.call(lFunctions, funcName) >= 0);
+      break;
+    case 'string':
+      assert(funcName === undef, "type string, funcName defined");
+      assert(nObjects === 0, `Objects not allowed for ${OL(type)}`);
+      doLog = true;
+      break;
+    case 'objects':
+      assert(funcName === undef, "type objects, funcName defined");
+      assert(nObjects > 0, `Objects required for ${OL(type)}`);
+      dolog = true;
+  }
+  if (doLog) {
+    doTheLogging(type, label, lObjects);
+  }
+  if ((type === 'enter') && doLog) {
+    callStack.logCurFunc(funcName);
+  } else if (type === 'return') {
+    callStack.returnFrom(funcName);
+  }
+  doDebugDebug = true;
+};
 
 // ---------------------------------------------------------------------------
 export var debug = function(label, ...lObjects) {
-  var doLog, funcName, i, itemPrefix, j, k, l, len1, len2, len3, level, nObjects, obj, prefix, type;
+  var doLog, funcName, nObjects, type;
   assert(isString(label), `1st arg ${OL(label)} should be a string`);
-  // --- We want to allow objects to be undef. Therefore, we need to
-  //     distinguish between 1 arg sent vs. 2 or more args sent
+  // --- If label is "enter <funcname>, we need to put that on the stack
+  //     BEFORE we do any internal logging
   nObjects = lObjects.length;
-  // --- funcName is only set for types 'enter' and 'return'
   [type, funcName] = getType(label, nObjects);
-  if (doDebugDebug) {
-    LOG(`debug(): type = ${OL(type)}`);
-    LOG(`debug(): funcName = ${OL(funcName)}`);
+  if (type === 'enter') {
+    callStack.enter(funcName);
   }
+  debugDebug(`enter debug(${OL(label)})`, ...lObjects);
+  debugDebug(`type = ${OL(type)}`);
+  debugDebug(`funcName = ${OL(funcName)}`);
   // --- function shouldLog() returns the (possibly modified) label
   //     if we should log this, else it returns undef
   switch (type) {
     case 'enter':
-      callStack.enter(funcName);
       label = shouldLog(label, type, funcName, callStack);
       break;
     case 'return':
@@ -83,84 +154,89 @@ export var debug = function(label, ...lObjects) {
       break;
     case 'string':
       label = shouldLog(label, type, undef, callStack);
-      assert(nObjects === 0, `multiple objects only not allowed for ${OL(type)}`);
+      assert(nObjects === 0, `Objects not allowed for ${OL(type)}`);
       break;
     case 'objects':
       label = shouldLog(label, type, undef, callStack);
-      assert(nObjects > 0, `multiple objects only not allowed for ${OL(type)}`);
+      assert(nObjects > 0, `Objects required for ${OL(type)}`);
   }
+  assert((label === undef) || isString(label), `label not a string: ${OL(label)}`);
   doLog = defined(label);
-  if (doDebugDebug) {
-    if (nObjects === 0) {
-      LOG(`debug(${OL(label)}) - 1 arg`);
-    } else {
-      LOG(`debug(${OL(label)}), ${nObjects} args`);
-    }
-    LOG(`doLog = ${OL(doLog)}`);
-  }
+  debugDebug(`doLog = ${OL(doLog)}`);
+  debugDebug(`${nObjects} objects`);
   if (doLog) {
-    level = callStack.getLevel();
-    prefix = getPrefix(level);
-    itemPrefix = removeLastVbar(prefix);
-    if (doDebugDebug) {
-      LOG("callStack", callStack);
-      LOG(`level = ${OL(level)}`);
-      LOG(`prefix = ${OL(prefix)}`);
-      LOG(`itemPrefix = ${OL(itemPrefix)}`);
-    }
-    switch (type) {
-      case 'enter':
-        log(label, {prefix});
-        for (i = j = 0, len1 = lObjects.length; j < len1; i = ++j) {
-          obj = lObjects[i];
-          if (i > 0) {
-            log(dashes(itemPrefix, 40));
-          }
-          logItem(undef, obj, {itemPrefix});
-        }
-        break;
-      case 'return':
-        log(label, {
-          prefix: addArrow(prefix)
-        });
-        for (i = k = 0, len2 = lObjects.length; k < len2; i = ++k) {
-          obj = lObjects[i];
-          if (i > 0) {
-            log(dashes(itemPrefix, 40));
-          }
-          logItem(undef, obj, {itemPrefix});
-        }
-        break;
-      case 'string':
-        log(label, {prefix});
-        break;
-      case 'objects':
-        if ((nObjects === 1) && shortEnough(label, lObjects[0])) {
-          logItem(label, lObjects[0], {prefix});
-        } else {
-          if (label.indexOf(':') !== label.length - 1) {
-            label += ':';
-          }
-          log(label, {prefix});
-          for (l = 0, len3 = lObjects.length; l < len3; l++) {
-            obj = lObjects[l];
-            logItem(undef, obj, {prefix});
-          }
-        }
-    }
+    doTheLogging(type, label, lObjects);
   }
   if ((type === 'enter') && doLog && (label.indexOf('call') === -1)) {
-    callStack.logCurFunc();
-  } else if (type === 'return') {
+    callStack.logCurFunc(funcName);
+  }
+  // --- This must be called BEFORE we return from funcName
+  debugDebug("return from debug()");
+  if (type === 'return') {
     callStack.returnFrom(funcName);
   }
   return true; // allow use in boolean expressions
 };
 
 
+// ---------------------------------------------------------------------------
+export var doTheLogging = function(type, label, lObjects) {
+  var i, itemPrefix, j, k, l, len, len1, len2, level, obj, prefix, sep;
+  level = callStack.getLevel();
+  prefix = getPrefix(level);
+  itemPrefix = removeLastVbar(prefix);
+  sep = dashes(itemPrefix, 40);
+  assert(isString(sep), "sep is not a string");
+  debugDebug("callStack", callStack);
+  debugDebug(`level = ${OL(level)}`);
+  debugDebug(`prefix = ${OL(prefix)}`);
+  debugDebug(`itemPrefix = ${OL(itemPrefix)}`);
+  debugDebug(`sep = ${OL(sep)}`);
+  switch (type) {
+    case 'enter':
+      log(label, {prefix});
+      for (i = j = 0, len = lObjects.length; j < len; i = ++j) {
+        obj = lObjects[i];
+        if (i > 0) {
+          log(sep);
+        }
+        logItem(undef, obj, {itemPrefix});
+      }
+      break;
+    case 'return':
+      log(label, {
+        prefix: addArrow(prefix)
+      });
+      for (i = k = 0, len1 = lObjects.length; k < len1; i = ++k) {
+        obj = lObjects[i];
+        if (i > 0) {
+          log(sep);
+        }
+        logItem(undef, obj, {itemPrefix});
+      }
+      break;
+    case 'string':
+      log(label, {prefix});
+      break;
+    case 'objects':
+      if ((lObjects.length === 1) && shortEnough(label, lObjects[0])) {
+        logItem(label, lObjects[0], {prefix});
+      } else {
+        if (label.indexOf(':') !== label.length - 1) {
+          label += ':';
+        }
+        log(label, {prefix});
+        for (l = 0, len2 = lObjects.length; l < len2; l++) {
+          obj = lObjects[l];
+          logItem(undef, obj, {prefix});
+        }
+      }
+  }
+};
+
 // ---------------------------------------------------------------------------
 export var stdShouldLog = function(label, type, funcName, stack) {
-  var prevLogged;
+  var prevLogged, result;
   // --- if type is 'enter', then funcName won't be on the stack yet
   //     returns the (possibly modified) label to log
 
@@ -175,14 +251,11 @@ export var stdShouldLog = function(label, type, funcName, stack) {
     assert(funcName === undef, `func name ${OL(funcName)} not undef`);
   }
   assert(stack instanceof CallStack, "not a call stack object");
-  if (doDebugDebug) {
-    LOG(`stdShouldLog(${OL(label)}, ${OL(type)}, ${OL(funcName)}, stack)`);
-    LOG("stack", stack);
-    LOG("lFuncList", lFuncList);
-  }
+  debugDebug(`enter stdShouldLog(${OL(label)}, ${OL(type)}, ${OL(funcName)}, stack)`);
   switch (type) {
     case 'enter':
-      if (funcMatch(stack, lFuncList)) {
+      if (funcMatch()) {
+        debugDebug(`return ${OL(label)} from stdShouldLog() - funcMatch`);
         return label;
       } else {
         // --- As a special case, if we enter a function where we will not
@@ -190,40 +263,25 @@ export var stdShouldLog = function(label, type, funcName, stack) {
         //     we'll log out the call itself
         prevLogged = stack.isLoggingPrev();
         if (prevLogged) {
-          return label.replace('enter', 'call');
+          result = label.replace('enter', 'call');
+          debugDebug(`return ${OL(result)} from stdShouldLog() - s/enter/call/`);
+          return result;
         }
       }
       break;
     default:
-      if (funcMatch(stack, lFuncList)) {
+      if (funcMatch()) {
+        debugDebug(`return ${OL(label)} from stdShouldLog()`);
         return label;
       }
   }
+  debugDebug("return undef from stdShouldLog()");
   return undef;
 };
 
-// ---------------------------------------------------------------------------
-export var debugDebug = function(flag = true) {
-  doDebugDebug = flag;
-  if (doDebugDebug) {
-    LOG(`doDebugDebug = ${flag}`);
-  }
-};
-
-// ---------------------------------------------------------------------------
-resetDebugging = function() {
-  if (doDebugDebug) {
-    LOG("resetDebugging()");
-  }
-  callStack.reset();
-  shouldLog = function(label, type, funcName, stack) {
-    return undef;
-  };
-};
-
 // ---------------------------------------------------------------------------
 export var setDebugging = function(option) {
-  resetDebugging();
+  callStack.reset();
   if (isBoolean(option)) {
     if (option) {
       shouldLog = function(label, type, funcName, stack) {
@@ -234,21 +292,11 @@ export var setDebugging = function(option) {
         return undef;
       };
     }
-    if (doDebugDebug) {
-      LOG(`setDebugging = ${option}`);
-    }
   } else if (isString(option)) {
     lFuncList = getFuncList(option);
     shouldLog = stdShouldLog;
-    if (doDebugDebug) {
-      LOG(`setDebugging FUNCS: ${option}`);
-      LOG('lFuncList', lFuncList);
-    }
   } else if (isFunction(option)) {
     shouldLog = option;
-    if (doDebugDebug) {
-      LOG("setDebugging to custom func");
-    }
   } else {
     croak(`bad parameter ${OL(option)}`);
   }
@@ -257,10 +305,11 @@ export var setDebugging = function(option) {
 // ---------------------------------------------------------------------------
 // --- export only to allow unit tests
 export var getFuncList = function(str) {
-  var _, ident1, ident2, j, lMatches, len1, plus, ref, word;
+  var _, ident1, ident2, j, lMatches, len, plus, ref, word;
+  strFuncList = str; // store original string for debugging
   lFuncList = [];
   ref = words(str);
-  for (j = 0, len1 = ref.length; j < len1; j++) {
+  for (j = 0, len = ref.length; j < len; j++) {
     word = ref[j];
     if (lMatches = word.match(/^([A-Za-z_][A-Za-z0-9_]*)(?:\.([A-Za-z_][A-Za-z0-9_]*))?(\+)?$/)) {
       [_, ident1, ident2, plus] = lMatches;
@@ -285,34 +334,26 @@ export var getFuncList = function(str) {
 
 // ---------------------------------------------------------------------------
 // --- export only to allow unit tests
-export var funcMatch = function(stack, lFuncList) {
-  var curFunc, h, j, len1, name, object, plus;
+export var funcMatch = function() {
+  var curFunc, h, j, len, name, object, plus;
   assert(isArray(lFuncList), `not an array ${OL(lFuncList)}`);
-  curFunc = stack.curFunc();
-  if (doDebugDebug) {
-    LOG(`funcMatch(): curFunc = ${OL(curFunc)}`);
-    stack.dump('   ');
-    LOG('lFuncList', lFuncList);
-  }
-  for (j = 0, len1 = lFuncList.length; j < len1; j++) {
+  debugDebug("enter funcMatch()");
+  curFunc = callStack.curFunc();
+  debugDebug(`curFunc = ${OL(curFunc)}`);
+  debugDebug(`lFuncList = ${strFuncList}`);
+  for (j = 0, len = lFuncList.length; j < len; j++) {
     h = lFuncList[j];
     ({name, object, plus} = h);
     if (name === curFunc) {
-      if (doDebugDebug) {
-        LOG("   curFunc in lFuncList - match successful");
-      }
+      debugDebug("return from funcMatch() - curFunc in lFuncList");
       return true;
     }
-    if (plus && stack.isActive(name)) {
-      if (doDebugDebug) {
-        LOG(`   func ${OL(name)} is active - match successful`);
-      }
+    if (plus && callStack.isActive(name)) {
+      debugDebug(`return from funcMatch() - func ${OL(name)} is active`);
       return true;
     }
   }
-  if (doDebugDebug) {
-    LOG("   - no match");
-  }
+  debugDebug("return from funcMatch() - no match");
   return false;
 };
 
@@ -336,33 +377,3 @@ export var getType = function(str, nObjects) {
 reMethod = /^([A-Za-z_][A-Za-z0-9_]*)\.([A-Za-z_][A-Za-z0-9_]*)$/;
 
 // ---------------------------------------------------------------------------
-export var checkTrace = function(block) {
-  var funcName, j, lMatches, lStack, len, len1, line, ref;
-  // --- export only to allow unit tests
-  lStack = [];
-  ref = blockToArray(block);
-  for (j = 0, len1 = ref.length; j < len1; j++) {
-    line = ref[j];
-    if (lMatches = line.match(/enter\s+([A-Za-z_][A-Za-z0-9_\.]*)/)) {
-      funcName = lMatches[1];
-      lStack.push(funcName);
-    } else if (lMatches = line.match(/return.*from\s+([A-Za-z_][A-Za-z0-9_\.]*)/)) {
-      funcName = lMatches[1];
-      len = lStack.length;
-      if (len === 0) {
-        log(`return from ${funcName} with empty stack`);
-      } else if (lStack[len - 1] === funcName) {
-        lStack.pop();
-      } else if (lStack[len - 2] === funcName) {
-        log(`missing return from ${lStack[len - 2]}`);
-        lStack.pop();
-        lStack.pop();
-      } else {
-        log(`return from ${funcName} - not found on stack`);
-      }
-    }
-  }
-};
-
-// ---------------------------------------------------------------------------
-resetDebugging();

package/src/log_utils.coffee

@@ -135,9 +135,9 @@ export log = (str, hOptions={}) ->
 	# --- valid options:
 	#   prefix
 
+	assert isString(str),      "log(): not a string: #{OL(str)}"
 	assert isFunction(putstr), "putstr not properly set"
-	assert isString(str),      "log(): not a string"
-	assert isHash(hOptions),   "log(): arg 2 not a hash"
+	assert isHash(hOptions),   "log(): arg 2 not a hash: #{OL(hOptions)}"
 	prefix = fixForTerminal(hOptions.prefix)
 
 	if doDebugLog

package/src/log_utils.js

@@ -158,9 +158,9 @@ export var log = function(str, hOptions = {}) {
   var prefix;
   // --- valid options:
   //   prefix
+  assert(isString(str), `log(): not a string: ${OL(str)}`);
   assert(isFunction(putstr), "putstr not properly set");
-  assert(isString(str), "log(): not a string");
-  assert(isHash(hOptions), "log(): arg 2 not a hash");
+  assert(isHash(hOptions), `log(): arg 2 not a hash: ${OL(hOptions)}`);
   prefix = fixForTerminal(hOptions.prefix);
   if (doDebugLog) {
     LOG(`CALL log(${OL(str)}), prefix = ${OL(prefix)}`);