@jdeighan/coffee-utils 7.0.49 → 7.0.52

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "7.0.49",
+	"version": "7.0.52",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {
@@ -52,6 +52,6 @@
 		"svelte": "^3.48.0"
 	},
 	"devDependencies": {
-		"@jdeighan/unit-tester": "^2.0.3"
+		"@jdeighan/unit-tester": "^2.0.5"
 	}
 }

package/src/arrow.coffee

@@ -1,5 +1,9 @@
 # arrow.coffee
 
+import {undef, OL, setCharsAt} from '@jdeighan/coffee-utils'
+
+# --- We use spaces here because Windows Terminal handles TAB chars badly
+
 export vbar = '│'       # unicode 2502
 export hbar = '─'       # unicode 2500
 export corner = '└'     # unicode 2514
@@ -8,18 +12,22 @@ export space = ' '
 
 export oneIndent = vbar + space + space + space
 export arrow = corner + hbar + arrowhead + space
-export fourSpaces = space + space + space + space
+export clearIndent = space + space + space + space
 
 # ---------------------------------------------------------------------------
 
 export getPrefix = (level, option='none') ->
 
-	if level==0 then return ''
+	if level==0
+		if (option == 'object')
+			return clearIndent
+		else
+			return ''
 	switch option
 		when 'withArrow'
 			result = oneIndent.repeat(level-1) + arrow
-		when 'returnVal'
-			result = oneIndent.repeat(level-1) + fourSpaces
+		when 'object'
+			result = oneIndent.repeat(level) + clearIndent
 		when 'none'
 			result = oneIndent.repeat(level)
 		else
@@ -27,3 +35,31 @@ export getPrefix = (level, option='none') ->
 	if result.length % 4 != 0
 		throw new Error("getPrefix(): Bad prefix '#{result}'")
 	return result
+
+# ---------------------------------------------------------------------------
+
+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

@@ -1,5 +1,12 @@
 // Generated by CoffeeScript 2.7.0
-// arrow.coffee
+  // arrow.coffee
+import {
+  undef,
+  OL,
+  setCharsAt
+} from '@jdeighan/coffee-utils';
+
+// --- We use spaces here because Windows Terminal handles TAB chars badly
 export var vbar = '│'; // unicode 2502
 
 export var hbar = '─'; // unicode 2500
@@ -14,20 +21,24 @@ export var oneIndent = vbar + space + space + space;
 
 export var arrow = corner + hbar + arrowhead + space;
 
