Longstrings - Revision history

JAL: typo

2015-03-27T20:42:29Z

typo

← Older revision		Revision as of 20:42, 27 March 2015
Line 125:		Line 125:
	The result is a <code>10</code> being assigned to <code>%short</code> with no warnings, exactly the behavior if <code>%long</code> were a <code>String Len 255</code>.		The result is a <code>10</code> being assigned to <code>%short</code> with no warnings, exactly the behavior if <code>%long</code> were a <code>String Len 255</code>.

	<div id="longstrInvIndex"></~~var~~>		<div id="longstrInvIndex"></div>
	====Longstrings not allowed as index %variable in For statement====		====Longstrings not allowed as index %variable in For statement====
	<!--Caution: <div> above-->		<!--Caution: <div> above-->

JAL: minor cleanup

2015-03-27T20:28:02Z

minor cleanup

Show changes

Dme: /* Longstrings in expressions */

2015-03-27T18:42:42Z

Longstrings in expressions

← Older revision		Revision as of 18:42, 27 March 2015
Line 70:		Line 70:

	One important point to keep in mind is that <var class="product">Model 204's</var> expression processing behavior is not changed at all unless <var>Longstring</var> variables or $functions are used, and then only changed in the statements where they are actually used. So the effect of any use of <var>Longstring</var> variables or $functions is limited to the statements that use them.		One important point to keep in mind is that <var class="product">Model 204's</var> expression processing behavior is not changed at all unless <var>Longstring</var> variables or $functions are used, and then only changed in the statements where they are actually used. So the effect of any use of <var>Longstring</var> variables or $functions is limited to the statements that use them.

			===Concatenation - the With operator===

	<var class="product">SOUL</var> expressions can have embedded sub-expressions or simply expressions. For example, in		<var class="product">SOUL</var> expressions can have embedded sub-expressions or simply expressions. For example, in
	<p class="code">%x = %a with %b with %c		<p class="code">%x = %a with %b with %c
Line 126:		Line 128:

	<div id="longstrInvIndex"></var>		<div id="longstrInvIndex"></var>
	====Longstrings not allowed as ~~<var>For<var>~~ index %variable====		====Longstrings not allowed as index %variable in For statement====
	<!--Caution: <div> above-->		<!--Caution: <div> above-->

Dme: /* Longstrings in expressions */

2015-03-27T18:33:18Z

Longstrings in expressions

← Older revision		Revision as of 18:33, 27 March 2015
Line 68:		Line 68:
	==Longstrings in expressions==		==Longstrings in expressions==
	Like <var>Strings</var>, a <var>Longstring</var> variable can be used in <var class="product">SOUL</var> expressions, as operands or as input to $functions. <var>Longstring</var> variables can also be used as input to intrinsic methods (as can any other string or numeric datatype).		Like <var>Strings</var>, a <var>Longstring</var> variable can be used in <var class="product">SOUL</var> expressions, as operands or as input to $functions. <var>Longstring</var> variables can also be used as input to intrinsic methods (as can any other string or numeric datatype).

			One important point to keep in mind is that <var class="product">Model 204's</var> expression processing behavior is not changed at all unless <var>Longstring</var> variables or $functions are used, and then only changed in the statements where they are actually used. So the effect of any use of <var>Longstring</var> variables or $functions is limited to the statements that use them.

	<var class="product">SOUL</var> expressions can have embedded sub-expressions or simply expressions. For example, in		<var class="product">SOUL</var> expressions can have embedded sub-expressions or simply expressions. For example, in
