Stringlist class - Revision history

DCameron: /* Compatibility */

2019-05-20T15:20:27Z

Compatibility

← Older revision		Revision as of 15:20, 20 May 2019
Line 44:		Line 44:
	==Compatibility==		==Compatibility==
	<p><var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.</p>		<p><var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.</p>

	<p>There is no overall practical size limit on a stringlist object itself. The stringlist is maintained internally as a binary tree, to a maximum depth of three levels, similarly to a $list object. The stringlist object will be as compact a possible if it is built using the add method to add successive stringlist items to the end of the object, as opposed to using methods such as insert, delete, and replace, where the compaction of the stringlist object will be reduced. </p>		<p>There is no overall practical size limit on a stringlist object itself. The stringlist is maintained internally as a binary tree, to a maximum depth of three levels, similarly to a $list object. The stringlist object will be as compact a possible if it is built using the add method to add successive stringlist items to the end of the object, as opposed to using methods such as insert, delete, and replace, where the compaction of the stringlist object will be reduced. </p>

	<p>For stringlists where the average stringlist item length is less than the pagesize ( 6144 ), then the maximum overall size of the stringlist object is approximately 3.5 Gigabytes. If the average stringlist item length is greater, up to the maximum item length of 2 gigabytes, then the overall object size can extend in theory up to 1.26 petabytes. </p>		<p>For stringlists where the average stringlist item length is less than the pagesize ( 6144 ), then the maximum overall size of the stringlist object is approximately 3.5 Gigabytes. If the average stringlist item length is greater, up to the maximum item length of 2 gigabytes, then the overall object size can extend in theory up to 1.26 petabytes. </p>

DCameron: /* Compatibility */

2019-05-20T15:17:58Z

Compatibility

← Older revision		Revision as of 15:17, 20 May 2019
Line 45:		Line 45:
	<p><var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.</p>		<p><var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.</p>
	<p>There is no overall practical size limit on a stringlist object itself. The stringlist is maintained internally as a binary tree, to a maximum depth of three levels, similarly to a $list object. The stringlist object will be as compact a possible if it is built using the add method to add successive stringlist items to the end of the object, as opposed to using methods such as insert, delete, and replace, where the compaction of the stringlist object will be reduced. </p>		<p>There is no overall practical size limit on a stringlist object itself. The stringlist is maintained internally as a binary tree, to a maximum depth of three levels, similarly to a $list object. The stringlist object will be as compact a possible if it is built using the add method to add successive stringlist items to the end of the object, as opposed to using methods such as insert, delete, and replace, where the compaction of the stringlist object will be reduced. </p>
			<p>For stringlists where the average stringlist item length is less than the pagesize ( 6144 ), then the maximum overall size of the stringlist object is approximately 3.5 Gigabytes. If the average stringlist item length is greater, up to the maximum item length of 2 gigabytes, then the overall object size can extend in theory up to 1.26 petabytes. </p>

	==List of Stringlist methods==		==List of Stringlist methods==

DCameron: /* Compatibility */

2019-05-20T14:57:36Z

Compatibility

← Older revision		Revision as of 14:57, 20 May 2019
Line 44:		Line 44:
	==Compatibility==		==Compatibility==
	<p><var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.</p>		<p><var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.</p>
			<p>There is no overall practical size limit on a stringlist object itself. The stringlist is maintained internally as a binary tree, to a maximum depth of three levels, similarly to a $list object. The stringlist object will be as compact a possible if it is built using the add method to add successive stringlist items to the end of the object, as opposed to using methods such as insert, delete, and replace, where the compaction of the stringlist object will be reduced. </p>

	==List of Stringlist methods==		==List of Stringlist methods==

DCameron: /* Compatibility */

2019-05-20T14:44:59Z

Compatibility

← Older revision		Revision as of 14:44, 20 May 2019
Line 43:		Line 43:

	==Compatibility==		==Compatibility==
	<var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.		<p><var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.</p>

	==List of Stringlist methods==		==List of Stringlist methods==

JAL at 20:51, 13 November 2012

2012-11-13T20:51:34Z

