ParseLines (Stringlist subroutine) - Revision history

JAL at 17:48, 27 August 2014

2014-08-27T17:48:16Z

← Older revision		Revision as of 17:48, 27 August 2014
Line 31:		Line 31:

	==Examples==		==Examples==
	<ol><li>The following loads the names of three popular sandwich contents onto separate <var>Stringlist</var> items:		<ol>
			<li>The following loads the names of three popular sandwich contents onto separate <var>Stringlist</var> items:

	<p class="code">%contents is object stringList		<p class="code">%contents is object stringList
Line 39:		Line 40:
	</p>		</p>

	The space before the slash character is the delimiter-set delimiter character, that is, the character used to separate multiple delimiters, should there be more than one. As this example illustrates, the <var>ParseLines</var> method can be used for general-purpose parsing, although this was not really its intent and it is somewhat limited for this purpose. Its main use is expected to be in parsing text received into a string via <var>[[$~~web_input_content~~]]</var>, <var>[[$~~web_file_content~~]]</var>, or <var>[[$~~web_output_content~~]]</var>. Accordingly, the default delimiter set for the <var>ParseLines</var> method is <code>X'0D'</code>, <code>X'25'</code>, and <code>X'0D25'</code> (which are the EBCDIC carriage-return, line-feed, and carriage-return/line-feed characters respectively).		The space before the slash character is the delimiter-set delimiter character, that is, the character used to separate multiple delimiters, should there be more than one. As this example illustrates, the <var>ParseLines</var> method can be used for general-purpose parsing, although this was not really its intent and it is somewhat limited for this purpose. Its main use is expected to be in parsing text received into a string via <var>[[$Web_Input_Content]]</var>, <var>[[$Web_File_Content]]</var>, or <var>[[$Web_Output_Content]]</var>. Accordingly, the default delimiter set for the <var>ParseLines</var> method is <code>X'0D'</code>, <code>X'25'</code>, and <code>X'0D25'</code> (which are the EBCDIC carriage-return, line-feed, and carriage-return/line-feed characters respectively).
	<li>In the following example, the contents of the file being uploaded via form field <code>MYFILE</code> are moved to a <var>Stringlist</var>:		<li>In the following example, the contents of the file being uploaded via form field <code>MYFILE</code> are moved to a <var>Stringlist</var>:

JAL: /* See also */

2012-10-31T19:12:11Z

JAL: /* See also */

2012-10-31T19:11:57Z

JAL at 19:11, 31 October 2012

2012-10-31T19:11:37Z

