@jdeighan/coffee-utils 6.0.7 → 7.0.0

package/package.json

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

package/src/DataStores.coffee

@@ -8,7 +8,6 @@ import {
 	assert, undef, pass, error, isEmpty,
 	} from '@jdeighan/coffee-utils'
 import {localStore} from '@jdeighan/coffee-utils/browser'
-import {log} from '@jdeighan/coffee-utils/log'
 import {
 	withExt, slurp, barf, newerDestFileExists,
 	} from '@jdeighan/coffee-utils/fs'

package/src/DataStores.js

@@ -22,10 +22,6 @@ import {
   localStore
 } from '@jdeighan/coffee-utils/browser';
 
-import {
-  log
-} from '@jdeighan/coffee-utils/log';
-
 import {
   withExt,
   slurp,

package/src/arrow.coffee

@@ -1,39 +1,29 @@
 # arrow.coffee
 
-vbar = '│'       # unicode 2502
-hbar = '─'       # unicode 2500
-corner = '└'     # unicode 2514
-arrowhead = '>'
+export vbar = '│'       # unicode 2502
+export hbar = '─'       # unicode 2500
+export corner = '└'     # unicode 2514
+export arrowhead = '>'
+export space = ' '
 
-oneIndent = vbar + '   '
-export arrow = corner + hbar + arrowhead + ' '
+export oneIndent = vbar + space + space + space
+export arrow = corner + hbar + arrowhead + space
+export fourSpaces = space + space + space + space
 
 # ---------------------------------------------------------------------------
 
-export getPrefix = (level, withArrow) ->
+export getPrefix = (level, option='none') ->
 
-	if withArrow
-		return oneIndent.repeat(level-1) + arrow
-	else
-		return oneIndent.repeat(level)
-	return
-
-# ---------------------------------------------------------------------------
-
-export hasArrow = (str) ->
-
-	return str.indexOf(arrow) > -1
-
-# ---------------------------------------------------------------------------
-
-export removeArrow = (str, useVbar) ->
-
-	if hasArrow(str)
-		if useVbar
-			return str.replace(arrow, oneIndent)
+	if level==0 then return ''
+	switch option
+		when 'withArrow'
+			result = oneIndent.repeat(level-1) + arrow
+		when 'returnVal'
+			result = oneIndent.repeat(level-1) + fourSpaces
+		when 'none'
+			result = oneIndent.repeat(level)
 		else
-			return str.replace(arrow, '    ')
-	else
-		return str
-
-# ---------------------------------------------------------------------------
+			throw new Error("getPrefix(): Bad option: '#{option}'")
+	if result.length % 4 != 0
+		throw new Error("getPrefix(): Bad prefix '#{result}'")
+	return result

package/src/arrow.js

@@ -1,44 +1,42 @@
 // Generated by CoffeeScript 2.6.1
 // arrow.coffee
-var arrowhead, corner, hbar, oneIndent, vbar;
+export var vbar = '│'; // unicode 2502
 
-vbar = '│'; // unicode 2502
+export var hbar = '─'; // unicode 2500
 
-hbar = '─'; // unicode 2500
+export var corner = '└'; // unicode 2514
 
-corner = '└'; // unicode 2514
+export var arrowhead = '>';
 
-arrowhead = '>';
+export var space = ' ';
 
-oneIndent = vbar + '   ';
+export var oneIndent = vbar + space + space + space;
 
-export var arrow = corner + hbar + arrowhead + ' ';
+export var arrow = corner + hbar + arrowhead + space;
 
-// ---------------------------------------------------------------------------
-export var getPrefix = function(level, withArrow) {
-  if (withArrow) {
-    return oneIndent.repeat(level - 1) + arrow;
-  } else {
-    return oneIndent.repeat(level);
-  }
-};
-
-// ---------------------------------------------------------------------------
-export var hasArrow = function(str) {
-  return str.indexOf(arrow) > -1;
-};
+export var fourSpaces = space + space + space + space;
 
 // ---------------------------------------------------------------------------
-export var removeArrow = function(str, useVbar) {
-  if (hasArrow(str)) {
-    if (useVbar) {
-      return str.replace(arrow, oneIndent);
-    } else {
-      return str.replace(arrow, '    ');
-    }
-  } else {
-    return str;
+export var getPrefix = function(level, option = 'none') {
+  var result;
+  if (level === 0) {
+    return '';
+  }
+  switch (option) {
+    case 'withArrow':
+      result = oneIndent.repeat(level - 1) + arrow;
+      break;
+    case 'returnVal':
+      result = oneIndent.repeat(level - 1) + fourSpaces;
+      break;
+    case 'none':
+      result = oneIndent.repeat(level);
+      break;
+    default:
+      throw new Error(`getPrefix(): Bad option: '${option}'`);
+  }
+  if (result.length % 4 !== 0) {
+    throw new Error(`getPrefix(): Bad prefix '${result}'`);
   }
+  return result;
 };
-
-// ---------------------------------------------------------------------------

package/src/call_stack.coffee

@@ -2,6 +2,7 @@
 
 import {undef, croak, assert} from '@jdeighan/coffee-utils'
 import {log, LOG} from '@jdeighan/coffee-utils/log'
+import {getPrefix} from '@jdeighan/coffee-utils/arrow'
 
 doDebugStack = false
 
@@ -22,49 +23,95 @@ export class CallStack
 
 	# ........................................................................
 
-	call: (funcName, hInfo) ->
+	reset: () ->
 
 		if doDebugStack
-			prefix = '   '.repeat(@lStack.length)
-			LOG "#{prefix}[> CALL #{funcName}]"
-		@lStack.push({funcName, hInfo})
+			LOG "RESET STACK"
+
+		@lStack = []
+		@level = 0
 		return
 
 	# ........................................................................
 
-	returnFrom: (fName) ->
+	addCall: (funcName, hInfo, isLogged) ->
 
-		if @lStack.length == 0
-			LOG "returnFrom('#{fName}') but stack is empty"
-			return undef
-		{funcName, hInfo} = @lStack.pop()
+		@lStack.push({funcName, hInfo, isLogged})
+		if isLogged
+			@level += 1
+		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} = @lStack.pop()
+			{funcName, hInfo, isLogged} = @lStack.pop()
+			if isLogged && (@level > 0)
+				@level -= 1
 
-		if doDebugStack
-			prefix = '   '.repeat(@lStack.length)
-			LOG "#{prefix}[< BACK #{fName}]"
-		if (funcName == fName)
+		if funcName == fName
 			return hInfo
 		else
 			@dump()
-			LOG "BAD returnFrom('#{fName}')"
+			LOG "BAD BAD BAD BAD returnFrom('#{fName}')"
 			return undef
 
 	# ........................................................................
+	# ........................................................................
 
-	reset: () ->
+	call: (funcName, hInfo, isLogged=undef) ->
+
+		assert isLogged != undef, "CallStack.call(): 3 args required"
+		mainPre = getPrefix(@level)
 
 		if doDebugStack
-			LOG "RESET STACK"
-		@lStack = []
+			prefix = '   '.repeat(@lStack.length)
+			LOG "#{prefix}[--> CALL #{funcName}]"
+
+		@addCall funcName, hInfo, isLogged
+		auxPre = getPrefix(@level)
+		return [mainPre, auxPre, undef]
+
+	# ........................................................................
+
+	logStr: () ->
+
+		pre = getPrefix(@level)
+		return [pre, pre, undef]
+
+	# ........................................................................
+
+	returnFrom: (funcName) ->
+
+		# --- Prefixes are based on level before stack adjustment
+		mainPre = getPrefix(@level, 'withArrow')
+		auxPre = getPrefix(@level, 'returnVal')
 
+		if @lStack.length == 0
+			LOG "returnFrom('#{fName}') but stack is empty"
+			return [mainPre, auxPre, undef]
+
+		hInfo = @removeCall(funcName)
+		if doDebugStack
+			prefix = '   '.repeat(@lStack.length)
+			LOG "#{prefix}[<-- BACK #{fName}]"
+
+		return [mainPre, auxPre, hInfo]
+
+	# ........................................................................
 	# ........................................................................
 
 	dump: (label='CALL STACK') ->
 
-		console.log "#{label}:"
-		for item, i in @lStack
-			LOG "#{i}: #{JSON.stringify(item)}"
+		LOG "#{label}:"
+		if @lStack.length == 0
+			LOG "   <EMPTY>"
+		else
+			for item, i in @lStack
+				LOG "   #{i}: #{JSON.stringify(item)}"
 		return

package/src/call_stack.js

@@ -13,6 +13,10 @@ import {
   LOG
 } from '@jdeighan/coffee-utils/log';
 
+import {
+  getPrefix
+} from '@jdeighan/coffee-utils/arrow';
+
 doDebugStack = false;
 
 // ---------------------------------------------------------------------------
@@ -27,56 +31,98 @@ export var CallStack = class CallStack {
   }
 
   // ........................................................................
-  call(funcName, hInfo) {
-    var prefix;
+  reset() {
     if (doDebugStack) {
-      prefix = '   '.repeat(this.lStack.length);
-      LOG(`${prefix}[> CALL ${funcName}]`);
+      LOG("RESET STACK");
     }
-    this.lStack.push({funcName, hInfo});
+    this.lStack = [];
+    this.level = 0;
   }
 
   // ........................................................................
-  returnFrom(fName) {
-    var funcName, hInfo, prefix;
-    if (this.lStack.length === 0) {
-      LOG(`returnFrom('${fName}') but stack is empty`);
-      return undef;
+  addCall(funcName, hInfo, isLogged) {
+    this.lStack.push({funcName, hInfo, isLogged});
+    if (isLogged) {
+      this.level += 1;
+    }
+  }
+
+  // ........................................................................
+  removeCall(fName) {
+    var funcName, hInfo, isLogged;
+    ({funcName, hInfo, isLogged} = this.lStack.pop());
+    if (isLogged && (this.level > 0)) {
+      this.level -= 1;
     }
-    ({funcName, hInfo} = this.lStack.pop());
     while ((funcName !== fName) && (this.lStack.length > 0)) {
       LOG(`[MISSING RETURN FROM ${funcName} (return from ${fName})]`);
-      ({funcName, hInfo} = this.lStack.pop());
-    }
-    if (doDebugStack) {
-      prefix = '   '.repeat(this.lStack.length);
-      LOG(`${prefix}[< BACK ${fName}]`);
+      ({funcName, hInfo, isLogged} = this.lStack.pop());
+      if (isLogged && (this.level > 0)) {
+        this.level -= 1;
+      }
     }
     if (funcName === fName) {
       return hInfo;
     } else {
       this.dump();
-      LOG(`BAD returnFrom('${fName}')`);
+      LOG(`BAD BAD BAD BAD returnFrom('${fName}')`);
       return undef;
     }
   }
 
   // ........................................................................
-  reset() {
+  // ........................................................................
+  call(funcName, hInfo, isLogged = undef) {
+    var auxPre, mainPre, prefix;
+    assert(isLogged !== undef, "CallStack.call(): 3 args required");
+    mainPre = getPrefix(this.level);
     if (doDebugStack) {
-      LOG("RESET STACK");
+      prefix = '   '.repeat(this.lStack.length);
+      LOG(`${prefix}[--> CALL ${funcName}]`);
     }
-    return this.lStack = [];
+    this.addCall(funcName, hInfo, isLogged);
+    auxPre = getPrefix(this.level);
+    return [mainPre, auxPre, undef];
+  }
+
+  // ........................................................................
+  logStr() {
+    var pre;
+    pre = getPrefix(this.level);
+    return [pre, pre, undef];
   }
 
+  // ........................................................................
+  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('${fName}') but stack is empty`);
+      return [mainPre, auxPre, undef];
+    }
+    hInfo = this.removeCall(funcName);
+    if (doDebugStack) {
+      prefix = '   '.repeat(this.lStack.length);
+      LOG(`${prefix}[<-- BACK ${fName}]`);
+    }
+    return [mainPre, auxPre, hInfo];
+  }
+
+  // ........................................................................
   // ........................................................................
   dump(label = 'CALL STACK') {
     var i, item, j, len, ref;
-    console.log(`${label}:`);
-    ref = this.lStack;
-    for (i = j = 0, len = ref.length; j < len; i = ++j) {
-      item = ref[i];
-      LOG(`${i}: ${JSON.stringify(item)}`);
+    LOG(`${label}:`);
+    if (this.lStack.length === 0) {
+      LOG("   <EMPTY>");
+    } else {
+      ref = this.lStack;
+      for (i = j = 0, len = ref.length; j < len; i = ++j) {
+        item = ref[i];
+        LOG(`   ${i}: ${JSON.stringify(item)}`);
+      }
     }
   }
 

package/src/coffee_utils.coffee

@@ -3,6 +3,7 @@
 export sep_dash = '-'.repeat(42)
 export sep_eq = '='.repeat(42)
 `export const undef = undefined`
+LOG = (lArgs...) -> console.log lArgs...   # synonym for console.log()
 
 # ---------------------------------------------------------------------------
 #   pass - do nothing
@@ -226,9 +227,9 @@ export hashToStr = (h) ->
 export say = (x) ->
 
 	if isHash(x)
-		console.log hashToStr(x)
+		LOG hashToStr(x)
 	else
-		console.log x
+		LOG x
 	return
 
 # ---------------------------------------------------------------------------

package/src/coffee_utils.js

@@ -1,6 +1,6 @@
 // Generated by CoffeeScript 2.6.1
 // coffee_utils.coffee
-var commentRegExp;
+var LOG, commentRegExp;
 
 export var sep_dash = '-'.repeat(42);
 
@@ -8,6 +8,11 @@ export var sep_eq = '='.repeat(42);
 
 export const undef = undefined;
 
+LOG = function(...lArgs) {
+  return console.log(...lArgs); // synonym for console.log()
+};
+
+
 // ---------------------------------------------------------------------------
 //   pass - do nothing
 export var pass = function() {};
@@ -219,9 +224,9 @@ export var hashToStr = function(h) {
 //         later, on a web page, call alert(str)
 export var say = function(x) {
   if (isHash(x)) {
-    console.log(hashToStr(x));
+    LOG(hashToStr(x));
   } else {
-    console.log(x);
+    LOG(x);
   }
 };