Debugging Tips - Revision history

ObviousAltIsObvious Resident: tag to

2015-01-25T22:36:24Z

← Older revision		Revision as of 15:36, 25 January 2015
Line 5:		Line 5:
	The solution is to define a simple debugging utility function as follows.		The solution is to define a simple debugging utility function as follows.

	<~~lsl~~>		<source lang="lsl2">
	notify(string message)		notify(string message)
	{		{
	llOwnerSay(message);		llOwnerSay(message);
	}		}
	</~~lsl~~>		</source>

	then whenever we need to check the value of a variable simple call		then whenever we need to check the value of a variable simple call

	<~~lsl~~>		<source lang="lsl2">
	// default		// default
	// {		// {
Line 22:		Line 22:
	// }		// }
	// }		// }
	</~~lsl~~>		</source>

	don't forget to typecast as necessary, for example:		don't forget to typecast as necessary, for example:

	<~~lsl~~>		<source lang="lsl2">
	// default		// default
	// {		// {
Line 37:		Line 37:
	// }		// }
	// }		// }
	</~~lsl~~>		</source>

	This allows us to reuse the same function for reporting anything to the owner of the object, rather than using public chat. The advantage to doing this is we can comment out a single line in the code function as follows to disable all debugging, or we can search and replace and instance of "notify" with "//notify".		This allows us to reuse the same function for reporting anything to the owner of the object, rather than using public chat. The advantage to doing this is we can comment out a single line in the code function as follows to disable all debugging, or we can search and replace and instance of "notify" with "//notify".

	<~~lsl~~>		<source lang="lsl2">
	notify(string message)		notify(string message)
	{		{
	//llOwnerSay(message);		//llOwnerSay(message);
	}		}
	</~~lsl~~>		</source>

	if you're working with list, you could use something along the lines of		if you're working with list, you could use something along the lines of

	<~~lsl~~>		<source lang="lsl2">
	// notification contains one list element		// notification contains one list element
	notify(llList2String(listOfNames, integerIndex));		notify(llList2String(listOfNames, integerIndex));
	</~~lsl~~>		</source>
	or		or
	<~~lsl~~>		<source lang="lsl2">
	// notification contains entire list as a string		// notification contains entire list as a string
	notify(llDumpList2String(listOfNames, ","));		notify(llDumpList2String(listOfNames, ","));
Line 61:		Line 61:
	// or alternatively a CSV (comma-seperated-value string):		// or alternatively a CSV (comma-seperated-value string):
	// notify(llList2CSV(listOfNames));		// notify(llList2CSV(listOfNames));
	</~~lsl~~>		</source>

	However, the lsl compiler is not an optimizing compiler. This means that even if you disable notify() as shown above (by commenting out its body), you will still suffer a performance hit from converting the list to a string. A better plan would be to create a separate notifyList function which takes a list parameter and dumps it:		However, the lsl compiler is not an optimizing compiler. This means that even if you disable notify() as shown above (by commenting out its body), you will still suffer a performance hit from converting the list to a string. A better plan would be to create a separate notifyList function which takes a list parameter and dumps it:

	<~~lsl~~>		<source lang="lsl2">
	notifyList(list listOfMessages)		notifyList(list listOfMessages)
	{		{
Line 73:		Line 73:
	// llOwnerSay(llList2CSV(listOfMessages));		// llOwnerSay(llList2CSV(listOfMessages));
	}		}
	</~~lsl~~>		</source>

	==Error Reporting and Debugging==		==Error Reporting and Debugging==
	We can use the same concept for tracking issues after the code is complete as follows		We can use the same concept for tracking issues after the code is complete as follows

	<~~lsl~~>		<source lang="lsl2">
	notify(string genus, string message)		notify(string genus, string message)
	{		{
Line 106:		Line 106:
	}		}
	}		}
	</~~lsl~~>		</source>

	We're doing a number of things here: handling different kids of messages, informational for normal running, error reporting to the owner and creator and debug messages. To turn off debug simply comment out the debug line as shown in the code, and uncomment the genus="off" line to disable all notifications.		We're doing a number of things here: handling different kids of messages, informational for normal running, error reporting to the owner and creator and debug messages. To turn off debug simply comment out the debug line as shown in the code, and uncomment the genus="off" line to disable all notifications.
