@jdeighan/coffee-utils 7.0.58 → 7.0.61

package/package.json

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

package/src/arrow.coffee

@@ -1,6 +1,6 @@
 # arrow.coffee
 
-import {undef, OL, setCharsAt} from '@jdeighan/coffee-utils'
+import {undef, assert, OL, setCharsAt} from '@jdeighan/coffee-utils'
 
 # --- We use spaces here because Windows Terminal handles TAB chars badly
 
@@ -16,50 +16,41 @@ export clearIndent = space + space + space + space
 
 # ---------------------------------------------------------------------------
 
-export getPrefix = (level, option='none') ->
+export prefix = (level, option='none') ->
 
-	if level==0
-		if (option == 'object')
-			return clearIndent
-		else
-			return ''
 	switch option
 		when 'withArrow'
-			result = oneIndent.repeat(level-1) + arrow
-		when 'object'
-			result = oneIndent.repeat(level) + clearIndent
-		when 'none'
-			result = oneIndent.repeat(level)
+			if (level == 0)
+				return arrow
+			else
+				return oneIndent.repeat(level-1) + arrow
+		when 'noLastVbar'
+			assert (level >= 1), "prefix(), noLastVbar but level=#{OL(level)}"
+			return oneIndent.repeat(level-1) + clearIndent
+		when 'noLast2Vbars'
+			assert (level >= 2), "prefix(), noLast2Vbars but level=#{OL(level)}"
+			return oneIndent.repeat(level-2) + clearIndent + clearIndent
 		else
-			throw new Error("getPrefix(): Bad option: '#{option}'")
-	if result.length % 4 != 0
-		throw new Error("getPrefix(): Bad prefix '#{result}'")
-	return result
+			return oneIndent.repeat(level)
 
 # ---------------------------------------------------------------------------
 
 export addArrow = (prefix) ->
 
-#	console.log "in addArrow(#{OL(prefix)})"
 	pos = prefix.lastIndexOf(vbar)
-#	console.log "pos = #{pos}"
 	if (pos == -1)
 		result = prefix
 	else
 		result = setCharsAt(prefix, pos, arrow)
-#	console.log "result = #{OL(result)}"
 	return result
 
 # ---------------------------------------------------------------------------
 
 export removeLastVbar = (prefix) ->
 
-#	console.log "in removeLastVbar(#{OL(prefix)})"
 	pos = prefix.lastIndexOf(vbar)
-#	console.log "pos = #{pos}"
 	if (pos == -1)
 		result = prefix
 	else
 		result = setCharsAt(prefix, pos, ' ')
-#	console.log "result = #{OL(result)}"
 	return result

package/src/arrow.js

@@ -2,6 +2,7 @@
   // arrow.coffee
 import {
   undef,
+  assert,
   OL,
   setCharsAt
 } from '@jdeighan/coffee-utils';
@@ -24,60 +25,46 @@ export var arrow = corner + hbar + arrowhead + space;
 export var clearIndent = space + space + space + space;
 
 // ---------------------------------------------------------------------------