← Older revision		Revision as of 19:11, 31 October 2012
Line 5:		Line 5:
	==Syntax==		==Syntax==
	{{Template:Stringlist:ParseLines syntax}}		{{Template:Stringlist:ParseLines syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>sl</th>		<tr><th>sl</th>
	<td>A <var>Stringlist</var> object; the parsed lines are appended as items to <var class="term">sl</var>. </td></tr>		<td>A <var>Stringlist</var> object; the parsed lines are appended as items to <var class="term">sl</var>. </td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>The string to be parsed. </td></tr>		<td>The string to be parsed. </td></tr>

	<tr><th>delims</th>		<tr><th>delims</th>
	<td>An, optional, list of one or more delimiters to be used as line delimiters. If specified, the first character in the delimiter list is the separator character for the delimiter list itself and the remainder are the delimiters to be used to separate the <var class="term">string</var> being parsed. If this optional argument is not specified, the delimiter list used contains <code>X'0D'</code>, <code>X'25'</code>, and <code>X'0D25'</code> (which are the EBCDIC carriage-return, line-feed, and carriage-return/line-feed characters respectively), and it should handle any line-end delimited data from an ASCII host that is been translated to ASCII. </td></tr>		<td>An, optional, list of one or more delimiters to be used as line delimiters. If specified, the first character in the delimiter list is the separator character for the delimiter list itself and the remainder are the delimiters to be used to separate the <var class="term">string</var> being parsed. If this optional argument is not specified, the delimiter list used contains <code>X'0D'</code>, <code>X'25'</code>, and <code>X'0D25'</code> (which are the EBCDIC carriage-return, line-feed, and carriage-return/line-feed characters respectively), and it should handle any line-end delimited data from an ASCII host that is been translated to ASCII. </td></tr>

	<tr><th><var>StripTrailingNull</var></th>		<tr><th><var>StripTrailingNull</var></th>
	<td>This name required argument, <var>StripTrailingNull</var>, is a <var>boolean</var> value that indicates whether a trailing null line should be stripped. <var>StripTrailingNull</var> is an optional argument that defaults to <var>true</var>, which results in a trailing null line being stripped.</td></tr>		<td>This name required argument, <var>StripTrailingNull</var>, is a <var>boolean</var> value that indicates whether a trailing null line should be stripped. <var>StripTrailingNull</var> is an optional argument that defaults to <var>true</var>, which results in a trailing null line being stripped.</td></tr>
Line 18:		Line 22:

	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>ParseLines</var> result in request cancellation.		<ul>
	<li>The default for trailing null-line stripping for <var>ParseLines</var> is based on the fact that most ASCII applications end the last line of a file with the line-end character(s). As such, not stripping the trailing null-line would create a <var>Stringlist</var> item where a line was not intended, so it would likely be a bit of an annoyance. Similarly, the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> also ends the output string with the line delimiter by default. Still, the default trailing null-line handling is necessarily the most "correct" in some absolute sense. Specifically, if a <var>ParseLines</var> operation is used to load a <var>Stringlist</var>, the result of a <var>~~[[CreateLines (Stringlist function)\|~~Createlines]]</var> with the same delimiter character would produce an output different from the input to <var>ParseLines</var>, if the original input did not end with a delimiter — a delimiter would be added. Using <var ~~class="term"~~>~~false~~</var> for both the <var>ParseLines</var> <var>StripTrailingNull</var> parameter and the <var>~~[[CreateLines (Stringlist function)\|~~Createlines]]</var> <var>AddTrailingDelimiter</var> parameter would ensure reversability of these two methods.		<li>All errors in <var>ParseLines</var> result in request cancellation.
	~~<li><var>ParseLines~~</~~var~~> ~~is available in <var class="product">Sirius Mods</var> Version 6.7 and later.~~
			<li>The default for trailing null-line stripping for <var>ParseLines</var> is based on the fact that most ASCII applications end the last line of a file with the line-end character(s). As such, not stripping the trailing null-line would create a <var>Stringlist</var> item where a line was not intended, so it would likely be a bit of an annoyance. Similarly, the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> method also ends the output string with the line delimiter by default.
			<p>
			Still, the default trailing null-line handling is necessarily the most "correct" in some absolute sense. Specifically, if a <var>ParseLines</var> operation is used to load a <var>Stringlist</var>, the result of a <var>Createlines</var> with the same delimiter character would produce an output different from the input to <var>ParseLines</var>, if the original input did not end with a delimiter — a delimiter would be added. Using <var>False</var> for both the <var>ParseLines</var> <var>StripTrailingNull</var> parameter and the <var>Createlines</var> <var>AddTrailingDelimiter</var> parameter would ensure reversability of these two methods.</p>
	</ul>		</ul>

Line 83:		Line 90:
	{{Template:Stringlist:ParseLines footer}}		{{Template:Stringlist:ParseLines footer}}
	<ul>		<ul>
	<li>The intrinsic String <var>[[ParseLines (String function)\|ParseLines]]</var> function.		<li>The intrinsic <var>String</var> class <var>[[ParseLines (String function)\|ParseLines]]</var> function

JALWiccan: 1 revision

2012-10-30T22:02:47Z

1 revision

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

JAL2 at 22:02, 30 October 2012

2012-10-30T22:02:32Z

← Older revision		Revision as of 22:02, 30 October 2012
Line 19:		Line 19:
	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>ParseLines</var> result in request cancellation.		<ul><li>All errors in <var>ParseLines</var> result in request cancellation.
	<li>The default for trailing null-line stripping for <var>ParseLines</var> is based on the fact that most ASCII applications end the last line of a file with the line-end character(s). As such, not stripping the trailing null-line would create a <var>Stringlist</var> item where a line was not intended, so it would likely be a bit of an annoyance. Similarly, the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> also ends the output string with the line delimiter by default. Still, the default trailing null-line handling is necessarily the most "correct" in some absolute sense. Specifically, if a <var>ParseLines</var> operation is used to load a <var>Stringlist</var>, the result of a <var>[[CreateLines (Stringlist function)\|Createlines]]</var> with the same delimiter character would produce an output different from the input to <var>ParseLines</var>, if the original input did not end with a delimiter -- a delimiter would be added. Using <var class="term">false</var> for both the <var>ParseLines</var> <var>StripTrailingNull</var> parameter and the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> <var>AddTrailingDelimiter</var> parameter would ensure reversability of these two methods.		<li>The default for trailing null-line stripping for <var>ParseLines</var> is based on the fact that most ASCII applications end the last line of a file with the line-end character(s). As such, not stripping the trailing null-line would create a <var>Stringlist</var> item where a line was not intended, so it would likely be a bit of an annoyance. Similarly, the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> also ends the output string with the line delimiter by default. Still, the default trailing null-line handling is necessarily the most "correct" in some absolute sense. Specifically, if a <var>ParseLines</var> operation is used to load a <var>Stringlist</var>, the result of a <var>[[CreateLines (Stringlist function)\|Createlines]]</var> with the same delimiter character would produce an output different from the input to <var>ParseLines</var>, if the original input did not end with a delimiter — a delimiter would be added. Using <var class="term">false</var> for both the <var>ParseLines</var> <var>StripTrailingNull</var> parameter and the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> <var>AddTrailingDelimiter</var> parameter would ensure reversability of these two methods.
	<li><var>ParseLines</var> is available in <var class="product">Sirius Mods</var> Version 6.7 and later.		<li><var>ParseLines</var> is available in <var class="product">Sirius Mods</var> Version 6.7 and later.
	</ul>		</ul>

JAL2 at 20:56, 13 April 2011

2011-04-13T20:56:40Z

← Older revision		Revision as of 20:56, 13 April 2011
Line 13:		Line 13:
	<tr><th>delims</th>		<tr><th>delims</th>
	<td>An, optional, list of one or more delimiters to be used as line delimiters. If specified, the first character in the delimiter list is the separator character for the delimiter list itself and the remainder are the delimiters to be used to separate the <var class="term">string</var> being parsed. If this optional argument is not specified, the delimiter list used contains <code>X'0D'</code>, <code>X'25'</code>, and <code>X'0D25'</code> (which are the EBCDIC carriage-return, line-feed, and carriage-return/line-feed characters respectively), and it should handle any line-end delimited data from an ASCII host that is been translated to ASCII. </td></tr>		<td>An, optional, list of one or more delimiters to be used as line delimiters. If specified, the first character in the delimiter list is the separator character for the delimiter list itself and the remainder are the delimiters to be used to separate the <var class="term">string</var> being parsed. If this optional argument is not specified, the delimiter list used contains <code>X'0D'</code>, <code>X'25'</code>, and <code>X'0D25'</code> (which are the EBCDIC carriage-return, line-feed, and carriage-return/line-feed characters respectively), and it should handle any line-end delimited data from an ASCII host that is been translated to ASCII. </td></tr>
	<tr><th>StripTrailingNull</th>		<tr><th><var>StripTrailingNull</var></th>
	<td>This name required argument, <var>StripTrailingNull</var>, is a <var>boolean</var> value that indicates whether a trailing null line should be stripped. <var>StripTrailingNull</var> is an optional argument that defaults to <var>true</var>, which results in a trailing null line being stripped.</td></tr>		<td>This name required argument, <var>StripTrailingNull</var>, is a <var>boolean</var> value that indicates whether a trailing null line should be stripped. <var>StripTrailingNull</var> is an optional argument that defaults to <var>true</var>, which results in a trailing null line being stripped.</td></tr>
	</table>		</table>
Line 19:		Line 19:
	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>ParseLines</var> result in request cancellation.		<ul><li>All errors in <var>ParseLines</var> result in request cancellation.
	<li>The default for trailing null-line stripping for <var>ParseLines</var> is based on the fact that most ASCII applications end the last line of a file with the line-end character(s). As such, not stripping the trailing null-line would create a <var>Stringlist</var> item where a line was not intended, so it would likely be a bit of an annoyance. Similarly, the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> also ends the output string with the line delimiter by default. Still, the default trailing null-line handling is necessarily the most "correct" in some absolute sense. Specifically, if a <var>ParseLines</var> operation is used to load a <var>Stringlist</var>, the result of a <var>[[CreateLines (Stringlist function)\|Createlines]]</var> with the same delimiter character would produce an output different from the input to <var>ParseLines</var>, if the original input did not end with a delimiter -- a delimiter would be added. Using <var class="term">false</var> for both the <var>ParseLines</var> <var ~~class="term"~~>StripTrailingNull</var> parameter and the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> <var ~~class="term"~~>AddTrailingDelimiter</var> parameter would ensure reversability of these two methods.		<li>The default for trailing null-line stripping for <var>ParseLines</var> is based on the fact that most ASCII applications end the last line of a file with the line-end character(s). As such, not stripping the trailing null-line would create a <var>Stringlist</var> item where a line was not intended, so it would likely be a bit of an annoyance. Similarly, the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> also ends the output string with the line delimiter by default. Still, the default trailing null-line handling is necessarily the most "correct" in some absolute sense. Specifically, if a <var>ParseLines</var> operation is used to load a <var>Stringlist</var>, the result of a <var>[[CreateLines (Stringlist function)\|Createlines]]</var> with the same delimiter character would produce an output different from the input to <var>ParseLines</var>, if the original input did not end with a delimiter -- a delimiter would be added. Using <var class="term">false</var> for both the <var>ParseLines</var> <var>StripTrailingNull</var> parameter and the <var>[[CreateLines (Stringlist function)\|Createlines]]</var> <var>AddTrailingDelimiter</var> parameter would ensure reversability of these two methods.
	<li><var>ParseLines</var> is available in <var class="product">Sirius Mods</var> Version 6.7 and later.		<li><var>ParseLines</var> is available in <var class="product">Sirius Mods</var> Version 6.7 and later.
	</ul>		</ul>

Dme: /* Examples */

2011-02-07T22:08:23Z

Examples

← Older revision		Revision as of 22:08, 7 February 2011
Line 38:		Line 38:
	%myfile is longstring		%myfile is longstring
	...		...
	~~</p>~~
	%myfile = $web_file_content('MYFILE', ,'text')		%myfile = $web_file_content('MYFILE', ,'text')
	~~<p class="code">~~...		...
	~~</p>~~
	%contents = new		%contents = new
	%contents:parseLines(%myfile)		%contents:parseLines(%myfile)
Line 52:		Line 50:
	'/' with $x2c('0A') with -		'/' with $x2c('0A') with -
	'/' with $x2c('0A0D'))		'/' with $x2c('0A0D'))
	~~</p>~~
	%contents is object stringList		%contents is object stringList
	%myfile is longstring		%myfile is longstring
	~~<p class="code">~~...		...
	~~</p>~~
	%myfile = $web_file_content('MYFILE')		%myfile = $web_file_content('MYFILE')
	~~<p class="code">~~...		...
	~~</p>~~
	%contents = new		%contents = new
	%contents:parseLines(%myfile, %asciiLinend)		%contents:parseLines(%myfile, %asciiLinend)

