Assert statement - Revision history

JAL: add 7.7 Info expression support

2016-08-31T00:52:16Z

add 7.7 Info expression support

← Older revision		Revision as of 00:52, 31 August 2016
Line 16:		Line 16:

	<tr><th><var>Info</var></th>		<tr><th><var>Info</var></th>
	<td>Extra information that is included in the audit trail and terminal output for the assertion failure as part of an MSIR.0494 message. If <var class="term">info</var> is a %variable, the contents of the indicated variable is output. <var class="term">info</var> ~~must be enclosed in quotes if it~~ contains spaces or other <var class="product">Model 204</var> separator characters. If <var class="term">info</var> is not a %variable, and is not enclosed in quotes, the uppercased literal string is output.		<td>Extra information that is included in the audit trail and terminal output for the assertion failure as part of an MSIR.0494 message.
	</td></tr>		<p>
			If <var class="term">info</var> is a %variable, the contents of the indicated variable is output. If <var class="term">info</var> contains spaces or other <var class="product">Model 204</var> separator characters, it must be enclosed in quotes. If <var class="term">info</var> is not a %variable and is not enclosed in quotes, the uppercased literal string is output. </p>
			<p>
			As of version 7.7, <var class="term">info</var> can also be any valid SOUL expression, including a SOUL OO method call, $function, or even a [[Local methods#Defining and invoking a local method\|local function]]. The expression, which must be enclosed in parentheses, is evaluated only in the case of an <var>Assert</var> failure. See the "Examples" section, below.</p></td></tr>

	<tr><th><var>Continue</var></th>		<tr><th><var>Continue</var></th>
Line 38:		Line 41:

	assert %income gt 10000000, info highroller continue		assert %income gt 10000000, info highroller continue

			assert %x gt 0, info ('abc' with 'def')

			assert %ls ne "22", info ((%x:a with ' xxx ' with %x:a):right(50, pad='*'))
	</p>		</p>

Line 44:		Line 51:
	above (<code>assert %x = 22, info %x</code>) produces the following message if <code>%x</code> is 21: </p>		above (<code>assert %x = 22, info %x</code>) produces the following message if <code>%x</code> is 21: </p>
	<p class="output">MSIR.0494: Assert info: 21</p>		<p class="output">MSIR.0494: Assert info: 21</p>
	</blockquote>		<p>
			In the next-to-last example above, if the <var>Info</var> argument was simply <code>info ( </code>, the <var>Assert</var> would fail to compile in version 7.7 and higher because it had no closing parenthesis. But prior to 7.7, the compiler does not consider expressions, and the statement compiles without error. </p>
			<p>
			Also, be aware that an error in an expression in the <var>Info</var> clause might only be noticed upon an <var>Assert</var> failure. For example, in the last <var>Assert</var> statement example above, if the 50 in the <var>Right</var> function is changed to <code>-50</code>, and the <var>Assert</var> check fails, you get a message about an error in the <var>Right</var> function instead of an <var>Assert</var> failure message.</p></blockquote>

	==Usage notes==		==Usage notes==
	An <var>Assert</var> statement uses the same expression handler as the <var>If</var> statement, so it is exactly as efficient as an <var>If</var> statement with the same conditions.		<ul>
			<li>An <var>Assert</var> statement uses the same expression handler as the <var>If</var> statement, so it is exactly as efficient as an <var>If</var> statement with the same conditions. </li>

	To use an <var>Assert</var>, simply place it before any code that depends on some assumptions		<li>To use an <var>Assert</var>, simply place it before any code that depends on some assumptions
	about variables or the environment. <var>Assert</var> statements should be coded to test values		about variables or the environment. <var>Assert</var> statements should be coded to test values
	or relationships that are required for the code to run correctly but whose values are not		or relationships that are required for the code to run correctly but whose values are not immediately apparent from the surrounding code.
	immediately apparent from the surrounding code.
	In addition to catching coding errors, the <var>Assert</var> statement provides the following benefits:		In addition to catching coding errors, the <var>Assert</var> statement provides the following benefits:
	<ul>		<ul>
Line 58:		Line 68:

	<li>It eliminates doubt when you are scanning code trying to debug a problem, and it prevents wasted time on "what if" scenarios that can be ruled out with a simple <var>Assert</var>. </li>		<li>It eliminates doubt when you are scanning code trying to debug a problem, and it prevents wasted time on "what if" scenarios that can be ruled out with a simple <var>Assert</var>. </li>
			</ul></li>
	</ul>		</ul>

JAL: link repair

2016-03-02T01:46:05Z

link repair

← Older revision		Revision as of 01:46, 2 March 2016
Line 89:		Line 89:
	* It tests the validity of an assumption.		* It tests the validity of an assumption.
	* It causes the current request to be cancelled if the assumption is incorrect. In an APSY subsystem, this causes transfer to the subsystem error procedure.		* It causes the current request to be cancelled if the assumption is incorrect. In an APSY subsystem, this causes transfer to the subsystem error procedure.
	* It indicates the procedure and line number containing the failing <var>Assert</var> statement. Furthermore, in the presence of appropriate <var>SIRFACT MAXDUMP</var> and <var>SIRFACT DUMP</var> settings, it causes the creation of a <var class="product">SirFact</var> dump that contains a wide variety of information about the program environment at the time of the error. For more information about <var class="product">SirFact</var> dumps, see the <var class="book">[http://m204wiki.rocketsoftware.com/images/f/fb/FactrNew.pdf Rocket M204 SirFact Reference Manual]</var>.		* It indicates the procedure and line number containing the failing <var>Assert</var> statement. Furthermore, in the presence of appropriate <var>[[SIRFACT command#SIRFACT MAXDUMP\|SIRFACT MAXDUMP]]</var> and <var>[[SIRFACT command#SIRFACT DUMP\|SIRFACT DUMP]]</var> settings, it causes the creation of a <var class="product">SirFact</var> dump that contains a wide variety of information about the program environment at the time of the error.

	Stated another way, the <var>Assert</var> statement allows testing of assumptions and extensive		Stated another way, the <var>Assert</var> statement allows testing of assumptions and extensive

JAL: minor formatting

2016-02-26T17:39:05Z

minor formatting

← Older revision		Revision as of 17:39, 26 February 2016
Line 40:		Line 40:
	</p>		</p>

	<p class="note">~~'''~~Note:~~'''~~ A %variable in the <var>Info</var> clause is interpreted to mean the contents of the indicated variable. For example, the fourth <var>Assert</var> statement		<blockquote class="note">
			<p><b>Note:</b> A %variable in the <var>Info</var> clause is interpreted to mean the contents of the indicated variable. For example, the fourth <var>Assert</var> statement
	above (<code>assert %x = 22, info %x</code>) produces the following message if <code>%x</code> is 21: </p>		above (<code>assert %x = 22, info %x</code>) produces the following message if <code>%x</code> is 21: </p>
	<p class="output">MSIR.0494: Assert info: 21</p>		<p class="output">MSIR.0494: Assert info: 21</p>
			</blockquote>

	==Usage notes==		==Usage notes==

JAL at 19:40, 2 July 2014

2014-07-02T19:40:12Z

← Older revision		Revision as of 19:40, 2 July 2014
Line 1:		Line 1:
	The <var>Assert</var> statement tests a condition. A false condition can send diagnostic		The <var>Assert</var> statement tests a condition. A false condition can send diagnostic
	information to the terminal output and audit trail, and/or it can result in cancellation		information to the terminal output and audit trail, and/or it can result in cancellation
	of the <var class="product">~~User Language~~</var> request.		of the <var class="product">[[SOUL]]</var> request.

	==Syntax==		==Syntax==
Line 8:		Line 8:

	===Syntax terms===		===Syntax terms===
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>cond</th>		<tr><th>cond</th>
	<td>The conditions that are being asserted as true. These conditions have exactly the same syntax as conditions on IF statements.</td></tr>		<td>The conditions that are being asserted as true. These conditions have exactly the same syntax as conditions on <var>IF</var> statements.</td></tr>

	<tr><th><var>Snap</var></th>		<tr><th><var>Snap</var></th>
	<td>Indicates a CCASNAP is to be taken on an assertion failure. A CCASNAP is taken in addition to, but before, any <var class="product">SirFact</var> dump associated with the assertion failure.</td></tr>		<td>Indicates a CCASNAP is to be taken on an assertion failure. A CCASNAP is taken in addition to, but before, any <var class="product">[[SirFact]]</var> dump associated with the assertion failure.</td></tr>

	<tr><th><var>Info</var></th>		<tr><th><var>Info</var></th>
	<td>Extra information that is included in the audit trail and terminal output for the assertion failure as part of an MSIR.0494 message. ~~As of <var class="product">Sirius Mods</var> version 6.7, if~~ <var class="term">info</var> is a %variable, the contents of the indicated variable is output. <var class="term">info</var> must be enclosed in quotes if it contains spaces or other <var class="product">Model 204</var> separator characters. If <var class="term">info</var> is not a %variable, and is not enclosed in quotes, the uppercased literal string is output.		<td>Extra information that is included in the audit trail and terminal output for the assertion failure as part of an MSIR.0494 message. If <var class="term">info</var> is a %variable, the contents of the indicated variable is output. <var class="term">info</var> must be enclosed in quotes if it contains spaces or other <var class="product">Model 204</var> separator characters. If <var class="term">info</var> is not a %variable, and is not enclosed in quotes, the uppercased literal string is output.
	</td></tr>		</td></tr>

	<tr><th><var>Continue</var></th>		<tr><th><var>Continue</var></th>
	<td>Indicates that an assertion failure does not cause the request to be cancelled. An MSIR.0494 message, and possibly a <var class="product">SirFact</var> dump, will still be produced, but the request continues.</td></tr>		<td>Indicates that an assertion failure does not cause the request to be cancelled. An MSIR.0494 message, and possibly a <var class="product">SirFact</var> dump, will still be produced, but the request continues.</td></tr>
Line 37:		Line 40:
	</p>		</p>

	'''Note:''' ~~As of <var class="product">Sirius Mods</var> version 6.7, a~~ %variable in the <var>Info</var> clause is interpreted to mean the contents of the indicated variable. For example, the fourth <var>Assert</var> statement		<p class="note">'''Note:''' A %variable in the <var>Info</var> clause is interpreted to mean the contents of the indicated variable. For example, the fourth <var>Assert</var> statement
	above (<code>assert %x = 22, info %x</code>) produces the following message if <code>%x</code> is 21:		above (<code>assert %x = 22, info %x</code>) produces the following message if <code>%x</code> is 21: </p>
	<p class="output">MSIR.0494: Assert info: 21</p>		<p class="output">MSIR.0494: Assert info: 21</p>

	~~For versions prior to 6.7, an unquoted %variable name is interpreted as a literal, and the message produced is:~~		==Usage notes==
	~~<p class="output">MSIR.0494: Assert info: %X</p>~~
	==Usage notes==

	An <var>Assert</var> statement uses the same expression handler as the <var>If</var> statement, so it is exactly as efficient as an <var>If</var> statement with the same conditions.		An <var>Assert</var> statement uses the same expression handler as the <var>If</var> statement, so it is exactly as efficient as an <var>If</var> statement with the same conditions.

Line 53:		Line 53:
	In addition to catching coding errors, the <var>Assert</var> statement provides the following benefits:		In addition to catching coding errors, the <var>Assert</var> statement provides the following benefits:
	<ul>		<ul>
	<li>It makes clear to anyone scanning the program the assumptions on which the code depends. This makes it easier to understand the surrounding code. Similarly, it makes the environmental requirements clear to someone wanting to reuse a code fragment or call a common subroutine. While these benefits can be achieved with comments, the <var>Assert</var> statement has the added benefit that it enforces the restrictions.		<li>It makes clear to anyone scanning the program the assumptions on which the code depends. This makes it easier to understand the surrounding code. Similarly, it makes the environmental requirements clear to someone wanting to reuse a code fragment or call a common subroutine. While these benefits can be achieved with comments, the <var>Assert</var> statement has the added benefit that it enforces the restrictions. </li>
	<li>It eliminates doubt when you are scanning code trying to debug a problem, and it prevents wasted time on "what if" scenarios that can be ruled out with a simple <var>Assert</var>.
			<li>It eliminates doubt when you are scanning code trying to debug a problem, and it prevents wasted time on "what if" scenarios that can be ruled out with a simple <var>Assert</var>. </li>
	</ul>		</ul>

Line 86:		Line 87:
	* It tests the validity of an assumption.		* It tests the validity of an assumption.
	* It causes the current request to be cancelled if the assumption is incorrect. In an APSY subsystem, this causes transfer to the subsystem error procedure.		* It causes the current request to be cancelled if the assumption is incorrect. In an APSY subsystem, this causes transfer to the subsystem error procedure.
	* It indicates the procedure and line number containing the failing <var>Assert</var> statement. Furthermore, in the presence of appropriate <var>SIRFACT MAXDUMP</var> and <var>SIRFACT DUMP</var> settings, it causes the creation of a <var class="product">SirFact</var> dump that contains a wide variety of information about the program environment at the time of the error. For more information about <var class="product">SirFact</var> dumps, see the <var class="~~product~~">[http://~~sirius-software~~.com/~~maint~~/~~download~~/~~factr~~.pdf SirFact Reference Manual]</var>.		* It indicates the procedure and line number containing the failing <var>Assert</var> statement. Furthermore, in the presence of appropriate <var>SIRFACT MAXDUMP</var> and <var>SIRFACT DUMP</var> settings, it causes the creation of a <var class="product">SirFact</var> dump that contains a wide variety of information about the program environment at the time of the error. For more information about <var class="product">SirFact</var> dumps, see the <var class="book">[http://m204wiki.rocketsoftware.com/images/f/fb/FactrNew.pdf Rocket M204 SirFact Reference Manual]</var>.

	Stated another way, the <var>Assert</var> statement allows testing of assumptions and extensive		Stated another way, the <var>Assert</var> statement allows testing of assumptions and extensive
	diagnostic data collection with a single, simple statement.		diagnostic data collection with a single, simple statement.

	[[Category:User Language statements]]		[[Category:User Language statements]]

DCameron at 14:19, 13 August 2013

2013-08-13T14:19:02Z

← Older revision		Revision as of 14:19, 13 August 2013
Line 1:		Line 1:
	The <var>Assert</var> statement tests a condition. A ~~true~~ condition can send diagnostic		The <var>Assert</var> statement tests a condition. A false condition can send diagnostic
	information to the terminal output and audit trail, and/or it can result in cancellation		information to the terminal output and audit trail, and/or it can result in cancellation
	of the <var class="product">User Language</var> request.		of the <var class="product">User Language</var> request.

Alex: /* Discussion */

2013-01-10T14:48:30Z

Discussion

← Older revision		Revision as of 14:48, 10 January 2013
Line 86:		Line 86:
	* It tests the validity of an assumption.		* It tests the validity of an assumption.
	* It causes the current request to be cancelled if the assumption is incorrect. In an APSY subsystem, this causes transfer to the subsystem error procedure.		* It causes the current request to be cancelled if the assumption is incorrect. In an APSY subsystem, this causes transfer to the subsystem error procedure.
	* It indicates the procedure and line number containing the failing <var>Assert</var> statement. Furthermore, in the presence of appropriate <var>SIRFACT MAXDUMP</var> and <var>SIRFACT DUMP</var> settings, it causes the creation of a <var class="product">SirFact</var> dump that contains a wide variety of information about the program environment at the time of the error. For more information about <var class="product">SirFact</var> dumps, see the <var class="product">[http://sirius-software.com/maint/~~downloads~~/factr.pdf SirFact Reference Manual]</var>.		* It indicates the procedure and line number containing the failing <var>Assert</var> statement. Furthermore, in the presence of appropriate <var>SIRFACT MAXDUMP</var> and <var>SIRFACT DUMP</var> settings, it causes the creation of a <var class="product">SirFact</var> dump that contains a wide variety of information about the program environment at the time of the error. For more information about <var class="product">SirFact</var> dumps, see the <var class="product">[http://sirius-software.com/maint/download/factr.pdf SirFact Reference Manual]</var>.

	Stated another way, the <var>Assert</var> statement allows testing of assumptions and extensive		Stated another way, the <var>Assert</var> statement allows testing of assumptions and extensive
	diagnostic data collection with a single, simple statement.		diagnostic data collection with a single, simple statement.
	[[Category:User Language statements]]		[[Category:User Language statements]]

JAL2 at 22:01, 22 February 2012

2012-02-22T22:01:21Z

← Older revision		Revision as of 22:01, 22 February 2012
Line 2:		Line 2:
	information to the terminal output and audit trail, and/or it can result in cancellation		information to the terminal output and audit trail, and/or it can result in cancellation
	of the <var class="product">User Language</var> request.		of the <var class="product">User Language</var> request.

	==Syntax==		==Syntax==
	<p class="syntax"><span class="literal">Assert </span><span class="term">cond</span><span class="squareb"> [</span><span class="literal">, </span><span class="squareb">[</span><span class="literal">Snap</span><span class="squareb">] [</span><span class="literal">Info </span><span class="term">info</span><span class="squareb">] [</span><span class="literal">Continue</span><span class="squareb">] ]</span>		<p class="syntax"><span class="literal">Assert </span><span class="term">cond</span><span class="squareb"> [</span><span class="literal">, </span><span class="squareb">[</span><span class="literal">Snap</span><span class="squareb">] [</span><span class="literal">Info </span><span class="term">info</span><span class="squareb">] [</span><span class="literal">Continue</span><span class="squareb">] ]</span>
	</p>		</p>

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>cond</th><td>The conditions that are being asserted as true. These conditions have exactly the same syntax as conditions on IF statements.</td></tr>		<tr><th>cond</th>
	<tr><th><var>Snap</var></th><td>Indicates a CCASNAP is to be taken on an assertion failure. A CCASNAP is taken in addition to, but before, any SirFact dump associated with the assertion failure.</td></tr>		<td>The conditions that are being asserted as true. These conditions have exactly the same syntax as conditions on IF statements.</td></tr>
	<tr><th>~~info~~</th><td>Extra information that is included in the audit trail and terminal output for the assertion failure as part of a MSIR.0494 message. As of <var class="product">Sirius Mods</var> version 6.7, if <var class="term">info</var> is a %variable, the contents of the indicated variable is output. <var class="term">info</var> must be enclosed in quotes if it contains spaces or other <var class="product">Model 204</var> separator characters. If <var class="term">info</var> is not a %variable, and is not enclosed in quotes, ~~that~~ uppercased literal string is output.		<tr><th><var>Snap</var></th>
			<td>Indicates a CCASNAP is to be taken on an assertion failure. A CCASNAP is taken in addition to, but before, any <var class="product">SirFact</var> dump associated with the assertion failure.</td></tr>
			<tr><th><var>Info</var></th>
			<td>Extra information that is included in the audit trail and terminal output for the assertion failure as part of an MSIR.0494 message. As of <var class="product">Sirius Mods</var> version 6.7, if <var class="term">info</var> is a %variable, the contents of the indicated variable is output. <var class="term">info</var> must be enclosed in quotes if it contains spaces or other <var class="product">Model 204</var> separator characters. If <var class="term">info</var> is not a %variable, and is not enclosed in quotes, the uppercased literal string is output.
	</td></tr>		</td></tr>
	<tr><th><var>Continue</var></th><td>Indicates that an assertion failure ~~will~~ not cause the request to be cancelled. An MSIR.0494 message, and possibly a SirFact dump, will still be produced, but the request ~~will continue~~.</td></tr>		<tr><th><var>Continue</var></th>
			<td>Indicates that an assertion failure does not cause the request to be cancelled. An MSIR.0494 message, and possibly a <var class="product">SirFact</var> dump, will still be produced, but the request continues.</td></tr>
	</table>		</table>

	==Examples==		==Examples==
	Some valid <var>Assert</var> statements are:		Some valid <var>Assert</var> statements are:
	<p class="code"> assert (%x gt 0) and (%name ne <nowiki>''</nowiki>)		<p class="code">assert (%x gt 0) and (%name ne <nowiki>''</nowiki>)
	assert %x gt 0, snap
	assert not $setg('name', 'value')		assert %x gt 0, snap
	assert %x = 22, info %x
	assert %x, info 'zero %x' snap		assert not $setg('name', 'value')
	assert %income gt 10000, continue
	assert %income gt 10000000, info highroller continue		assert %x = 22, info %x

			assert %x, info 'zero %x' snap

			assert %income gt 10000, continue

			assert %income gt 10000000, info highroller continue
	</p>		</p>

	''Note:'' As of Sirius Mods version 6.7, a %variable in the Info clause is interpreted to mean the contents of the indicated variable. For example, the fourth <var>Assert</var> statement		'''Note:''' As of <var class="product">Sirius Mods</var> version 6.7, a %variable in the <var>Info</var> clause is interpreted to mean the contents of the indicated variable. For example, the fourth <var>Assert</var> statement
	above (<code>assert %x = 22, info %x</code>) produces the following message if <code>%x</code> is 21:		above (<code>assert %x = 22, info %x</code>) produces the following message if <code>%x</code> is 21:
	<p class="output">MSIR.0494: Assert info: 21</p>		<p class="output">MSIR.0494: Assert info: 21</p>
Line 32:		Line 45:
	==Usage notes==		==Usage notes==

	An <var>Assert</var> statement uses the same expression handler as the IF statement, so it is exactly as efficient as an IF statement with the same conditions.		An <var>Assert</var> statement uses the same expression handler as the <var>If</var> statement, so it is exactly as efficient as an <var>If</var> statement with the same conditions.

	To use an <var>Assert</var>, simply place it before any code that depends on some assumptions		To use an <var>Assert</var>, simply place it before any code that depends on some assumptions
	about variables or the environment. <var>Assert</var> statements should be coded to test values		about variables or the environment. <var>Assert</var> statements should be coded to test values
	or relationships that are required for the code to run correctly, but whose values are not		or relationships that are required for the code to run correctly but whose values are not
	immediately apparent from the surrounding code.		immediately apparent from the surrounding code.
	In addition to catching coding errors, the <var>Assert</var> statement provides the following		In addition to catching coding errors, the <var>Assert</var> statement provides the following benefits:
	benefits:		<ul>
	*It makes clear to anyone scanning the program the assumptions on which the code depends. This makes it easier to understand the surrounding code. Similarly, it makes the environmental requirements clear to someone wanting to reuse a code fragment or call a common subroutine. While these benefits can be achieved with comments, the <var>Assert</var> statement has the added benefit that it enforces the restrictions.		<li>It makes clear to anyone scanning the program the assumptions on which the code depends. This makes it easier to understand the surrounding code. Similarly, it makes the environmental requirements clear to someone wanting to reuse a code fragment or call a common subroutine. While these benefits can be achieved with comments, the <var>Assert</var> statement has the added benefit that it enforces the restrictions.
	*It eliminates doubt when you are scanning code trying to debug a problem, and it prevents wasted time on "what if" scenarios that can be ruled out with a simple <var>Assert</var>.		<li>It eliminates doubt when you are scanning code trying to debug a problem, and it prevents wasted time on "what if" scenarios that can be ruled out with a simple <var>Assert</var>.
			</ul>

	==Discussion==		==Discussion==
Line 67:		Line 81:
	The last solution looks the most appealing. However, without the <var>Assert</var> statement,		The last solution looks the most appealing. However, without the <var>Assert</var> statement,
	collecting the appropriate diagnostic information can only be done in User Language, so		collecting the appropriate diagnostic information can only be done in User Language, so
	it can be tedious (numerous ~~AUDIT~~, ~~PRINT~~, or $~~SETG~~ statements), and it still provides		it can be tedious (numerous <var>Audit</var>, <var>Print</var>, or <var>$Setg</var> statements), and it still provides
	only limited information.		only limited information.
	The Sirius Mods provides a User Language ~~statement,~~ <var>Assert</var>, to get around these		The <var class="product">Sirius Mods</var> provides the <var class="product">User Language</var> <var>Assert</var> statement to get around these problems. The <var>Assert</var> statement serves three functions:
	problems. The <var>Assert</var> statement serves three functions:
	* It tests the validity of an assumption.		* It tests the validity of an assumption.
	* It causes the current request to be cancelled if the assumption is incorrect. In an APSY subsystem, this causes transfer to the subsystem error procedure.		* It causes the current request to be cancelled if the assumption is incorrect. In an APSY subsystem, this causes transfer to the subsystem error procedure.
	* It indicates the procedure and line number containing the failing <var>Assert</var> statement. Furthermore, in the presence of appropriate SIRFACT MAXDUMP and SIRFACT DUMP settings, it causes the creation of a SirFact dump that contains a wide variety of information about the program environment at the time of the error. For more information about SirFact dumps, see the SirFact Reference Manual.		* It indicates the procedure and line number containing the failing <var>Assert</var> statement. Furthermore, in the presence of appropriate <var>SIRFACT MAXDUMP</var> and <var>SIRFACT DUMP</var> settings, it causes the creation of a <var class="product">SirFact</var> dump that contains a wide variety of information about the program environment at the time of the error. For more information about <var class="product">SirFact</var> dumps, see the <var class="product">[http://sirius-software.com/maint/downloads/factr.pdf SirFact Reference Manual]</var>.

	Stated another way, the <var>Assert</var> statement allows testing of assumptions and extensive		Stated another way, the <var>Assert</var> statement allows testing of assumptions and extensive
	diagnostic data collection with a single, simple statement.		diagnostic data collection with a single, simple statement.
	[[Category:User Language statements]]		[[Category:User Language statements]]

JAL2: /* Usage notes */

2012-02-22T21:24:26Z

Usage notes

← Older revision		Revision as of 21:24, 22 February 2012
Line 39:		Line 39:
	immediately apparent from the surrounding code.		immediately apparent from the surrounding code.
	In addition to catching coding errors, the <var>Assert</var> statement provides the following		In addition to catching coding errors, the <var>Assert</var> statement provides the following
	benefits :		benefits:
	*It makes clear the assumptions ~~that~~ the code depends ~~on to anyone scanning the program~~. This makes it easier to understand the surrounding code. Similarly, it makes the environmental requirements clear to someone wanting to ~~re-use~~ a code fragment or call a common subroutine. While these benefits can be achieved with comments, the <var>Assert</var> statement has the added benefit that it enforces the restrictions.		*It makes clear to anyone scanning the program the assumptions on which the code depends. This makes it easier to understand the surrounding code. Similarly, it makes the environmental requirements clear to someone wanting to reuse a code fragment or call a common subroutine. While these benefits can be achieved with comments, the <var>Assert</var> statement has the added benefit that it enforces the restrictions.
	*It eliminates doubt when scanning code ~~while~~ trying to debug a problem, and it prevents wasted time on ~~�what if�~~ scenarios that can be ruled out with a simple <var>Assert</var>.		*It eliminates doubt when you are scanning code trying to debug a problem, and it prevents wasted time on "what if" scenarios that can be ruled out with a simple <var>Assert</var>.

	==Discussion==		==Discussion==
	Programming errors often cause symptoms that point directly to the error. For example,		Programming errors often cause symptoms that point directly to the error. For example,

Dme at 10:25, 7 February 2012

2012-02-07T10:25:22Z

Show changes

Dme at 09:57, 7 February 2012

2012-02-07T09:57:03Z

← Older revision		Revision as of 09:57, 7 February 2012
Line 36:		Line 36:
	</p>		</p>
	===Syntax terms===		===Syntax terms===
	<table ~~border~~="2">		<table class="syntaxTable">
	<tr><th>~~Parameter~~</th~~><th>Definition</th></tr>~~		<tr><th>cond</th><td>The conditions that are being asserted as true. These conditions have exactly the same syntax as conditions on IF statements.</td></tr>
	~~<tr><td><i>cond</i></td~~><td>The conditions that are being asserted as true. These conditions have exactly the same syntax as conditions on IF statements.</td></tr>		<tr><th><var>SNAP</var></th><td>Indicates a CCASNAP is to be taken on an assertion failure. A CCASNAP is taken in addition to, but before, any SirFact dumpassociated with the assertion failure.</td></tr>
	<tr><td>SNAP</td><td>Indicates a CCASNAP is to be taken on an assertion failure. A CCASNAP is taken in addition to, but before, any SirFact dumpassociated with the assertion failure.</td></tr>		<tr><th>info</th><td>Extra information that is included in the audit trail and terminal output for the assertion failure as part of a MSIR.0494 message. As of <var class="product">Sirius Mods</var> version 6.7, if <var class="term">info</var> is a %variable, the contents of the indicated variable is output. <var class="term">info</var> must be enclosed in quotes if it contains spaces or other <var class="product">Model 204</var> separator characters.</td></tr>
	<tr><td>info</td><td>Extra information that is included in the audit trail and terminal output for the assertion failure as part of a MSIR.0494 message. info must be enclosed in quotes if it contains spaces or other Model 204 separator characters.</td></tr>		<tr><th><var>CONTINUE</var></th><td>Indicates that an assertion failure will not cause the request to be cancelled. An MSIR.0494 message, and possibly a SirFact dump, will still be produced, but the request will continue.</td></tr>
	<tr><td>CONTINUE</td><td>Indicates that an assertion failure will not cause the request to be cancelled. An MSIR.0494 message, and possibly a SirFact dump, will still be produced, but the request will continue.</td></tr>
	</table>		</table>
	==Examples==		==Examples==
	Some valid <var>Assert</var> statements are:		Some valid <var>Assert</var> statements are:
	<p class="code"> ASSERT (%X GT 0) AND (%NAME NE '')		<p class="code"> ASSERT (%X GT 0) AND (%NAME NE <nowiki>''</nowiki>)
	~~ASSERT~~ %X GT 0, ~~SNAP~~		assert %x GT 0, snap
	ASSERT NOT $SETG('NAME', 'VALUE')		ASSERT NOT $SETG('NAME', 'VALUE')
	ASSERT %X = 22, INFO %X		ASSERT %X = 22, INFO %X