@jdeighan/coffee-utils 11.0.3 → 11.0.5

package/src/arrow.js

@@ -1,83 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-  // arrow.coffee
-import {
-  assert
-} from '@jdeighan/exceptions';
-
-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
-
-export var corner = '└'; // unicode 2514
-
-export var arrowhead = '>';
-
-export var space = ' ';
-
-export var dot = '.';
-
-export var oneIndent = vbar + space + space + space;
-
-export var arrow = corner + hbar + arrowhead + space;
-
-export var clearIndent = space + space + space + space;
-
-export var dotIndent = dot + space + space + space;
-
-// ---------------------------------------------------------------------------
-export var prefix = function(level, option = 'none') {
-  switch (option) {
-    case 'withArrow':
-      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;
-    case 'dotLastVbar':
-      assert(level >= 1, `prefix(), dotLastVbar but level=${OL(level)}`);
-      return oneIndent.repeat(level - 1) + dotIndent;
-    case 'dotLast2Vbars':
-      assert(level >= 2, `prefix(), dotLast2Vbars but level=${OL(level)}`);
-      return oneIndent.repeat(level - 2) + dotIndent + clearIndent;
-    default:
-      return oneIndent.repeat(level);
-  }
-};
-
-// ---------------------------------------------------------------------------
-export var addArrow = function(prefix) {
-  var pos, result;
-  pos = prefix.lastIndexOf(vbar);
-  if (pos === -1) {
-    result = prefix;
-  } else {
-    result = setCharsAt(prefix, pos, arrow);
-  }
-  return result;
-};
-
-// ---------------------------------------------------------------------------
-export var removeLastVbar = function(prefix) {
-  var pos, result;
-  pos = prefix.lastIndexOf(vbar);
-  if (pos === -1) {
-    result = prefix;
-  } else {
-    result = setCharsAt(prefix, pos, ' ');
-  }
-  return result;
-};

package/src/debug.coffee

