Stringlist class: Difference between revisions
mNo edit summary |
m (lots of tags) |
||
| Line 1: | Line 1: | ||
The '''Stringlist''' class provides a facility that resembles an unbounded array of strings. | The '''Stringlist''' class provides a facility that resembles an unbounded array of strings. | ||
While less generalized than a [[Collection | While less generalized than a <var>[[Collections|Collection]]</var> class, it has a richer set of methods than any <var>[[Collections|Collection]]</var> class. Unfortunately, the <var>Stringlist</var> class cannot be thought of as either a subset or superset of <var>collections</var>, so it is not necessarily an obvious decision as to which to use. | ||
or superset of collections, so it is not necessarily an obvious decision as to which to use. | |||
[[List of Stringlist methods]] lists all the methods in this class. | [[List of Stringlist methods]] lists all the methods in this class. | ||
| Line 8: | Line 7: | ||
==Stringlist usage== | ==Stringlist usage== | ||
The Stringlist class is essentially an object-oriented version of $lists (described in the | The <var>Stringlist</var> class is essentially an object-oriented version of [[$lists]] (described in the <var class="product">[[Sirius Functions Reference Manual]]</var>). It is strongly recommended that all new applications use <var>Stringlists</var> instead of <var>[[$lists]]</var>: | ||
<ul> | <ul> | ||
<li>Because they use the object-oriented model of instantiation, Stringlists eliminate the confusing behavior of $lists 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>Stringlists are strongly datatyped, so application errors resulting from misuse of $ | <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> | ||
Stringlist objects are instantiated with the [[ | <var>Stringlist</var> objects are instantiated with the <var>[[New_(Stringlist_constructor)|New]]</var> function or with methods that return <var>Stringlist</var> instances "under the covers" such as the <var>[[Sort (Stringlist subroutine)|Sort]]</var>, <var>[[SortNew (Stringlist function)|SortNew]]</var> or <var>[[Copy (Stringlist function)|Copy]]</var> methods. | ||
The system Discard method deletes a Stringlist object. | The system <var>[[Discard]]</var> method deletes a <var>Stringlist</var> object. | ||
Stringlists are stored in CCATEMP, so they take minimal server table space no matter how large the Stringlist. | <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, Stringlists are considered | 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 Stringlist with the [[Text and Html statements|HTML or Text | 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>. | ||
<p class="code">Begin | |||
%sl is object Stringlist | |||
%sl = New | |||
Text to %sl | |||
<html> | |||
<head> | |||
<title>Loading a complete web page into a stringlist</title> | |||
</head> | |||
<body> | |||
Each line of this text block is a new stringlist item. | |||
</body> | |||
End Text | |||
%sl:Print | |||
End</p> | |||
==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 Stringlists: Stringlists can be passed to code that works on $lists after being converted to a $list with MoveToId; $lists can be converted to Stringlists with MoveFromId. | 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. | |||
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_(Stringlist_function)|Locate]]</var> and <var>[[LocateUp_(Stringlist_function)|LocateUp]]</var> still restrict their processing to the first 6124 bytes of a <var>Stringlists</var> item. | |||
In | |||
as many as 2**31-1 bytes long. While, as of | |||
[[Category:System classes]] | [[Category:System classes]] | ||
Revision as of 01:20, 29 January 2011
The Stringlist class provides a facility that resembles an unbounded array of strings.
While less generalized than a Collection class, it has a richer set of methods than any Collection class. Unfortunately, the Stringlist 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 lists all the methods in this class.
Stringlist usage
The Stringlist class is essentially an object-oriented version of $lists (described in the Sirius Functions Reference Manual). It is strongly recommended that all new applications use Stringlists instead of $lists:
- Because they use the object-oriented model of instantiation, Stringlists eliminate the confusing behavior of $lists that results from their being tied to the statement that created them.
- Stringlistsare strongly datatyped, so application errors resulting from misuse of $lists identifiers are eliminated. Code is clearer because it is obvious that a variable is a Stringlist -- $lists identifiers are simply Float, Fixed, or String datatypes.
- Because of the way $lists are instantiated, they are essentially unusable inside class methods.
Stringlist objects are instantiated with the New function or with methods that return Stringlist instances "under the covers" such as the Sort, SortNew or Copy methods.
The system Discard method deletes a Stringlist object.
Stringlists are stored in CCATEMP, so they take minimal server table space no matter how large the Stringlist.
Like all system classes, Stringlists are considered longstring-capable, that is, any string inputs and outputs are considered longstrings for expression-compilation purposes. The main impact of this is that Stringlist inputs and outputs will have standard longstring truncation behavior: truncation by assignment results in request cancellation.
In addition to the described methods, it is also possible to add data to a Stringlist with the HTML or Text statements using the To clause. This is especially useful if there is a block of mostly constant text to be added to a Stringlist.
Begin %sl is object Stringlist %sl = New Text to %sl <html> <head> <title>Loading a complete web page into a stringlist</title> </head> <body> Each line of this text block is a new stringlist item. </body> End Text %sl:Print End
Migrating from $lists to Stringlists
The MoveFromId and MoveToId methods facilitate migration from $lists to Stringlists: Stringlists can be passed to code that works on $lists after being converted to a $list with MoveToId; $lists can be converted to Stringlists with MoveFromId.
Compatibility
Before Sirius Mods Version 6.6, Stringlists items were limited to 6124 bytes in length.
In Sirius Mods Version 6.6, this limitation was lifted, and Stringlists items can be as many as 2**31-1 bytes long. While, as of Sirius Mods Version 6.6, all methods work correctly with Stringlists items longer than 6124 bytes, a few methods such as Locate and LocateUp still restrict their processing to the first 6124 bytes of a Stringlists item.