← Older revision		Revision as of 20:51, 13 November 2012
Line 4:		Line 4:

	==Stringlist usage==		==Stringlist usage==
			The <var>Stringlist</var> class is essentially an object-oriented version of [[$lists]]. It is strongly recommended that all new applications use <var>Stringlists</var> instead of $lists:

	~~The~~ <~~var~~>~~Stringlist~~<~~/var~~> ~~class is essentially an~~ object-oriented ~~version~~ of ~~[[$lists]]. It is strongly recommended that all new applications use~~ <var>Stringlists</var> ~~instead~~ of ~~<var>[[~~$lists~~]]</var>:~~		<ul>
			<li>Because they use the object-oriented model of instantiation, <var>Stringlists</var> eliminate the confusing behavior of $lists that results from their being tied to the statement that created them.

	~~<ul>~~		<li><var>Stringlists</var> are strongly datatyped, so application errors resulting from misuse of $list identifiers are eliminated. Code is clearer because it is obvious that a variable is a <var>Stringlist</var> — $list identifiers are simply <var>Float</var>, <var>Fixed</var>, or <var>String</var> datatypes.
	<li>Because they use the object-oriented model of instantiation, <var>Stringlists</var> eliminate the confusing behavior of <var>[[$lists]]</var> that results from their being tied to the statement that created them.
	<li><var>Stringlists</var>are strongly datatyped, so application errors resulting from misuse of ~~<var>[[~~$~~lists]]</var>~~ identifiers are eliminated. Code is clearer because it is obvious that a variable is a <var>Stringlist</var> — <var>~~[[$lists]]~~</var> ~~identifiers are simply Float~~, Fixed, or String datatypes.		<li>Because of the way $lists are instantiated, they are essentially unusable inside class methods.
	<li>Because of the way ~~<var>[[~~$lists~~]]</var>~~ are instantiated, they are essentially unusable inside class methods.
	</ul>		</ul>

Line 19:		Line 20:
	<var>Stringlists</var> are stored in CCATEMP, so they take minimal server table space no matter how large the <var>Stringlist</var>.		<var>Stringlists</var> are stored in CCATEMP, so they take minimal server table space no matter how large the <var>Stringlist</var>.

	Like all system classes, <var>Stringlists</var> are considered <var>longstring</var>-capable, that is, any string inputs and outputs are considered <var>longstrings</var> for expression-compilation purposes. The main impact of this is that <var>Stringlist</var> inputs and outputs will have standard <var>longstring</var> truncation behavior: truncation by assignment results in request cancellation.		Like all system classes, <var>Stringlists</var> are considered <var>[[Longstrings\|longstring]]</var>-capable, that is, any string inputs and outputs are considered <var>longstrings</var> for expression-compilation purposes. The main impact of this is that <var>Stringlist</var> inputs and outputs will have standard <var>longstring</var> truncation behavior: truncation by assignment results in request cancellation.

	In addition to the described methods, it is also possible to add data to a <var>Stringlist</var> with the <var>[[Text and Html statements\|HTML/Text]]</var> statement using the <~~code~~>To</~~code~~> clause. This is especially useful if there is a block of mostly constant text to be added to a <var>Stringlist</var>.		In addition to the described methods, it is also possible to add data to a <var>Stringlist</var> with the <var>[[Text and Html statements\|HTML/Text]]</var> statement using the <var>To</var> clause. This is especially useful if there is a block of mostly constant text to be added to a <var>Stringlist</var>.

	<p class="code">Begin		<p class="code">Begin