@@ -1,300 +0,0 @@
-# debug.coffee
-
-import {LOG, assert, croak} from '@jdeighan/exceptions'
-import {
-	undef, defined, notdefined,
-	isString, isFunction, isBoolean, isArray,
-	OL, words, pass,
-	} from '@jdeighan/coffee-utils'
-import {CallStack} from '@jdeighan/coffee-utils/stack'
-import {prefix} from '@jdeighan/coffee-utils/arrow'
-import {
-	log, logItem, logBareItem, shortEnough,
-	} from '@jdeighan/coffee-utils/log'
-
-# --- set in resetDebugging() and setDebugging()
-export callStack = new CallStack()
-export shouldLog = () -> undef
-
-lFuncList = []          # names of functions being debugged
-strFuncList = undef     # original string
-
-# ---------------------------------------------------------------------------
-
-export interp = (label) ->
-
-	return label.replace(/// \$ (\@)? ([A-Za-z_][A-Za-z0-9_]*) ///g,
-			(_, atSign, varName) ->
-				if atSign
-					return "\#{OL(@#{varName})\}"
-				else
-					return "\#{OL(#{varName})\}"
-			)
-
-# ---------------------------------------------------------------------------
-
-export debug = (orgLabel, lObjects...) ->
-
-	assert isString(orgLabel), "1st arg #{OL(orgLabel)} should be a string"
-
-	[type, funcName] = getType(orgLabel, lObjects)
-	label = shouldLog(orgLabel, type, funcName, callStack)
-	if defined(label)
-		label = interp(label)
-
-	switch type
-
-		when 'enter'
-			if defined(label)
-				doTheLogging type, label, lObjects
-			callStack.enter funcName, lObjects, defined(label)
-
-			debug2 "enter debug()", orgLabel, lObjects
-			debug2 "type = #{OL(type)}, funcName = #{OL(funcName)}"
-			debug2 "return from debug()"
-
-		when 'return'
-			debug2 "enter debug()", orgLabel, lObjects
-			debug2 "type = #{OL(type)}, funcName = #{OL(funcName)}"
-			debug2 "return from debug()"
-
-			if defined(label)
-				doTheLogging type, label, lObjects
-			callStack.returnFrom funcName
-
-		when 'string'
-			debug2 "enter debug()", orgLabel, lObjects
-			debug2 "type = #{OL(type)}, funcName = #{OL(funcName)}"
-
-			if defined(label)
-				doTheLogging type, label, lObjects
-			debug2 "return from debug()"
-
-	return true   # allow use in boolean expressions
-
-# ---------------------------------------------------------------------------
-
-export debug2 = (orgLabel, lObjects...) ->
-
-	[type, funcName] = getType(orgLabel, lObjects)
-	label = shouldLog(orgLabel, type, funcName, callStack)
-
-	switch type
-		when 'enter'
-			if defined(label)
-				doTheLogging 'enter', label, lObjects
-			callStack.enter funcName, lObjects, defined(label)
-
-		when 'return'
-			if defined(label)
-				doTheLogging 'return', label, lObjects
-			callStack.returnFrom funcName
-
-		when 'string'
-			if defined(label)
-				doTheLogging 'string', label, lObjects
-
-	return true   # allow use in boolean expressions
-
-# ---------------------------------------------------------------------------
-
-export doTheLogging = (type, label, lObjects) ->
-
-	assert isString(label), "non-string label #{OL(label)}"
-	level = callStack.getLevel()
-
-	switch type
-
-		when 'enter'
-			log label, prefix(level)
-			pre = prefix(level+1, 'dotLastVbar')
-			itemPre = prefix(level+2, 'dotLast2Vbars')
-			for obj,i in lObjects
-				logItem "arg[#{i}]", obj, pre, itemPre
-
-		when 'return'
-			log label, prefix(level, 'withArrow')
-			pre = prefix(level, 'noLastVbar')
-			itemPre = prefix(level+1, 'noLast2Vbars')
-			for obj,i in lObjects
-				logItem "ret[#{i}]", obj, pre, itemPre
-
-		when 'string'
-			pre = prefix(level)
-			itemPre = prefix(level+1, 'noLastVbar')
-			if (lObjects.length==0)
-				log label, pre
-			else if (lObjects.length==1) && shortEnough(label, lObjects[0])
-				logItem label, lObjects[0], pre
-			else
-				if (label.indexOf(':') != label.length - 1)
-					label += ':'
-				log label, pre
-				for obj in lObjects
-					logBareItem obj, itemPre
-	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
-
-	assert isString(label), "label #{OL(label)} not a string"
-	assert isString(type),  "type #{OL(type)} not a string"
-	assert stack instanceof CallStack, "not a call stack object"
-	if (type == 'enter') || (type == 'return')
-		assert isString(funcName), "func name #{OL(funcName)} not a string"
-	else
-		assert funcName == undef, "func name #{OL(funcName)} not undef"
-
-	if funcMatch(funcName || stack.curFunc())
-		return label
-
-	if (type == 'enter') && ! isMyFunc(funcName)
-		# --- As a special case, if we enter a function where we will not
-		#     be logging, but we were logging in the calling function,
-		#     we'll log out the call itself
-
-		if funcMatch(stack.curFunc())
-			result = label.replace('enter', 'call')
-			return result
-	return undef
-
-# ---------------------------------------------------------------------------
-
-export isMyFunc = (funcName) ->
-
-	return funcName in words('debug debug2 doTheLogging
-			stdShouldLog setDebugging getFuncList funcMatch
-			getType dumpCallStack')
-
-# ---------------------------------------------------------------------------
-
-export trueShouldLog = (label, type, funcName, stack) ->
-
-	if isMyFunc(funcName || stack.curFunc())
-		return undef
-	else
-		return label
-
-# ---------------------------------------------------------------------------
-
-export setDebugging = (option) ->
-
-	callStack.reset()
-	if isBoolean(option)
-		if option
-			shouldLog = trueShouldLog
-		else
-			shouldLog = () -> return undef
-	else if isString(option)
-		lFuncList = getFuncList(option)
-		shouldLog = stdShouldLog
-	else if isFunction(option)
-		shouldLog = option
-	else
-		croak "bad parameter #{OL(option)}"
-	return
-
-# ---------------------------------------------------------------------------
-# --- export only to allow unit tests
-
-export getFuncList = (str) ->
-
-	strFuncList = str     # store original string for debugging
-	lFuncList = []
-	for word in words(str)
-		if lMatches = word.match(///^
-				([A-Za-z_][A-Za-z0-9_]*)
-				(?:
-					\.
-					([A-Za-z_][A-Za-z0-9_]*)
-					)?
-				(\+)?
-				$///)
-			[_, ident1, ident2, plus] = lMatches
-			if ident2
-				lFuncList.push {
-					name: ident2
-					object: ident1
-					plus: (plus == '+')
-					}
-			else
-				lFuncList.push {
-					name: ident1
-					plus: (plus == '+')
-					}
-		else
-			croak "Bad word in func list: #{OL(word)}"
-	return lFuncList
-
-# ---------------------------------------------------------------------------
-# --- export only to allow unit tests
-
-export funcMatch = (funcName) ->
-
-	assert isArray(lFuncList), "not an array #{OL(lFuncList)}"
-	for h in lFuncList
-		{name, object, plus} = h
-		if (name == funcName)
-			return true
-		if plus && callStack.isActive(name)
-			return true
-	return false
-
-# ---------------------------------------------------------------------------
-# --- type is one of: 'enter', 'return', 'string'
-
-export getType = (str, lObjects) ->
-
-	if lMatches = str.match(///^
-			\s*
-			( enter | (?: return .+ from ) )
-			\s+
-			([A-Za-z_][A-Za-z0-9_]*)
-			(?:
-				\.
-				([A-Za-z_][A-Za-z0-9_]*)
-				)?
-			///)
-		[_, type, ident1, ident2] = lMatches
-
-		if ident2
-			funcName = ident2
-		else
-			funcName = ident1
-
-		if (type == 'enter')
-			return ['enter', funcName]
-		else
-			return ['return', funcName]
-	else
-		return ['string', undef]
-
-# ---------------------------------------------------------------------------
-
-reMethod = ///^
-	([A-Za-z_][A-Za-z0-9_]*)
-	\.
-	([A-Za-z_][A-Za-z0-9_]*)
-	$///
-
-# ---------------------------------------------------------------------------
-
-export dumpDebugGlobals = () ->
-
-	LOG '='.repeat(40)
-	LOG callStack.dump()
-	if shouldLog == stdShouldLog
-		LOG "using stdShouldLog"
-	else if shouldLog == trueShouldLog
-		LOG "using trueShouldLog"
-	else
-		LOG "using custom shouldLog"
-	LOG "lFuncList:"
-	for funcName in lFuncList
-		LOG "   #{OL(funcName)}"
-	LOG '='.repeat(40)
-
-# ---------------------------------------------------------------------------

package/src/debug.js

@@ -1,329 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-  // debug.coffee
-var lFuncList, reMethod, strFuncList,
-  indexOf = [].indexOf;
-
-import {
-  LOG,
-  assert,
-  croak
-} from '@jdeighan/exceptions';
-
-import {
-  undef,
-  defined,
-  notdefined,
-  isString,
-  isFunction,
-  isBoolean,
-  isArray,
-  OL,
-  words,
-  pass
-} from '@jdeighan/coffee-utils';
-
-import {
-  CallStack
-} from '@jdeighan/coffee-utils/stack';
-
-import {
-  prefix
-} from '@jdeighan/coffee-utils/arrow';
-
-import {
-  log,
-  logItem,
-  logBareItem,
-  shortEnough
-} from '@jdeighan/coffee-utils/log';
-
-// --- set in resetDebugging() and setDebugging()
-export var callStack = new CallStack();
-
-export var shouldLog = function() {
-  return undef;
-};
-
-lFuncList = []; // names of functions being debugged
-
-strFuncList = undef; // original string
-
-
-// ---------------------------------------------------------------------------
-export var interp = function(label) {
-  return label.replace(/\$(\@)?([A-Za-z_][A-Za-z0-9_]*)/g, function(_, atSign, varName) {
-    if (atSign) {
-      return `\#{OL(@${varName})\}`;
-    } else {
-      return `\#{OL(${varName})\}`;
-    }
-  });
-};
-
-// ---------------------------------------------------------------------------
-export var debug = function(orgLabel, ...lObjects) {
-  var funcName, label, type;
-  assert(isString(orgLabel), `1st arg ${OL(orgLabel)} should be a string`);
-  [type, funcName] = getType(orgLabel, lObjects);
-  label = shouldLog(orgLabel, type, funcName, callStack);
-  if (defined(label)) {
-    label = interp(label);
-  }
-  switch (type) {
-    case 'enter':
-      if (defined(label)) {
-        doTheLogging(type, label, lObjects);
-      }
-      callStack.enter(funcName, lObjects, defined(label));
-      debug2("enter debug()", orgLabel, lObjects);
-      debug2(`type = ${OL(type)}, funcName = ${OL(funcName)}`);
-      debug2("return from debug()");
-      break;
-    case 'return':
-      debug2("enter debug()", orgLabel, lObjects);
-      debug2(`type = ${OL(type)}, funcName = ${OL(funcName)}`);
-      debug2("return from debug()");
-      if (defined(label)) {
-        doTheLogging(type, label, lObjects);
-      }
-      callStack.returnFrom(funcName);
-      break;
-    case 'string':
-      debug2("enter debug()", orgLabel, lObjects);
-      debug2(`type = ${OL(type)}, funcName = ${OL(funcName)}`);
-      if (defined(label)) {
-        doTheLogging(type, label, lObjects);
-      }
-      debug2("return from debug()");
-  }
-  return true; // allow use in boolean expressions
-};
-
-
-// ---------------------------------------------------------------------------
-export var debug2 = function(orgLabel, ...lObjects) {
-  var funcName, label, type;
-  [type, funcName] = getType(orgLabel, lObjects);
-  label = shouldLog(orgLabel, type, funcName, callStack);
-  switch (type) {
-    case 'enter':
-      if (defined(label)) {
-        doTheLogging('enter', label, lObjects);
-      }
-      callStack.enter(funcName, lObjects, defined(label));
-      break;
-    case 'return':
-      if (defined(label)) {
-        doTheLogging('return', label, lObjects);
-      }
-      callStack.returnFrom(funcName);
-      break;
-    case 'string':
-      if (defined(label)) {
-        doTheLogging('string', label, lObjects);
-      }
-  }
-  return true; // allow use in boolean expressions
-};
-
-
-// ---------------------------------------------------------------------------
-export var doTheLogging = function(type, label, lObjects) {
-  var i, itemPre, j, k, l, len, len1, len2, level, obj, pre;
-  assert(isString(label), `non-string label ${OL(label)}`);
-  level = callStack.getLevel();
-  switch (type) {
-    case 'enter':
-      log(label, prefix(level));
-      pre = prefix(level + 1, 'dotLastVbar');
-      itemPre = prefix(level + 2, 'dotLast2Vbars');
-      for (i = j = 0, len = lObjects.length; j < len; i = ++j) {
-        obj = lObjects[i];
-        logItem(`arg[${i}]`, obj, pre, itemPre);
-      }
-      break;
-    case 'return':
-      log(label, prefix(level, 'withArrow'));
-      pre = prefix(level, 'noLastVbar');
-      itemPre = prefix(level + 1, 'noLast2Vbars');
-      for (i = k = 0, len1 = lObjects.length; k < len1; i = ++k) {
-        obj = lObjects[i];
-        logItem(`ret[${i}]`, obj, pre, itemPre);
-      }
-      break;
-    case 'string':
-      pre = prefix(level);
-      itemPre = prefix(level + 1, 'noLastVbar');
-      if (lObjects.length === 0) {
-        log(label, pre);
-      } else if ((lObjects.length === 1) && shortEnough(label, lObjects[0])) {
-        logItem(label, lObjects[0], pre);
-      } else {
-        if (label.indexOf(':') !== label.length - 1) {
-          label += ':';
-        }
-        log(label, pre);
-        for (l = 0, len2 = lObjects.length; l < len2; l++) {
-          obj = lObjects[l];
-          logBareItem(obj, itemPre);
-        }
-      }
-  }
-};
-
-// ---------------------------------------------------------------------------
-export var stdShouldLog = function(label, type, funcName, stack) {
-  var result;
-  // --- if type is 'enter', then funcName won't be on the stack yet
-  //     returns the (possibly modified) label to log
-  assert(isString(label), `label ${OL(label)} not a string`);
-  assert(isString(type), `type ${OL(type)} not a string`);
-  assert(stack instanceof CallStack, "not a call stack object");
-  if ((type === 'enter') || (type === 'return')) {
-    assert(isString(funcName), `func name ${OL(funcName)} not a string`);
-  } else {
-    assert(funcName === undef, `func name ${OL(funcName)} not undef`);
-  }
-  if (funcMatch(funcName || stack.curFunc())) {
-    return label;
-  }
-  if ((type === 'enter') && !isMyFunc(funcName)) {
-    // --- As a special case, if we enter a function where we will not
-    //     be logging, but we were logging in the calling function,
-    //     we'll log out the call itself
-    if (funcMatch(stack.curFunc())) {
-      result = label.replace('enter', 'call');
-      return result;
-    }
-  }
-  return undef;
-};
-
-// ---------------------------------------------------------------------------
-export var isMyFunc = function(funcName) {
-  return indexOf.call(words('debug debug2 doTheLogging stdShouldLog setDebugging getFuncList funcMatch getType dumpCallStack'), funcName) >= 0;
-};
-
-// ---------------------------------------------------------------------------
-export var trueShouldLog = function(label, type, funcName, stack) {
-  if (isMyFunc(funcName || stack.curFunc())) {
-    return undef;
-  } else {
-    return label;
-  }
-};
-
-// ---------------------------------------------------------------------------
-export var setDebugging = function(option) {
-  callStack.reset();
-  if (isBoolean(option)) {
-    if (option) {
-      shouldLog = trueShouldLog;
-    } else {
-      shouldLog = function() {
-        return undef;
-      };
-    }
-  } else if (isString(option)) {
-    lFuncList = getFuncList(option);
-    shouldLog = stdShouldLog;
-  } else if (isFunction(option)) {
-    shouldLog = option;
-  } else {
-    croak(`bad parameter ${OL(option)}`);
-  }
-};
-
-// ---------------------------------------------------------------------------
-// --- export only to allow unit tests
-export var getFuncList = function(str) {
-  var _, ident1, ident2, j, lMatches, len, plus, ref, word;
-  strFuncList = str; // store original string for debugging
-  lFuncList = [];
-  ref = words(str);
-  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;
-      if (ident2) {
-        lFuncList.push({
-          name: ident2,
-          object: ident1,
-          plus: plus === '+'
-        });
-      } else {
-        lFuncList.push({
-          name: ident1,
-          plus: plus === '+'
-        });
-      }
-    } else {
-      croak(`Bad word in func list: ${OL(word)}`);
-    }
-  }
-  return lFuncList;
-};
-
-// ---------------------------------------------------------------------------
-// --- export only to allow unit tests
-export var funcMatch = function(funcName) {
-  var h, j, len, name, object, plus;
-  assert(isArray(lFuncList), `not an array ${OL(lFuncList)}`);
-  for (j = 0, len = lFuncList.length; j < len; j++) {
-    h = lFuncList[j];
-    ({name, object, plus} = h);
-    if (name === funcName) {
-      return true;
-    }
-    if (plus && callStack.isActive(name)) {
-      return true;
-    }
-  }
-  return false;
-};
-
-// ---------------------------------------------------------------------------
-// --- type is one of: 'enter', 'return', 'string'
-export var getType = function(str, lObjects) {
-  var _, funcName, ident1, ident2, lMatches, type;
-  if (lMatches = str.match(/^\s*(enter|(?:return.+from))\s+([A-Za-z_][A-Za-z0-9_]*)(?:\.([A-Za-z_][A-Za-z0-9_]*))?/)) {
-    [_, type, ident1, ident2] = lMatches;
-    if (ident2) {
-      funcName = ident2;
-    } else {
-      funcName = ident1;
-    }
-    if (type === 'enter') {
-      return ['enter', funcName];
-    } else {
-      return ['return', funcName];
-    }
-  } else {
-    return ['string', undef];
-  }
-};
-
-// ---------------------------------------------------------------------------
-reMethod = /^([A-Za-z_][A-Za-z0-9_]*)\.([A-Za-z_][A-Za-z0-9_]*)$/;
-
-// ---------------------------------------------------------------------------
-export var dumpDebugGlobals = function() {
-  var funcName, j, len;
-  LOG('='.repeat(40));
-  LOG(callStack.dump());
-  if (shouldLog === stdShouldLog) {
-    LOG("using stdShouldLog");
-  } else if (shouldLog === trueShouldLog) {
-    LOG("using trueShouldLog");
-  } else {
-    LOG("using custom shouldLog");
-  }
-  LOG("lFuncList:");
-  for (j = 0, len = lFuncList.length; j < len; j++) {
-    funcName = lFuncList[j];
-    LOG(`   ${OL(funcName)}`);
-  }
-  return LOG('='.repeat(40));
-};
-
-// ---------------------------------------------------------------------------