Line 119:		Line 119:
	We can extend the reuse even further by making this a discreet script on it's own within the object as follows:		We can extend the reuse even further by making this a discreet script on it's own within the object as follows:

	<~~lsl~~>		<source lang="lsl2">
	notify(string genus, string message)		notify(string genus, string message)
	{		{
Line 161:		Line 161:
	}		}
	}		}
	</~~lsl~~>		</source>

	To send a notification you simply use in your implementation:		To send a notification you simply use in your implementation:

	<~~lsl~~>		<source lang="lsl2">
	default		default
	{		{
Line 178:		Line 178:
	}		}
	}		}
	</~~lsl~~>		</source>

	----		----
	Return to [[Good_Building_Practices]]		Return to [[Good_Building_Practices]]

Kireji Haiku: fixed a bug and improved readability

2012-10-31T20:23:39Z

fixed a bug and improved readability

Show changes

Strife Onizuka: /* Error Reporting and Debugging */ I like what the moles have been up to. Keep up the good work.

2012-07-01T03:57:34Z

Error Reporting and Debugging: I like what the moles have been up to. Keep up the good work.

← Older revision		Revision as of 20:57, 30 June 2012
Line 81:		Line 81:
	We're doing a number of things here: handling different kids of messages, informational for normal running, error reporting to the owner and creator and debug messages. To turn off debug simply comment out the debug line as shown in the code, and uncomment the genus="off" line to disable all notifications.		We're doing a number of things here: handling different kids of messages, informational for normal running, error reporting to the owner and creator and debug messages. To turn off debug simply comment out the debug line as shown in the code, and uncomment the genus="off" line to disable all notifications.

	We're using ~~llOwner~~ for the current owner and llInstantMessage for contacting the script creator that will continue to work after ownership has passed - you just have insert your own key at the top.		We're using [[llOwnerSay]] for the current owner and [[llInstantMessage]] for contacting the script creator that will continue to work after ownership has passed - you just have insert your own key at the top.

	Other mechanisms that could be used include llEmail or llHTTPRequest to post a message to an external logging system perhaps.		Other mechanisms that could be used include [[llEmail]] or [[llHTTPRequest]] to post a message to an external logging system perhaps.

	You define your own ~~custome~~ message types and communicate using the most appropriate method.		You define your own custom message types and communicate using the most appropriate method.

	==More Reuse==		==More Reuse==

Strife Onizuka: /* Simple Example */

2012-07-01T03:55:55Z

Simple Example

← Older revision		Revision as of 20:55, 30 June 2012
Line 38:		Line 38:
	if you're working with list, you could use something along the lines of		if you're working with list, you could use something along the lines of

	notify(llList2String(listName, integerIndex)); // notification contains one list element		<lsl>notify(llList2String(listName, integerIndex)); // notification contains one list element</lsl>
	or		or
	notify(llDumpList2String(listName, ",")); notification contains entire list as a string		<lsl>notify(llDumpList2String(listName, ",")); // notification contains entire list as a string</lsl>

	However, the lsl compiler is not an optimizing compiler. This means that even if you disable notify() as shown above (by commenting out its body), you will still suffer a performance hit from converting the list to a string. A better plan would be to create a separate notifyList function which takes a list parameter and dumps it:		However, the lsl compiler is not an optimizing compiler. This means that even if you disable notify() as shown above (by commenting out its body), you will still suffer a performance hit from converting the list to a string. A better plan would be to create a separate notifyList function which takes a list parameter and dumps it:

Strife Onizuka: detabbing. tab -> 4 spaces

2012-07-01T03:54:46Z

detabbing. tab -> 4 spaces

← Older revision		Revision as of 20:54, 30 June 2012
Line 8:		Line 8:
	notify(string msg)		notify(string msg)
	{		{
	llOwnerSay(msg);		llOwnerSay(msg);
	}		}
	</lsl>		</lsl>
Line 32:		Line 32:
	notify(string msg)		notify(string msg)
	{		{
	//llOwnerSay(msg);		//llOwnerSay(msg);
	}		}
	</lsl>		</lsl>