Line 39:		Line 40:

	==Migrating from $lists to Stringlists==		==Migrating from $lists to Stringlists==
			The <var>[[MoveFromId (Stringlist subroutine)\|MoveFromId]]</var> and <var>[[MoveToId (Stringlist subroutine)\|MoveToId]]</var> methods facilitate migration from $lists to <var>Stringlists</var>: <var>Stringlists</var> can be passed to code that works on $lists after being converted to a $list with <var>[[MoveToId (Stringlist subroutine)\|MoveToId]]</var>; $lists can be converted to <var>Stringlists</var> with <var>[[MoveFromId (Stringlist subroutine)\|MoveFromId]]</var>.
	The <var>[[MoveFromId (Stringlist subroutine)\|MoveFromId]]</var> and <var>[[MoveToId (Stringlist subroutine)\|MoveToId]]</var> methods facilitate migration from ~~<var>[[~~$lists~~]]</var>~~ to <var>Stringlists</var>: <var>Stringlists</var> can be passed to code that works on ~~<var>[[~~$lists~~]]</var>~~ after being converted to a ~~<var>[[~~$list~~]]</var>~~ with <var>[[MoveToId (Stringlist subroutine)\|MoveToId]]</var>; ~~<var>[[~~$lists~~]]</var>~~ can be converted to <var>Stringlists</var> with <var>[[MoveFromId (Stringlist subroutine)\|MoveFromId]]</var>.

	==Compatibility==		==Compatibility==
	~~Before~~ <var ~~class="product"~~>~~Sirius Mods</var> Version 6.6, <var>Stringlists</var> items were limited to 6124 bytes in length.~~		<var>Stringlist</var> items can be as many as 2**31-1 bytes long. While all methods work correctly with <var>Stringlist</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> restrict their processing to the first 6124 bytes of a <var>Stringlist</var> item.

	~~In <var class="product">Sirius Mods</var> Version 6.6, this limitation was lifted, and <var>Stringlists~~</var> items can be as many as 2**31-1 bytes long. While~~, as of <var class="product">Sirius Mods</var> Version 6.6,~~ all methods work correctly with <var>~~Stringlists~~</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> ~~still~~ restrict their processing to the first 6124 bytes of a <var>~~Stringlists~~</var> item.

	==List of Stringlist methods==		==List of Stringlist methods==
	The individual Stringlist methods are summarized in [[List of Stringlist methods\|"List of Stringlist methods"]].		The individual <var>Stringlist</var> methods are summarized in [[List of Stringlist methods\|"List of Stringlist methods"]].

	[[Category:System classes]]		[[Category:System classes]]

JALWiccan: 1 revision

2012-10-30T22:02:48Z

1 revision

← Older revision	Revision as of 22:02, 30 October 2012
(No difference)

JAL2: /* Stringlist usage */

2012-10-30T22:02:32Z

Stringlist usage

← Older revision		Revision as of 22:02, 30 October 2012
Line 9:		Line 9:
	<ul>		<ul>
	<li>Because they use the object-oriented model of instantiation, <var>Stringlists</var> eliminate the confusing behavior of <var>[[$lists]]</var> that results from their being tied to the statement that created them.		<li>Because they use the object-oriented model of instantiation, <var>Stringlists</var> eliminate the confusing behavior of <var>[[$lists]]</var> that results from their being tied to the statement that created them.
	<li><var>Stringlists</var>are strongly datatyped, so application errors resulting from misuse of <var>[[$lists]]</var> identifiers are eliminated. Code is clearer because it is obvious that a variable is a <var>Stringlist</var> -- <var>[[$lists]]</var> identifiers are simply Float, Fixed, or String datatypes.		<li><var>Stringlists</var>are strongly datatyped, so application errors resulting from misuse of <var>[[$lists]]</var> identifiers are eliminated. Code is clearer because it is obvious that a variable is a <var>Stringlist</var> — <var>[[$lists]]</var> identifiers are simply Float, Fixed, or String datatypes.
	<li>Because of the way <var>[[$lists]]</var> are instantiated, they are essentially unusable inside class methods.		<li>Because of the way <var>[[$lists]]</var> are instantiated, they are essentially unusable inside class methods.
	</ul>		</ul>

JAL2: /* Stringlist usage */

2012-06-20T23:17:18Z

Stringlist usage

