// Debug.js.
// Opens a debugging window and facilitates writing to it.
// Especially useful for alerting variables inside loops.
// v01.6 modified by Jon ippolito to revise debugObject and debugArray functions.
/*" _______________ HOW TO USE THIS SCRIPT _________________ "*/
/*
1. Add to html head:
2. Call the function inline, and choose the argument depending on what you want:
a. To report name and value of a global variable, just quote the argument.
debug( "myGlobalVariable") ;
b. To report just a string, double-quote ( " ' foo ' " ) the argument.
debug("'myHeading'") ;
c. To modify style, add a second argument for an importance from 1-10, or a more nuanced anonymous object.
debug( "myUnimportantVariable", 1 ) ;
debug("'myImportantHeading'", 10) ;
debug( "mySpecialVariable", { importance: 4, styleString: "color: turquoise; font-size: 20px ; " } ) ;
e. To create a collapsible section, add a third argument:
debug("'Begin function'", 1, "start") ;
...
debug("'End function'", 1, "end") ;
d. To report the name and value of a local variable, create a temporary global:
_this = this ; debug("_this") ;
e. To report the contents of an array or object, use these custom functions:
debugArray("myArray") ;
debugObject("myObject") ;
*/
/*" _______________ THE SCRIPT _________________ "*/
// Prepare the window.
debugWindowOpenedBefore = false ;
function openDebugWindow(argsObj) { //openerWindow [usually "this"], debugIsOn, purgeOldReports
debugWindowOpenedBefore = true ;
debugIsOn = argsObj.debugIsOn ;
purgeOldReports = argsObj.purgeOldReports ;
if (debugIsOn) {
openerWindow = argsObj.openerWindow ;
openerWindowTitle = (openerWindow.document.title == "")? openerWindowTitle = "untitled window" : openerWindow.document.title ;
debugWinVar = window.open("","debugWinName","width=400,height=800,resizable,scrollbars,left=-50") ;
debugWinVar.document.write("Debugging: " + openerWindowTitle + "") ;
if (purgeOldReports) {
// The following line does not allow multiple reports per window.
debugWinVar.document.close() ;
}
var currentTimeObj = new Date() ;
debugWinVar.document.write( "
DEBUG.JS REPORT AT " + currentTimeObj.getHours() + ":" + currentTimeObj.getMinutes() + ":" + currentTimeObj.getSeconds() + "
" );
debugWinVar.document.write( "To disable debugging, set debugIsOn to false in openDebugWindow function.
" );
debugWinVar.focus() ;
}
}
// Report an event to that window.
function debug(lineToWriteArg, optionsArg, makeCollapsible) { // optionsArg can be an importance from 1 to 10 or an object.
if (!debugIsOn) return ;
var styleString = "font-family: arial ; font-size: 12px ; font-weight: bold ; " ;
var lineToWrite = lineToWriteArg ;
// CONDITIONALS WOULD HAVE TO GO ABOVE.
try {
errorTest = lineToWrite != "'" + eval(lineToWrite) + "'"
if (lineToWrite != "'" + eval(lineToWrite) + "'") {
lineToWrite += ": " + eval(lineToWrite) + "" ;
}
else {
styleString += " color: wheat ; background-color: dimgray ; " ;
}
}
catch (e) {
this_broke_the_debugger = lineToWrite; debug("this_broke_the_debugger", 8) ;
}
if (optionsArg) {
if (typeof optionsArg == "object") {
if (optionsObj.styleStringCustom) {
styleString += optionsObj.styleStringCustom ;
}
if (optionsObj.importance) {
var importance = optionsObj.importance ;
}
}
else if (typeof optionsArg == "number") {
var importance = optionsArg ;
}
switch (importance) { // 10 is highest.
case 0:
break ;
case 1:
styleString += "color: blueviolet" ;
break ;
case 2:
styleString +="margin-left: 15px ; color: dodgerblue ; " ;
break ;
case 3:
styleString +="margin-left: 15px ; color: darkcyan ; " ;
break ;
case 4:
styleString +="margin-left: 10px ; color: olive ; font-size: 13px ; " ;
break ;
case 5:
styleString +="margin-left: 10px ; color: teal ; font-size: 13px ; " ;
break ;
case 6:
styleString += "margin-left: 5px ; color: orange; font-size: 14px ; " ;
break ;
case 7:
styleString +="margin-left: 5px ; color: orangered ; font-size: 14px ; " ;
break ;
case 8:
styleString +="margin-left: 0px ; color: red ; font-size: 16px ;" ;
break ;
case 9:
styleString +="margin-left: 0px ; color: maroon ; font-size: 20px ;" ;
break ;
case 10:
styleString +="margin-left: 0px ; color: white ; background-color: black; font-size: 24px ;" ;
break ;
}
}
if (makeCollapsible) {
if (makeCollapsible == "start") {
lineToWrite = "" + lineToWrite + "
" ;
}
else {
lineToWrite += "
"
// }
lineToWrite = "" + lineToWrite + "" ;
}
if (!debugWindowOpenedBefore) {
alert("debug.js hasn't been properly initialized. Check the instructions in debug.js or remove all debug.js references from your html code.") ;
document.write("Exited document.") ;
return ;
}
if (typeof debugWinVar == "undefined" || typeof debugWinVar.document == "undefined" ) { // It was opened but is now closed.
openDebugWindow({ openerWindow: openerWindow, debugIsOn: debugIsOn , purgeOldReports: purgeOldReports }) ;
}
debugWinVar.document.writeln(lineToWrite) ;
}
function debugObject(objectArg){ // objectArg can be string or object.
if (!debugIsOn) return ;
if (typeof objectArg == "string") { // objectArg is the object name as a string.
debug("'Here are the properties for :'") ;
_objectName = objectArg ; debug("_objectName", 2, "start") ;
objectArg = eval(objectArg) ;
_objectLength = objectArg.length ; debug("_objectLength") ;
}
var objectProperties = "" ;
for (var property in objectArg) {
objectProperties += property + ", " ;
}
debugWinVar.document.write(objectProperties) ;
debug("'End of object'", 1, "end") ;
}
function debugArray(arrayArg){ // arrayArg can be string or object.
if (!debugIsOn) return ;
if (typeof arrayArg == "string") { // objectArg is the object name as a string.
debug("'Here are the properties for :'") ;
_arrayName = arrayArg ; debug("_arrayName", 2, "start") ;
arrayArg = eval(arrayArg) ;
_arrayLength = arrayArg.length ; debug("_arrayLength") ;
}
var arrayElements = "" ;
for (var counter=0; counter < arrayArg.length; counter++) {
arrayElements += arrayArg[counter] + ", " ;
};
debugWinVar.document.write(arrayElements) ;
debug("'End of array'", 1, "end") ;
}
/* UPGRADE: STILL TO IMPLEMENT
Flags:
-b follow with a line break and a border ________
-1, -2 importance
-n no line break
*/