-export var fourSpaces = space + space + space + space;
+export var clearIndent = space + space + space + space;
 
 // ---------------------------------------------------------------------------
 export var getPrefix = function(level, option = 'none') {
   var result;
   if (level === 0) {
-    return '';
+    if (option === 'object') {
+      return clearIndent;
+    } else {
+      return '';
+    }
   }
   switch (option) {
     case 'withArrow':
       result = oneIndent.repeat(level - 1) + arrow;
       break;
-    case 'returnVal':
-      result = oneIndent.repeat(level - 1) + fourSpaces;
+    case 'object':
+      result = oneIndent.repeat(level) + clearIndent;
       break;
     case 'none':
       result = oneIndent.repeat(level);
@@ -40,3 +51,33 @@ export var getPrefix = function(level, option = 'none') {
   }
   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,6 +1,8 @@
 # call_stack.coffee
 
-import {undef, croak, assert} from '@jdeighan/coffee-utils'
+import {
+	undef, defined, croak, assert, OL, isBoolean, escapeStr,
+	} from '@jdeighan/coffee-utils'
 import {log, LOG} from '@jdeighan/coffee-utils/log'
 import {getPrefix} from '@jdeighan/coffee-utils/arrow'
 
@@ -19,7 +21,8 @@ export class CallStack
 
 	constructor: () ->
 
-		@reset()
+		@lStack = []
+		@level = 0
 
 	# ........................................................................
 
@@ -27,86 +30,130 @@ export class CallStack
 
 		if doDebugStack
 			LOG "RESET STACK"
-
 		@lStack = []
 		@level = 0
 		return
 
 	# ........................................................................
 
-	addCall: (funcName, hInfo, isLogged) ->
+	enter: (funcName, oldFlag=undef) ->
+		# --- funcName might be <object>.<method>
 
-		@lStack.push({funcName, hInfo, isLogged})
-		if isLogged
-			@level += 1
+		assert (oldFlag == undef), "enter() takes only 1 arg"
+		if doDebugStack
+			LOG "[--> ENTER #{funcName}]"
+
+		lMatches = funcName.match(///^
+				([A-Za-z_][A-Za-z0-9_]*)
+				(?:
+					\.
+					([A-Za-z_][A-Za-z0-9_]*)
+					)?
+				$///)
+		assert defined(lMatches), "Bad funcName: #{OL(funcName)}"
+		[_, ident1, ident2] = lMatches
+		if ident2
+			@lStack.push({
+				fullName: "#{ident1}.#{ident2}"
+				funcName: ident2
+				isLogged: false
+				})
+		else
+			@lStack.push({
+				fullName: ident1
+				funcName: ident1
+				isLogged: false
+				})
 		return
 
 	# ........................................................................
 
-	removeCall: (fName) ->
-
-		{funcName, hInfo, isLogged} = @lStack.pop()
-		if isLogged && (@level > 0)
-			@level -= 1
-		while (funcName != fName) && (@lStack.length > 0)
-			LOG "[MISSING RETURN FROM #{funcName} (return from #{fName})]"
-			{funcName, hInfo, isLogged} = @lStack.pop()
-			if isLogged && (@level > 0)
-				@level -= 1
+	isLogging: () ->
 
-		if funcName == fName
-			return hInfo
+		if (@lStack.length == 0)
+			return false
 		else
-			@dump()
-			LOG "BAD BAD BAD BAD returnFrom('#{fName}')"
-			return undef
+			return @lStack[@lStack.length - 1].isLogged
 
 	# ........................................................................
+
+	isLoggingPrev: () ->
+
+		if (@lStack.length < 2)
+			return false
+		else
+			return @lStack[@lStack.length - 2].isLogged
+
 	# ........................................................................
 
-	call: (funcName, hInfo, isLogged=undef) ->
+	logCurFunc: () ->
 
-		assert isLogged != undef, "CallStack.call(): 3 args required"
-		mainPre = getPrefix(@level)
+		# --- 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
+
+	# ........................................................................
+	# --- if stack is empty, log the error, but continue
+
+	returnFrom: (fName) ->
 
 		if doDebugStack
-			prefix = '   '.repeat(@lStack.length)
-			LOG "#{prefix}[--> CALL #{funcName}]"
+			LOG "[<-- BACK #{fName}]"
 
-		@addCall funcName, hInfo, isLogged
-		auxPre = getPrefix(@level)
-		return [mainPre, auxPre, undef]
+		if @lStack.length == 0
+			LOG "ERROR: returnFrom('#{funcName}') but stack is empty"
+			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
 
 	# ........................................................................
 
-	logStr: () ->
+	getLevel: () ->
 
-		pre = getPrefix(@level)
-		return [pre, pre, undef]
+		return @level
 
 	# ........................................................................
 
-	returnFrom: (funcName) ->
+	curFunc: () ->
 
-		# --- Prefixes are based on level before stack adjustment
-		mainPre = getPrefix(@level, 'withArrow')
-		auxPre = getPrefix(@level, 'returnVal')
+		if (@lStack.length == 0)
+			return 'main'
+		else
+			return @lStack[@lStack.length - 1].funcName
 
-		if @lStack.length == 0
-			LOG "returnFrom('#{funcName}') but stack is empty"
-			return [mainPre, auxPre, undef]
+	# ........................................................................
 
-		hInfo = @removeCall(funcName)
-		if doDebugStack
-			prefix = '   '.repeat(@lStack.length)
-			LOG "#{prefix}[<-- BACK #{funcName}]"
+	isActive: (funcName) ->
+		# --- funcName won't be <obj>.<method>
+		#     but the stack might contain that form
 
-		return [mainPre, auxPre, hInfo]
+		for h in @lStack
+			if (h.funcName == funcName)
+				return true
+		return false
 
 	# ........................................................................
 	# ........................................................................
 
-	dump: (label='CALL STACK') ->
+	dump: (prefix='', label='CALL STACK') ->
 
 		LOG "#{label}:"
 		if @lStack.length == 0

package/src/call_stack.js

@@ -4,8 +4,12 @@ var doDebugStack;
 
 import {
   undef,
+  defined,
   croak,
-  assert
+  assert,
+  OL,
+  isBoolean,
+  escapeStr
 } from '@jdeighan/coffee-utils';
 
 import {
@@ -27,7 +31,8 @@ export var debugStack = function(flag = true) {
 // ---------------------------------------------------------------------------
 export var CallStack = class CallStack {
   constructor() {
-    this.reset();
+    this.lStack = [];
+    this.level = 0;
   }
 
   // ........................................................................
@@ -40,79 +45,121 @@ export var CallStack = class CallStack {
   }
 
   // ........................................................................
-  addCall(funcName, hInfo, isLogged) {
-    this.lStack.push({funcName, hInfo, isLogged});
-    if (isLogged) {
-      this.level += 1;
+  enter(funcName, oldFlag = undef) {
+    var _, ident1, ident2, lMatches;
+    // --- funcName might be <object>.<method>
+    assert(oldFlag === undef, "enter() takes only 1 arg");
+    if (doDebugStack) {
+      LOG(`[--> ENTER ${funcName}]`);
+    }
+    lMatches = funcName.match(/^([A-Za-z_][A-Za-z0-9_]*)(?:\.([A-Za-z_][A-Za-z0-9_]*))?$/);
+    assert(defined(lMatches), `Bad funcName: ${OL(funcName)}`);
+    [_, ident1, ident2] = lMatches;
+    if (ident2) {
+      this.lStack.push({
+        fullName: `${ident1}.${ident2}`,
+        funcName: ident2,
+        isLogged: false
+      });
+    } else {
+      this.lStack.push({
+        fullName: ident1,
+        funcName: ident1,
+        isLogged: false
+      });
     }
   }
 
   // ........................................................................
-  removeCall(fName) {
-    var funcName, hInfo, isLogged;
-    ({funcName, hInfo, isLogged} = this.lStack.pop());
+  isLogging() {
+    if (this.lStack.length === 0) {
+      return false;
+    } else {
+      return this.lStack[this.lStack.length - 1].isLogged;
+    }
+  }
+
+  // ........................................................................
+  isLoggingPrev() {
+    if (this.lStack.length < 2) {
+      return false;
+    } else {
+      return this.lStack[this.lStack.length - 2].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) {
+    var fullName, isLogged;
+    if (doDebugStack) {
+      LOG(`[<-- BACK ${fName}]`);
+    }
+    if (this.lStack.length === 0) {
+      LOG(`ERROR: returnFrom('${funcName}') but stack is empty`);
+      return;
+    }
+    ({fullName, isLogged} = this.lStack.pop());
     if (isLogged && (this.level > 0)) {
       this.level -= 1;
     }
-    while ((funcName !== fName) && (this.lStack.length > 0)) {
-      LOG(`[MISSING RETURN FROM ${funcName} (return from ${fName})]`);
-      ({funcName, hInfo, isLogged} = this.lStack.pop());
+    // --- 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 (funcName === fName) {
-      return hInfo;
-    } else {
+    if (fullName !== fName) {
       this.dump();
       LOG(`BAD BAD BAD BAD returnFrom('${fName}')`);
-      return undef;
     }
   }
 
   // ........................................................................
-  // ........................................................................
-  call(funcName, hInfo, isLogged = undef) {
-    var auxPre, mainPre, prefix;
-    assert(isLogged !== undef, "CallStack.call(): 3 args required");
-    mainPre = getPrefix(this.level);
-    if (doDebugStack) {
-      prefix = '   '.repeat(this.lStack.length);
-      LOG(`${prefix}[--> CALL ${funcName}]`);
-    }
-    this.addCall(funcName, hInfo, isLogged);
-    auxPre = getPrefix(this.level);
-    return [mainPre, auxPre, undef];
+  getLevel() {
+    return this.level;
   }
 
   // ........................................................................
-  logStr() {
-    var pre;
-    pre = getPrefix(this.level);
-    return [pre, pre, undef];
+  curFunc() {
+    if (this.lStack.length === 0) {
+      return 'main';
+    } else {
+      return this.lStack[this.lStack.length - 1].funcName;
+    }
   }
 
   // ........................................................................
-  returnFrom(funcName) {
-    var auxPre, hInfo, mainPre, prefix;
-    // --- Prefixes are based on level before stack adjustment
-    mainPre = getPrefix(this.level, 'withArrow');
-    auxPre = getPrefix(this.level, 'returnVal');
-    if (this.lStack.length === 0) {
-      LOG(`returnFrom('${funcName}') but stack is empty`);
-      return [mainPre, auxPre, undef];
-    }
-    hInfo = this.removeCall(funcName);
-    if (doDebugStack) {
-      prefix = '   '.repeat(this.lStack.length);
-      LOG(`${prefix}[<-- BACK ${funcName}]`);
+  isActive(funcName) {
+    var h, j, len, ref;
+    ref = this.lStack;
+    // --- funcName won't be <obj>.<method>
+    //     but the stack might contain that form
+    for (j = 0, len = ref.length; j < len; j++) {
+      h = ref[j];
+      if (h.funcName === funcName) {
+        return true;
+      }
     }
-    return [mainPre, auxPre, hInfo];
+    return false;
   }
 
   // ........................................................................
   // ........................................................................
-  dump(label = 'CALL STACK') {
+  dump(prefix = '', label = 'CALL STACK') {
     var i, item, j, len, ref;
     LOG(`${label}:`);
     if (this.lStack.length === 0) {

package/src/coffee_utils.coffee

@@ -503,3 +503,15 @@ export className = (aClass) ->
 export range = (n) ->
 
 	return [0..n-1]
+
+# ---------------------------------------------------------------------------
+
+export setCharsAt = (str, pos, str2) ->
+
+	assert (pos >= 0), "negative pos #{pos} not allowed"
+	assert (pos < str.length), "pos #{pos} not in #{OL(str)}"
+	if (pos + str2.length >= str.length)
+		return str.substring(0, pos) + str2
+	else
+		return str.substring(0, pos) + str2 + str.substring(pos + str2.length)
+

package/src/coffee_utils.js

@@ -543,3 +543,14 @@ export var range = function(n) {
     return results;
   }).apply(this);
 };
+
+// ---------------------------------------------------------------------------
+export var setCharsAt = function(str, pos, str2) {
+  assert(pos >= 0, `negative pos ${pos} not allowed`);
+  assert(pos < str.length, `pos ${pos} not in ${OL(str)}`);
+  if (pos + str2.length >= str.length) {
+    return str.substring(0, pos) + str2;
+  } else {
+    return str.substring(0, pos) + str2 + str.substring(pos + str2.length);
+  }
+};