Line 107:		Line 109:
	</p>		</p>
	<code>%short</code> ends up containing an asterisk followed by the first 9 bytes of <code>%long</code>. The assignment is made with silent truncation, because the result of a non-longstring-capable $function is always treated as a regular <var>String</var> for the purposes of assignment and <var>With</var> processing.		<code>%short</code> ends up containing an asterisk followed by the first 9 bytes of <code>%long</code>. The assignment is made with silent truncation, because the result of a non-longstring-capable $function is always treated as a regular <var>String</var> for the purposes of assignment and <var>With</var> processing.

			===Numeric conversion===

	In a context where a <var>Longstring</var> is automatically converted to a numeric datatype, a request-cancelling truncation error occurs if the <var>Longstring</var> variable is longer than 255 bytes, even if most or all of these bytes are leading zeros. For example, <code>%long</code> is a <var>Longstring</var> with 300 zeros followed by a one:		In a context where a <var>Longstring</var> is automatically converted to a numeric datatype, a request-cancelling truncation error occurs if the <var>Longstring</var> variable is longer than 255 bytes, even if most or all of these bytes are leading zeros. For example, <code>%long</code> is a <var>Longstring</var> with 300 zeros followed by a one:
	<p class="code">%a = %long + 1		<p class="code">%a = %long + 1
	</p>		</p>
	The result is a request-cancelling truncation error. Fortunately, it's not likely that one is likely to encounter numbers with greater than 255 digits in them. <var>Longstring</var> data used in a numeric context will undergo the dubious automatic conversion of invalid numeric data into a zero in the same way as <var>String</var> data. <b><i>Note:</i></b> One case of automatic conversion to numeric where <var>String</var> and <var>Longstring</var> behaviors differ is index loop control variables. For example, the following loop is valid if <code>%s</code> is a <var>String</var>, but it results in a compilation error if <code>%s</code> is a <var>Longstring</var>:		The result is a request-cancelling truncation error. Fortunately, it's not likely that one is likely to encounter numbers with greater than 255 digits in them. <var>Longstring</var> data used in a numeric context will undergo the dubious automatic conversion of invalid numeric data into a zero in the same way as <var>String</var> data.
	~~<p class="code">for %s from 1 to 2~~
	~~print %s~~
	~~end for~~
	~~</p>~~

	If the result of a numeric operation on a <var>Longstring</var> is then used in a <var>With</var> operation, the <var>With</var> operation is not upgraded to a <var>Longstring</var> <var>With</var> operation, because the intermediate result of the numeric operation is not a <var>Longstring</var> but a numeric, which is then automatically converted to a <var>String</var> intermediate result. For example, <code>%long</code> is a <var>Longstring</var> containing <code>99</code> and <code>%short</code> is <code>String Len 2</code>:		If the result of a numeric operation on a <var>Longstring</var> is then used in a <var>With</var> operation, the <var>With</var> operation is not upgraded to a <var>Longstring</var> <var>With</var> operation, because the intermediate result of the numeric operation is not a <var>Longstring</var> but a numeric, which is then automatically converted to a <var>String</var> intermediate result. For example, <code>%long</code> is a <var>Longstring</var> containing <code>99</code> and <code>%short</code> is <code>String Len 2</code>:
Line 124:		Line 124:
	</p>		</p>
	results in a <code>10</code> being assigned to <code>%short</code> with no warnings, exactly the behavior if <code>%long</code> were a <code>String Len 255</code>.		results in a <code>10</code> being assigned to <code>%short</code> with no warnings, exactly the behavior if <code>%long</code> were a <code>String Len 255</code>.

			<div id="longstrInvIndex"></var>
			====Longstrings not allowed as <var>For<var> index %variable====
			<!--Caution: <div> above-->

			One case of automatic conversion to numeric where <var>String</var> and <var>Longstring</var> behaviors differ is index loop control variables. For example, the following loop is valid if <code>%s</code> is a <var>String</var>, but it results in a compilation error if <code>%s</code> is a <var>Longstring</var>:
			<p class="code">for %s from 1 to 2
			print %s
			end for
			</p>

			===Comparisons===

	Comparison operations such as <var>Eq</var>, <var>Lt</var>, <var>Le</var>, <var>></var>, <var><</var>, etc. will perform <var>Longstring</var> comparisons if either of the operands is a <var>Longstring</var>, that is, comparison operations involving <var>Longstring</var> operands behave pretty much as expected.		Comparison operations such as <var>Eq</var>, <var>Lt</var>, <var>Le</var>, <var>></var>, <var><</var>, etc. will perform <var>Longstring</var> comparisons if either of the operands is a <var>Longstring</var>, that is, comparison operations involving <var>Longstring</var> operands behave pretty much as expected.

	One important point to keep in mind is that <var class="product">Model 204's</var> expression processing behavior is not changed at all unless <var>Longstring</var> variables or $functions are used, and then only changed in the statements where they are actually used. So the effect of any use of <var>Longstring</var> variables or $functions is limited to the statements that use them.

	==Longstrings and $functions==		==Longstrings and $functions==
	<var>Longstrings</var> can be used as inputs to $functions. As mentioned before, if a <var>Longstring</var> expression is assigned to a regular <var>String</var>, a request-cancelling truncation error will occur if the target <var>String</var> variable is not big enough to hold the source <var>Longstring</var>. Request-cancelling truncation errors also occur if a <var>Longstring</var> that is longer than 255 bytes is passed to a non-<var>Longstring</var>-capable $function. For example:		<var>Longstrings</var> can be used as inputs to $functions. As mentioned before, if a <var>Longstring</var> expression is assigned to a regular <var>String</var>, a request-cancelling truncation error will occur if the target <var>String</var> variable is not big enough to hold the source <var>Longstring</var>. Request-cancelling truncation errors also occur if a <var>Longstring</var> that is longer than 255 bytes is passed to a non-<var>Longstring</var>-capable $function. For example:

JAL: add category

2015-03-27T13:40:11Z

add category

← Older revision		Revision as of 13:40, 27 March 2015
Line 307:		Line 307:
	<p class="code">%long = $date with '>' with %long with '<' with $time		<p class="code">%long = $date with '>' with %long with '<' with $time
	</p>		</p>

			[[Category:SOUL]]
	[[Category:Overviews]]		[[Category:Overviews]]
	[[Category:User Language syntax enhancements]]		[[Category:User Language syntax enhancements]]

Dme at 21:50, 4 November 2013

2013-11-04T21:50:28Z

Show changes

DCameron at 10:43, 4 November 2013

2013-11-04T10:43:34Z

← Older revision		Revision as of 10:43, 4 November 2013
Line 212:		Line 212:

	==Longstrings and the Print, Html, and Text statements==		==Longstrings and the Print, Html, and Text statements==
	Using <var>Longstring</var> expressions in the <code>Print</code> statement works largely “as expected”: given the constraints of <code>LOBUFF</code>, <code>OUTCCC</code>, and <code>OUTMRL</code>, and other output target specific parameters - the values of <var>Longstrings</var> are simply displayed to the output target. One minor exception to this is that the <code>To</code> ~~and <code>At</code> clauses~~ on the <code>Print</code> statement ~~are~~ not supported for <var>Longstrings</var>.		Using <var>Longstring</var> expressions in the <code>Print</code> statement works largely “as expected”: given the constraints of <code>LOBUFF</code>, <code>OUTCCC</code>, and <code>OUTMRL</code>, and other output target specific parameters - the values of <var>Longstrings</var> are simply displayed to the output target. One minor exception to this is that the <code>To</code> clause on the <code>Print</code> statement is not supported for <var>Longstrings</var>.

	It should also be kept in mind that the <code>With</code> keyword in <code>Print</code> statements is not the <code>With</code> concatenation operator, although the result is usually the same as if it were. Specifically, the <code>With</code> keyword results in the part before the <code>With</code> being printed, followed by the part after. This means that if two regular String variables, each with 255 bytes of data in them, are printed as follows:		It should also be kept in mind that the <code>With</code> keyword in <code>Print</code> statements is not the <code>With</code> concatenation operator, although the result is usually the same as if it were. Specifically, the <code>With</code> keyword results in the part before the <code>With</code> being printed, followed by the part after. This means that if two regular String variables, each with 255 bytes of data in them, are printed as follows:

JAL at 22:25, 17 October 2013

2013-10-17T22:25:29Z

Show changes

Dme at 15:35, 9 September 2013

2013-09-09T15:35:24Z

← Older revision		Revision as of 15:35, 9 September 2013
Line 3:		Line 3:
	<p class="code">%name is longstring		<p class="code">%name is longstring
	</p>		</p>
	<var>Longstring</var> ~~variavles~~ are largely interchangeable with <var>String</var> variables, with the exception that a <var>Longstring</var> can have a length up to 2**31-1 bytes, while <var>String</var> variables have a maximum length of 255 bytes. The <var>Variables Are</var> statement and the <var>VTYPE</var> parameter do not allow <code>Longstring</code> to be set as a default type, so all <var>Longstring</var> variables must be explicitly declared as such. <var>Longstring</var> variables can be defined as <code>Common</code> and as subroutine parameters, but there is currently no support for <code>Static</code> <var>Longstring</var> variables. Sirius Mods Version 7.2 introduced support for the <var>Initial</var> clause for <var>longstrings</var>.		<var>Longstring</var> variables are largely interchangeable with <var>String</var> variables, with the exception that a <var>Longstring</var> can have a length up to 2**31-1 bytes, while <var>String</var> variables have a maximum length of 255 bytes. The <var>Variables Are</var> statement and the <var>VTYPE</var> parameter do not allow <code>Longstring</code> to be set as a default type, so all <var>Longstring</var> variables must be explicitly declared as such. <var>Longstring</var> variables can be defined as <code>Common</code> and as subroutine parameters, but there is currently no support for <code>Static</code> <var>Longstring</var> variables. Sirius Mods Version 7.2 introduced support for the <var>Initial</var> clause for <var>longstrings</var>.

	Like other %variables, a <var>Longstring</var> cannot be declared as <code>Global</code> on its declaration. However, a <var>Longstring</var> %variable can be dynamically bound to a global <var>Longstring</var> with the <var>[[$Lstr_Global_and_$Lstr_Session\|$Lstr_global]]</var> function, and it can be dynamically bound to a session global <var>Longstring</var> with the <var>[[$Lstr_Global_and_$Lstr_Session\|$Lstr_session]]</var> function.		Like other %variables, a <var>Longstring</var> cannot be declared as <code>Global</code> on its declaration. However, a <var>Longstring</var> %variable can be dynamically bound to a global <var>Longstring</var> with the <var>[[$Lstr_Global_and_$Lstr_Session\|$Lstr_global]]</var> function, and it can be dynamically bound to a session global <var>Longstring</var> with the <var>[[$Lstr_Global_and_$Lstr_Session\|$Lstr_session]]</var> function.