Wiccan: 1 revision

2011-02-07T21:23:53Z

1 revision

← Older revision	Revision as of 21:23, 7 February 2011
(No difference)

Wiccan: 1 revision

2011-02-07T21:23:51Z

1 revision

← Older revision		Revision as of 21:23, 7 February 2011
Line 28:		Line 28:
	<p class="code">%contents is object stringList		<p class="code">%contents is object stringList
	%contents = new		%contents = new
	~~<p class="code">~~...		...
	~~</p>~~
	%contents:parseLines('Bacon/Lettuce/Tomato', ' /')		%contents:parseLines('Bacon/Lettuce/Tomato', ' /')
	</p>		</p>
Line 38:		Line 37:
	<p class="code">%contents is object stringList		<p class="code">%contents is object stringList
	%myfile is longstring		%myfile is longstring
	~~<p class="code">~~...		...
	</p>		</p>
	%myfile = $web_file_content('MYFILE', ,'text')		%myfile = $web_file_content('MYFILE', ,'text')
Line 50:		Line 49:

	<p class="code">%asciiLinend is string len 32 static -		<p class="code">%asciiLinend is string len 32 static -
	~~<p class="code">~~initial('/' with $x2c('0D') with -		initial('/' with $x2c('0D') with -
	'/' with $x2c('0A') with -		'/' with $x2c('0A') with -
	'/' with $x2c('0A0D'))		'/' with $x2c('0A0D'))
	</p>		</p>
	%contents is object stringList		%contents is object stringList

← Older revision		Revision as of 19:11, 31 October 2012
Line 88:		Line 88:

	==See also==		==See also==
	~~{{Template:Stringlist:ParseLines footer}}~~
	<ul>		<ul>
	<li>The intrinsic <var>String</var> class <var>[[ParseLines (String function)\|ParseLines]]</var> function		<li>The intrinsic <var>String</var> class <var>[[ParseLines (String function)\|ParseLines]]</var> function

			{{Template:Stringlist:ParseLines footer}}

← Older revision		Revision as of 19:12, 31 October 2012
Line 90:		Line 90:
	<ul>		<ul>
	<li>The intrinsic <var>String</var> class <var>[[ParseLines (String function)\|ParseLines]]</var> function		<li>The intrinsic <var>String</var> class <var>[[ParseLines (String function)\|ParseLines]]</var> function
			</ul>

	{{Template:Stringlist:ParseLines footer}}		{{Template:Stringlist:ParseLines footer}}