/* DepressedPress.com DP_Debug Author: Jim Davis, the Depressed Press of Boston Date: September 20, 2006 Contact: webmaster@depressedpress.com Website: www.depressedpress.com Full documentation can be found at: http://www.depressedpress.com/Content/Development/JavaScript/Extensions/DP_Debug/Index.cfm DP_Debug provides extensions to JavaScript to assist with debugging. + The DP_Debug.dump() method allows you to dump an HTML representation of any JavaScript object to the DP_Debug console. It supports nested objects, recursive references and chained method calls. + The methods DP_Debug.dumpCookies() and DP_Debug.dumpQueryString dump important browser information to the console. + The DP_Debug.log() method creates a log entry in the DP_Debug console. + The methods DP_Debug.logInfo(), DP_Debug.logWarning() and DP_Debug.logError() provide shortcuts for logging specific types of messages. + The DP_Debug.timer() method provides a simple way to time specific blocks of code. + The DP_Debug.dpGetType() method provides a more specific answer as to an object type than the native typeof operator. Copyright (c) 1996-2006, The Depressed Press of Boston (depressedpress.com) All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: +) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +) Neither the name of the DEPRESSED PRESS OF BOSTON (DEPRESSEDPRESS.COM) nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ // Add a container for utility methods DP_Debug = new Object(); // dumpWindow Management // // Opens the window, if it's not already open DP_Debug.openDebugWindow = function() { // Create the Dump Window DPDebugWin = window.open("","dumpWindow","scrollbars=yes,resizable=yes,width=500,height=400"); var DPW = DPDebugWin.document; if ( DPW.getElementById("dpBox") == null ) { // Write the HTML DPW.write( "", "", "", " dpDebug by the DepressedPress", " ", " ", " ", "", "
", "
", "
DP_Debug by the DepressedPress
", "
Show Quick Ref
", "
", "
", " ", "
", "
dump Output
", " ", "
", "
", "
", "
", "
log Output
", "
", " Show: ", " Clear", "
", "
", "
", "
", ""); // Close the stream DPW.close(); }; }; // Default Enabled status to "false" DP_Debug.Enabled = false; // Methods to indicate enabled/disabled status DP_Debug.enable = function() { DP_Debug.Enabled = true; }; DP_Debug.disable = function() { DP_Debug.Enabled = false; }; DP_Debug.isEnabled = function() { return DP_Debug.Enabled; }; // Add convienence methods for common log operations DP_Debug.logInfo = function(Content) { DP_Debug.logger(Content, "Info"); }; DP_Debug.logWarning = function(Content) { DP_Debug.logger(Content, "Warning"); }; DP_Debug.logError = function(Content) { DP_Debug.logger(Content, "Error"); }; // "log" method DP_Debug.logger = function(Content, Type) { // Manage input params if ( typeof Content != "string" || Content == "" ) { var Content = ""; }; if ( typeof Type != "string" || Type == "" ) { var Type = "Info"; }; // Open the dumpWindow (if it's not already open) DP_Debug.openDebugWindow() // Get the Current Entries var CurEntries = DPDebugWin.dpLgEntries; // Generate an Entry Object var NewEntry = new Object(); NewEntry.Content = Content; NewEntry.Type = Type; NewEntry.Time = new Date(); // Add the new Entry to the List CurEntries[CurEntries.length] = NewEntry; // Write the Log Entry DPDebugWin.writeLog(); // Return return; }; // Extend Object with the "log" method DP_Debug.timer = function(Name) { // Manage input params if ( typeof Name != "string" || Name == "" ) { var Name = "timer"; }; // Open the dumpWindow (if it's not already open) DP_Debug.openDebugWindow(); // Get the Current Entries var CurTimers = DPDebugWin.timers; // See if this is a new timer if ( typeof CurTimers[Name] == "undefined" ) { // Set the Timer Start Point CurTimers[Name] = new Date(); // Output the log entry DP_Debug.logger("Timer \"" + Name + "\" started.", "Timer"); } else { // Get the Timer Start Point var CurStart = CurTimers[Name]; var CurEnd = new Date(); // Reset the Timer CurTimers[Name] = undefined; // Get the duration var CurTime = CurEnd.getTime() - CurStart.getTime() // Output the log entry DP_Debug.logger("Timer \"" + Name + "\" ended. Duration " + CurTime + " ms", "Timer"); }; // Return return; }; // Cookie Dumper DP_Debug.dumpCookies = function() { var AllCookies = new Object; var Cookies = document.cookie.split(";"); for ( var Cnt=0; Cnt < Cookies.length; Cnt++ ) { var CurCookie = Cookies[Cnt].split("="); if ( CurCookie[0] ) { if ( CurCookie[1] ) { AllCookies[CurCookie[0].replace(/^\s*|\s*$/g,"")] = CurCookie[1]; } else { AllCookies[CurCookie[0].replace(/^\s*|\s*$/g,"")] = ""; }; }; }; DP_Debug.dump(AllCookies, "Accessible Browser Cookies"); }; // Query String Dumper DP_Debug.dumpQueryString = function() { var QS, AllElements, CurElement, CurName, CurVal QS = new Object(); QueryString = location.search; // Split the query string on the ampersand (the substring removes the question mark) AllElements = QueryString.substring(1).split('&'); // Loop over the elements for( var Cnt = 0; Cnt < AllElements.length; Cnt++) { // Split the current element on the equals sign CurElement = AllElements[Cnt].split('='); CurName = unescape(CurElement[0]).replace(/^\s*|\s*$/g,""); // Call the get method to obtain the value if ( CurName.length > 0 ) { if ( !QS[CurName] ) { QS[CurName] = new Array() }; QS[CurName][QS[CurName].length] = CurElement[1]; }; }; // Dump the object DP_Debug.dump(QS, "Accessible Query String Values"); }; // Extend Object with the "dump" method DP_Debug.dump = function(Ob, DevLabel, ShowFunctions, MaxRecurseLevel) { // Grab the Start time var DumpStart = new Date(); // Open the dumpWindow (if it's not already open) DP_Debug.openDebugWindow() // Set up the Object Checker var ParsedObs = new Array(); // Define the current Dump InstanceID var InstID = DPDebugWin.dumpInstances++; var ObID = 0; var ObRefID = 0; // Manage input params if ( typeof DevLabel != "string" || DevLabel == "" ) { var DevLabel = ""; }; // Only IE can handle local links in popups generated by JavaScript if ( navigator.appName == "Microsoft Internet Explorer" ) { LogLabel = "[Dump " + (InstID + 1) + "] " + DevLabel; } else { LogLabel = "[Dump " + (InstID + 1) + "] " + DevLabel; }; // Set the full Dev Label DevLabel = "[Dump " + (InstID + 1) + "] " + DevLabel; // Set whether or not to show functions if ( typeof ShowFunctions != "boolean" ) { var ShowFunctions = false; }; // Set the maximum recursive level if ( typeof MaxRecurseLevel != "number" ) { var MaxRecurseLevel = -1; }; // Set the encoded character dictionary for the conversion to HTML var EncodedChars = new Array(); // Add simple chars (& must come first!) EncodedChars["&"] = "&"; EncodedChars["<"] = "<"; EncodedChars[">"] = ">"; EncodedChars["\""] = """; // Output the current dump DPDebugWin.document.getElementById("dpDpDsp").innerHTML += parseToHTML(Ob, DevLabel); // Grab the End Time var DumpEnd = new Date(); // Determine the total time var DumpTime = DumpEnd.getTime() - DumpStart.getTime() // Output the log entry DP_Debug.logger(LogLabel + " (Completed in " + DumpTime + " ms)", "Dump"); // Return a reference to the object return Ob; // Escape characters using the Encoded Chars tables function escapeString(CurString) { var CurRegEx; for ( var CurChar in EncodedChars ) { if (typeof EncodedChars[CurChar] != "function") {; if ( CurChar != "\\" ) { CurRegEx = new RegExp(CurChar, "g"); } else { CurRegEx = /\\/g; }; CurString = CurString.replace(CurRegEx, EncodedChars[CurChar]); }; }; return CurString; }; // Has the object been parsed already? function checkIfParsedOB(Ob) { // Check the parsed array for ( var Cnt = 0; Cnt < ParsedObs.length; Cnt++ ) { if ( ParsedObs[Cnt] === Ob ) { return true; }; }; // Add the passed object to the parsed array ParsedObs[ParsedObs.length] = Ob; return false; }; // Get the Ref ID function getObRefID(Ob) { // Check the parsed array for ( var Cnt = 0; Cnt < ParsedObs.length; Cnt++ ) { if ( ParsedObs[Cnt] === Ob ) { return Cnt; }; }; return ""; }; // Parse objects to HTML function parseToHTML(Ob, ObLabel, RecurseLevel, ForceUnknown) { // Manage Arugments if ( typeof RecurseLevel != "number" ) { RecurseLevel = 0; }; if ( typeof ForceUnknown != "boolean" ) { ForceUnknown = false; }; // Update the object ID ObID = ObID + 1; // Initialize results var Results = ""; // Set options based on whether this is the first pass or a recursive pass if ( RecurseLevel == 0 ) { var StylePrefix = "Inst"; Results += ""; } else { var StylePrefix = "Ob"; }; // Get some information about the passed Object and set some display fragments if ( ForceUnknown ) { var ObType = "unknown"; } else { var ObType = DP_Debug.getType(Ob); }; var ObLabelID = "ObLabel_" + InstID + "_" + ObID; var ObValueID = "ObValue_" + InstID + "_" + ObID; var ObIDLink = ""; var ObDisplayed = false; switch ( ObType ) { case "object": case "array": // Check to see if the object has already been displayed if ( checkIfParsedOB(Ob) ) { ObDisplayed = true; }; var CurObRefID = getObRefID(Ob); if ( ObDisplayed ) { // Only IE can handle local links in popups generated by JavaScript if ( navigator.appName == "Microsoft Internet Explorer" ) { ObIDLink = " (id: " + CurObRefID + ")"; } else { ObIDLink = " (id: " + CurObRefID + ")"; }; } else { ObIDLink = " (id: " + CurObRefID + ")"; }; }; // Display Element Header Results += ""; Results += ""; if ( RecurseLevel == 0 ) { Results += "
" + ObLabel + "" + ObType + ObIDLink + "
"; // Display Element Content switch ( ObType ) { case "object": case "array": if ( ObDisplayed ) { Results += "( Previously Displayed )"; } else if ( RecurseLevel == MaxRecurseLevel ) { Results += "( Maximum Recursion Depth Reached )"; } else { // Determine if the object is enumerable var ObEnumerable = true; try { for ( var Prop in Ob ) { break; } } catch (CurError) { ObEnumerable = false; }; // Loop over object if ( ObEnumerable ) { Results += ""; for ( var Prop in Ob ) { PropEnumerable = true; try { typeof Ob[Prop]; Ob[Prop]; } catch (CurError) { PropEnumerable = false; Results += parseToHTML(null, Prop, RecurseLevel + 1, true); }; if ( PropEnumerable && ( typeof Ob[Prop] != "function" || ShowFunctions ) ) { Results += parseToHTML(Ob[Prop], Prop, RecurseLevel + 1); }; }; Results += "
"; } else { Results += "( Object is not Enumerable )"; }; }; break; case "function": Results += escapeString(Ob.toString()); break; case "null": Results += "( null )"; break; case "date": Results += Ob.toString(); break; case "number": Results += Ob.toString(); break; case "string": if ( Ob.length == 0 ) { Results += "( Empty String )"; } else { Results += escapeString(Ob); }; break; case "boolean": Results += Ob.toString(); break; case "undefined": Results += "( Undefined Entity )"; break; case "unknown": Results += "( Entity is not Enumerable )"; break; }; // Display Element Footer Results += "
" }; // Return Results return Results; }; }; // Extend Object with the "dpGetType" method DP_Debug.getType = function(Ob) { try { switch (typeof Ob) { case "object": if ( Ob == null ) { return "null"; } else if ( Ob.constructor == Date ) { return "date"; } else if ( Ob.constructor == Array ) { return "array"; } else if ( Ob.constructor == String ) { return "string"; } else if ( Ob.constructor == Number ) { return "number"; } else if ( Ob.constructor == Boolean ) { return "boolean"; } else if ( Ob == undefined ) { return "undefined"; } else { return "object"; }; case "function": return "function"; case "number": return "number"; case "string": return "string"; case "boolean": return "boolean"; case "undefined": return "undefined"; default: return "unknown"; }; } catch (CurError) { return "unknown"; }; };