JAL: /* Longstrings and methods */

2013-09-06T22:04:07Z

Longstrings and methods

← Older revision		Revision as of 22:04, 6 September 2013
Line 241:		Line 241:
	<li>As the result (output value) of <var class="product">User Language</var> and system methods.		<li>As the result (output value) of <var class="product">User Language</var> and system methods.
	</ul>		</ul>
	In fact, '''all''' system methods are <var>~~longstring~~</var>-capable so behave, for the purposes of truncation and upgrading of <var>With</var> operations, the same as <var>~~longstring~~</var>-capable $functions. Therefore any <var>With</var> operation whose result is an input to a system method causes the <var>With</var> operation to be upgraded to a <var>Longstring</var> <var>With</var> operation. Similarly, any implicit truncation of the result of a system method results in request cancellation.		In fact, '''all''' system methods are <var>Longstring</var>-capable, so they behave, for the purposes of truncation and upgrading of <var>With</var> operations, the same as <var>Longstring</var>-capable $functions. Therefore any <var>With</var> operation whose result is an input to a system method causes the <var>With</var> operation to be upgraded to a <var>Longstring</var> <var>With</var> operation. Similarly, any implicit truncation of the result of a system method results in request cancellation.

	<var class="product">User Language</var> methods, on the other hand, can declare their inputs and output as <var>Longstrings</var> or Strings of a specific length. <var>Longstring</var> inputs and results exhibit the same truncation and <~~code~~>With</~~code~~> operation behavior as string inputs to system methods. For example, consider the following function declaration in some class:		<var class="product">User Language</var> methods, on the other hand, can declare their inputs and output as <var>Longstrings</var> or <var>Strings</var> of a specific length. <var>Longstring</var> inputs and results exhibit the same truncation and <var>With</var> operation behavior as string inputs to system methods. For example, consider the following function declaration in some class:
	<p class="code">function encode(%in is longstring) is longstring		<p class="code">function encode(%in is longstring) is longstring
	</p>		</p>
Line 249:		Line 249:
	<p class="code">%x = %foo:encode(%a with %b)		<p class="code">%x = %foo:encode(%a with %b)
	</p>		</p>
	the <code>%a with %b</code> is upgraded to a <var>Longstring</var> <~~code~~>With</~~code~~> operation because its target (the <code>%in</code> parameter in the <code>Encode</code> function) is a <var>Longstring</var>. Similarly, if <code>%x</code> is a standard String variable with some specific length, the request will be cancelled if the result of the <code>Encode</code> method is longer than <code>%x</code>'s declared length.		the <code>%a with %b</code> is upgraded to a <var>Longstring</var> <var>With</var> operation, because its target (the <code>%in</code> parameter in the <code>Encode</code> function) is a <var>Longstring</var>. Similarly, if <code>%x</code> is a standard <var>String</var> variable with some specific length, the request will be cancelled if the result of the <code>Encode</code> method is longer than <code>%x</code>'s declared length.

	<var>String</var> inputs and output, on the other hand, will behave like standard <var>String</var> variables for the purposes of truncation and <~~code~~>With</~~code~~> operation behavior. For example, consider the following function declaration in some class:		<var>String</var> inputs and output, on the other hand, will behave like standard <var>String</var> variables for the purposes of truncation and <var>With</var> operation behavior. For example, consider the following function declaration in some class:
	<p class="code">function stubby(%in is string len 4) is string len 2		<p class="code">function stubby(%in is string len 4) is string len 2
	</p>		</p>