← Older revision		Revision as of 23:17, 20 June 2012
Line 21:		Line 21:
	Like all system classes, <var>Stringlists</var> are considered <var>longstring</var>-capable, that is, any string inputs and outputs are considered <var>longstrings</var> for expression-compilation purposes. The main impact of this is that <var>Stringlist</var> inputs and outputs will have standard <var>longstring</var> truncation behavior: truncation by assignment results in request cancellation.		Like all system classes, <var>Stringlists</var> are considered <var>longstring</var>-capable, that is, any string inputs and outputs are considered <var>longstrings</var> for expression-compilation purposes. The main impact of this is that <var>Stringlist</var> inputs and outputs will have standard <var>longstring</var> truncation behavior: truncation by assignment results in request cancellation.

	In addition to the described methods, it is also possible to add data to a <var>Stringlist</var> with the <var>[[Text and Html statements\|HTML or Text ~~statements~~]]</var> using the <code>To</code> clause. This is especially useful if there is a block of mostly constant text to be added to a <var>Stringlist</var>.		In addition to the described methods, it is also possible to add data to a <var>Stringlist</var> with the <var>[[Text and Html statements\|HTML/Text]]</var> statement using the <code>To</code> clause. This is especially useful if there is a block of mostly constant text to be added to a <var>Stringlist</var>.

	<p class="code">Begin		<p class="code">Begin

JAL2 at 21:05, 23 December 2011

2011-12-23T21:05:00Z

← Older revision		Revision as of 21:05, 23 December 2011
Line 3:		Line 3:
	While less generalized than a <var>[[Collections\|collection]]</var> class, it has a richer set of methods than any collection class. Unfortunately, the <var>Stringlist</var> class cannot be thought of as either a subset or superset of collections, so it is not necessarily an obvious decision as to which to use.		While less generalized than a <var>[[Collections\|collection]]</var> class, it has a richer set of methods than any collection class. Unfortunately, the <var>Stringlist</var> class cannot be thought of as either a subset or superset of collections, so it is not necessarily an obvious decision as to which to use.

	~~[[List of Stringlist methods\|"List of Stringlist methods"]] lists all the methods in this class.~~

	~~__TOC__~~
	==Stringlist usage==		==Stringlist usage==

Line 49:		Line 46:

	In <var class="product">Sirius Mods</var> Version 6.6, this limitation was lifted, and <var>Stringlists</var> items can be as many as 2**31-1 bytes long. While, as of <var class="product">Sirius Mods</var> Version 6.6, all methods work correctly with <var>Stringlists</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> still restrict their processing to the first 6124 bytes of a <var>Stringlists</var> item.		In <var class="product">Sirius Mods</var> Version 6.6, this limitation was lifted, and <var>Stringlists</var> items can be as many as 2**31-1 bytes long. While, as of <var class="product">Sirius Mods</var> Version 6.6, all methods work correctly with <var>Stringlists</var> items longer than 6124 bytes, a few methods such as <var>[[Locate and LocateUp (Stringlist_functions)\|Locate]]</var> and <var>[[Locate and LocateUp_(Stringlist_functions)\|LocateUp]]</var> still restrict their processing to the first 6124 bytes of a <var>Stringlists</var> item.

			==List of Stringlist methods==
			The individual Stringlist methods are summarized in [[List of Stringlist methods\|"List of Stringlist methods"]].

	[[Category:System classes]]		[[Category:System classes]]

JAL2 at 21:01, 23 December 2011

2011-12-23T21:01:11Z

← Older revision		Revision as of 21:01, 23 December 2011
Line 5:		Line 5:
	[[List of Stringlist methods\|"List of Stringlist methods"]] lists all the methods in this class.		[[List of Stringlist methods\|"List of Stringlist methods"]] lists all the methods in this class.

			__TOC__
	==Stringlist usage==		==Stringlist usage==

	The <var>Stringlist</var> class is essentially an object-oriented version of [[$lists]] ~~(currently described in the <var class="product">[http://www.sirius-software.com/maint/funcr.pdf Sirius Functions Reference Manual]</var>~~. It is strongly recommended that all new applications use <var>Stringlists</var> instead of <var>[[$lists]]</var>:		The <var>Stringlist</var> class is essentially an object-oriented version of [[$lists]]. It is strongly recommended that all new applications use <var>Stringlists</var> instead of <var>[[$lists]]</var>:

	<ul>		<ul>