Line 39:		Line 39:

	notify(llList2String(listName, integerIndex)); // notification contains one list element		notify(llList2String(listName, integerIndex)); // notification contains one list element
	or		or
	notify(llDumpList2String(listName, ",")); notification contains entire list as a string		notify(llDumpList2String(listName, ",")); notification contains entire list as a string

Line 47:		Line 47:
	notifyList(list msg)		notifyList(list msg)
	{		{
	llOwnerSay(llDumpList2String(msg, ","));		llOwnerSay(llDumpList2String(msg, ","));
	}		}
	</lsl>		</lsl>
Line 57:		Line 57:
	notify(string genus, string msg)		notify(string genus, string msg)
	{		{
	key creator = "a822ff2b-ff02-461d-b45d-dcd10a2de0c2";		key creator = "a822ff2b-ff02-461d-b45d-dcd10a2de0c2";
	//genus = "off" //uncoment this line to turn notifications off		//genus = "off" //uncoment this line to turn notifications off
	if (genus == "dbg")		if (genus == "dbg")
	{		{
	llInstantMessage(creator, "DEBUG: " + msg); //coment out this line to turn off debugging		llInstantMessage(creator, "DEBUG: " + msg); //coment out this line to turn off debugging
	}		}
	else if (genus == "err")		else if (genus == "err")
	{		{
	llOwnerSay("ERROR: " + msg);		llOwnerSay("ERROR: " + msg);
	llInstantMessage(creator, "ERROR: " + msg + " in object " + llGetObjectName() + " that belongs to " + llKey2Name(llGetOwner()) + " in region " + llGetRegionName());		llInstantMessage(creator, "ERROR: " + msg + " in object " + llGetObjectName() + " that belongs to " + llKey2Name(llGetOwner()) + " in region " + llGetRegionName());
	}		}
	else if (genus == "info")		else if (genus == "info")
	{		{
	llOwnerSay(msg); //no prepend because it's a normal message		llOwnerSay(msg); //no prepend because it's a normal message
	}		}
	else		else
	{		{
	//do nothing, notifications were turned off		//do nothing, notifications were turned off
	}		}
	}		}
	</lsl>		</lsl>