-export var getPrefix = function(level, option = 'none') {
-  var result;
-  if (level === 0) {
-    if (option === 'object') {
-      return clearIndent;
-    } else {
-      return '';
-    }
-  }
+export var prefix = function(level, option = 'none') {
   switch (option) {
     case 'withArrow':
-      result = oneIndent.repeat(level - 1) + arrow;
-      break;
-    case 'object':
-      result = oneIndent.repeat(level) + clearIndent;
-      break;
-    case 'none':
-      result = oneIndent.repeat(level);
+      if (level === 0) {
+        return arrow;
+      } else {
+        return oneIndent.repeat(level - 1) + arrow;
+      }
       break;
+    case 'noLastVbar':
+      assert(level >= 1, `prefix(), noLastVbar but level=${OL(level)}`);
+      return oneIndent.repeat(level - 1) + clearIndent;
+    case 'noLast2Vbars':
+      assert(level >= 2, `prefix(), noLast2Vbars but level=${OL(level)}`);
+      return oneIndent.repeat(level - 2) + clearIndent + clearIndent;
     default:
-      throw new Error(`getPrefix(): Bad option: '${option}'`);
+      return oneIndent.repeat(level);
   }
-  if (result.length % 4 !== 0) {
-    throw new Error(`getPrefix(): Bad prefix '${result}'`);
-  }
-  return result;
 };
 
 // ---------------------------------------------------------------------------
 export var addArrow = function(prefix) {
   var pos, result;
-  //	console.log "in addArrow(#{OL(prefix)})"
   pos = prefix.lastIndexOf(vbar);
-  //	console.log "pos = #{pos}"
   if (pos === -1) {
     result = prefix;
   } else {
     result = setCharsAt(prefix, pos, arrow);
   }
-  //	console.log "result = #{OL(result)}"
   return result;
 };
 
 // ---------------------------------------------------------------------------
 export var removeLastVbar = function(prefix) {
   var pos, result;
-  //	console.log "in removeLastVbar(#{OL(prefix)})"
   pos = prefix.lastIndexOf(vbar);
-  //	console.log "pos = #{pos}"
   if (pos === -1) {
     result = prefix;
   } else {
     result = setCharsAt(prefix, pos, ' ');
   }
-  //	console.log "result = #{OL(result)}"
   return result;
 };

package/src/call_stack.coffee

@@ -1,10 +1,10 @@
 # call_stack.coffee
 
 import {
-	undef, defined, croak, assert, OL, isBoolean, escapeStr,
+	undef, defined, croak, assert, OL,  escapeStr, deepCopy,
+	isArray, isBoolean,
 	} from '@jdeighan/coffee-utils'
-import {log, LOG} from '@jdeighan/coffee-utils/log'
-import {getPrefix} from '@jdeighan/coffee-utils/arrow'
+import {LOG} from '@jdeighan/coffee-utils/log'
 
 doDebugStack = false
 
@@ -22,7 +22,6 @@ export class CallStack
 	constructor: () ->
 
 		@lStack = []
-		@level = 0
 
 	# ........................................................................
 
@@ -31,15 +30,16 @@ export class CallStack
 		if doDebugStack
 			LOG "RESET STACK"
 		@lStack = []
-		@level = 0
 		return
 
 	# ........................................................................
 
-	enter: (funcName, oldFlag=undef) ->
+	enter: (funcName, lArgs=[], isLogged) ->
 		# --- funcName might be <object>.<method>
 
-		assert (oldFlag == undef), "enter() takes only 1 arg"
+		assert isArray(lArgs), "missing lArgs"
+		assert isBoolean(isLogged), "missing isLogged"
+
 		if doDebugStack
 			LOG "[--> ENTER #{funcName}]"
 
@@ -53,48 +53,40 @@ export class CallStack
 		assert defined(lMatches), "Bad funcName: #{OL(funcName)}"
 		[_, ident1, ident2] = lMatches
 		if ident2
-			@lStack.push({
-				fullName: "#{ident1}.#{ident2}"
+			hStackItem = {
+				fullName: funcName     #    "#{ident1}.#{ident2}"
 				funcName: ident2
-				isLogged: false
-				})
+				isLogged
+				lArgs: deepCopy(lArgs)
+				}
 		else
-			@lStack.push({
-				fullName: ident1
+			hStackItem = {
+				fullName: funcName
 				funcName: ident1
-				isLogged: false
-				})
-		return
+				isLogged
+				lArgs: deepCopy(lArgs)
+				}
+		@lStack.push hStackItem
+		return hStackItem
 
 	# ........................................................................
 
-	isLogging: () ->
+	getLevel: () ->
 
-		if (@lStack.length == 0)
-			return false
-		else
-			return @lStack[@lStack.length - 1].isLogged
+		level = 0
+		for item in @lStack
+			if item.isLogged
+				level += 1
+		return level
 
 	# ........................................................................
 
-	isLoggingPrev: () ->
+	isLogging: () ->
 
-		if (@lStack.length < 2)
+		if (@lStack.length == 0)
 			return false
 		else
-			return @lStack[@lStack.length - 2].isLogged
-
-	# ........................................................................
-
-	logCurFunc: () ->
-
-		# --- 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"
-		cur.isLogged = true
-		@level += 1
-		return
+			return @lStack[@lStack.length - 1].isLogged
 
 	# ........................................................................
 	# --- if stack is empty, log the error, but continue
@@ -109,26 +101,11 @@ export class CallStack
 			return
 
 		{fullName, isLogged} = @lStack.pop()
-		if isLogged && (@level > 0)
-			@level -= 1
-
-		# --- This should do nothing
-		while (fullName != fName) && (@lStack.length > 0)
-			LOG "[MISSING RETURN FROM #{fullName} (return from #{fName})]"
-			{fullName, isLogged} = @lStack.pop()
-			if isLogged && (@level > 0)
-				@level -= 1
-
-		if fullName != fName
-			@dump()
-			LOG "BAD BAD BAD BAD returnFrom('#{fName}')"
-		return
-
-	# ........................................................................
-
-	getLevel: () ->
+		if (fullName != fName)
+			LOG "ERROR: returnFrom('#{fName}') but TOS is #{fullName}"
+			return
 
-		return @level
+		return
 
 	# ........................................................................
 
@@ -151,14 +128,38 @@ export class CallStack
 		return false
 
 	# ........................................................................
-	# ........................................................................
 
-	dump: (prefix='', label='CALL STACK') ->
+	dump: (label="CALL STACK") ->
 
-		lLines = ["#{label}:"]
+		lLines = [label]
 		if @lStack.length == 0
 			lLines.push "   <EMPTY>"
 		else
 			for item, i in @lStack
-				lLines.push "   #{i}: #{item.fullName} #{item.isLogged}"
-		return lLines.join("\n") + "\n"
+				lLines.push "   " + @callStr(i, item)
+		return lLines.join("\n")
+
+	# ........................................................................
+
+	callStr: (i, item) ->
+
+		sym = if item.isLogged then '*' else '-'
+		str = "#{i}: #{sym}#{item.fullName}"
+		for arg in item.lArgs
+			str += " #{OL(arg)}"
+		return str
+
+	# ........................................................................
+
+	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

@@ -8,19 +8,16 @@ import {
   croak,
   assert,
   OL,
-  isBoolean,
-  escapeStr
+  escapeStr,
+  deepCopy,
+  isArray,
+  isBoolean
 } from '@jdeighan/coffee-utils';
 
 import {
-  log,
   LOG
 } from '@jdeighan/coffee-utils/log';
 
-import {
-  getPrefix
-} from '@jdeighan/coffee-utils/arrow';
-
 doDebugStack = false;
 
 // ---------------------------------------------------------------------------
@@ -32,7 +29,6 @@ export var debugStack = function(flag = true) {
 export var CallStack = class CallStack {
   constructor() {
     this.lStack = [];
-    this.level = 0;
   }
 
   // ........................................................................
@@ -41,14 +37,14 @@ export var CallStack = class CallStack {
       LOG("RESET STACK");
     }
     this.lStack = [];
-    this.level = 0;
   }
 
   // ........................................................................
-  enter(funcName, oldFlag = undef) {
-    var _, ident1, ident2, lMatches;
+  enter(funcName, lArgs = [], isLogged) {
+    var _, hStackItem, ident1, ident2, lMatches;
     // --- funcName might be <object>.<method>
-    assert(oldFlag === undef, "enter() takes only 1 arg");
+    assert(isArray(lArgs), "missing lArgs");
+    assert(isBoolean(isLogged), "missing isLogged");
     if (doDebugStack) {
       LOG(`[--> ENTER ${funcName}]`);
     }
@@ -56,49 +52,47 @@ export var CallStack = class CallStack {
     assert(defined(lMatches), `Bad funcName: ${OL(funcName)}`);
     [_, ident1, ident2] = lMatches;
     if (ident2) {
-      this.lStack.push({
-        fullName: `${ident1}.${ident2}`,
+      hStackItem = {
+        fullName: funcName, //    "#{ident1}.#{ident2}"
         funcName: ident2,
-        isLogged: false
-      });
+        isLogged,
+        lArgs: deepCopy(lArgs)
+      };
     } else {
-      this.lStack.push({
-        fullName: ident1,
+      hStackItem = {
+        fullName: funcName,
         funcName: ident1,
-        isLogged: false
-      });
+        isLogged,
+        lArgs: deepCopy(lArgs)
+      };
     }
+    this.lStack.push(hStackItem);
+    return hStackItem;
   }
 
   // ........................................................................
-  isLogging() {
-    if (this.lStack.length === 0) {
-      return false;
-    } else {
-      return this.lStack[this.lStack.length - 1].isLogged;
+  getLevel() {
+    var item, j, len, level, ref;
+    level = 0;
+    ref = this.lStack;
+    for (j = 0, len = ref.length; j < len; j++) {
+      item = ref[j];
+      if (item.isLogged) {
+        level += 1;
+      }
     }
+    return level;
   }
 
   // ........................................................................
-  isLoggingPrev() {
-    if (this.lStack.length < 2) {
+  isLogging() {
+    if (this.lStack.length === 0) {
       return false;
     } else {
-      return this.lStack[this.lStack.length - 2].isLogged;
+      return this.lStack[this.lStack.length - 1].isLogged;
     }
   }
 
-  // ........................................................................
-  logCurFunc() {
-    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");
-    cur.isLogged = true;
-    this.level += 1;
-  }
-
   // ........................................................................
   // --- if stack is empty, log the error, but continue
   returnFrom(fName) {
@@ -111,28 +105,12 @@ export var CallStack = class CallStack {
       return;
     }
     ({fullName, isLogged} = this.lStack.pop());
-    if (isLogged && (this.level > 0)) {
-      this.level -= 1;
-    }
-    // --- This should do nothing
-    while ((fullName !== fName) && (this.lStack.length > 0)) {
-      LOG(`[MISSING RETURN FROM ${fullName} (return from ${fName})]`);
-      ({fullName, isLogged} = this.lStack.pop());
-      if (isLogged && (this.level > 0)) {
-        this.level -= 1;
-      }
-    }
     if (fullName !== fName) {
-      this.dump();
-      LOG(`BAD BAD BAD BAD returnFrom('${fName}')`);
+      LOG(`ERROR: returnFrom('${fName}') but TOS is ${fullName}`);
+      return;
     }
   }
 
-  // ........................................................................
-  getLevel() {
-    return this.level;
-  }
-
   // ........................................................................
   curFunc() {
     if (this.lStack.length === 0) {
@@ -158,20 +136,52 @@ export var CallStack = class CallStack {
   }
 
   // ........................................................................
-  // ........................................................................
-  dump(prefix = '', label = 'CALL STACK') {
+  dump(label = "CALL STACK") {
     var i, item, j, lLines, len, ref;
-    lLines = [`${label}:`];
+    lLines = [label];
     if (this.lStack.length === 0) {
       lLines.push("   <EMPTY>");
     } else {
       ref = this.lStack;
       for (i = j = 0, len = ref.length; j < len; i = ++j) {
         item = ref[i];
-        lLines.push(`   ${i}: ${item.fullName} ${item.isLogged}`);
+        lLines.push("   " + this.callStr(i, item));
+      }
+    }
+    return lLines.join("\n");
+  }
+
+  // ........................................................................
+  callStr(i, item) {
+    var arg, j, len, ref, str, sym;
+    sym = item.isLogged ? '*' : '-';
+    str = `${i}: ${sym}${item.fullName}`;
+    ref = item.lArgs;
+    for (j = 0, len = ref.length; j < len; j++) {
+      arg = ref[j];
+      str += ` ${OL(arg)}`;
+    }
+    return str;
+  }
+
+  // ........................................................................
+  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);
       }
     }
-    return lLines.join("\n") + "\n";
+    if (this.lStack.length === 0) {
+      return `${label} <EMPTY>`;
+    } else {
+      return `${label} ${lFuncNames.join(' ')}`;
+    }
   }
 
 };

package/src/coffee_utils.coffee

@@ -73,17 +73,11 @@ getCallers = (stackTrace, lExclude=[]) ->
 export assert = (cond, msg) ->
 
 	if ! cond
-#		try
-#			throw new Error()
-#		catch e
-#			stackTrace = e.stack
 		stackTrace = new Error().stack
 		lCallers = getCallers(stackTrace, ['assert'])
 
-#		console.log 'STACK'
-#		console.log stackTrace
 		console.log '--------------------'
-		console.log 'CALL STACK:'
+		console.log 'JavaScript CALL STACK:'
 		for caller in lCallers
 			console.log "   #{caller}"
 		console.log '--------------------'
@@ -118,6 +112,16 @@ export getClassName = (obj) ->
 
 # ---------------------------------------------------------------------------
 
+export patchStr = (bigstr, pos, str) ->
+
+	endpos = pos + str.length
+	if (endpos < bigstr.length)
+		return bigstr.substring(0, pos) + str + bigstr.substring(endpos)
+	else
+		return bigstr.substring(0, pos) + str
+
+# ---------------------------------------------------------------------------
+
 export isString = (x) ->
 
 	return typeof x == 'string' || x instanceof String
@@ -349,7 +353,15 @@ export ltrunc = (str, nChars) ->
 
 export deepCopy = (obj) ->
 
-	return JSON.parse(JSON.stringify(obj))
+	if (obj == undef)
+		return undef
+	objStr = JSON.stringify(obj)
+	try
+		newObj = JSON.parse(objStr)
+	catch err
+		croak "ERROR: err.message", objStr
+
+	return newObj
 
 # ---------------------------------------------------------------------------
 #   escapeStr - escape newlines, TAB chars, etc.

package/src/coffee_utils.js

@@ -68,16 +68,10 @@ getCallers = function(stackTrace, lExclude = []) {
 export var assert = function(cond, msg) {
   var caller, i, lCallers, len, stackTrace;
   if (!cond) {
-    //		try
-    //			throw new Error()
-    //		catch e
-    //			stackTrace = e.stack
     stackTrace = new Error().stack;
     lCallers = getCallers(stackTrace, ['assert']);
-    //		console.log 'STACK'
-    //		console.log stackTrace
     console.log('--------------------');
-    console.log('CALL STACK:');
+    console.log('JavaScript CALL STACK:');
     for (i = 0, len = lCallers.length; i < len; i++) {
       caller = lCallers[i];
       console.log(`   ${caller}`);
@@ -112,6 +106,17 @@ export var getClassName = function(obj) {
   return obj.constructor.name;
 };
 
+// ---------------------------------------------------------------------------
+export var patchStr = function(bigstr, pos, str) {
+  var endpos;
+  endpos = pos + str.length;
+  if (endpos < bigstr.length) {
+    return bigstr.substring(0, pos) + str + bigstr.substring(endpos);
+  } else {
+    return bigstr.substring(0, pos) + str;
+  }
+};
+
 // ---------------------------------------------------------------------------
 export var isString = function(x) {
   return typeof x === 'string' || x instanceof String;
@@ -347,7 +352,18 @@ export var ltrunc = function(str, nChars) {
 // ---------------------------------------------------------------------------
 //   deepCopy - deep copy an array or object
 export var deepCopy = function(obj) {
-  return JSON.parse(JSON.stringify(obj));
+  var err, newObj, objStr;
+  if (obj === undef) {
+    return undef;
+  }
+  objStr = JSON.stringify(obj);
+  try {
+    newObj = JSON.parse(objStr);
+  } catch (error1) {
+    err = error1;
+    croak("ERROR: err.message", objStr);
+  }
+  return newObj;
 };
 
 // ---------------------------------------------------------------------------