Line 93:		Line 93:
	notify(string genus, string msg)		notify(string genus, string msg)
	{		{
	key creator = "a822ff2b-ff02-461d-b45d-dcd10a2de0c2";		key creator = "a822ff2b-ff02-461d-b45d-dcd10a2de0c2";
	//genus = "off" //uncoment this line to turn notifications off		//genus = "off" //uncoment this line to turn notifications off
	if (genus == "dbg")		if (genus == "dbg")
	{		{
	llInstantMessage(creator, "DEBUG: " + msg); //coment out this line to turn off debugging		llInstantMessage(creator, "DEBUG: " + msg); //coment out this line to turn off debugging
	}		}
	else if (genus == "err")		else if (genus == "err")
	{		{
	llOwnerSay("ERROR: " + msg);		llOwnerSay("ERROR: " + msg);
	llInstantMessage(creator, "ERROR: " + msg + " in object " + llGetObjectName() + " that belongs to " + llKey2Name(llGetOwner()) + " in region " + llGetRegionName());		llInstantMessage(creator, "ERROR: " + msg + " in object " + llGetObjectName() + " that belongs to " + llKey2Name(llGetOwner()) + " in region " + llGetRegionName());
	}		}
	else if (genus == "info")		else if (genus == "info")
	{		{
	llOwnerSay(msg); //no prepend because it's a normal message		llOwnerSay(msg); //no prepend because it's a normal message
	}		}
	else		else
	{		{
	//do nothing, notifications were turned off		//do nothing, notifications were turned off
	}		}
	}		}

	default		default
	{		{
	state_entry()		state_entry()
	{		{
	notify("info", "notification system ready");		notify("info", "notification system ready");
	}		}
	link_message(integer source, integer num, string str, key id)		link_message(integer source, integer num, string str, key id)
	{		{
Line 134:		Line 134:
	touch_start(integer c)		touch_start(integer c)
	{		{
	string msg = llKey2Name(llDetectedKey(0)) + " attempted to steal Mjölnir!";		string msg = llKey2Name(llDetectedKey(0)) + " attempted to steal Mjölnir!";
	llMessageLinked(LINK_SET, 0, "info", msg);		llMessageLinked(LINK_SET, 0, "info", msg);
	//this may seem odd but it's valid to use the key paramter of llMessageLinked as a second string passing facility if not actually used for a key		//this may seem odd but it's valid to use the key paramter of llMessageLinked as a second string passing facility if not actually used for a key

Falcon Linden at 21:51, 30 June 2012

2012-06-30T21:51:13Z

← Older revision		Revision as of 14:51, 30 June 2012
Line 36:		Line 36:
	</lsl>		</lsl>

	if you're working with list use something along the lines of:		if you're working with list, you could use something along the lines of

	notify(llList2String(listName, integerIndex)); // notification contains one list element		notify(llList2String(listName, integerIndex)); // notification contains one list element
	or		or
	notify(llDumpList2String(listName, ",")); notification contains entire list as a string		notify(llDumpList2String(listName, ",")); notification contains entire list as a string

			However, the lsl compiler is not an optimizing compiler. This means that even if you disable notify() as shown above (by commenting out its body), you will still suffer a performance hit from converting the list to a string. A better plan would be to create a separate notifyList function which takes a list parameter and dumps it:

			<lsl>
			notifyList(list msg)
			{
			llOwnerSay(llDumpList2String(msg, ","));
			}
			</lsl>

	==Error Reporting and Debugging==		==Error Reporting and Debugging==

Hyper Mole at 14:17, 24 June 2012

2012-06-24T14:17:22Z

← Older revision		Revision as of 07:17, 24 June 2012
Line 131:		Line 131:
	}		}
	</lsl>		</lsl>

			----
			Return to [[Good_Building_Practices]]

Myopic Mole: corrected spelling of Mjölnir ;-)

2012-06-23T18:55:45Z

corrected spelling of Mjölnir ;-)

← Older revision		Revision as of 11:55, 23 June 2012
Line 125:		Line 125:
	touch_start(integer c)		touch_start(integer c)
	{		{
	string msg = llKey2Name(llDetectedKey(0)) + " attempted to steal ~~Mjolnir~~!";		string msg = llKey2Name(llDetectedKey(0)) + " attempted to steal Mjölnir!";
	llMessageLinked(LINK_SET, 0, "info", msg);		llMessageLinked(LINK_SET, 0, "info", msg);
	//this may seem odd but it's valid to use the key paramter of llMessageLinked as a second string passing facility if not actually used for a key		//this may seem odd but it's valid to use the key paramter of llMessageLinked as a second string passing facility if not actually used for a key

Myopic Mole: added instructions on how to use the discreet debug script that got chopped off the end

2012-06-23T18:52:35Z

added instructions on how to use the discreet debug script that got chopped off the end

@@ Line 113: / Line 113: @@
      link_message(integer source, integer num, string str, key id)
+     {
-         notify(llString2CSV(str, 0), llString2CSV(str, 1));
+         notify(str, key); //we're using the key as a second string parameter
+     }
+}
 </lsl>

Myopic Mole: added several line comments

2012-06-23T18:34:12Z

added several line comments

← Older revision		Revision as of 11:34, 23 June 2012
Line 52:		Line 52:
	if (genus == "dbg")		if (genus == "dbg")
	{		{
	llInstantMessage(creator, "DEBUG: " + msg);		llInstantMessage(creator, "DEBUG: " + msg); //coment out this line to turn off debugging
	}		}
	else if (genus == "err")		else if (genus == "err")
Line 61:		Line 61:
	else if (genus == "info")		else if (genus == "info")
	{		{
	llOwnerSay(msg);		llOwnerSay(msg); //no prepend because it's a normal message
	}		}
	else		else
Line 88:		Line 88:
	if (genus == "dbg")		if (genus == "dbg")
	{		{
	llInstantMessage(creator, "DEBUG: " + msg);		llInstantMessage(creator, "DEBUG: " + msg); //coment out this line to turn off debugging
	}		}
	else if (genus == "err")		else if (genus == "err")
Line 97:		Line 97:
	else if (genus == "info")		else if (genus == "info")
	{		{
	llOwnerSay(msg);		llOwnerSay(msg); //no prepend because it's a normal message
	}		}
	else		else